Module: GemChangelogDiff

Defined in:
lib/gem_changelog_diff.rb,
lib/gem_changelog_diff/cli.rb,
lib/gem_changelog_diff/cache.rb,
lib/gem_changelog_diff/errors.rb,
lib/gem_changelog_diff/version.rb,
lib/gem_changelog_diff/detector.rb,
lib/gem_changelog_diff/exit_code.rb,
lib/gem_changelog_diff/formatter.rb,
lib/gem_changelog_diff/interactive.rb,
lib/gem_changelog_diff/tag_matcher.rb,
lib/gem_changelog_diff/outdated_gem.rb,
lib/gem_changelog_diff/uri_resolver.rb,
lib/gem_changelog_diff/config_loader.rb,
lib/gem_changelog_diff/configuration.rb,
lib/gem_changelog_diff/github_client.rb,
lib/gem_changelog_diff/formatters/base.rb,
lib/gem_changelog_diff/formatters/json.rb,
lib/gem_changelog_diff/formatters/text.rb,
lib/gem_changelog_diff/lockfile_parser.rb,
lib/gem_changelog_diff/rubygems_client.rb,
lib/gem_changelog_diff/source_resolver.rb,
lib/gem_changelog_diff/changelog_parser.rb,
lib/gem_changelog_diff/concurrent_fetcher.rb,
lib/gem_changelog_diff/formatters/markdown.rb

Overview

CLI that shows changelog diffs for outdated gems before you bundle update.

Defined Under Namespace

Modules: ExitCode, Formatters Classes: CLI, Cache, CachedResponse, ChangelogParser, ConcurrentFetcher, ConfigLoader, Configuration, Detector, Error, GitHubAPIError, GithubClient, Interactive, LockfileParser, NetworkError, OutdatedGem, RateLimitError, RepoNotFoundError, RubygemsClient, SourceResolver, TagMatcher, UriResolver

Constant Summary collapse

VERSION = 
"1.0.0"
Formatter =
Deprecated.

Use GemChangelogDiff::Formatters::Text directly or GemChangelogDiff::Formatters.build.

Formatters::Text

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#current_version ⇒ String (readonly)

Returns the currently locked version.

Returns:

  • (String) —

    the currently locked version



11
 
# File 'lib/gem_changelog_diff/outdated_gem.rb', line 11

OutdatedGem = Data.define(:name, :current_version, :newest_version)

#name ⇒ String (readonly)

Returns the gem name.

Returns:

  • (String) —

    the gem name



11
 
# File 'lib/gem_changelog_diff/outdated_gem.rb', line 11

OutdatedGem = Data.define(:name, :current_version, :newest_version)

#newest_version ⇒ String (readonly)

Returns the latest available version.

Returns:

  • (String) —

    the latest available version



11
 
# File 'lib/gem_changelog_diff/outdated_gem.rb', line 11

OutdatedGem = Data.define(:name, :current_version, :newest_version)

Class Method Details

.configuration ⇒ Configuration

Returns the global configuration instance.

Returns:



45
46
47
 
# File 'lib/gem_changelog_diff/configuration.rb', line 45

def self.configuration
  @configuration ||= Configuration.new
end

.configure {|config| ... } ⇒ void

This method returns an undefined value.

Yields the global configuration for modification.

Yield Parameters:



52
53
54
 
# File 'lib/gem_changelog_diff/configuration.rb', line 52

def self.configure
  yield(configuration)
end

.reset_configuration! ⇒ Configuration

Resets the global configuration to defaults.

Returns:



58
59
60
 
# File 'lib/gem_changelog_diff/configuration.rb', line 58

def self.reset_configuration!
  @configuration = Configuration.new
end