quiet_quality 1.1.0 → 1.2.1

data/lib/quiet_quality/tools/base_runner.rb

@@ -0,0 +1,49 @@
+module QuietQuality
+  module Tools
+    class BaseRunner
+      # In general, we don't want to supply a huge number of arguments to a command-line tool.
+      MAX_FILES = 100
+
+      def initialize(changed_files: nil, file_filter: nil)
+        @changed_files = changed_files
+        @file_filter = file_filter
+      end
+
+      def invoke!
+        @_outcome ||= performed_outcome
+      end
+
+      def tool_name
+        fail(NoMethodError, "BaseRunner subclass must implement `tool_name`")
+      end
+
+      def command
+        fail(NoMethodError, "BaseRunner subclass must implement `command`")
+      end
+
+      def success_status?(stat)
+        stat.success?
+      end
+
+      # distinct from _error_ status - this is asking "does this status represent failures-found?"
+      def failure_status?(stat)
+        stat.exitstatus == 1
+      end
+
+      private
+
+      attr_reader :changed_files, :file_filter
+
+      def performed_outcome
+        out, err, stat = Open3.capture3(*command)
+        if success_status?(stat)
+          Outcome.new(tool: tool_name, output: out, logging: err)
+        elsif failure_status?(stat)
+          Outcome.new(tool: tool_name, output: out, logging: err, failure: true)
+        else
+          fail(ExecutionError, "Execution of #{tool_name} failed with #{stat.exitstatus}")
+        end
+      end
+    end
+  end
+end

data/lib/quiet_quality/tools/brakeman/runner.rb

@@ -1,38 +1,19 @@
 module QuietQuality
   module Tools
     module Brakeman
-      class Runner
-        # These are specified in constants at the top of brakeman.rb:
-        #   https://github.com/presidentbeef/brakeman/blob/main/lib/brakeman.rb#L6-L25
-        KNOWN_EXIT_STATUSES = [3, 4, 5, 6, 7, 8].to_set
-
-        # brakeman does not support being run against a portion of the project, so neither
-        # changed_files nor file_filter is actually used. But they are accepted here because
-        # that is what Runner initializers are required to accept.
-        def initialize(changed_files: nil, file_filter: nil)
-          @changed_files = changed_files
-          @file_filter = file_filter
-        end
-
-        def invoke!
-          @_outcome ||= performed_outcome
+      class Runner < BaseRunner
+        def tool_name
+          :brakeman
         end
 
-        private
-
         def command
           ["brakeman", "-f", "json"]
         end
 
-        def performed_outcome
-          out, err, stat = Open3.capture3(*command)
-          if stat.success?
-            Outcome.new(tool: :brakeman, output: out, logging: err)
-          elsif KNOWN_EXIT_STATUSES.include?(stat.exitstatus)
-            Outcome.new(tool: :brakeman, output: out, logging: err, failure: true)
-          else
-            fail(ExecutionError, "Execution of brakeman failed with #{stat.exitstatus}")
-          end
+        # These are specified in constants at the top of brakeman.rb:
+        #   https://github.com/presidentbeef/brakeman/blob/main/lib/brakeman.rb#L6-L25
+        def failure_status?(stat)
+          [3, 4, 5, 6, 7, 8].include?(stat.exitstatus)
         end
       end
     end

data/lib/quiet_quality/tools/brakeman.rb

@@ -3,8 +3,6 @@ require_relative "./rubocop"
 module QuietQuality
   module Tools
     module Brakeman
-      ExecutionError = Class.new(Tools::Error)
-      ParsingError = Class.new(Tools::Error)
     end
   end
 end

data/lib/quiet_quality/tools/haml_lint/runner.rb

@@ -1,64 +1,29 @@
 module QuietQuality
   module Tools
     module HamlLint
-      class Runner
-        MAX_FILES = 100
-        NO_FILES_OUTPUT = %({"files": []})
-
-        # haml-lint uses the `sysexits` gem, and exits with Sysexits::EX_DATAERR for the
-        # failures case here in lib/haml_lint/cli.rb. That's mapped to status 65 - other
-        # statuses have other failure meanings, which we don't want to interpret as "problems
-        # encountered"
-        FAILURE_STATUS = 65
-
-        def initialize(changed_files: nil, file_filter: nil)
-          @changed_files = changed_files
-          @file_filter = file_filter
-        end
-
-        def invoke!
-          @_outcome ||= skip_execution? ? skipped_outcome : performed_outcome
-        end
-
-        private
-
-        attr_reader :changed_files, :file_filter
-
-        def skip_execution?
-          changed_files && relevant_files.empty?
-        end
-
-        def relevant_files
-          return nil if changed_files.nil?
-          changed_files.paths
-            .select { |path| path.end_with?(".haml") }
-            .select { |path| file_filter.nil? || file_filter.match?(path) }
+      class Runner < RelevantRunner
+        def tool_name
+          :haml_lint
         end
 
-        def target_files
-          return [] if changed_files.nil?
-          return [] if relevant_files.length > MAX_FILES
-          relevant_files
+        def no_files_output
+          %({"files": []})
         end
 
-        def command
-          return nil if skip_execution?
-          ["haml-lint", "--reporter", "json"] + target_files.sort
+        def base_command
+          ["haml-lint", "--reporter", "json"]
         end
 
-        def skipped_outcome
-          Outcome.new(tool: :haml_lint, output: NO_FILES_OUTPUT)
+        def relevant_path?(path)
+          path.end_with?(".haml")
         end
 
-        def performed_outcome
-          out, err, stat = Open3.capture3(*command)
-          if stat.success?
-            Outcome.new(tool: :haml_lint, output: out, logging: err)
-          elsif stat.exitstatus == FAILURE_STATUS
-            Outcome.new(tool: :haml_lint, output: out, logging: err, failure: true)
-          else
-            fail(ExecutionError, "Execution of haml-lint failed with #{stat.exitstatus}")
-          end
+        # haml-lint uses the `sysexits` gem, and exits with Sysexits::EX_DATAERR for the
+        # failures case here in lib/haml_lint/cli.rb. That's mapped to status 65 - other
+        # statuses have other failure meanings, which we don't want to interpret as "problems
+        # encountered"
+        def failure_status?(stat)
+          stat.exitstatus == 65
         end
       end
     end

data/lib/quiet_quality/tools/haml_lint.rb

@@ -1,8 +1,6 @@
 module QuietQuality
   module Tools
     module HamlLint
-      ExecutionError = Class.new(Tools::Error)
-      ParsingError = Class.new(Tools::Error)
     end
   end
 end

data/lib/quiet_quality/tools/markdown_lint/parser.rb

@@ -0,0 +1,34 @@
+module QuietQuality
+  module Tools
+    module MarkdownLint
+      class Parser
+        def initialize(text)
+          @text = text
+        end
+
+        def messages
+          return @_messages if defined?(@_messages)
+          messages = content.map { |entry| message_for_entry(entry) }
+          @_messages = Messages.new(messages)
+        end
+
+        private
+
+        attr_reader :text
+
+        def content
+          @_content ||= JSON.parse(text, symbolize_names: true)
+        end
+
+        def message_for_entry(entry)
+          Message.new(
+            path: entry.fetch(:filename),
+            start_line: entry.fetch(:line),
+            rule: entry.fetch(:description),
+            body: entry.fetch(:docs)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/quiet_quality/tools/markdown_lint/runner.rb

@@ -0,0 +1,28 @@
+module QuietQuality
+  module Tools
+    module MarkdownLint
+      class Runner < RelevantRunner
+        def tool_name
+          :markdown_lint
+        end
+
+        def no_files_output
+          "[]"
+        end
+
+        def command
+          return nil if skip_execution?
+          if target_files.any?
+            ["mdl", "--json"] + target_files.sort
+          else
+            ["mdl", "--json", "."]
+          end
+        end
+
+        def relevant_path?(path)
+          path.end_with?(".md")
+        end
+      end
+    end
+  end
+end

data/lib/quiet_quality/tools/markdown_lint.rb

@@ -0,0 +1,9 @@
+module QuietQuality
+  module Tools
+    module MarkdownLint
+    end
+  end
+end
+
+glob = File.expand_path("../markdown_lint/*.rb", __FILE__)
+Dir.glob(glob).sort.each { |f| require f }

data/lib/quiet_quality/tools/relevant_runner.rb

@@ -0,0 +1,55 @@
+require_relative "./base_runner"
+
+module QuietQuality
+  module Tools
+    class RelevantRunner < BaseRunner
+      # In general, we don't want to supply a huge number of arguments to a command-line tool.
+      # This will probably become configurable later.
+      MAX_FILES = 100
+
+      def invoke!
+        @_outcome ||= skip_execution? ? skipped_outcome : performed_outcome
+      end
+
+      def command
+        return nil if skip_execution?
+        base_command + target_files.sort
+      end
+
+      def relevant_path?(path)
+        fail(NoMethodError, "RelevantRunner subclass must implement `relevant_path?`")
+      end
+
+      def base_command
+        fail(NoMethodError, "RelevantRunner subclass must implement either `command` or `base_command`")
+      end
+
+      def no_files_output
+        fail(NoMethodError, "RelevantRunner subclass must implement `no_files_output`")
+      end
+
+      private
+
+      def skip_execution?
+        changed_files && relevant_files.empty?
+      end
+
+      def relevant_files
+        return nil if changed_files.nil?
+        changed_files.paths
+          .select { |path| relevant_path?(path) }
+          .select { |path| file_filter.nil? || file_filter.match?(path) }
+      end
+
+      def target_files
+        return [] if changed_files.nil?
+        return [] if relevant_files.length > MAX_FILES
+        relevant_files
+      end
+
+      def skipped_outcome
+        Outcome.new(tool: tool_name, output: no_files_output)
+      end
+    end
+  end
+end

data/lib/quiet_quality/tools/rspec/runner.rb

@@ -1,58 +1,21 @@
 module QuietQuality
   module Tools
     module Rspec
-      class Runner
-        MAX_FILES = 100
-        NO_FILES_OUTPUT = '{"examples": [], "summary": {"failure_count": 0}}'
-
-        def initialize(changed_files: nil, file_filter: nil)
-          @changed_files = changed_files
-          @file_filter = file_filter
-        end
-
-        def invoke!
-          @_outcome ||= skip_execution? ? skipped_outcome : performed_outcome
-        end
-
-        private
-
-        attr_reader :changed_files, :file_filter
-
-        def skip_execution?
-          changed_files && relevant_files.empty?
-        end
-
-        def relevant_files
-          return nil if changed_files.nil?
-          changed_files.paths
-            .select { |path| path.end_with?("_spec.rb") }
-            .select { |path| file_filter.nil? || file_filter.match?(path) }
-        end
-
-        def target_files
-          return [] if changed_files.nil?
-          return [] if relevant_files.length > MAX_FILES
-          relevant_files
+      class Runner < RelevantRunner
+        def tool_name
+          :rspec
         end
 
-        def command
-          return nil if skip_execution?
-          ["rspec", "-f", "json"] + target_files.sort
+        def no_files_output
+          '{"examples": [], "summary": {"failure_count": 0}}'
         end
 
-        def skipped_outcome
-          Outcome.new(tool: :rspec, output: NO_FILES_OUTPUT)
+        def base_command
+          ["rspec", "-f", "json"]
         end
 
-        def performed_outcome
-          out, err, stat = Open3.capture3(*command)
-          if stat.success?
-            Outcome.new(tool: :rspec, output: out, logging: err)
-          elsif stat.exitstatus == 1
-            Outcome.new(tool: :rspec, output: out, logging: err, failure: true)
-          else
-            fail(ExecutionError, "Execution of rspec failed with #{stat.exitstatus}")
-          end
+        def relevant_path?(path)
+          path.end_with?("_spec.rb")
         end
       end
     end

data/lib/quiet_quality/tools/rspec.rb

@@ -1,8 +1,6 @@
 module QuietQuality
   module Tools
     module Rspec
-      ExecutionError = Class.new(Tools::Error)
-      ParsingError = Class.new(Tools::Error)
     end
   end
 end

data/lib/quiet_quality/tools/rubocop/runner.rb

@@ -1,68 +1,21 @@
 module QuietQuality
   module Tools
     module Rubocop
-      class Runner
-        MAX_FILES = 100
-        NO_FILES_OUTPUT = '{"files": [], "summary": {"offense_count": 0}}'
-
-        def command_name
-          "rubocop"
-        end
-
-        # Supplying changed_files: nil means "run against all files".
-        def initialize(changed_files: nil, file_filter: nil)
-          @changed_files = changed_files
-          @file_filter = file_filter
-        end
-
-        def invoke!
-          @_outcome ||= skip_execution? ? skipped_outcome : performed_outcome
-        end
-
-        private
-
-        attr_reader :changed_files, :file_filter
-
-        # If we were told that _no files changed_ (which is distinct from not being told that
-        # any files changed - a [] instead of a nil), then we shouldn't run rubocop at all.
-        def skip_execution?
-          changed_files && relevant_files.empty?
-        end
-
-        # Note: if target_files goes over MAX_FILES, it's _empty_ instead - that means that
-        # we run against the full repository instead of the specific files (rubocop's behavior
-        # when no target files are specified)
-        def command
-          return nil if skip_execution?
-          [command_name, "-f", "json"] + target_files.sort
-        end
-
-        def relevant_files
-          return nil if changed_files.nil?
-          changed_files.paths
-            .select { |path| path.end_with?(".rb") }
-            .select { |path| file_filter.nil? || file_filter.match?(path) }
+      class Runner < RelevantRunner
+        def tool_name
+          :rubocop
         end
 
-        def target_files
-          return [] if changed_files.nil?
-          return [] if relevant_files.length > MAX_FILES
-          relevant_files
+        def no_files_output
+          '{"files": [], "summary": {"offense_count": 0}}'
         end
 
-        def skipped_outcome
-          Outcome.new(tool: command_name.to_sym, output: NO_FILES_OUTPUT)
+        def base_command
+          ["rubocop", "-f", "json"]
         end
 
-        def performed_outcome
-          out, err, stat = Open3.capture3(*command)
-          if stat.success?
-            Outcome.new(tool: command_name.to_sym, output: out, logging: err)
-          elsif stat.exitstatus == 1
-            Outcome.new(tool: command_name.to_sym, output: out, logging: err, failure: true)
-          else
-            fail(ExecutionError, "Execution of #{command_name} failed with #{stat.exitstatus}")
-          end
+        def relevant_path?(path)
+          path.end_with?(".rb")
         end
       end
     end

data/lib/quiet_quality/tools/rubocop.rb

@@ -1,8 +1,6 @@
 module QuietQuality
   module Tools
     module Rubocop
-      ExecutionError = Class.new(Tools::Error)
-      ParsingError = Class.new(Tools::Error)
     end
   end
 end

data/lib/quiet_quality/tools/standardrb/runner.rb

@@ -1,9 +1,21 @@
 module QuietQuality
   module Tools
     module Standardrb
-      class Runner < Rubocop::Runner
-        def command_name
-          "standardrb"
+      class Runner < RelevantRunner
+        def tool_name
+          :standardrb
+        end
+
+        def no_files_output
+          '{"files": [], "summary": {"offense_count": 0}}'
+        end
+
+        def base_command
+          ["standardrb", "-f", "json"]
+        end
+
+        def relevant_path?(path)
+          path.end_with?(".rb")
         end
       end
     end

data/lib/quiet_quality/tools/standardrb.rb

@@ -3,8 +3,6 @@ require_relative "./rubocop"
 module QuietQuality
   module Tools
     module Standardrb
-      ExecutionError = Class.new(Tools::Error)
-      ParsingError = Class.new(Tools::Error)
     end
   end
 end

data/lib/quiet_quality/tools.rb

@@ -3,9 +3,14 @@ require "open3"
 module QuietQuality
   module Tools
     Error = Class.new(::QuietQuality::Error)
+    ExecutionError = Class.new(Error)
+    ParsingError = Class.new(Error)
   end
 end
 
+require_relative "./tools/base_runner"
+require_relative "./tools/relevant_runner"
+
 glob = File.expand_path("../tools/*.rb", __FILE__)
 Dir.glob(glob).sort.each { |f| require f }
 
@@ -15,6 +20,7 @@ module QuietQuality
     AVAILABLE = {
       brakeman: Brakeman,
       haml_lint: HamlLint,
+      markdown_lint: MarkdownLint,
       rspec: Rspec,
       rubocop: Rubocop,
       standardrb: Standardrb

data/lib/quiet_quality/version.rb

@@ -1,3 +1,3 @@
 module QuietQuality
-  VERSION = "1.1.0"
+  VERSION = "1.2.1"
 end

data/lib/quiet_quality/version_control_systems/git.rb

@@ -66,12 +66,6 @@ module QuietQuality
 
       private
 
-      def changed_lines_for(diff)
-        GitDiffParser.parse(diff).flat_map do |parsed_diff|
-          parsed_diff.changed_line_numbers.to_set
-        end
-      end
-
       def committed_changed_files(base, sha)
         ChangedFiles.new(committed_changes(base, sha))
       end
@@ -105,11 +99,8 @@ module QuietQuality
       end
 
       def untracked_paths
-        out, err, stat = Open3.capture3("git", "-C", path, "ls-files", "--others", "--exclude-standard")
-        unless stat.success?
-          warn err
-          fail(Error, "git ls-files failed")
-        end
+        out, _err, stat = Open3.capture3("git", "-C", path, "ls-files", "--others", "--exclude-standard")
+        fail(Error, "git ls-files failed") unless stat.success?
         out.split
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quiet_quality
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Eric Mueller
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-27 00:00:00.000000000 Z
+date: 2023-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: git
@@ -166,9 +166,11 @@ files:
 - ".gitignore"
 - ".mdl_rules.rb"
 - ".mdlrc"
+- ".quiet_quality.ci.yml"
 - ".quiet_quality.yml"
 - ".rspec"
 - ".rubocop.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -183,9 +185,11 @@ files:
 - lib/quiet_quality/cli.rb
 - lib/quiet_quality/cli/arg_parser.rb
 - lib/quiet_quality/cli/entrypoint.rb
+- lib/quiet_quality/cli/presenter.rb
 - lib/quiet_quality/config.rb
 - lib/quiet_quality/config/builder.rb
 - lib/quiet_quality/config/finder.rb
+- lib/quiet_quality/config/logging.rb
 - lib/quiet_quality/config/options.rb
 - lib/quiet_quality/config/parsed_options.rb
 - lib/quiet_quality/config/parser.rb
@@ -195,17 +199,23 @@ files:
 - lib/quiet_quality/executors/concurrent_executor.rb
 - lib/quiet_quality/executors/pipeline.rb
 - lib/quiet_quality/executors/serial_executor.rb
+- lib/quiet_quality/logger.rb
 - lib/quiet_quality/message.rb
 - lib/quiet_quality/message_filter.rb
 - lib/quiet_quality/messages.rb
 - lib/quiet_quality/tools.rb
+- lib/quiet_quality/tools/base_runner.rb
 - lib/quiet_quality/tools/brakeman.rb
 - lib/quiet_quality/tools/brakeman/parser.rb
 - lib/quiet_quality/tools/brakeman/runner.rb
 - lib/quiet_quality/tools/haml_lint.rb
 - lib/quiet_quality/tools/haml_lint/parser.rb
 - lib/quiet_quality/tools/haml_lint/runner.rb
+- lib/quiet_quality/tools/markdown_lint.rb
+- lib/quiet_quality/tools/markdown_lint/parser.rb
+- lib/quiet_quality/tools/markdown_lint/runner.rb
 - lib/quiet_quality/tools/outcome.rb
+- lib/quiet_quality/tools/relevant_runner.rb
 - lib/quiet_quality/tools/rspec.rb
 - lib/quiet_quality/tools/rspec/parser.rb
 - lib/quiet_quality/tools/rspec/runner.rb