reviewer 0.1.5 → 1.0.0

metadata

@@ -1,240 +1,171 @@
 --- !ruby/object:Gem::Specification
 name: reviewer
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 1.0.0
 platform: ruby
 authors:
 - Garrett Dimon
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-12-21 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rainbow
+  name: benchmark
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.5'
 - !ruby/object:Gem::Dependency
-  name: slop
+  name: pstore
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.2'
 - !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: codecov
-  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: flay
+  name: rainbow
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: '3.1'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.1'
 - !ruby/object:Gem::Dependency
-  name: flog
+  name: ruby-progressbar
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: '1.13'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.13'
 - !ruby/object:Gem::Dependency
-  name: inch
+  name: slop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: '4.10'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.10'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.27'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.27'
 - !ruby/object:Gem::Dependency
   name: minitest-heat
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
-  name: psych
+  name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '7.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '7.1'
 - !ruby/object:Gem::Dependency
-  name: reek
-  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
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.22'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.22'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: simplecov_json_formatter
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.9'
   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.
+        version: '0.9'
+description: Run tests, linters, security audits, and formatters with a single command.
+  Reviewer wraps your code quality tools into a consistent interface with git-aware
+  file targeting, auto-detection, and multiple output formats.
 email:
 - email@garrettdimon.com
 executables:
@@ -245,9 +176,12 @@ extra_rdoc_files: []
 files:
 - ".alexignore"
 - ".flayignore"
+- ".github/FUNDING.yml"
 - ".github/workflows/main.yml"
+- ".github/workflows/release.yml"
 - ".gitignore"
 - ".inch.yml"
+- ".reek.yml"
 - ".reviewer.example.yml"
 - ".reviewer.future.yml"
 - ".reviewer.yml"
@@ -259,9 +193,11 @@ files:
 - Gemfile.lock
 - LICENSE.txt
 - README.md
+- RELEASING.md
 - Rakefile
 - bin/console
 - bin/setup
+- dependency_decisions.yml
 - exe/fmt
 - exe/rvw
 - lib/reviewer.rb
@@ -270,30 +206,55 @@ files:
 - lib/reviewer/arguments/keywords.rb
 - lib/reviewer/arguments/tags.rb
 - lib/reviewer/batch.rb
+- lib/reviewer/batch/formatter.rb
+- lib/reviewer/capabilities.rb
 - lib/reviewer/command.rb
 - lib/reviewer/command/string.rb
 - lib/reviewer/command/string/env.rb
 - lib/reviewer/command/string/flags.rb
 - lib/reviewer/configuration.rb
-- lib/reviewer/conversions.rb
-- lib/reviewer/guidance.rb
+- lib/reviewer/configuration/loader.rb
+- lib/reviewer/context.rb
+- lib/reviewer/doctor.rb
+- lib/reviewer/doctor/config_check.rb
+- lib/reviewer/doctor/environment_check.rb
+- lib/reviewer/doctor/formatter.rb
+- lib/reviewer/doctor/keyword_check.rb
+- lib/reviewer/doctor/opportunity_check.rb
+- lib/reviewer/doctor/report.rb
+- lib/reviewer/doctor/tool_inventory.rb
 - lib/reviewer/history.rb
-- lib/reviewer/keywords.rb
-- lib/reviewer/keywords/git.rb
-- lib/reviewer/keywords/git/staged.rb
-- lib/reviewer/loader.rb
 - lib/reviewer/output.rb
+- lib/reviewer/output/formatting.rb
 - lib/reviewer/output/printer.rb
-- lib/reviewer/output/scrubber.rb
-- lib/reviewer/output/token.rb
+- lib/reviewer/prompt.rb
+- lib/reviewer/report.rb
+- lib/reviewer/report/formatter.rb
 - lib/reviewer/runner.rb
+- lib/reviewer/runner/failed_files.rb
+- lib/reviewer/runner/formatter.rb
+- lib/reviewer/runner/guidance.rb
+- lib/reviewer/runner/result.rb
 - lib/reviewer/runner/strategies/captured.rb
 - lib/reviewer/runner/strategies/passthrough.rb
+- lib/reviewer/session.rb
+- lib/reviewer/session/formatter.rb
+- lib/reviewer/setup.rb
+- lib/reviewer/setup/catalog.rb
+- lib/reviewer/setup/detector.rb
+- lib/reviewer/setup/formatter.rb
+- lib/reviewer/setup/gemfile_lock.rb
+- lib/reviewer/setup/generator.rb
+- lib/reviewer/setup/tool_block.rb
 - lib/reviewer/shell.rb
 - lib/reviewer/shell/result.rb
 - lib/reviewer/shell/timer.rb
 - lib/reviewer/tool.rb
+- lib/reviewer/tool/conversions.rb
+- lib/reviewer/tool/file_resolver.rb
 - lib/reviewer/tool/settings.rb
+- lib/reviewer/tool/test_file_mapper.rb
+- lib/reviewer/tool/timing.rb
 - lib/reviewer/tools.rb
 - lib/reviewer/version.rb
 - reviewer.gemspec
@@ -309,7 +270,6 @@ metadata:
   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:
 - lib
@@ -317,15 +277,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.9
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
-summary: Provides a unified approach to managing automated code quality tools.
+summary: Frictionless code quality. One command for all your review tools.
 test_files: []

data/lib/reviewer/conversions.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-module Reviewer
-  # Conversion functions for special types in Reviewer
-  module Conversions
-    def Tool(value) # rubocop:disable Naming/MethodName
-      case value
-      when Tool   then value
-      when Symbol then Tool.new(value)
-      when String then Tool.new(value.to_sym)
-      else raise TypeError, "Cannot convert #{value} to Tool"
-      end
-    end
-    module_function :Tool
-  end
-end

data/lib/reviewer/guidance.rb

@@ -1,77 +0,0 @@
-# frozen_string_literal: true
-
-require 'yaml/store'
-
-module Reviewer
-  # Handles the logic around what to display after a command has been run
-  class Guidance
-    attr_reader :command, :result, :output
-
-    # Create an instance of guidance for suggesting recovery steps after errors
-    # @param command: [Command] the command that was run and needs recovery guidance
-    # @param result: [Result] the result of the command
-    # @param output: Reviewer.output [Output] the output channel for displaying content
-    #
-    # @return [Guidance] the guidance class to suggest relevant recovery steps
-    def initialize(command:, result:, output: Reviewer.output)
-      @command = command
-      @result = result
-      @output = output
-    end
-
-    # Prints the relevant guidance based on the command and result context
-    #
-    # @return [void] prints the relevant guidance to the stream
-    def show
-      case result
-      when executable_not_found? then show_missing_executable_guidance
-      when cannot_execute?       then show_unrecoverable_guidance
-      else                            show_syntax_guidance
-      end
-    end
-
-    private
-
-    # Conditional check for when the command result was that the executable couldn't be found
-    #
-    # @return [Boolean] true if the result indicates the command couldn't be found
-    def executable_not_found?
-      ->(result) { result.executable_not_found? }
-    end
-
-    # Conditional check for when the command result was that it was unable to be executed
-    #
-    # @return [Boolean] true if the result indicates the command couldn't be executed
-    def cannot_execute?
-      ->(result) { result.cannot_execute? }
-    end
-
-    # Shows the recovery guidance for when a command is missing
-    #
-    # @return [void] prints missing executable guidance
-    def show_missing_executable_guidance
-      tool = command.tool
-      installation_command = Command.new(tool, :install).string if tool.installable?
-      install_link = tool.install_link
-
-      output.failure("Missing executable for '#{tool}'", command: command)
-      output.guidance('Try installing the tool:', installation_command)
-      output.guidance('Read the installation guidance:', install_link)
-    end
-
-    # Shows the recovery guidance for when a command generates an unrecoverable error
-    #
-    # @return [void] prints unrecoverable error guidance
-    def show_unrecoverable_guidance
-      output.unrecoverable(result.stderr)
-    end
-
-    # Shows suggestions for ignoring or disable rules when a command fails after reviewing code
-    #
-    # @return [void] prints syntax guidance
-    def show_syntax_guidance
-      output.guidance('Selectively Ignore a Rule:', command.tool.links[:ignore_syntax])
-      output.guidance('Fully Disable a Rule:', command.tool.links[:disable_syntax])
-    end
-  end
-end

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

@@ -1,64 +0,0 @@
-# frozen_string_literal: true
-
-module Reviewer
-  module Keywords
-    module Git
-      # Provides a convenient interface to get the list of staged files via Git
-      class Staged
-        OPTIONS = [
-          'diff',
-          '--staged',
-          '--name-only'
-        ].freeze
-
-        attr_reader :stdout, :stderr, :status, :exit_status
-
-        def to_a
-          stdout.strip.empty? ? [] : stdout.split("\n")
-        end
-
-        # Gets the list of staged files
-        #
-        # @example Get the list of files
-        #   staged.list #=> ['/Code/example.rb', '/Code/run.rb']
-        #
-        # @return [Array<String>] the array of staged filenames as strings
-        def list
-          @stdout, @stderr, @status = Open3.capture3(command)
-          @exit_status = @status.exitstatus.to_i
-
-          @status.success? ? to_a : raise_command_line_error
-        end
-
-        # Convenience method for retrieving the list of staged files since there's no parameters
-        #   for an initializer.
-        #
-        # @example Get the list of files
-        #   Reviewer::Keywords::Git::Staged.list #=> ['/Code/example.rb', '/Code/run.rb']
-        #
-        # @return [Array<String>] the array of staged filenames as strings
-        def self.list
-          new.list
-        end
-
-        # Assembles the pieces of the command that gets the list of staged files
-        #
-        # @return [String] the full command to run to retrieve the list of staged files
-        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

data/lib/reviewer/keywords/git.rb

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

data/lib/reviewer/keywords.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'keywords/git'
-
-module Keywords
-  # Grouping for individual commands
-  module Git
-  end
-end

data/lib/reviewer/loader.rb

@@ -1,59 +0,0 @@
-# frozen_string_literal: true
-
-require 'yaml'
-
-module Reviewer
-  # Provides a collection of the configured tools
-  class Loader
-    class MissingConfigurationError < StandardError; end
-
-    class InvalidConfigurationError < StandardError; end
-
-    class MissingReviewCommandError < StandardError; end
-
-    attr_reader :configuration, :file
-
-    def initialize(file = Reviewer.configuration.file)
-      @file = file
-      @configuration = 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 ||= Psych.safe_load_file(@file, symbolize_names: true)
-    rescue Errno::ENOENT
-      raise MissingConfigurationError, "Tools configuration file couldn't be found at `#{file}`"
-    rescue Psych::SyntaxError => e
-      raise InvalidConfigurationError, "Tools configuration file (#{file}) has a syntax error: #{e.message}"
-    end
-  end
-end