maximus 0.1.4 → 0.1.5

data/lib/maximus/lints/rubocop.rb

@@ -3,16 +3,12 @@ module Maximus
   class Rubocop < Maximus::Lint
 
     # RuboCop
-    #
     # @see Lint#initialize
     def result
       @task = 'rubocop'
-
-      return unless temp_config(@task)
-
       @path = is_rails? ? "#{@settings[:root_dir]}/app" : "#{@settings[:root_dir]}/*.rb" if @path.blank?
 
-      return unless path_exists(@path)
+      return unless temp_config(@task) && path_exists?(@path)
 
       rubo = `rubocop #{@path} --require #{reporter_path('rubocop')} --config #{temp_config(@task)} --format RuboCop::Formatter::MaximusRuboFormatter #{'-R' if is_rails?}`
 

data/lib/maximus/lints/scsslint.rb

@@ -3,15 +3,12 @@ module Maximus
   class Scsslint < Maximus::Lint
 
     # SCSS-Lint
-    #
     # @see Lint#initialize
     def result
       @task = 'scsslint'
-
-      return unless temp_config(@task)
       @path = is_rails? ? "#{@settings[:root_dir]}/app/assets/stylesheets" : "#{@settings[:root_dir]}/source/assets/stylesheets" if @path.blank?
 
-      return unless path_exists(@path)
+      return unless temp_config(@task) && path_exists?(@path)
 
       scss = `scss-lint #{@path} -c #{temp_config(@task)} --format=JSON`
       @output[:files_inspected] ||= files_inspected('scss')

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

@@ -59,28 +59,14 @@ function lines-added(){
     fi
   done
 }
-function diff-lines(){
-  local path=
-  local line=
-  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
-      line=${BASH_REMATCH[2]}
-    elif [[ $REPLY =~ ^($esc\[[0-9;]+m)*([\ +-]) ]]; then
-      echo "$path:$line:$REPLY"
-      if [[ ${BASH_REMATCH[2]} != - ]]; then
-        ((line++))
-      fi
-    fi
-  done
-}
 
-if [ -z "$2" ]; then
-  git diff $1^ $1 --unified=1 | lines-added
+if [ -z "$3" ]; then
+  first_commit=$(git rev-list --max-parents=0 HEAD)
+  if [[ "$2" == "$first_commit" ]]; then
+    git -C $1 diff --unified=1 | lines-added
+  else
+    git -C $1 diff $2^ $2 --unified=1 | lines-added
+  fi
 else
-  git diff --unified=1 | lines-added
+  git -C $1 diff --unified=1 | lines-added
 fi

data/lib/maximus/statistic.rb

@@ -62,10 +62,10 @@ module Maximus
         return false if stats_cli.blank?
 
         stats = JSON.parse(stats_cli)
-        @output[:statistics][file_path.to_sym] ||= {}
+        @output[:statistics][file_path.to_s] ||= {}
 
         # @todo is there a better way to do this?
-        fp = @output[:statistics][file_path.to_s.to_sym]
+        fp = @output[:statistics][file_path.to_s]
 
         # @todo Can I do like a self << thing here?
         stats.each do |stat, value|

data/lib/maximus/statistics/phantomas.rb

@@ -20,7 +20,6 @@ module Maximus
       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')
       @output
     end
 

data/lib/maximus/statistics/stylestats.rb

@@ -9,9 +9,17 @@ module Maximus
       return if @settings[:stylestats].blank?
 
       node_module_exists('stylestats')
-      @path = is_rails? ? "#{@settings[:root_dir]}/public/assets/**/*.css" : "#{@settings[:root_dir]}/**/*.css" if @path.blank?
 
-      css_files = @path.is_a?(Array) ? @path : find_css_files
+      if @path.blank?
+        @path = is_rails? ? "#{@settings[:root_dir]}/public/assets/**/*.css" : "#{@settings[:root_dir]}/**/*.css"
+      end
+
+      if @path.is_a?(Array)
+        css_files = @path
+      else
+        compile_scss if @settings[:compile_assets]
+        css_files = find_css
+      end
 
       css_files.each do |file|
 
@@ -28,18 +36,7 @@ module Maximus
         File.delete(file)
       end
 
-      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?
-            # @todo review that this may not be best practice, but it's really noisy in the console
-            quietly { `rake assets:clobber` }
-          else
-            `rake assets:clobber`
-          end
-        end
-      end
-      @config.destroy_temp('stylestats')
+      destroy_assets if @settings[:compile_assets]
       @output
 
     end
@@ -51,62 +48,100 @@ module Maximus
       #
       # Uses sprockets if Rails; Sass engine otherwise.
       # Compass is supported
-      # @return [Array] CSS files
-      def find_css_files
-        searched_files = []
-
+      # @return [#compile_scss_rails, #compile_scss, Array] CSS files
+      def compile_scss
+        puts "\nCompiling assets for stylestats...".color(:blue)
         if is_rails?
-          # Only load tasks if we're not running a rake task
+
+          # Get rake tasks
           Rails.application.load_tasks unless @config.is_dev?
+          compile_scss_rails
+        else
 
-          puts "\n"
-          puts 'Compiling assets for stylestats...'.color(:blue)
+          load_compass
 
-          # @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
+          compile_scss
+        end
+      end
 
-          Dir.glob(@path).select { |f| File.file? f }.each do |file|
-            searched_files << file
+      # Load Compass paths if the gem exists
+      # @see find_css_files
+      # @since 0.1.5
+      def load_compass
+        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
 
-        else
+      # Add directories to load paths
+      # @todo This function is here in case older versions of SCSS will need it
+      #   because there shouldn't be a need to load paths, but there might be a need
+      #   in older versions of SCSS, which should be tested (although the SCSSLint)
+      #   dependency may dictate our scss version
+      # @since 0.1.5
+      def load_scss_load_paths
+        Dir.glob(@path).select { |d| File.directory? d}.each do |directory|
+          Sass.load_paths << directory
+        end
+      end
 
-          # 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
+      # Turns scss files into css files with the asset pipeline
+      # @see find_css_files
+      # @since 0.1.5
+      # @return [Array] compiled css files
+      def compile_scss_rails
+        searched_files = []
+        # @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
 
-          # 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"
-
-          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
+      # Turn scss files into css files
+      # @see find_css_files
+      # @since 0.1.5
+      def compile_scss_normal
+        Dir["#{@path}.scss"].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
+        end
+      end
 
-            searched_files << output_file.path
+      # Remove all assets created
+      # @since 0.1.5
+      def destroy_assets
 
+        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?
+              # @todo review that this may not be best practice, but it's really noisy in the console
+              quietly { `rake assets:clobber` }
+            else
+              `rake assets:clobber`
+            end
           end
         end
-        searched_files
+
+      end
+
+      # Find all css files
+      # @param path [String] globbed file path
+      # @return [Array] paths to compiled CSS files
+      def find_css(path = @path)
+        Dir.glob(path).select { |f| File.file? f }.map { |file| file }
       end
 
   end

data/lib/maximus/statistics/wraith.rb

@@ -3,6 +3,20 @@ module Maximus
   class Wraith < Maximus::Statistic
 
     # Generates screenshots for visual regression testing
+    #
+    # WARNING: If you call this class from a script,
+    #   you should delete the images generated after they've been
+    #   created.
+    # @example removing images after run
+    #   dest = '/desired/root/directory'
+    #   wraith_pics = Maximus::Wraith.new.result
+    #   wraith_pics.each do |path_label, data|
+    #     data[:images].each do |image|
+    #       moved_image = "#{dest}/#{File.basename(image)}"
+    #       FileUtils.mv image, moved_image, force: true
+    #     end
+    #   end
+    #
     # @see Statistic#initialize
     def result
 
@@ -14,22 +28,23 @@ module Maximus
 
       # Run history or latest depending on the existence of a history directory as defined
       #   in each wraith config file.
-      #
-      # @todo this doesn't work very well. It puts the new shots in the history folder,
-      #   even with absolute paths. Could be a bug in wraith
-      #
       # @yieldparam browser [String] headless browser name
       # @yieldparam configpath [String] path to temp config file (see Config#wraith_setup)
       @settings[:wraith].each do |browser, configpath|
+        next unless File.file?(configpath) # prevents abortive YAML error if it can't find the file
         wraith_yaml = YAML.load_file(configpath)
         if File.directory?("#{@settings[:root_dir]}/#{wraith_yaml['history_dir']}")
           puts `wraith latest #{configpath}`
-        else
-          puts `wraith history #{configpath}`
+
+          # Reset history dir
+          # It puts the new shots in the history folder, even with absolute paths in the config.
+          #   Could be a bug in wraith.
+          FileUtils.remove_dir("#{@settings[:root_dir]}/#{wraith_yaml['history_dir']}")
         end
-        File.delete(configpath)
-        wraith_parse browser
+        wraith_parse browser unless @config.is_dev?
+        puts `wraith history #{configpath}`
       end
+      @output
 
     end
 
@@ -38,25 +53,68 @@ module Maximus
 
       # 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}] } }}
+      # @example { :statistics => { "/" => { :browser=>"phantomjs", :name=>"home", :percent_changed=>{ 1024=>2.1, 1280=>1.8, 767=>3.4 } } } }
       # @param browser [String] headless browser used to generate the gallery
-      # @return [Hash] { path: { percent_changed: [{ size: percent_diff }] } }
+      # @return [Hash] { path: { browser, path_label, 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')
+        Dir.glob("#{@settings[:root_dir]}/maximus_wraith_#{browser}/**/*").select { |f| File.file? f }.each do |file|
+          extension = File.extname(file)
+          next unless extension == '.png' || extension == '.txt'
+
           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
+
+          path = @settings[:paths][orig_label].to_s
+
+          @output[:statistics][path] = {
+            browser: browser.to_s,
+            name: orig_label
+          } if @output[:statistics][path].blank?
+
+          browser_output = @output[:statistics][path]
+
+          if extension == '.txt'
+            browser_output = wraith_percentage(file, browser_output)
+          else
+            browser_output[:images] ||= []
+            browser_output[:images] << wraith_image(file)
+          end
+
         end
         @output
       end
 
+      # Grab the percentage change from previous snapshots
+      # @since 0.1.5
+      # @param file [String]
+      # @param browser_output [Hash]
+      # @return [Hash]
+      def wraith_percentage(file, browser_output)
+        file_object = File.open(file, 'rb')
+        browser_output[:percent_changed] ||= {}
+        browser_output[:percent_changed][File.basename(file).split('_')[0].to_i] = file_object.read.to_f
+
+        file_object.close
+
+        browser_output
+      end
+
+      # Make images temp files to save for later
+      # Once this script exits, the images will delete themselves.
+      #   We need those images, so the finalizer is left undefined.
+      #   http://stackoverflow.com/a/21286718
+      # @since 0.1.5
+      # @param file [String]
+      # @return [String] path to image
+      def wraith_image(file)
+        data = File.read(file)
+        image = Tempfile.new([File.basename(file), '.png']).tap do |f|
+          f.rewind
+          f.write(data)
+          ObjectSpace.undefine_finalizer(f)
+          f.close
+        end
+        image.path
+      end
+
   end
 end

data/lib/maximus/version.rb

@@ -1,3 +1,3 @@
 module Maximus
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

data/maximus.gemspec

@@ -18,18 +18,18 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "git", ">= 1.2.8"
-  spec.add_runtime_dependency "scss-lint", "~> 0.31.0"
+  spec.add_runtime_dependency "git", "~> 1.2.9"
+  spec.add_runtime_dependency "scss-lint", "~> 0.33.0"
   spec.add_runtime_dependency "rainbow", "2.0.0"
-  spec.add_runtime_dependency "rubocop", "~> 0.23"
+  spec.add_runtime_dependency "rubocop", "~> 0.28"
   spec.add_runtime_dependency "rails_best_practices", "~> 1.15"
-  spec.add_runtime_dependency "brakeman", "~> 2.6"
-  spec.add_runtime_dependency "wraith", "~> 2.1.0"
-  spec.add_runtime_dependency "activesupport"
-  spec.add_runtime_dependency "thor"
+  spec.add_runtime_dependency "brakeman", "~> 3.0.1"
+  spec.add_runtime_dependency "wraith", "~> 2.3"
+  spec.add_runtime_dependency "activesupport", "~> 4.2.0"
+  spec.add_runtime_dependency "thor", "~> 0.19.1"
 
   spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "nokogiri", "~> 1.6.0"
   spec.add_development_dependency "yard", "~> 0.8"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "coveralls", "~> 0.7.8"
 end

data/roadmap.md

@@ -9,5 +9,9 @@
 * Add CSS lint (maybe)
 * Add JSLint (maybe)
 * Add W3 validator (maybe)
+* Add Markdown lint (maybe)
+* Add Flog support (maybe)
+* Add Flay support (maybe)
 * Regex path names on phantomas and wraith to defend against injection and bad characters
 * Test for < ruby 2.0 or require 2.0 < in gemspec
+* If no files to inspect in working, say so