quiet_quality 1.1.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b6aea488d2026da63fdf9483d1df9bd4e2363270d7b441cbca384cd803cab803
-  data.tar.gz: 0536d6eb0b8cdd1c4678f49058be4d37017b7ff6156d363afa71df8a979d30aa
+  metadata.gz: b3847a8d0b996b19f34c32ac587dd1b9e51a2bedbea8e777e6b888294b16b5c0
+  data.tar.gz: 742080e4b9193d0d99606f00c68077229ffba805c5b93ffa75c09705e0101b18
 SHA512:
-  metadata.gz: 766f24f8211b83610c05e57b0f81d77bbf2d4bf8c206cc5e9af1d4e302adc9fee6425c506b344850a1421b7a30f18b6dfa6a23132aaa64dc3e6fbeb5e59c4c0b
-  data.tar.gz: 7b72dcf22a6696b2ff88a5efb08fb0338d2d4f0b43f506f147a2d5cb0ed7186328157ff4b8ded7198fff3785f6636b32d8b1ecd1102cd462b341f28c57dfd429
+  metadata.gz: b61e91968e6bdd4943809a336d60cf6a7feee9ab58db225a33f8268bd02efc911c3fa812e45491be1cc9f6d461a6db71308e790f1d912fac011c82cf4864e8d7
+  data.tar.gz: ace3273fb13dfcd04ae2432ed0cd488195789c75a27251617fc6be851bf865e4c4b689f9c3e3e83203ffb2b1ecd2be11c258405b10a3720c186b79b5e150fe3b

data/.github/workflows/dogfood.yml

@@ -27,4 +27,4 @@ jobs:
         run: bundle install --jobs 4 --retry 3
 
       - name: Run QuietQuality
-        run: bundle exec bin/qq standardrb rubocop rspec --all-files --unfiltered --annotate github_stdout --comparison-branch origin/main
+        run: bundle exec bin/qq -C .quiet_quality.ci.yml

data/.github/workflows/rspec.yml

@@ -30,4 +30,4 @@ jobs:
         run: bundle install --jobs 4 --retry 3
 
       - name: Run RSpec
-        run: bundle exec rspec
+        run: SIMPLECOV=true SIMPLECOV_TEXT=true bundle exec rspec

data/.quiet_quality.ci.yml

@@ -0,0 +1,6 @@
+---
+default_tools: ["standardrb", "rubocop", "markdown_lint", "rspec"]
+executor: concurrent
+comparison_branch: origin/main
+all_files: true
+unfiltered: true

data/.quiet_quality.yml

@@ -1,6 +1,7 @@
 ---
-default_tools: ["standardrb", "rubocop", "rspec"]
+default_tools: ["standardrb", "rubocop", "markdown_lint", "rspec"]
 executor: concurrent
 comparison_branch: main
 changed_files: false
 filter_messages: false
+logging: light

data/CHANGELOG.md

@@ -0,0 +1,63 @@
+# Changelog
+
+## Release 1.2.1
+
+* Fix the handling of the various ways to specify whether tools should limit
+  their targets to changed files or run against the entire repository. The
+  configuration systems had disagreements on what to call the options in
+  question, which resulted in some configuration entries being ignored. We
+  enforce a set of validations on reads and writes now to avoid such a problem
+  in the future (#89, resolves #88)
+* Add coverage-checking, and then improve test coverage and remove unreferenced
+  code as a result. (#87)
+
+## Release 1.2.0
+
+* Support `--light`, `--quiet`, and `--logging LEVEL` arguments for less output
+  (#78, resolves #37)
+* Support the [markdownlint](https://github.com/markdownlint/markdownlint) tool
+  (#79, resolves #58)
+* Extract BaseRunner (#82) and RelevantRunner (#83) parent classes from the tool
+  runners, to allow new tools to be more easily implemented. (Resolves #81)
+* Extract a Cli::Presenter from the Entrypoint, to simplify pending work on cli
+  presentation (#84, resolves #42)
+* Update the docs a bit, and add a changelog (hi!)
+
+## Release 1.1.0
+
+* Support a `file_filter` config entry per-tool (without a cli option), to limit
+  what file paths a runner might supply to its tool based on a regex
+  (#74, resolves #68)
+* When what tools to execute is not specified (by cli or by config file), abort
+  `bin/qq` and explain, rather than assuming "all of them" (#79, resolves #58)
+* Update the config parser to handle keys named to match the cli options
+  alongside the ones that were (mistakenly) named differently. This is a
+  backwards-compatible change; if we eventually deprecate and simplify some of
+  these option names, you'll have plenty of warning (#77, resolves #75)
+* Support `--version/-V` flag (#73, resolves #69)
+
+## Release 1.0.3
+
+* Fix the printed _output_ for the case where there were some warnings from a
+  tool, but all of them were filtered out (because they targetted lines that
+  were not changed, for example). This situation should tell you that nothing
+  is wrong with your PR, not that there is a problem (#71)
+
+## Release 1.0.2
+
+* Fix the _exit status_ for the case where there were some warnings from a
+  tool, but all of them were filtered out (because they targetted lines that
+  were not changed, for example). This situation should produce a successful
+  result, and not fail a CI pipeline (#67)
+
+## Release 1.0.1
+
+* Fix the calculation of `changed_files` for the executor - in the migration
+  to Entrypoint, the actual git call to get a ChangedFiles object to pass into
+  other service classes was lost, which had the result that the entire system
+  behaved (outside of tests) as if you were always running with `--all-files`
+  (#65).
+
+## Release 1.0.0
+
+Initial functional public release.

data/README.md

@@ -14,11 +14,13 @@ that too.
 
 So far, we have support for the following tools:
 
-* rubocop
-* standardrb
-* rspec
-* haml-lint
-* brakeman (though there's no way to run this against only changed files)
+* [rubocop](https://github.com/rubocop/rubocop)
+* [standardrb](https://github.com/standardrb/standard)
+* [rspec](https://rspec.info/)
+* [haml-lint](https://github.com/sds/haml-lint)
+* [markdownlint](https://github.com/markdownlint/markdownlint)
+* [brakeman](https://brakemanscanner.org/) (though there's no way to run this
+  against only changed files)
 
 Supporting more tools is relatively straightforward - they're implemented by
 wrapping cli invocations and parsing output files (which overall seem to be much
@@ -126,6 +128,9 @@ And then run `qq -C config/quiet_quality/linters_workflow.yml`
 
 The configuration file supports the following _global_ options (top-level keys):
 
+* `default_tools`: Which tools should be run when you `qq` without specifying?
+  Valid values are: `rubocop`, `rspec`, `standardrb`, `haml_lint`, `brakeman`,
+  and `markdown_lint`.
 * `executor`: 'serial' or 'concurrent' (the latter is the default)
 * `annotator`: none set by default, and `github_stdout` is the only supported
   value so far.
@@ -139,6 +144,10 @@ The configuration file supports the following _global_ options (top-level keys):
 * `filter_messages`: defaults to false - should the resulting messages that do
   not refer to lines that were changed or added relative to the comparison
   branch be skipped? Also possible to set for each tool.
+* `logging`: defaults to full messages printed. The `light` option
+  prints a aggregated result (e.g. "3 tools executed: 1 passed, 2 failed
+  (rubocop, standardrb)"). The `quiet` option will only return a status code,
+  printing nothing.
 
 And then each tool can have an entry, within which `changed_files` and
 `filter_messages` can be specified - the tool-specific settings override the
@@ -162,11 +171,32 @@ rspec:
 
 ### CLI Options
 
-The same options are all available on the CLI, plus some additional ones - run
-`qq --help` for a detailed list of the options, but the notable additions are:
-
-* `--help/-H`: See a list of the options
-* `--no-config/-N`: Do _not_ load a config file, even if present.
-* `--config/-C`: load the supplied config file (instead of the detected one, if
-  found)
-* `--version/-V`: what version of the gem are you using?
+To specify which _tools_ to run (and if any are specified, the `default_tools`
+from the configuration file will be ignored), you supply them as positional
+arguments: `qq rubocop rspec --all-files -L` will run the `rubocop` and `rspec`
+tools, for example.
+
+Run `qq --help` for a detailed list of the CLI options, they largely agree with
+those in the configuration file, but there are some differences. There's no way
+to specify a `file_filter` for a tool on the command-line, and there are some
+additional options available focused on managing the interactions with
+configuration files.
+
+```text
+Usage: qq [TOOLS] [GLOBAL_OPTIONS] [TOOL_OPTIONS]
+    -h, --help                       Prints this help
+    -V, --version                    Print the current version of the gem
+    -C, --config PATH                Load a config file from this path
+    -N, --no-config                  Do not load a config file, even if present
+    -E, --executor EXECUTOR          Which executor to use
+    -A, --annotate ANNOTATOR         Annotate with this annotator
+    -G, --annotate-github-stdout     Annotate with GitHub Workflow commands
+    -a, --all-files [tool]           Use the tool(s) on all files
+    -c, --changed-files [tool]       Use the tool(s) only on changed files
+    -B, --comparison-branch BRANCH   Specify the branch to compare against
+    -f, --filter-messages [tool]     Filter messages from tool(s) based on changed lines
+    -u, --unfiltered [tool]          Don't filter messages from tool(s)
+    -l, --light                      Print aggregated results only
+    -q, --quiet                      Don't print results, only return a status code
+    -L, --logging LEVEL              Specify logging mode that results will be returned in. Valid options: light, quiet
+```

data/lib/quiet_quality/cli/arg_parser.rb

@@ -45,12 +45,12 @@ module QuietQuality
       # options; if they don't, they are global options. (optparse allows an optional argument
       # to a flag if the string representing it is not a 'string in all caps'. So `[FOO]` or `foo`
       # would be optional, but `FOO` would be required. This helper simplifies handling those.
-      def read_tool_or_global_option(name, tool, value)
+      def read_tool_or_global_option(name:, into:, tool:, value:)
         if tool
           validate_value_from("tool", tool, Tools::AVAILABLE)
-          set_tool_option(tool, name, value)
+          set_tool_option(tool, into, value)
         else
-          set_global_option(name, value)
+          set_global_option(into, value)
         end
       end
 
@@ -65,6 +65,7 @@ module QuietQuality
           setup_annotation_options(parser)
           setup_file_target_options(parser)
           setup_filter_messages_options(parser)
+          setup_logging_options(parser)
         end
       end
 
@@ -113,11 +114,11 @@ module QuietQuality
 
       def setup_file_target_options(parser)
         parser.on("-a", "--all-files [tool]", "Use the tool(s) on all files") do |tool|
-          read_tool_or_global_option(:all_files, tool, true)
+          read_tool_or_global_option(name: :all_files, into: :limit_targets, tool: tool, value: false)
         end
 
         parser.on("-c", "--changed-files [tool]", "Use the tool(s) only on changed files") do |tool|
-          read_tool_or_global_option(:all_files, tool, false)
+          read_tool_or_global_option(name: :all_files, into: :limit_targets, tool: tool, value: true)
         end
 
         parser.on("-B", "--comparison-branch BRANCH", "Specify the branch to compare against") do |branch|
@@ -127,11 +128,26 @@ module QuietQuality
 
       def setup_filter_messages_options(parser)
         parser.on("-f", "--filter-messages [tool]", "Filter messages from tool(s) based on changed lines") do |tool|
-          read_tool_or_global_option(:filter_messages, tool, true)
+          read_tool_or_global_option(name: :filter_messages, into: :filter_messages, tool: tool, value: true)
         end
 
         parser.on("-u", "--unfiltered [tool]", "Don't filter messages from tool(s)") do |tool|
-          read_tool_or_global_option(:filter_messages, tool, false)
+          read_tool_or_global_option(name: :filter_messages, into: :filter_messages, tool: tool, value: false)
+        end
+      end
+
+      def setup_logging_options(parser)
+        parser.on("-l", "--light", "Print aggregated results only") do
+          set_global_option(:logging, Config::Logging::LIGHT)
+        end
+
+        parser.on("-q", "--quiet", "Don't print results, only return a status code") do
+          set_global_option(:logging, Config::Logging::QUIET)
+        end
+
+        parser.on("-L", "--logging LEVEL", "Specify logging mode that results will be returned in. Valid options: light, quiet") do |level|
+          validate_value_from("logging level", level, Config::Logging::LEVELS)
+          set_global_option(:logging, level.to_sym)
         end
       end
     end

data/lib/quiet_quality/cli/entrypoint.rb

@@ -16,8 +16,7 @@ module QuietQuality
           log_no_tools_text
         else
           executed
-          log_outcomes
-          log_messages
+          log_results
           annotate_messages
         end
 
@@ -34,6 +33,23 @@ module QuietQuality
 
       attr_reader :argv, :output_stream, :error_stream
 
+      def logger
+        @_logger ||= QuietQuality::Logger.new(stream: error_stream, logging: options.logging)
+      end
+
+      def presenter
+        @_presenter ||= Presenter.new(
+          logger: logger,
+          logging: options.logging,
+          outcomes: executor.outcomes,
+          messages: executor.messages
+        )
+      end
+
+      def log_results
+        presenter.log_results
+      end
+
       def arg_parser
         @_arg_parser ||= ArgParser.new(argv.dup)
       end
@@ -55,15 +71,15 @@ module QuietQuality
       end
 
       def log_help_text
-        error_stream.puts(arg_parser.help_text)
+        logger.puts(arg_parser.help_text)
       end
 
       def log_version_text
-        error_stream.puts(QuietQuality::VERSION)
+        logger.puts(QuietQuality::VERSION)
       end
 
       def log_no_tools_text
-        error_stream.puts(<<~TEXT)
+        logger.puts(<<~TEXT)
           You must specify one or more tools to run, either on the command-line or in the
           default_tools key in a configuration file.
         TEXT
@@ -95,31 +111,6 @@ module QuietQuality
         @_executed = executor
       end
 
-      def log_outcomes
-        executed.outcomes.each do |outcome|
-          result = outcome.success? ? "Passed" : "Failed"
-          error_stream.puts "--- #{result}: #{outcome.tool}"
-        end
-      end
-
-      def log_message(msg)
-        line_range =
-          if msg.start_line == msg.stop_line
-            msg.start_line.to_s
-          else
-            "#{msg.start_line}-#{msg.stop_line}"
-          end
-        rule_string = msg.rule ? "  [#{msg.rule}]" : ""
-        truncated_body = msg.body.gsub(/ *\n */, "\\n").slice(0, 120)
-        error_stream.puts "  #{msg.path}:#{line_range}#{rule_string}  #{truncated_body}"
-      end
-
-      def log_messages
-        return unless executed.messages.any?
-        error_stream.puts "\n\n#{executed.messages.count} messages:"
-        executed.messages.each { |msg| log_message(msg) }
-      end
-
       def annotate_messages
         return unless options.annotator
         annotator = options.annotator.new(output_stream: output_stream)

data/lib/quiet_quality/cli/presenter.rb

@@ -0,0 +1,77 @@
+module QuietQuality
+  module Cli
+    class Presenter
+      def initialize(logger:, logging:, outcomes:, messages:)
+        @logger = logger
+        @logging = logging
+        @outcomes = outcomes
+        @messages = messages
+      end
+
+      def log_results
+        return if logging.quiet?
+
+        if logging.light?
+          log_light_outcomes
+        else
+          log_outcomes
+          log_messages
+        end
+      end
+
+      private
+
+      attr_reader :logger, :logging, :outcomes, :messages
+
+      def failed_outcomes
+        @_failed_outcomes ||= outcomes.select(&:failure?)
+      end
+
+      def successful_outcomes
+        @_successful_outcomes ||= outcomes.select(&:success?)
+      end
+
+      def log_light_outcomes
+        line = "%d tools executed: %d passed, %d failed" % [
+          outcomes.count,
+          successful_outcomes.count,
+          failed_outcomes.count
+        ]
+        line += " (#{failed_outcomes.map(&:tool).join(", ")})" if failed_outcomes.any?
+        logger.puts line
+      end
+
+      def log_outcomes
+        outcomes.each do |outcome|
+          result = outcome.success? ? "Passed" : "Failed"
+          logger.puts "--- #{result}: #{outcome.tool}"
+        end
+      end
+
+      def log_messages
+        return unless messages.any?
+        logger.puts "\n\n#{messages.count} messages:"
+        messages.each { |msg| log_message(msg) }
+      end
+
+      def line_range_for(msg)
+        if msg.start_line == msg.stop_line
+          msg.start_line.to_s
+        else
+          "#{msg.start_line}-#{msg.stop_line}"
+        end
+      end
+
+      def reduce_text(s, length)
+        s.gsub(/ *\n */, "\\n").slice(0, length)
+      end
+
+      def log_message(msg)
+        line_range = line_range_for(msg)
+        rule_string = msg.rule ? "  [#{msg.rule}]" : ""
+        truncated_body = reduce_text(msg.body, 120)
+        logger.puts "  #{msg.path}:#{line_range}#{rule_string}  #{truncated_body}"
+      end
+    end
+  end
+end

data/lib/quiet_quality/config/builder.rb

@@ -85,6 +85,7 @@ module QuietQuality
           update_annotator
           update_executor
           update_comparison_branch
+          update_logging
         end
 
         def update_annotator
@@ -103,6 +104,10 @@ module QuietQuality
           set_unless_nil(options, :comparison_branch, apply.global_option(:comparison_branch))
         end
 
+        def update_logging
+          set_unless_nil(options, :logging, apply.global_option(:logging))
+        end
+
         # ---- update the tool options (apply global forms first) -------
 
         def update_tools

data/lib/quiet_quality/config/finder.rb

@@ -25,10 +25,6 @@ module QuietQuality
 
       attr_reader :from
 
-      def config_path_within(dir)
-        File.join(dir, CONFIG_FILENAME)
-      end
-
       def each_successive_enclosing_directory(max_depth: 100, &block)
         d = Pathname.new(from)
         depth = 0

data/lib/quiet_quality/config/logging.rb

@@ -0,0 +1,23 @@
+module QuietQuality
+  module Config
+    class Logging
+      LIGHT = :light
+      QUIET = :quiet
+      LEVELS = [LIGHT, QUIET].freeze
+
+      attr_accessor :level
+
+      def initialize(level: nil)
+        @level = level
+      end
+
+      def light?
+        @level == LIGHT
+      end
+
+      def quiet?
+        @level == QUIET
+      end
+    end
+  end
+end

data/lib/quiet_quality/config/options.rb

@@ -6,9 +6,15 @@ module QuietQuality
         @executor = Executors::ConcurrentExecutor
         @tools = nil
         @comparison_branch = nil
+        @logging = Logging.new
       end
 
       attr_accessor :tools, :comparison_branch, :annotator, :executor
+      attr_reader :logging
+
+      def logging=(level)
+        @logging.level = level
+      end
     end
   end
 end

data/lib/quiet_quality/config/parsed_options.rb

@@ -1,6 +1,26 @@
 module QuietQuality
   module Config
     class ParsedOptions
+      InvalidOptionName = Class.new(Error)
+
+      GLOBAL_OPTIONS = [
+        :no_config,
+        :config_path,
+        :annotator,
+        :executor,
+        :comparison_branch,
+        :logging,
+        :limit_targets,
+        :filter_messages,
+        :file_filter
+      ].to_set
+
+      TOOL_OPTIONS = [
+        :limit_targets,
+        :filter_messages,
+        :file_filter
+      ].to_set
+
       def initialize
         @tools = []
         @tool_options = {}
@@ -20,21 +40,37 @@ module QuietQuality
       end
 
       def set_global_option(name, value)
+        validate_global_option(name)
         @global_options[name.to_sym] = value
       end
 
       def global_option(name)
+        validate_global_option(name)
         @global_options.fetch(name.to_sym, nil)
       end
 
       def set_tool_option(tool, name, value)
+        validate_tool_option(name)
         @tool_options[tool.to_sym] ||= {}
         @tool_options[tool.to_sym][name.to_sym] = value
       end
 
       def tool_option(tool, name)
+        validate_tool_option(name)
         @tool_options.dig(tool.to_sym, name.to_sym)
       end
+
+      private
+
+      def validate_global_option(name)
+        return if GLOBAL_OPTIONS.include?(name.to_sym)
+        fail(InvalidOptionName, "Option name #{name} is not a recognized global ParsedOption")
+      end
+
+      def validate_tool_option(name)
+        return if TOOL_OPTIONS.include?(name.to_sym)
+        fail(InvalidOptionName, "Option name #{name} is not a recognized tool ParsedOption")
+      end
     end
   end
 end

data/lib/quiet_quality/config/parser.rb

@@ -42,10 +42,11 @@ module QuietQuality
         read_global_option(opts, :annotator, :annotator, as: :symbol, validate_from: Annotators::ANNOTATOR_TYPES)
         read_global_option(opts, :annotate, :annotator, as: :symbol, validate_from: Annotators::ANNOTATOR_TYPES)
         read_global_option(opts, :comparison_branch, :comparison_branch, as: :string)
-        read_global_option(opts, :changed_files, :changed_files, as: :boolean)
-        read_global_option(opts, :all_files, :changed_files, as: :reversed_boolean)
+        read_global_option(opts, :changed_files, :limit_targets, as: :boolean)
+        read_global_option(opts, :all_files, :limit_targets, as: :reversed_boolean)
         read_global_option(opts, :filter_messages, :filter_messages, as: :boolean)
         read_global_option(opts, :unfiltered, :filter_messages, as: :reversed_boolean)
+        read_global_option(opts, :logging, :logging, as: :symbol, validate_from: Logging::LEVELS)
       end
 
       def store_tool_options(opts)
@@ -60,8 +61,8 @@ module QuietQuality
 
         read_tool_option(opts, tool_name, :filter_messages, :filter_messages, as: :boolean)
         read_tool_option(opts, tool_name, :unfiltered, :filter_messages, as: :reversed_boolean)
-        read_tool_option(opts, tool_name, :changed_files, :changed_files, as: :boolean)
-        read_tool_option(opts, tool_name, :all_files, :changed_files, as: :reversed_boolean)
+        read_tool_option(opts, tool_name, :changed_files, :limit_targets, as: :boolean)
+        read_tool_option(opts, tool_name, :all_files, :limit_targets, as: :reversed_boolean)
         read_tool_option(opts, tool_name, :file_filter, :file_filter, as: :string)
       end
 
@@ -101,8 +102,6 @@ module QuietQuality
         when :reversed_boolean then validate_boolean(name, value)
         when :symbol then validate_symbol(name, value, from: from)
         when :string then validate_string(name, value)
-        else
-          fail ArgumentError, "validate_value does not handle type #{as}"
         end
       end
 
@@ -134,8 +133,6 @@ module QuietQuality
         when :reversed_boolean then !value
         when :string then value.to_s
         when :symbol then value.to_sym
-        else
-          fail ArgumentError, "coerce_value does not handle type #{as}"
         end
       end
     end

data/lib/quiet_quality/executors/base_executor.rb

@@ -7,7 +7,7 @@ module QuietQuality
       end
 
       def execute!
-        fail NoMethodError, "execute! should be implemented by the subclass of BaseExecutor"
+        pipelines.none?(&:failure?)
       end
 
       def outcomes
@@ -22,6 +22,14 @@ module QuietQuality
         pipelines.any?(&:failure?)
       end
 
+      def successful_outcomes
+        @_successful_outcomes ||= outcomes.select(&:success?)
+      end
+
+      def failed_outcomes
+        @_failed_outcomes ||= outcomes.select(&:failure?)
+      end
+
       private
 
       attr_reader :tools, :changed_files
@@ -31,16 +39,6 @@ module QuietQuality
           Pipeline.new(tool_options: topts, changed_files: changed_files)
         end
       end
-
-      def pipeline_by_tool
-        @_pipeline_by_tool ||= pipelines
-          .map { |p| [p.tool_name, p] }
-          .to_h
-      end
-
-      def pipeline_for(tool)
-        pipeline_by_tool.fetch(tool.to_sym)
-      end
     end
   end
 end

data/lib/quiet_quality/logger.rb

@@ -0,0 +1,17 @@
+module QuietQuality
+  class Logger
+    def initialize(stream:, logging:)
+      @stream = stream
+      @logging = logging
+    end
+
+    def puts(s)
+      return if logging.quiet?
+      stream.puts(s)
+    end
+
+    private
+
+    attr_reader :stream, :logging
+  end
+end