quality_gate 0.2.1 → 0.3.0

data/lib/quality_gate/runner.rb

@@ -23,22 +23,24 @@ module QualityGate
 
   # Runs adapters in order and reduces their findings into one immutable result.
   class Runner
-    Result = Data.define(:findings, :failed_tools, :checks) do
-      def initialize(findings:, checks: [])
+    Result = Data.define(:findings, :failed_tools, :checks, :baseline) do
+      def initialize(findings:, checks: [], baseline: nil)
         copied_findings = findings.dup.freeze
         failed_tools = copied_findings.select(&:tool_failure?).map(&:tool).uniq
         copied_checks = RunnerValueCopy.freeze_copy(checks)
+        copied_baseline = RunnerValueCopy.freeze_copy(baseline)
 
         super(
           findings: copied_findings,
           failed_tools: failed_tools.map { _1.dup.freeze }.freeze,
-          checks: copied_checks
+          checks: copied_checks,
+          baseline: copied_baseline
         )
       end
 
       # Override Data#with so replacements cannot bypass the derived-state invariant.
-      def with(findings: self.findings, checks: self.checks)
-        self.class.new(findings: findings, checks: checks)
+      def with(findings: self.findings, checks: self.checks, baseline: self.baseline)
+        self.class.new(findings: findings, checks: checks, baseline: baseline)
       end
 
       def exit_code
@@ -52,13 +54,17 @@ module QualityGate
     CHECK_SCOPES = {
       "rubocop" => "selected_files",
       "reek" => "selected_files",
+      "herb" => "selected_files",
       "test_suite" => "test_suite",
       "undercover" => "git_diff",
       "simplecov" => "coverage_summary",
       "brakeman" => "project",
-      "bundler_audit" => "lockfile"
+      "bundler_audit" => "lockfile",
+      "rubycritic" => "project",
+      "debride" => "project",
+      "database_consistency" => "project"
     }.freeze
-    SELECTION_SUPPORTED_TOOLS = %w[rubocop reek].freeze
+    SELECTION_SUPPORTED_TOOLS = %w[rubocop reek herb].freeze
     private_constant :CHECK_SCOPES, :SELECTION_SUPPORTED_TOOLS
 
     def initialize(adapters:, config:, diagnostic_io: nil)
@@ -72,7 +78,7 @@ module QualityGate
       checks = []
 
       adapters.each do |adapter|
-        tool = adapter_name(adapter)
+        tool = adapter.name.to_s
         write_progress(tool, scope_for(tool))
         started_at = monotonic_time
         adapter_findings = adapter.call
@@ -87,24 +93,16 @@ module QualityGate
 
     attr_reader :adapters, :config, :diagnostic_io
 
-    def adapter_name(adapter)
-      adapter.name.to_s
-    end
-
     def check_for(tool, findings, duration_ms)
       {
         tool: tool,
         status: status_for(findings),
         scope: scope_for(tool),
-        requested_files: selection_supported?(tool) ? requested_files : [],
+        requested_files: SELECTION_SUPPORTED_TOOLS.include?(tool) ? requested_files : [],
         duration_ms: duration_ms
       }
     end
 
-    def selection_supported?(tool)
-      SELECTION_SUPPORTED_TOOLS.include?(tool)
-    end
-
     def scope_for(tool)
       scope = CHECK_SCOPES.fetch(tool, "unknown")
       return "project" if scope == "selected_files" && requested_files.empty?

data/lib/quality_gate/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module QualityGate
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

data/lib/quality_gate.rb

@@ -14,15 +14,30 @@ module QualityGate
   # Your code goes here...
 end
 
+require_relative "quality_gate/baseline"
+require_relative "quality_gate/baseline_run"
 require_relative "quality_gate/adapter"
 require_relative "quality_gate/adapters/brakeman"
 require_relative "quality_gate/adapters/bundler_audit"
+require_relative "quality_gate/adapters/database_consistency"
+require_relative "quality_gate/adapters/herb"
 require_relative "quality_gate/adapters/reek"
 require_relative "quality_gate/adapters/rubocop"
+require_relative "quality_gate/adapters/rubycritic"
+require_relative "quality_gate/adapters/debride"
 require_relative "quality_gate/adapters/simplecov"
 require_relative "quality_gate/adapters/test_suite"
 require_relative "quality_gate/adapters/undercover"
 require_relative "quality_gate/config"
 require_relative "quality_gate/runner"
+require_relative "quality_gate/doctor_report"
+require_relative "quality_gate/reporters/doctor"
+require_relative "quality_gate/doctor_bounded_file"
+require_relative "quality_gate/doctor_launchers"
+require_relative "quality_gate/doctor_git"
+require_relative "quality_gate/doctor_coverage"
+require_relative "quality_gate/doctor_hooks"
+require_relative "quality_gate/doctor"
+require_relative "quality_gate/doctor_command"
 require_relative "quality_gate/cli"
 require_relative "quality_gate/railtie" if defined?(Rails::Railtie)

data/sig/quality_gate.rbs

@@ -1,4 +1,9 @@
 module QualityGate
+  interface _BaselineMatch
+    def findings: () -> Array[Finding]
+    def accepted: () -> Array[Finding]
+  end
+
   VERSION: String
 
   interface _Output
@@ -8,6 +13,22 @@ module QualityGate
   class Error < StandardError
   end
 
+  class BaselineError < Error
+  end
+
+  class Baseline
+    def self.capture: (gate: String, tools: Array[String], findings: Array[Finding], root: String) -> Baseline
+    def self.read: (String path) -> Baseline
+    def self.from_h: (Hash[String, untyped] document) -> Baseline
+
+    def initialize: (gate: String, tools: Array[String], entries: Array[Hash[String, untyped]]) -> void
+    def validate_context!: (gate: String, tools: Array[String]) -> Baseline
+    def match: (Array[Finding] findings, root: String) -> _BaselineMatch
+    def write: (String path, create: bool) -> Integer
+    def count: () -> Integer
+    def to_h: () -> Hash[String, untyped]
+  end
+
   class ParseError < Error
     attr_reader tool: String
 
@@ -33,6 +54,7 @@ module QualityGate
     def create_initializers: () -> void
     def inject_coverage: () -> void
     def create_agent_integration: () -> void
+    def create_ci_workflow: () -> void
     def print_summary: () -> void
   end
 
@@ -51,6 +73,18 @@ module QualityGate
     def template_for: (String name) -> String
   end
 
+  class RailsProfile
+    attr_reader destination_root: String
+    attr_reader framework: String
+    attr_reader test_helper: String
+    attr_reader test_command: Array[String]
+
+    def initialize: (destination_root: String, ?options: Hash[Symbol, untyped]) -> void
+    def coverage?: () -> bool
+    def missing_default_helper?: () -> bool
+    def template_for: (String name) -> String
+  end
+
   class Config
     DEFAULTS: Hash[Symbol, untyped]
 
@@ -85,6 +119,10 @@ module QualityGate
     def timeout: () -> Integer
   end
 
+  class DatabaseConsistencyRunner
+    def self.run: (?stdout: _Output, ?stderr: _Output, ?cwd: String) -> (0 | 2)
+  end
+
   module Adapters
     class Brakeman < Adapter
       CONFIDENCE_MAP: Hash[String, finding_severity]
@@ -108,6 +146,24 @@ module QualityGate
       def timeout: () -> Integer
     end
 
+    class DatabaseConsistency < Adapter
+      TOOL_NAME: String
+      BRIDGE_PATH: String
+
+      def call: () -> Array[Finding]
+      def name: () -> String
+      def command: () -> Array[String]
+      def parse: (String stdout) -> Array[Finding]
+    end
+
+    class Herb < Adapter
+      def initialize: (config: Config, ?files: Array[String], ?diagnostic_io: _Output) -> void
+      def call: () -> Array[Finding]
+      def name: () -> String
+      def command: () -> Array[String]
+      def parse: (String stdout) -> Array[Finding]
+    end
+
     class RuboCop < Adapter
       SEVERITY_MAP: Hash[String, finding_severity]
       CONFIG_PATH: String
@@ -120,6 +176,24 @@ module QualityGate
       def timeout: () -> Integer
     end
 
+    class RubyCritic < Adapter
+      def initialize: (config: Config, ?files: Array[String], ?diagnostic_io: _Output) -> void
+      def call: () -> Array[Finding]
+      def name: () -> String
+      def command: () -> Array[String]
+      def parse: (String json) -> Array[Finding]
+      def timeout: () -> Integer
+    end
+
+    class Debride < Adapter
+      def initialize: (config: Config, ?files: Array[String], ?diagnostic_io: _Output) -> void
+      def call: () -> Array[Finding]
+      def name: () -> String
+      def command: () -> Array[String]
+      def parse: (String json) -> Array[Finding]
+      def timeout: () -> Integer
+    end
+
     class SimpleCov < Adapter
       COVERAGE_PATH: String
 
@@ -162,9 +236,10 @@ module QualityGate
       attr_reader findings: Array[Finding]
       attr_reader failed_tools: Array[String]
       attr_reader checks: Array[Hash[Symbol, untyped]]
+      attr_reader baseline: Hash[Symbol, untyped]?
 
-      def initialize: (findings: Array[Finding], ?checks: Array[Hash[Symbol, untyped]]) -> void
-      def with: (?findings: Array[Finding], ?checks: Array[Hash[Symbol, untyped]]) -> Result
+      def initialize: (findings: Array[Finding], ?checks: Array[Hash[Symbol, untyped]], ?baseline: Hash[Symbol, untyped]?) -> void
+      def with: (?findings: Array[Finding], ?checks: Array[Hash[Symbol, untyped]], ?baseline: Hash[Symbol, untyped]?) -> Result
       def exit_code: () -> (0 | 1 | 2)
     end
   end
@@ -175,6 +250,41 @@ module QualityGate
     def self.run: (Array[String] argv, ?stdout: _Output, ?stderr: _Output, ?dir: String) -> (0 | 1 | 2)
   end
 
+  class CodexStopHook
+    def initialize: (dir: String) -> void
+    def call: (untyped input) -> Hash[String, String]
+  end
+
+  class CodexFastHook
+    def initialize: (dir: String) -> void
+    def call: (untyped input) -> Hash[String, untyped]
+  end
+
+  class CodexPatchFiles
+    def self.parse: (String patch) -> Array[String]
+  end
+
+  class Doctor
+    def initialize: (dir: String, registry: Hash[String, untyped]) -> void
+    def call: () -> DoctorReport
+  end
+
+  class DoctorReport
+    STATUSES: Array[String]
+
+    attr_reader checks: Array[Hash[String, String]]
+    attr_reader summary: Hash[String, Integer]
+
+    def self.check: (id: String, status: String, message: String) -> Hash[String, String]
+    def initialize: (checks: Array[Hash[String, String]]) -> void
+    def exit_code: () -> (0 | 1 | 2)
+  end
+
+  class DoctorCommand
+    def initialize: (dir: String, registry: Hash[String, untyped]) -> void
+    def run: (Array[String] arguments, stdout: _Output, stderr: _Output) -> (0 | 1 | 2)
+  end
+
   class InitCommand
     def self.run: (Array[String] arguments, stdout: _Output, stderr: _Output, dir: String) -> (0 | 1 | 2)
   end
@@ -194,6 +304,11 @@ module QualityGate
       def initialize: (io: _Output) -> void
       def call: (Runner::Result result) -> nil
     end
+
+    class Doctor
+      def initialize: (io: _Output) -> void
+      def call: (DoctorReport report, format: String) -> nil
+    end
   end
 
   type finding_severity = :error | :warning | :info

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: quality_gate
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Lucian Ghinda
@@ -51,6 +51,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.3
+- !ruby/object:Gem::Dependency
+  name: fiddle
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: reek
   requirement: !ruby/object:Gem::Requirement
@@ -188,10 +202,15 @@ files:
 - lib/generators/quality_gate/install/templates/agents_section.md.tt
 - lib/generators/quality_gate/install/templates/bullet.rb.tt
 - lib/generators/quality_gate/install/templates/claude_settings.json.tt
+- lib/generators/quality_gate/install/templates/codex_fast.rb.tt
+- lib/generators/quality_gate/install/templates/codex_hooks.json.tt
+- lib/generators/quality_gate/install/templates/codex_verify_stop.rb.tt
 - lib/generators/quality_gate/install/templates/hook_log_filesystem.rb.tt
 - lib/generators/quality_gate/install/templates/quality_gate.yml.tt
 - lib/generators/quality_gate/install/templates/quality_gate_fast.rb.tt
 - lib/generators/quality_gate/install/templates/quality_gate_verify_stop.rb.tt
+- lib/generators/quality_gate/install/templates/quality_gate_workflow.yml.tt
+- lib/generators/quality_gate/install/templates/rails_quality_gate.yml.tt
 - lib/generators/quality_gate/install/templates/rubocop.yml.tt
 - lib/generators/quality_gate/install/templates/ruby_agents_section.md.tt
 - lib/generators/quality_gate/install/templates/ruby_quality_gate.yml.tt
@@ -203,13 +222,36 @@ files:
 - lib/quality_gate/adapter.rb
 - lib/quality_gate/adapters/brakeman.rb
 - lib/quality_gate/adapters/bundler_audit.rb
+- lib/quality_gate/adapters/database_consistency.rb
+- lib/quality_gate/adapters/database_consistency_report.rb
+- lib/quality_gate/adapters/database_consistency_report_item.rb
+- lib/quality_gate/adapters/debride.rb
+- lib/quality_gate/adapters/debride_report.rb
+- lib/quality_gate/adapters/herb.rb
 - lib/quality_gate/adapters/reek.rb
 - lib/quality_gate/adapters/rubocop.rb
+- lib/quality_gate/adapters/rubycritic.rb
+- lib/quality_gate/adapters/rubycritic_report.rb
 - lib/quality_gate/adapters/simplecov.rb
 - lib/quality_gate/adapters/test_suite.rb
 - lib/quality_gate/adapters/undercover.rb
+- lib/quality_gate/baseline.rb
+- lib/quality_gate/baseline_run.rb
 - lib/quality_gate/cli.rb
+- lib/quality_gate/codex_fast_hook.rb
+- lib/quality_gate/codex_patch_files.rb
+- lib/quality_gate/codex_stop_hook.rb
 - lib/quality_gate/config.rb
+- lib/quality_gate/database_consistency_runner.rb
+- lib/quality_gate/doctor.rb
+- lib/quality_gate/doctor_bounded_file.rb
+- lib/quality_gate/doctor_command.rb
+- lib/quality_gate/doctor_coverage.rb
+- lib/quality_gate/doctor_git.rb
+- lib/quality_gate/doctor_hooks.rb
+- lib/quality_gate/doctor_launchers.rb
+- lib/quality_gate/doctor_path_lookup.rb
+- lib/quality_gate/doctor_report.rb
 - lib/quality_gate/exit_code.rb
 - lib/quality_gate/finding.rb
 - lib/quality_gate/hook_log.rb
@@ -217,6 +259,7 @@ files:
 - lib/quality_gate/installation.rb
 - lib/quality_gate/installer.rb
 - lib/quality_gate/railtie.rb
+- lib/quality_gate/reporters/doctor.rb
 - lib/quality_gate/reporters/field_sanitizer.rb
 - lib/quality_gate/reporters/json.rb
 - lib/quality_gate/reporters/markdown.rb