maximus 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8843e2de02ffdfdbe667056bbb99a3a346a6c2aa
-  data.tar.gz: 4d60b2e41051e130c5d6749c584430f6d3d49681
+  metadata.gz: b23428dccc821b0c760a0e9e700dae8a98590824
+  data.tar.gz: 584a217684704ba5e28be0362805de0dff016d4a
 SHA512:
-  metadata.gz: 6bfa472047e078d6d46220e88a5e0fe2f350ddc321c39c4967d89c5e0015b1da40af853448501966bc197abe1238e3d0e2791ecaface6bc08c8755b24049c3bc
-  data.tar.gz: 4d41a262ca94d0dc8444b8ce2a4d43978ae4945010ecc2ac670519dcddb375a0af61f4baa903042d77bdf54c3bb53271cb24d15efd46528791ab72ba6b699c73
+  metadata.gz: 8d6782b673a666075f0e8fef4dbbe885a25f5eba717522a6adf3eeb0e89089abaac67a1bea31c6b07a25e6bb8fa188f02ca1b23ad97f301be7e5b3242bdbeaed
+  data.tar.gz: 7b8fe7dfbf4401ba3c12ce4249d790e1b9c6e59c18688c1c75fda55cc998ad3ad1964f6e2ea6e4aa9bb2c9f3a1c431cb9f4f05ead59c5a50884c5258cbf66f8e

data/.travis.yml

@@ -1,6 +1,8 @@
 sudo: false
 cache: bundler
 language: ruby
+git:
+  depth: 800
 rvm:
   - 2.0.0
   - 2.1

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2014 Tim Shedor
+Copyright (c) 2015 Tim Shedor
 
 MIT License
 

data/README.md

@@ -77,18 +77,18 @@ lints: true # all lints including brakeman will run
 
 Flag                | Accepts                          | Description
 --------------------|----------------------------------|--------------------
-`-fp`/`--filepaths` | String/Array                     | Space-separated path(s) to files
-`-u`/`--urls`       | String/Array                     | Statistics only - Space-separated path(s) to relative URLs
-`-d`/`--domain`     | String                           | Statistics only - Web address (prepended to paths)
-`-po`/`--port`      | String/Numeric                   | Statistics only - Port to use if required (appended to domain)
+`-g`/`--sha`      | String                           | Run maximus based on a git commit. See [below](#git-examples)
 `-f`/`--frontend`   | Boolean/Blank                    | Run all front-end lints
 `-b`/`--backend`    | Boolean/Blank                    | Run all back-end lints
 `-s`/`--statistics` | Boolean/Blank                    | Run all statistics
 `-a`/`--all`        | Boolean/Blank                    | Run everything
 `-i`/`--include`    | String/Array                     | Include specific lints or statistics
 `-i`/`--exclude`    | String/Array                     | Exclude specific lints or statistics
-`-git`/`--sha`      | String                           | Run maximus based on a git commit. See [below](#git-examples)
 `-c`/`--config`     | String                           | Path to config file
+`-fp`/`--filepaths` | String/Array                     | Space-separated path(s) to files
+`-u`/`--urls`       | String/Array                     | Statistics only - Space-separated path(s) to relative URLs
+`-d`/`--domain`     | String                           | Statistics only - Web address (prepended to paths)
+`-po`/`--port`      | String/Numeric                   | Statistics only - Port to use if required (appended to domain)
 
 
 * Lint tasks can accept glob notation, i.e. `**/*.scss`
@@ -135,8 +135,26 @@ When adding new lints, the JSON output should obey the following format:
 } ]
 ```
 
+## Notes
+
+If calling Maximus::Wraith from a script, please see the note in lib/statistics/wraith.rb#result
+
 ## Changelog
 
+### 0.1.5 (February 1, 2015)
+
+Bugfixes:
+
+* Wraith outputs percentages properly
+* Diff data for initial commits
+* More intuitive config path discovery
+* Flip GitControl#diff around for old to new comparison
+* More stability/defensive programming in Config, Wraith, and GitControl
+
+Features:
+
+* Wraith includes images in output
+
 ### 0.1.4 (January 3, 2015)
 
 Bugfixes:

data/lib/maximus/cli.rb

@@ -14,14 +14,14 @@ class Maximus::CLI < Thor
   class_option :filepath, aliases: ['-fp'], type: :array, default: [], desc: "Space-separated path(s) to files"
   class_option :urls, aliases: ['-u'], type: :array, default: ['/'], desc: "Statistics only - Space-separated path(s) to relative URL paths"
   class_option :domain, aliases: ['-d'], type: :string, default: 'http://localhost', desc: "Statistics only - Web address (prepended to paths)"
-  class_option :port, aliases: ['-po'], type: :numeric, default: nil, desc: 'Statistics only - Port to use if required (appended to domain)'
+  class_option :port, aliases: ['-po'], type: :numeric, default: 3000, desc: 'Statistics only - Port to use if required (appended to domain)'
 
   class_option :include, aliases: ['-i'], type: :array, default: [], desc: "Include only specific lints or statistics"
   class_option :exclude, aliases: ['-e'], type: :array, default: [], desc: "Exlude specific lints or statistics"
 
-  class_option :config, aliases: ['-c'], type: :string, default: 'maximus.yml', desc: 'Path to config file'
+  class_option :config, aliases: ['-c'], type: :string, default: nil, desc: 'Path to config file'
 
-  class_option :git, aliases: ['-g', '--sha'], type: :string, default: 'working', banner: "working, last, master, or sha", desc: "Lint by commit or working copy"
+  class_option :git, aliases: ['-g', '--git', '--sha'], type: :string, default: 'working', banner: "working, last, master, or sha", desc: "Lint by commit or working copy"
 
   def initialize(*args)
     super
@@ -31,16 +31,19 @@ class Maximus::CLI < Thor
   desc "frontend", "Execute all front-end tasks"
   def frontend
     ['scsslint', 'jshint'].each { |e| check_exclude(e) }
+    @config.destroy_temp
   end
 
   desc "backend", "Lint with all backend lints"
   def backend
     ['rubocop', 'railsbp', 'brakeman'].each { |e| check_exclude(e) }
+    @config.destroy_temp
   end
 
   desc "statistics", "Run all statistics"
   def statistics
     ['stylestats', 'phantomas', 'wraith'].each { |e| check_exclude(e) }
+    @config.destroy_temp
   end
 
   # Alias ruby to backend
@@ -61,7 +64,8 @@ class Maximus::CLI < Thor
     return options[:include].each { |i| send(i) } unless options[:include].blank?
     # If all flag is not enabled, lint working copy as it's supposed to be
     @config.settings[:commit] = options[:git]
-    return Maximus::GitControl.new({config: @config}).lints_and_stats(true)
+    Maximus::GitControl.new({config: @config}).lints_and_stats(true)
+    @config.destroy_temp
   end
 
   # @todo something better than just installing in the global npm file

data/lib/maximus/config.rb

@@ -1,3 +1,6 @@
+require 'active_support'
+require 'active_support/core_ext/hash/keys'
+
 module Maximus
 
   # Global options and configuration
@@ -27,127 +30,99 @@ module Maximus
     # @option opts [Hash] :paths ({home: '/'}) labeled relative path to URLs. Statistics only
     # @option opts [String] :commit accepts sha, "working", "last", or "master".
     # @option opts [String] :config_file ('maximus.yml') path to config file
-    # @return [#load_config_file #group_families #evaluate_yaml] this method is used to set up instance variables
+    # @option opts [Boolean] :compile_assets (true) compile and destroy assets automagically
+    # @return [#load_config_file #group_families #evaluate_settings] this method is used to set up instance variables
     def initialize(opts = {})
-      opts[:is_dev] ||= false
+
+      default_options = {
+        root_dir: root_dir,
+        domain: 'http://localhost',
+        port: is_rails? ? 3000 : '',
+        paths: { 'home' => '/' },
+        is_dev: false,
+        phantomas: false,
+        stylestats: false,
+        wraith: false
+      }
+
+      yaml = default_options.merge load_config_file(opts[:config_file])
+      @settings = yaml.merge opts
 
       # Only set log file if it's set to true.
       #   Otherwise, allow it to be nil or a path
-      opts[:log] = 'log/maximus.log' if opts[:log].is_a?(TrueClass)
+      @settings[:log] = false if @settings[:log].nil?
+      @settings[:log] ||= 'log/maximus.log' if @settings[:log].is_a?(TrueClass)
 
-      opts[:git_log] = false if opts[:git_log].nil?
-      opts[:git_log] = 'log/maximus_git.log' if opts[:git_log].is_a?(TrueClass)
+      @settings[:git_log] = false if @settings[:git_log].nil?
+      @settings[:git_log] ||= 'log/maximus_git.log' if @settings[:git_log].is_a?(TrueClass)
 
-      # @see Helper#root_dir
-      opts[:root_dir] ||= root_dir
-      opts[:domain] ||= 'http://localhost'
-      opts[:port] ||= is_rails? ? 3000 : ''
-      opts[:paths] ||= { 'home' => '/' }
+      @settings[:compile_assets] = true if @settings[:compile_assets].nil?
 
-      opts[:paths] = parse_cli_config(opts[:paths]) if opts[:paths].is_a?(Array)
+      @settings[:paths] = split_paths(@settings[:paths]) if @settings[:paths].is_a?(Array)
 
-      # What we're really interested in
-      @settings = opts
+      group_families
 
       # Instance variables for Config class only
       @temp_files = {}
-
-      load_config_file(opts[:config_file])
-
-      group_families
-
       # Override options with any defined in a discovered config file
-      evaluate_yaml
+      evaluate_settings
     end
 
     # Set global options or generate appropriate config files for lints or statistics
-    #
-    # @param yaml_data [Hash] (@yaml) loaded data from the discovered maximus config file
+    # @param settings_data [Hash] (@settings) loaded data from the discovered maximus config file
     # @return [Hash] paths to temp config files and static options
     #   These should be deleted with destroy_temp after read and loaded
-    def evaluate_yaml(yaml_data = @yaml)
-      yaml_data.each do |key, value|
-        unless value.is_a?(FalseClass)
-          value = {} if value.is_a?(TrueClass)
-
-          case key
-
-            when 'jshint', 'JSHint', 'JShint'
-
-              # @todo DRY this up, but can't call it at the start because of the
-              #   global config variables (last when statement in this switch)
-              value = load_config(value)
-
-              if yaml_data[key].is_a?(Hash) && yaml_data[key].has_key?['ignore']
-                jshintignore_file = []
-                yaml_data[key]['ignore'].each { |i| jshintignore_file << "#{i}\n" }
-                @settings[:jshintignore] = temp_it('jshintignore.json', jshintignore_file)
-              end
-              @settings[:jshint] = temp_it('jshint.json', value.to_json)
-
-            when 'scsslint', 'scss-lint', 'SCSSlint'
-              value = load_config(value)
-
-              @settings[:scsslint] = temp_it('scsslint.yml', value.to_yaml)
-
-            when 'rubocop', 'Rubocop', 'RuboCop'
-              value = load_config(value)
-
-              @settings[:rubocop] = temp_it('rubocop.yml', value.to_yaml)
-
-            when 'brakeman'
-              @settings[:brakeman] = yaml_data[key]
-
-            when 'rails_best_practice', 'railsbp'
-              @settings[:railsbp] = yaml_data[key]
-
-            when 'stylestats', 'Stylestats'
-              value = load_config(value)
-              @settings[:stylestats] = temp_it('stylestats.json', value.to_json)
-
-            when 'phantomas', 'Phantomas'
-              value = load_config(value)
-              @settings[:phantomas] = temp_it('phantomas.json', value.to_json)
-
-            when 'wraith', 'Wraith'
-              value = load_config(value)
-
-              @settings[:wraith] = {}
-              if value.include?('browser')
-                value['browser'].each do |browser, browser_value|
-                  unless browser_value.is_a?(FalseClass)
-                    new_data = {}
-                    new_data['browser'] = []
-                    new_data['browser'] << { browser.to_s => browser.to_s }
-
-                    # Regardless of what's in the config, override with maximus,
-                    #   predictable namespacing
-                    new_data['directory'] = "maximus_wraith_#{browser}"
-                    new_data['history_dir'] = "maximus_wraith_history_#{browser}"
-
-                    # @todo a snap file cannot be set in the config
-                    snap_file = case browser
-                      when 'casperjs' then 'casper'
-                      when 'nojs' then 'nojs'
-                      else 'snap'
-                    end
-                    new_data['snap_file'] = File.join(File.dirname(__FILE__), "config/wraith/#{snap_file}.js")
-
-                    @settings[:wraith][browser.to_sym] = wraith_setup(new_data, "wraith_#{browser}")
-                  end
-                end
-              else
-                value['browser'] = { 'phantomjs' => 'phantomjs' }
-                value['directory'] = 'maximus_wraith_phantomjs'
-                value['history_dir'] = 'maximus_wraith_history_phantomjs'
-                value['snap_file'] = File.join(File.dirname(__FILE__), "config/wraith/snap.js")
-                @settings[:wraith][:phantomjs] = wraith_setup(value)
-              end
-
-            # Configuration important to all of maximus
-            when 'is_dev', 'log', 'root_dir', 'domain', 'port', 'paths', 'commit'
-              @settings[key.to_sym] = yaml_data[key]
-          end
+    def evaluate_settings(settings_data = @settings)
+      settings_data.each do |key, value|
+        next if value.is_a?(FalseClass)
+        value = {} if value.is_a?(TrueClass)
+
+        case key
+
+          when :jshint, :JSHint, :JShint
+
+            # @todo DRY this load_config up, but can't call it at the start because of the
+            #   global config variables (last when statement in this switch)
+            value = load_config(value)
+
+            if settings_data[key].is_a?(Hash) && settings_data[key].has_key?('jshintignore')
+              jshintignore_file = []
+              settings_data[key]['jshintignore'].each { |i| jshintignore_file << "#{i}\n" }
+              @settings[:jshintignore] = temp_it('jshintignore.json', jshintignore_file)
+            end
+            @settings[:jshint] = temp_it('jshint.json', value.to_json)
+
+          when :scsslint, :SCSSlint
+            value = load_config(value)
+
+            @settings[:scsslint] = temp_it('scsslint.yml', value.to_yaml)
+
+          when :rubocop, :Rubocop, :RuboCop
+            value = load_config(value)
+
+            @settings[:rubocop] = temp_it('rubocop.yml', value.to_yaml)
+
+          when :brakeman
+            @settings[:brakeman] = settings_data[key]
+
+          when :rails_best_practice, :railsbp
+            @settings[:railsbp] = settings_data[key]
+
+          when :stylestats, :Stylestats
+            value = load_config(value)
+            @settings[:stylestats] = temp_it('stylestats.json', value.to_json)
+
+          when :phantomas, :Phantomas
+            value = load_config(value)
+            @settings[:phantomas] = temp_it('phantomas.json', value.to_json)
+
+          when :wraith, :Wraith
+            value = load_config(value)
+            evaluate_for_wraith(value)
+
+          # Configuration important to all of maximus
+          when :is_dev, :log, :root_dir, :domain, :port, :paths, :commit
+            @settings[key] = settings_data[key]
         end
       end
 
@@ -175,17 +150,23 @@ module Maximus
 
     # Remove all or one created temporary config file
     # @see temp_it
-    # @param filename [String] file to destroy
-    def destroy_temp(filename)
-      return if @temp_files[filename.to_sym].blank?
-      @temp_files[filename.to_sym].unlink
-      @temp_files.delete(filename.to_sym)
+    # @param filename [String] (nil) file to destroy
+    #   If nil, destroy all temp files
+    def destroy_temp(filename = nil)
+      if filename.nil?
+        @temp_files.each { |filename, file| file.unlink }
+        @temp_files = {}
+      else
+        return if @temp_files[filename.to_sym].blank?
+        @temp_files[filename.to_sym].unlink
+        @temp_files.delete(filename.to_sym)
+      end
     end
 
     # Combine domain with port if necessary
     # @return [String] complete domain/host address
     def domain
-      (!@settings[:port].blank? || @settings[:domain].include?(':')) ? "#{@settings[:domain]}:#{@settings[:port]}" : @settings[:domain]
+      (!@settings[:port].blank?) ? "#{@settings[:domain]}:#{@settings[:port]}" : @settings[:domain]
     end
 
 
@@ -193,44 +174,41 @@ module Maximus
 
       # Look for a maximus config file
       #
-      # Checks ./maximus.yml, ./maximus.yaml, ./config/maximus.yaml in order.
+      # Checks ./maximus.yml, ./.maximus.yml, ./config/maximus.yml in order.
       #   If there hasn't been a file discovered yet, checks ./config/maximus.yml
       #   and if there still isn't a file, load the default one included with the
       #   maximus gem.
       #
       # @since 0.1.4
       # @param file_path [String]
-      # @return @yaml [Hash]
+      # @return @settings [Hash]
       def load_config_file(file_path)
 
         conf_location = if !file_path.nil? && File.exist?(file_path)
           file_path
         else
-          config_exists('maximus.yml') || config_exists('maximus.yaml') || config_exists('config/maximus.yaml') || check_default_config_path('maximus.yml')
+          config_exists('.maximus.yml') || config_exists('maximus.yml') || check_default_config_path('config/maximus.yml')
         end
 
-        @yaml = YAML.load_file(conf_location)
+        yaml = YAML.load_file(conf_location)
 
-        # Match defaults
-        @yaml['domain'] ||= @settings[:domain]
-        @yaml['paths'] ||= @settings[:paths]
-        @yaml['port'] ||= @settings[:port]
+        yaml.symbolize_keys
 
       end
 
       # Allow shorthand to be declared for groups Maximus executions
       #
       # @example disable statistics
-      #   @yaml['statistics'] = false
+      #   @settings[:statistics] = false
       #   set_families('statistics', ['phantomas', 'stylestats', 'wraith'])
       #
       # Sets as Boolean based on whether or not the queried label is `true`
-      # @param head_of_house [String] @yaml key and group label
-      # @param family [Array] group of other @yaml keys to be disabled
-      # @return [void] modified @yaml
+      # @param head_of_house [String] @settings key and group label
+      # @param family [Array] group of other @settings keys to be disabled
+      # @return [void] modified @settings
       def set_families(head_of_house, family)
-        if @yaml.has_key?(head_of_house)
-          family.each { |f| @yaml[f] = @yaml[head_of_house].is_a?(TrueClass) }
+        if @settings.has_key?(head_of_house)
+          family.each { |f| @settings[f] ||= @settings[head_of_house].is_a?(TrueClass) }
         end
       end
 
@@ -259,9 +237,11 @@ module Maximus
       # @return [String] absolute path to new config file
       def temp_it(filename, data)
         ext = filename.split('.')
-        file = Tempfile.new([filename, ".#{ext[1]}"])
-        file.write(data)
-        file.close
+        file = Tempfile.new([filename, ".#{ext[1]}"]).tap do |f|
+          f.rewind
+          f.write(data)
+          f.close
+        end
         @temp_files[ext[0].to_sym] = file
         file.path
       end
@@ -282,7 +262,7 @@ module Maximus
       # @since 0.1.4
       # @param paths [Array]
       # @return [Hash]
-      def parse_cli_config(paths)
+      def split_paths(paths)
         new_paths = {}
         paths.each do |p|
           if p.split('/').length > 1
@@ -298,44 +278,76 @@ module Maximus
       # @since 0.1.4
       # @todo the command line options are overriden here and it should be the other way around
       def group_families
-        set_families('lints', ['jshint', 'scsslint', 'rubocop', 'brakeman', 'railsbp'])
-        set_families('frontend', ['jshint', 'scsslint', 'phantomas', 'stylestats', 'wraith'])
-        set_families('backend', ['rubocop', 'brakeman', 'railsbp'])
-        set_families('ruby', ['rubocop', 'brakeman', 'railsbp'])
-        set_families('statistics', ['phantomas', 'stylestats', 'wraith'])
-        set_families('all', ['lints', 'statistics'])
+        set_families(:lints, [:jshint, :scsslint, :rubocop, :brakeman, :railsbp])
+        set_families(:frontend, [:jshint, :scsslint, :phantomas, :stylestats, :wraith])
+        set_families(:backend, [:rubocop, :brakeman, :railsbp])
+        set_families(:ruby, [:rubocop, :brakeman, :railsbp])
+        set_families(:statistics, [:phantomas, :stylestats, :wraith])
+        set_families(:all, [:lints, :statistics])
       end
 
       # Wraith is a complicated gem with significant configuration
-      #
-      # @see yaml_evaluate
-      # @see temp_it
-      #
+      # @see yaml_evaluate, temp_it
       # @param value [Hash] modified data from a wraith config or injected data
       # @param name [String] ('wraith') config file name to write and eventually load
       # @return [String] temp file path
       def wraith_setup(value, name = 'phantomjs')
 
-        if @yaml.include?('urls')
-          value['domains'] = yaml_data['urls']
+        if @settings.has_key?(:urls)
+          value['domains'] = @settings[:urls]
         else
           value['domains'] = {}
           # @see #domain
           value['domains']['main'] = domain
         end
 
+        # Set wraith defaults unless they're already defined
         # Wraith requires this screen_width config to be present
-        value['screen_widths'] ||= [767, 1024, 1280]
-
-        value['paths'] = @yaml['paths']
+        value['screen_widths'] ||= [1280, 1024, 767]
+        value['fuzz'] ||= '20%'
         value['threshold'] ||= 0
 
-        # Wraith requires config files have .yaml extensions
-        # https://github.com/BBC-News/wraith/blob/2aff771eba01b76e61600cccb2113869bfe16479/lib/wraith/wraith.rb
-        file = Tempfile.new([name, '.yaml'])
-        file.write(value.to_yaml)
-        file.close
-        file.path
+        value['paths'] = @settings[:paths]
+        temp_it("#{name}.yaml", value.to_yaml)
+      end
+
+      # Apply wraith defaults/merge existing config
+      # @since 0.1.5
+      # @see yaml_evaluate
+      # @param value [Hash]
+      def evaluate_for_wraith(value)
+        @settings[:wraith] = {}
+
+        if value.include?('browser')
+          value['browser'].each do |browser, browser_value|
+            next if browser_value.is_a?(FalseClass)
+
+            # @todo a snap file cannot be set in the config
+            snap_file = case browser
+              when 'casperjs' then 'casper'
+              when 'nojs' then 'nojs'
+              else 'snap'
+            end
+
+            new_data = {
+              'browser' => [{ browser.to_s => browser.to_s }],
+              'directory' => "maximus_wraith_#{browser}",
+              'history_dir' => "maximus_wraith_history_#{browser}",
+              'snap_file' => File.join(File.dirname(__FILE__), "config/wraith/#{snap_file}.js")
+            }
+
+            @settings[:wraith][browser.to_sym] = wraith_setup(new_data, "maximus_wraith_#{browser}")
+          end
+        else
+          append_value = {
+            'browser' => { 'phantomjs' => 'phantomjs' },
+            'directory' => 'maximus_wraith_phantomjs',
+            'history_dir' => 'maximus_wraith_history_phantomjs',
+            'snap_file' => File.join(File.dirname(__FILE__), "config/wraith/snap.js")
+          }
+          @settings[:wraith][:phantomjs] = wraith_setup value.merge(append_value)
+        end
+
       end
 
   end