quiet_quality 1.2.1 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b3847a8d0b996b19f34c32ac587dd1b9e51a2bedbea8e777e6b888294b16b5c0
-  data.tar.gz: 742080e4b9193d0d99606f00c68077229ffba805c5b93ffa75c09705e0101b18
+  metadata.gz: 6876b975446f39615f129b4fd35f3543bb998024ea292edcac1e6e1a90f7b59b
+  data.tar.gz: 277492ea2e6b93854e3b7d16f0184a50b5c756683929fb2a1081415e8e9836df
 SHA512:
-  metadata.gz: b61e91968e6bdd4943809a336d60cf6a7feee9ab58db225a33f8268bd02efc911c3fa812e45491be1cc9f6d461a6db71308e790f1d912fac011c82cf4864e8d7
-  data.tar.gz: ace3273fb13dfcd04ae2432ed0cd488195789c75a27251617fc6be851bf865e4c4b689f9c3e3e83203ffb2b1ecd2be11c258405b10a3720c186b79b5e150fe3b
+  metadata.gz: 7d0acaa14243573095f8741b9ca45cf56608b4ffde72f3ecd36a6ebd03cb0aeb45541ef3e4dad1c681976d5cdc3226d738a489b754d80590be032c31bbc8520b
+  data.tar.gz: 8e8daf77522762cca13480745f30df25cb2e445f2f7c69f98c20af9bc3b03bc8568299b8403ddbbc2e09fef750d3b3944c1a6f9b8dc2e4e22a4389a5419d05ab

data/CHANGELOG.md

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

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

@@ -137,6 +137,10 @@ module QuietQuality
       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/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/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/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.1"
+  VERSION = "1.2.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quiet_quality
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.2
 platform: ruby
 authors:
 - Eric Mueller
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-03 00:00:00.000000000 Z
+date: 2023-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: git