churn_vs_complexity 1.5.1 → 1.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dba0d67852cef763abe50d7fa5a63a7e9b4687b5232d05b281ed267cf948a0c4
-  data.tar.gz: 1839953429d9840ce96782431d530f45e8169441e54c94badf9f12fc9aea7b0a
+  metadata.gz: 843cae8dad7f09344cbea477eb73ae3d9d57945df8a5955d93d6dfc820b5a8e1
+  data.tar.gz: 5066b98af73acde0f18b233fd12efe6858bb9977c4a9d553970c6ad859db98a9
 SHA512:
-  metadata.gz: 699fad42098c2a7e9e4e1368a03fda265ef3333b0e9c0895f6095e38898cf68a36a1c15d152de98f39a4f2a3ce866ce481bea68f83033876aa0d400cfe024b57
-  data.tar.gz: dd4a1412a7c49e76c7dd7624e80f5bd06f3c5bb027402f3eba8f9842568db3f4f6a2e1f6b9b5a559af6eee61c3049e7cd8848640432e3929f4b554b9c28dc847
+  metadata.gz: 7af6d2c460fd9bb2cb78751d8a7f5cdd3ada48e9026e61ccbd3ef74a22c738bcfea4185984ffea2476a5d4b726f902c881edabf2baefa211884bfb129b59f80c
+  data.tar.gz: c3cf5e4dfd7bea34298fac9d7e2db1b7ffe58ad16acab25e9217dae0f84b43e2da7d89f147027f1ebb3fd52115538aba81a1f05bca5a0f7e13f0ad5d3a7b9aef

data/CHANGELOG.md

@@ -1,4 +1,9 @@
-## [1.5.1] - 2024-10-15
+## [1.5.2] - 2024-10-21
+
+- Fixed bug where delta mode validations would fail when the commit was a non-sha value.
+- Allow HEAD as specified commit in delta mode
+
+## [1.5.1] - 2024-10-15
 
 - Fix bug where worktree checkout silently failed
 
@@ -32,4 +37,4 @@
 
 ## [1.0.0] - 2024-06-07
 
-- Initial release
+- Initial release

data/README.md

@@ -1,3 +1,5 @@
+[![Gem Version](https://badge.fury.io/rb/churn_vs_complexity.svg)](https://badge.fury.io/rb/churn_vs_complexity)
+
 # ChurnVsComplexity
 
 A tool to visualise code complexity in a project and help direct refactoring efforts.
@@ -47,9 +49,10 @@ Usage: churn_vs_complexity [options] folder
     -q, --quarter                    Calculate churn for the quarter leading up to the most recent commit
     -y, --year                       Calculate churn for the year leading up to the most recent commit
         --timetravel N               Calculate summary for all commits at intervals of N days throughout project history or from the date specified with --since
-        --delta SHA                  Identify changes between the specified commit and the previous commit and annotate changed files with complexity score. Can be used multiple times to specify multiple commits.
+        --delta SHA                  Identify changes between the specified commit (SHA) and the previous commit and annotate changed files with complexity score. SHA can be a full or short commit hash, or the value HEAD. Can be used multiple times to specify multiple commits.
         --dry-run                    Echo the chosen options from the CLI
     -h, --help                       Display help
+        --version                    Display version
 ```
 
 Note that when using the `--timetravel` mode, the semantics of some flags are subtly different from normal mode:

data/lib/churn_vs_complexity/cli/main.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'optparse'
+
+module ChurnVsComplexity
+  module CLI
+    module Main
+      class << self
+        def run!(options, folder)
+          validate_folder!(folder)
+          validate_options!(options)
+          config = config(options)
+          config.validate!
+
+          config.checker.check(folder:)
+        end
+
+        private
+
+        def validate_folder!(folder)
+          raise ValidationError, 'No folder selected. Use --help for usage information.' if folder.nil? || folder.empty?
+          raise ValidationError, "Folder #{folder} does not exist" unless File.directory?(folder)
+        end
+
+        def validate_options!(options)
+          raise ValidationError, 'No options selected. Use --help for usage information.' if options.empty?
+          raise ValidationError, 'No language selected. Use --help for usage information.' if options[:language].nil?
+
+          return unless options[:serializer].nil?
+
+          raise ValidationError, 'No serializer selected. Use --help for usage information.'
+        end
+
+        def config(options)
+          config_class =
+            case options[:mode]
+            when :timetravel then Timetravel::Config
+            when :delta then Delta::Config
+            else Normal::Config
+            end
+          config_class.new(**options)
+        end
+      end
+    end
+  end
+end

data/lib/churn_vs_complexity/cli/parser.rb

@@ -64,7 +64,7 @@ module ChurnVsComplexity
           end
 
           opts.on('--delta SHA',
-                  'Identify changes between the specified commit and the previous commit and annotate changed files with complexity score. Can be used multiple times to specify multiple commits.',) do |value|
+                  'Identify changes between the specified commit (SHA) and the previous commit and annotate changed files with complexity score. SHA can be a full or short commit hash, or the value HEAD. Can be used multiple times to specify multiple commits.',) do |value|
             options[:mode] = :delta
             (options[:commits] ||= []) << value
           end

data/lib/churn_vs_complexity/cli.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative 'cli/parser'
+require_relative 'cli/main'
 
 module ChurnVsComplexity
   module CLI
@@ -11,33 +12,7 @@ module ChurnVsComplexity
         # First argument that is not an option is the folder
         folder = ARGV.first
 
-        validate_folder!(folder)
-        validate_options!(options)
-        config = config(options)
-        config.validate!
-        puts config.checker.check(folder:)
-      end
-
-      private
-
-      def validate_folder!(folder)
-        raise Error, 'No folder selected. Use --help for usage information.' if folder.nil? || folder.empty?
-        raise Error, "Folder #{folder} does not exist" unless File.directory?(folder)
-      end
-
-      def validate_options!(options)
-        raise Error, 'No options selected. Use --help for usage information.' if options.empty?
-        raise Error, 'No language selected. Use --help for usage information.' if options[:language].nil?
-        raise Error, 'No serializer selected. Use --help for usage information.' if options[:serializer].nil?
-      end
-
-      def config(options)
-        config_class = case options[:mode]
-                       when :timetravel then Timetravel::Config
-                       when :delta then Delta::Config
-                       else Normal::Config
-                       end
-        config_class.new(**options)
+        puts Main.run!(options, folder)
       end
     end
   end

data/lib/churn_vs_complexity/delta/checker.rb

@@ -40,12 +40,10 @@ module ChurnVsComplexity
       end
 
       def commit_summary(folder:)
-        summary = { commit: @commit }
-        if @serializer.respond_to?(:has_commit_summary?) && @serializer.has_commit_summary?
-          parent, next_commit = @factory.git_strategy(folder:).surrounding(commit: @commit)
-          summary.merge!(parent:, next_commit:)
-        end
-        summary
+        CommitHydrator.new(
+          git_strategy: @factory.git_strategy(folder:),
+          serializer: @serializer,
+        ).hydrate(@commit)
       end
 
       def valid_commit?(folder:)

data/lib/churn_vs_complexity/delta/commit_hydrator.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module ChurnVsComplexity
+  module Delta
+    class CommitHydrator
+      def initialize(git_strategy:, serializer:)
+        @git_strategy = git_strategy
+        @serializer = serializer
+      end
+
+      def hydrate(commit_sha)
+        commit = @git_strategy.object(commit_sha)
+        summary = { commit: commit.sha }
+        if @serializer.respond_to?(:has_commit_summary?) && @serializer.has_commit_summary?
+          parent, next_commit = @git_strategy.surrounding(commit:)
+          summary.merge!(parent:, next_commit:)
+        end
+        summary
+      end
+    end
+  end
+end

data/lib/churn_vs_complexity/delta/config.rb

@@ -38,7 +38,7 @@ module ChurnVsComplexity
       end
 
       def validate_commit!(commit)
-        return if commit.match?(/\A[0-9a-f]{40}\z/i) || @commit.match?(/\A[0-9a-f]{8}\z/i)
+        return if commit == 'HEAD' || commit.match?(/\A[0-9a-f]{40}\z/i) || commit.match?(/\A[0-9a-f]{8}\z/i)
 
         raise ValidationError,
               "Invalid commit: #{commit}. It must be a valid 40-character SHA-1 hash or an 8-character shortened form."

data/lib/churn_vs_complexity/delta.rb

@@ -6,6 +6,7 @@ require_relative 'delta/serializer'
 require_relative 'delta/factory'
 require_relative 'delta/complexity_annotator'
 require_relative 'delta/multi_checker'
+require_relative 'delta/commit_hydrator'
 
 module ChurnVsComplexity
   module Delta

data/lib/churn_vs_complexity/git_strategy.rb

@@ -14,13 +14,15 @@ module ChurnVsComplexity
       false
     end
 
+    def object(commit)
+      commit.is_a?(Git::Object::Commit) ? commit : @repo.object(commit)
+    end
+
     def surrounding(commit:)
-      current = @repo.object(commit)
-      parent = current.parent
-      next_commit = @repo.log(100_000).find do |c|
-        c.parents.map(&:sha).include?(current.sha)
-      end
-      [parent&.sha, next_commit&.sha]
+      current = object(commit)
+      is_head = current.sha == @repo.object('HEAD').sha
+      next_commit = is_head ? nil : @repo.log(100_000).find { |c| c.parents.map(&:sha).include?(current.sha) }
+      [current.parent&.sha, next_commit&.sha]
     end
 
     def changes(commit:)

data/lib/churn_vs_complexity/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ChurnVsComplexity
-  VERSION = '1.5.1'
+  VERSION = '1.5.2'
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: churn_vs_complexity
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 1.5.2
 platform: ruby
 authors:
 - Erik T. Madsen
 bindir: bin
 cert_chain: []
-date: 2024-10-15 00:00:00.000000000 Z
+date: 2024-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: flog
@@ -62,6 +62,7 @@ files:
 - lib/churn_vs_complexity.rb
 - lib/churn_vs_complexity/churn.rb
 - lib/churn_vs_complexity/cli.rb
+- lib/churn_vs_complexity/cli/main.rb
 - lib/churn_vs_complexity/cli/parser.rb
 - lib/churn_vs_complexity/complexity.rb
 - lib/churn_vs_complexity/complexity/eslint_calculator.rb
@@ -73,6 +74,7 @@ files:
 - lib/churn_vs_complexity/concurrent_calculator.rb
 - lib/churn_vs_complexity/delta.rb
 - lib/churn_vs_complexity/delta/checker.rb
+- lib/churn_vs_complexity/delta/commit_hydrator.rb
 - lib/churn_vs_complexity/delta/complexity_annotator.rb
 - lib/churn_vs_complexity/delta/config.rb
 - lib/churn_vs_complexity/delta/factory.rb