maximus 0.1.5.1 → 0.1.6.1

data/lib/maximus/helper.rb

@@ -17,6 +17,13 @@ module Maximus
       defined?(Rails)
     end
 
+    # See if project is a Middleman app
+    # @since 0.1.7
+    # @return [Boolean]
+    def is_middleman?
+      Gem::Specification::find_all_by_name('middleman').any?
+    end
+
     # Get root directory of file being called
     # @return [String] absolute path to root directory
     def root_dir
@@ -37,20 +44,11 @@ module Maximus
       end
     end
 
-    # Look for a file in the config directory
-    #
-    # @since 0.1.0
-    # @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__), 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)
-      File.join(File.dirname(__FILE__), "reporter/#{filename}")
+      File.join(File.dirname(__FILE__), 'reporter', filename)
     end
 
     # Find all files that were linted by extension
@@ -99,25 +97,6 @@ module Maximus
       STDIN.gets
     end
 
-    # Convert the array from lines_added into spelled-out ranges
-    # This is a GitControl helper but it's used in Lint
-    # @see GitControl#lines_added
-    # @see Lint#relevant_lint
-    #
-    # @example typical output
-    #   lines_added = {changes: ['0..10', '11..14']}
-    #   lines_added_to_range(lines_added)
-    #   # output
-    #   [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
-    # @return [Hash] changes_array of spelled-out arrays of integers
-    def lines_added_to_range(file)
-      changes_array = file[:changes].map { |ch| ch.split("..").map(&:to_i) }
-      changes_array.map { |e| (e[0]..e[1]).to_a }.flatten!
-    end
-
     # Ensure path exists
     # @param path [String, Array] path to files can be directory or glob
     # @return [Boolean]
@@ -131,6 +110,7 @@ module Maximus
           end
         end
       else
+        path = path.gsub('/**', '').gsub('/*', '').split('.')[0..1].first if path.include?('*')
         if File.exist?(path)
           return true
         else
@@ -140,5 +120,22 @@ module Maximus
       end
     end
 
+    # Default paths to check for lints and some stats
+    # @since 0.1.7
+    # @param root [String] base directory
+    # @param folder [String] nested folder to search for for Rails or Middleman
+    # @param extension [String] file glob type to search for if neither
+    # @return [String] path to desired files
+    def discover_path(root = @config.working_dir, folder = '', extension = '')
+      return @path unless @path.blank?
+      if is_rails?
+        File.join(root, 'app', 'assets', folder)
+      elsif is_middleman?
+        File.join(root, 'source', folder)
+      else
+        extension.blank? ? File.join(root) : File.join(root, '/**', "/*.#{extension}")
+      end
+    end
+
   end
 end

data/lib/maximus/lint.rb

@@ -1,4 +1,5 @@
 require 'json'
+require 'rainbow'
 
 module Maximus
 
@@ -48,27 +49,18 @@ module Maximus
     # @param data [Hash] unfiltered lint data
     # @return [Hash] refined lint data and all the other bells and whistles
     def refine(data)
+      @task ||= ''
 
-      # 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')
-
-      data = data.is_a?(String) ? JSON.parse(data) : data
-
-      @output[:relevant_lints] = relevant_lints( data, @git_files ) unless @git_files.blank?
-      unless @settings[:commit].blank?
-        data = @output[:relevant_lints]
-      end
+      data = parse_data(data)
+      return puts data if data.is_a?(String)
 
       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?
-        lint_ceiling lint_count
+        puts lint_dev_format(data)
+        lint_ceiling
       else
         # Because this should be returned in the format it was received
         @output[:raw_data] = data.to_json
@@ -84,7 +76,7 @@ module Maximus
       # @param delimiter [String] comma or space separated
       # @param remove [String] remove from all file names
       # @return all_files [Array<string>] list of file names
-      def files_inspected(ext, delimiter = ',', remove = @settings[:root_dir])
+      def files_inspected(ext, delimiter = ',', remove = @config.working_dir)
         @path.is_a?(Array) ? @path.split(delimiter) : file_list(@path, ext, remove)
       end
 
@@ -98,24 +90,26 @@ module Maximus
 
           # 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]
+          lint_file = lint[file[:filename]]
+
+          next if lint_file.blank?
 
           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
+          revert_name = strip_working_dir(file[:filename])
+
+          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
+
+          # 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
         @output[:files_linted] = all_files.keys
         all_files
@@ -138,36 +132,56 @@ module Maximus
         @output[:lint_errors] = []
         @output[:lint_conventions] = []
         @output[:lint_refactors] = []
+        @output[:lint_fatals] = []
+
         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['filename'] = filename.nil? ? '' : strip_working_dir(filename)
+            severity = "lint_#{message['severity']}s".to_sym
             message.delete('severity')
-            @output["lint_#{severity}s".to_sym] << message
+            @output[severity] << message if @output.key?(severity)
           end
         end
-        return @output
+        @output
       end
 
+      # Convert the array from lines_added into spelled-out ranges
+      # This is a GitControl helper but it's used in Lint
+      # @see GitControl#lines_added
+      # @see Lint#relevant_lint
+      #
+      # @example typical output
+      #   lines_added = {changes: ['0..10', '11..14']}
+      #   lines_added_to_range(lines_added)
+      #   # output
+      #   [0,1,2,3,4,5,6,7,8,9,10, 11,12,13,14]
+      #
+      # @return [Hash] changes_array of spelled-out arrays of integers
+      def lines_added_to_range(file)
+        changes_array = file[:changes].map { |ch| ch.split("..").map(&:to_i) }
+        changes_array.map { |e| (e[0]..e[1]).to_a }.flatten!
+      end
 
     private
 
       # Send abbreviated results to console or to the log
       # @return [String] console message to display
       def lint_summarize
-        puts "#{'Warning'.color(:red)}: #{@output[:lint_errors].length} errors found in #{@task}" unless @output[:lint_errors].length
+        puts "#{'Warning'.color(:red)}: #{@output[:lint_errors].length} errors found in #{@task}" if @output[:lint_errors].length > 0
 
-        success = @task.to_s.color(:green)
-        success += ": "
-        success += "[#{@output[:lint_warnings].length}]".color(:yellow)
-        success += " [#{@output[:lint_errors].length}]".color(:red)
+        success = @task.color(:green)
+        success << ": "
+        success << "[#{@output[:lint_warnings].length}]".color(:yellow)
+        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)
+          success << " [#{@output[:lint_fatals].length}]".color(:magenta)
         end
 
         success
@@ -176,12 +190,22 @@ module Maximus
       # 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)
+      def lint_ceiling
+        lint_length = (@output[:lint_errors].length + @output[:lint_warnings].length + @output[:lint_conventions].length + @output[:lint_refactors].length + @output[:lint_fatals].length)
+
         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"
+        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)
@@ -194,23 +218,48 @@ module Maximus
         return if errors.blank?
         pretty_output = ''
         errors.each do |filename, error_list|
-          filename = filename.gsub("#{@settings[:root_dir]}/", '')
-          pretty_output += "\n#{filename.color(:cyan).underline} \n"
+          filename = strip_working_dir(filename)
+          pretty_output << "\n#{filename.color(:cyan).underline} \n"
           error_list.each do |message|
-            pretty_output += case message['severity']
+            pretty_output << case message['severity']
               when 'warning' then 'W'.color(:yellow)
               when 'error' then 'E'.color(:red)
               when 'convention' then 'C'.color(:cyan)
               when 'refactor' then 'R'.color(:white)
+              when 'fatal' then 'F'.color(:magenta)
               else '?'.color(:blue)
             end
-            pretty_output += " #{message['line'].to_s.color(:blue)} #{message['linter'].color(:green)}: #{message['reason']} \n"
+            pretty_output << " #{message['line'].to_s.color(:blue)} #{message['linter'].color(:green)}: #{message['reason']} \n"
           end
         end
         pretty_output
       end
 
+      # String working directory
+      # @since 0.1.6
+      # @param path [String]
+      # @return [String]
+      def strip_working_dir(path)
+        path.gsub("#{@config.working_dir}/", '')
+      end
+
+      # Handle data and generate relevant_lints if appropriate
+      # @since 0.1.6
+      # @see #refine
+      # @param data [String, Hash]
+      # @return [String, Hash] String if error, Hash if success
+      def parse_data(data)
+        # Prevent abortive empty JSON.parse error
+        data = '{}' if data.blank?
+
+        return "Error from #{@task}: #{data}" if data.is_a?(String) && data.include?('No such')
 
+        data = JSON.parse(data) if data.is_a?(String)
+
+        @output[:relevant_lints] = relevant_lints( data, @git_files ) unless @git_files.blank?
+        data = @output[:relevant_lints] unless @settings[:commit].blank?
+        data
+      end
 
   end
 end

data/lib/maximus/lints/brakeman.rb

@@ -1,13 +1,13 @@
 module Maximus
+  # Evaluates quality of security on a Rails site
   # @since 0.1.0
   class Brakeman < Maximus::Lint
 
     # Brakeman (requires Rails)
     # @see Lint#initialize
     def result
-
       @task = 'brakeman'
-      @path = @settings[:root_dir] if @path.blank?
+      @path = discover_path
 
       return unless is_rails? && temp_config(@task) && path_exists?(@path)
 
@@ -19,26 +19,15 @@ module Maximus
 
       unless brakeman.blank?
         bjson = JSON.parse(brakeman)
-        @output[:ignored_warnings] = bjson['scan_info']['ignored_warnings']
-        @output[:checks_performed] = bjson['scan_info']['checks_performed']
-        @output[:number_of_controllers] = bjson['scan_info']['number_of_controllers']
-        @output[:number_of_models] = bjson['scan_info']['number_of_models']
-        @output[:number_of_templates] = bjson['scan_info']['number_of_templates']
-        @output[:ruby_version] = bjson['scan_info']['ruby_version']
-        @output[:rails_version] = bjson['scan_info']['rails_version']
+        basics(bjson)
         brakeman = {}
         ['warnings', 'errors'].each do |type|
           new_brakeman = bjson[type].group_by { |s| s['file'] }
           new_brakeman.each do |file, errors|
-            if file
-              brakeman[file.to_sym] = errors.map { |e| hash_for_brakeman(e, type) }
-            end
+            next unless file
+            brakeman[file] = errors.map { |e| hash_for_brakeman(e, type) }
           end
         end
-        # The output of brakeman is a mix of strings and symbols
-        #   but resetting the JSON like this standardizes everything.
-        # @todo Better way to get around this?
-        brakeman = JSON.parse(brakeman.to_json)
       end
 
       @output[:files_inspected] ||= files_inspected('rb', ' ')
@@ -53,14 +42,28 @@ module Maximus
       # @return [Hash]
       def hash_for_brakeman(error, type)
         {
-          linter: error['warning_type'].delete(' '),
-          severity: type.chomp('s'),
-          reason: error['message'],
-          column: 0,
-          line: error['line'].to_i,
-          confidence: error['confidence']
+          'linter' => error['warning_type'].delete(' '),
+          'severity' => type.chomp('s'),
+          'reason' => error['message'],
+          'column' => 0,
+          'line' => error['line'].to_i,
+          'confidence' => error['confidence']
         }
       end
 
+      # Pull out the general data brakeman provides
+      # @since 0.1.6
+      # @see #result
+      # @param brakeman_data [Hash]
+      def basics(brakeman_data)
+        @output[:ignored_warnings] = brakeman_data['scan_info']['ignored_warnings']
+        @output[:checks_performed] = brakeman_data['scan_info']['checks_performed']
+        @output[:number_of_controllers] = brakeman_data['scan_info']['number_of_controllers']
+        @output[:number_of_models] = brakeman_data['scan_info']['number_of_models']
+        @output[:number_of_templates] = brakeman_data['scan_info']['number_of_templates']
+        @output[:ruby_version] = brakeman_data['scan_info']['ruby_version']
+        @output[:rails_version] = brakeman_data['scan_info']['rails_version']
+      end
+
   end
 end

data/lib/maximus/lints/jshint.rb

@@ -1,4 +1,5 @@
 module Maximus
+  # Evaluates quality of JavaScript
   # @since 0.1.0
   class Jshint < Maximus::Lint
 
@@ -6,14 +7,14 @@ module Maximus
     # @see Lint#initialize
     def result
       @task = 'jshint'
-      @path = is_rails? ? "#{@settings[:root_dir]}/app/assets" : "#{@settings[:root_dir]}source/assets" if @path.blank?
+      @path = discover_path(@config.working_dir, 'javascripts', 'js')
 
       return unless temp_config(@task) && path_exists?(@path)
 
       node_module_exists(@task)
 
       jshint_cli = "jshint #{@path} --config=#{temp_config(@task)} --reporter=#{reporter_path('jshint.js')}"
-      jshint_cli += " --exclude-path=#{temp_config(@settings[:jshintignore])}" if @settings.has_key?(:jshintignore)
+      jshint_cli << " --exclude-path=#{temp_config(@settings[:jshintignore])}" if @settings.key?(:jshintignore)
       jshint = `#{jshint_cli}`
 
       @output[:files_inspected] ||= files_inspected('js')

data/lib/maximus/lints/railsbp.rb

@@ -1,13 +1,13 @@
 module Maximus
+  # Evaluates quality of Rails methods
   # @since 0.1.0
   class Railsbp < Maximus::Lint
 
     # rails_best_practice (requires Rails)
     # @see Lint#initialize
     def result
-
       @task = 'railsbp'
-      @path = @settings[:root_dir] if @path.blank?
+      @path = discover_path
 
       return unless is_rails? && temp_config(@task) && path_exists?(@path)
 

data/lib/maximus/lints/rubocop.rb

@@ -1,4 +1,5 @@
 module Maximus
+  # Evaluates quality of ruby
   # @since 0.1.0
   class Rubocop < Maximus::Lint
 
@@ -6,7 +7,7 @@ module Maximus
     # @see Lint#initialize
     def result
       @task = 'rubocop'
-      @path = is_rails? ? "#{@settings[:root_dir]}/app" : "#{@settings[:root_dir]}/*.rb" if @path.blank?
+      @path = discover_path
 
       return unless temp_config(@task) && path_exists?(@path)