quiet_quality 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 921a945aaedb335246c6944ae8f460505357a73d20f4f1cf2ae3dba3e9fe9041
-  data.tar.gz: fab1f3330661738cc146e26590d489bb9fff0cc0c0318a5e9529fb9fd0802038
+  metadata.gz: 81e7296beb4ced635f0e6e0d1b5521adb6481b3ca4d027e86e76ad1ee8682643
+  data.tar.gz: 27dfab991d21f98536860a0fdbeed31faa1ea5b65a2af0941e0cc286fe6dcbc1
 SHA512:
-  metadata.gz: 84a082f31fb8a6ae290399a97fdb5918bd91c2eaa701ec7b3909fe27e2d66845ceae7db7bcf9a59dd6696c71bfe99b4cc189f1d529bea49f5f82ba849c8fb553
-  data.tar.gz: 222a7432405df57d2739c0799bc5844b1a916c76febf34c798891ee39e17ce79c17dedaec15928488a819261fdc35d3d746276109455cba7d490b2140c5d31c4
+  metadata.gz: b84bb256a178326bc76143952098db02723fcfa792ed6e86f9b6b63a0c602d87eb270d81d93e34742c2026abd7fd2118964b3a039eb8e3968863a8d1e5fe1697
+  data.tar.gz: 76fc65f2ce473f91a8cb98bc32c62e98ecc154aef519ab8d9e908f7def8330306b76ee2c54ed99a57bfba4b5997065b6d953747756b9a0b83e9e557c96de1d23

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## Release 1.4.0
+
+* Support specifying `excludes` per-tool, so that certain files won't be passed
+  to those tools on the command-line (#107 resolves #106)
+
+## Release 1.3.1
+
+* Fix a bug around the logging of nil commands when runners are skipped (#104
+  resolves #103)
+
 ## Release 1.3.0
 
 * Support (and enable by default) colorizing the console stderr output from

data/README.md

@@ -156,14 +156,14 @@ And then each tool can have an entry, within which `changed_files` and
 `filter_messages` can be specified - the tool-specific settings override the
 global ones.
 
-The tools have one additional setting that is not available at a global level:
-`file_filter`. This is a string that will be turned into a _ruby regex_, and
-used to limit what file paths are passed to the tool. For example, if you are
-working in a rails engine `engines/foo/`, and you touch one of the rspec tests
-there, you would not want `qq` in the root of the repository to run
-`rspec engines/foo/spec/foo/thing_spec.rb` - that probably won't work, as your
-engine will have its own test setup code and Gemfile. This setting is mostly
-intended to be used like this:
+The tools have two additional settings that are not available at a global level:
+`file_filter` and `excludes`. `file_filter` is a string that will be turned into
+a _ruby regex_, and used to limit what file paths are passed to the tool. For
+example, if you are working in a rails engine `engines/foo/`, and you touch one
+of the rspec tests there, you would not want `qq` in the root of the repository
+to run `rspec engines/foo/spec/foo/thing_spec.rb` - that probably won't work, as
+your engine will have its own test setup code and Gemfile. This setting is
+mostly intended to be used like this:
 
 ```yaml
 rspec:
@@ -172,6 +172,15 @@ rspec:
   file_filter: "^spec/"
 ```
 
+`excludes` are more specific in meaning - this is an _array_ of regexes, and any
+file that matches any of these regexes will _not_ be passed to the tool as an
+explicit command line argument. This is generally because tools like rubocop
+have internal systems for excluding files, but if you pass a filename on the
+cli, those systems are ignored. That means that if you have changes to a
+generated file like `db/schema.rb`, and that file doesn't meet your rubocop (or
+standardrb) rules, you'll get _told_ unless you exclude it at the quiet-quality
+level as well.
+
 ### CLI Options
 
 To specify which _tools_ to run (and if any are specified, the `default_tools`

data/lib/quiet_quality/annotators.rb

@@ -1,10 +1,14 @@
+module QuietQuality
+  module Annotators
+    Unrecognized = Class.new(Error)
+  end
+end
+
 glob = File.expand_path("../annotators/*.rb", __FILE__)
 Dir.glob(glob).sort.each { |f| require(f) }
 
 module QuietQuality
   module Annotators
-    Unrecognized = Class.new(Error)
-
     ANNOTATOR_TYPES = {
       github_stdout: Annotators::GithubStdout
     }.freeze

data/lib/quiet_quality/config/file_filter.rb

@@ -0,0 +1,52 @@
+module QuietQuality
+  module Config
+    class FileFilter
+      # * regex is a regex string
+      # * excludes is an array of regex strings OR a single regex string
+      def initialize(regex: nil, excludes: nil)
+        @regex_string = regex
+        @excludes_strings = excludes
+      end
+
+      def regex
+        return nil if @regex_string.nil?
+        @_regex ||= Regexp.new(@regex_string)
+      end
+
+      def excludes
+        return @_excludes if defined?(@_excludes)
+
+        @_excludes =
+          if @excludes_strings.nil?
+            nil
+          elsif @excludes_strings.is_a?(String)
+            [Regexp.new(@excludes_strings)]
+          else
+            @excludes_strings.map { |xs| Regexp.new(xs) }
+          end
+      end
+
+      # The filter _overall_ matches if:
+      # (a) the regex either matches or is not supplied AND
+      # (b) either none of the excludes match or none are supplied
+      def match?(s)
+        regex_match?(s) && !excludes_match?(s)
+      end
+
+      private
+
+      # The regex is an allow-match - if it's not supplied, treat everything as matching.
+      def regex_match?(s)
+        return true if regex.nil?
+        regex.match?(s)
+      end
+
+      # The excludes are a list of deny-matches - if they're not supplied, treat _nothing_
+      # as matching.
+      def excludes_match?(s)
+        return false if excludes.nil? || excludes.empty?
+        excludes.any? { |exclude| exclude.match?(s) }
+      end
+    end
+  end
+end

data/lib/quiet_quality/config/parser.rb

@@ -64,7 +64,7 @@ module QuietQuality
         read_tool_option(opts, tool_name, :unfiltered, :filter_messages, 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)
+        read_file_filter(opts, tool_name)
       end
 
       def invalid!(message)
@@ -97,6 +97,15 @@ module QuietQuality
         opts.set_tool_option(tool, into, coerced_value)
       end
 
+      def read_file_filter(opts, tool)
+        parsed_regex = data.dig(tool.to_sym, :file_filter)
+        parsed_excludes = data.dig(tool.to_sym, :excludes)
+        if parsed_regex || parsed_excludes
+          filter = Config::FileFilter.new(regex: parsed_regex, excludes: parsed_excludes)
+          opts.set_tool_option(tool, :file_filter, filter)
+        end
+      end
+
       def validate_value(name, value, as:, from: nil)
         case as
         when :boolean then validate_boolean(name, value)

data/lib/quiet_quality/config/tool_options.rb

@@ -8,8 +8,9 @@ module QuietQuality
         @file_filter = file_filter
       end
 
+      attr_accessor :file_filter
       attr_reader :tool_name
-      attr_writer :limit_targets, :filter_messages, :file_filter
+      attr_writer :limit_targets, :filter_messages
 
       def limit_targets?
         @limit_targets
@@ -31,17 +32,13 @@ module QuietQuality
         tool_namespace::Parser
       end
 
-      def file_filter
-        return nil if @file_filter.nil?
-        Regexp.new(@file_filter)
-      end
-
       def to_h
         {
           tool_name: tool_name,
           limit_targets: limit_targets?,
           filter_messages: filter_messages?,
-          file_filter: file_filter&.to_s
+          file_filter: file_filter&.regex&.to_s,
+          excludes: file_filter&.excludes&.map(&:to_s)
         }
       end
     end

data/lib/quiet_quality/executors/pipeline.rb

@@ -54,7 +54,8 @@ module QuietQuality
       end
 
       def log_runner(r)
-        info("Runner #{r.tool_name} command: `#{r.command.join(" ")}`")
+        command_string = r.command ? "`#{r.command.join(" ")}`" : "(skipped)"
+        info("Runner #{r.tool_name} command: #{command_string}")
         debug("Full command for #{r.tool_name}", data: r.command)
       end
 

data/lib/quiet_quality/version.rb

@@ -1,3 +1,3 @@
 module QuietQuality
-  VERSION = "1.3.0"
+  VERSION = "1.4.0"
 end

data/quiet_quality.gemspec

@@ -42,4 +42,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rubocop", "~> 1.50"
   spec.add_development_dependency "debug", "~> 1.7"
   spec.add_development_dependency "mdl", "~> 0.12"
+  spec.add_development_dependency "rspec-cover_it", "~> 0.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quiet_quality
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Eric Mueller
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-06 00:00:00.000000000 Z
+date: 2023-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: git
@@ -150,6 +150,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: rspec-cover_it
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
 description: |
   Allow your CI to notice and/or annotate new quality issues, despite the presences of
   many pre-existing issues in your codebase.
@@ -189,6 +203,7 @@ files:
 - lib/quiet_quality/colorize.rb
 - lib/quiet_quality/config.rb
 - lib/quiet_quality/config/builder.rb
+- lib/quiet_quality/config/file_filter.rb
 - lib/quiet_quality/config/finder.rb
 - lib/quiet_quality/config/options.rb
 - lib/quiet_quality/config/parsed_options.rb
@@ -252,7 +267,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: A system for comparing quality tool outputs against the forward diffs