reviewer 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a5df0f3247eb105862f40b5092bb3c3b25fa20e87e155cb283fc2fd278933987
-  data.tar.gz: 06716646a5f980c5d67f89abc4ab4938977c2dd2691101d8cdd924f4481599cf
+  metadata.gz: 64e0b63ddf470414a26b5903508646ace97b1b0ee6e2b0244e7233d9e6717652
+  data.tar.gz: 97b9d1d998959319791022b37f00fde7b6424411c728e98fb8109c352078088d
 SHA512:
-  metadata.gz: 57ca3df253ec35a5544f9a2145733c535688f8be8f0ed6820973563f758563e08a6f3aa729e8743be49945d931cc63a27a21a75e4512d2f9855f1ecad055a9ac
-  data.tar.gz: 5b06953f74f63aff8410b27470a37044d764b87b07289554d0ddc3581575d8a6849603a78f656d392273ac6e4d3d358acd91a84cae49a7d49fd427800536d5cb
+  metadata.gz: da483ff2104b138d463c1688731c3eb83ecb8778105af38efbe98f6c7597f9aa4a069341580a3fc7bb34833cf83119d64967a56398e0cea4f97ae7bebc2ae5f2
+  data.tar.gz: f9f1106bf11209abd1a5af2d3ad151413a1026cbe43a4a5db171414d335df7cae9c7ab8d922e661da0625240163d55906eccf9b8fe03a245869f97b00bc94ce8

data/.github/workflows/main.yml

@@ -10,7 +10,7 @@ jobs:
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 2.6.6
+        ruby-version: 2.7.3
         bundler-cache: true
     - name: Run the default task
       run: bundle exec rake

data/.reviewer.example.yml

@@ -0,0 +1,47 @@
+# Quick overview of the options configuration for command-line tools.
+#
+# <command_key>:                // ex. 'rubocop', 'bundler-audit', etc.
+#  disabled: true               // Optional. Tools are enabled by default
+#  name:                        // Optional. Will use the `command_key` if name isn't provided.
+#  description:                 // Optional. Serves as a handy reminder for the purpose of the command.
+#  tags: [ruby, dependencies]   // Optional. Lets you run commands tagged with the same word.
+#  links:
+#    home:                      // Optional. A link to the home page for the tool.
+#    install:                   // Optional. A link to the installation instructions for the tool.
+#    ignore_syntax:             // Optional. A link to the syntax for ignoring/disabling some rules for the tool.
+#  commands:
+#    install:                   // Optional. Command to run to install the tool.
+#    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.
+#    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.
+
+# This is an example for a YAML block for a command-line tool:
+#
+# tool-name-key:
+#  disabled: true
+#  name: Tool
+#  description: A tool that finds issues and fixes code.
+#  tags: [syntax, security]
+#  links:
+#    home: https://example.com
+#    install: https://example.com/install
+#    ignore_syntax: https://example.com/ignore
+#  commands:
+#    install: 'bundle install tool'
+#    prepare: 'bundle exec tool update'
+#    review: 'bundle exec tool'
+#    format: 'bundle exec tool --format'
+#    quiet_option: '--quiet'
+#    max_exit_status: 1
+#   env:
+#     report: false
+#   flags:
+#     format: json

data/.reviewer.yml

@@ -0,0 +1,36 @@
+bundler_audit:
+  tags: [critical, dependencies, ruby]
+  name: Bundler Audit
+  description: Audit Gem Dependencies for Security Issues
+  links:
+    home: https://github.com/rubysec/bundler-audit
+    install: https://github.com/rubysec/bundler-audit#install
+  commands:
+    install: 'bundle exec gem install bundler-audit'
+    prepare: 'bundle exec bundle-audit update'
+    review: 'bundle exec bundle-audit check --no-update'
+    quiet_option: '--quiet'
+
+tests:
+  name: Minitest
+  description: Unit Tests
+  tags: [ruby, tests]
+  links:
+    home:
+  commands:
+    review: "bundle exec rake TESTOPTS='--seed=$SEED'"
+    quiet_option: '--silent'
+
+rubocop:
+  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
+    ignore_syntax: https://docs.rubocop.org/rubocop/configuration.html#ignoredmethods
+    disable_syntax: https://docs.rubocop.org/rubocop/configuration.html#disabling-cops-within-source-code
+  commands:
+    install: 'bundle exec gem install rubocop'
+    review: 'bundle exec rubocop --parallel'
+    format: 'bundle exec rubocop --auto-correct'
+    quiet_option: '--format q'

data/.rubocop.yml

@@ -0,0 +1,17 @@
+AllCops:
+  NewCops: enable
+  Exclude:
+    - 'bin/**/*'
+
+# Let's aim for 80, but we don't need to be nagged if we judiciously go over.
+Layout/LineLength:
+  Enabled: false
+
+# One case statement in a single method isn't complex.
+Metrics/CyclomaticComplexity:
+  IgnoredMethods: ['case']
+
+# 10 is a good goal but a little draconian
+Metrics/MethodLength:
+  CountAsOne: ['array', 'hash', 'heredoc']
+  Max: 15

data/.ruby-version

@@ -0,0 +1 @@
+2.7.3

data/Gemfile

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in reviewer.gemspec
 gemspec
 
-gem "rake", "~> 13.0"
+gem 'rake', '~> 13.0'
 
-gem "minitest", "~> 5.0"
+gem 'minitest', '~> 5.0'

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    reviewer (0.1.1)
+    reviewer (0.1.2)
       activesupport
+      colorize
       slop
 
 GEM
@@ -14,23 +15,58 @@ GEM
       minitest (>= 5.1)
       tzinfo (~> 2.0)
       zeitwerk (~> 2.3)
+    ast (2.4.2)
+    bundler-audit (0.8.0)
+      bundler (>= 1.2.0, < 3)
+      thor (~> 1.0)
+    colorize (0.8.1)
     concurrent-ruby (1.1.8)
     i18n (1.8.10)
       concurrent-ruby (~> 1.0)
     minitest (5.14.4)
+    parallel (1.20.1)
+    parser (3.0.1.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
     rake (13.0.3)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rubocop (1.13.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.4.1)
+      parser (>= 2.7.1.5)
+    rubocop-minitest (0.11.1)
+      rubocop (>= 0.90, < 2.0)
+    rubocop-rake (0.5.1)
+      rubocop
+    ruby-progressbar (1.11.0)
     slop (4.8.2)
+    thor (1.1.0)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
+    unicode-display_width (2.0.0)
     zeitwerk (2.4.2)
 
 PLATFORMS
+  ruby
   x86_64-darwin-19
+  x86_64-linux
 
 DEPENDENCIES
+  bundler-audit
   minitest (~> 5.0)
   rake (~> 13.0)
   reviewer!
+  rubocop
+  rubocop-minitest
+  rubocop-rake
 
 BUNDLED WITH
    2.2.16

data/README.md

@@ -1,8 +1,28 @@
+**Note:** As of May 4th, 2021, Reviewer is a work in progress and does not actually do anything just yet. Hopefully soon.
+
 # Reviewer
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/reviewer`. To experiment with that code, run `bin/console` for an interactive prompt.
+Reviewer reduces the friction of using automated tools for dependency audits, static analysis, linting, testing, and more by providing a standardized way to configure and run them in different contexts with less friction.
+
+So, instead of...
+```
+yarn audit --level moderate
+bundle exec bundle-audit check --no-update
+bundle exec rubocop --parallel
+bundle exec erblint --lint-all --enable-all-linters
+yarn stylelint .
+yarn eslint .
+bundle exec rake notes
+```
+
+You run...
+```
+./bin/rvw
+```
+
+Having a simpler command is just the beginning through. It also cleans up the output and lets you run subsets of commands.
 
-TODO: Delete this and the text above, and describe your gem
+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.
 
 ## Installation
 

data/Rakefile

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
-require "bundler/gem_tasks"
-require "rake/testtask"
+require 'bundler/gem_tasks'
+require 'rake/testtask'
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList["test/**/*_test.rb"]
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
 end
 
 task default: :test

data/bin/console

@@ -1,15 +1,15 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require "bundler/setup"
-require "reviewer"
+require 'bundler/setup'
+require 'reviewer'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
 
 # (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
+# require 'pry'
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/bin/fmt

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

data/lib/reviewer.rb

@@ -1,31 +1,43 @@
 # frozen_string_literal: true
 
-require_relative "reviewer/arguments"
-require_relative "reviewer/configuration"
-require_relative "reviewer/loader"
-require_relative "reviewer/tool"
-require_relative "reviewer/tools"
-require_relative "reviewer/version"
-
+require 'active_support/core_ext/string'
+require 'benchmark'
+
+require_relative 'reviewer/configuration'
+require_relative 'reviewer/arguments'
+require_relative 'reviewer/loader'
+require_relative 'reviewer/logger'
+require_relative 'reviewer/runner'
+require_relative 'reviewer/tool'
+require_relative 'reviewer/tools'
+require_relative 'reviewer/version'
+
+# Primary interface for the reviewer tools
 module Reviewer
   class Error < StandardError; end
 
   class << self
-    attr_writer :configuration
+    attr_writer :configuration, :logger
   end
 
   def self.review
-    options = Arguments.new
-    # TODO: Make it actually run the tools.
-    puts "Running with the following options:"
-    pp options
+    elapsed_time = Benchmark.realtime do
+      Tools.all.each do |tool|
+        next if tool.disabled?
+
+        exit_status = Runner.new(tool, :review).run
+
+        break unless exit_status <= tool.max_exit_status
+      end
+    end
+    puts "\n➤ Total Time: #{elapsed_time.round(3)}s\n"
   end
 
   def self.format
-    options = Arguments.new
-    # TODO: Make it actually run the tools.
-    puts "Running with the following options:"
-    pp options
+    # options = Arguments.new
+    Tools.all.each do |tool|
+      Runner.run(tool, :format)
+    end
   end
 
   def self.configuration

data/lib/reviewer/arguments.rb

@@ -2,8 +2,8 @@
 
 require 'slop'
 
-# Handles option parsing for bin/review
 module Reviewer
+  # Handles option parsing for bin/review
   class Arguments
     attr_accessor :options
 

data/lib/reviewer/configuration.rb

@@ -1,9 +1,10 @@
 # frozen_string_literal: true
 
 module Reviewer
+  # Configuration for Reviewer
   class Configuration
     DEFAULT_CONFIGURATION_PATH = Dir.pwd.freeze
-    DEFAULT_CONFIGURATION_FILE = '.reviewer.yml'.freeze
+    DEFAULT_CONFIGURATION_FILE = '.reviewer.yml'
 
     attr_accessor :file
 

data/lib/reviewer/loader.rb

@@ -1,12 +1,13 @@
 # frozen_string_literal: true
 
-require "yaml"
-require "active_support/core_ext/hash/indifferent_access"
+require 'yaml'
+require 'active_support/core_ext/hash/indifferent_access'
 
-# Provides a collection of the configured tools
 module Reviewer
+  # Provides a collection of the configured tools
   class Loader
     class MissingConfigurationError < StandardError; end
+
     class InvalidConfigurationError < StandardError; end
 
     attr_reader :configuration

data/lib/reviewer/logger.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'colorize'
+
+module Reviewer
+  # Clean formatter for logging to $stdout
+  class StandardOutFormatter < ::Logger::Formatter
+    def call(_severity, _time, _progname, message)
+      "#{message}\n"
+    end
+  end
+
+  # Logger for $stdout
+  class Logger < ::Logger
+    SUCCESS = 'Success'
+    FAILURE = 'Failure ·'
+    PROMPT  = '$'
+
+    def initialize(formatter = StandardOutFormatter.new)
+      super($stdout)
+      @formatter = formatter
+    end
+
+    def running(tool)
+      info "\n#{tool.name}".bold + ' · '.light_black + tool.description
+    end
+
+    def command(cmd)
+      info "#{PROMPT} #{cmd}".light_black
+    end
+
+    def rerunning(tool)
+      info "\n\nRe-running #{tool.name} verbosely:"
+    end
+
+    def success(elapsed_time)
+      info SUCCESS.green.bold + " (#{elapsed_time.round(3)}s)".green
+    end
+
+    def failure(message)
+      info "#{FAILURE} #{message}".red.bold
+    end
+
+    def guidance(summary, details)
+      info "  #{summary}" if summary
+      info "  #{details}".light_black if details
+    end
+  end
+end

data/lib/reviewer/runner.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+require 'open3'
+
+module Reviewer
+  # Handles running, benchmarking, and printing output for a command
+  class Runner
+    COMMAND_NOT_FOUND_EXIT_STATUS_CODE = 127
+
+    attr_accessor :tool, :command
+
+    attr_reader :elapsed_time, :stdout, :stderr, :status, :exit_status, :logger
+
+    def initialize(tool, command, logger: Logger.new)
+      @tool = tool
+      @command = command
+      @logger = logger
+    end
+
+    def run
+      logger.running(tool)
+
+      @elapsed_time = Benchmark.realtime do
+        prepare
+        review
+      end
+
+      print_result
+      exit_status
+    end
+
+    private
+
+    def shell_out(cmd)
+      @stdout, @stderr, @status = Open3.capture3(cmd)
+      @exit_status = status.exitstatus
+
+      logger.command(cmd) unless status.success?
+    end
+
+    def prepare
+      shell_out(tool.preparation_command) if tool.prepare_command?
+    end
+
+    def review
+      shell_out(tool.review_command(seed: seed))
+    end
+
+    def 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)
+      system(cmd)
+    end
+
+    def print_result
+      if status.success?
+        # Outputs success details
+        logger.success(elapsed_time)
+      else
+        recovery_guidance
+      end
+    end
+
+    def recovery_guidance
+      logger.failure(error_message)
+      if missing_executable?
+        missing_executable_guidance
+      else
+        review_verbosely
+      end
+    end
+
+    def error_message
+      if missing_executable?
+        "Missing executable for '#{tool}'"
+      else
+        "Exit Status #{exit_status}"
+      end
+    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?
+    end
+
+    def missing_executable?
+      (@exit_status == COMMAND_NOT_FOUND_EXIT_STATUS_CODE) ||
+        stderr.include?("can't find executable")
+    end
+
+    def seed
+      # Keep the same seed for each instance so re-running generates the same results as the failure.
+      # Otherwise, re-running after the failure will change the seed and show different results.
+      @seed ||= Random.rand(100_000)
+    end
+  end
+end

data/lib/reviewer/tool.rb

@@ -1,38 +1,51 @@
 # frozen_string_literal: true
 
-require "active_support/core_ext/string"
-require_relative "tool/command"
-require_relative "tool/env"
-require_relative "tool/flags"
-require_relative "tool/settings"
-require_relative "tool/verbosity"
-
-# Provides an instance of a specific tool
+require_relative 'tool/command'
+require_relative 'tool/env'
+require_relative 'tool/flags'
+require_relative 'tool/settings'
+require_relative 'tool/verbosity'
+
 module Reviewer
+  # Provides an instance of a specific tool
   class Tool
     attr_reader :settings
 
+    delegate :name,
+             :description,
+             :enabled?,
+             :disabled?,
+             :max_exit_status,
+             :prepare_command?,
+             :install_command?,
+             :format_command?,
+             :install_link?,
+             to: :settings
+
     def initialize(tool)
       @settings = Settings.new(tool)
     end
 
+    def to_s
+      name
+    end
+
     def installation_command(verbosity_level = :no_silence)
       command_string(:install, verbosity_level: verbosity_level)
     end
 
-    def preparation_command(verbosity_level = :no_silence)
-       command_string(:prepare, verbosity_level: verbosity_level)
+    def preparation_command(verbosity_level = :total_silence)
+      command_string(:prepare, verbosity_level: verbosity_level)
     end
 
-    def review_command(verbosity_level = :total_silence)
-      command_string(:review, verbosity_level: verbosity_level)
+    def review_command(verbosity_level = :total_silence, seed: nil)
+      command_string(:review, verbosity_level: verbosity_level).gsub('$SEED', seed.to_s)
     end
 
     def format_command(verbosity_level = :no_silence)
       command_string(:format, verbosity_level: verbosity_level)
     end
 
-
     private
 
     def command_string(command_type, verbosity_level: :no_silence)

data/lib/reviewer/tool/command.rb

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
 
-# Assembles tool tool_settings into a usable command string
 module Reviewer
   class Tool
+    # Assembles tool tool_settings into a usable command string
     class Command
       class InvalidTypeError < StandardError; end
+
       class NotConfiguredError < StandardError; end
 
       TYPES = %i[install prepare review format].freeze
@@ -21,9 +22,9 @@ module Reviewer
 
       def to_s
         to_a
-          .map(&:strip)
-          .join(' ')
-          .strip
+          .map(&:strip) # Remove extra spaces on the components
+          .join(' ')    # Merge the components
+          .strip        # Strip extra spaces from the end result
       end
 
       def to_a
@@ -44,17 +45,18 @@ module Reviewer
       end
 
       def flags
-        # :review commands are the only commands that use flags (except the :quiet_flag)
-        return nil unless review?
+        # :review commands are the only commands that use flags
+        # And if no flags are configured, this won't do much
+        # Flags for 'quiet' are handled separately by design and excluded from this check.
+        return nil unless review? && tool_settings.flags.any?
 
         Flags.new(tool_settings.flags).to_s
       end
 
       def verbosity
-        Verbosity.new(tool_settings.quiet_flag, level: verbosity_level).to_s
+        Verbosity.new(tool_settings.quiet_option, level: verbosity_level).to_s
       end
 
-
       private
 
       def review?

data/lib/reviewer/tool/env.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-# Assembles tool environment variables into a single string or array
 module Reviewer
   class Tool
+    # Assembles tool environment variables into a single string or array
     class Env
       attr_reader :env_pairs
 
@@ -20,7 +20,6 @@ module Reviewer
         env
       end
 
-
       private
 
       def env(key, value)

data/lib/reviewer/tool/flags.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-# Assembles tool flag settings into a single string or array
 module Reviewer
   class Tool
+    # Assembles tool flag settings into a single string or array
     class Flags
       attr_reader :flag_pairs
 
@@ -20,7 +20,6 @@ module Reviewer
         flags
       end
 
-
       private
 
       def flag(key, value)

data/lib/reviewer/tool/settings.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-# Converts/casts tool configuration values and provides default values if not set
 module Reviewer
   class Tool
+    # Converts/casts tool configuration values and provides default values if not set
     class Settings
       class MissingReviewCommandError < StandardError; end
 
@@ -14,17 +14,33 @@ module Reviewer
 
         # 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, "'#{name}' does not have a 'review' key under 'commands' in your tools configuration" unless commands.key?(:review)
+        raise MissingReviewCommandError, "'#{key}' does not have a 'review' key under 'commands' in `#{Reviewer.configuration.file}`" unless commands.key?(:review)
       end
 
       def disabled?
-        config.fetch(:disabled) { false }
+        config.fetch(:disabled, false)
       end
 
       def enabled?
         !disabled?
       end
 
+      def prepare_command?
+        commands.key?(:prepare) && commands[:prepare].present?
+      end
+
+      def install_command?
+        commands.key?(:install) && commands[:install].present?
+      end
+
+      def format_command?
+        commands.key?(:format) && commands[:format].present?
+      end
+
+      def install_link?
+        links.key?(:install) && links[:install].present?
+      end
+
       def key
         tool.to_sym
       end
@@ -58,11 +74,11 @@ module Reviewer
       end
 
       def max_exit_status
-        commands.fetch(:max_exit_status) { 0 }
+        commands.fetch(:max_exit_status, 0)
       end
 
-      def quiet_flag
-        commands.fetch(:quiet_flag) { '' }
+      def quiet_option
+        commands.fetch(:quiet_option, '')
       end
     end
   end

data/lib/reviewer/tool/verbosity.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-# Assembles tool settings and provided context for silencing output
 module Reviewer
   class Tool
+    # Assembles tool settings and provided context for silencing output
     class Verbosity
       class InvalidLevelError < StandardError; end
       # :total_silence = Use the quiet flag and send everything to dev/null.
@@ -11,20 +11,20 @@ module Reviewer
       # :tool_silence  = Just the quiet flag
       # :no_silence    = Let the output scroll for eternity
       LEVELS = %i[total_silence tool_silence no_silence].freeze
-      SEND_TO_DEV_NULL = "> /dev/null".freeze
+      SEND_TO_DEV_NULL = '> /dev/null'
 
       attr_reader :flag, :level
 
-      def initialize(flag, level: :total_silence)
+      def initialize(flag, level: :tool_silence)
         @flag = flag
 
-        raise InvalidLevelError, "Invalid Verbosity Level: '#{level}'"  unless LEVELS.include?(level)
+        raise InvalidLevelError, "Invalid Verbosity Level: '#{level}'" unless LEVELS.include?(level)
 
         @level = level
       end
 
       def to_s
-        to_a.join(' ').strip
+        to_a.map(&:strip).join(' ').strip
       end
 
       def to_a

data/lib/reviewer/tools.rb

@@ -1,18 +1,14 @@
 # frozen_string_literal: true
 
-# Provides a collection of the configured tools
 module Reviewer
+  # Provides a collection of the configured tools
   module Tools
     def self.all
-      []
-    end
-
-    def self.enabled
-      []
-    end
-
-    def self.disabled
-      []
+      tools = []
+      Reviewer.configuration.tools.each_key do |key|
+        tools << Tool.new(key)
+      end
+      tools
     end
   end
 end

data/lib/reviewer/version.rb

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

data/reviewer.gemspec

@@ -1,36 +1,38 @@
 # frozen_string_literal: true
 
-require_relative "lib/reviewer/version"
+require_relative 'lib/reviewer/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "reviewer"
+  spec.name          = 'reviewer'
   spec.version       = Reviewer::VERSION
-  spec.authors       = ["Garrett Dimon"]
-  spec.email         = ["email@garrettdimon.com"]
+  spec.authors       = ['Garrett Dimon']
+  spec.email         = ['email@garrettdimon.com']
 
-  spec.summary       = "Provides a unified approach to managing automated code quality tools."
-  spec.description   = "Provides a unified approach to managing automated code quality tools."
-  spec.homepage      = "https://github.com/garrettdimon/reviewer"
-  spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+  spec.summary       = 'Provides a unified approach to managing automated code quality tools.'
+  spec.description   = 'Provides a unified approach to managing automated code quality tools.'
+  spec.homepage      = 'https://github.com/garrettdimon/reviewer'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.7.3')
 
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/garrettdimon/reviewer"
-  spec.metadata["changelog_uri"] = "https://github.com/garrettdimon/reviewer/CHANGELOG.md"
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/garrettdimon/reviewer'
+  spec.metadata['changelog_uri'] = 'https://github.com/garrettdimon/reviewer/CHANGELOG.md'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  # Uncomment to register a new dependency of your gem
-  spec.add_dependency "activesupport"
-  spec.add_dependency "slop"
+  spec.add_dependency 'activesupport'
+  spec.add_dependency 'colorize'
+  spec.add_dependency 'slop'
 
-  # For more information and examples about making a new gem, checkout our
-  # guide at: https://bundler.io/guides/creating_gem.html
+  spec.add_development_dependency 'bundler-audit'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-minitest'
+  spec.add_development_dependency 'rubocop-rake'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: reviewer
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Garrett Dimon
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-04-18 00:00:00.000000000 Z
+date: 2021-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: slop
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +52,62 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler-audit
+  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
+    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-minitest
+  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-rake
+  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'
 description: Provides a unified approach to managing automated code quality tools.
 email:
 - email@garrettdimon.com
@@ -47,6 +117,10 @@ extra_rdoc_files: []
 files:
 - ".github/workflows/main.yml"
 - ".gitignore"
+- ".reviewer.example.yml"
+- ".reviewer.yml"
+- ".rubocop.yml"
+- ".ruby-version"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -55,12 +129,15 @@ files:
 - README.md
 - Rakefile
 - bin/console
-- bin/review
+- bin/fmt
+- bin/rvw
 - bin/setup
 - lib/reviewer.rb
 - lib/reviewer/arguments.rb
 - lib/reviewer/configuration.rb
 - lib/reviewer/loader.rb
+- lib/reviewer/logger.rb
+- lib/reviewer/runner.rb
 - lib/reviewer/tool.rb
 - lib/reviewer/tool/command.rb
 - lib/reviewer/tool/env.rb
@@ -85,14 +162,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.7.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.16
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Provides a unified approach to managing automated code quality tools.