reviewer 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 538f085294cbfbb5ce7c8412a39991534a2251b83978894133537f20e2bbf1ba
-  data.tar.gz: 39bee00497eccb91256b772f5af8a77746374648efd884c9ffb719f9fd7b1e16
+  metadata.gz: 9223e406b7f957249c7d39ba4c56e3fbdabe323e52b270af076de0a530b51b9f
+  data.tar.gz: afb2714ed785bd91b2fe3d3d7b6f75fa8826f9387609ba6eb21ed21960883e10
 SHA512:
-  metadata.gz: 872fbfb03db5c520c6b20d0eedf624ae37c9c9c2452b34bb286a4f9c52eddafe2846f5e401d702424e14dae9a153cefd6e3f8e8bf15a9a3e4c58e76940af64e9
-  data.tar.gz: 4bc2ae679b15339577014e404fb8340c436e0c7ae26f6f46ac2baaf94d14592c42610a343e6eba679928bdcb3d1c0698f0e75d68771f78fa4f1bef9f03ed8dfd
+  metadata.gz: 7f56b586b5bea303b4dab387ba4c66535caf2f1cdbc0d8ff3b2a8e092b54d0a3bc340ae864a0ae90729bb89a2925294c51c8bab9476cb2a34f886b429efb3694
+  data.tar.gz: 71da282037c2f26c339afe21ddb71ff0713ff7bf652bb0787f74df3b16bf12cd9aea86a7bf7625c0ee43d8d80e6d1e0ca03315e6cf9c1e8eee33cb6082415558

data/.flayignore

@@ -0,0 +1 @@
+./test/**/*.rb

data/.github/workflows/main.yml

@@ -4,13 +4,21 @@ on: [push,pull_request]
 
 jobs:
   build:
+    strategy:
+      matrix:
+        ruby: [2.5.9, 2.6.8, 2.7.4, 3.0.2]
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v2
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 2.7.3
+        ruby-version: ${{ matrix.ruby }}
         bundler-cache: true
-    - name: Run the default task
-      run: bundle exec rake
+    - name: Bundle Audit
+      run: bundle exec ./exe/rvw bundle_audit
+    - name: Test Review
+      run: bundle exec ./exe/rvw tests
+    - name: Multiple Command Review
+      run: bundle exec ./exe/rvw bundle_audit tests
+

data/.gitignore

@@ -6,3 +6,8 @@
 /pkg/
 /spec/reports/
 /tmp/
+/rubocop_cache/
+.reviewer_history.yml
+.reviewer_history_test.yml
+coverage
+Gemfile.lock

data/.reviewer.example.yml

@@ -1,4 +1,5 @@
 # Quick overview of the options configuration for command-line tools.
+# It can be handy to leave this section in your configuration file as a convenient reference.
 #
 # <command_key>:                // ex. 'rubocop', 'bundler-audit', etc.
 #  disabled: true               // Optional. Tools are enabled by default
@@ -8,7 +9,8 @@
 #  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.
+#    ignore_syntax:             // Optional. A link to the syntax for ignoring some rules for small sections of code.
+#    disable_syntax:            // Optional. A link to the syntax for disabling entire rules for a 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'
@@ -25,25 +27,27 @@
 #    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
+# In practice, a configuration block would look something like the block below.
+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
+    disable_syntax: https://example.com/disable
+  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
+    files_flag: 'files'
+    files_separator: ','
+   env:
+     report: false
+   flags:
+     format: json

data/.reviewer.yml

@@ -1,7 +1,7 @@
-bundler_audit:
-  tags: [critical, dependencies, ruby, dev]
-  name: Bundler Audit
+bundle_audit:
+  name: Bundle Audit
   description: Review Gem Dependencies for Security Issues
+  tags: [critical, dependencies, ruby, dev]
   links:
     home: https://github.com/rubysec/bundler-audit
     install: https://github.com/rubysec/bundler-audit#install
@@ -13,13 +13,65 @@ bundler_audit:
 
 tests:
   name: Minitest
-  description: Unit Tests
+  description: Unit Tests & Coverage
   tags: [ruby, tests, dev]
   links:
     home:
   commands:
     review: "bundle exec rake TESTOPTS='--seed=$SEED'"
     quiet_option: '--silent'
+  reports:
+    open_on_fail: true
+    local_file: coverage/index.html
+    local_uri: 'file:///Users/garrettdimon/Code/reviewer/coverage/index.html#_AllFiles'
+  env:
+    coverage: true
+
+reek:
+  name: Reek
+  description: Examine Ruby Classes for Code Smells
+  tags: [ruby, quality, dev]
+  links:
+    home: https://github.com/troessner/reek
+    install: https://github.com/troessner/reek#quickstart
+  commands:
+    install: 'bundle exec gem install reek'
+    review: 'bundle exec reek'
+  flags:
+    color:
+    documentation:
+
+flog:
+  disabled: true # Flog provides guidance and is generally run solo
+  name: Flog
+  description: Reports your most tortured ruby code in an easy to read pain report.
+  tags: [ruby, quality, dev]
+  links:
+    home: https://ruby.sadi.st/Flog.html
+    install: https://ruby.sadi.st/Flog.html
+  commands:
+    install: 'bundle exec gem install flog'
+    review: 'bundle exec flog -g lib'
+  flags:
+    threshold: 10 # Percentage. i.e. Show the most concerning 10% of results
+    group:
+    methods-only:
+
+flay:
+  disabled: true # Flay provides guidance and is generally run solo
+  name: Flay
+  description: Review ruby code for structural similarities and refactoring opportunities.
+  tags: [ruby, quality, dev]
+  links:
+    home: https://ruby.sadi.st/Flay.html
+    install: https://ruby.sadi.st/Flay.html
+  commands:
+    install: 'bundle exec gem install flay'
+    review: 'bundle exec flay ./lib'
+  flags:
+    liberal:
+    summary:
+
 
 rubocop:
   name: Rubocop
@@ -37,9 +89,10 @@ rubocop:
     quiet_option: '--format q'
     files_flag: ''
     files_list_separator: ' '
+  flags:
+    color:
 
 inch:
-  disabled: true # Inch provides guidance and is generally run solo
   tags: [docs, ruby, dev]
   name: Inch
   description: Review Ruby Documentation

data/.rubocop.yml

@@ -1,5 +1,7 @@
 AllCops:
   NewCops: enable
+  UseCache: true
+  CacheRootDirectory: './'
   Exclude:
     - 'bin/**/*'
 

data/.ruby-version

@@ -1 +1 @@
-2.7.3
+2.5.9

data/CHANGELOG.md

@@ -3,6 +3,20 @@
 - TODO: Improve and streamline installation
 - TODO: Add support for targeting specific files
 
+## [0.1.4] - 2021-07-08
+
+On the surface, this release doesn't change much or provide drastically new functionality, but it begins to lay the foundation for something that could evolve in the long-term.
+
+- Mostly refactoring to support the long-term vision
+- Add Reek to dev dependencies
+- Enable Inch in the default commands
+- Reduce external dependencies
+- Broaden official support Ruby 2.5.9, 2.6.8, 2.7.4, and 3.0.2
+- Add more robust GitHub Actions integration
+- Add Code Coverage via SimpleCov and set the bar at 100%
+- Begin to expand documentation coverage
+- Improve UX of results, timing, output, and error recovery guidance
+
 ## [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.

data/Gemfile

@@ -6,6 +6,3 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'rake', '~> 13.0'
-
-gem 'minitest', '~> 5.14.4'
-gem 'minitest-color', '~> 0.0.2'

data/Gemfile.lock

@@ -1,93 +1,118 @@
 PATH
   remote: .
   specs:
-    reviewer (0.1.3)
-      activesupport
+    reviewer (0.1.4)
       colorize
       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)
     ast (2.4.2)
     bundler-audit (0.8.0)
       bundler (>= 1.2.0, < 3)
       thor (~> 1.0)
+    codecov (0.5.2)
+      simplecov (>= 0.15, < 0.22)
     coderay (1.1.3)
     colorize (0.8.1)
-    concurrent-ruby (1.1.8)
-    i18n (1.8.10)
-      concurrent-ruby (~> 1.0)
+    dead_end (1.1.7)
+    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.14.4)
     minitest-color (0.0.2)
       minitest (~> 5)
     parallel (1.20.1)
-    parser (3.0.1.0)
+    parser (3.0.2.0)
       ast (~> 2.4.1)
+    path_expander (1.1.0)
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
+    psych (3.3.2)
     rainbow (3.0.0)
-    rake (13.0.3)
+    rake (13.0.6)
+    reek (6.0.5)
+      kwalify (~> 0.7.0)
+      parser (~> 3.0.0)
+      psych (>= 3.1, < 5.0)
+      rainbow (>= 2.0, < 4.0)
     regexp_parser (2.1.1)
     rexml (3.2.5)
-    rubocop (1.13.0)
+    rubocop (1.18.4)
       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)
+      rubocop-ast (>= 1.8.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-ast (1.8.0)
+      parser (>= 3.0.1.1)
+    rubocop-minitest (0.14.0)
       rubocop (>= 0.90, < 2.0)
-    rubocop-rake (0.5.1)
-      rubocop
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
     ruby-progressbar (1.11.0)
-    slop (4.8.2)
+    ruby_parser (3.16.0)
+      sexp_processor (~> 4.15, >= 4.15.1)
+    sexp_processor (4.15.3)
+    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)
     sync (0.5.0)
     term-ansicolor (1.7.1)
       tins (~> 1.0)
     thor (1.1.0)
-    tins (1.28.0)
+    tins (1.29.1)
       sync
-    tzinfo (2.0.4)
-      concurrent-ruby (~> 1.0)
     unicode-display_width (2.0.0)
     yard (0.9.26)
-    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
-  x86_64-darwin-19
+  x86_64-darwin-20
   x86_64-linux
 
 DEPENDENCIES
   bundler-audit
+  codecov
+  dead_end
+  flay
+  flog
   inch
-  minitest (~> 5.14.4)
-  minitest-color (~> 0.0.2)
+  minitest
+  minitest-color
+  psych (~> 3.3.2)
   rake (~> 13.0)
+  reek
   reviewer!
   rubocop
   rubocop-minitest
   rubocop-rake
+  simplecov
 
 BUNDLED WITH
-   2.2.16
+   2.2.25

data/README.md

@@ -1,58 +1,13 @@
-**Note:** As of May 4th, 2021, Reviewer is a work in progress and does not actually do anything just yet. Hopefully soon.
 
-# Reviewer
+**Note:** As of August 4th, 2021, Reviewer is a work in progress. While it's working great reviewing its own code, it's not quite ready for wider usage.
 
-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.
+[![Gem Version](https://badge.fury.io/rb/reviewer.svg)](https://badge.fury.io/rb/reviewer) [![Ruby](https://github.com/garrettdimon/reviewer/actions/workflows/main.yml/badge.svg?branch=main)](https://github.com/garrettdimon/reviewer/actions/workflows/main.yml) [![codecov](https://codecov.io/gh/garrettdimon/reviewer/branch/main/graph/badge.svg?token=UuXUlQAA2e)](https://codecov.io/gh/garrettdimon/reviewer)
 
-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
-```
+# What is Reviewer?
 
-You run...
-```
-rvw
-```
+*Reviewer reduces the friction of using multiple automated code review tools so you can use them more frequently and consistently.*
 
-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.
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'reviewer'
-```
-
-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
-
-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).
+For more detailed information, the [Wiki](https://github.com/garrettdimon/reviewer/wiki) is the best place to start. Or if you'd like the full story, you can go straight to the [Overview](https://github.com/garrettdimon/reviewer/wiki/Overview).
 
 ## License