maximus 0.1.3 → 0.1.4

data/lib/maximus/lints/brakeman.rb

@@ -54,20 +54,20 @@ 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'],
-        severity: type.chomp('s'),
-        reason: error['message'],
-        column: 0,
-        line: error['line'].to_i,
-        confidence: error['confidence']
-      }
-    end
+      # Convert to {file:README.md Maximus format}
+      #
+      # @param error [Hash] lint error
+      # @return [Hash]
+      def hash_for_brakeman(error, type)
+        {
+          linter: error['warning_type'],
+          severity: type.chomp('s'),
+          reason: error['message'],
+          column: 0,
+          line: error['line'].to_i,
+          confidence: error['confidence']
+        }
+      end
 
   end
 end

data/lib/maximus/lints/railsbp.rb

@@ -45,19 +45,19 @@ 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
-      }
-    end
+      # 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
+        }
+      end
 
   end
 end

data/lib/maximus/reporter/git-lines.sh

@@ -7,24 +7,53 @@ function lines-added(){
   local line=
   local start=
   local finish=
+  local unified=1
   while read; do
     esc=$'\033'
     if [[ $REPLY =~ ---\ (a/)?.* ]]; then
       continue
     elif [[ $REPLY =~ \+\+\+\ (b/)?([^[:blank:]$esc]+).* ]]; then
       path=${BASH_REMATCH[2]}
-    elif [[ $REPLY =~ @@\ -[0-9]+,([0-9]+)?\ \+([0-9]+)?,([0-9]+)?\ @@.* ]]; then
-      if [[ ${BASH_REMATCH[2]} = ${BASH_REMATCH[3]} ]]; then
+    # @@ -1,2, +3,4 @@
+    elif [[ $REPLY =~ @@\ -([0-9]+)?,([0-9]+)?\ \+([0-9]+)?,([0-9]+)?\ @@.* ]]; then
+
+      # hunk deletion
+      # @@ -7,5 +7,3 @@
+      # 0..0
+      if [[ ${BASH_REMATCH[2]} > ${BASH_REMATCH[4]} ]]; then
         line="0..0"
-      elif [[ ${BASH_REMATCH[2]} = $((${BASH_REMATCH[2]} + ${BASH_REMATCH[3]})) ]]; then
-        line="$((${BASH_REMATCH[2]} + ${BASH_REMATCH[3]} - ${BASH_REMATCH[1]}))..$((${BASH_REMATCH[2]} + ${BASH_REMATCH[3]} - ${BASH_REMATCH[1]}))"
+
+      # line(s) addition
+      # @@ -3,2, +3,3 @@
+      # 4..4
+      elif [[ ${BASH_REMATCH[1]} = ${BASH_REMATCH[3]} ]]; then
+        line="$((${BASH_REMATCH[1]} + $unified))..$((${BASH_REMATCH[4]} - ${BASH_REMATCH[2]} + ${BASH_REMATCH[1]}))"
+
+      # full deletion
+      # @@ -1,2, +0,0 @@
+      # 0..0
+      elif [[ ${BASH_REMATCH[3]} = ${BASH_REMATCH[4]} ]]; then
+        line="0..0"
+
+      # hunk addition
+      # @@ -0,0, +1,5 @@
+      # 0..4
+      elif [[ ${BASH_REMATCH[1]} = ${BASH_REMATCH[2]} ]]; then
+        line="$((${BASH_REMATCH[3]} - $unified))..$((${BASH_REMATCH[4]} - ${BASH_REMATCH[3]} + $unified))"
+
+      # additions with deletions
+      # @@ -13,3 +11,3 @@
+      # 12..12
+      elif [[ ${BASH_REMATCH[2]} = ${BASH_REMATCH[4]} ]]; then
+        line="$((${BASH_REMATCH[1]} - $unified))..$((${BASH_REMATCH[1]} - $unified))"
+
       else
-        line="${BASH_REMATCH[2]}..$((${BASH_REMATCH[2]} + ${BASH_REMATCH[3]}))"
+
+        # @@ -13,3 +11,4 @@
+        # 12..13
+        line="$((${BASH_REMATCH[1]} - $unified))..${BASH_REMATCH[1]}"
+
       fi
-    elif [[ $REPLY =~ @@\ -([0-9])?,([0-9]+)?\ \+([0-9]+)?\ @@.* ]]; then
-      line="${BASH_REMATCH[3]}..${BASH_REMATCH[3]}"
-    elif [[ $REPLY =~ @@\ -([0-9]+)?,\ \+([0-9]+)?\ @@.* ]]; then
-      line="0..${BASH_REMATCH[2]}"
     elif [[ $REPLY =~ ^($esc\[[0-9;]+m)*([\ +-]) ]]; then
       echo "$path:$line"
     fi
@@ -51,7 +80,7 @@ function diff-lines(){
 }
 
 if [ -z "$2" ]; then
-  git diff $1^ $1 --unified=0 | lines-added
+  git diff $1^ $1 --unified=1 | lines-added
 else
-  git diff --unified=0 | lines-added
+  git diff --unified=1 | lines-added
 fi

data/lib/maximus/statistic.rb

@@ -1,6 +1,8 @@
 module Maximus
+
+  # Parent class for all statistics (inherited by children)
   # @since 0.1.0
-  # @attr_accessor output [Hash] result of a lint parsed by Lint#refine
+  # @attr_accessor output [Hash] result of a statistic parsed by Statistic#refine
   class Statistic
     attr_accessor :output
 
@@ -17,6 +19,9 @@ module Maximus
     #  end
     #
     # Inherits settings from {Config#initialize}
+    #
+    # @see Config#initialize
+    #
     # @param opts [Hash] ({}) options passed directly to statistic
     # @option file_paths [Array, String] stat only specific files or directories
     #   Accepts globs too
@@ -25,8 +30,8 @@ module Maximus
     # @return [void] this method is used to set up instance variables
     def initialize(opts = {})
 
-      @@config ||= opts[:config] || Maximus::Config.new(opts)
-      @settings ||= @@config.settings
+      @config = opts[:config] || Maximus::Config.new(opts)
+      @settings = @config.settings
 
       @path = opts[:file_paths] || @settings[:file_paths]
 
@@ -41,34 +46,34 @@ module Maximus
 
     protected
 
-    # Organize stat output on the @output variable
-    #   Adds @output[:statistics][:filepath] with all statistic data
-    #   Ignores if is_dev or if stats_cli is blank
-    #
-    # @param stats_cli [String] JSON data from a lint result
-    # @param file_path [String] key value to organize stats output
-    # @return [Hash] organized stats data
-    def refine(stats_cli, file_path)
+      # Organize stat output on the @output variable
+      #   Adds @output[:statistics][:filepath] with all statistic data
+      #   Ignores if is_dev or if stats_cli is blank
+      #
+      # @param stats_cli [String] JSON data from a lint result
+      # @param file_path [String] key value to organize stats output
+      # @return [Hash] organized stats data
+      def refine(stats_cli, file_path)
 
-      # Stop right there unless you mean business
-      return puts stats_cli if @@config.is_dev?
+        # Stop right there unless you mean business
+        return puts stats_cli if @config.is_dev?
 
-      # JSON.parse will throw an abortive error if it's given an empty string
-      return false if stats_cli.blank?
+        # JSON.parse will throw an abortive error if it's given an empty string
+        return false if stats_cli.blank?
 
-      stats = JSON.parse(stats_cli)
-      @output[:statistics][file_path.to_sym] ||= {}
+        stats = JSON.parse(stats_cli)
+        @output[:statistics][file_path.to_sym] ||= {}
 
-      # @todo is there a better way to do this?
-      fp = @output[:statistics][file_path.to_s.to_sym]
+        # @todo is there a better way to do this?
+        fp = @output[:statistics][file_path.to_s.to_sym]
 
-      # @todo Can I do like a self << thing here?
-      stats.each do |stat, value|
-        fp[stat.to_sym] = value
-      end
+        # @todo Can I do like a self << thing here?
+        stats.each do |stat, value|
+          fp[stat.to_sym] = value
+        end
 
-      @output
-    end
+        @output
+      end
 
   end
 end

data/lib/maximus/statistics/phantomas.rb

@@ -13,28 +13,28 @@ module Maximus
       node_module_exists('phantomas')
 
       @path = @settings[:paths] if @path.blank?
-      @domain = @@config.domain
+      @domain = @config.domain
 
       # Phantomas doesn't actually skip the skip-modules defined in the config BUT here's to hoping for future support
       phantomas_cli = "phantomas --config=#{@settings[:phantomas]} "
-      phantomas_cli += @@config.is_dev? ? '--colors' : '--reporter=json:no-skip'
+      phantomas_cli += @config.is_dev? ? '--colors' : '--reporter=json:no-skip'
       phantomas_cli += " --proxy=#{@domain}"
       @path.is_a?(Hash) ? @path.each { |label, url| phantomas_by_url(url, phantomas_cli) } : phantomas_by_url(@path, phantomas_cli)
-      @@config.destroy_temp('phantomas')
+      @config.destroy_temp('phantomas')
       @output
     end
 
 
     private
 
-    # Organize stat output on the @output variable
-    # Adds @output[:statistics][:filepath] with all statistic data
-    # @return [void] goes to refine statistics
-    def phantomas_by_url(url, phantomas_cli)
-      puts "Phantomas on #{@domain + url}".color(:green)
-      phantomas = `#{phantomas_cli} #{@domain + url}`
-      refine(phantomas, url)
-    end
+      # Organize stat output on the @output variable
+      # Adds @output[:statistics][:filepath] with all statistic data
+      # @return [void] goes to refine statistics
+      def phantomas_by_url(url, phantomas_cli)
+        puts "Phantomas on #{@domain + url}".color(:green)
+        phantomas = `#{phantomas_cli} #{@domain + url}`
+        refine(phantomas, url)
+      end
 
   end
 end

data/lib/maximus/statistics/stylestats.rb

@@ -2,9 +2,7 @@ module Maximus
   # @since 0.1.0
   class Stylestats < Maximus::Statistic
 
-    # @path array preferrably absolute paths, but relative should work
-    #   If stylestatting one file, pass that as an array
-    #
+    # Produces CSS statistics
     # @see Statistic#initialize
     def result
 
@@ -24,8 +22,7 @@ module Maximus
         puts "#{'stylestats'.color(:green)}: #{pretty_name}\n\n"
 
         # include JSON formatter unless we're in dev
-        stylestats = `stylestats #{file} --config=#{@settings[:stylestats]} #{'--type=json' unless @@config.is_dev?}`
-        puts stylestats
+        stylestats = `stylestats #{file} --config=#{@settings[:stylestats]} #{'--type=json' unless @config.is_dev?}`
         refine(stylestats, pretty_name)
 
         File.delete(file)
@@ -34,7 +31,7 @@ module Maximus
       if is_rails?
         # @todo I'd rather Rake::Task but it's not working in different directories
         Dir.chdir(@settings[:root_dir]) do
-          if @@config.is_dev?
+          if @config.is_dev?
             # @todo review that this may not be best practice, but it's really noisy in the console
             quietly { `rake assets:clobber` }
           else
@@ -42,7 +39,7 @@ module Maximus
           end
         end
       end
-      @@config.destroy_temp('stylestats')
+      @config.destroy_temp('stylestats')
       @output
 
     end
@@ -50,67 +47,67 @@ module Maximus
 
     private
 
-    # Find all CSS files or compile.
-    #
-    # Uses sprockets if Rails; Sass engine otherwise.
-    # Compass is supported
-    # @return [Array] CSS files
-    def find_css_files
-      searched_files = []
-
-      if is_rails?
-        # Only load tasks if we're not running a rake task
-        Rails.application.load_tasks unless @@config.is_dev?
-
-        puts "\n"
-        puts 'Compiling assets for stylestats...'.color(:blue)
-
-        # @todo I'd rather Rake::Task but it's not working in different directories
-        Dir.chdir(@settings[:root_dir]) do
-          if @@config.is_dev?
-             # @todo review that this may not be best practice, but it's really noisy in the console
-            quietly { `rake assets:precompile` }
-          else
-            `rake assets:precompile`
+      # Find all CSS files or compile.
+      #
+      # Uses sprockets if Rails; Sass engine otherwise.
+      # Compass is supported
+      # @return [Array] CSS files
+      def find_css_files
+        searched_files = []
+
+        if is_rails?
+          # Only load tasks if we're not running a rake task
+          Rails.application.load_tasks unless @config.is_dev?
+
+          puts "\n"
+          puts 'Compiling assets for stylestats...'.color(:blue)
+
+          # @todo I'd rather Rake::Task but it's not working in different directories
+          Dir.chdir(@settings[:root_dir]) do
+            if @config.is_dev?
+               # @todo review that this may not be best practice, but it's really noisy in the console
+              quietly { `rake assets:precompile` }
+            else
+              `rake assets:precompile`
+            end
           end
-        end
 
-        Dir.glob(@path).select { |f| File.file? f }.each do |file|
-          searched_files << file
-        end
+          Dir.glob(@path).select { |f| File.file? f }.each do |file|
+            searched_files << file
+          end
 
-      else
+        else
 
-        # Load Compass paths if the gem exists
-        if Gem::Specification::find_all_by_name('compass').any?
-          require 'compass'
-          Compass.sass_engine_options[:load_paths].each do |path|
-            Sass.load_paths << path
+          # Load Compass paths if the gem exists
+          if Gem::Specification::find_all_by_name('compass').any?
+            require 'compass'
+            Compass.sass_engine_options[:load_paths].each do |path|
+              Sass.load_paths << path
+            end
           end
-        end
 
-        # Shouldn't need to load paths anymore, but in case this doesn't work
-        #   as it should, try the func below
-        # Dir.glob(@path).select { |d| File.directory? d}.each do |directory|
-        #   Sass.load_paths << directory
-        # end
+          # Shouldn't need to load paths anymore, but in case this doesn't work
+          #   as it should, try the func below
+          # Dir.glob(@path).select { |d| File.directory? d}.each do |directory|
+          #   Sass.load_paths << directory
+          # end
 
-        @path += ".scss"
+          @path += ".scss"
 
-        Dir[@path].select { |f| File.file? f }.each do |file|
-          # @todo don't compile file if it starts with an underscore
-          scss_file = File.open(file, 'rb') { |f| f.read }
+          Dir[@path].select { |f| File.file? f }.each do |file|
+            # @todo don't compile file if it starts with an underscore
+            scss_file = File.open(file, 'rb') { |f| f.read }
 
-          output_file = File.open( file.split('.').reverse.drop(1).reverse.join('.'), "w" )
-          output_file << Sass::Engine.new(scss_file, { syntax: :scss, quiet: true, style: :compressed }).render
-          output_file.close
+            output_file = File.open( file.split('.').reverse.drop(1).reverse.join('.'), "w" )
+            output_file << Sass::Engine.new(scss_file, { syntax: :scss, quiet: true, style: :compressed }).render
+            output_file.close
 
-          searched_files << output_file.path
+            searched_files << output_file.path
 
+          end
         end
+        searched_files
       end
-      searched_files
-    end
 
   end
 end

data/lib/maximus/statistics/wraith.rb

@@ -2,10 +2,7 @@ module Maximus
   # @since 0.1.0
   class Wraith < Maximus::Statistic
 
-    # By default checks homepage
-    # Requires config to be in config/wraith/history.yaml
-    # Adds a new config/wraith/history.yaml if not present
-    # Path should be an Array defined as [{ label: url }]
+    # Generates screenshots for visual regression testing
     # @see Statistic#initialize
     def result
 
@@ -30,7 +27,6 @@ module Maximus
         else
           puts `wraith history #{configpath}`
         end
-        File.write('said.yml', wraith_yaml.to_yaml)
         File.delete(configpath)
         wraith_parse browser
       end
@@ -40,27 +36,27 @@ module Maximus
 
     private
 
-    # Get a diff percentage of all changes by label and screensize
-    #
-    # @example {:statistics=>{:/=>{:percent_changed=>[{1024=>0.0}, {767=>0.0}, {1024=>0.0}, {767=>0.0}, {1024=>0.0}, {767=>0.0}, {1024=>0.0}, {767=>0.0}] } }}
-    # @param browser [String] headless browser used to generate the gallery
-    # @return [Hash] { path: { percent_changed: [{ size: percent_diff }] } }
-    def wraith_parse(browser)
-      Dir.glob("#{@settings[:root_dir]}/maximus_wraith_#{browser}/**/*.txt").select { |f| File.file? f }.each do |file|
-        file_object = File.open(file, 'rb')
-        orig_label = File.dirname(file).split('/').last
-        label = @settings[:paths][orig_label]
-        @output[:statistics][browser.to_sym] ||= {}
-        @output[:statistics][browser.to_sym][label.to_sym] ||= {}
-        browser_output = @output[:statistics][browser.to_sym][label.to_sym]
-        browser_output ||= {}
-        browser_output[:name] = orig_label
-        browser_output[:percent_changed] ||= []
-        browser_output[:percent_changed] << { File.basename(file).split('_')[0].to_i => file_object.read.to_f }
-        file_object.close
+      # Get a diff percentage of all changes by label and screensize
+      #
+      # @example {:statistics=>{:/=>{:percent_changed=>[{1024=>0.0}, {767=>0.0}, {1024=>0.0}, {767=>0.0}, {1024=>0.0}, {767=>0.0}, {1024=>0.0}, {767=>0.0}] } }}
+      # @param browser [String] headless browser used to generate the gallery
+      # @return [Hash] { path: { percent_changed: [{ size: percent_diff }] } }
+      def wraith_parse(browser)
+        Dir.glob("#{@settings[:root_dir]}/maximus_wraith_#{browser}/**/*.txt").select { |f| File.file? f }.each do |file|
+          file_object = File.open(file, 'rb')
+          orig_label = File.dirname(file).split('/').last
+          label = @settings[:paths][orig_label]
+          @output[:statistics][browser.to_sym] ||= {}
+          @output[:statistics][browser.to_sym][label.to_sym] ||= {}
+          browser_output = @output[:statistics][browser.to_sym][label.to_sym]
+          browser_output ||= {}
+          browser_output[:name] = orig_label
+          browser_output[:percent_changed] ||= []
+          browser_output[:percent_changed] << { File.basename(file).split('_')[0].to_i => file_object.read.to_f }
+          file_object.close
+        end
+        @output
       end
-      @output
-    end
 
   end
 end