quiet_quality 1.5.0 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7ff5a82876936d746842d76e055475ba19e78d0bfff7967b2f179a2262cb5d7e
-  data.tar.gz: 529ed1d29fdf3c3c6ba381e7ab71cbf006bc44c8d608858e8ec84d67c2efb267
+  metadata.gz: 3084fe3f419db403944af870a9ccc39cccfe046f9f01841f52872808cd38b186
+  data.tar.gz: bc3b18bd54ec79e6adf72c9947142050cd0a14a329d665f58290fe40b3382b27
 SHA512:
-  metadata.gz: 1b840cfe8d90929c0fcc32fdc1370310924a46464006b39afa5dceff69b8c24254d701002e77f33a845baaa7fe5373243486b5d1422a3beea4fd45a50e65ec8b
-  data.tar.gz: e3176f406a5de5a027cae5a2edcbd897395a0191dad1a6cb402bf48fb005f9dce3783d8e6778f91e7d05c03b3f12f473ee23438b9235ed5eedd5e4d588a58526
+  metadata.gz: 761966c658f578970e2d420d194d8d81a71e2d8808f95c8862366656a88e2ee3bf10e1ec8907ac21f4b4e62d799cd923ea481c7bbbd856da8a9b5c8656c3cf1e
+  data.tar.gz: 2a91a00a403943d7a6051dc788dae5d2a963740cfd6d543228d8dbc810a5efd2ac5bdc0d8fc9c5f6c799e97c0c81742fd17543a43b184b86e4be117365146a0c

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## Release 1.5.1
+
+* Refactor ConfigParser to just parse the config into ParsedOptions, separating
+  the file-filter/excludes handling properly (#114)
+* Update the standard/rubocop constraints (dev-only)
+* Fail the pipeline when rspec encounters non-spec failures (#120 resolves #119)
+* Expose error messages when brakeman encounters errors (#122 resolves #115)
+
 ## Release 1.5.0
 
 * Update to comply with current standardrb rules, and use checkout@v4

data/lib/quiet_quality/config/builder.rb

@@ -84,7 +84,7 @@ module QuietQuality
 
         def set_unless_nil(object, method, value)
           return if value.nil?
-          object.send("#{method}=", value)
+          object.send(:"#{method}=", value)
         end
 
         # ---- update the global options -------------
@@ -129,7 +129,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)
+            set_unless_nil(tool_options, :file_filter, build_file_filter(tool_options.tool_name))
           end
         end
 
@@ -138,6 +138,13 @@ module QuietQuality
           set_unless_nil(tool_options, option_name, apply.global_option(option_name))
           set_unless_nil(tool_options, option_name, apply.tool_option(tool_name, option_name))
         end
+
+        def build_file_filter(tool_name)
+          filter_string = apply.tool_option(tool_name, :file_filter)
+          excludes_strings = apply.tool_option(tool_name, :excludes)
+          return nil if filter_string.nil? && (excludes_strings.nil? || excludes_strings.empty?)
+          Config::FileFilter.new(regex: filter_string, excludes: excludes_strings)
+        end
       end
     end
   end

data/lib/quiet_quality/config/file_filter.rb

@@ -8,6 +8,8 @@ module QuietQuality
         @excludes_strings = excludes
       end
 
+      attr_reader :regex_string, :excludes_strings
+
       def regex
         return nil if @regex_string.nil?
         @_regex ||= Regexp.new(@regex_string)
@@ -33,6 +35,10 @@ module QuietQuality
         regex_match?(s) && !excludes_match?(s)
       end
 
+      def ==(other)
+        regex_string == other.regex_string && excludes_strings.sort == other.excludes_strings.sort
+      end
+
       private
 
       # The regex is an allow-match - if it's not supplied, treat everything as matching.

data/lib/quiet_quality/config/parsed_options.rb

@@ -21,7 +21,8 @@ module QuietQuality
       TOOL_OPTIONS = [
         :limit_targets,
         :filter_messages,
-        :file_filter
+        :file_filter,
+        :excludes
       ].to_set
 
       def initialize

data/lib/quiet_quality/config/parser.rb

@@ -65,7 +65,8 @@ 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_file_filter(opts, tool_name)
+        read_tool_option(opts, tool_name, :file_filter, :file_filter, as: :string)
+        read_tool_option(opts, tool_name, :excludes, :excludes, as: :strings)
       end
 
       def invalid!(message)
@@ -98,21 +99,13 @@ 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)
         when :reversed_boolean then validate_boolean(name, value)
         when :symbol then validate_symbol(name, value, from: from)
         when :string then validate_string(name, value)
+        when :strings then validate_strings(name, value)
         end
       end
 
@@ -138,11 +131,17 @@ module QuietQuality
         invalid!("option #{name} must not be empty") if value.empty?
       end
 
+      def validate_strings(name, value)
+        invalid!("option #{name} must be an array") unless value.is_a?(Array)
+        value.each_with_index { |item, n| validate_string("#{name}[#{n}]", item) }
+      end
+
       def coerce_value(value, as:)
         case as
         when :boolean then !!value
         when :reversed_boolean then !value
         when :string then value.to_s
+        when :strings then value.map(&:to_s)
         when :symbol then value.to_sym
         end
       end

data/lib/quiet_quality/logger.rb

@@ -53,8 +53,10 @@ module QuietQuality
         data_text = JSON.pretty_generate(data)
         message = message + "\n" + data_text
       end
-      prefixed_message = message.split("\n").map { |line| "[#{prefix}] #{line}" }.join("\n")
-      colorize(prefixed_message, message_level)
+      message.split("\n")
+        .map { |line| "[#{prefix}] #{line}" }
+        .map { |prefixed_line| colorize(prefixed_line, message_level) }
+        .join("\n")
     end
 
     def colorize(s, message_level)

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

@@ -2,6 +2,8 @@ module QuietQuality
   module Tools
     module Brakeman
       class Parser
+        include Logging
+
         def initialize(text)
           @text = text
         end
@@ -24,6 +26,8 @@ module QuietQuality
         def check_errors!
           errors = data[:errors]
           return if errors.nil? || errors.empty?
+          warn "Brakeman errors:"
+          errors.each { |error| warn "    #{error}" }
           fail(ParsingError, "Found #{errors.length} errors in brakeman output")
         end
 

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

@@ -2,6 +2,8 @@ module QuietQuality
   module Tools
     module Rspec
       class Parser
+        include Logging
+
         def initialize(text)
           @text = text
         end
@@ -39,7 +41,9 @@ module QuietQuality
         end
 
         def examples
-          @_examples ||= content.fetch(:examples)
+          return @_examples if defined?(@_examples)
+          raise_if_errors_outside_of_examples!
+          @_examples = content.fetch(:examples)
         end
 
         def failed_examples
@@ -63,6 +67,25 @@ module QuietQuality
             tool_name: TOOL_NAME
           )
         end
+
+        def errors_count
+          @_errors_count ||= content.dig(:summary, :errors_outside_of_examples_count) || 0
+        end
+
+        def error_messages
+          @_error_messages ||= content.fetch(:messages, [])
+        end
+
+        def raise_if_errors_outside_of_examples!
+          return if errors_count < 1
+          warn "RSpec errors:"
+          warn "-" * 80
+          error_messages.each do |msg|
+            warn msg
+            warn "-" * 80
+          end
+          fail Rspec::Error, "Rspec encountered #{errors_count} errors outside of examples"
+        end
       end
     end
   end

data/lib/quiet_quality/tools/rspec.rb

@@ -2,6 +2,8 @@ module QuietQuality
   module Tools
     module Rspec
       TOOL_NAME = :rspec
+
+      Error = Class.new(Tools::Error)
     end
   end
 end

data/lib/quiet_quality/version.rb

@@ -1,3 +1,3 @@
 module QuietQuality
-  VERSION = "1.5.0"
+  VERSION = "1.5.1"
 end

data/quiet_quality.gemspec

@@ -34,12 +34,12 @@ Gem::Specification.new do |spec|
   spec.add_dependency "git", "~> 1.18"
   spec.add_dependency "git_diff_parser", "~> 4"
 
-  spec.add_development_dependency "rspec", "~> 3.10"
+  spec.add_development_dependency "rspec", "~> 3.13"
   spec.add_development_dependency "rspec-its", "~> 1.3"
   spec.add_development_dependency "simplecov", "~> 0.22.0"
   spec.add_development_dependency "pry", "~> 0.14"
-  spec.add_development_dependency "standard", "~> 1.28"
-  spec.add_development_dependency "rubocop", "~> 1.50"
+  spec.add_development_dependency "standard", ">= 1.35.1"
+  spec.add_development_dependency "rubocop", ">= 1.62"
   spec.add_development_dependency "debug", "~> 1.7"
   spec.add_development_dependency "mdl", "~> 0.12"
   spec.add_development_dependency "rspec-cover_it", "~> 0.1.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quiet_quality
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.5.1
 platform: ruby
 authors:
 - Eric Mueller
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-15 00:00:00.000000000 Z
+date: 2024-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: git
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.10'
+        version: '3.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.10'
+        version: '3.13'
 - !ruby/object:Gem::Dependency
   name: rspec-its
   requirement: !ruby/object:Gem::Requirement
@@ -98,30 +98,30 @@ dependencies:
   name: standard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.28'
+        version: 1.35.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.28'
+        version: 1.35.1
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.50'
+        version: '1.62'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.50'
+        version: '1.62'
 - !ruby/object:Gem::Dependency
   name: debug
   requirement: !ruby/object:Gem::Requirement