gem_changelog_diff 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5fff27b4446b9283fde0a59b3df642289748c7551988836dfea4260f75798d2d
-  data.tar.gz: cd72d26b57447d9fb24e70274adeadf3955637aaf2f24c3f74d8f2d92c962eec
+  metadata.gz: c58884878cc207c11af411418fb33ec4390458388c078e83197c0cad35f1b50d
+  data.tar.gz: 73f6403bc48d9a991d67d7f3da53e327acd08c004fefc3813729794dd2438112
 SHA512:
-  metadata.gz: 0ec391d55ff38fefd88ad0f9c18de86d7867b74357e2eeff19b0d84f160365faff36ce70ef329fac3dca75e0adf119dcb385efad884daae630e7108715b77c64
-  data.tar.gz: 78f6be459bd426c79c3ccc6c485a917fa5e09b6d122d08dc4f72566b49e13654d17183536f795f1a22481aede43bcaa9ae324ee6dbc25665179381105efd1377
+  metadata.gz: 231a6934a5924d3b192261bb22e9dfbf419b439e3332cb0d05623bcba85e7a712a49155351c216e36c4fd5e43d3055780fa2ef16d2e644892dc8bfcff8d6eae3
+  data.tar.gz: 740990db45157a3661635beb030fa8e57885e9da9e0373ffe1d0c3a847ace03ef7b7219ce1baac7da85d568d24091eccd67859f3079ded0e49812780cebde030

data/CHANGELOG.md

@@ -7,6 +7,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.6.0] - 2026-06-18
+
+### Added
+
+- Formatter class hierarchy: `Formatters::Text`, `Formatters::Json`, `Formatters::Markdown`
+- `--format` flag: `text` (default), `json`, or `markdown`
+- JSON output (`--format json`) for piping to `jq` or CI tools
+- Markdown output (`--format markdown`) for PR descriptions
+- `--output` flag to write formatted output to a file
+- Interactive gem selection via `tty-prompt` (`--interactive` / `-i` flag)
+- `show` subcommand: `gem_changelog_diff show rails 7.0.0 7.1.0`
+
 ## [0.5.0] - 2026-06-18
 
 ### Added
@@ -64,7 +76,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.5.0...HEAD
+[Unreleased]: https://github.com/eclectic-coding/gem_changelog_diff/compare/v0.6.0...HEAD
+[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
 [0.3.0]: https://github.com/eclectic-coding/gem_changelog_diff/releases/tag/v0.3.0

data/README.md

@@ -13,9 +13,12 @@ CLI that shows you the changelog diff for each gem before you `bundle update`, p
 - [Installation](#installation)
 - [Usage](#usage)
   - [GitHub Authentication](#github-authentication)
+  - [Output Formats](#output-formats)
   - [Output Control](#output-control)
   - [Detection Strategy](#detection-strategy)
   - [Filtering](#filtering)
+  - [Interactive Mode](#interactive-mode)
+  - [Show Subcommand](#show-subcommand)
   - [Caching](#caching)
 - [Development](#development)
 - [Contributing](#contributing)
@@ -61,6 +64,15 @@ export GITHUB_TOKEN=ghp_your_token
 gem_changelog_diff
 ```
 
+### Output Formats
+
+```bash
+gem_changelog_diff --format text      # Plain text with ANSI colors (default)
+gem_changelog_diff --format json      # JSON for piping to jq or CI tools
+gem_changelog_diff --format markdown  # Markdown for PR descriptions
+gem_changelog_diff --output report.md --format markdown  # Write to a file
+```
+
 ### Output Control
 
 ```bash
@@ -88,6 +100,24 @@ gem_changelog_diff --group development   # Filter by Bundler group
 gem_changelog_diff --ignore rails rake   # Exclude specific gems
 ```
 
+### Interactive Mode
+
+```bash
+gem_changelog_diff --interactive  # Multi-select which gems to check
+gem_changelog_diff -i             # Short alias
+```
+
+After detecting outdated gems, presents a multi-select prompt where you can choose which gems to fetch changelogs for.
+
+### Show Subcommand
+
+Look up changelogs for a specific gem between two versions, without needing a Gemfile.lock:
+
+```bash
+gem_changelog_diff show rails 7.0.8 7.1.3
+gem_changelog_diff show rails 7.0.8 7.1.3 --format json
+```
+
 ### Caching
 
 API responses are cached to `~/.cache/gem_changelog_diff/` with a 24-hour TTL. Subsequent runs reuse cached data and use ETag conditional requests to avoid consuming rate limit.

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.6.0 -- Interactive Mode & Output Formats
-
-Let users selectively browse changelogs. Support machine-readable output for CI and scripting.
-
-- Interactive gem selection via `tty-prompt` (`--interactive` / `-i` flag)
-- JSON output (`--format=json`) for piping to `jq` or CI tools
-- Markdown output (`--format=markdown`) for PR descriptions
-- `show` subcommand: `gem_changelog_diff show rails 7.0.0 7.1.0`
-- `--output` flag to write to a file
-
-**New files:** `interactive.rb`, `formatters/base.rb`, `formatters/text.rb`, `formatters/json.rb`, `formatters/markdown.rb`
-**Dependencies:** `tty-prompt` (runtime)
-
----
-
 ## 0.7.0 -- Configuration File & Polish
 
 Persistent preferences so users don't repeat flags every run.
@@ -26,6 +11,7 @@ Persistent preferences so users don't repeat flags every run.
 - `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`
 

data/lib/gem_changelog_diff/cli.rb

@@ -21,21 +21,31 @@ module GemChangelogDiff
     class_option :no_cache, type: :boolean, default: false, desc: "Disable caching"
     class_option :cache_ttl, type: :numeric, desc: "Cache TTL in seconds"
     class_option :concurrency, type: :numeric, default: 4, desc: "Number of concurrent fetches"
+    class_option :format, type: :string, default: "text", desc: "Output format (text, json, markdown)"
+    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"
 
     desc "check [GEM...]", "Show changelog diffs for outdated gems"
     def check(*gem_names)
       configure_token
       gems = detect_gems
       gems = filter_gems(gems, gem_names)
+      return say("All gems are up to date!") if gems.empty?
 
-      if gems.empty?
-        say "All gems are up to date!"
-        return
-      end
+      gems = Interactive.new(gems: gems).select if options[:interactive]
+      return say("No gems selected.") if gems.empty?
 
-      reports = with_spinner { build_reports(gems) }
-      formatter = Formatter.new(color: color_enabled?)
-      say formatter.format(reports)
+      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)
+      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?)
+      write_output(formatter.format([report]))
     end
 
     desc "cache SUBCOMMAND", "Manage the cache"
@@ -139,6 +149,31 @@ module GemChangelogDiff
       result
     end
 
+    def output_results(gems)
+      reports = with_spinner { build_reports(gems) }
+      formatter = Formatters.build(format: options[:format], color: color_enabled?)
+      write_output(formatter.format(reports))
+    end
+
+    def build_single_report(gem)
+      cache = build_cache
+      rubygems_client = RubygemsClient.new(cache: cache)
+      source_resolver = SourceResolver.new(
+        github_client: GithubClient.new(cache: cache),
+        changelog_parser: ChangelogParser.new(cache: cache)
+      )
+      build_gem_report(gem, rubygems_client, source_resolver)
+    end
+
+    def write_output(text)
+      if options[:output]
+        File.write(options[:output], "#{text}\n")
+        say "Output written to #{options[:output]}" unless options[:quiet]
+      else
+        say text
+      end
+    end
+
     def color_enabled?
       !options[:no_color]
     end

data/lib/gem_changelog_diff/formatter.rb

@@ -1,68 +1,5 @@
 # frozen_string_literal: true
 
-require "tty-color"
-
 module GemChangelogDiff
-  class Formatter
-    BOLD = "\e[1m"
-    CYAN = "\e[36m"
-    GREEN = "\e[32m"
-    YELLOW = "\e[33m"
-    RED = "\e[31m"
-    RESET = "\e[0m"
-
-    def initialize(color: default_color?)
-      @color = color
-    end
-
-    def format(gem_reports)
-      output = gem_reports.map { |report| format_gem(report) }.join("\n")
-      output + summary(gem_reports)
-    end
-
-    private
-
-    def default_color?
-      TTY::Color.color? && ENV.fetch("NO_COLOR", nil).nil?
-    end
-
-    def format_gem(report)
-      gem = report[:gem]
-      header = colorize("== #{gem.name} (#{gem.current_version} → #{gem.newest_version}) ==", BOLD, CYAN)
-
-      body = if report[:releases].empty?
-               colorize(report[:error] || "  No changelog entries found.", RED)
-             else
-               report[:releases].map { |r| format_release(r) }.join("\n")
-             end
-
-      "#{header}\n#{body}\n"
-    end
-
-    def format_release(release)
-      title = "--- #{release[:tag_name]}"
-      title += " (#{release[:published_at][0..9]})" if release[:published_at]
-      title += " ---"
-      title = colorize(title, YELLOW)
-
-      body = release[:body]&.strip.to_s
-      body = "(no release notes)" if body.empty?
-      "#{title}\n#{body}\n"
-    end
-
-    def summary(gem_reports)
-      total = gem_reports.size
-      with_changelogs = gem_reports.count { |r| !r[:releases].empty? }
-      skipped = gem_reports.count { |r| r[:error] }
-
-      line = "\n#{total} gems outdated, #{with_changelogs} with changelogs found, #{skipped} skipped"
-      colorize(line, BOLD, GREEN)
-    end
-
-    def colorize(text, *codes)
-      return text unless @color
-
-      "#{codes.join}#{text}#{RESET}"
-    end
-  end
+  Formatter = Formatters::Text
 end

data/lib/gem_changelog_diff/formatters/base.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module GemChangelogDiff
+  module Formatters
+    def self.build(format:, color: false)
+      case format
+      when "text" then Text.new(color: color)
+      when "json" then Json.new
+      when "markdown" then Markdown.new
+      else raise ArgumentError, "Unknown format: #{format}. Valid formats: text, json, markdown"
+      end
+    end
+
+    class Base
+      def initialize(color: false)
+        @color = color
+      end
+
+      def format(_gem_reports)
+        raise NotImplementedError, "#{self.class}#format must be implemented"
+      end
+
+      private
+
+      def summary_counts(gem_reports)
+        {
+          total: gem_reports.size,
+          with_changelogs: gem_reports.count { |r| !r[:releases].empty? },
+          skipped: gem_reports.count { |r| r[:error] }
+        }
+      end
+    end
+  end
+end

data/lib/gem_changelog_diff/formatters/json.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "json"
+
+module GemChangelogDiff
+  module Formatters
+    class Json < Base
+      def format(gem_reports)
+        counts = summary_counts(gem_reports)
+
+        data = {
+          gems: gem_reports.map { |report| format_gem(report) },
+          summary: counts
+        }
+
+        JSON.pretty_generate(data)
+      end
+
+      private
+
+      def format_gem(report)
+        result = {
+          gem: report[:gem].to_h,
+          releases: report[:releases].map { |r| stringify_release(r) }
+        }
+        result[:error] = report[:error] if report[:error]
+        result
+      end
+
+      def stringify_release(release)
+        {
+          tag_name: release[:tag_name],
+          name: release[:name],
+          published_at: release[:published_at],
+          body: release[:body]
+        }
+      end
+    end
+  end
+end

data/lib/gem_changelog_diff/formatters/markdown.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module GemChangelogDiff
+  module Formatters
+    class Markdown < Base
+      def format(gem_reports)
+        sections = gem_reports.map { |report| format_gem(report) }
+        sections.push(summary(gem_reports))
+        sections.join("\n")
+      end
+
+      private
+
+      def format_gem(report)
+        gem = report[:gem]
+        header = "## #{gem.name} (#{gem.current_version} → #{gem.newest_version})"
+
+        body = if report[:releases].empty?
+                 report[:error] || "No changelog entries found."
+               else
+                 report[:releases].map { |r| format_release(r) }.join("\n")
+               end
+
+        "#{header}\n\n#{body}\n"
+      end
+
+      def format_release(release)
+        title = "### #{release[:tag_name]}"
+        title += " (#{release[:published_at][0..9]})" if release[:published_at]
+
+        body = release[:body]&.strip.to_s
+        body = "*(no release notes)*" if body.empty?
+        "#{title}\n\n#{body}\n"
+      end
+
+      def summary(gem_reports)
+        counts = summary_counts(gem_reports)
+        "_#{counts[:total]} gems outdated, #{counts[:with_changelogs]} with changelogs found, " \
+          "#{counts[:skipped]} skipped_\n"
+      end
+    end
+  end
+end

data/lib/gem_changelog_diff/formatters/text.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require "tty-color"
+
+module GemChangelogDiff
+  module Formatters
+    class Text < Base
+      BOLD = "\e[1m"
+      CYAN = "\e[36m"
+      GREEN = "\e[32m"
+      YELLOW = "\e[33m"
+      RED = "\e[31m"
+      RESET = "\e[0m"
+
+      def initialize(color: default_color?)
+        super
+      end
+
+      def format(gem_reports)
+        output = gem_reports.map { |report| format_gem(report) }.join("\n")
+        output + summary(gem_reports)
+      end
+
+      private
+
+      def default_color?
+        TTY::Color.color? && ENV.fetch("NO_COLOR", nil).nil?
+      end
+
+      def format_gem(report)
+        gem = report[:gem]
+        header = colorize("== #{gem.name} (#{gem.current_version} → #{gem.newest_version}) ==", BOLD, CYAN)
+
+        body = if report[:releases].empty?
+                 colorize(report[:error] || "  No changelog entries found.", RED)
+               else
+                 report[:releases].map { |r| format_release(r) }.join("\n")
+               end
+
+        "#{header}\n#{body}\n"
+      end
+
+      def format_release(release)
+        title = "--- #{release[:tag_name]}"
+        title += " (#{release[:published_at][0..9]})" if release[:published_at]
+        title += " ---"
+        title = colorize(title, YELLOW)
+
+        body = release[:body]&.strip.to_s
+        body = "(no release notes)" if body.empty?
+        "#{title}\n#{body}\n"
+      end
+
+      def summary(gem_reports)
+        counts = summary_counts(gem_reports)
+        line = "\n#{counts[:total]} gems outdated, #{counts[:with_changelogs]} with changelogs found, " \
+               "#{counts[:skipped]} skipped"
+        colorize(line, BOLD, GREEN)
+      end
+
+      def colorize(text, *codes)
+        return text unless @color
+
+        "#{codes.join}#{text}#{RESET}"
+      end
+    end
+  end
+end

data/lib/gem_changelog_diff/interactive.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "tty-prompt"
+
+module GemChangelogDiff
+  class Interactive
+    def initialize(gems:)
+      @gems = gems
+    end
+
+    def select
+      prompt = TTY::Prompt.new
+      prompt.multi_select("Select gems to check:", per_page: 15) do |menu|
+        @gems.each do |gem|
+          menu.choice "#{gem.name} (#{gem.current_version} → #{gem.newest_version})", gem
+        end
+      end
+    end
+  end
+end

data/lib/gem_changelog_diff/version.rb

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

data/lib/gem_changelog_diff.rb

@@ -17,5 +17,10 @@ require_relative "gem_changelog_diff/github_client"
 require_relative "gem_changelog_diff/changelog_parser"
 require_relative "gem_changelog_diff/source_resolver"
 require_relative "gem_changelog_diff/concurrent_fetcher"
+require_relative "gem_changelog_diff/formatters/base"
+require_relative "gem_changelog_diff/formatters/text"
+require_relative "gem_changelog_diff/formatters/json"
+require_relative "gem_changelog_diff/formatters/markdown"
 require_relative "gem_changelog_diff/formatter"
+require_relative "gem_changelog_diff/interactive"
 require_relative "gem_changelog_diff/cli"

data/sig/gem_changelog_diff.rbs

@@ -176,35 +176,77 @@ module GemChangelogDiff
     ?error: String
   }
 
-  class Formatter
-    BOLD: String
-    CYAN: String
-    GREEN: String
-    YELLOW: String
-    RED: String
-    RESET: String
+  module Formatters
+    def self.build: (format: String, ?color: bool) -> Base
 
-    def initialize: (?color: bool) -> void
-    def format: (Array[gem_report] gem_reports) -> String
+    class Base
+      def initialize: (?color: bool) -> void
+      def format: (Array[gem_report] gem_reports) -> String
 
-    private
+      private
+
+      def summary_counts: (Array[gem_report] gem_reports) -> { total: Integer, with_changelogs: Integer, skipped: Integer }
+    end
+
+    class Text < Base
+      BOLD: String
+      CYAN: String
+      GREEN: String
+      YELLOW: String
+      RED: String
+      RESET: String
+
+      def initialize: (?color: bool) -> void
+      def format: (Array[gem_report] gem_reports) -> String
+
+      private
+
+      def default_color?: () -> bool
+      def format_gem: (gem_report report) -> String
+      def format_release: (release_hash release) -> String
+      def summary: (Array[gem_report] gem_reports) -> String
+      def colorize: (String text, *String codes) -> String
+    end
+
+    class Json < Base
+      def format: (Array[gem_report] gem_reports) -> String
+
+      private
+
+      def format_gem: (gem_report report) -> Hash[Symbol, untyped]
+      def stringify_release: (release_hash release) -> Hash[Symbol, untyped]
+    end
+
+    class Markdown < Base
+      def format: (Array[gem_report] gem_reports) -> String
+
+      private
+
+      def format_gem: (gem_report report) -> String
+      def format_release: (release_hash release) -> String
+      def summary: (Array[gem_report] gem_reports) -> String
+    end
+  end
+
+  Formatter: singleton(Formatters::Text)
 
-    def default_color?: () -> bool
-    def format_gem: (gem_report report) -> String
-    def format_release: (release_hash release) -> String
-    def summary: (Array[gem_report] gem_reports) -> String
-    def colorize: (String text, *String codes) -> String
+  class Interactive
+    def initialize: (gems: Array[OutdatedGem]) -> void
+    def select: () -> Array[OutdatedGem]
   end
 
   class CLI < Thor
     def self.exit_on_failure?: () -> bool
 
     def check: (*String gem_names) -> void
+    def show: (String gem_name, String from_version, String to_version) -> void
     def cache: (?String? subcommand) -> void
     def version: () -> void
 
     private
 
+    def output_results: (Array[OutdatedGem] gems) -> void
+    def build_single_report: (OutdatedGem gem) -> gem_report
     def with_spinner: [T] () { () -> T } -> T
     def color_enabled?: () -> bool
     def configure_token: () -> void
@@ -216,6 +258,7 @@ module GemChangelogDiff
     def ignore_list: () -> Array[String]
     def build_reports: (Array[OutdatedGem] gems) -> Array[gem_report]
     def build_gem_report: (OutdatedGem gem, RubygemsClient rubygems_client, SourceResolver source_resolver) -> gem_report
+    def write_output: (String text) -> void
     def log: (String message) -> void
     def log_warning: (String message) -> void
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gem_changelog_diff
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Chuck Smith
@@ -37,6 +37,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: tty-prompt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.23'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.23'
 - !ruby/object:Gem::Dependency
   name: tty-spinner
   requirement: !ruby/object:Gem::Requirement
@@ -79,7 +93,12 @@ files:
 - lib/gem_changelog_diff/detector.rb
 - lib/gem_changelog_diff/errors.rb
 - lib/gem_changelog_diff/formatter.rb
+- lib/gem_changelog_diff/formatters/base.rb
+- lib/gem_changelog_diff/formatters/json.rb
+- lib/gem_changelog_diff/formatters/markdown.rb
+- lib/gem_changelog_diff/formatters/text.rb
 - lib/gem_changelog_diff/github_client.rb
+- lib/gem_changelog_diff/interactive.rb
 - lib/gem_changelog_diff/lockfile_parser.rb
 - lib/gem_changelog_diff/outdated_gem.rb
 - lib/gem_changelog_diff/rubygems_client.rb