reviewer 0.1.1 → 0.1.5

data/Gemfile.lock

@@ -1,36 +1,119 @@
 PATH
   remote: .
   specs:
-    reviewer (0.1.1)
-      activesupport
+    reviewer (0.1.5)
+      rainbow
       slop
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.3.1)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 1.6, < 2)
-      minitest (>= 5.1)
-      tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
-    concurrent-ruby (1.1.8)
-    i18n (1.8.10)
-      concurrent-ruby (~> 1.0)
-    minitest (5.14.4)
-    rake (13.0.3)
-    slop (4.8.2)
-    tzinfo (2.0.4)
-      concurrent-ruby (~> 1.0)
-    zeitwerk (2.4.2)
+    ast (2.4.2)
+    bundler-audit (0.9.0.1)
+      bundler (>= 1.2.0, < 3)
+      thor (~> 1.0)
+    codecov (0.6.0)
+      simplecov (>= 0.15, < 0.22)
+    coderay (1.1.3)
+    docile (1.4.0)
+    erubis (2.7.0)
+    flay (2.12.1)
+      erubis (~> 2.7.0)
+      path_expander (~> 1.0)
+      ruby_parser (~> 3.0)
+      sexp_processor (~> 4.0)
+    flog (4.6.4)
+      path_expander (~> 1.0)
+      ruby_parser (~> 3.1, > 3.1.0)
+      sexp_processor (~> 4.8)
+    inch (0.8.0)
+      pry
+      sparkr (>= 0.2.0)
+      term-ansicolor
+      yard (~> 0.9.12)
+    kwalify (0.7.2)
+    method_source (1.0.0)
+    minitest (5.15.0)
+    minitest-heat (1.1.0)
+      minitest
+    parallel (1.21.0)
+    parser (3.0.3.2)
+      ast (~> 2.4.1)
+    path_expander (1.1.0)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    psych (4.0.3)
+      stringio
+    rainbow (3.0.0)
+    rake (13.0.6)
+    reek (6.0.6)
+      kwalify (~> 0.7.0)
+      parser (~> 3.0.0)
+      rainbow (>= 2.0, < 4.0)
+    regexp_parser (2.2.0)
+    rexml (3.2.5)
+    rubocop (1.23.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.12.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.15.0)
+      parser (>= 3.0.1.1)
+    rubocop-minitest (0.17.0)
+      rubocop (>= 0.90, < 2.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    ruby-progressbar (1.11.0)
+    ruby_parser (3.18.1)
+      sexp_processor (~> 4.16)
+    sexp_processor (4.16.0)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.3)
+    slop (4.9.1)
+    sparkr (0.4.1)
+    stringio (3.0.1)
+    sync (0.5.0)
+    term-ansicolor (1.7.1)
+      tins (~> 1.0)
+    thor (1.1.0)
+    tins (1.29.1)
+      sync
+    unicode-display_width (2.1.0)
+    webrick (1.7.0)
+    yard (0.9.27)
+      webrick (~> 1.7.0)
 
 PLATFORMS
-  x86_64-darwin-19
+  ruby
+  x86_64-darwin-20
+  x86_64-linux
 
 DEPENDENCIES
-  minitest (~> 5.0)
+  bundler-audit
+  codecov
+  flay
+  flog
+  inch
+  minitest
+  minitest-heat
+  psych
   rake (~> 13.0)
+  reek
   reviewer!
+  rubocop
+  rubocop-minitest
+  rubocop-rake
+  simplecov
+  yard
 
 BUNDLED WITH
-   2.2.16
+   2.2.33

data/LICENSE.txt

@@ -1,21 +1,5 @@
-The MIT License (MIT)
+Copyright (c) Garrett Dimon
 
-Copyright (c) 2021 Garrett Dimon
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+Reviewer is an Open Source project licensed under the terms of
+the LGPLv3 license. Please see <http://www.gnu.org/licenses/lgpl-3.0.html>
+for license text.

data/README.md

@@ -1,43 +1,37 @@
-# Reviewer
+# [Reviewer](https://github.com/garrettdimon/reviewer)
+by [Garrett Dimon](https://garrettdimon.com)
 
-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.
+---
 
-TODO: Delete this and the text above, and describe your gem
+**Note:** As of December 2021, Reviewer is a work in progress. While it's working great reviewing its own code, it's not quite ready for wider usage. Once, it's ready, it will provide more helpful installation and usage details.
 
-## Installation
+---
 
-Add this line to your application's Gemfile:
+*With Reviewer, you can seamlessly use multiple automated code review tools with orders of magnitude less friction so you can use them more frequently and consistently.*
 
-```ruby
-gem 'reviewer'
+So instead of remembering and typing...
+```bash
+$ 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 .
+```
+...you could just type...
+```
+$ rvw
 ```
 
-And then execute:
-
-    $ bundle install
-
-Or install it yourself as:
-
-    $ gem install reviewer
-
-## Usage
-
-TODO: Write usage instructions here
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
+That's just the tip of the iceberg, though. For the full story on Reviewer's capabilities and benefits, the [Overview](https://github.com/garrettdimon/reviewer/wiki/Overview) is the best place to start. Or if you'd like to see how it's configured under the hood, the [Configuration Instructions](https://github.com/garrettdimon/reviewer/wiki/Configuration) go even deeper.
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/reviewer. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/reviewer/blob/master/CODE_OF_CONDUCT.md).
+[![build](https://github.com/garrettdimon/reviewer/actions/workflows/main.yml/badge.svg?branch=main)](https://github.com/garrettdimon/reviewer/actions/workflows/main.yml)
+[![coverage](https://img.shields.io/codecov/c/github/garrettdimon/reviewer?token=UuXUlQAA2e)](https://codecov.io/gh/garrettdimon/reviewer)
+[![last commit](https://img.shields.io/github/last-commit/garrettdimon/reviewer/main)](https://github.com/garrettdimon/reviewer/commits/main)
+[![gem version](https://img.shields.io/gem/v/reviewer)](https://rubygems.org/gems/reviewer)
 
 ## License
-
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
 ## Code of Conduct
-
 Everyone interacting in the Reviewer project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/reviewer/blob/master/CODE_OF_CONDUCT.md).

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/exe/fmt

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

data/exe/rvw

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

data/lib/reviewer/arguments/files.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module Reviewer
+  class Arguments
+    # Generates a Ruby-friendly list (Array) of files to run the command against from the provided
+    # command line arguments
+    class Files
+      attr_reader :provided, :keywords
+
+      alias raw provided
+
+      # Generates an instance of files from the provided arguments
+      # @param provided: Reviewer.arguments.files.raw [Array, String] file arguments provided
+      #   directly via the -f or --files flag on the command line.
+      # @param keywords: Reviewer.arguments.keywords [Array, String] keywords that can potentially
+      #   be translated to a list of files (ex. 'staged')
+      #
+      # @example Using the `-f` flag: `rvw -f ./file.rb`
+      #   reviewer = Reviewer::Arguments::Files.new(provided: ['./file.rb'], keywords: [])
+      #   reviewer.to_a # => ['./file.rb']
+      # @example Using the `--files` flag: `rvw --files ./file.rb,./directory/file.rb
+      #   reviewer = Reviewer::Arguments::Files.new(provided: ['./file.rb','./directory/file.rb'], keywords: [])
+      #   reviewer.to_a # => ['./file.rb','./directory/file.rb']
+      #
+      # @return [self]
+      def initialize(provided: Reviewer.arguments.files.raw, keywords: Reviewer.arguments.keywords)
+        @provided = Array(provided)
+        @keywords = Array(keywords)
+      end
+
+      # Provides the full list of file/path values derived from the command-line arguments
+      #
+      # @return [Array<String>] full collection of the file arguments as a string
+      def to_a
+        file_list
+      end
+
+      # Provides the full list of file/path values derived from the command-line arguments
+      #
+      # @return [String] comma-separated string of the derived tag values
+      def to_s
+        to_a.join(',')
+      end
+
+      # Summary of the state of the file arguments
+      #
+      # @return [Hash<Symbol, Array<String>>] summarizes all of the resulting file values
+      def to_h
+        {
+          provided: provided.sort,
+          from_keywords: from_keywords
+        }
+      end
+      alias inspect to_h
+
+      private
+
+      # Combines the sorted list of unique files/paths by merging the explicitly-provided file
+      #   arguments as well as those that were translated from any relevant keyword arguments.
+      #
+      # @return [Array] full list of files/paths passed via command-line including those extracted
+      #   as a result of a keyword argument like `staged`
+      def file_list
+        @file_list ||= [
+          *provided,
+          *from_keywords
+        ].compact.sort.uniq
+      end
+
+      # Converts relevant keywords to the list of files they implicitly represent.
+      #
+      # @return [Array<String>] list of files/paths translated from any keyword arguments that
+      #   represent a list of files
+      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.compact.uniq
+      end
+
+      # If `staged` is passed as a keyword via the command-line, this will get the list of staged
+      #   files via Git
+      #
+      # @return [Array] list of the currently staged files
+      def staged
+        # Use git for list of staged fields
+        ::Reviewer::Keywords::Git::Staged.list
+      end
+    end
+  end
+end

data/lib/reviewer/arguments/keywords.rb

@@ -0,0 +1,133 @@
+# frozen_string_literal: true
+
+module Reviewer
+  class Arguments
+    # Handles interpreting all 'leftover' arguments and translating them to file-related,
+    # tag-related, or tool-related arguments
+    #
+    # @!attribute provided
+    #   @return [Array<String>] the keywords extracted from the command-line arguments
+    class Keywords
+      RESERVED = %w[staged].freeze
+
+      attr_accessor :provided
+
+      alias raw provided
+
+      # Generates an instance of parsed keywords from the provided arguments
+      # @param *provided [Array<String>] the leftover (non-flag) arguments from the command line
+      #
+      # @return [self]
+      def initialize(*provided)
+        @provided = Array(provided.flatten)
+      end
+
+      # Proves the full list of raw keyword arguments explicitly passed via command-line as an array
+      #
+      # @return [Array] full collection of the provided keyword arguments as a string
+      def to_a
+        provided
+      end
+
+      # Provides the full list of raw keyword arguments explicitly passed via command-line as a
+      #   comma-separated string
+      #
+      # @return [String] comma-separated list of the file arguments as a string
+      def to_s
+        to_a.join(',')
+      end
+
+      # Summary of the state of keyword arguments based on how Reviewer parsed them
+      #
+      # @return [Hash] represents the summary of the keyword values parsed from the command-line and
+      #   grouped based on how they were parsed
+      def to_h
+        {
+          provided: provided,
+          recognized: recognized,
+          unrecognized: unrecognized,
+          reserved: reserved,
+          for_tags: for_tags,
+          for_tool_names: for_tool_names
+        }
+      end
+      alias inspect to_h
+
+      # 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
+        tools.enabled.map(&:tags).flatten.uniq.sort
+      end
+
+      # Provides the complete list of all configured tool names for enabled tools
+      #
+      # @return [Array<String>] all unique configured 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
+        tools.all.map { |tool| tool.key.to_s }
+      end
+
+      private
+
+      # Provides a collection of enabled Tools for convenient access
+      #
+      # @return [Array<Reviewer::Tool>] collection of all currently enabled tools
+      def tools
+        @tools ||= Reviewer.tools
+      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 & provided).uniq.sort
+      end
+    end
+  end
+end

data/lib/reviewer/arguments/tags.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Reviewer
+  class Arguments
+    # Handles the logic of translating tag arguments
+    class Tags
+      attr_accessor :provided, :keywords
+
+      alias raw provided
+
+      # Generates an instace of parsed tags from the provided arguments by merging tag arguments
+      #   that were provided via either flags or keywords
+      # @param provided: Reviewer.arguments.tags.raw [Array<String>] tag arguments provided
+      #   directly via the -t or --tags flag on the command line.
+      # @param keywords: Reviewer.arguments.keywords [Array, String] keywords that can potentially
+      #   be translated to a list of tags based on the tags used in the configuration file
+      #
+      # @example Using keywords: `rvw ruby` (assuming a 'ruby' tag is defined)
+      #   Reviewer::Arguments::Tags.new.to_a # => ['ruby']
+      # @example Using the `-t` flag: `rvw -t ruby`
+      #   Reviewer::Arguments::Tags.new.to_a # => ['ruby']
+      # @example Using the `--tags` flag: `rvw -t ruby,css`
+      #   Reviewer::Arguments::Tags.new.to_a # => ['css', 'ruby']
+      #
+      # @return [self]
+      def initialize(provided: Reviewer.arguments.tags.raw, keywords: Reviewer.arguments.keywords.for_tags)
+        @provided = Array(provided)
+        @keywords = Array(keywords)
+      end
+
+      # Provides the full list of tags values derived from the command-line arguments
+      #
+      # @return [Array<String>] full collection of the tag arguments as a string
+      def to_a
+        tag_list
+      end
+
+      # Provides the full list of tag values derived from the command-line arguments
+      #
+      # @return [String] comma-separated string of the derived tag values
+      def to_s
+        to_a.join(',')
+      end
+
+      # Summary of the state of the tag arguments
+      #
+      # @return [Hash] represents the summary of the tag values parsed from the command-line
+      def to_h
+        {
+          provided: provided.sort,
+          from_keywords: keywords.sort
+        }
+      end
+      alias inspect to_h
+
+      private
+
+      # Combines the sorted list of unique tags by merging the explicitly-provided tag arguments
+      #   as well as those that were recognized from any relevant keyword arguments.
+      #
+      # @return [Array] full list of tags passed via command-line including those matching keyword
+      #   arguments
+      def tag_list
+        @tag_list ||= [
+          *provided,
+          *keywords
+        ].compact.sort.uniq
+      end
+    end
+  end
+end