reviewer 0.1.3 → 0.1.4

data/lib/reviewer/arguments/keywords/git.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'git/staged'
-
-module Reviewer
-  class Arguments
-    class Keywords
-      module Git
-        BASE_COMMAND = [
-          'git',
-          '--no-pager'
-        ].freeze
-      end
-    end
-  end
-end

data/lib/reviewer/arguments/keywords/git/staged.rb

@@ -1,64 +0,0 @@
-# frozen_string_literal: true
-
-module Reviewer
-  class Arguments
-    class Keywords
-      module Git
-        # Provides a convenient interface to get the list of staged files
-        class Staged
-          OPTIONS = [
-            'diff',
-            '--staged',
-            '--name-only'
-          ].freeze
-
-          attr_reader :stdout, :stderr, :status, :exit_status
-
-          def to_a
-            stdout.present? ? stdout.split("\n") : []
-          end
-
-          def to_s
-            stdout.present? ? stdout : ''
-          end
-
-          def inspect
-            {
-              command: command,
-              stdout: stdout,
-              stderr: stderr,
-              status: status,
-              results: results
-            }
-          end
-
-          def list
-            @stdout, @stderr, @status = Open3.capture3(command)
-            @exit_status = @status.exitstatus.to_i
-
-            @status.success? ? to_a : raise_command_line_error
-          end
-
-          def self.list
-            new.list
-          end
-
-          def command
-            command_parts.join(' ')
-          end
-
-          private
-
-          def raise_command_line_error
-            message = "Git Error: #{stderr} (#{command})"
-            raise SystemCallError.new(message, exit_status)
-          end
-
-          def command_parts
-            BASE_COMMAND + OPTIONS
-          end
-        end
-      end
-    end
-  end
-end

data/lib/reviewer/logger.rb

@@ -1,62 +0,0 @@
-# frozen_string_literal: true
-
-require 'colorize'
-
-module Reviewer
-  # Clean formatter for logging to $stdout
-  class StandardOutFormatter < ::Logger::Formatter
-    # Overrides ::Logger::Formatter `call` to more present output more concisely
-    # @param _severity [Logger::Severity] Unused - Logger severity for etnry
-    # @param _time [DateTime] Unused - Timestamp for entry
-    # @param _progname [String] Unused - Name of the current program for entry
-    # @param message [String] The string to print to $stdout
-    #
-    # @return [type] [description]
-    def call(_severity, _time, _progname, message)
-      "#{message}\n"
-    end
-  end
-
-  # Logger for $stdout
-  class Logger < ::Logger
-    SUCCESS = 'Success'
-    FAILURE = 'Failure ·'
-    PROMPT  = '$'
-
-    def initialize(formatter = StandardOutFormatter.new)
-      super($stdout)
-      @formatter = formatter
-    end
-
-    def running(tool)
-      info "\n#{tool.name}".bold + ' · '.light_black + tool.description
-    end
-
-    def command(cmd)
-      info "\nReviewer ran this command:"
-      info cmd.to_s.light_black
-    end
-
-    def rerunning(tool, cmd)
-      info "\nRe-running #{tool.name} verbosely:"
-      info cmd.to_s.light_black
-    end
-
-    def success(elapsed_time)
-      info SUCCESS.green.bold + " (#{elapsed_time.round(3)}s)".green
-    end
-
-    def failure(message)
-      error "#{FAILURE} #{message}".red.bold
-    end
-
-    def total_time(elapsed_time)
-      info "\n➤ Total Time: #{elapsed_time.round(3)}s\n"
-    end
-
-    def guidance(summary, details)
-      info "\n#{summary}" if summary
-      info details.to_s.light_black if details
-    end
-  end
-end

data/lib/reviewer/tool/command.rb

@@ -1,80 +0,0 @@
-# frozen_string_literal: true
-
-module Reviewer
-  class Tool
-    # Assembles tool tool_settings into a usable command string
-    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) # Remove extra spaces on the components
-          .join(' ')    # Merge the components
-          .strip        # Strip extra spaces from the end result
-      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
-        # And if no flags are configured, this won't do much
-        # Flags for 'quiet' are handled separately by design and excluded from this check.
-        return nil unless review? && tool_settings.flags.any?
-
-        Flags.new(tool_settings.flags).to_s
-      end
-
-      def verbosity
-        Verbosity.new(tool_settings.quiet_option, 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

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-module Reviewer
-  class Tool
-    # Assembles tool environment variables into a single string or array
-    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

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-module Reviewer
-  class Tool
-    # Assembles tool flag settings into a single string or array
-    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/verbosity.rb

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-module Reviewer
-  class Tool
-    # Assembles tool settings and provided context for silencing output
-    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'
-
-      attr_reader :flag, :level
-
-      def initialize(flag, level: :tool_silence)
-        @flag = flag
-
-        raise InvalidLevelError, "Invalid Verbosity Level: '#{level}'" unless LEVELS.include?(level)
-
-        @level = level
-      end
-
-      def to_s
-        to_a.map(&:strip).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