Refactor OutdatedGem; install FactoryBot for improved test coverage

.rubocop.yml

@@ -1,4 +1,5 @@
 require:
+  - rubocop-factory_bot
   - rubocop-minitest
   - rubocop-packaging
   - rubocop-performance

Gemfile

@@ -3,14 +3,17 @@
 source "https://rubygems.org"
 gemspec
 
+gem "factory_bot", "~> 6.3.0"
 gem "minitest", "~> 5.11"
 gem "minitest-snapshots", "~> 1.1"
 gem "mocha", "~> 2.4"
+gem "observer"
 gem "rake", "~> 13.0"
 
 if RUBY_VERSION >= "3.3"
   gem "mighty_test", "~> 0.3"
   gem "rubocop", "1.64.1"
+  gem "rubocop-factory_bot", "2.26.1"
   gem "rubocop-minitest", "0.35.0"
   gem "rubocop-packaging", "0.5.2"
   gem "rubocop-performance", "1.21.1"

lib/bundle_update_interactive/cli/table.rb

@@ -28,7 +28,7 @@ def render_gem(name)
 
     def render
       lines = [render_header]
-      rows.each_key { |name| lines << render_gem(name) }
+      rows.keys.sort.each { |name| lines << render_gem(name) }
       lines.join("\n")
     end
 

lib/bundle_update_interactive/outdated_gem.rb

@@ -2,19 +2,21 @@
 
 module BundleUpdateInteractive
   class OutdatedGem
-    attr_reader :current_lockfile_entry, :updated_lockfile_entry, :gemfile_groups
-    attr_writer :vulnerable
+    attr_accessor :name,
+                  :gemfile_groups,
+                  :git_source_uri,
+                  :current_version,
+                  :current_git_version,
+                  :updated_version,
+                  :updated_git_version
 
-    def initialize(current_lockfile_entry:, updated_lockfile_entry:, gemfile_groups:)
-      @current_lockfile_entry = current_lockfile_entry
-      @updated_lockfile_entry = updated_lockfile_entry
-      @gemfile_groups = gemfile_groups
-      @changelog_locator = ChangelogLocator.new
+    attr_writer :rubygems_source, :vulnerable
+
+    def initialize(**attrs)
       @vulnerable = nil
-    end
+      @changelog_locator = ChangelogLocator.new
 
-    def name
-      current_lockfile_entry.name
+      attrs.each { |name, value| public_send(:"#{name}=", value) }
     end
 
     def semver_change
@@ -25,13 +27,17 @@ def vulnerable?
       @vulnerable
     end
 
+    def rubygems_source?
+      @rubygems_source
+    end
+
     def changelog_uri
       return @changelog_uri if defined?(@changelog_uri)
 
       @changelog_uri =
         if git_version_changed?
           "https://github.com/#{github_repo}/compare/#{current_git_version}...#{updated_git_version}"
-        elsif updated_lockfile_entry.rubygems_source?
+        elsif rubygems_source?
           changelog_locator.find_changelog_uri(name: name, version: updated_version.to_s)
         else
           begin
@@ -42,22 +48,6 @@ def changelog_uri
         end
     end
 
-    def current_version
-      current_lockfile_entry.version
-    end
-
-    def updated_version
-      updated_lockfile_entry.version
-    end
-
-    def current_git_version
-      current_lockfile_entry.git_version
-    end
-
-    def updated_git_version
-      updated_lockfile_entry.git_version
-    end
-
     def git_version_changed?
       current_git_version && updated_git_version && current_git_version != updated_git_version
     end
@@ -69,8 +59,7 @@ def git_version_changed?
     def github_repo
       return nil unless updated_git_version
 
-      updated_lockfile_entry.git_source_uri.to_s[%r{^(?:git@github.com:|https://github.com/)([^/]+/[^/]+?)(:?\.git)?(?:$|/)}i,
-                                                 1]
+      git_source_uri.to_s[%r{^(?:git@github.com:|https://github.com/)([^/]+/[^/]+?)(:?\.git)?(?:$|/)}i, 1]
     end
   end
 end

lib/bundle_update_interactive/report.rb

@@ -21,16 +21,12 @@ def generate
 
     def initialize(gemfile:, current_lockfile:, updated_lockfile:)
       @current_lockfile = current_lockfile
-      outdated_names = current_lockfile.entries.each_with_object([]) do |current_entry, arr|
-        updated_entry = updated_lockfile[current_entry.name]
-        arr << current_entry.name if current_entry.older_than?(updated_entry)
-      end
-      @outdated_gems ||= outdated_names.sort.each_with_object({}) do |name, hash|
-        hash[name] = OutdatedGem.new(
-          current_lockfile_entry: current_lockfile[name],
-          updated_lockfile_entry: updated_lockfile[name],
-          gemfile_groups: gemfile[name]&.groups
-        )
+      @outdated_gems ||= current_lockfile.entries.each_with_object({}) do |current_lockfile_entry, hash|
+        name = current_lockfile_entry.name
+        updated_lockfile_entry = updated_lockfile[name]
+        next unless current_lockfile_entry.older_than?(updated_lockfile_entry)
+
+        hash[name] = build_outdated_gem(current_lockfile_entry, updated_lockfile_entry, gemfile[name]&.groups)
       end.freeze
     end
 
@@ -39,12 +35,14 @@ def [](gem_name)
     end
 
     def updateable_gems
-      outdated_gems.reject { |_, gem| gem.current_lockfile_entry.exact_dependency? }
+      @updateable_gems ||= outdated_gems.reject do |name, _|
+        current_lockfile[name].exact_dependency?
+      end.freeze
     end
 
     def expand_gems_with_exact_dependencies(*gem_names)
       gem_names.flatten!
-      gem_names.flat_map { [_1, *outdated_gems[_1].current_lockfile_entry.exact_dependencies] }.uniq
+      gem_names.flat_map { |name| [name, *current_lockfile[name].exact_dependencies] }.uniq
     end
 
     def scan_for_vulnerabilities!
@@ -68,5 +66,18 @@ def bundle_update!(*gem_names)
     private
 
     attr_reader :current_lockfile
+
+    def build_outdated_gem(current_lockfile_entry, updated_lockfile_entry, gemfile_groups)
+      OutdatedGem.new(
+        name: current_lockfile_entry.name,
+        gemfile_groups: gemfile_groups,
+        rubygems_source: updated_lockfile_entry.rubygems_source?,
+        git_source_uri: updated_lockfile_entry.git_source_uri&.to_s,
+        current_version: current_lockfile_entry.version.to_s,
+        current_git_version: current_lockfile_entry.git_version&.strip,
+        updated_version: updated_lockfile_entry.version.to_s,
+        updated_git_version: updated_lockfile_entry.git_version&.strip
+      )
+    end
   end
 end

test/bundle_update_interactive/cli/row_test.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+class BundleUpdateInteractive::CLI
+  class RowTest < Minitest::Test
+    def test_formatted_gem_name_for_vulnerable_gem_is_red_on_white
+      outdated_gem = build(:outdated_gem, name: "rails", vulnerable: true)
+      row = Row.new(outdated_gem)
+
+      assert_equal "\e[37;41mrails\e[0m", row.formatted_gem_name
+    end
+
+    def test_formatted_updated_version_highlights_diff_in_cyan_regardless_of_semver_change
+      outdated_gem = build(
+        :outdated_gem,
+        current_version: "7.0.5",
+        updated_version: "7.1.2",
+        current_git_version: "a1a1207",
+        updated_git_version: "0e5bafe"
+      )
+      row = Row.new(outdated_gem)
+
+      assert_equal "7.\e[36m1.2\e[0m \e[36m0e5bafe\e[0m", row.formatted_updated_version
+    end
+
+    def test_name_and_version_red_if_major_semver_change
+      outdated_gem = build(:outdated_gem, name: "rails", current_version: "6.1.2", updated_version: "7.0.3")
+      row = Row.new(outdated_gem)
+
+      assert_equal "\e[31mrails\e[0m", row.formatted_gem_name
+      assert_equal "\e[31m7.0.3\e[0m", row.formatted_updated_version
+    end
+
+    def test_name_and_version_yellow_if_minor_semver_change
+      outdated_gem = build(:outdated_gem, name: "rails", current_version: "7.0.3", updated_version: "7.1.0")
+      row = Row.new(outdated_gem)
+
+      assert_equal "\e[33mrails\e[0m", row.formatted_gem_name
+      assert_equal "7.\e[33m1.0\e[0m", row.formatted_updated_version
+    end
+
+    def test_name_and_version_green_if_patch_semver_change
+      outdated_gem = build(:outdated_gem, name: "rails", current_version: "7.0.3", updated_version: "7.0.4")
+      row = Row.new(outdated_gem)
+
+      assert_equal "\e[32mrails\e[0m", row.formatted_gem_name
+      assert_equal "7.0.\e[32m4\e[0m", row.formatted_updated_version
+    end
+
+    def test_formatted_gemfile_groups_handles_nil_groups
+      outdated_gem = build(:outdated_gem, gemfile_groups: nil)
+      row = Row.new(outdated_gem)
+
+      assert_nil row.formatted_gemfile_groups
+    end
+
+    def test_formatted_gemfile_groups_returns_comma_separated_symbols
+      outdated_gem = build(:outdated_gem, gemfile_groups: %i[development test])
+      row = Row.new(outdated_gem)
+
+      assert_equal ":development, :test", row.formatted_gemfile_groups
+    end
+  end
+end

test/factories/outdated_gems.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  factory :outdated_gem, class: "BundleUpdateInteractive::OutdatedGem" do
+    current_git_version { nil }
+    current_version { "7.0.3" }
+    git_source_uri { nil }
+    name { "rails" }
+    rubygems_source { true }
+    updated_git_version { nil }
+    updated_version { "7.1.0" }
+    vulnerable { false }
+  end
+end

test/support/factory_bot.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "factory_bot"
+
+FactoryBot.find_definitions
+
+class Minitest::Test
+  include FactoryBot::Syntax::Methods
+end

test/test_helper.rb

@@ -6,3 +6,5 @@
 require "mocha/minitest"
 
 BundleUpdateInteractive.pastel = Pastel.new(enabled: true)
+
+Dir[File.expand_path("support/**/*.rb", __dir__)].sort.each { |rb| require(rb) }