lib/slim_lint/cli.rb in slim_lint-0.2.0 vs lib/slim_lint/cli.rb in slim_lint-0.3.0

@@ -1,24 +1,25 @@
+require 'slim_lint'
 require 'slim_lint/options'
 
 require 'sysexits'
 
 module SlimLint
   # Command line application interface.
   class CLI
-    attr_accessor :options
-
+    # Create a CLI that outputs to the specified logger.
+    #
     # @param logger [SlimLint::Logger]
     def initialize(logger)
       @log = logger
     end
 
     # Parses the given command-line arguments and executes appropriate logic
     # based on those arguments.
     #
     # @param args [Array<String>] command line arguments
-    # @return [Fixnum] exit status returned by the application
+    # @return [Integer] exit status code
     def run(args)
       options = SlimLint::Options.new.parse(args)
       act_on_options(options)
     rescue => ex
       handle_exception(ex)
@@ -26,10 +27,13 @@
 
     private
 
     attr_reader :log
 
+    # Given the provided options, execute the appropriate command.
+    #
+    # @return [Integer] exit status code
     def act_on_options(options)
       log.color_enabled = options.fetch(:color, log.tty?)
 
       if options[:help]
         print_help(options)
@@ -46,10 +50,12 @@
       else
         scan_for_lints(options)
       end
     end
 
+    # Outputs a message and returns an appropriate error code for the specified
+    # exception.
     def handle_exception(ex)
       case ex
       when SlimLint::Exceptions::ConfigurationError
         log.error ex.message
         Sysexits::EX_CONFIG
@@ -67,52 +73,63 @@
         print_unexpected_exception(ex)
         Sysexits::EX_SOFTWARE
       end
     end
 
+    # Scans the files specified by the given options for lints.
+    #
+    # @return [Integer] exit status code
     def scan_for_lints(options)
       report = Runner.new.run(options)
       print_report(report, options)
       report.failed? ? Sysexits::EX_DATAERR : Sysexits::EX_OK
     end
 
+    # Outputs a report of the linter run using the specified reporter.
     def print_report(report, options)
-      reporter = options.fetch(:reporter, Reporter::DefaultReporter).new(log, report)
-      reporter.report_lints
+      reporter = options.fetch(:reporter,
+                               SlimLint::Reporter::DefaultReporter).new(log)
+      reporter.display_report(report)
     end
 
+    # Outputs a list of all currently available linters.
     def print_available_linters
       log.info 'Available linters:'
 
-      linter_names = LinterRegistry.linters.map do |linter|
+      linter_names = SlimLint::LinterRegistry.linters.map do |linter|
         linter.name.split('::').last
       end
 
       linter_names.sort.each do |linter_name|
         log.log " - #{linter_name}"
       end
     end
 
+    # Outputs a list of currently available reporters.
     def print_available_reporters
       log.info 'Available reporters:'
 
-      reporter_names = Reporter.descendants.map do |reporter|
+      reporter_names = SlimLint::Reporter.descendants.map do |reporter|
         reporter.name.split('::').last.sub(/Reporter$/, '').downcase
       end
 
       reporter_names.sort.each do |reporter_name|
         log.log " - #{reporter_name}"
       end
     end
 
+    # Outputs help documentation.
     def print_help(options)
       log.log options[:help]
     end
 
+    # Outputs the application name and version.
     def print_version
-      log.log "#{APP_NAME} #{SlimLint::VERSION}"
+      log.log "#{SlimLint::APP_NAME} #{SlimLint::VERSION}"
     end
 
+    # Outputs the backtrace of an exception with instructions on how to report
+    # the issue.
     def print_unexpected_exception(ex)
       log.bold_error ex.message
       log.error ex.backtrace.join("\n")
       log.warning 'Report this bug at ', false
       log.info SlimLint::BUG_REPORT_URL