gem_changelog_diff 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c58884878cc207c11af411418fb33ec4390458388c078e83197c0cad35f1b50d
-  data.tar.gz: 73f6403bc48d9a991d67d7f3da53e327acd08c004fefc3813729794dd2438112
+  metadata.gz: cb1f64ee5cd989dcb791da00dde70d752f297d0cc640e455cac541eedf09bc8b
+  data.tar.gz: 303b4fa0ce947b0ad9dab918294674f8fb90881c9017d30279e6afbf8e02ca03
 SHA512:
-  metadata.gz: 231a6934a5924d3b192261bb22e9dfbf419b439e3332cb0d05623bcba85e7a712a49155351c216e36c4fd5e43d3055780fa2ef16d2e644892dc8bfcff8d6eae3
-  data.tar.gz: 740990db45157a3661635beb030fa8e57885e9da9e0373ffe1d0c3a847ace03ef7b7219ce1baac7da85d568d24091eccd67859f3079ded0e49812780cebde030
+  metadata.gz: 7f9897600fc4fd863d2f99d2152c6e2c4ae68669be8ec6fa37e824356dd952cd80367742587a91a53e13ffd6e1b4d5bbe7cc435e2fe96aac4970b9fe6dc9b443
+  data.tar.gz: c3f9b5411ac024a224b0f0b25926a2f33dda76cf6a1a5689831c4a616788aa8659310a68bd379558ee9ed1fe9e5eeb2166127953147f8b30580d4be0a36d3453

data/CHANGELOG.md

@@ -7,6 +7,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.7.0] - 2026-06-18
+
+### Added
+
+- YAML config file support: `.gem_changelog_diff.yml` (project) and `~/.config/gem_changelog_diff/config.yml` (user)
+- Supported config keys: `github_token`, `default_format`, `cache_ttl`, `concurrency`, `ignore_gems`, `no_color`
+- `init` subcommand: generate a commented config file template
+- Config file token used as fallback when `--token` and `GITHUB_TOKEN` are not set
+- `--dry-run` flag: show which gems would be checked without fetching changelogs
+- Dry-run output respects `--format` flag (text, JSON, markdown)
+- Rails credentials token support: reads from `Rails.application.credentials.dig(:gem_changelog_diff, :github_token)` when running inside a Rails app
+- Token priority: `--token` flag → `GITHUB_TOKEN` env → Rails credentials → config file
+
 ## [0.6.0] - 2026-06-18
 
 ### Added
@@ -76,7 +89,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Plain text formatter for changelog output
 - Full end-to-end pipeline: detect → lookup → fetch → format
 
-[Unreleased]: https://github.com/eclectic-coding/gem_changelog_diff/compare/v0.6.0...HEAD
+[Unreleased]: https://github.com/eclectic-coding/gem_changelog_diff/compare/v0.7.0...HEAD
+[0.7.0]: https://github.com/eclectic-coding/gem_changelog_diff/releases/tag/v0.7.0
 [0.6.0]: https://github.com/eclectic-coding/gem_changelog_diff/releases/tag/v0.6.0
 [0.5.0]: https://github.com/eclectic-coding/gem_changelog_diff/releases/tag/v0.5.0
 [0.4.0]: https://github.com/eclectic-coding/gem_changelog_diff/releases/tag/v0.4.0

data/README.md

@@ -20,6 +20,8 @@ CLI that shows you the changelog diff for each gem before you `bundle update`, p
   - [Interactive Mode](#interactive-mode)
   - [Show Subcommand](#show-subcommand)
   - [Caching](#caching)
+  - [Dry Run](#dry-run)
+  - [Configuration File](#configuration-file)
 - [Development](#development)
 - [Contributing](#contributing)
 - [License](#license)
@@ -64,6 +66,23 @@ export GITHUB_TOKEN=ghp_your_token
 gem_changelog_diff
 ```
 
+Token resolution priority: `--token` flag → `GITHUB_TOKEN` env → Rails credentials → config file.
+
+#### Rails Credentials
+
+When running inside a Rails app, the token is automatically read from Rails credentials:
+
+```ruby
+Rails.application.credentials.dig(:gem_changelog_diff, :github_token)
+```
+
+Set it via `rails credentials:edit`:
+
+```yaml
+gem_changelog_diff:
+  github_token: ghp_your_token
+```
+
 ### Output Formats
 
 ```bash
@@ -128,6 +147,44 @@ gem_changelog_diff --cache-ttl 3600       # Set TTL to 1 hour
 gem_changelog_diff cache clear            # Clear all cached data
 ```
 
+### Dry Run
+
+Preview which gems would be checked without fetching changelogs:
+
+```bash
+gem_changelog_diff --dry-run                     # List gems in text format
+gem_changelog_diff --dry-run --format json       # JSON array of gem objects
+gem_changelog_diff --dry-run --format markdown   # Markdown bullet list
+```
+
+### Configuration File
+
+Generate a config file template:
+
+```bash
+gem_changelog_diff init  # Creates .gem_changelog_diff.yml
+```
+
+The tool loads settings from two locations (project overrides user):
+
+1. `~/.config/gem_changelog_diff/config.yml` (user-level defaults)
+2. `.gem_changelog_diff.yml` (project-level overrides)
+
+Supported keys:
+
+```yaml
+github_token: ghp_xxx
+default_format: text       # text, json, markdown
+cache_ttl: 86400           # seconds (default: 24 hours)
+concurrency: 4
+ignore_gems:
+  - rake
+  - bundler
+no_color: false
+```
+
+CLI flags always take priority over config file values.
+
 [Back to top](#gemchangelogdiff)
 
 ## Development

data/ROADMAP.md

@@ -2,21 +2,6 @@
 
 Feature roadmap for gem_changelog_diff. Each section is auto-pruned by `bin/release` when that version ships.
 
-## 0.7.0 -- Configuration File & Polish
-
-Persistent preferences so users don't repeat flags every run.
-
-- Config file: `.gem_changelog_diff.yml` (project root) and `~/.config/gem_changelog_diff/config.yml` (user); project overrides user
-- Supported keys: `github_token`, `default_format`, `cache_ttl`, `concurrency`, `ignore_gems`, `no_color`
-- `init` subcommand: generate a commented config template
-- `version` subcommand
-- `--dry-run` flag: show which gems would be checked without fetching
-- Rails credentials support: read token from `Rails.application.credentials.dig(:gem_changelog_diff, :github_token)` when running inside a Rails app
-
-**New files:** `config_loader.rb`
-
----
-
 ## 0.8.0 -- Robustness & Edge Cases
 
 Handle the long tail of real-world gem repository patterns.

data/lib/gem_changelog_diff/cli.rb

@@ -25,9 +25,11 @@ module GemChangelogDiff
     class_option :output, type: :string, desc: "Write output to file instead of stdout"
     class_option :interactive, type: :boolean, default: false, aliases: "-i",
                                desc: "Interactively select gems to check"
+    class_option :dry_run, type: :boolean, default: false, desc: "Show which gems would be checked"
 
     desc "check [GEM...]", "Show changelog diffs for outdated gems"
     def check(*gem_names)
+      load_config
       configure_token
       gems = detect_gems
       gems = filter_gems(gems, gem_names)
@@ -35,16 +37,18 @@ module GemChangelogDiff
 
       gems = Interactive.new(gems: gems).select if options[:interactive]
       return say("No gems selected.") if gems.empty?
+      return dry_run_output(gems) if options[:dry_run]
 
       output_results(gems)
     end
 
     desc "show GEM FROM_VERSION TO_VERSION", "Show changelog between two versions of a gem"
     def show(gem_name, from_version, to_version)
+      load_config
       configure_token
       gem = OutdatedGem.new(name: gem_name, current_version: from_version, newest_version: to_version)
       report = build_single_report(gem)
-      formatter = Formatters.build(format: options[:format], color: color_enabled?)
+      formatter = Formatters.build(format: resolved_format, color: color_enabled?)
       write_output(formatter.format([report]))
     end
 
@@ -59,6 +63,18 @@ module GemChangelogDiff
       end
     end
 
+    desc "init", "Generate a config file template"
+    def init
+      path = ConfigLoader::PROJECT_CONFIG_NAME
+      if File.exist?(path)
+        say "#{path} already exists."
+        return
+      end
+
+      File.write(path, config_template)
+      say "Created #{path}"
+    end
+
     desc "version", "Print version"
     def version
       say "gem_changelog_diff #{VERSION}"
@@ -68,11 +84,26 @@ module GemChangelogDiff
 
     private
 
+    def load_config
+      config = ConfigLoader.new.load
+      GemChangelogDiff.configuration.apply(config)
+    end
+
     def configure_token
       token = options[:token] || ENV.fetch("GITHUB_TOKEN", nil)
+      token ||= rails_credentials_token
+      token ||= GemChangelogDiff.configuration.github_token
       GemChangelogDiff.configuration.github_token = token if token
     end
 
+    def rails_credentials_token
+      return unless defined?(Rails) && Rails.application.respond_to?(:credentials)
+
+      Rails.application.credentials.dig(:gem_changelog_diff, :github_token)
+    rescue StandardError
+      nil
+    end
+
     def build_cache
       ttl = options[:cache_ttl] || GemChangelogDiff.configuration.cache_ttl
       enabled = !options[:no_cache] && GemChangelogDiff.configuration.cache_enabled
@@ -109,7 +140,7 @@ module GemChangelogDiff
     end
 
     def ignore_list
-      @ignore_list ||= options[:ignore] || []
+      @ignore_list ||= (options[:ignore] || []) | GemChangelogDiff.configuration.ignore_gems
     end
 
     def build_reports(gems)
@@ -119,7 +150,7 @@ module GemChangelogDiff
         github_client: GithubClient.new(cache: cache),
         changelog_parser: ChangelogParser.new(cache: cache)
       )
-      fetcher = ConcurrentFetcher.new(concurrency: options[:concurrency])
+      fetcher = ConcurrentFetcher.new(concurrency: resolved_concurrency)
 
       fetcher.fetch_all(gems) { |gem| build_gem_report(gem, rubygems_client, source_resolver) }
     end
@@ -149,12 +180,36 @@ module GemChangelogDiff
       result
     end
 
+    def dry_run_output(gems)
+      write_output(format_dry_run(gems))
+    end
+
+    def format_dry_run(gems)
+      case resolved_format
+      when "json"
+        require "json"
+        JSON.pretty_generate(gems.map(&:to_h))
+      when "markdown"
+        gems.map { |g| "- **#{g.name}** (#{g.current_version} → #{g.newest_version})" }.join("\n")
+      else
+        gems.map { |g| "#{g.name} (#{g.current_version} → #{g.newest_version})" }.join("\n")
+      end
+    end
+
     def output_results(gems)
       reports = with_spinner { build_reports(gems) }
-      formatter = Formatters.build(format: options[:format], color: color_enabled?)
+      formatter = Formatters.build(format: resolved_format, color: color_enabled?)
       write_output(formatter.format(reports))
     end
 
+    def resolved_format
+      options[:format] || GemChangelogDiff.configuration.default_format
+    end
+
+    def resolved_concurrency
+      options[:concurrency] || GemChangelogDiff.configuration.concurrency
+    end
+
     def build_single_report(gem)
       cache = build_cache
       rubygems_client = RubygemsClient.new(cache: cache)
@@ -175,7 +230,34 @@ module GemChangelogDiff
     end
 
     def color_enabled?
-      !options[:no_color]
+      !options[:no_color] && !GemChangelogDiff.configuration.no_color
+    end
+
+    def config_template
+      <<~YAML
+        # gem_changelog_diff configuration
+        # See: https://github.com/eclectic-coding/gem_changelog_diff
+
+        # GitHub personal access token (or use GITHUB_TOKEN env var)
+        # github_token: ghp_xxx
+
+        # Default output format: text, json, markdown
+        # default_format: text
+
+        # Cache TTL in seconds (default: 86400 = 24 hours)
+        # cache_ttl: 86400
+
+        # Number of concurrent fetches (default: 4)
+        # concurrency: 4
+
+        # Gems to always ignore
+        # ignore_gems:
+        #   - rake
+        #   - bundler
+
+        # Disable colored output
+        # no_color: false
+      YAML
     end
 
     def log(message)

data/lib/gem_changelog_diff/config_loader.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require "yaml"
+
+module GemChangelogDiff
+  class ConfigLoader
+    USER_CONFIG_DIR = File.join(Dir.home, ".config", "gem_changelog_diff")
+    USER_CONFIG_PATH = File.join(USER_CONFIG_DIR, "config.yml")
+    PROJECT_CONFIG_NAME = ".gem_changelog_diff.yml"
+
+    def initialize(project_dir: Dir.pwd)
+      @project_dir = project_dir
+    end
+
+    def load
+      user_config = load_file(USER_CONFIG_PATH)
+      project_config = load_file(project_config_path)
+      user_config.merge(project_config)
+    end
+
+    private
+
+    def project_config_path
+      File.join(@project_dir, PROJECT_CONFIG_NAME)
+    end
+
+    def load_file(path)
+      return {} unless File.exist?(path)
+
+      result = YAML.safe_load_file(path, permitted_classes: [], symbolize_names: true)
+      result.is_a?(Hash) ? result : {}
+    rescue Psych::SyntaxError
+      {}
+    end
+  end
+end

data/lib/gem_changelog_diff/configuration.rb

@@ -2,11 +2,24 @@
 
 module GemChangelogDiff
   class Configuration
-    attr_accessor :github_token, :cache_enabled, :cache_ttl
+    attr_accessor :github_token, :cache_enabled, :cache_ttl,
+                  :default_format, :concurrency, :ignore_gems, :no_color
+
+    VALID_KEYS = %i[github_token cache_enabled cache_ttl default_format concurrency ignore_gems no_color].freeze
 
     def initialize
       @cache_enabled = true
       @cache_ttl = 86_400
+      @default_format = "text"
+      @concurrency = 4
+      @ignore_gems = []
+      @no_color = false
+    end
+
+    def apply(hash)
+      hash.each do |key, value|
+        public_send(:"#{key}=", value) if VALID_KEYS.include?(key) && !value.nil?
+      end
     end
   end
 

data/lib/gem_changelog_diff/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GemChangelogDiff
-  VERSION = "0.6.0"
+  VERSION = "0.7.0"
 end

data/lib/gem_changelog_diff.rb

@@ -2,6 +2,7 @@
 
 require_relative "gem_changelog_diff/version"
 require_relative "gem_changelog_diff/configuration"
+require_relative "gem_changelog_diff/config_loader"
 
 module GemChangelogDiff
   class Error < StandardError; end

data/sig/gem_changelog_diff.rbs

@@ -26,8 +26,29 @@ module GemChangelogDiff
     attr_accessor github_token: String?
     attr_accessor cache_enabled: bool
     attr_accessor cache_ttl: Integer
+    attr_accessor default_format: String
+    attr_accessor concurrency: Integer
+    attr_accessor ignore_gems: Array[String]
+    attr_accessor no_color: bool
+
+    VALID_KEYS: Array[Symbol]
 
     def initialize: () -> void
+    def apply: (Hash[Symbol, untyped] hash) -> void
+  end
+
+  class ConfigLoader
+    USER_CONFIG_DIR: String
+    USER_CONFIG_PATH: String
+    PROJECT_CONFIG_NAME: String
+
+    def initialize: (?project_dir: String) -> void
+    def load: () -> Hash[Symbol, untyped]
+
+    private
+
+    def project_config_path: () -> String
+    def load_file: (String path) -> Hash[Symbol, untyped]
   end
 
   class Cache
@@ -241,12 +262,20 @@ module GemChangelogDiff
     def check: (*String gem_names) -> void
     def show: (String gem_name, String from_version, String to_version) -> void
     def cache: (?String? subcommand) -> void
+    def init: () -> void
     def version: () -> void
 
     private
 
+    def load_config: () -> void
+    def dry_run_output: (Array[OutdatedGem] gems) -> void
+    def format_dry_run: (Array[OutdatedGem] gems) -> String
+    def rails_credentials_token: () -> String?
     def output_results: (Array[OutdatedGem] gems) -> void
+    def resolved_format: () -> String
+    def resolved_concurrency: () -> Integer
     def build_single_report: (OutdatedGem gem) -> gem_report
+    def config_template: () -> String
     def with_spinner: [T] () { () -> T } -> T
     def color_enabled?: () -> bool
     def configure_token: () -> void

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gem_changelog_diff
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Chuck Smith
@@ -89,6 +89,7 @@ files:
 - lib/gem_changelog_diff/changelog_parser.rb
 - lib/gem_changelog_diff/cli.rb
 - lib/gem_changelog_diff/concurrent_fetcher.rb
+- lib/gem_changelog_diff/config_loader.rb
 - lib/gem_changelog_diff/configuration.rb
 - lib/gem_changelog_diff/detector.rb
 - lib/gem_changelog_diff/errors.rb