cleo_quality_review 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 63b36db131462e8bedbfe7e7f1d42084a4f600464a6a6b881231a9254d0f4e5b
-  data.tar.gz: 5722693b1abeaee01930f71c0e3d5d57333677c2d62bd3f4eaffc613094e3e7b
+  metadata.gz: 3ef174aa218590b9a2f32114c94e9ef21c73d6809e87524750d66adc70562f0b
+  data.tar.gz: d25eae8497f8b87506231b4586614729b58b93634c3ed37a935d5029abcd3056
 SHA512:
-  metadata.gz: 31cf5bfcac10c05eb3f1297b132e60b1b730c951c382351879750f51362419df464c103f368e3571dfc6545070f37281827e477cf80af07420d08c8a3a7e4e37
-  data.tar.gz: 956cba96beddc95e78ec88b27d0c7e2b25f0b94dd997f8a5ee8b137ab2a34ee7be42e75fb18300fdd5abfc5260978b428d280e6359f730c0cad8b406c58f40cc
+  metadata.gz: a3c8d5bf0d7748a797b7c82c74ff5f1e914147b16b45b13e342e49268eb5e355dcb9885953725c16f118254ff48c728782289fcf291c49478ca0aca002f071bd
+  data.tar.gz: 436193715042ed3165c0ecf04026a70e0681a96bbd5bb6adc9c842662ae405e8b5409b408c5597c21884590374b1029ef94c3230bded8667117c978511d40ce9

data/lib/cleo_quality_review/changes_diff.rb

@@ -2,7 +2,7 @@
 
 require "digest"
 
-require_relative "target_resolver"
+require_relative "git_diff_base"
 
 module CleoQualityReview
   ##
@@ -11,9 +11,13 @@ module CleoQualityReview
     ##
     # @param [Array<String>] target_files files included in the review
     # @param [CommandRunner] command_runner for executing git commands
-    def initialize(target_files:, command_runner:)
+    # @param [String] base_ref git ref to compare against
+    # @param [Boolean] strict_base whether unresolved refs should raise
+    def initialize(target_files:, command_runner:, base_ref: GitDiffBase::DEFAULT_BASE_REF, strict_base: false)
       @target_files = target_files
       @command_runner = command_runner
+      @base_ref = base_ref || GitDiffBase::DEFAULT_BASE_REF
+      @strict_base = strict_base
     end
 
     ##
@@ -30,7 +34,7 @@ module CleoQualityReview
 
     private
 
-    attr_reader :command_runner, :target_files
+    attr_reader :command_runner, :target_files, :base_ref, :strict_base
 
     def tracked_changes_diff
       command = ["git", "diff", diff_base]
@@ -56,12 +60,7 @@ module CleoQualityReview
     end
 
     def diff_base
-      @diff_base ||= begin
-        result = command_runner.run("git", "merge-base", TargetResolver::BASE_REF, "HEAD")
-        base = result.stdout.strip
-
-        result.success? && !base.empty? ? base : TargetResolver::BASE_REF
-      end
+      @diff_base ||= GitDiffBase.resolve(command_runner: command_runner, base_ref: base_ref, strict: strict_base)
     end
   end
 end

data/lib/cleo_quality_review/git_diff_base.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module CleoQualityReview
+  ##
+  # Resolves git comparison bases for changed-file and diff capture flows
+  module GitDiffBase
+    DEFAULT_BASE_REF = "origin/main"
+
+    module_function
+
+    ##
+    # @param [CommandRunner] command_runner for executing git commands
+    # @param [String] base_ref git ref to compare against
+    # @param [Boolean] strict whether unresolved refs should raise
+    # @return [String] merge-base SHA, or the base ref when non-strict resolution fails
+    def resolve(command_runner:, base_ref:, strict:)
+      result = command_runner.run("git", "merge-base", base_ref, "HEAD")
+      base = result.stdout.strip
+
+      return base if result.success? && !base.empty?
+
+      raise ArgumentError, "Could not resolve quality review base ref: #{base_ref}" if strict
+
+      base_ref
+    end
+  end
+end

data/lib/cleo_quality_review/options.rb

@@ -2,6 +2,8 @@
 
 require "optparse"
 
+require_relative "git_diff_base"
+
 module CleoQualityReview
   ##
   # Parses command-line options for the quality review CLI
@@ -23,7 +25,7 @@ module CleoQualityReview
     #   @return [Array<String>] checks to exclude
     # @!attribute [r] changed
     #   @return [Boolean] whether to filter to changed files only
-    ParseResult = Struct.new(:format, :checks, :files, :exclude, :changed, :log, :review_id, :review_file, keyword_init: true) do
+    ParseResult = Struct.new(:format, :checks, :files, :exclude, :changed, :base, :log, :review_id, :review_file, keyword_init: true) do
       ##
       # @return [String] validated review_id
       # @raise [OptionParser::MissingArgument] if review_id is blank
@@ -58,6 +60,7 @@ module CleoQualityReview
       @files = []
       @exclude = []
       @changed = false
+      @base = GitDiffBase::DEFAULT_BASE_REF
       @log = false
       @review_id = nil
       @review_file = nil
@@ -78,6 +81,7 @@ module CleoQualityReview
         files: files,
         exclude: exclude,
         changed: changed,
+        base: base,
         log: log,
         review_id: review_id,
         review_file: review_file,
@@ -86,7 +90,7 @@ module CleoQualityReview
 
     private
 
-    attr_reader :argv, :format, :checks, :files, :exclude, :changed, :log, :review_id, :review_file
+    attr_reader :argv, :format, :checks, :files, :exclude, :changed, :base, :log, :review_id, :review_file
 
     def parser
       OptionParser.new do |opts|
@@ -132,9 +136,13 @@ module CleoQualityReview
         files.concat(values)
       end
 
-      opts.on("--changed", "Only check files changed from main branch") do
+      opts.on("--changed", "Only check files changed from the base ref") do
         @changed = true
       end
+
+      opts.on("--base REF", "Git ref to compare changed files against") do |value|
+        @base = value
+      end
     end
 
     def register_output_options(opts)

data/lib/cleo_quality_review/prompt_builder.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative "target_resolver"
+require_relative "git_diff_base"
 
 module CleoQualityReview
   ##
@@ -46,7 +46,7 @@ module CleoQualityReview
     end
 
     def diff_section
-      fenced("Git diff against #{TargetResolver::BASE_REF}", "diff", artifacts.changes_diff)
+      fenced("Git diff against #{run.base_ref || GitDiffBase::DEFAULT_BASE_REF}", "diff", artifacts.changes_diff)
     end
 
     def check_outputs_section

data/lib/cleo_quality_review/run.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative "git_diff_base"
+
 module CleoQualityReview
   ##
   # Value object representing a quality review run with its configuration and results
@@ -25,6 +27,7 @@ module CleoQualityReview
   Run = Struct.new(
     :timestamp,
     :review_id,
+    :base_ref,
     :format,
     :checks,
     :target_files,
@@ -42,6 +45,7 @@ module CleoQualityReview
       {
         timestamp: timestamp,
         review_id: review_id,
+        base_ref: comparison_base_ref,
         format: format,
         checks: checks,
         target_files: target_files,
@@ -68,11 +72,18 @@ module CleoQualityReview
     def manifest_data
       {
         review_id: review_id,
+        base_ref: comparison_base_ref,
         timestamp: timestamp,
         checks: checks,
         target_files: target_files,
         ruby_files: ruby_files,
       }
     end
+
+    private
+
+    def comparison_base_ref
+      base_ref || GitDiffBase::DEFAULT_BASE_REF
+    end
   end
 end

data/lib/cleo_quality_review/run_artifacts.rb

@@ -5,6 +5,7 @@ require "fileutils"
 
 require_relative "result"
 require_relative "run"
+require_relative "git_diff_base"
 require_relative "run_artifacts/raw_check_outputs"
 
 module CleoQualityReview
@@ -79,6 +80,7 @@ module CleoQualityReview
       Run.new(
         timestamp: manifest.fetch("timestamp"),
         review_id: manifest.fetch("review_id"),
+        base_ref: manifest.fetch("base_ref", GitDiffBase::DEFAULT_BASE_REF),
         format: format,
         checks: manifest.fetch("checks", []),
         target_files: target_files,

data/lib/cleo_quality_review/runner.rb

@@ -6,6 +6,7 @@ require "json"
 require_relative "changes_diff"
 require_relative "checks"
 require_relative "command_runner"
+require_relative "git_diff_base"
 require_relative "run"
 require_relative "run_artifacts"
 require_relative "target_resolver"
@@ -16,12 +17,13 @@ module CleoQualityReview
   class Runner
     ##
     # Grouped values resolved at the start of an analysis run
-    AnalysisContext = Struct.new(:timestamp, :target, :changes, :review_id, :check_classes, keyword_init: true) do
+    AnalysisContext = Struct.new(:timestamp, :base_ref, :target, :changes, :review_id, :check_classes, keyword_init: true) do
       ##
       # @return [Hash] run construction attributes derived from this context
       def run_attributes
         {
           timestamp: timestamp,
+          base_ref: base_ref,
           review_id: review_id,
           checks: check_classes.map(&:check_name),
           target_files: target.files,
@@ -69,21 +71,26 @@ module CleoQualityReview
 
       AnalysisContext.new(
         timestamp: timestamp,
+        base_ref: base_ref,
         target: target,
         changes: changes,
-        review_id: review_id_for(changes, check_classes),
+        review_id: review_id_for(changes, check_classes, base_ref: base_ref),
         check_classes: check_classes,
       )
     end
 
     def resolve_target
       files = options.files
-      changed = options.changed || files.empty?
-      TargetResolver.new(command_runner: command_runner).resolve(files, changed: changed)
+      TargetResolver.new(command_runner: command_runner, base_ref: base_ref).resolve(files, changed: changed_mode?)
     end
 
     def changes_diff(target)
-      ChangesDiff.new(target_files: target.files, command_runner: command_runner)
+      ChangesDiff.new(
+        target_files: target.files,
+        command_runner: command_runner,
+        base_ref: base_ref,
+        strict_base: changed_mode?,
+      )
     end
 
     def prepare_artifacts(context)
@@ -146,13 +153,24 @@ module CleoQualityReview
       artifacts.write_run(run)
     end
 
-    def review_id_for(changes, check_classes)
+    def review_id_for(changes, check_classes, base_ref:)
+      payload = {
+        diff: changes.to_s,
+        checks: check_classes.map(&:check_name).sort,
+      }
+      payload[:base_ref] = base_ref unless base_ref == GitDiffBase::DEFAULT_BASE_REF
+
       Digest::SHA256.hexdigest(
-        JSON.generate(
-          diff: changes.to_s,
-          checks: check_classes.map(&:check_name).sort,
-        ),
+        JSON.generate(payload),
       )
     end
+
+    def changed_mode?
+      options.changed || options.files.empty?
+    end
+
+    def base_ref
+      options.base || GitDiffBase::DEFAULT_BASE_REF
+    end
   end
 end

data/lib/cleo_quality_review/target_resolver.rb

@@ -1,12 +1,13 @@
 # frozen_string_literal: true
 
 require_relative "configuration"
+require_relative "git_diff_base"
 
 module CleoQualityReview
   ##
   # Resolves target files for quality review based on git changes and configuration
   class TargetResolver
-    BASE_REF = "origin/main"
+    BASE_REF = GitDiffBase::DEFAULT_BASE_REF
 
     ##
     # Value object containing resolved file lists
@@ -20,9 +21,11 @@ module CleoQualityReview
     ##
     # @param [CommandRunner] command_runner for executing git commands
     # @param [Configuration] configuration file filtering configuration
-    def initialize(command_runner:, configuration: Configuration.load)
+    # @param [String] base_ref git ref to compare changed files against
+    def initialize(command_runner:, configuration: Configuration.load, base_ref: GitDiffBase::DEFAULT_BASE_REF)
       @command_runner = command_runner
       @configuration = configuration
+      @base_ref = base_ref || GitDiffBase::DEFAULT_BASE_REF
     end
 
     ##
@@ -41,7 +44,7 @@ module CleoQualityReview
 
     private
 
-    attr_reader :command_runner, :configuration
+    attr_reader :command_runner, :configuration, :base_ref
 
     def resolve_target_files(files, changed:)
       candidates = resolve_candidates(files, changed: changed)
@@ -91,12 +94,7 @@ module CleoQualityReview
     end
 
     def diff_base
-      @diff_base ||= begin
-        result = command_runner.run("git", "merge-base", BASE_REF, "HEAD")
-        base = result.stdout.strip
-
-        result.success? && !base.empty? ? base : BASE_REF
-      end
+      @diff_base ||= GitDiffBase.resolve(command_runner: command_runner, base_ref: base_ref, strict: true)
     end
 
     def expand_target_paths(paths)

data/lib/cleo_quality_review/version.rb

@@ -3,5 +3,5 @@
 module CleoQualityReview
   ##
   # Gem version
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cleo_quality_review
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Gavin Morrice
@@ -92,6 +92,7 @@ files:
 - lib/cleo_quality_review/configuration.rb
 - lib/cleo_quality_review/diff_map.rb
 - lib/cleo_quality_review/formatter.rb
+- lib/cleo_quality_review/git_diff_base.rb
 - lib/cleo_quality_review/github_review_builder.rb
 - lib/cleo_quality_review/github_review_publisher.rb
 - lib/cleo_quality_review/llm_client.rb