quiet_quality 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae3f031f4d627e624ce2ae28a5cf58d8e9e0663822371089d54bda51cb1aefeb
-  data.tar.gz: c9c26fd4d3df19e70162b38ef78622cc569ea492656d9264c4a41a964931934a
+  metadata.gz: b3847a8d0b996b19f34c32ac587dd1b9e51a2bedbea8e777e6b888294b16b5c0
+  data.tar.gz: 742080e4b9193d0d99606f00c68077229ffba805c5b93ffa75c09705e0101b18
 SHA512:
-  metadata.gz: 6925f90d2f144b9bd59b4f0ca8d9a28e41cebf8570b30e3fa85cee6eefe2961aaaf246f733cd9b62de0d070afb7cca545c650ead15e45a6a39372d34c4240023
-  data.tar.gz: 3589c916dab556a467ab64c974ea91eda6a4f6f229ccda58aa51488b13b3a9a44217206fb3962697570cd176fb1bd282bee6231eccad5b50e1d948f0758eb8fb
+  metadata.gz: b61e91968e6bdd4943809a336d60cf6a7feee9ab58db225a33f8268bd02efc911c3fa812e45491be1cc9f6d461a6db71308e790f1d912fac011c82cf4864e8d7
+  data.tar.gz: ace3273fb13dfcd04ae2432ed0cd488195789c75a27251617fc6be851bf865e4c4b689f9c3e3e83203ffb2b1ecd2be11c258405b10a3720c186b79b5e150fe3b

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,16 @@
 # 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

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,11 +128,11 @@ 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
 

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

@@ -1,3 +1,3 @@
 module QuietQuality
-  VERSION = "1.2.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.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Eric Mueller
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-30 00:00:00.000000000 Z
+date: 2023-06-03 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