reviewer 0.1.3 → 0.1.4

data/lib/reviewer/tool/settings.rb

@@ -2,20 +2,26 @@
 
 module Reviewer
   class Tool
-    # Converts/casts tool configuration values and provides default values if not set
+    # Converts/casts tool configuration values and provides default values if not set.
     class Settings
-      attr_reader :tool
+      attr_reader :tool_key, :config
 
-      def initialize(tool, config: nil)
-        @tool = tool
-        @config = config
+      alias key tool_key
+
+      def initialize(tool_key, config: nil)
+        @tool_key = tool_key.to_sym
+        @config = config || load_config
+      end
+
+      def hash
+        state.hash
       end
 
-      def ==(other)
+      def eql?(other)
         self.class == other.class &&
           state == other.state
       end
-      alias eql? ==
+      alias :== eql?
 
       def disabled?
         config.fetch(:disabled, false)
@@ -25,28 +31,8 @@ module Reviewer
         !disabled?
       end
 
-      def prepare_command?
-        commands.key?(:prepare) && commands[:prepare].present?
-      end
-
-      def install_command?
-        commands.key?(:install) && commands[:install].present?
-      end
-
-      def format_command?
-        commands.key?(:format) && commands[:format].present?
-      end
-
-      def install_link?
-        links.key?(:install) && links[:install].present?
-      end
-
-      def key
-        tool.to_sym
-      end
-
       def name
-        config.fetch(:name) { tool.to_s.titleize }
+        config.fetch(:name) { tool_key.to_s.capitalize }
       end
 
       def description
@@ -83,13 +69,13 @@ module Reviewer
 
       protected
 
-      def config
-        @config || Reviewer.tools.to_h.fetch(tool.to_sym) { {} }
-      end
-
       def state
         config.to_hash
       end
+
+      def load_config
+        Reviewer.tools.to_h.fetch(key) { {} }
+      end
     end
   end
 end

data/lib/reviewer/tools.rb

@@ -1,40 +1,75 @@
 # frozen_string_literal: true
 
 module Reviewer
-  # Provides convenient access to subsets of configured tools
+  # Provides convenient access to subsets of configured tools based on provided arguments,
+  # configured tools, their enabled/disabled status, and more.
   class Tools
+    include Enumerable
+
+    # Provides an instance to work with for knowing which tools to run in a given context.
+    # @param tags: nil [Array] the tags to use to filter tools for a run
+    # @param tool_names: nil [type] the explicitly provided tool names to filter tools for a run
+    #
+    # @return [Reviewer::Tools] collection of tools based on the current run context
     def initialize(tags: nil, tool_names: nil)
       @tags       = tags
       @tool_names = tool_names
     end
 
+    # The current state of all available configured tools regardless of whether they are disabled
+    #
+    # @return [Hash] hash representing all of the configured tools
     def to_h
       configured
     end
+    alias inspect to_h
 
+    # Provides a collection of all configured tools instantiated as Tool instances
+    #
+    # @return [Array<Tool>] the full collection of all Tool instances
     def all
       configured.keys.map { |tool_name| Tool.new(tool_name) }
     end
     alias to_a all
 
+    # Provides a collection of all enabled tools instantiated as Tool instances
+    #
+    # @return [Array<Tool>] the full collection of all enabled Tool instances
     def enabled
       @enabled ||= all.keep_if(&:enabled?)
     end
 
+    # Provides a collection of all explicitly-specified-via-command-line tools as Tool instances
+    #
+    # @return [Array<Tool>] the full collection of explicitly-specified tools for a run
     def specified
       all.keep_if { |tool| named?(tool) }
     end
 
+    # Provides a collection of all tagged-via-command-line tools as Tool instances
+    #
+    # @return [Array<Tool>] the full collection of tagged-via-command-line tools for a run
     def tagged
       enabled.keep_if { |tool| tagged?(tool) }
     end
 
+    # Uses the full context of a run to provide the filtered subset of tools to use. It takes into
+    # consideration: tagged tools, explicitly-specified tools, configuration (enabled/disabled), and
+    # any other relevant details that should influence whether a specific tool should be run as part
+    # of the current batch being executed.
+    #
+    # @return [Array<Tool>] the full collection of should-be-used-for-this-run tools
     def current
       subset? ? (specified + tagged).uniq : enabled
     end
 
     private
 
+    # Determines if the current run should include a subset of a tools or the full suite of enabled
+    # tools by determining if any tool names or tags were provided that would reduce the full set to
+    # only a subset of relevant tools.
+    #
+    # @return [Boolean] true if any tool names or tags are provided via the command line
     def subset?
       tool_names.any? || tags.any?
     end
@@ -48,11 +83,11 @@ module Reviewer
     end
 
     def tool_names
-      Array(@tool_names || Reviewer.arguments.tool_names)
+      Array(@tool_names || Reviewer.arguments.keywords.for_tool_names)
     end
 
     def tagged?(tool)
-      tool.enabled? && tags.intersection(tool.tags).any?
+      tool.enabled? && (tags & tool.tags).any?
     end
 
     def named?(tool)

data/lib/reviewer/version.rb

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

data/reviewer.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.description   = 'Provides a unified approach to managing automated code quality tools.'
   spec.homepage      = 'https://github.com/garrettdimon/reviewer'
   spec.license       = 'MIT'
-  spec.required_ruby_version = Gem::Requirement.new('>= 2.7.3')
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.9')
 
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = 'https://github.com/garrettdimon/reviewer'
@@ -27,13 +27,21 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'activesupport'
   spec.add_dependency 'colorize'
   spec.add_dependency 'slop'
 
   spec.add_development_dependency 'bundler-audit'
+  spec.add_development_dependency 'codecov'
+  spec.add_development_dependency 'dead_end'
+  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-color'
+  spec.add_development_dependency 'psych', '~> 3.3.2'
+  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'
 end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: reviewer
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Garrett Dimon
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-07-08 00:00:00.000000000 Z
+date: 2021-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: colorize
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: colorize
+  name: slop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,13 +39,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: slop
+  name: bundler-audit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -53,7 +53,49 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler-audit
+  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: dead_end
+  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
+  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: flog
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -80,6 +122,62 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: 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: minitest-color
+  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: psych
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.2
+- !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
@@ -122,6 +220,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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'
 description: Provides a unified approach to managing automated code quality tools.
 email:
 - email@garrettdimon.com
@@ -131,6 +243,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".flayignore"
 - ".github/workflows/main.yml"
 - ".gitignore"
 - ".inch.yml"
@@ -153,19 +266,32 @@ files:
 - lib/reviewer/arguments.rb
 - lib/reviewer/arguments/files.rb
 - lib/reviewer/arguments/keywords.rb
-- lib/reviewer/arguments/keywords/git.rb
-- lib/reviewer/arguments/keywords/git/staged.rb
 - lib/reviewer/arguments/tags.rb
+- lib/reviewer/batch.rb
+- lib/reviewer/command.rb
+- lib/reviewer/command/string.rb
+- lib/reviewer/command/string/env.rb
+- lib/reviewer/command/string/flags.rb
+- lib/reviewer/command/string/verbosity.rb
+- lib/reviewer/command/verbosity.rb
 - lib/reviewer/configuration.rb
+- lib/reviewer/conversions.rb
+- lib/reviewer/guidance.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/logger.rb
+- lib/reviewer/output.rb
+- lib/reviewer/printer.rb
 - lib/reviewer/runner.rb
+- lib/reviewer/runner/strategies/quiet.rb
+- lib/reviewer/runner/strategies/verbose.rb
+- lib/reviewer/shell.rb
+- lib/reviewer/shell/result.rb
+- lib/reviewer/shell/timer.rb
 - lib/reviewer/tool.rb
-- lib/reviewer/tool/command.rb
-- lib/reviewer/tool/env.rb
-- lib/reviewer/tool/flags.rb
 - lib/reviewer/tool/settings.rb
-- lib/reviewer/tool/verbosity.rb
 - lib/reviewer/tools.rb
 - lib/reviewer/version.rb
 - reviewer.gemspec
@@ -184,14 +310,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.3
+      version: 2.5.9
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubyforge_project:
+rubygems_version: 2.7.6.3
 signing_key:
 specification_version: 4
 summary: Provides a unified approach to managing automated code quality tools.