quiet_quality 1.0.3 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d7372d3c4b395adb2890c54270426bf92b9a2a9e2669ef27d5145eda776d1072
-  data.tar.gz: 5877277009b82e9685e62f8f8a1f17aec823faaad93c3c8e40dcb7f2640d0e7c
+  metadata.gz: b6aea488d2026da63fdf9483d1df9bd4e2363270d7b441cbca384cd803cab803
+  data.tar.gz: 0536d6eb0b8cdd1c4678f49058be4d37017b7ff6156d363afa71df8a979d30aa
 SHA512:
-  metadata.gz: 4c860d24410fd6a03390e726fdc699113f3d0c21b722e12ccf564c666b5708690d8ed90a092448f3942496a47331e10b3d3bb7580ba2e0feeafbf74ea60bdb03
-  data.tar.gz: 67b89da10e8fc43370d586d9282776c2f1f23a0fa4fcfbea5bfd596ab6520cca7c9319731fd960c63dc04e36ab7021b83e27497d52f2e10b8cdd9ef8a39ad394
+  metadata.gz: 766f24f8211b83610c05e57b0f81d77bbf2d4bf8c206cc5e9af1d4e302adc9fee6425c506b344850a1421b7a30f18b6dfa6a23132aaa64dc3e6fbeb5e59c4c0b
+  data.tar.gz: 7b72dcf22a6696b2ff88a5efb08fb0338d2d4f0b43f506f147a2d5cb0ed7186328157ff4b8ded7198fff3785f6636b32d8b1ecd1102cd462b341f28c57dfd429

data/README.md

@@ -144,6 +144,22 @@ 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:
+
+```yaml
+rspec:
+  changed_files: true
+  filter_messages: false
+  file_filter: "^spec/"
+```
+
 ### CLI Options
 
 The same options are all available on the CLI, plus some additional ones - run
@@ -151,5 +167,6 @@ The same options are all available on the CLI, plus some additional ones - run
 
 * `--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
+* `--config/-C`: load the supplied config file (instead of the detected one, if
   found)
+* `--version/-V`: what version of the gem are you using?

data/lib/quiet_quality/cli/arg_parser.rb

@@ -76,6 +76,10 @@ module QuietQuality
         parser.on("-h", "--help", "Prints this help") do
           @parsed_options.helping = true
         end
+
+        parser.on("-V", "--version", "Print the current version of the gem") do
+          @parsed_options.printing_version = true
+        end
       end
 
       def setup_config_options(parser)

data/lib/quiet_quality/cli/entrypoint.rb

@@ -10,6 +10,10 @@ module QuietQuality
       def execute
         if helping?
           log_help_text
+        elsif printing_version?
+          log_version_text
+        elsif no_tools?
+          log_no_tools_text
         else
           executed
           log_outcomes
@@ -21,7 +25,9 @@ module QuietQuality
       end
 
       def successful?
-        helping? || !executed.any_failure?
+        return true if helping? || printing_version?
+        return false if no_tools?
+        !executed.any_failure?
       end
 
       private
@@ -40,10 +46,29 @@ module QuietQuality
         parsed_options.helping?
       end
 
+      def printing_version?
+        parsed_options.printing_version?
+      end
+
+      def no_tools?
+        options.tools.empty?
+      end
+
       def log_help_text
         error_stream.puts(arg_parser.help_text)
       end
 
+      def log_version_text
+        error_stream.puts(QuietQuality::VERSION)
+      end
+
+      def log_no_tools_text
+        error_stream.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
+      end
+
       def options
         return @_options if defined?(@_options)
         builder = Config::Builder.new(parsed_cli_options: parsed_options)

data/lib/quiet_quality/config/builder.rb

@@ -28,7 +28,7 @@ module QuietQuality
         elsif config_file&.tools&.any?
           config_file.tools
         else
-          Tools::AVAILABLE.keys
+          []
         end
       end
 
@@ -109,6 +109,7 @@ module QuietQuality
           options.tools.each do |tool_options|
             update_tool_option(tool_options, :limit_targets)
             update_tool_option(tool_options, :filter_messages)
+            update_tool_option(tool_options, :file_filter)
           end
         end
 

data/lib/quiet_quality/config/parsed_options.rb

@@ -5,16 +5,20 @@ module QuietQuality
         @tools = []
         @tool_options = {}
         @global_options = {}
-        @helping = false
+        @helping = @printing_version = false
       end
 
       attr_accessor :tools
-      attr_writer :helping
+      attr_writer :helping, :printing_version
 
       def helping?
         @helping
       end
 
+      def printing_version?
+        @printing_version
+      end
+
       def set_global_option(name, value)
         @global_options[name.to_sym] = value
       end

data/lib/quiet_quality/config/parser.rb

@@ -38,11 +38,14 @@ module QuietQuality
       end
 
       def store_global_options(opts)
-        read_global_option(opts, :executor, as: :symbol, validate_from: Executors::AVAILABLE)
-        read_global_option(opts, :annotator, as: :symbol, validate_from: Annotators::ANNOTATOR_TYPES)
-        read_global_option(opts, :comparison_branch, as: :string)
-        read_global_option(opts, :changed_files, as: :boolean)
-        read_global_option(opts, :filter_messages, as: :boolean)
+        read_global_option(opts, :executor, :executor, as: :symbol, validate_from: Executors::AVAILABLE)
+        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, :filter_messages, :filter_messages, as: :boolean)
+        read_global_option(opts, :unfiltered, :filter_messages, as: :reversed_boolean)
       end
 
       def store_tool_options(opts)
@@ -54,8 +57,12 @@ module QuietQuality
       def store_tool_options_for(opts, tool_name)
         entries = data.fetch(tool_name, nil)
         return if entries.nil?
-        read_tool_option(opts, tool_name, :filter_messages, as: :boolean)
-        read_tool_option(opts, tool_name, :changed_files, as: :boolean)
+
+        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, :file_filter, :file_filter, as: :string)
       end
 
       def invalid!(message)
@@ -70,27 +77,28 @@ module QuietQuality
         [true, false].include?(value)
       end
 
-      def read_global_option(opts, name, as:, validate_from: nil)
+      def read_global_option(opts, name, into, as:, validate_from: nil)
         parsed_value = data.fetch(name.to_sym, nil)
         return if parsed_value.nil?
 
         validate_value(name, parsed_value, as: as, from: validate_from)
         coerced_value = coerce_value(parsed_value, as: as)
-        opts.set_global_option(name, coerced_value)
+        opts.set_global_option(into, coerced_value)
       end
 
-      def read_tool_option(opts, tool, name, as:)
+      def read_tool_option(opts, tool, name, into, as:)
         parsed_value = data.dig(tool.to_sym, name.to_sym)
         return if parsed_value.nil?
 
         validate_value("#{tool}.#{name}", parsed_value, as: as)
         coerced_value = coerce_value(parsed_value, as: as)
-        opts.set_tool_option(tool, name, coerced_value)
+        opts.set_tool_option(tool, into, coerced_value)
       end
 
       def validate_value(name, value, as:, from: nil)
         case as
         when :boolean then validate_boolean(name, value)
+        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
@@ -123,6 +131,7 @@ module QuietQuality
       def coerce_value(value, as:)
         case as
         when :boolean then !!value
+        when :reversed_boolean then !value
         when :string then value.to_s
         when :symbol then value.to_sym
         else

data/lib/quiet_quality/config/tool_options.rb

@@ -1,14 +1,15 @@
 module QuietQuality
   module Config
     class ToolOptions
-      def initialize(tool, limit_targets: true, filter_messages: true)
+      def initialize(tool, limit_targets: true, filter_messages: true, file_filter: nil)
         @tool_name = tool.to_sym
         @limit_targets = limit_targets
         @filter_messages = filter_messages
+        @file_filter = file_filter
       end
 
       attr_reader :tool_name
-      attr_writer :limit_targets, :filter_messages
+      attr_writer :limit_targets, :filter_messages, :file_filter
 
       def limit_targets?
         @limit_targets
@@ -29,6 +30,11 @@ module QuietQuality
       def parser_class
         tool_namespace::Parser
       end
+
+      def file_filter
+        return nil if @file_filter.nil?
+        Regexp.new(@file_filter)
+      end
     end
   end
 end

data/lib/quiet_quality/executors/pipeline.rb

@@ -48,8 +48,10 @@ module QuietQuality
       end
 
       def runner
-        @_runner ||= tool_options.runner_class
-          .new(changed_files: limit_targets? ? changed_files : nil)
+        @_runner ||= tool_options.runner_class.new(
+          changed_files: limit_targets? ? changed_files : nil,
+          file_filter: tool_options.file_filter
+        )
       end
 
       def parser

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

@@ -6,8 +6,12 @@ module QuietQuality
         #   https://github.com/presidentbeef/brakeman/blob/main/lib/brakeman.rb#L6-L25
         KNOWN_EXIT_STATUSES = [3, 4, 5, 6, 7, 8].to_set
 
-        def initialize(changed_files: nil)
+        # 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!

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

@@ -11,8 +11,9 @@ module QuietQuality
         # encountered"
         FAILURE_STATUS = 65
 
-        def initialize(changed_files: nil)
+        def initialize(changed_files: nil, file_filter: nil)
           @changed_files = changed_files
+          @file_filter = file_filter
         end
 
         def invoke!
@@ -21,7 +22,7 @@ module QuietQuality
 
         private
 
-        attr_reader :changed_files
+        attr_reader :changed_files, :file_filter
 
         def skip_execution?
           changed_files && relevant_files.empty?
@@ -29,7 +30,9 @@ module QuietQuality
 
         def relevant_files
           return nil if changed_files.nil?
-          changed_files.paths.select { |path| path.end_with?(".haml") }
+          changed_files.paths
+            .select { |path| path.end_with?(".haml") }
+            .select { |path| file_filter.nil? || file_filter.match?(path) }
         end
 
         def target_files

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

@@ -5,8 +5,9 @@ module QuietQuality
         MAX_FILES = 100
         NO_FILES_OUTPUT = '{"examples": [], "summary": {"failure_count": 0}}'
 
-        def initialize(changed_files: nil)
+        def initialize(changed_files: nil, file_filter: nil)
           @changed_files = changed_files
+          @file_filter = file_filter
         end
 
         def invoke!
@@ -15,7 +16,7 @@ module QuietQuality
 
         private
 
-        attr_reader :changed_files
+        attr_reader :changed_files, :file_filter
 
         def skip_execution?
           changed_files && relevant_files.empty?
@@ -23,7 +24,9 @@ module QuietQuality
 
         def relevant_files
           return nil if changed_files.nil?
-          changed_files.paths.select { |path| path.end_with?("_spec.rb") }
+          changed_files.paths
+            .select { |path| path.end_with?("_spec.rb") }
+            .select { |path| file_filter.nil? || file_filter.match?(path) }
         end
 
         def target_files

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

@@ -10,8 +10,9 @@ module QuietQuality
         end
 
         # Supplying changed_files: nil means "run against all files".
-        def initialize(changed_files: nil)
+        def initialize(changed_files: nil, file_filter: nil)
           @changed_files = changed_files
+          @file_filter = file_filter
         end
 
         def invoke!
@@ -20,7 +21,7 @@ module QuietQuality
 
         private
 
-        attr_reader :changed_files
+        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.
@@ -38,7 +39,9 @@ module QuietQuality
 
         def relevant_files
           return nil if changed_files.nil?
-          changed_files.paths.select { |path| path.end_with?(".rb") }
+          changed_files.paths
+            .select { |path| path.end_with?(".rb") }
+            .select { |path| file_filter.nil? || file_filter.match?(path) }
         end
 
         def target_files

data/lib/quiet_quality/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quiet_quality
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.0
 platform: ruby
 authors:
 - Eric Mueller
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-24 00:00:00.000000000 Z
+date: 2023-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: git
@@ -241,7 +241,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