reviewer 0.1.5 → 1.0.0

data/lib/reviewer/version.rb

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

data/lib/reviewer.rb

@@ -5,86 +5,82 @@ require 'forwardable'
 # require 'logger'
 require 'rainbow'
 
-require_relative 'reviewer/conversions'
+require_relative 'reviewer/configuration'
+require_relative 'reviewer/configuration/loader'
+require_relative 'reviewer/context'
+require_relative 'reviewer/history'
+require_relative 'reviewer/tool'
+require_relative 'reviewer/tools'
 
 require_relative 'reviewer/arguments'
 require_relative 'reviewer/batch'
+require_relative 'reviewer/capabilities'
 require_relative 'reviewer/command'
-require_relative 'reviewer/configuration'
-require_relative 'reviewer/guidance'
-require_relative 'reviewer/history'
-require_relative 'reviewer/keywords'
-require_relative 'reviewer/loader'
 require_relative 'reviewer/output'
+require_relative 'reviewer/prompt'
+require_relative 'reviewer/report'
 require_relative 'reviewer/runner'
+require_relative 'reviewer/session'
 require_relative 'reviewer/shell'
-require_relative 'reviewer/tool'
-require_relative 'reviewer/tools'
+require_relative 'reviewer/setup'
+require_relative 'reviewer/doctor'
 require_relative 'reviewer/version'
 
 # Primary interface for the reviewer tools
 module Reviewer
+  # Base error class for all Reviewer errors
   class Error < StandardError; end
 
   class << self
-    # Resets the loaded tools
-    def reset!
-      @tools = nil
-    end
+    # Resets the loaded tools and arguments
+    def reset! = @tools = @arguments = @prompt = @output = @history = @configuration = nil
 
     # 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.
-    # @param clear_screen [boolean] clears the screen to reduce noise when true
     #
     # @return [void] Prints output to the console
-    def review(clear_screen: false)
-      perform(:review, clear_screen: clear_screen)
+    def review
+      handle_early_exits { exit build_session.review }
     end
 
     # Runs the `format` command for the specified tools/files for which it is configured.
-    # @param clear_screen [boolean] clears the screen to reduce noise when true
     #
     # @return [void] Prints output to the console
-    def format(clear_screen: false)
-      perform(:format, clear_screen: clear_screen)
+    def format
+      handle_early_exits { exit build_session.format }
     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
+    def arguments = @arguments ||= Arguments.new
 
     # 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
+    def tools = @tools ||= Tools.new(arguments: arguments, history: history, config_file: configuration.file)
 
     # 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::Output] prints formatted output to the console.
-    def output
-      @output ||= Output.new
-    end
+    def output = @output ||= Output.new
 
     # A file store for sharing information across runs
     #
     # @return [Reviewer::History] a YAML::Store (or Pstore) containing data on tools
-    def history
-      @history ||= History.new
-    end
+    def history = @history ||= History.new(file: configuration.history_file)
+
+    # An interactive prompt for yes/no questions
+    #
+    # @return [Reviewer::Prompt] prompt instance wrapping stdin/stdout
+    def prompt = @prompt ||= Prompt.new
 
     # Exposes the configuration options for Reviewer.
     #
     # @return [Reviewer::Configuration] configuration settings instance
-    def configuration
-      @configuration ||= Configuration.new
-    end
+    def configuration = @configuration ||= Configuration.new
 
     # A block approach to configuring Reviewer.
     #
@@ -94,28 +90,91 @@ module Reviewer
     #   end
     #
     # @return [Reviewer::Configuration] Reviewer configuration settings
-    def configure
-      yield(configuration)
-    end
+    def configure = yield(configuration)
 
     private
 
-    # 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
-    # @param clear_screen [Boolean] if true, clears the screen before a run
-    #
-    # @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, clear_screen: false)
-      output.clear if clear_screen
+    def handle_early_exits
+      return show_help if arguments.help?
+      return show_version if arguments.version?
+      return Setup.run if subcommand?(:init)
+      return run_doctor if subcommand?(:doctor)
+      return run_capabilities if capabilities_flag?
+      return run_first_time_setup unless configuration.file.exist?
+
+      yield
+    end
 
-      results = Batch.new(command_type, tools.current).run
+    def subcommand?(name) = ARGV.first == name.to_s
+    def capabilities_flag? = ARGV.include?('--capabilities') || ARGV.include?('-c')
+
+    def show_help
+      output.help(help_text)
+    end
+
+    def help_text
+      <<~HELP
+        Usage: rvw [tool or tag ...] [keyword ...] [options]
+               fmt [tool or tag ...] [keyword ...] [options]
+
+        Commands:
+            rvw                          Run all enabled tools
+            rvw <tool>                   Run a single tool by its config key
+            rvw <tag>                    Run tools matching a tag
+            fmt                          Auto-fix with format commands
+            rvw init                     Generate .reviewer.yml from Gemfile.lock
+            rvw doctor                   Check configuration and tool health
+
+        Keywords:
+            staged                       Files staged for commit
+            unstaged                     Files with unstaged changes
+            modified                     All changed files (staged + unstaged)
+            untracked                    New files not yet tracked by git
+            failed                       Re-run only tools that failed last time
+
+        Options:
+        #{slop_options}
+
+        Examples:
+            rvw rubocop                  Run RuboCop only
+            rvw staged                   Review staged files across all tools
+            rvw -t security modified     Run security-tagged tools on changed files
+            rvw tests -f test/user_test.rb   Run tests on a specific file
+            rvw failed                   Re-run what failed last time
+            fmt rubocop                  Auto-fix with RuboCop
+      HELP
+    end
+
+    def slop_options
+      arguments.options.to_s.lines.drop(1).join.rstrip
+    end
+
+    def show_version
+      output.help(VERSION)
+    end
+
+    def run_capabilities
+      puts Capabilities.new(tools: tools).to_json
+    end
+
+    def run_doctor
+      report = Doctor.run(configuration: configuration, tools: tools)
+      Doctor::Formatter.new(output).print(report)
+    end
+
+    def run_first_time_setup
+      formatter = Setup::Formatter.new(output)
+      formatter.first_run_greeting
+      if prompt.yes?('Would you like to set it up now?')
+        Setup.run(configuration: configuration)
+      else
+        formatter.first_run_skip
+      end
+    end
 
-      # Return the largest exit status
-      exit results.values.max
+    def build_session
+      context = Context.new(arguments: arguments, output: output, history: history)
+      Session.new(context: context, tools: tools)
     end
   end
 end

data/reviewer.gemspec

@@ -8,11 +8,13 @@ Gem::Specification.new do |spec|
   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.summary       = 'Frictionless code quality. One command for all your review tools.'
+  spec.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.'
   spec.homepage      = 'https://github.com/garrettdimon/reviewer'
   spec.license       = 'MIT'
-  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.9')
+  spec.required_ruby_version = Gem::Requirement.new('>= 3.2')
 
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['bug_tracker_uri'] = 'https://github.com/garrettdimon/reviewer/issues'
@@ -31,21 +33,16 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'rainbow'
-  spec.add_dependency 'slop'
+  spec.add_dependency 'benchmark', '~> 0.5'
+  spec.add_dependency 'pstore', '~> 0.2'
+  spec.add_dependency 'rainbow', '~> 3.1'
+  spec.add_dependency 'ruby-progressbar', '~> 1.13'
+  spec.add_dependency 'slop', '~> 4.10'
 
-  spec.add_development_dependency 'bundler-audit'
-  spec.add_development_dependency 'codecov'
-  spec.add_development_dependency 'flay'
-  spec.add_development_dependency 'flog'
-  spec.add_development_dependency 'inch'
-  spec.add_development_dependency 'minitest'
-  spec.add_development_dependency 'minitest-heat'
-  spec.add_development_dependency 'psych'
-  spec.add_development_dependency 'reek'
-  spec.add_development_dependency 'rubocop'
-  spec.add_development_dependency 'rubocop-minitest'
-  spec.add_development_dependency 'rubocop-rake'
-  spec.add_development_dependency 'simplecov'
-  spec.add_development_dependency 'yard'
+  spec.add_development_dependency 'minitest', '~> 5.27'
+  spec.add_development_dependency 'minitest-heat', '~> 2.1'
+  spec.add_development_dependency 'rdoc', '~> 7.1'
+  spec.add_development_dependency 'simplecov', '~> 0.22'
+  spec.add_development_dependency 'simplecov_json_formatter', '~> 0.1'
+  spec.add_development_dependency 'yard', '~> 0.9'
 end