cleo_quality_review 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 63b36db131462e8bedbfe7e7f1d42084a4f600464a6a6b881231a9254d0f4e5b
-  data.tar.gz: 5722693b1abeaee01930f71c0e3d5d57333677c2d62bd3f4eaffc613094e3e7b
+  metadata.gz: 2f7c748370590a154e611c6302e8bbfd9e5c3f8dc1b756e938ccba09101b6ee5
+  data.tar.gz: 85e837b45af4b31c23e9f59d613653a481a5e172da0581df8edc96945c4f409c
 SHA512:
-  metadata.gz: 31cf5bfcac10c05eb3f1297b132e60b1b730c951c382351879750f51362419df464c103f368e3571dfc6545070f37281827e477cf80af07420d08c8a3a7e4e37
-  data.tar.gz: 956cba96beddc95e78ec88b27d0c7e2b25f0b94dd997f8a5ee8b137ab2a34ee7be42e75fb18300fdd5abfc5260978b428d280e6359f730c0cad8b406c58f40cc
+  metadata.gz: 7f5f53a18a2cd9ef9e6e7c3456b416d4b2f0dcab0d36d3c4d75e70c1c97bb408659918c89d57ab284faf05e7111cd06f0fc39f34f1be0d08f611f48945fe9ace
+  data.tar.gz: dabda2763af548f1ef2be712d6b3a0ec8ca1ca03330a249ea91b35972176a3f37785677dd39334ff207aae8374d586358a0c1c3a1a402f0e9ac94ab1c4dadff5

data/cleo_quality_review.gemspec

@@ -24,7 +24,6 @@ Gem::Specification.new do |spec|
   spec.executables = ["check_quality"]
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "debride"
   spec.add_dependency "fasterer"
   spec.add_dependency "flog"
   spec.add_dependency "reek"

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/checks.rb

@@ -9,7 +9,6 @@ module CleoQualityReview
     require_relative "checks/reek"
     require_relative "checks/flog"
     require_relative "checks/fasterer"
-    require_relative "checks/debride"
 
     class << self
       ##

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|
@@ -116,7 +120,7 @@ module CleoQualityReview
     end
 
     def register_checks_option(opts)
-      opts.on("-c", "--checks CHECKS", Array, "Checks to run: all, reek, flog, fasterer, debride") { |values| checks.concat(values) }
+      opts.on("-c", "--checks CHECKS", Array, "Checks to run: all, reek, flog, fasterer") { |values| checks.concat(values) }
     end
 
     def register_only_option(opts)
@@ -124,7 +128,7 @@ module CleoQualityReview
     end
 
     def register_exclude_option(opts)
-      opts.on("-x", "--exclude CHECKS", Array, "Checks to exclude: reek, flog, fasterer, debride") { |values| exclude.concat(values) }
+      opts.on("-x", "--exclude CHECKS", Array, "Checks to exclude: reek, flog, fasterer") { |values| exclude.concat(values) }
     end
 
     def register_target_options(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.3.0"
 end

data/lib/cleo_quality_review.rb

@@ -14,7 +14,6 @@ module CleoQualityReview
   Checks.register("Reek", Checks::Reek, tool_type: :smell_detection)
   Checks.register("Flog", Checks::Flog, tool_type: :complexity)
   Checks.register("Fasterer", Checks::Fasterer, tool_type: :performance)
-  Checks.register("Debride", Checks::Debride, tool_type: :dead_code)
 
   ##
   # Register all supported LLM APIs for formatting output here

data/prompts/agent.md

@@ -7,7 +7,6 @@ Analyze the raw tool outputs and git diff provided. Prioritize actionable issues
 - **Flog**: Ignore scores below 40.0
 - **Reek**: Focus on FeatureEnvy, TooManyStatements, DuplicateMethodCall, NestedIterators, LongParameterList
 - **Fasterer**: Include all performance suggestions
-- **Debride**: Treat as lower-confidence static dead-code detection. Include only findings that are clearly actionable and avoid recommending deletion without checking dynamic call paths.
 
 ## Output Format
 
@@ -21,7 +20,7 @@ Output valid JSON matching this exact schema:
     "target_files": [<file paths from metadata>],
     "findings": [
       {
-        "tool_name": "<reek|flog|fasterer|debride>",
+        "tool_name": "<reek|flog|fasterer>",
         "tool_type": "<smell_detection|complexity|performance|dead_code>",
         "check": "<specific check type>",
         "filepath": "<relative file path>",
@@ -33,7 +32,7 @@ Output valid JSON matching this exact schema:
   "check_outputs": [
     {
       "check_name": "<check name>",
-      "tool_name": "<reek|flog|fasterer|debride>",
+      "tool_name": "<reek|flog|fasterer>",
       "tool_type": "<smell_detection|complexity|performance|dead_code>",
       "extension": "<json|txt>",
       "path": "<raw output artifact path>",

data/prompts/github.md

@@ -17,10 +17,6 @@ Reek:
 Fasterer:
   Severity: Low
 
-Debride:
-  Severity: Low
-  Notes: Lower-confidence static dead-code signal. Only report when the finding is specific, actionable, and unlikely to be a dynamic Rails call.
-
 
 You MUST NOT return so many items that the feedback is noisy and confusing. Limit yourself to maximum 10 comments.
 

data/prompts/human.md

@@ -1,10 +1,10 @@
 You are reviewing a local code change for code quality.
 
-The files provided include git diffs for local code changes, as well as generated output files from various code quality assessment tools including (but not limited to) Reek, Flog, Fasterer, Debride, etc.
+The files provided include git diffs for local code changes, as well as generated output files from various code quality assessment tools including (but not limited to) Reek, Flog, Fasterer, etc.
 
 Your task is to parse the static output files generated by these tools, and provide feedback to the human user. The diff provided is to allow you to map tool output to changes in the code. 
 
-YOU MUST NOT comment on the code diff itself, unless the comment is in relatinon to an issue reported by a tool.
+YOU MUST NOT comment on the code diff itself, unless the comment is in relation to an issue reported by a tool.
 
 Prioritize issues that are likely to matter to maintainability, correctness, readability, or long-term ownership. 
 
@@ -12,9 +12,8 @@ Avoid repeating tool output mechanically. If multiple issues of the same sort ar
 
 If a tool finding is low value or likely a false positive, say so briefly or omit it.
 
-Debride findings are lower-confidence static dead-code candidates. Do not recommend deleting code unless the finding is clearly supported by the changed code and dynamic call paths have been considered.
 
-The output will be printed in a unix terminal, and so colour-coded feedback is preferrable.
+The output will be printed in a Unix terminal, and so colour-coded feedback is preferable.
 
 1. Highest-impact issues first, with file and line references as clickable links when available.
 2. Suggested changes that are specific enough for an engineer or coding agent to implement.

data/prompts/pr_review.md

@@ -1,6 +1,6 @@
 You are the pipeline interface between code quality tools and GitHub pull request review comments.
 
-You will collate data from code quality tools including Reek, Flog, Fasterer, and Debride. The raw output is noisy, so your job is to identify only the most useful comments for the engineer whose PR triggered this flow.
+You will collate data from code quality tools including Reek, Flog, and Fasterer. The raw output is noisy, so your job is to identify only the most useful comments for the engineer whose PR triggered this flow.
 
 You MUST NOT comment on the code diff itself unless the comment is directly supported by a tool finding.
 
@@ -9,7 +9,6 @@ You MUST NOT comment on the code diff itself unless the comment is directly supp
 - **Flog**: Ignore scores below 40.0. Prioritize high-complexity methods because they are the most expensive to maintain.
 - **Reek**: Prefer actionable smells such as FeatureEnvy, TooManyStatements, DuplicateMethodCall, NestedIterators, and LongParameterList.
 - **Fasterer**: Low severity. Include only when the finding is clearly on code changed by this PR and the fix is straightforward.
-- **Debride**: Lower-confidence static dead-code signal. Include only when the candidate method is clearly made obsolete by this PR, and do not suggest deletion without noting possible dynamic Rails calls.
 
 ## Comment Selection
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cleo_quality_review
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Gavin Morrice
@@ -9,20 +9,6 @@ bindir: exe
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: debride
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: fasterer
   requirement: !ruby/object:Gem::Requirement
@@ -80,7 +66,6 @@ files:
 - lib/cleo_quality_review.rb
 - lib/cleo_quality_review/changes_diff.rb
 - lib/cleo_quality_review/checks.rb
-- lib/cleo_quality_review/checks/debride.rb
 - lib/cleo_quality_review/checks/fasterer.rb
 - lib/cleo_quality_review/checks/flog.rb
 - lib/cleo_quality_review/checks/quality_check.rb
@@ -92,6 +77,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

data/lib/cleo_quality_review/checks/debride.rb

@@ -1,65 +0,0 @@
-# frozen_string_literal: true
-
-require "json"
-
-require_relative "quality_check"
-
-module CleoQualityReview
-  module Checks
-    ##
-    # Quality check implementation for Debride unused-code analyzer
-    class Debride < QualityCheck
-      self.check_name = "dead_code"
-      self.tool_name = "debride"
-      self.output_extension = "json"
-
-      private
-
-      def command(files)
-        [ruby_executable, gem_executable("debride", "debride"), "--json", "--rails", *files]
-      end
-
-      def parse(stdout, stderr)
-        findings = missing_methods(stdout).flat_map do |class_name, methods|
-          results_for_class(class_name, methods)
-        end
-        return findings unless findings.empty? && stderr.to_s.strip != ""
-
-        [result(check: "Execution error", message: stderr, filepath: nil)]
-      end
-
-      def missing_methods(stdout)
-        parsed = JSON.parse(stdout.to_s)
-        missing = parsed.fetch("missing", {})
-        return {} unless missing.is_a?(Hash)
-
-        missing
-      rescue JSON::ParserError
-        {}
-      end
-
-      def results_for_class(class_name, methods)
-        Array(methods).map { |entry| method_to_result(class_name, entry) }
-      end
-
-      def method_to_result(class_name, entry)
-        method_name, location = Array(entry)
-        filepath, line = parse_location(location)
-
-        result(
-          check: "PotentialDeadMethod",
-          message: "#{class_name}##{method_name} might not be called",
-          filepath: filepath,
-          line: line,
-        )
-      end
-
-      def parse_location(location)
-        match = location.to_s.match(/\A(?<filepath>.*):(?<line>\d+)(?:-\d+)?\z/)
-        return [nil, nil] unless match
-
-        match.values_at(:filepath, :line)
-      end
-    end
-  end
-end