maximus 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dfcfe18a00fe7415422140b106609c011870cea5
-  data.tar.gz: db6a33810bb07a2fe58f0e29e9dd9e59f4c48e3e
+  metadata.gz: 8843e2de02ffdfdbe667056bbb99a3a346a6c2aa
+  data.tar.gz: 4d60b2e41051e130c5d6749c584430f6d3d49681
 SHA512:
-  metadata.gz: cfef49478e9d9f9b994c80f77ab9c987963b6f396828023b9e99902254d03b2382b56755d8929ba96154cb41f0571e5b9474a66ea9378788c314f63f1e6c03c7
-  data.tar.gz: 2d38e52edb5a2cc6850d7f303d86d87d48a1e9f6c98237aed90f0a31b478c42a598549fa0f6d0164de2c0912abcdc253caf1b8fe084bb2d68b4f3056f8a70668
+  metadata.gz: 6bfa472047e078d6d46220e88a5e0fe2f350ddc321c39c4967d89c5e0015b1da40af853448501966bc197abe1238e3d0e2791ecaface6bc08c8755b24049c3bc
+  data.tar.gz: 4d41a262ca94d0dc8444b8ce2a4d43978ae4945010ecc2ac670519dcddb375a0af61f4baa903042d77bdf54c3bb53271cb24d15efd46528791ab72ba6b699c73

data/.gitignore

@@ -20,3 +20,6 @@ tmp
 *.o
 *.a
 mkmf.log
+# generated spec config files
+spec/.maximus.yml
+.maximus.yml

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,10 @@
+sudo: false
+cache: bundler
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1
+install:
+  - bundle install --retry=3
+script:
+  - bundle exec rspec

data/README.md

@@ -1,6 +1,6 @@
 # Maximus
 
-[![Gem Version](https://badge.fury.io/rb/maximus.svg)](http://badge.fury.io/rb/maximus) [![Code Climate](https://codeclimate.com/github/wearefine/maximus/badges/gpa.svg)](https://codeclimate.com/github/wearefine/maximus)
+[![Gem Version](https://badge.fury.io/rb/maximus.svg)](http://badge.fury.io/rb/maximus) [![Code Climate](https://codeclimate.com/github/wearefine/maximus/badges/gpa.svg)](https://codeclimate.com/github/wearefine/maximus) [![Build Status](https://travis-ci.org/wearefine/maximus.svg)](https://travis-ci.org/wearefine/maximus) [![Inline docs](http://inch-ci.org/github/wearefine/maximus.svg?branch=master&style=flat)](http://inch-ci.org/github/wearefine/maximus)
 
 The all-in-one linting solution.
 
@@ -12,13 +12,23 @@ Plays nice with Middleman and Rails.
 * Elsewhere/command line: `gem install maximus`
 * Globally with RVM (~/.rvm/gemsets/global.gems): `maximus` 
 
-Maximus has several node dependencies that can be installed with a `npm install -g jshint phantomas stylestats` or a `maximus install` once the gem is successfully installed.
+Maximus has several node dependencies that can be installed via the command line:
+
+```bash
+$ npm install -g jshint phantomas stylestats
+```
+
+or once the gem is successfully installed:
+
+```bash
+$ maximus install
+```
 
 ## Config
 
 Lints and statistics can be configured turned on or off with a  `maximus.yml` file in the root directory maximus is being called in. `config/maximus.yml` will be checked if a config file isn't found in the root, and if there's still no luck, [the default config](lib/maximus/config/maximus.yml) will be loaded.
 
-Parent options are identical to the [command line flags](#command-line-flags) with the exception of `include` and `exclude`.
+Parent options are identical to the [command line flags](#flags) with the exception of `include` and `exclude`.
 
 ```yaml
 domain: 'http://localhost'
@@ -61,12 +71,14 @@ lints: true # all lints including brakeman will run
 
 ### [Sample Config](lib/maximus/config/maximus-example.yml)
 
-## Command Line Flags
+## Command Line
+
+### Flags
 
 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 URL paths
+`-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)
 `-f`/`--frontend`   | Boolean/Blank                    | Run all front-end lints
@@ -75,14 +87,14 @@ Flag                | Accepts                          | Description
 `-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, working copy (`working`, default), the last commit (`last` or `HEAD^`), or the master branch (`master`)
+`-git`/`--sha`      | String                           | Run maximus based on a git commit. See [below](#git-examples)
 `-c`/`--config`     | String                           | Path to config file
 
 
 * Lint tasks can accept glob notation, i.e. `**/*.scss`
 * Arrays are space-separated, i.e. `--urls=/ /about`
 
-## Command Line Commands
+### Commands
 
 Command               | Description
 ----------------------|---------------------------
@@ -91,24 +103,24 @@ Command               | Description
 `backend`             | Runs all back-end lints
 `statistics`          | Runs all statistics
 
-### Examples
+### Git Examples
+
+`$ maximus -g working` 
 
 Default. Lints based on your working directory
 
-`maximus -g working` 
+`$ maximus -g last` 
 
 Lints based on the previous commit by `HEAD^`
 
-`maximus -g last` 
+`$ maximus -g master`
 
 Lints based on the commit on the master branch
 
-`maximus -g master`
+`$ maximus -g d96a8e23`
 
 Lints based on commit d96a8e23
 
-`maximus -g d96a8e23`
-
 ## Lint syntax
 
 When adding new lints, the JSON output should obey the following format:
@@ -125,7 +137,16 @@ When adding new lints, the JSON output should obey the following format:
 
 ## Changelog
 
-### 0.1.3
+### 0.1.4 (January 3, 2015)
+
+Bugfixes:
+
+* Added basic tests
+* Modified git-lines to show unified=1 instead of unified=0
+* Remove tmp files error
+* Better documentation to README
+
+### 0.1.3 (December 22, 2014)
 
 Features:
 

data/lib/maximus/cli.rb

@@ -1,5 +1,6 @@
 require 'thor'
 
+# Command line abilities
 # @since 0.1.0
 class Maximus::CLI < Thor
 

data/lib/maximus/config.rb

@@ -1,4 +1,6 @@
 module Maximus
+
+  # Global options and configuration
   # @since 0.1.3
   # @attr_reader settings [Hash] all the options
   # @attr_reader temp_files [Hash] Filename without extension => path to temp file
@@ -25,7 +27,7 @@ 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 [void] this method is used to set up instance variables
+    # @return [#load_config_file #group_families #evaluate_yaml] this method is used to set up instance variables
     def initialize(opts = {})
       opts[:is_dev] ||= false
 
@@ -42,18 +44,7 @@ module Maximus
       opts[:port] ||= is_rails? ? 3000 : ''
       opts[:paths] ||= { 'home' => '/' }
 
-      # Accounting for space-separated command line arrays
-      if opts[:paths].is_a?(Array)
-        new_paths = {}
-        opts[:paths].each do |p|
-          if p.split('/').length > 1
-            new_paths[p.split('/').last.to_s] = p
-          else
-            new_paths['home'] = '/'
-          end
-        end
-        opts[:paths] = new_paths
-      end
+      opts[:paths] = parse_cli_config(opts[:paths]) if opts[:paths].is_a?(Array)
 
       # What we're really interested in
       @settings = opts
@@ -61,20 +52,9 @@ module Maximus
       # Instance variables for Config class only
       @temp_files = {}
 
-      conf_location = (opts[:config_file] && File.exist?(opts[:config_file])) ? opts[:config] : find_config
-
-      @yaml = YAML.load_file(conf_location)
+      load_config_file(opts[:config_file])
 
-      # Match defaults
-      @yaml['domain'] ||= @settings[:domain]
-      @yaml['paths'] ||= @settings[:paths]
-      @yaml['port'] ||= @settings[:port]
-      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'])
+      group_families
 
       # Override options with any defined in a discovered config file
       evaluate_yaml
@@ -175,13 +155,14 @@ module Maximus
       @settings
     end
 
+    # If output should be returned to console
+    #   in a pretty display
     # @return [Boolean]
     def is_dev?
       @settings[:is_dev]
     end
 
     # Defines base logger
-    #
     # @param out [String, STDOUT] location for logging
     #   Accepts file path
     # @return [Logger] self.log
@@ -193,26 +174,15 @@ module Maximus
     end
 
     # Remove all or one created temporary config file
-    #
-    # @see #temp_it
-    # @see #yaml_evaluate
-    #
-    # @param filename [String] (nil) file to destroy
-    #   If nil, destroy all temp files
-    # @return [void]
-    def destroy_temp(filename = nil)
+    # @see temp_it
+    # @param filename [String] file to destroy
+    def destroy_temp(filename)
       return if @temp_files[filename.to_sym].blank?
-      if filename.nil?
-        @temp_files.each { |filename, file| file.unlink }
-        @temp_files = {}
-      else
-        @temp_files[filename.to_sym].unlink
-        @temp_files.delete(filename.to_sym)
-      end
+      @temp_files[filename.to_sym].unlink
+      @temp_files.delete(filename.to_sym)
     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]
@@ -221,109 +191,152 @@ module Maximus
 
     private
 
-    # Allow shorthand to be declared for groups Maximus executions
-    #
-    # @example disable statistics
-    #   @yaml['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
-    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) }
+      # Look for a maximus config file
+      #
+      # Checks ./maximus.yml, ./maximus.yaml, ./config/maximus.yaml 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]
+      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')
+        end
+
+        @yaml = YAML.load_file(conf_location)
+
+        # Match defaults
+        @yaml['domain'] ||= @settings[:domain]
+        @yaml['paths'] ||= @settings[:paths]
+        @yaml['port'] ||= @settings[:port]
+
       end
-    end
 
-    # Load config files if filename supplied
-    #
-    # @param value [Mixed] value from base config file
-    # @param [Hash] return blank hash if file not found so
-    #   the reset of the process doesn't break
-    def load_config(value)
-      return value unless value.is_a?(String)
-      if File.exist?(value)
-        return YAML.load_file(value)
-      else
-        puts "#{value} not found"
-        return {}
+      # Allow shorthand to be declared for groups Maximus executions
+      #
+      # @example disable statistics
+      #   @yaml['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
+      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) }
+        end
       end
-    end
 
-    # Create a temp file with config data
-    #
-    # Stores all temp files in @temp_files or self.temp_files
-    #   In Hash with filename minus extension as the key.
-    #
-    # @param filename [String] the preferred name/identifier of the file
-    # @param data [Mixed] config data important to each lint or statistic
-    # @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
-      @temp_files[ext[0].to_sym] = file
-      file.path
-    end
+      # Load config files if filename supplied
+      #
+      # @param value [Mixed] value from base config file
+      # @param [Hash] return blank hash if file not found so
+      #   the reset of the process doesn't break
+      def load_config(value)
+        return value unless value.is_a?(String)
+        if File.exist?(value)
+          return YAML.load_file(value)
+        else
+          puts "#{value} not found"
+          return {}
+        end
+      end
 
-    # Look for a maximus config file
-    #
-    # Checks ./maximus.yml, ./maximus.yaml, ./config/maximus.yaml 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.
-    #
-    # @return [String] absolute path to config file
-    def find_config
-      config_exists('maximus.yml') || config_exists('maximus.yaml') || config_exists('config/maximus.yaml') || check_default_config_path('maximus.yml')
-    end
+      # Create a temp file with config data
+      #
+      # Stores all temp files in @temp_files or self.temp_files
+      #   In Hash with filename minus extension as the key.
+      #
+      # @param filename [String] the preferred name/identifier of the file
+      # @param data [Mixed] config data important to each lint or statistic
+      # @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
+        @temp_files[ext[0].to_sym] = file
+        file.path
+      end
 
-    # See if a config file exists
-    #
-    # @see #find_config
-    #
-    # This is used exclusively for the find_config method
-    # @param file [String] file name
-    # @return [String, FalseClass] if file is found return the absolute path
-    #   otherwise return false so we can keep checking
-    def config_exists(file)
-      File.exist?(File.join(File.dirname(__FILE__), file)) ? File.join(File.dirname(__FILE__), file) : false
-    end
+      # See if a config file exists
+      #
+      # @see load_config_file
+      #
+      # This is used exclusively for the load_config_file method
+      # @param file [String] file name
+      # @return [String, FalseClass] if file is found return the absolute path
+      #   otherwise return false so we can keep checking
+      def config_exists(file)
+        File.exist?(File.join(File.dirname(__FILE__), file)) ? File.join(File.dirname(__FILE__), file) : false
+      end
 
-    # Wraith is a complicated gem with significant configuration
-    #
-    # @see #yaml_evaluate
-    # @see #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']
-      else
-        value['domains'] = {}
-        # @see #domain
-        value['domains']['main'] = domain
+      # Accounting for space-separated command line arrays
+      # @since 0.1.4
+      # @param paths [Array]
+      # @return [Hash]
+      def parse_cli_config(paths)
+        new_paths = {}
+        paths.each do |p|
+          if p.split('/').length > 1
+            new_paths[p.split('/').last.to_s] = p
+          else
+            new_paths['home'] = '/'
+          end
+        end
+        new_paths
       end
 
-      # Wraith requires this screen_width config to be present
-      value['screen_widths'] ||= [767, 1024, 1280]
+      # Group families of extensions
+      # @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'])
+      end
 
-      value['paths'] = @yaml['paths']
-      value['threshold'] ||= 0
+      # Wraith is a complicated gem with significant configuration
+      #
+      # @see yaml_evaluate
+      # @see 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']
+        else
+          value['domains'] = {}
+          # @see #domain
+          value['domains']['main'] = domain
+        end
 
-      # 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
-    end
+        # Wraith requires this screen_width config to be present
+        value['screen_widths'] ||= [767, 1024, 1280]
+
+        value['paths'] = @yaml['paths']
+        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
+      end
 
   end
 end