reviewer 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64e0b63ddf470414a26b5903508646ace97b1b0ee6e2b0244e7233d9e6717652
-  data.tar.gz: 97b9d1d998959319791022b37f00fde7b6424411c728e98fb8109c352078088d
+  metadata.gz: 538f085294cbfbb5ce7c8412a39991534a2251b83978894133537f20e2bbf1ba
+  data.tar.gz: 39bee00497eccb91256b772f5af8a77746374648efd884c9ffb719f9fd7b1e16
 SHA512:
-  metadata.gz: da483ff2104b138d463c1688731c3eb83ecb8778105af38efbe98f6c7597f9aa4a069341580a3fc7bb34833cf83119d64967a56398e0cea4f97ae7bebc2ae5f2
-  data.tar.gz: f9f1106bf11209abd1a5af2d3ad151413a1026cbe43a4a5db171414d335df7cae9c7ab8d922e661da0625240163d55906eccf9b8fe03a245869f97b00bc94ce8
+  metadata.gz: 872fbfb03db5c520c6b20d0eedf624ae37c9c9c2452b34bb286a4f9c52eddafe2846f5e401d702424e14dae9a153cefd6e3f8e8bf15a9a3e4c58e76940af64e9
+  data.tar.gz: 4bc2ae679b15339577014e404fb8340c436e0c7ae26f6f46ac2baaf94d14592c42610a343e6eba679928bdcb3d1c0698f0e75d68771f78fa4f1bef9f03ed8dfd

data/.inch.yml

@@ -0,0 +1,4 @@
+files:
+  # define files included in the analysis (defaults to ["{app,lib}/**/*.rb"])
+  included:
+    - lib/**/*.rb

data/.reviewer.example.yml

@@ -14,14 +14,16 @@
 #    prepare:                   // Optional. Command to run prior to the review phase. ex. 'bundle exec bundle-audit update'
 #    review:                    // Required. The only truly required field because this is the whole point.
 #    format:                    // Optional. Command to auto-update rule violations when possible.
-#    quiet_option:                // Optional, but strongly suggested. Helps keep output under control when running multiple tools.
+#    quiet_option:              // Optional, but strongly suggested. Helps keep output under control when running multiple tools.
 #    max_exit_status:           // Optional, defaults to 0. Some tools like Yarn Audit essentially won't return less than a 3. This specifies the threshold that's still considered passing.
-#   env:                        // Optional. A way to specify necessary environment variables for the tools commands. The key is the variable name, and the value is, well, the value.
-#     example_one: value        //           - The names will automatically be capitalized, so you can freely use lower-case here.
-#     example_one: value        //           - Reviewer is smart enough to handle string values with spaces and automatically quote them.
-#   flags:                      // Optional. A way to specify flags *only for the review command*. The key is the flag name, and the value is, well, the value.
-#     example_one: value        //           - Reviewer is smart enough to handle single-letter (-f) and multi-letter (--format) flags.
-#     example_two: value        //           - It's highly-recommended to use the longer-name format for flags when possible to serve as self-documentation.
+#    files_flag:                // Optional, defaults to '' (empty string). The name of the flag used to pass subsets of files to the command.
+#    files_separator:           // Optional, defaults to ' ' (single space). The character used to separate lists of files and directories.
+#  env:                         // Optional. A way to specify necessary environment variables for the tools commands. The key is the variable name, and the value is, well, the value.
+#    example_one: value         //           - The names will automatically be capitalized, so you can freely use lower-case here.
+#    example_one: value         //           - Reviewer is smart enough to handle string values with spaces and automatically quote them.
+#  flags:                       // Optional. A way to specify flags *only for the review command*. The key is the flag name, and the value is, well, the value.
+#    example_one: value         //           - Reviewer is smart enough to handle single-letter (-f) and multi-letter (--format) flags.
+#    example_two: value         //           - It's highly-recommended to use the longer-name format for flags when possible to serve as self-documentation.
 
 # This is an example for a YAML block for a command-line tool:
 #

data/.reviewer.yml

@@ -1,7 +1,7 @@
 bundler_audit:
-  tags: [critical, dependencies, ruby]
+  tags: [critical, dependencies, ruby, dev]
   name: Bundler Audit
-  description: Audit Gem Dependencies for Security Issues
+  description: Review Gem Dependencies for Security Issues
   links:
     home: https://github.com/rubysec/bundler-audit
     install: https://github.com/rubysec/bundler-audit#install
@@ -14,7 +14,7 @@ bundler_audit:
 tests:
   name: Minitest
   description: Unit Tests
-  tags: [ruby, tests]
+  tags: [ruby, tests, dev]
   links:
     home:
   commands:
@@ -22,8 +22,9 @@ tests:
     quiet_option: '--silent'
 
 rubocop:
+  name: Rubocop
+  description: Review Ruby Syntax & Formatting for Consistency
   tags: [ruby, syntax]
-  description: Review Ruby syntax/formatting for consistency
   links:
     home: https://rubocop.org
     install: https://docs.rubocop.org/rubocop/1.13/installation.html
@@ -34,3 +35,16 @@ rubocop:
     review: 'bundle exec rubocop --parallel'
     format: 'bundle exec rubocop --auto-correct'
     quiet_option: '--format q'
+    files_flag: ''
+    files_list_separator: ' '
+
+inch:
+  disabled: true # Inch provides guidance and is generally run solo
+  tags: [docs, ruby, dev]
+  name: Inch
+  description: Review Ruby Documentation
+  links:
+    home: https://rrrene.org/inch/
+  commands:
+    install: 'bundle exec gem install inch'
+    review: 'bundle exec inch'

data/CHANGELOG.md

@@ -1,8 +1,29 @@
 ## [Unreleased]
 
-- TODO: Add Runner to handle timing, logging, and exit status
-- TODO: Add Targets to handle targeting specific files
-- TODO: Add support for Targets in Tool/Command generator
+- TODO: Improve and streamline installation
+- TODO: Add support for targeting specific files
+
+## [0.1.3] - 2021-07-07
+
+The most significant update to how the core commands work and how the command-line arguments are handled. Most of the overall structure is starting to feel stable enough to begin documenting and adding comments.
+
+- Commands are now `rvw` and `fmt`
+- Adds command-line arguments support
+- Adds support for specifying tags via the command-line
+- Adds support for specifying files via the command-line
+- Adds support for handling keywords via the command-line
+- Improved configuration and loading
+- Adds Tools class for more convenient filtering of tools based on arguments
+- Begins the process of adding documentation comments
+
+## [0.1.2] - 2021-05-04
+
+The bare minimum works now, but it's not quite there for day-to-day use. It works well enough that it's being used to review this project, but there's much more to do.
+
+- Add Runner to wrap individual commands
+- Add benchmark/timing to Runner
+- Extract Logging to a dedicated class
+- Intelligently handle non-zero exit statuses
 
 ## [0.1.1] - 2021-04-17
 

data/Gemfile

@@ -7,4 +7,5 @@ gemspec
 
 gem 'rake', '~> 13.0'
 
-gem 'minitest', '~> 5.0'
+gem 'minitest', '~> 5.14.4'
+gem 'minitest-color', '~> 0.0.2'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    reviewer (0.1.2)
+    reviewer (0.1.3)
       activesupport
       colorize
       slop
@@ -19,14 +19,26 @@ GEM
     bundler-audit (0.8.0)
       bundler (>= 1.2.0, < 3)
       thor (~> 1.0)
+    coderay (1.1.3)
     colorize (0.8.1)
     concurrent-ruby (1.1.8)
     i18n (1.8.10)
       concurrent-ruby (~> 1.0)
+    inch (0.8.0)
+      pry
+      sparkr (>= 0.2.0)
+      term-ansicolor
+      yard (~> 0.9.12)
+    method_source (1.0.0)
     minitest (5.14.4)
+    minitest-color (0.0.2)
+      minitest (~> 5)
     parallel (1.20.1)
     parser (3.0.1.0)
       ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
     rainbow (3.0.0)
     rake (13.0.3)
     regexp_parser (2.1.1)
@@ -48,10 +60,17 @@ GEM
       rubocop
     ruby-progressbar (1.11.0)
     slop (4.8.2)
+    sparkr (0.4.1)
+    sync (0.5.0)
+    term-ansicolor (1.7.1)
+      tins (~> 1.0)
     thor (1.1.0)
+    tins (1.28.0)
+      sync
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.0.0)
+    yard (0.9.26)
     zeitwerk (2.4.2)
 
 PLATFORMS
@@ -61,7 +80,9 @@ PLATFORMS
 
 DEPENDENCIES
   bundler-audit
-  minitest (~> 5.0)
+  inch
+  minitest (~> 5.14.4)
+  minitest-color (~> 0.0.2)
   rake (~> 13.0)
   reviewer!
   rubocop

data/README.md

@@ -17,10 +17,10 @@ bundle exec rake notes
 
 You run...
 ```
-./bin/rvw
+rvw
 ```
 
-Having a simpler command is just the beginning through. It also cleans up the output and lets you run subsets of commands.
+But that's just the beginning. It also cleans up the output and lets easily you run subsets of commands for different contexts.
 
 For more detailed information, take a look at the [Overview](https://github.com/garrettdimon/reviewer/wiki/Overview) and [Usage](https://github.com/garrettdimon/reviewer/wiki/Usage) pages in the wiki.
 

data/{bin → exe}/fmt

@@ -1,5 +1,7 @@
 #!/usr/bin/env ruby
 
+# frozen_string_literal: true
+
 require_relative '../lib/reviewer'
 
 Reviewer.format

data/{bin → exe}/rvw

@@ -1,5 +1,7 @@
 #!/usr/bin/env ruby
 
+# frozen_string_literal: true
+
 require_relative '../lib/reviewer'
 
 Reviewer.review

data/lib/reviewer.rb

@@ -3,8 +3,8 @@
 require 'active_support/core_ext/string'
 require 'benchmark'
 
-require_relative 'reviewer/configuration'
 require_relative 'reviewer/arguments'
+require_relative 'reviewer/configuration'
 require_relative 'reviewer/loader'
 require_relative 'reviewer/logger'
 require_relative 'reviewer/runner'
@@ -17,38 +17,91 @@ module Reviewer
   class Error < StandardError; end
 
   class << self
-    attr_writer :configuration, :logger
-  end
+    attr_writer :configuration
 
-  def self.review
-    elapsed_time = Benchmark.realtime do
-      Tools.all.each do |tool|
-        next if tool.disabled?
+    # Runs the `review` command for the specified tools/files. Reviewer expects all configured
+    # commands that are not disabled to have an entry for the `review` command.
+    #
+    # @return [void] Prints output to the console
+    def review
+      perform(:review)
+    end
 
-        exit_status = Runner.new(tool, :review).run
+    # Runs the `format` command for the specified tools/files for which it is configured.
+    #
+    # @return [void] Prints output to the console
+    def format
+      perform(:format)
+    end
 
-        break unless exit_status <= tool.max_exit_status
-      end
+    # The collection of arguments that were passed via the command line.
+    #
+    # @return [Reviewer::Arguments] exposes tags, files, and keywords from arguments
+    def arguments
+      @arguments ||= Arguments.new
     end
-    puts "\n➤ Total Time: #{elapsed_time.round(3)}s\n"
-  end
 
-  def self.format
-    # options = Arguments.new
-    Tools.all.each do |tool|
-      Runner.run(tool, :format)
+    # An interface for the collection of configured tools for accessing subsets of tools
+    # based on enabled/disabled, tags, keywords, etc.
+    #
+    # @return [Reviewer::Tools] exposes the set of tools to be run in a given context
+    def tools
+      @tools ||= Tools.new
     end
-  end
 
-  def self.configuration
-    @configuration ||= Configuration.new
-  end
+    # The primary output method for Reviewer to consistently display success/failure details for a
+    # unique run of each tool and the collective summary when relevant.
+    #
+    # @return [Reviewer::Logger] prints formatted output to the command line.
+    def logger
+      @logger ||= Logger.new
+    end
 
-  def self.reset
-    @configuration = Configuration.new
-  end
+    # Exposes the configuration options for Reviewer.
+    #
+    # @return [Reviewer::Configuration] configuration settings instance
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    # A block approach to configuring Reviewer.
+    #
+    # @example Set configuration file path
+    #   Reviewer.configure do |config|
+    #     config.file = '~/configuration.yml'
+    #   end
+    #
+    # @return [Reviewer::Configuration] Reviewer configuration settings
+    def configure
+      yield(configuration)
+    end
+
+    private
 
-  def self.configure
-    yield(configuration)
+    # Provides a consistent approach to running and benchmarking commmands and preventing further
+    # execution of later tools if a command fails.
+    # @param command_type [Symbol] the specific command to run for each tool
+    #
+    # @example Run the `review` command for each relevant tool
+    #   perform(:review)
+    #
+    # @return [Hash] the exit status (in integer format) for each command run
+    def perform(command_type)
+      results = {}
+
+      elapsed_time = Benchmark.realtime do
+        tools.current.each do |tool|
+          runner = Runner.new(tool, command_type, logger: logger)
+          exit_status = runner.run
+          results[tool.key] = exit_status
+
+          # If a single tool fails, stop there.
+          break unless exit_status <= tool.max_exit_status
+        end
+      end
+      logger.total_time(elapsed_time)
+
+      results
+    end
   end
 end

data/lib/reviewer/arguments.rb

@@ -1,9 +1,23 @@
 # frozen_string_literal: true
 
+require_relative 'arguments/keywords'
+require_relative 'arguments/files'
+require_relative 'arguments/tags'
+
 require 'slop'
 
 module Reviewer
-  # Handles option parsing for bin/review
+  # Handles option parsing for `rvw` and `fmt` commands
+  #
+  # @example
+  #
+  #   `rvw`
+  #   `rvw -t ruby`
+  #   `rvw -f ./example.rb,./example_test.rb`
+  #   `rvw staged`
+  #   `rvw --files ./example.rb,./example_test.rb --tags syntax`
+  #   `rvw ruby staged`
+  #
   class Arguments
     attr_accessor :options
 
@@ -24,21 +38,28 @@ module Reviewer
       end
     end
 
-    def files
-      options[:files]
+    def inspect
+      {
+        files: files.raw,
+        tags: tags.raw,
+        keywords: keywords.raw
+      }
     end
 
     def tags
-      options[:tags]
+      @tags ||= Arguments::Tags.new(provided: options[:tags])
     end
 
-    def arguments
-      options.arguments
+    def files
+      @files ||= Arguments::Files.new(provided: options[:files])
     end
 
     def keywords
-      # TODO: Filter arguments to only for allowed keywords to be defined later.
-      arguments
+      @keywords ||= Arguments::Keywords.new(options.arguments)
+    end
+
+    def tool_names
+      @tool_names ||= keywords.for_tool_names.to_a
     end
   end
 end

data/lib/reviewer/arguments/files.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Reviewer
+  class Arguments
+    # Generates the list of files to run the command against
+    class Files
+      attr_reader :provided, :keywords
+
+      alias raw provided
+
+      def initialize(provided: Reviewer.arguments.files.raw, keywords: Reviewer.arguments.keywords)
+        @provided = Array(provided)
+        @keywords = Array(keywords)
+      end
+
+      def to_a
+        file_list
+      end
+
+      def to_s
+        to_a.join(',')
+      end
+
+      def inspect
+        {
+          provided: provided,
+          from_keywords: from_keywords
+        }
+      end
+
+      private
+
+      def file_list
+        @file_list ||= [
+          *provided,
+          *from_keywords
+        ].compact.sort.uniq
+      end
+
+      def from_keywords
+        return [] unless keywords.any?
+
+        keywords.map do |keyword|
+          next unless respond_to?(keyword.to_sym, true)
+
+          send(keyword.to_sym)
+        end.flatten.uniq
+      end
+
+      def staged
+        # Use git for list of staged fields
+        ::Reviewer::Arguments::Keywords::Git::Staged.list
+      end
+    end
+  end
+end

data/lib/reviewer/arguments/keywords.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+require_relative 'keywords/git'
+
+module Reviewer
+  class Arguments
+    # Handles interpreting all 'leftover' arguments and translating them to file-related,
+    # tag-related, or tool-related arguments
+    class Keywords
+      RESERVED = %w[staged].freeze
+
+      attr_accessor :provided
+
+      alias raw provided
+
+      def initialize(*provided)
+        @provided = Array(provided.flatten)
+      end
+
+      def to_a
+        provided
+      end
+
+      def to_s
+        to_a.join(',')
+      end
+
+      def inspect
+        {
+          provided: provided,
+          recognized: recognized,
+          unrecognized: unrecognized,
+          reserved: reserved,
+          for_tags: for_tags,
+          for_tool_names: for_tool_names
+        }
+      end
+
+      # Extracts reserved keywords from the provided arguments
+      #
+      # @return [Array<String>] intersection of provided arguments and reserved keywords
+      def reserved
+        intersection_with RESERVED
+      end
+
+      # Extracts keywords that match configured tags for enabled tools
+      #
+      # @return [Array<String>] intersection of provided arguments and configured tags for tools
+      def for_tags
+        intersection_with configured_tags
+      end
+
+      # Extracts keywords that match configured tool keys
+      #
+      # @return [Array<String>] intersection of provided arguments and configured tool names
+      def for_tool_names
+        intersection_with configured_tool_names
+      end
+
+      # Extracts keywords that match any possible recognized keyword values
+      #
+      # @return [Array<String>] intersection of provided arguments and recognizable keywords
+      def recognized
+        intersection_with possible
+      end
+
+      # Extracts keywords that don't match any possible recognized keyword values
+      #
+      # @return [Array<String>] leftover keywords that weren't recognized
+      def unrecognized
+        (provided - recognized).uniq.sort
+      end
+
+      # Provides the complete list of all recognized keywords based on configuration
+      #
+      # @return [Array<String>] all keywords that Reviewer can recognized
+      def possible
+        (RESERVED + configured_tags + configured_tool_names).uniq.sort
+      end
+
+      # Provides the complete list of all configured tags for enabled tools
+      #
+      # @return [Array<String>] all unique configured tags
+      def configured_tags
+        enabled_tools.map(&:tags).flatten.uniq.sort
+      end
+
+      # Provides the complete list of all configured tool names for enabled tools
+      #
+      # @return [Array<String>] all unique configured and enabled tools
+      def configured_tool_names
+        # We explicitly don't sort the tool names list because Reviewer uses the configuration order
+        # to determine the execution order. So not sorting maintains the predicted order it will run
+        # in and leaves the option to sort to the consuming code if needed
+        enabled_tools.map { |tool| tool.key.to_s }.flatten.uniq
+      end
+
+      private
+
+      # Provides a collection of enabled Tools for convenient access
+      #
+      # @return [Array<Reviewer::Tool>] collection of all currently enabled tools
+      def enabled_tools
+        @enabled_tools ||= Reviewer.tools.enabled
+      end
+
+      # Syntactic sugar for finding intersections with valid keywords
+      # @param values [Array<String>] the collection to use for finding intersecting values
+      #
+      # @return [Array<String>] the list of intersecting values
+      def intersection_with(values)
+        values.intersection(provided).uniq.sort
+      end
+    end
+  end
+end

data/lib/reviewer/arguments/keywords/git.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require_relative 'git/staged'
+
+module Reviewer
+  class Arguments
+    class Keywords
+      module Git
+        BASE_COMMAND = [
+          'git',
+          '--no-pager'
+        ].freeze
+      end
+    end
+  end
+end

data/lib/reviewer/arguments/keywords/git/staged.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Reviewer
+  class Arguments
+    class Keywords
+      module Git
+        # Provides a convenient interface to get the list of staged files
+        class Staged
+          OPTIONS = [
+            'diff',
+            '--staged',
+            '--name-only'
+          ].freeze
+
+          attr_reader :stdout, :stderr, :status, :exit_status
+
+          def to_a
+            stdout.present? ? stdout.split("\n") : []
+          end
+
+          def to_s
+            stdout.present? ? stdout : ''
+          end
+
+          def inspect
+            {
+              command: command,
+              stdout: stdout,
+              stderr: stderr,
+              status: status,
+              results: results
+            }
+          end
+
+          def list
+            @stdout, @stderr, @status = Open3.capture3(command)
+            @exit_status = @status.exitstatus.to_i
+
+            @status.success? ? to_a : raise_command_line_error
+          end
+
+          def self.list
+            new.list
+          end
+
+          def command
+            command_parts.join(' ')
+          end
+
+          private
+
+          def raise_command_line_error
+            message = "Git Error: #{stderr} (#{command})"
+            raise SystemCallError.new(message, exit_status)
+          end
+
+          def command_parts
+            BASE_COMMAND + OPTIONS
+          end
+        end
+      end
+    end
+  end
+end

data/lib/reviewer/arguments/tags.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Reviewer
+  class Arguments
+    # Handles the logic of translating tag arguments
+    class Tags
+      attr_accessor :provided, :keywords
+
+      alias raw provided
+
+      def initialize(provided: Reviewer.arguments.tags.raw, keywords: Reviewer.arguments.keywords.for_tags)
+        @provided = Array(provided)
+        @keywords = Array(keywords)
+      end
+
+      def to_a
+        tag_list
+      end
+
+      def to_s
+        to_a.join(',')
+      end
+
+      def inspect
+        {
+          provided: provided,
+          from_keywords: keywords
+        }
+      end
+
+      private
+
+      def tag_list
+        @tag_list ||= [
+          *provided,
+          *keywords
+        ].compact.sort.uniq
+      end
+    end
+  end
+end

data/lib/reviewer/configuration.rb

@@ -1,19 +1,16 @@
 # frozen_string_literal: true
 
 module Reviewer
-  # Configuration for Reviewer
+  # Configuration values container for Reviewer
   class Configuration
-    DEFAULT_CONFIGURATION_PATH = Dir.pwd.freeze
-    DEFAULT_CONFIGURATION_FILE = '.reviewer.yml'
+    DEFAULT_PATH = Dir.pwd.freeze
+    DEFAULT_FILE_NAME = '.reviewer.yml'
+    DEFAULT_FILE = "#{DEFAULT_PATH}/#{DEFAULT_FILE_NAME}"
 
     attr_accessor :file
 
     def initialize
-      @file = "#{DEFAULT_CONFIGURATION_PATH}/#{DEFAULT_CONFIGURATION_FILE}"
-    end
-
-    def tools
-      @tools ||= Loader.new.to_h
+      @file = DEFAULT_FILE
     end
   end
 end

data/lib/reviewer/loader.rb

@@ -10,24 +10,51 @@ module Reviewer
 
     class InvalidConfigurationError < StandardError; end
 
-    attr_reader :configuration
+    class MissingReviewCommandError < StandardError; end
 
-    def initialize
+    attr_reader :configuration, :file
+
+    def initialize(file = Reviewer.configuration.file)
+      @file = file
       @configuration = HashWithIndifferentAccess.new(configuration_hash)
+
+      validate_configuration!
     end
 
     def to_h
       configuration
     end
 
+    def self.configuration
+      new.configuration
+    end
+
     private
 
+    def validate_configuration!
+      # Any additional guidance for configuration issues will live here
+      require_review_commands!
+    end
+
+    def require_review_commands!
+      configuration.each do |key, value|
+        commands = value[:commands]
+
+        next if commands.key?(:review)
+
+        # Ideally, folks would want to fill out everything to receive the most benefit,
+        # but realistically, the 'review' command is the only required value. If the key
+        # is missing, or maybe there was a typo, fail right away.
+        raise MissingReviewCommandError, "'#{key}' does not have a 'review' key under 'commands' in `#{file}`"
+      end
+    end
+
     def configuration_hash
-      @configuration_hash ||= YAML.load_file(Reviewer.configuration.file)
+      @configuration_hash ||= YAML.load_file(@file)
     rescue Errno::ENOENT
-      raise MissingConfigurationError, "Tools configuration file couldn't be found - #{Reviewer.configuration.file}"
+      raise MissingConfigurationError, "Tools configuration file couldn't be found at `#{file}`"
     rescue Psych::SyntaxError => e
-      raise InvalidConfigurationError, "Tools configuration file has a syntax error - #{e.message}"
+      raise InvalidConfigurationError, "Tools configuration file (#{file}) has a syntax error: #{e.message}"
     end
   end
 end

data/lib/reviewer/logger.rb

@@ -5,6 +5,13 @@ require 'colorize'
 module Reviewer
   # Clean formatter for logging to $stdout
   class StandardOutFormatter < ::Logger::Formatter
+    # Overrides ::Logger::Formatter `call` to more 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
@@ -26,11 +33,13 @@ module Reviewer
     end
 
     def command(cmd)
-      info "#{PROMPT} #{cmd}".light_black
+      info "\nReviewer ran this command:"
+      info cmd.to_s.light_black
     end
 
-    def rerunning(tool)
-      info "\n\nRe-running #{tool.name} verbosely:"
+    def rerunning(tool, cmd)
+      info "\nRe-running #{tool.name} verbosely:"
+      info cmd.to_s.light_black
     end
 
     def success(elapsed_time)
@@ -38,12 +47,16 @@ module Reviewer
     end
 
     def failure(message)
-      info "#{FAILURE} #{message}".red.bold
+      error "#{FAILURE} #{message}".red.bold
+    end
+
+    def total_time(elapsed_time)
+      info "\n➤ Total Time: #{elapsed_time.round(3)}s\n"
     end
 
     def guidance(summary, details)
-      info "  #{summary}" if summary
-      info "  #{details}".light_black if details
+      info "\n#{summary}" if summary
+      info details.to_s.light_black if details
     end
   end
 end

data/lib/reviewer/runner.rb

@@ -3,13 +3,19 @@
 require 'open3'
 
 module Reviewer
-  # Handles running, benchmarking, and printing output for a command
+  # Handles running, benchmarking, and printing output for a single command
   class Runner
-    COMMAND_NOT_FOUND_EXIT_STATUS_CODE = 127
+    EXECUTABLE_NOT_FOUND_EXIT_STATUS_CODE = 127
 
     attr_accessor :tool, :command
 
-    attr_reader :elapsed_time, :stdout, :stderr, :status, :exit_status, :logger
+    attr_reader :elapsed_time,
+                :last_command_run,
+                :stdout,
+                :stderr,
+                :status,
+                :exit_status,
+                :logger
 
     def initialize(tool, command, logger: Logger.new)
       @tool = tool
@@ -21,8 +27,7 @@ module Reviewer
       logger.running(tool)
 
       @elapsed_time = Benchmark.realtime do
-        prepare
-        review
+        tool.format_command? ? run_format : run_review
       end
 
       print_result
@@ -34,32 +39,26 @@ module Reviewer
     def shell_out(cmd)
       @stdout, @stderr, @status = Open3.capture3(cmd)
       @exit_status = status.exitstatus
-
-      logger.command(cmd) unless status.success?
+      @last_command_run = cmd
     end
 
-    def prepare
+    def run_review
       shell_out(tool.preparation_command) if tool.prepare_command?
-    end
-
-    def review
       shell_out(tool.review_command(seed: seed))
     end
 
-    def format
+    def run_format
       shell_out(tool.format_command) if tool.format_command?
     end
 
     def review_verbosely
       cmd = tool.review_command(:no_silence, seed: seed)
-      logger.rerunning(tool)
-      logger.command(cmd)
+      logger.rerunning(tool, cmd)
       system(cmd)
     end
 
     def print_result
       if status.success?
-        # Outputs success details
         logger.success(elapsed_time)
       else
         recovery_guidance
@@ -68,6 +67,7 @@ module Reviewer
 
     def recovery_guidance
       logger.failure(error_message)
+      logger.command(last_command_run)
       if missing_executable?
         missing_executable_guidance
       else
@@ -84,12 +84,12 @@ module Reviewer
     end
 
     def missing_executable_guidance
-      logger.guidance('Installation Command:', tool.installation_command) if tool.install_command?
-      logger.guidance('Installation Help:', tool.settings.links[:install]) if tool.install_link?
+      logger.guidance('Try installing the tool:', tool.installation_command) if tool.install_command?
+      logger.guidance('Read the installation guidance:', tool.settings.links[:install]) if tool.install_link?
     end
 
     def missing_executable?
-      (@exit_status == COMMAND_NOT_FOUND_EXIT_STATUS_CODE) ||
+      (@exit_status == EXECUTABLE_NOT_FOUND_EXIT_STATUS_CODE) ||
         stderr.include?("can't find executable")
     end
 

data/lib/reviewer/tool.rb

@@ -13,6 +13,8 @@ module Reviewer
 
     delegate :name,
              :description,
+             :tags,
+             :key,
              :enabled?,
              :disabled?,
              :max_exit_status,
@@ -30,6 +32,14 @@ module Reviewer
       name
     end
 
+    def to_sym
+      key
+    end
+
+    def ==(other)
+      settings == other.settings
+    end
+
     def installation_command(verbosity_level = :no_silence)
       command_string(:install, verbosity_level: verbosity_level)
     end

data/lib/reviewer/tool/settings.rb

@@ -4,18 +4,18 @@ module Reviewer
   class Tool
     # Converts/casts tool configuration values and provides default values if not set
     class Settings
-      class MissingReviewCommandError < StandardError; end
-
-      attr_reader :tool, :config
+      attr_reader :tool
 
       def initialize(tool, config: nil)
         @tool = tool
-        @config = config || Reviewer.configuration.tools.fetch(tool.to_sym) { {} }
+        @config = config
+      end
 
-        # Ideally, folks would fill out everything, but realistically, the 'review' command is the only required value.
-        # If the key is missing, or maybe there was a typo, fail right away.
-        raise MissingReviewCommandError, "'#{key}' does not have a 'review' key under 'commands' in `#{Reviewer.configuration.file}`" unless commands.key?(:review)
+      def ==(other)
+        self.class == other.class &&
+          state == other.state
       end
+      alias eql? ==
 
       def disabled?
         config.fetch(:disabled, false)
@@ -80,6 +80,16 @@ module Reviewer
       def quiet_option
         commands.fetch(:quiet_option, '')
       end
+
+      protected
+
+      def config
+        @config || Reviewer.tools.to_h.fetch(tool.to_sym) { {} }
+      end
+
+      def state
+        config.to_hash
+      end
     end
   end
 end

data/lib/reviewer/tools.rb

@@ -1,14 +1,62 @@
 # frozen_string_literal: true
 
 module Reviewer
-  # Provides a collection of the configured tools
-  module Tools
-    def self.all
-      tools = []
-      Reviewer.configuration.tools.each_key do |key|
-        tools << Tool.new(key)
-      end
-      tools
+  # Provides convenient access to subsets of configured tools
+  class Tools
+    def initialize(tags: nil, tool_names: nil)
+      @tags       = tags
+      @tool_names = tool_names
+    end
+
+    def to_h
+      configured
+    end
+
+    def all
+      configured.keys.map { |tool_name| Tool.new(tool_name) }
+    end
+    alias to_a all
+
+    def enabled
+      @enabled ||= all.keep_if(&:enabled?)
+    end
+
+    def specified
+      all.keep_if { |tool| named?(tool) }
+    end
+
+    def tagged
+      enabled.keep_if { |tool| tagged?(tool) }
+    end
+
+    def current
+      subset? ? (specified + tagged).uniq : enabled
+    end
+
+    private
+
+    def subset?
+      tool_names.any? || tags.any?
+    end
+
+    def configured
+      @configured ||= Loader.configuration
+    end
+
+    def tags
+      Array(@tags || Reviewer.arguments.tags)
+    end
+
+    def tool_names
+      Array(@tool_names || Reviewer.arguments.tool_names)
+    end
+
+    def tagged?(tool)
+      tool.enabled? && tags.intersection(tool.tags).any?
+    end
+
+    def named?(tool)
+      tool_names.map(&:to_s).include?(tool.key.to_s)
     end
   end
 end

data/lib/reviewer/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Reviewer
-  VERSION = '0.1.2'
+  VERSION = '0.1.3'
 end

data/reviewer.gemspec

@@ -32,6 +32,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'slop'
 
   spec.add_development_dependency 'bundler-audit'
+  spec.add_development_dependency 'inch'
   spec.add_development_dependency 'rubocop'
   spec.add_development_dependency 'rubocop-minitest'
   spec.add_development_dependency 'rubocop-rake'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: reviewer
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Garrett Dimon
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-05-04 00:00:00.000000000 Z
+date: 2021-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: inch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -111,12 +125,15 @@ dependencies:
 description: Provides a unified approach to managing automated code quality tools.
 email:
 - email@garrettdimon.com
-executables: []
+executables:
+- fmt
+- rvw
 extensions: []
 extra_rdoc_files: []
 files:
 - ".github/workflows/main.yml"
 - ".gitignore"
+- ".inch.yml"
 - ".reviewer.example.yml"
 - ".reviewer.yml"
 - ".rubocop.yml"
@@ -129,11 +146,16 @@ files:
 - README.md
 - Rakefile
 - bin/console
-- bin/fmt
-- bin/rvw
 - bin/setup
+- exe/fmt
+- exe/rvw
 - lib/reviewer.rb
 - lib/reviewer/arguments.rb
+- lib/reviewer/arguments/files.rb
+- lib/reviewer/arguments/keywords.rb
+- lib/reviewer/arguments/keywords/git.rb
+- lib/reviewer/arguments/keywords/git/staged.rb
+- lib/reviewer/arguments/tags.rb
 - lib/reviewer/configuration.rb
 - lib/reviewer/loader.rb
 - lib/reviewer/logger.rb