reviewer 0.1.1 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a5df0f3247eb105862f40b5092bb3c3b25fa20e87e155cb283fc2fd278933987
-  data.tar.gz: 06716646a5f980c5d67f89abc4ab4938977c2dd2691101d8cdd924f4481599cf
+  metadata.gz: 4269dc4784c9a22232bd47db41cff0bf7d57b023ee50dc5fc455a650fb138b2a
+  data.tar.gz: 73d9261188abd69db6aa23aa7db6f76a59696b1dac3e35eb1a5615e013b40354
 SHA512:
-  metadata.gz: 57ca3df253ec35a5544f9a2145733c535688f8be8f0ed6820973563f758563e08a6f3aa729e8743be49945d931cc63a27a21a75e4512d2f9855f1ecad055a9ac
-  data.tar.gz: 5b06953f74f63aff8410b27470a37044d764b87b07289554d0ddc3581575d8a6849603a78f656d392273ac6e4d3d358acd91a84cae49a7d49fd427800536d5cb
+  metadata.gz: 66894ea63a67d4964e93a5ab83ce92b95e0757d38af05a1587e136d0cc2d61fcf146d2c30534ce3f58aa4f08ed406e328ecad1293a617df73b2d1167c6146782
+  data.tar.gz: 0614f40cbd184e0e20aad58a8f4c320af3a5db358078cecdfac236047a0c85060b15b7dccbade7c599c4ebc030ea0eb4348d239fbbf3f25a48079f6f3a0464f7

data/.alexignore

@@ -0,0 +1 @@
+CODE_OF_CONDUCT.md

data/.flayignore

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

data/.github/workflows/main.yml

@@ -1,16 +1,26 @@
-name: Ruby
+name: Review
 
 on: [push,pull_request]
 
+env:
+  CI: true
+
 jobs:
   build:
+    strategy:
+      matrix:
+        ruby: [2.5.9, 2.6.9, 2.7.5, 3.0.3]
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v2
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 2.6.6
+        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/.inch.yml

@@ -0,0 +1,4 @@
+files:
+  # define files included in the analysis (defaults to ["{app,lib}/**/*.rb"])
+  included:
+    - lib/**/*.rb

data/.reviewer.example.yml

@@ -0,0 +1,63 @@
+# 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
+#  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.
+#    usage:                     // Optional. A link to the general usage instructions 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'
+#    review:                    // Required. The only truly required field because this is the whole point.
+#    format:                    // Optional. Command to auto-update rule violations when possible.
+#    serve:                     // Optional. Command to start a local server with reports generated by the tool.
+#    generate:                  // Optional. Command to generate artifacts from the tool for viewing separately.
+#    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.
+#  files:
+#    flag:                      // Optional, defaults to '' (empty string). The name of the flag used to pass subsets of files to the command.
+#    separator:                 // Optional, defaults to ' ' (single space). The character used to separate lists of files and directories.
+#  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.
+#    example_three:             //           - If the flag doesn't need or have a value, leaving it blank will translate it to a flag without a value.
+#  other:                       // Optional. A way to specify paramters that don't follow the standard flags conventions.
+#    description: value         //           - The key (ex. 'description') only serves as documentation and won't be used. Instead, the raw value will be applied
+
+
+# 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'
+    max_exit_status: 1
+  files:
+    flag: 'files'
+    separator: ','
+  env:
+    report: false
+  flags:
+    format: json
+    verbose:
+  other:
+    example: '--example | other'

data/.reviewer.future.yml

@@ -0,0 +1,221 @@
+# This represents the long-term vision for reviewer. It's a sort of documentation-driven design, but
+#  it's also heavily based on the initial exploration and iteration to determine what's possible and
+#  what's practical based on testing out a variety of command types and structures.
+
+# Options for `rvw` command
+# -c <file>, --config=<file>
+# -f <file>,<file>..., --files=<file>,<file>...
+# -t <tag>,<tag>..., --tags=<tag>,<tag>...
+# -l <tool_key>,<tool_key>..., --tools=<tool_key>,<tool_key>...
+# -c <command>, --command=<command>
+# -k, --keywords
+# -s, --settings
+# -h, --help
+# -v, --version
+# <keyword>
+
+# Implicit Keywords:
+# - every <tag>
+# - every <tool_key>
+#   - <tool_key>:settings
+#   - <tool_key>:links
+#   - every <tool_key>:<link>
+#   - <tool_key>:commands
+#   - every <tool_key>:<command>
+
+# Reserved Keywords:
+# - every link type
+# - every command type
+# - staged               // currently staged git files
+# - untracked            // currently untracked git files
+# - fresh                // untracked files updated in last 5 minutes
+#   - fresh_15           //                             ... 15 minutes
+#   - fresh_30           //                             ... 30 minutes
+#   - fresh_60           //                             ... 60 minutes
+# - stale                // untracked files updated more than 5 minutes ago
+#   - stale_15           //                               ... 15 minutes
+#   - stale_30           //                               ... 30 minutes
+#   - stale_60           //                               ... 60 minutes
+# - branch|diff          // All files created or updated on the current branch
+# - last_commit          // All files created or updated in the last commit
+# - current              // alias for branch or diff?
+
+# Command Examples:
+
+# The Basics
+# - rvw           // runs :review command for all enabled tools
+# - rvw <command> // runs <command> for all enabled tools (not disabled or solo)
+# - rvw <keyword> // runs :review command for all enabled tools and translates the <keyword>
+# - rvw <tag>     // runs :review command for all enabled tools tagged with <tag>
+
+# Tools
+# - rvw <tool_key>           // shortcut for `rvw <tool_key>:review`
+# - rvw <tool_key>:<command> // runs <command> for <tool_key> in passthrough mode
+# - rvw <tool_key>:<link>    // opens the <link> via `open <link>` if present, otherwise, shares that it's not configured
+# - rvw <tool_key>:settings  // displays all settings for <tool_key>
+# - rvw <tool_key>:commands  // displays all configured commands for <tool_key>
+# - rvw <tool_key>:links     // displays all configured links for <tool_key>
+
+# Combos
+# - rvw <keyword> <tag>                          // ex. `rvw staged ruby` -> `rvw review staged ruby`
+# - rvw <command> <tag>                          // ex. `rvw format ruby` -> `rvw format ruby`
+# - rvw <command> <reserved_keyword>             // ex. `rvw install ruby`
+# - rvw <command> <reserved_keyword> <tag>       // ex. `rvw format last_commit ruby`
+# - rvw <command> <reserved_keyword> <tag> <tag> // ex. `rvw format last_commit ruby erb`
+
+reviewer:
+  # Whether to run tools consecutively or in parallel if available
+  # :linear - It would suck if your first command is `bundle audit` and fails but 6 other tools
+  #   are running in parallel but will take time to fail. So :linear with :stop as the behavior
+  #   ensures you don't attepmt commands.
+  # :parallel - Reviewer will attempt to run commands on multiple threads/processors for more speed.
+  #   Best used when groups of commands are not dependent on each other.
+  default_batch_mode: <:linear|:safe, :parallel|:fast>
+
+  # Fallback failure behavior for all commands where it isn't explicitly defined. Applies to
+  #   linear runs independent of each other. So if you have two batches (ex. ruby, javascript), and
+  #   one batch fails immediately, the remaining commands willn ot be run. But the other batch will
+  #   safely continue independently.
+  # Optional. Defaults to :fast.
+  # :stop - Don't run any additional commands in that batch.
+  # :continue - Keep running the other commands.
+  default_command_failure_behavior_in_batch: <:stop, :continue>
+
+  # Fallback install behavior for all commands where it isn't explicitly defined.
+  # Maybe if the install command is present, `:auto` is implied?
+  # Optional. Defaults to :guidance.
+  # - :guidance shows the installation command and/or link for manual installation.
+  # - :auto attempts to automatically install if the command is missing
+  # - :skip quietly moves on without worrying about it
+  default_install_behavior: <:guidance, :auto, :skip>
+
+  # Fallback behavior for displaying results.
+  # Optional. Defaults to :full
+  # - :full - Re-run the command directly so you see the full output
+  # - :fast - Show the results, but potentially lose colorizing and some formatting
+  default_results_behavior: <:full, :fast, :timer>
+
+  # Fallback definition for determining whether a command is slow.
+  # Only used if :default_results_behavior is :timer
+  # Optional. Defaults to 10 seconds
+  default_slow_window: <integer seconds>
+
+  # Fallback defintion for determining whether a command needs to be prepped again.
+  # Optional. Defaults to 6 hours
+  default_prep_window: <integer hours>
+
+  # Primarily for debugging/improving performance of reviewer. But if low-level performance info is
+  #   interesting, it can be enabled.
+  # Optional. Defaults to :min
+  # :min - Shows simply the total time for each command. Breaks out install/prep % if relevant.
+  timer_detail: <:min, :max>
+
+# Custom-defined keywords for shortcuts
+keywords:
+  # Compact version
+  mgc:   'format last_commit ruby erb'
+  # Long-form version of `mgc` (a little more self-documenting and explicit)
+  magic: '--command=format --keywords=last_commit --tags=ruby,erb'
+  # Long-form of `mgc` (most self-documentating and explicit)
+  magic:
+    - '--command=format'
+    - '--keywords=last_commit'
+    - '--tags=ruby,erb'
+
+# The real core of the configuration for each individual tool.
+tools:
+  <tool_key>: # Required. ex. 'rubocop', 'bundler-audit', etc.
+    status: <:enabled, :disabled, :solo> # Optional. Tools are enabled by default
+    name: # Optional. Defaults to <tool_key> capitalized
+    description: # Optional. Remind folks of the specific task this tool performs.
+    tags: [one, two, three] # Optional. For running groups of commands.
+    batch: # Optional. Only used if run in batch mode. ex. Run ruby commands on one thread and yarn commands on another.
+    install_behavior: <:auto, :guidance> # Optional. Defaults to Reviewer default.
+    failure_behavior: <:continue, :fast, :informative> # Optional
+    links:
+      home:
+      repo:
+      support:
+      install:
+      usage:
+      options:
+      syntax:
+      ignore:
+      disable:
+    files_syntax:
+      flag:
+      separator:
+      quotes:
+    shared_options: # Optional. Used for all commands.
+      prefix: 'bundle exec'
+      stale: <hours>
+      base: '<command>'
+      quiet: '--quiet'
+      max_exit_status:
+      flags:
+        <flag>: '<value>'
+      env:
+        <env_var>: '<value>'
+      raw:
+        - '<value>'
+    commands:
+      install:
+        desc:
+        stale:
+        prefix:
+        base:
+        quiet:
+        max_exit_status:
+        flags:
+        env:
+        raw:
+      prepare:
+        desc:
+        stale:
+        prefix:
+        base:
+        quiet:
+        max_exit_status:
+        flags:
+        env:
+        raw:
+      review:
+        desc:
+        stale:
+        prefix:
+        base:
+        quiet:
+        max_exit_status:
+        flags:
+        env:
+        raw:
+      format:
+        desc:
+        stale:
+        prefix:
+        base:
+        quiet:
+        max_exit_status:
+        flags:
+        env:
+        raw:
+      serve:
+        desc:
+        stale:
+        prefix:
+        base:
+        quiet:
+        max_exit_status:
+        flags:
+        env:
+        raw:
+      generate:
+        desc:
+        stale:
+        prefix:
+        base:
+        quiet:
+        max_exit_status:
+        flags:
+        env:
+        raw:

data/.reviewer.yml

@@ -0,0 +1,140 @@
+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
+  commands:
+    install: 'bundle exec gem install bundler-audit'
+    prepare: 'bundle exec bundle-audit update'
+    review: 'bundle exec bundle-audit check --no-update'
+
+tests:
+  name: Minitest
+  description: Unit Tests & Coverage
+  tags: [ruby, tests, dev]
+  links:
+    home:
+  commands:
+    review: "bundle exec rake"
+  reports:
+    open_on_fail: true
+    local_file: coverage/index.html
+    local_uri: 'file:///Users/garrettdimon/Code/reviewer/coverage/index.html#_AllFiles'
+  env:
+    testopts: --seed=$SEED
+    # coverage: false
+
+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
+  description: Review Ruby Syntax & Formatting for Consistency
+  tags: [ruby, syntax]
+  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'
+  files:
+    flag: ''
+    separator: ' '
+  flags:
+    color:
+
+
+# The YARD Parser can also come in handy:
+#   https://yardoc.org/types
+inch:
+  disabled: true
+  tags: [docs, ruby, dev]
+  name: Inch
+  description: Review Ruby Documentation Quality
+  links:
+    home: https://rrrene.org/inch/
+    usage: https://www.rubydoc.info/gems/yard/file/docs/Tags.md
+  commands:
+    install: 'bundle exec gem install inch'
+    review: 'bundle exec inch'
+
+
+yard:
+  disabled: true
+  tags: [docs, ruby, dev]
+  name: Yard
+  description: Generates Documentation
+  links:
+    home: https://yardoc.org
+    usage: https://www.rubydoc.info/gems/yard/file/docs/GettingStarted.md#using
+    install: https://github.com/lsegal/yard#installing
+  commands:
+    install: 'bundle exec gem install yard'
+    prepare: "yard doc 'lib/**/*.rb'"
+    review: 'yard stats'
+    serve: 'yard server --reload && open http://0.0.0.0:8808'
+    generate:
+    quiet_flag: '--quiet'
+
+
+alex:
+  disabled: true
+  tags: [language, docs]
+  name: Yard
+  description: Generates Documentation
+  links:
+    home:
+    usage:
+    install:
+  commands:
+    install: 'yarn global add alex'
+    review: 'alex .'
+    quiet_flag: '--quiet'

data/.rubocop.yml

@@ -0,0 +1,20 @@
+AllCops:
+  TargetRubyVersion: 2.5
+  NewCops: enable
+  UseCache: true
+  CacheRootDirectory: './'
+  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/CHANGELOG.md

@@ -1,8 +1,43 @@
 ## [Unreleased]
 
-- TODO: Add Runner to handle timing, logging, and exit status
-- TODO: Add Targets to handle targeting specific files
-- TODO: Add support for Targets in Tool/Command generator
+- 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.
+
+- Commands are now `rvw` and `fmt`
+- Adds command-line arguments support
+- Adds support for specifying tags via the command-line
+- Adds support for specifying files via the command-line
+- Adds support for handling keywords via the command-line
+- Improved configuration and loading
+- Adds Tools class for more convenient filtering of tools based on arguments
+- Begins the process of adding documentation comments
+
+## [0.1.2] - 2021-05-04
+
+The bare minimum works now, but it's not quite there for day-to-day use. It works well enough that it's being used to review this project, but there's much more to do.
+
+- Add Runner to wrap individual commands
+- Add benchmark/timing to Runner
+- Extract Logging to a dedicated class
+- Intelligently handle non-zero exit statuses
 
 ## [0.1.1] - 2021-04-17
 

data/Gemfile

@@ -1,10 +1,8 @@
 # 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 "minitest", "~> 5.0"
+gem 'rake', '~> 13.0'