maximus 0.1.4 → 0.1.5

data/lib/maximus/helper.rb

@@ -11,7 +11,6 @@ module Maximus
   module Helper
 
     # See if project linted is a Rails app
-    #
     # This will usually be stored as a class variable in the inherited class
     # @return [Boolean]
     def is_rails?
@@ -19,7 +18,6 @@ module Maximus
     end
 
     # Get root directory of file being called
-    #
     # @return [String] absolute path to root directory
     def root_dir
       is_rails? ? Rails.root.to_s : Dir.pwd.to_s
@@ -31,13 +29,9 @@ module Maximus
     # @param install_instructions [String] how to install the missing command
     # @return [void] aborts the action if command not found
     def node_module_exists(command, install_instructions = 'npm install -g')
-      cmd = `if hash #{command} 2>/dev/null; then
-        echo "true"
-      else
-        echo "false"
-      fi`
+      cmd = `if hash #{command} 2>/dev/null; then echo "true"; else echo "false"; fi`
       if cmd.include? "false"
-        command_msg = "Missing command #{command}".color(:red)
+        command_msg = "Missing command #{command}"
         abort "#{command_msg}: Please run `#{install_instructions} #{command}` And try again\n"
         exit 1
       end
@@ -49,11 +43,10 @@ module Maximus
     # @param file [String] filename with extension to search for
     # @return [String] path to default config file or file in user's directory
     def check_default_config_path(file)
-      File.exist?(file) ? file : File.join(File.dirname(__FILE__), "config/#{file}")
+      File.exist?(file) ? file : File.join(File.dirname(__FILE__), file)
     end
 
     # Grab the absolute path of the reporter file
-    #
     # @param filename [String]
     # @return [String] absolute path to the reporter file
     def reporter_path(filename)
@@ -82,16 +75,14 @@ module Maximus
     end
 
     # Convert string to boolean
-    #
     # @param str [String] the string to evaluate
     # @return [Boolean] whether or not the string is true
-    def truthy(str)
+    def truthy?(str)
       return true if str == true || str =~ (/^(true|t|yes|y|1)$/i)
       return false if str == false || str.blank? || str =~ (/^(false|f|no|n|0)$/i)
     end
 
     # Edit and save a YAML file
-    #
     # @param yaml_location [String] YAML absolute file path
     # @return [void]
     def edit_yaml(yaml_location, &block)
@@ -101,7 +92,6 @@ module Maximus
     end
 
     # Request user input
-    #
     # @param args [Array<String>] prompts to request
     # @return [String] user input to use elsewhere
     def prompt(*args)
@@ -115,17 +105,10 @@ module Maximus
     # @see Lint#relevant_lint
     #
     # @example typical output
-    #   lines_added = {'filename' => ['0..10', '11..14']}
+    #   lines_added = {changes: ['0..10', '11..14']}
     #   lines_added_to_range(lines_added)
     #   # output
-    #   {
-    #     'filename': {
-    #       {
-    #         [0,1,2,3,4,5,6,7,8,9,10],
-    #         [11,12,13,14]
-    #       }
-    #     }
-    #   }
+    #   [0,1,2,3,4,5,6,7,8,9,10, 11,12,13,14]
     #
     # @todo I'm sure there's a better way of doing this
     # @todo figure out a better place to put this than in Helper
@@ -136,10 +119,9 @@ module Maximus
     end
 
     # Ensure path exists
-    #
     # @param path [String, Array] path to files can be directory or glob
     # @return [Boolean]
-    def path_exists(path = @path)
+    def path_exists?(path = @path)
       path = path.split(' ') if path.is_a?(String) && path.include?(' ')
       if path.is_a?(Array)
         path.each do |p|

data/lib/maximus/lint.rb

@@ -20,7 +20,7 @@ module Maximus
     #     lint_data = JSON.parse(`some-command-line-linter`)
     #     @output[:files_inspected] ||= files_inspected(extension, delimiter, base_path_replacement)
     #     refine data_from_output
-    #  end
+    #   end
     #
     # Inherits settings from {Config#initialize}
     # @see Config#initialize
@@ -45,10 +45,10 @@ module Maximus
     end
 
     # Convert raw data into warnings, errors, conventions or refactors. Use this wisely.
-    #
     # @param data [Hash] unfiltered lint data
     # @return [Hash] refined lint data and all the other bells and whistles
     def refine(data)
+
       # Prevent abortive empty JSON.parse error
       data = '{}' if data.blank?
       return puts "Error from #{@task}: #{data}" if data.is_a?(String) && data.include?('No such')
@@ -60,48 +60,19 @@ module Maximus
         data = @output[:relevant_lints]
       end
 
-      lint_warnings = []
-      lint_errors = []
-      lint_conventions = []
-      lint_refactors = []
-      unless data.blank?
-        data.each do |filename, error_list|
-          error_list.each do |message|
-            # so that :raw_data remains unaffected
-            message = message.clone
-            message.delete('length')
-            message['filename'] = filename
-            if message['severity'] == 'warning'
-              message.delete('severity')
-              lint_warnings << message
-            elsif message['severity'] == 'error'
-              message.delete('severity')
-              lint_errors << message
-            elsif message['severity'] == 'convention'
-              message.delete('severity')
-              lint_conventions << message
-            elsif message['severity'] == 'refactor'
-              message.delete('severity')
-              lint_refactors << message
-            end
-          end
-        end
-      end
-      @output[:lint_errors] = lint_errors
-      @output[:lint_warnings] = lint_warnings
-      @output[:lint_conventions] = lint_conventions
-      @output[:lint_refactors] = lint_refactors
-      lint_count = (lint_errors.length + lint_warnings.length + lint_conventions.length + lint_refactors.length)
+      evaluate_severities(data)
+
+      lint_count = (@output[:lint_errors].length + @output[:lint_warnings].length + @output[:lint_conventions].length + @output[:lint_refactors].length)
+
+      puts lint_summarize
+
       if @config.is_dev?
         puts lint_dev_format(data) unless data.blank?
-        puts lint_summarize
         lint_ceiling lint_count
       else
-        @config.log.info lint_summarize
         # Because this should be returned in the format it was received
         @output[:raw_data] = data.to_json
       end
-      @config.destroy_temp(@task)
       @output
     end
 
@@ -109,7 +80,6 @@ module Maximus
     protected
 
       # List all files inspected
-      #
       # @param ext [String] extension to search for
       # @param delimiter [String] comma or space separated
       # @param remove [String] remove from all file names
@@ -119,7 +89,6 @@ module Maximus
       end
 
       # Compare lint output with lines changed in commit
-      #
       # @param lint [Hash] output lint data
       # @param files [Hash<String: String>] filename: filepath
       # @return [Array] lints that match the lines in commit
@@ -127,29 +96,25 @@ module Maximus
         all_files = {}
         files.each do |file|
 
-          # sometimes data will be blank but this is good - it means no errors raised in the lint
-          unless lint.blank?
-            lint_file = lint[file[:filename].to_s]
-
-            expanded = lines_added_to_range(file)
-            revert_name = file[:filename].gsub("#{@settings[:root_dir]}/", '')
-            unless lint_file.blank?
-              all_files[revert_name] = []
-
-              # @todo originally I tried .map and delete_if, but this works,
-              #   and the other method didn't cover all bases.
-              #   Gotta be a better way to write this though
-              lint_file.each do |l|
-                if expanded.include?(l['line'].to_i)
-                  all_files[revert_name] << l
-                end
+          # sometimes data will be blank but this is good - it means no errors were raised in the lint
+          next if lint.blank?
+          lint_file = lint[file[:filename].to_s]
+
+          expanded = lines_added_to_range(file)
+          revert_name = file[:filename].gsub("#{@settings[:root_dir]}/", '')
+          unless lint_file.blank?
+            all_files[revert_name] = []
+
+            # @todo originally I tried .map and delete_if, but this works,
+            #   and the other method didn't cover all bases.
+            #   Gotta be a better way to write this though
+            lint_file.each do |l|
+              if expanded.include?(l['line'].to_i)
+                all_files[revert_name] << l
               end
-              # If there's nothing there, then it definitely isn't a relevant lint
-              all_files.delete(revert_name) if all_files[revert_name].blank?
             end
-          else
-            # Optionally store the filename with a blank array
-            #   @example all_files[file[:filename].to_s.gsub("#{@settings[:root_dir]}/", '')] = []
+            # If there's nothing there, then it definitely isn't a relevant lint
+            all_files.delete(revert_name) if all_files[revert_name].blank?
           end
         end
         @output[:files_linted] = all_files.keys
@@ -157,7 +122,6 @@ module Maximus
       end
 
       # Look for a config defined from Config#initialize
-      #
       # @since 0.1.2
       # @param search_for [String]
       # @return [String, Boolean] path to temp file
@@ -166,58 +130,72 @@ module Maximus
         @settings[search_for.to_sym].blank? ? false : @settings[search_for.to_sym]
       end
 
+      # Add severities to @output
+      # @since 0.1.5
+      # @param data [Hash]
+      def evaluate_severities(data)
+        @output[:lint_warnings] = []
+        @output[:lint_errors] = []
+        @output[:lint_conventions] = []
+        @output[:lint_refactors] = []
+        return if data.blank?
+        data.each do |filename, error_list|
+          error_list.each do |message|
+            # so that :raw_data remains unaffected
+            message = message.clone
+            message.delete('length')
+            message['filename'] = filename.nil? ? '' : filename.gsub("#{@settings[:root_dir]}/", '')
+            severity = message['severity']
+            message.delete('severity')
+            @output["lint_#{severity}s".to_sym] << message
+          end
+        end
+        return @output
+      end
+
 
     private
 
       # Send abbreviated results to console or to the log
-      #
       # @return [String] console message to display
       def lint_summarize
-        puts "\n" if @config.is_dev?
-
-        puts "#{'Warning'.color(:red)}: #{@output[:lint_errors].length} errors found in #{@task.to_s}" if @output[:lint_errors].length > 0
+        puts "#{'Warning'.color(:red)}: #{@output[:lint_errors].length} errors found in #{@task}" unless @output[:lint_errors].length
 
         success = @task.to_s.color(:green)
         success += ": "
         success += "[#{@output[:lint_warnings].length}]".color(:yellow)
-        success += " " + "[#{@output[:lint_errors].length}]".color(:red)
+        success += " [#{@output[:lint_errors].length}]".color(:red)
         if @task == 'rubocop'
-          success += " " + "[#{@output[:lint_conventions].length}]".color(:cyan)
-          success += " " + "[#{@output[:lint_refactors].length}]".color(:white)
+          success += " [#{@output[:lint_conventions].length}]".color(:cyan)
+          success += " [#{@output[:lint_refactors].length}]".color(:white)
         end
 
         success
       end
 
       # If there's just too much to handle, through a warning.
-      #
       # @param lint_length [Integer] count of how many lints
       # @return [String] console message to display
       def lint_ceiling(lint_length)
-        if lint_length > 100
-          lint_dev_format
-          failed_task = "#{@task}".color(:green)
-          errors = Rainbow("#{lint_length} failures.").red
-          errormsg = ["You wouldn't stand a chance in Rome.\nResolve thy errors and train with #{failed_task} again.", "The gods frown upon you, mortal.\n#{failed_task}. Again.", "Do not embarrass the city. Fight another day. Use #{failed_task}.", "You are without honor. Replenish it with another #{failed_task}.", "You will never claim the throne with a performance like that.", "Pompeii has been lost.", "A wise choice. Do not be discouraged from another #{failed_task}."].sample
-          errormsg += "\n\n"
-
-          go_on = prompt "\n#{errors} Continue? (y/n) "
-          abort errormsg unless truthy(go_on)
-        end
+        return unless lint_length > 100
+        failed_task = @task.color(:green)
+        errors = "#{lint_length} failures.".color(:red)
+        errormsg = ["You wouldn't stand a chance in Rome.\nResolve thy errors and train with #{failed_task} again.", "The gods frown upon you, mortal.\n#{failed_task}. Again.", "Do not embarrass the city. Fight another day. Use #{failed_task}.", "You are without honor. Replenish it with another #{failed_task}.", "You will never claim the throne with a performance like that.", "Pompeii has been lost.", "A wise choice. Do not be discouraged from another #{failed_task}."].sample
+        errormsg += "\n\n"
+
+        go_on = prompt "\n#{errors} Continue? (y/n) "
+        abort errormsg unless truthy?(go_on)
       end
 
       # Dev display, executed only when called from command line
-      #
       # @param errors [Hash] data from lint
       # @return [String] console message to display
       def lint_dev_format(errors = @output[:raw_data])
         return if errors.blank?
         pretty_output = ''
         errors.each do |filename, error_list|
-          pretty_output += "\n"
           filename = filename.gsub("#{@settings[:root_dir]}/", '')
-          pretty_output += filename.color(:cyan).underline
-          pretty_output += "\n"
+          pretty_output += "\n#{filename.color(:cyan).underline} \n"
           error_list.each do |message|
             pretty_output += case message['severity']
               when 'warning' then 'W'.color(:yellow)
@@ -226,15 +204,13 @@ module Maximus
               when 'refactor' then 'R'.color(:white)
               else '?'.color(:blue)
             end
-            pretty_output += ' '
-            pretty_output += message['line'].to_s.color(:blue)
-            pretty_output += " #{message['linter'].color(:green)}: "
-            pretty_output += message['reason']
-            pretty_output += "\n"
+            pretty_output += " #{message['line'].to_s.color(:blue)} #{message['linter'].color(:green)}: #{message['reason']} \n"
           end
         end
         pretty_output
       end
 
+
+
   end
 end

data/lib/maximus/lints/brakeman.rb

@@ -3,19 +3,13 @@ module Maximus
   class Brakeman < Maximus::Lint
 
     # Brakeman (requires Rails)
-    #
     # @see Lint#initialize
     def result
 
-      return unless is_rails?
-
       @task = 'brakeman'
-
-      return unless temp_config(@task)
-
       @path = @settings[:root_dir] if @path.blank?
 
-      return unless path_exists(@path)
+      return unless is_rails? && temp_config(@task) && path_exists?(@path)
 
       tmp = Tempfile.new('brakeman')
       quietly { `brakeman #{@path} -f json -o #{tmp.path} -q` }
@@ -55,12 +49,11 @@ module Maximus
     private
 
       # Convert to {file:README.md Maximus format}
-      #
       # @param error [Hash] lint error
       # @return [Hash]
       def hash_for_brakeman(error, type)
         {
-          linter: error['warning_type'],
+          linter: error['warning_type'].delete(' '),
           severity: type.chomp('s'),
           reason: error['message'],
           column: 0,

data/lib/maximus/lints/jshint.rb

@@ -3,16 +3,12 @@ module Maximus
   class Jshint < Maximus::Lint
 
     # JSHint (requires node module)
-    #
     # @see Lint#initialize
     def result
       @task = 'jshint'
-
-      return unless temp_config(@task)
-
       @path = is_rails? ? "#{@settings[:root_dir]}/app/assets" : "#{@settings[:root_dir]}source/assets" if @path.blank?
 
-      return unless path_exists(@path)
+      return unless temp_config(@task) && path_exists?(@path)
 
       node_module_exists(@task)
 

data/lib/maximus/lints/railsbp.rb

@@ -3,19 +3,13 @@ module Maximus
   class Railsbp < Maximus::Lint
 
     # rails_best_practice (requires Rails)
-    #
     # @see Lint#initialize
     def result
 
-      return unless is_rails?
-
       @task = 'railsbp'
-
-      return unless temp_config(@task)
-
       @path = @settings[:root_dir] if @path.blank?
 
-      return unless path_exists(@path)
+      return unless is_rails? && temp_config(@task) && path_exists?(@path)
 
       tmp = Tempfile.new('railsbp')
       `rails_best_practices #{@path} -f json --output-file #{tmp.path}`
@@ -27,15 +21,13 @@ module Maximus
         rbj = JSON.parse(railsbp).group_by { |s| s['filename'] }
         railsbp = {}
         rbj.each do |file, errors|
-          if file
-            # This crazy gsub grapbs scrubs the absolute path from the filename
-            railsbp[file.gsub(Rails.root.to_s, '')[1..-1].to_sym] = errors.map { |o| hash_for_railsbp(o) }
-          end
+          next unless file
+
+          # This crazy gsub scrubs the absolute path from the filename
+          filename = file.gsub(Rails.root.to_s, '')[1..-1]
+          railsbp[filename] = errors.map { |o| hash_for_railsbp(o) }
+
         end
-        # The output of railsbp is a mix of strings and symbols
-        #   but resetting the JSON like this standardizes everything.
-        # @todo Better way to get around this?
-        railsbp = JSON.parse(railsbp.to_json)
       end
 
       @output[:files_inspected] ||= files_inspected('rb', ' ')
@@ -46,16 +38,15 @@ module Maximus
     private
 
       # Convert to {file:README.md Maximus format}
-      #
       # @param error [Hash] lint error
       # @return [Hash]
       def hash_for_railsbp(error)
         {
-          linter: error['message'].gsub(/\((.*)\)/, '').strip.parameterize('_').camelize,
-          severity: 'warning',
-          reason: error['message'],
-          column: 0,
-          line: error['line_number'].to_i
+          'linter' => error['message'].gsub(/\((.*)\)/, '').strip.parameterize('_').camelize,
+          'severity' => 'warning',
+          'reason' => error['message'],
+          'column' => 0,
+          'line' => error['line_number'].to_i
         }
       end