turboladen/tailor

View on GitHub
lib/tailor/cli.rb

Summary

Maintainability
A
0 mins
Test Coverage
require_relative 'configuration'
require_relative 'critic'
require_relative 'cli/options'
require_relative 'logger'
require_relative 'reporter'


class Tailor

  # The Command-Line Interface worker.  Execution from the command line
  # comes through here.
  class CLI
    include LogSwitch::Mixin

    # @return [Tailor::Configuration]
    attr_reader :configuration

    # The main method of execution from the command line.
    #
    # @param [Array] args Arguments from the command-line.
    def self.run(args)
      new(args).execute!
    end

    # @param [Array] args Arguments from the command-line.
    def initialize(args)
      options = Options.parse!(args)
      @configuration = Configuration.new(args, options)
      @configuration.load!

      if options.show_config
        @configuration.show
        exit
      end

      @critic = Critic.new
      @reporter = Reporter.new(@configuration.formatters)
    end

    # This checks all of the files detected during the configuration gathering
    # process, then hands results over to the {Tailor::Reporter} to be reported.
    #
    # @return [Boolean] +true+ if no problems were detected; false if there
    #   were.
    def execute!
      @critic.critique(@configuration.file_sets) do |problems_for_file, label|
        @reporter.file_report(problems_for_file, label)
      end

      @reporter.summary_report(@critic.problems,
        output_file: @configuration.output_file)

      @critic.problem_count(:error) > 0
    end

    # Critiques all file sets, then returns the problems found as a result.
    #
    # @return [Hash{String => Array}] The list of problems, where the keys are
    #   the file names in which the problems were found, and the values are the
    #   respective lists of problems for each file.
    def result
      @critic.critique(@configuration.file_sets)
      @critic.problems
    end
  end
end