maximus 0.1.5.1 → 0.1.6.1

data/lib/maximus/lints/scsslint.rb

@@ -1,4 +1,5 @@
 module Maximus
+  # Evaluates quality of scss
   # @since 0.1.0
   class Scsslint < Maximus::Lint
 
@@ -6,8 +7,7 @@ module Maximus
     # @see Lint#initialize
     def result
       @task = 'scsslint'
-      @path = is_rails? ? "#{@settings[:root_dir]}/app/assets/stylesheets" : "#{@settings[:root_dir]}/source/assets/stylesheets" if @path.blank?
-
+      @path = discover_path(@config.working_dir, 'stylesheets')
       return unless temp_config(@task) && path_exists?(@path)
 
       scss = `scss-lint #{@path} -c #{temp_config(@task)} --format=JSON`

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

@@ -1,7 +1,6 @@
 #!/bin/bash
 
 # http://stackoverflow.com/questions/8259851/using-git-diff-how-can-i-get-added-and-modified-lines-numbers
-# @todo this function is tricky because I don't fully understand regex in BASH. Also, getting line hunks from git is tricky. This will likely need to be refactored
 function lines-added(){
   local path=
   local line=

data/lib/maximus/statistic.rb

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

data/lib/maximus/statistics/phantomas.rb

@@ -1,9 +1,9 @@
 module Maximus
+  # Evaluate page performance
   # @since 0.1.0
   class Phantomas < Maximus::Statistic
 
-    # Phantomas evaluates page performance with phantomjs and node
-    #
+    # Run phantomas through the command line
     # @see Statistic#initialize
     def result
 
@@ -18,7 +18,7 @@ module Maximus
       # 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 += " --proxy=#{@domain}"
+      phantomas_cli << " --proxy=#{@domain}" if @domain.include?('localhost')
       @path.is_a?(Hash) ? @path.each { |label, url| phantomas_by_url(url, phantomas_cli) } : phantomas_by_url(@path, phantomas_cli)
       @output
     end

data/lib/maximus/statistics/stylestats.rb

@@ -1,8 +1,9 @@
 module Maximus
+  # Produce CSS statistics
   # @since 0.1.0
   class Stylestats < Maximus::Statistic
 
-    # Produces CSS statistics
+    # Requires node
     # @see Statistic#initialize
     def result
 
@@ -11,7 +12,7 @@ module Maximus
       node_module_exists('stylestats')
 
       if @path.blank?
-        @path = is_rails? ? "#{@settings[:root_dir]}/public/assets/**/*.css" : "#{@settings[:root_dir]}/**/*.css"
+        @path = is_rails? ? "#{@config.working_dir}/public/assets/**/*.css" : "#{@config.working_dir}/**/*.css"
       end
 
       if @path.is_a?(Array)
@@ -21,20 +22,7 @@ module Maximus
         css_files = find_css
       end
 
-      css_files.each do |file|
-
-        # For Rails, we only want the name of the compiled asset, because we know it'll live in public/assets.
-        #   If this isn't Rails, sure, give me the full path because the directory structure is likely unique
-        pretty_name = is_rails? ? file.split('/').pop.gsub(/(-{1}[a-z0-9]{32}*\.{1}){1}/, '.') : file
-
-        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?}`
-        refine(stylestats, pretty_name)
-
-        File.delete(file)
-      end
+      css_files.each { |file| stylestats_report(file) }
 
       destroy_assets if @settings[:compile_assets]
       @output
@@ -94,23 +82,22 @@ module Maximus
       # @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
+        # I'd rather Rake::Task but it's not working in different directories
+        if @config.is_dev?
+           # @todo review that this may not be best practice, but it's really noisy in the console
+          quietly { `rake -f #{@config.working_dir}/Rakefile assets:precompile` }
+        else
+          `rake -f #{@config.working_dir}/Rakefile assets:precompile`
         end
       end
 
       # Turn scss files into css files
+      # Skips if the file starts with an underscore
       # @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
+          next if File.basename(file).chr == '_'
           scss_file = File.open(file, 'rb') { |f| f.read }
 
           output_file = File.open( file.split('.').reverse.drop(1).reverse.join('.'), "w" )
@@ -124,14 +111,12 @@ module Maximus
       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
+          # I'd rather Rake::Task but it's not working in different directories
+          if @config.is_dev?
+            # @todo review that this may not be best practice, but it's really noisy in the console
+            quietly { `rake -f #{@config.working_dir}/Rakefile assets:clobber` }
+          else
+            `rake -f #{@config.working_dir}/Rakefile assets:clobber`
           end
         end
 
@@ -144,5 +129,24 @@ module Maximus
         Dir.glob(path).select { |f| File.file? f }.map { |file| file }
       end
 
+      # Present stylestat result of a CSS file
+      # Deletes file at end
+      # @since 0.1.6
+      # @see #result
+      # @param file [String] path to file
+      def stylestats_report(file)
+        # For Rails, we only want the name of the compiled asset, because we know it'll live in public/assets.
+        #   If this isn't Rails, sure, give me the full path because the directory structure is likely unique
+        pretty_name = is_rails? ? file.split('/').pop.gsub(/(-{1}[a-z0-9]{32}*\.{1}){1}/, '.') : file
+
+        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?}`
+        refine(stylestats, pretty_name)
+
+        File.delete(file)
+      end
+
   end
 end

data/lib/maximus/statistics/wraith.rb

@@ -1,9 +1,9 @@
 module Maximus
+  # Generates screenshots for visual regression testing
   # @since 0.1.0
   class Wraith < Maximus::Statistic
 
-    # Generates screenshots for visual regression testing
-    #
+    # Runs Wraith through command line
     # WARNING: If you call this class from a script,
     #   you should delete the images generated after they've been
     #   created.
@@ -30,20 +30,8 @@ module Maximus
       #   in each wraith config file.
       # @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}`
+      @settings[:wraith].each { |browser, configpath| wraith_report(browser, 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
-        wraith_parse browser unless @config.is_dev?
-        puts `wraith history #{configpath}`
-      end
       @output
 
     end
@@ -57,7 +45,7 @@ module Maximus
       # @param browser [String] headless browser used to generate the gallery
       # @return [Hash] { path: { browser, path_label, percent_changed: { size: percent_diff ] } }
       def wraith_parse(browser)
-        Dir.glob("#{@settings[:root_dir]}/maximus_wraith_#{browser}/**/*").select { |f| File.file? f }.each do |file|
+        Dir.glob("#{@config.working_dir}/maximus_wraith_#{browser}/**/*").select { |f| File.file? f }.each do |file|
           extension = File.extname(file)
           next unless extension == '.png' || extension == '.txt'
 
@@ -116,5 +104,26 @@ module Maximus
         image.path
       end
 
+      # Generate thumbnails and history for each browser in the wraith config
+      # @since 0.1.6
+      # @see #result
+      # @param browser [String]
+      # @param configpath [String]
+      def wraith_report(browser, configpath)
+        return unless File.file?(configpath) # prevents abortive YAML error if it can't find the file
+        wraith_yaml = YAML.load_file(configpath)
+        if File.directory?(File.join(@config.working_dir, wraith_yaml['history_dir']))
+          puts `wraith latest #{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(File.join(@config.working_dir, wraith_yaml['history_dir']))
+        end
+
+        wraith_parse browser unless @config.is_dev?
+        puts `wraith history #{configpath}`
+      end
+
   end
 end

data/lib/maximus/version.rb

@@ -1,3 +1,3 @@
 module Maximus
-  VERSION = "0.1.5.1"
+  VERSION = "0.1.6.1"
 end

data/maximus.gemspec

@@ -19,16 +19,17 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_runtime_dependency "git", "~> 1.2.9"
-  spec.add_runtime_dependency "scss-lint", "~> 0.33.0"
+  spec.add_runtime_dependency "scss-lint", "~> 0.34.0"
   spec.add_runtime_dependency "rainbow", "2.0.0"
-  spec.add_runtime_dependency "rubocop", "~> 0.28"
+  spec.add_runtime_dependency "rubocop", "~> 0.29"
   spec.add_runtime_dependency "rails_best_practices", "~> 1.15"
   spec.add_runtime_dependency "brakeman", "~> 3.0.1"
-  spec.add_runtime_dependency "wraith", "~> 2.3"
+  spec.add_runtime_dependency "wraith", "~> 2.3.2"
   spec.add_runtime_dependency "activesupport"
   spec.add_runtime_dependency "thor"
 
   spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "pry-byebug", "~> 3.0"
   spec.add_development_dependency "yard", "~> 0.8"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "coveralls", "~> 0.7.8"

data/roadmap.md

@@ -1,17 +1,12 @@
 # Roadmap
 
-* Check for custom lint or stat hooks in a lib/maximus folder. Add custom lint path and script execution support to maximus.yml config file
-* Use PhantomJS 2.0 with webfont support
 * Resolve/review @todos
-* Convert ruby-git to rugged (MAYBE - rugged requires libgit2)
-* Add SCSS specificity graph
-* Add HAML lint (maybe)
 * 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
+* Add PHP CodeSniffer (maybe)
+* Add PHPMetrics (maybe)
+* Use PHP's built-in linter (maybe)
 * If no files to inspect in working, say so

data/spec/maximus/config_spec.rb

@@ -1,15 +1,78 @@
 require 'spec_helper'
+require 'support/config_helper'
 
 describe Maximus::Config do
-  let(:config_path) { '.maximus.yml' }
 
+  include ConfigHelper
+
+  let(:config_body) { '' }
   subject(:config) do
-    File.write(config_path, config_body)
-    config_contents = config_body.blank? ? {} : { config_file: config_path }
-    described_class.new(config_contents)
+    create_config(config_body)
+  end
+
+  after(:each) { destroy_config }
+
+  describe 'options in general', :isolated_environment do
+    context 'options are passed directly' do
+      it 'should read the options as is' do
+        conf = described_class.new({port: 1000})
+
+        expect(conf.settings[:port]).to eq 1000
+      end
+    end
+
+    context 'options are passed through a file' do
+      let(:config_body) { 'port: 1000' }
+      it 'should parse the file accurately' do
+        expect(config.settings[:port]).to eq 1000
+      end
+    end
+
+    context 'options are passed through a file and directly' do
+      let(:config_body) { 'port: 1000' }
+      it 'should prefer the direct options' do
+        conf = described_class.new({port: 1001, config_file: '.maximus.yml'})
+        expect(conf.settings[:port]).to eq 1001
+      end
+    end
+
   end
 
-  describe '#is_dev?', :isolated_environment do
+  describe 'config file loading (load_confg_file)', :isolated_environment do
+
+    context 'only maximus.yml is available' do
+      it 'should take the settings in maximus.yml' do
+        create_config('port: 1001', 'maximus.yml')
+        conf = described_class.new
+
+        expect(conf.settings[:port]).to eq 1001
+        destroy_config('maximus.yml')
+      end
+    end
+
+    context '.maximus.yml and maximus.yml are available' do
+      it 'should prefer .maximus.yml' do
+        create_config('port: 1000', '.maximus.yml')
+        create_config('port: 1001', 'maximus.yml')
+        conf = described_class.new
+
+        expect(conf.settings[:port]).to eq 1000
+        destroy_config('maximus.yml')
+      end
+    end
+
+  end
+
+  describe '.working_dir', :isolated_environment do
+    context 'root_dir is applied in the config' do
+      let(:config_body) { 'root_dir: some/fake/directory' }
+      it 'should equal the config setting' do
+        expect(config.working_dir).to eq 'some/fake/directory'
+      end
+    end
+  end
+
+  describe '.is_dev?', :isolated_environment do
     context 'setting root value is_dev to true' do
       let(:config_body) { 'is_dev: true' }
       it 'should be true' do
@@ -18,32 +81,30 @@ describe Maximus::Config do
     end
 
     context 'is blank/not supplied' do
-      let(:config_body) { '' }
       it 'should default to false' do
         expect(config.is_dev?).to be false
       end
     end
   end
 
-  describe '#initialize', :isolated_environment do
+  describe '.initialize', :isolated_environment do
 
     context 'setting a linter to be true' do
       let(:config_body) { 'scsslint: true' }
       it 'scsslint should exist' do
-        expect(config.settings.has_key?(:scsslint)).to be true
+        expect(config.settings.key?(:scsslint)).to be true
       end
     end
 
     context 'not supplying a linter but relying on the default' do
-      let(:config_body) { '' }
       it 'should include a linter' do
-        expect(config.settings.has_key?(:scsslint)).to be true
+        expect(config.settings.key?(:scsslint)).to be true
       end
     end
 
   end
 
-  describe '#domain', :isolated_environment do
+  describe '.domain', :isolated_environment do
 
     context 'domain is provided' do
 
@@ -83,7 +144,7 @@ describe Maximus::Config do
 
   end
 
-  describe '#split_paths', :isolated_environment do
+  describe '.split_paths', :isolated_environment do
 
     context 'an array is provided' do
       let(:config_body) { "paths: \n  - '/'\n  - '/about'"}
@@ -100,7 +161,6 @@ describe Maximus::Config do
     end
 
     context 'nothing is provided' do
-      let(:config_body) { '' }
       it 'should return the default path with label' do
         expect( config.settings[:paths] ).to eq ({ 'home' => '/'})
       end
@@ -111,10 +171,29 @@ describe Maximus::Config do
   describe '#load_config', :isolated_environment do
 
     context 'a file path is provided' do
-      let(:config_body) { 'rubocop: spec/support/rubocop.yml' }
-      it 'should load the file' do
-        expect( YAML.load_file(config.settings[:rubocop])['Rubolinter'] ).to be true
+
+      context 'at a local address' do
+        let(:config_body) { 'rubocop: spec/support/rubocop.yml' }
+        it 'should load the file' do
+          expect( YAML.load_file(config.settings[:rubocop])['Rubolinter'] ).to be true
+        end
+      end
+
+      context 'at an available remote address' do
+        let(:config_body) { 'rubocop: "https://raw.githubusercontent.com/wearefine/standards/master/linters/.rubocop.yml" ' }
+        it 'should load the file' do
+          expect( YAML.load_file(config.settings[:rubocop]) ).to be_a(Hash)
+        end
       end
+
+      context 'at an unavailable remote address' do
+        let(:config_body) { 'rubocop: "http://raw.githubusercontent.com/wearefine/standards/master/linters/nonexistent_file.yml" ' }
+        it 'should report an error and return an empty hash' do
+          STDOUT.should_receive(:puts).with('http://raw.githubusercontent.com/wearefine/standards/master/linters/nonexistent_file.yml not accessible')
+          expect( YAML.load_file(config.settings[:rubocop]) ).to eq({})
+        end
+      end
+
     end
 
     context 'settings are provided' do