reviewer 0.1.4 → 0.1.5

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: reviewer
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Garrett Dimon
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-08-05 00:00:00.000000000 Z
+date: 2021-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: colorize
+  name: rainbow
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: dead_end
+  name: flay
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: flay
+  name: flog
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: flog
+  name: inch
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,7 +109,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: inch
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -123,7 +123,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: minitest-heat
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -137,7 +137,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest-color
+  name: psych
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -151,21 +151,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: psych
+  name: reek
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.3.2
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.3.2
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: reek
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -179,7 +179,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rubocop-minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -193,7 +193,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop-minitest
+  name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -207,7 +207,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop-rake
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -221,7 +221,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -243,14 +243,16 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".alexignore"
 - ".flayignore"
 - ".github/workflows/main.yml"
 - ".gitignore"
 - ".inch.yml"
 - ".reviewer.example.yml"
+- ".reviewer.future.yml"
 - ".reviewer.yml"
+- ".reviewer_stdout"
 - ".rubocop.yml"
-- ".ruby-version"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -272,8 +274,6 @@ files:
 - lib/reviewer/command/string.rb
 - lib/reviewer/command/string/env.rb
 - lib/reviewer/command/string/flags.rb
-- lib/reviewer/command/string/verbosity.rb
-- lib/reviewer/command/verbosity.rb
 - lib/reviewer/configuration.rb
 - lib/reviewer/conversions.rb
 - lib/reviewer/guidance.rb
@@ -283,10 +283,12 @@ files:
 - lib/reviewer/keywords/git/staged.rb
 - lib/reviewer/loader.rb
 - lib/reviewer/output.rb
-- lib/reviewer/printer.rb
+- lib/reviewer/output/printer.rb
+- lib/reviewer/output/scrubber.rb
+- lib/reviewer/output/token.rb
 - lib/reviewer/runner.rb
-- lib/reviewer/runner/strategies/quiet.rb
-- lib/reviewer/runner/strategies/verbose.rb
+- lib/reviewer/runner/strategies/captured.rb
+- lib/reviewer/runner/strategies/passthrough.rb
 - lib/reviewer/shell.rb
 - lib/reviewer/shell/result.rb
 - lib/reviewer/shell/timer.rb
@@ -295,13 +297,18 @@ files:
 - lib/reviewer/tools.rb
 - lib/reviewer/version.rb
 - reviewer.gemspec
+- structure.svg
 homepage: https://github.com/garrettdimon/reviewer
 licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/garrettdimon/reviewer
-  source_code_uri: https://github.com/garrettdimon/reviewer
+  bug_tracker_uri: https://github.com/garrettdimon/reviewer/issues
   changelog_uri: https://github.com/garrettdimon/reviewer/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/reviewer
+  source_code_uri: https://github.com/garrettdimon/reviewer
+  wiki_uri: https://github.com/garrettdimon/reviewer/wiki
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -317,8 +324,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.7.6.3
+rubygems_version: 3.2.32
 signing_key:
 specification_version: 4
 summary: Provides a unified approach to managing automated code quality tools.

data/.ruby-version

@@ -1 +0,0 @@
-2.5.9

data/lib/reviewer/command/string/verbosity.rb

@@ -1,51 +0,0 @@
-# frozen_string_literal: true
-
-module Reviewer
-  class Command
-    class String
-      # Assembles tool settings and provided context for silencing output
-      class Verbosity
-        include ::Reviewer::Conversions
-
-        # Even when tools provide a quiet flag, not all treat it as complete silence. In order to
-        # ensure no extraneous noise is written to the console in some contexts, command output
-        # occasionally needs to be sent to dev null to ensure there's no clutter.
-        SEND_TO_DEV_NULL = '> /dev/null'
-
-        attr_reader :flag, :level
-
-        # A wrapper for translating a desired verbosity into the correct strings to append to the
-        # command so that any output is appropriately silenced for the context under which it's
-        # currently being executed.
-        # @param flag [String] the tool-level flag to be used for silencing output
-        # @param level: Reviewer::Command::Verbosity::TOOL_SILENCE [Symbol] the target level for
-        #   silence for the the command
-        #
-        # @return [type] [description]
-        def initialize(flag, level: Reviewer::Command::Verbosity::TOOL_SILENCE)
-          @flag = String(flag)
-          @level = Verbosity(level)
-        end
-
-        # Converts the verbosity to a string that can be appended to a command string
-        #
-        # @return [String] the string to be appended to commands to ensure the correct verbosity
-        def to_s
-          to_a.map(&:strip).join(' ').strip
-        end
-
-        # Collection of values to be joined to ensure the correct verbosity
-        #
-        # @return [Array<String>] the values that need to be joined to ensure the correct verbosity
-        #   for the context
-        def to_a
-          case level.key
-          when Reviewer::Command::Verbosity::TOTAL_SILENCE then [flag, SEND_TO_DEV_NULL].compact
-          when Reviewer::Command::Verbosity::TOOL_SILENCE  then [flag].compact
-          else []
-          end
-        end
-      end
-    end
-  end
-end

data/lib/reviewer/command/verbosity.rb

@@ -1,65 +0,0 @@
-# frozen_string_literal: true
-
-module Reviewer
-  class Command
-    # Defines the possible verbosity options for running commands
-    class Verbosity
-      include Comparable
-
-      class InvalidLevelError < ArgumentError; end
-
-      # Use the quiet flag and send everything to dev/null.
-      # For some tools "quiet" means "less noisy" rather than truly silent.
-      # So in those cases, dev/null handles lingering noise.
-      TOTAL_SILENCE = :total_silence
-
-      # Just the quiet flag for the tool. Basically, let the tool determine the useful output.
-      TOOL_SILENCE = :tool_silence
-
-      # Let the output scroll for eternity
-      NO_SILENCE = :no_silence
-
-      # For validation and casting purposes
-      LEVELS = [
-        TOTAL_SILENCE,
-        TOOL_SILENCE,
-        NO_SILENCE
-      ].freeze
-
-      attr_accessor :level
-
-      # Create an instance of verbosity
-      # @param level [Symbol] one of the values of verbosity defined by LEVELS
-      #
-      # @return [Command::Verbosity] an instance of verbosity
-      def initialize(level)
-        @level = level.to_sym
-
-        verify_level!
-      end
-
-      def <=>(other)
-        level <=> other.level
-      end
-
-      def to_s
-        level.to_s
-      end
-
-      def to_i
-        LEVELS.index(level)
-      end
-
-      def to_sym
-        level
-      end
-      alias key to_sym
-
-      private
-
-      def verify_level!
-        raise InvalidLevelError, "Invalid Verbosity Level: '#{level}'" unless LEVELS.include?(level)
-      end
-    end
-  end
-end

data/lib/reviewer/printer.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-module Reviewer
-  # Clean formatter for logging to $stdout
-  class StandardOutFormatter < ::Logger::Formatter
-    # Overrides ::Logger::Formatter `call` to present output more concisely
-    # @param _severity [Logger::Severity] Unused - Logger severity for etnry
-    # @param _time [DateTime] Unused - Timestamp for entry
-    # @param _progname [String] Unused - Name of the current program for entry
-    # @param message [String] The string to print to $stdout
-    #
-    # @return [type] [description]
-    def call(_severity, _time, _progname, message)
-      "#{message}\n"
-    end
-  end
-
-  # Logger for $stdout
-  class Printer < ::Logger
-    def initialize(formatter = StandardOutFormatter.new)
-      super($stdout)
-      @formatter = formatter
-    end
-  end
-end

data/lib/reviewer/runner/strategies/quiet.rb

@@ -1,90 +0,0 @@
-# frozen_string_literal: true
-
-module Reviewer
-  class Runner
-    module Strategies
-      # Execution strategy to run a command quietly
-      class Quiet
-        attr_accessor :runner
-
-        # Create an instance of the quiet strategy for a command runner so that any output is fully
-        # suppressed so as to not create too much noise when running multiple commands.
-        # @param runner [Runner] the instance of the runner to apply the strategy to
-        #
-        # @return [Runner::Strategies::Quiet] an instance of the relevant quiet strategy
-        def initialize(runner)
-          @runner = runner
-          @runner.command.verbosity = Reviewer::Command::Verbosity::TOTAL_SILENCE
-        end
-
-        # The prepare command strategy when running a command quietly
-        #
-        # @return [void]
-        def prepare
-          # Running the prepare command, so make sure the timestamp is updated
-          runner.update_last_prepared_at
-
-          # Run the prepare command, suppressing the output and capturing the realtime benchmark
-          runner.shell.capture_prep(runner.prepare_command)
-        end
-
-        # The run command strategy when running a command verbosely
-        #
-        # @return [void]
-        def run
-          # Run the primary command, suppressing the output and capturing the realtime benchmark
-          runner.shell.capture_main(runner.command)
-
-          # If it's successful, show that it was a success and how long it took to run, otherwise,
-          # it wasn't successful and we got some explaining to do...
-          runner.success? ? show_timing_result : show_command_output
-        end
-
-        private
-
-        # Prints "Success" and the resulting timing details before moving on to the next tool
-        #
-        # @return [void]
-        def show_timing_result
-          runner.output.success(runner.timer)
-        end
-
-        # Prints "Failure" and the resulting exit status. Shows the precise command that led to the
-        # failure for easier copy and paste or making it easier to see any incorrect syntax or
-        # options that could be corrected.
-        #
-        # @return [void]
-        def show_command_output
-          runner.output.failure("Exit Status #{runner.exit_status}", command: runner.command)
-
-          # If it can't be rerun, then don't try
-          return if runner.result.total_failure?
-
-          # If it can be rerun, set the strategy to verbose so the output will be visible, and then
-          # run it with the verbose strategy so the output isn't suppressed. Long-term, it makes
-          # sense to add an option for whether to focus on speed or rich output.
-          #
-          # For now, the simplest strategy is to re-run the exact same command without suppressing
-          # the output. However, running a command twice isn't exactly efficient. Since we've
-          # already run it once and captured the output, we could just display that output, but it
-          # would be filtered through as a dumb string. That would mean it strips out color and
-          # formatting. It would save time, but what's the threshold where the time savings is worth
-          # it?
-          #
-          # Ultimately, this will be a tradeoff between how much the tool's original formatting
-          # makes it easier to scan the results and take action. For example, if a command takes
-          # 60 seconds to run, it might be faster to show the low-fidelity output immediately rather
-          # than waiting another 60 seconds for higher-fidelity output.
-          #
-          # Most likely, this will be a tool-by-tool decision and need to be added as an option to
-          # the tool configuration, but that will create additional complexity/overhead when adding
-          # a new tool.
-          #
-          # So for now, we punt. And pay close attention.
-          runner.strategy = Strategies::Verbose
-          runner.run
-        end
-      end
-    end
-  end
-end