reviewer 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df101aff2f6774a051ec434d758d2a1b9f81366a5c6747ba524dfb711ada5d46
-  data.tar.gz: 76646cdd12c3ee0c280cbf1dec32745555a18f4a892fc8f10322f6795cf9a22b
+  metadata.gz: a5df0f3247eb105862f40b5092bb3c3b25fa20e87e155cb283fc2fd278933987
+  data.tar.gz: 06716646a5f980c5d67f89abc4ab4938977c2dd2691101d8cdd924f4481599cf
 SHA512:
-  metadata.gz: 28dbb56742a1ddee23e17ff5792bf66bd53cb38d9ebf8e3d00c9a343b92ee6ace22ff19568e123bc01e865d16126dbf4004d12826c0e3b28754a7541e909c3d1
-  data.tar.gz: b4ee814b4c07a1501000193ba593ca5a5ee06d41954b7bb397174947da26b01c22a45edc56482229b325ff7396ec29ce9c9e8759edf4caaa5dca0405ce16e959
+  metadata.gz: 57ca3df253ec35a5544f9a2145733c535688f8be8f0ed6820973563f758563e08a6f3aa729e8743be49945d931cc63a27a21a75e4512d2f9855f1ecad055a9ac
+  data.tar.gz: 5b06953f74f63aff8410b27470a37044d764b87b07289554d0ddc3581575d8a6849603a78f656d392273ac6e4d3d358acd91a84cae49a7d49fd427800536d5cb

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 ## [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
+
+## [0.1.1] - 2021-04-17
+
+It doesn't work just yet, but it's filling out. Primarily, this enables it to parse the configuration file and turn each tool's settings into a runnable command string for install, prepare, review, and format.
+
+- Added Configuration Management
+- Added command-line framework with option parsing
+- Created configuration loading bits
+- Built pieces to generate complete command strings
+
 ## [0.1.0] - 2021-04-16
 
 - Initial release

data/Gemfile.lock

@@ -0,0 +1,36 @@
+PATH
+  remote: .
+  specs:
+    reviewer (0.1.1)
+      activesupport
+      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)
+
+PLATFORMS
+  x86_64-darwin-19
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  rake (~> 13.0)
+  reviewer!
+
+BUNDLED WITH
+   2.2.16

data/bin/review

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/reviewer'
+
+Reviewer.review

data/lib/reviewer.rb

@@ -1,8 +1,42 @@
 # frozen_string_literal: true
 
+require_relative "reviewer/arguments"
+require_relative "reviewer/configuration"
+require_relative "reviewer/loader"
+require_relative "reviewer/tool"
+require_relative "reviewer/tools"
 require_relative "reviewer/version"
 
 module Reviewer
   class Error < StandardError; end
-  # Your code goes here...
+
+  class << self
+    attr_writer :configuration
+  end
+
+  def self.review
+    options = Arguments.new
+    # TODO: Make it actually run the tools.
+    puts "Running with the following options:"
+    pp options
+  end
+
+  def self.format
+    options = Arguments.new
+    # TODO: Make it actually run the tools.
+    puts "Running with the following options:"
+    pp options
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.reset
+    @configuration = Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
 end

data/lib/reviewer/arguments.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'slop'
+
+# Handles option parsing for bin/review
+module Reviewer
+  class Arguments
+    attr_accessor :options
+
+    def initialize(options = ARGV)
+      @options = Slop.parse options do |opts|
+        opts.array '-f', '--files', 'a list of comma-separated files or paths', delimiter: ',', default: []
+        opts.array '-t', '--tags', 'a list of comma-separated tags', delimiter: ',', default: []
+
+        opts.on '-v', '--version', 'print the version' do
+          puts VERSION
+          exit
+        end
+
+        opts.on '-h', '--help', 'print the help' do
+          puts opts
+          exit
+        end
+      end
+    end
+
+    def files
+      options[:files]
+    end
+
+    def tags
+      options[:tags]
+    end
+
+    def arguments
+      options.arguments
+    end
+
+    def keywords
+      # TODO: Filter arguments to only for allowed keywords to be defined later.
+      arguments
+    end
+  end
+end

data/lib/reviewer/configuration.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Reviewer
+  class Configuration
+    DEFAULT_CONFIGURATION_PATH = Dir.pwd.freeze
+    DEFAULT_CONFIGURATION_FILE = '.reviewer.yml'.freeze
+
+    attr_accessor :file
+
+    def initialize
+      @file = "#{DEFAULT_CONFIGURATION_PATH}/#{DEFAULT_CONFIGURATION_FILE}"
+    end
+
+    def tools
+      @tools ||= Loader.new.to_h
+    end
+  end
+end

data/lib/reviewer/loader.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require "yaml"
+require "active_support/core_ext/hash/indifferent_access"
+
+# Provides a collection of the configured tools
+module Reviewer
+  class Loader
+    class MissingConfigurationError < StandardError; end
+    class InvalidConfigurationError < StandardError; end
+
+    attr_reader :configuration
+
+    def initialize
+      @configuration = HashWithIndifferentAccess.new(configuration_hash)
+    end
+
+    def to_h
+      configuration
+    end
+
+    private
+
+    def configuration_hash
+      @configuration_hash ||= YAML.load_file(Reviewer.configuration.file)
+    rescue Errno::ENOENT
+      raise MissingConfigurationError, "Tools configuration file couldn't be found - #{Reviewer.configuration.file}"
+    rescue Psych::SyntaxError => e
+      raise InvalidConfigurationError, "Tools configuration file has a syntax error - #{e.message}"
+    end
+  end
+end

data/lib/reviewer/tool.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require "active_support/core_ext/string"
+require_relative "tool/command"
+require_relative "tool/env"
+require_relative "tool/flags"
+require_relative "tool/settings"
+require_relative "tool/verbosity"
+
+# Provides an instance of a specific tool
+module Reviewer
+  class Tool
+    attr_reader :settings
+
+    def initialize(tool)
+      @settings = Settings.new(tool)
+    end
+
+    def installation_command(verbosity_level = :no_silence)
+      command_string(:install, verbosity_level: verbosity_level)
+    end
+
+    def preparation_command(verbosity_level = :no_silence)
+       command_string(:prepare, verbosity_level: verbosity_level)
+    end
+
+    def review_command(verbosity_level = :total_silence)
+      command_string(:review, verbosity_level: verbosity_level)
+    end
+
+    def format_command(verbosity_level = :no_silence)
+      command_string(:format, verbosity_level: verbosity_level)
+    end
+
+
+    private
+
+    def command_string(command_type, verbosity_level: :no_silence)
+      cmd = Command.new(command_type, tool_settings: settings, verbosity_level: verbosity_level)
+
+      cmd.to_s
+    end
+  end
+end

data/lib/reviewer/tool/command.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+# Assembles tool tool_settings into a usable command string
+module Reviewer
+  class Tool
+    class Command
+      class InvalidTypeError < StandardError; end
+      class NotConfiguredError < StandardError; end
+
+      TYPES = %i[install prepare review format].freeze
+
+      attr_reader :command_type, :tool_settings, :verbosity_level
+
+      def initialize(command_type, tool_settings:, verbosity_level: nil)
+        @command_type = command_type
+        @tool_settings = tool_settings
+        @verbosity_level = verbosity_level
+
+        verify_command_type!
+      end
+
+      def to_s
+        to_a
+          .map(&:strip)
+          .join(' ')
+          .strip
+      end
+
+      def to_a
+        [
+          env,
+          body,
+          flags,
+          verbosity
+        ].compact
+      end
+
+      def env
+        Env.new(tool_settings.env).to_s
+      end
+
+      def body
+        tool_settings.commands.fetch(command_type)
+      end
+
+      def flags
+        # :review commands are the only commands that use flags (except the :quiet_flag)
+        return nil unless review?
+
+        Flags.new(tool_settings.flags).to_s
+      end
+
+      def verbosity
+        Verbosity.new(tool_settings.quiet_flag, level: verbosity_level).to_s
+      end
+
+
+      private
+
+      def review?
+        command_type == :review
+      end
+
+      def valid_command?
+        TYPES.include?(command_type)
+      end
+
+      def command_defined?
+        tool_settings.commands.key?(command_type)
+      end
+
+      def verify_command_type!
+        raise InvalidTypeError, "'#{body}' is not a supported command type. (Make sure it's not a typo.)" unless valid_command?
+        raise NotConfiguredError, "The '#{body}' command is not configured for #{tool_settings.name}.  (Make sure it's not a typo.)" unless command_defined?
+      end
+    end
+  end
+end

data/lib/reviewer/tool/env.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+# Assembles tool environment variables into a single string or array
+module Reviewer
+  class Tool
+    class Env
+      attr_reader :env_pairs
+
+      def initialize(env_pairs)
+        @env_pairs = env_pairs
+      end
+
+      def to_s
+        to_a.compact.join(' ')
+      end
+
+      def to_a
+        env = []
+        env_pairs.each { |key, value| env << env(key, value) }
+        env
+      end
+
+
+      private
+
+      def env(key, value)
+        return nil if key.to_s.blank? || value.to_s.blank?
+
+        value = needs_quotes?(value) ? "'#{value}'" : value
+
+        "#{key.to_s.strip.upcase}=#{value.to_s.strip};"
+      end
+
+      def needs_quotes?(value)
+        value.is_a?(String) && value.include?(' ')
+      end
+    end
+  end
+end

data/lib/reviewer/tool/flags.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+# Assembles tool flag settings into a single string or array
+module Reviewer
+  class Tool
+    class Flags
+      attr_reader :flag_pairs
+
+      def initialize(flag_pairs)
+        @flag_pairs = flag_pairs
+      end
+
+      def to_s
+        to_a.join(' ')
+      end
+
+      def to_a
+        flags = []
+        flag_pairs.each { |key, value| flags << flag(key, value) }
+        flags
+      end
+
+
+      private
+
+      def flag(key, value)
+        dash = key.to_s.size == 1 ? '-' : '--'
+
+        value = needs_quotes?(value) ? "'#{value}'" : value
+
+        "#{dash}#{key} #{value}".strip
+      end
+
+      def needs_quotes?(value)
+        value.is_a?(String) && value.include?(' ')
+      end
+    end
+  end
+end

data/lib/reviewer/tool/settings.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+# Converts/casts tool configuration values and provides default values if not set
+module Reviewer
+  class Tool
+    class Settings
+      class MissingReviewCommandError < StandardError; end
+
+      attr_reader :tool, :config
+
+      def initialize(tool, config: nil)
+        @tool = tool
+        @config = config || Reviewer.configuration.tools.fetch(tool.to_sym) { {} }
+
+        # Ideally, folks would fill out everything, but realistically, the 'review' command is the only required value.
+        # If the key is missing, or maybe there was a typo, fail right away.
+        raise MissingReviewCommandError, "'#{name}' does not have a 'review' key under 'commands' in your tools configuration" unless commands.key?(:review)
+      end
+
+      def disabled?
+        config.fetch(:disabled) { false }
+      end
+
+      def enabled?
+        !disabled?
+      end
+
+      def key
+        tool.to_sym
+      end
+
+      def name
+        config.fetch(:name) { tool.to_s.titleize }
+      end
+
+      def description
+        config.fetch(:description) { "(No description provided for '#{name}')" }
+      end
+
+      def tags
+        config.fetch(:tags) { [] }
+      end
+
+      def links
+        config.fetch(:links) { {} }
+      end
+
+      def env
+        config.fetch(:env) { {} }
+      end
+
+      def flags
+        config.fetch(:flags) { {} }
+      end
+
+      def commands
+        config.fetch(:commands) { {} }
+      end
+
+      def max_exit_status
+        commands.fetch(:max_exit_status) { 0 }
+      end
+
+      def quiet_flag
+        commands.fetch(:quiet_flag) { '' }
+      end
+    end
+  end
+end

data/lib/reviewer/tool/verbosity.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+# Assembles tool settings and provided context for silencing output
+module Reviewer
+  class Tool
+    class Verbosity
+      class InvalidLevelError < StandardError; end
+      # :total_silence = Use the quiet flag and send everything to dev/null.
+      #                  For some tools "quiet" means "less noisy" rather than truly silent.
+      #                  So in those cases, dev/null handles lingering noise.
+      # :tool_silence  = Just the quiet flag
+      # :no_silence    = Let the output scroll for eternity
+      LEVELS = %i[total_silence tool_silence no_silence].freeze
+      SEND_TO_DEV_NULL = "> /dev/null".freeze
+
+      attr_reader :flag, :level
+
+      def initialize(flag, level: :total_silence)
+        @flag = flag
+
+        raise InvalidLevelError, "Invalid Verbosity Level: '#{level}'"  unless LEVELS.include?(level)
+
+        @level = level
+      end
+
+      def to_s
+        to_a.join(' ').strip
+      end
+
+      def to_a
+        case level
+        when :total_silence then [flag, SEND_TO_DEV_NULL].compact
+        when :tool_silence  then [flag].compact
+        when :no_silence    then []
+        end
+      end
+    end
+  end
+end

data/lib/reviewer/tools.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+# Provides a collection of the configured tools
+module Reviewer
+  module Tools
+    def self.all
+      []
+    end
+
+    def self.enabled
+      []
+    end
+
+    def self.disabled
+      []
+    end
+  end
+end

data/lib/reviewer/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Reviewer
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/reviewer.gemspec

@@ -28,7 +28,8 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   # Uncomment to register a new dependency of your gem
-  # spec.add_dependency "example-gem", "~> 1.0"
+  spec.add_dependency "activesupport"
+  spec.add_dependency "slop"
 
   # For more information and examples about making a new gem, checkout our
   # guide at: https://bundler.io/guides/creating_gem.html

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: reviewer
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Garrett Dimon
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-04-16 00:00:00.000000000 Z
-dependencies: []
+date: 2021-04-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: slop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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
@@ -22,12 +50,24 @@ files:
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
+- bin/review
 - bin/setup
 - lib/reviewer.rb
+- lib/reviewer/arguments.rb
+- lib/reviewer/configuration.rb
+- lib/reviewer/loader.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
 homepage: https://github.com/garrettdimon/reviewer