quiet_quality 1.2.0 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae3f031f4d627e624ce2ae28a5cf58d8e9e0663822371089d54bda51cb1aefeb
-  data.tar.gz: c9c26fd4d3df19e70162b38ef78622cc569ea492656d9264c4a41a964931934a
+  metadata.gz: 6876b975446f39615f129b4fd35f3543bb998024ea292edcac1e6e1a90f7b59b
+  data.tar.gz: 277492ea2e6b93854e3b7d16f0184a50b5c756683929fb2a1081415e8e9836df
 SHA512:
-  metadata.gz: 6925f90d2f144b9bd59b4f0ca8d9a28e41cebf8570b30e3fa85cee6eefe2961aaaf246f733cd9b62de0d070afb7cca545c650ead15e45a6a39372d34c4240023
-  data.tar.gz: 3589c916dab556a467ab64c974ea91eda6a4f6f229ccda58aa51488b13b3a9a44217206fb3962697570cd176fb1bd282bee6231eccad5b50e1d948f0758eb8fb
+  metadata.gz: 7d0acaa14243573095f8741b9ca45cf56608b4ffde72f3ecd36a6ebd03cb0aeb45541ef3e4dad1c681976d5cdc3226d738a489b754d80590be032c31bbc8520b
+  data.tar.gz: 8e8daf77522762cca13480745f30df25cb2e445f2f7c69f98c20af9bc3b03bc8568299b8403ddbbc2e09fef750d3b3944c1a6f9b8dc2e4e22a4389a5419d05ab

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/CHANGELOG.md

@@ -1,5 +1,27 @@
 # Changelog
 
+## Release 1.2.2
+
+* Add some code to the Rspec::Parser that _cleans_ the json of certain text that
+  simplecov may write into the rspec json output. (#91, resolves #86)
+* Include the name of the originating tool in the printed message, and the
+  annotation, when a warning is presented. (#90 resolves #72)
+* Support `normal` as a logging level, and the `--normal` and `-n` cli
+  arguments. This is the default value, so this really only matters if your
+  config file sets another value and you want to override it from the cli.
+  (#91, resolves #86)
+
+## 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

data/lib/quiet_quality/annotators/github_stdout.rb

@@ -18,10 +18,12 @@ module QuietQuality
       # ::warning file={name},line={line},title={title}::{message}
       # See https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#setting-a-warning-message
       def self.format(message)
+        title = message.tool_name.to_s
+        title += " #{message.rule}" if message.rule
         attributes = {
           file: message.path,
           line: message.annotated_line || message.start_line,
-          title: message.rule
+          title: title
         }.compact
 
         attributes_string = attributes.map { |k, v| "#{k}=#{v}" }.join(",")

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
 
@@ -114,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|
@@ -128,15 +128,19 @@ 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("-n", "--normal", "Print outcomes and messages") do
+          set_global_option(:logging, Config::Logging::NORMAL)
+        end
+
         parser.on("-l", "--light", "Print aggregated results only") do
           set_global_option(:logging, Config::Logging::LIGHT)
         end

data/lib/quiet_quality/cli/entrypoint.rb

@@ -62,14 +62,6 @@ module QuietQuality
         parsed_options.helping?
       end
 
-      def quiet_logging?
-        options.logging.quiet?
-      end
-
-      def light_logging?
-        options.logging.light?
-      end
-
       def printing_version?
         parsed_options.printing_version?
       end

data/lib/quiet_quality/cli/presenter.rb

@@ -70,7 +70,7 @@ module QuietQuality
         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}"
+        logger.puts "#{msg.tool_name}  #{msg.path}:#{line_range}#{rule_string}  #{truncated_body}"
       end
     end
   end

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

@@ -3,11 +3,12 @@ module QuietQuality
     class Logging
       LIGHT = :light
       QUIET = :quiet
-      LEVELS = [LIGHT, QUIET].freeze
+      NORMAL = :normal
+      LEVELS = [LIGHT, QUIET, NORMAL].freeze
 
       attr_accessor :level
 
-      def initialize(level: nil)
+      def initialize(level: NORMAL)
         @level = level
       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,8 +42,8 @@ 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)
@@ -61,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
 
@@ -102,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
 
@@ -135,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
@@ -39,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/message.rb

@@ -1,7 +1,8 @@
 module QuietQuality
   class Message
-    attr_accessor :annotated_line
-    attr_reader :path, :body, :start_line, :stop_line, :level, :rule
+    REQUIRED_ATTRS = %w[path body start_line tool_name].freeze
+
+    attr_writer :annotated_line
 
     def self.load(hash)
       new(**hash)
@@ -9,17 +10,51 @@ module QuietQuality
 
     def initialize(**attrs)
       @attrs = attrs.map { |k, v| [k.to_s, v] }.to_h
-      @path = @attrs.fetch("path")
-      @body = @attrs.fetch("body")
-      @start_line = @attrs.fetch("start_line")
-      @stop_line = @attrs.fetch("stop_line", @start_line)
-      @annotated_line = @attrs.fetch("annotated_line", nil)
-      @level = @attrs.fetch("level", nil)
-      @rule = @attrs.fetch("rule", nil)
+      validate_attrs!
     end
 
     def to_h
       @attrs.map { |k, v| [k.to_s, v] }.to_h
     end
+
+    def path
+      @_path ||= @attrs.fetch("path")
+    end
+
+    def body
+      @_body ||= @attrs.fetch("body")
+    end
+
+    def tool_name
+      @_tool_name ||= @attrs.fetch("tool_name")
+    end
+
+    def start_line
+      @_start_line ||= @attrs.fetch("start_line")
+    end
+
+    def stop_line
+      @_stop_line ||= @attrs.fetch("stop_line", start_line)
+    end
+
+    def annotated_line
+      @annotated_line ||= @attrs.fetch("annotated_line", nil)
+    end
+
+    def level
+      @_level ||= @attrs.fetch("level", nil)
+    end
+
+    def rule
+      @_rule ||= @attrs.fetch("rule", nil)
+    end
+
+    private
+
+    def validate_attrs!
+      REQUIRED_ATTRS.each do |attr|
+        raise ArgumentError, "Missing required attribute #{attr}" unless @attrs[attr]
+      end
+    end
   end
 end

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

@@ -37,7 +37,14 @@ module QuietQuality
           line = warning.fetch(:line)
           level = warning.fetch(:confidence, nil)
           rule = warning.fetch(:warning_type)
-          Message.new(path: path, body: body, start_line: line, level: level, rule: rule)
+          Message.new(
+            path: path,
+            body: body,
+            start_line: line,
+            level: level,
+            rule: rule,
+            tool_name: TOOL_NAME
+          )
         end
       end
     end

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

@@ -3,7 +3,7 @@ module QuietQuality
     module Brakeman
       class Runner < BaseRunner
         def tool_name
-          :brakeman
+          TOOL_NAME
         end
 
         def command

data/lib/quiet_quality/tools/brakeman.rb

@@ -3,6 +3,7 @@ require_relative "./rubocop"
 module QuietQuality
   module Tools
     module Brakeman
+      TOOL_NAME = :brakeman
     end
   end
 end

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

@@ -36,7 +36,8 @@ module QuietQuality
             body: offense.fetch(:message),
             start_line: offense.dig(:location, :line),
             level: offense.fetch(:severity, nil),
-            rule: offense.fetch(:linter_name, nil)
+            rule: offense.fetch(:linter_name, nil),
+            tool_name: TOOL_NAME
           )
         end
       end

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

@@ -3,7 +3,7 @@ module QuietQuality
     module HamlLint
       class Runner < RelevantRunner
         def tool_name
-          :haml_lint
+          TOOL_NAME
         end
 
         def no_files_output

data/lib/quiet_quality/tools/haml_lint.rb

@@ -1,6 +1,7 @@
 module QuietQuality
   module Tools
     module HamlLint
+      TOOL_NAME = :haml_lint
     end
   end
 end

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

@@ -25,7 +25,8 @@ module QuietQuality
             path: entry.fetch(:filename),
             start_line: entry.fetch(:line),
             rule: entry.fetch(:description),
-            body: entry.fetch(:docs)
+            body: entry.fetch(:docs),
+            tool_name: TOOL_NAME
           )
         end
       end

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

@@ -3,7 +3,7 @@ module QuietQuality
     module MarkdownLint
       class Runner < RelevantRunner
         def tool_name
-          :markdown_lint
+          TOOL_NAME
         end
 
         def no_files_output

data/lib/quiet_quality/tools/markdown_lint.rb

@@ -1,6 +1,7 @@
 module QuietQuality
   module Tools
     module MarkdownLint
+      TOOL_NAME = :markdown_lint
     end
   end
 end

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

@@ -16,8 +16,26 @@ module QuietQuality
 
         attr_reader :text
 
+        # Many people use simplecov with rspec, and its default formatter
+        # writes text output into the stdout stream of rspec even when rspec is
+        # asked for json output. I have an issue open here, and I'll get a pair
+        # of PRs together if they indicate any willingness to accept such a
+        # change: https://github.com/simplecov-ruby/simplecov/issues/1060
+        #
+        # The only stdout writes are visible on these lines:
+        # https://github.com/simplecov-ruby/simplecov-html/blob/main/lib/simplecov-html.rb#L31
+        # https://github.com/simplecov-ruby/simplecov-html/blob/main/lib/simplecov-html.rb#L80
+        #
+        # There are _hundreds_ of rspec plugins, and any of them could write to
+        # stdout - we probably won't worry about any but the most common.
+        def cleaned_text
+          @_cleaned_text ||= text
+            .gsub(/Coverage report generated.*covered.$/, "")
+            .gsub(/Encoding problems with file.*$/, "")
+        end
+
         def content
-          @_content ||= JSON.parse(text, symbolize_names: true)
+          @_content ||= JSON.parse(cleaned_text, symbolize_names: true)
         end
 
         def examples
@@ -37,7 +55,13 @@ module QuietQuality
           body = example.dig(:exception, :message) || example.fetch(:description)
           line = example.fetch(:line_number)
           rule = example.dig(:exception, :class) || "Failed Example"
-          Message.new(path: path, body: body, start_line: line, rule: rule)
+          Message.new(
+            path: path,
+            body: body,
+            start_line: line,
+            rule: rule,
+            tool_name: TOOL_NAME
+          )
         end
       end
     end

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

@@ -3,7 +3,7 @@ module QuietQuality
     module Rspec
       class Runner < RelevantRunner
         def tool_name
-          :rspec
+          TOOL_NAME
         end
 
         def no_files_output

data/lib/quiet_quality/tools/rspec.rb

@@ -1,6 +1,7 @@
 module QuietQuality
   module Tools
     module Rspec
+      TOOL_NAME = :rspec
     end
   end
 end

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

@@ -37,9 +37,14 @@ module QuietQuality
             start_line: offense.dig(:location, :start_line),
             stop_line: offense.dig(:location, :last_line),
             level: offense.fetch(:severity, nil),
-            rule: offense.fetch(:cop_name, nil)
+            rule: offense.fetch(:cop_name, nil),
+            tool_name: tool_name
           )
         end
+
+        def tool_name
+          TOOL_NAME
+        end
       end
     end
   end

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

@@ -3,7 +3,7 @@ module QuietQuality
     module Rubocop
       class Runner < RelevantRunner
         def tool_name
-          :rubocop
+          TOOL_NAME
         end
 
         def no_files_output

data/lib/quiet_quality/tools/rubocop.rb

@@ -1,6 +1,7 @@
 module QuietQuality
   module Tools
     module Rubocop
+      TOOL_NAME = :rubocop
     end
   end
 end

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

@@ -2,6 +2,9 @@ module QuietQuality
   module Tools
     module Standardrb
       class Parser < Rubocop::Parser
+        def tool_name
+          TOOL_NAME
+        end
       end
     end
   end

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

@@ -3,7 +3,7 @@ module QuietQuality
     module Standardrb
       class Runner < RelevantRunner
         def tool_name
-          :standardrb
+          TOOL_NAME
         end
 
         def no_files_output

data/lib/quiet_quality/tools/standardrb.rb

@@ -3,6 +3,7 @@ require_relative "./rubocop"
 module QuietQuality
   module Tools
     module Standardrb
+      TOOL_NAME = :standardrb
     end
   end
 end

data/lib/quiet_quality/version.rb

@@ -1,3 +1,3 @@
 module QuietQuality
-  VERSION = "1.2.0"
+  VERSION = "1.2.2"
 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.2.0
+  version: 1.2.2
 platform: ruby
 authors:
 - Eric Mueller
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-30 00:00:00.000000000 Z
+date: 2023-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: git
@@ -251,7 +251,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: A system for comparing quality tool outputs against the forward diffs