maximus 0.1.4 → 0.1.5

data/lib/maximus/config/maximus.yml

@@ -1,2 +1,60 @@
-lints: true
-statistics: true
+paths:
+  home: '/'
+
+scsslint: true
+
+rubocop: true
+
+railsbp: true
+
+brakeman: true
+
+jshint:
+  browser: true
+  esnext: true
+  globals: {}
+  globalstrict: true
+  undef: true
+  unused: true
+  jquery: true
+
+phantomas:
+  block-domain: 'google-analytics.com'
+  skip-modules:
+    - 'Caching'
+    - 'localStorage'
+    - 'Cookies'
+    - 'assetsWithQueryString'
+    - 'nodesWithInlineCSS'
+
+stylestats:
+  published: false
+  paths: false
+  stylesheets: false
+  styleElements: true
+  size: true
+  dataUriSize: true
+  ratioOfDataUriSize: true
+  gzippedSize: false
+  simplicity: true
+  rules: true
+  selectors: true
+  mostIdentifier: true
+  mostIdentifierSelector: true
+  lowestCohesion: true
+  lowestCohesionSelector: true
+  totalUniqueFontSizes: true
+  uniqueFontSize: true
+  totalUniqueColors: true
+  uniqueColor: true
+  idSelectors: true
+  universalSelectors: true
+  unqualifiedAttributeSelectors: true
+  javascriptSpecificSelectors: "[#\\.]js\\-"
+  importantKeywords: true
+  floatProperties: true
+  mediaQueries: true
+  propertiesCount: 10
+  requestOptions: {}
+
+wraith: true

data/lib/maximus/config/wraith/nojs.js

@@ -1,3 +1,5 @@
+/*global phantom */
+
 var system = require('system');
 var page = require('webpage').create();
 var fs = require('fs');
@@ -25,7 +27,7 @@ page.settings.userAgent = 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_8_2) AppleW
 // page.customHeaders = {
 
 //      'X-Candy-OVERRIDE': 'https://api.live.bbc.co.uk/'
- 
+
 //  };
 
 // If you want to set a cookie, just add your details below in the following way.

data/lib/maximus/config/wraith/snap.js

@@ -1,3 +1,5 @@
+/*global phantom */
+
 var system = require('system');
 var page = require('webpage').create();
 var fs = require('fs');
@@ -25,7 +27,7 @@ page.settings.userAgent = 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_8_2) AppleW
 // page.customHeaders = {
 
 //      'X-Candy-OVERRIDE': 'https://api.live.bbc.co.uk/'
- 
+
 //  };
 
 // If you want to set a cookie, just add your details below in the following way.

data/lib/maximus/git_control.rb

@@ -14,18 +14,29 @@ module Maximus
     # @option opts [String] :commit accepts sha, "working", "last", or "master".
     def initialize(opts = {})
       opts[:config] ||= Maximus::Config.new({ commit: opts[:commit] })
-      @config ||= opts[:config]
-      @settings ||= @config.settings
-      @psuedo_commit = (!@settings[:commit].blank? && (@settings[:commit] == 'working' || @settings[:commit] == 'last' || @settings[:commit] == 'master') )
-      @g = Git.open(@settings[:root_dir], :log => @settings[:git_log])
+      @config = opts[:config]
+
+      @settings = @config.settings
+      @psuedo_commit = ( !@settings[:commit].blank? && %w(working last master).include?(@settings[:commit]) )
+
+      @g = Git.open(@settings[:root_dir])
     end
 
     # 30,000 foot view of a commit
-    # @param commit_sha [String] the sha of the commit
+    # @param commit_sha [String] (head_sha) the sha of the commit
     # @return [Hash] commit data
-    def commit_export(commit_sha = sha)
-      ce_commit = vccommit(commit_sha)
-      ce_diff = diff(ce_commit, @g.object('HEAD^'))
+    def commit_export(commit_sha = head_sha)
+      commit_sha = commit_sha.to_s
+
+      ce_commit = @g.gcommit(commit_sha)
+
+      if first_commit == commit_sha
+        ce_diff = diff_initial(first_commit)
+      else
+        last_commit = @g.gcommit(previous_commit(commit_sha))
+        ce_diff = diff(last_commit, ce_commit)
+      end
+
       {
         commit_sha: commit_sha,
         branch: branch,
@@ -52,58 +63,23 @@ module Maximus
     #       }
     #     }
     #   }
-    #
+    # @param sha1 [String]
+    # @param sha2 [String]
     # @return [Hash] diff_return files changed grouped by file extension and line number
-    def compare(sha1 = master_commit.sha, sha2 = sha)
+    def compare(sha1 = master_commit.sha, sha2 = head_sha)
       diff_return = {}
 
-      if @settings[:commit]
-        sha1 = case @settings[:commit]
-          when 'master' then master_commit.sha
-          when 'last' then @g.object('HEAD^').sha
-          when 'working' then 'working'
-          else @settings[:commit]
-        end
-      end
-
-      # If working directory, just have a single item array.
-      #   The space here is important because git-lines checks for a second arg,
-      #   and if one is present, it runs git diff without a commit
-      #   or a comparison to a commit.
-      git_diff = @psuedo_commit ? ["git #{sha1}"] : `git rev-list #{sha1}..#{sha2} --no-merges`.split("\n")
-
-      # Include the first sha because rev-list is doing a traversal
-      # So sha1 is never included
-      git_diff << sha1 unless @psuedo_commit
-
+      sha1 = set_psuedo_commit if @settings[:commit]
       # Reverse so that we go in chronological order
-      git_diff.reverse.each do |git_sha|
-        new_lines = lines_added(git_sha)
+      git_spread = commit_range(sha1, sha2).reverse
 
-        # Grab all files in that commit and group them by extension
-        # If working copy, just give the diff names of the files changed
-        files = @psuedo_commit ? `git diff --name-only` : `git show --pretty="format:" --name-only #{git_sha}`
-        files = files.split("\n").group_by { |f| f.split('.').pop }
+      git_spread.each do |git_sha|
 
-        # Don't worry about files that we don't have a lint or a statistic for
-        flat_associations = associations.clone.flatten(2)
-        files.delete_if { |k,v| !flat_associations.include?(k) || k.nil? }
+        # Grab all files in that commit and group them by extension
+        #   If working copy, just give the diff names of the files changed
+        files = @psuedo_commit ? `git -C #{@settings[:root_dir]} diff --name-only` : `git -C #{@settings[:root_dir]} show --pretty="format:" --name-only #{git_sha}`
 
-        associations.each do |ext, related|
-          files[ext] ||= []
-          related.each do |child|
-            unless files[child].blank?
-              files[child].each do |c|
-                # hack to ignore deleted files
-                files[child] = new_lines[c].blank? ? [] : [ filename: "#{@settings[:root_dir]}/#{c}", changes: new_lines[c] ]
-              end
-              files[ext].concat(files[child])
-              files.delete(child)
-            end
-          end
-        end
-        files.delete_if { |k,v| v.blank? }
-        diff_return[git_sha.to_sym] = files
+        diff_return[git_sha.to_s] = match_associations(git_sha, files)
       end
       diff_return
     end
@@ -124,37 +100,48 @@ module Maximus
     #     'sha'...
     #   }
     #
+    # @see compare
+    # @param lint_by_path [Boolean] only lint by files in git commit and
+    #   not the commit as a whole
+    # @param git_shas [Hash] (#compare) a hash of gitcommit shas
+    #   and relevant file types in the commit
+    # @param nuclear [Boolean] do everything regardless of what's in the commit
     # @return [Hash] data all data grouped by task
-    def lints_and_stats(lint_by_path = false, git_shas = compare)
+    def lints_and_stats(lint_by_path = false, git_shas = compare, nuclear = false)
       return false if git_shas.blank?
       base_branch = branch
       git_output = {}
       git_shas.each do |sha, exts|
-        # @todo better way to silence git, in case there's a real error?
-        quietly { `git checkout #{sha} -b maximus_#{sha}` } unless @psuedo_commit
-        puts sha.to_s.color(:blue) if @config.is_dev?
-        git_output[sha.to_sym] = {
-          lints: {},
-          statistics: {}
-        }
-        lints = git_output[sha.to_sym][:lints]
-        statistics = git_output[sha.to_sym][:statistics]
-        lint_opts = {}
+        create_branch(sha) unless @psuedo_commit
+        sha = sha.to_s
+        puts sha.color(:blue)
+        git_output[sha] = {lints: {}, statistics: {}}
+        lints = git_output[sha][:lints]
+        statistics = git_output[sha][:statistics]
 
         # This is where everything goes down
         exts.each do |ext, files|
+
           # For relevant_lines data
           lint_opts = {
             git_files: files,
-            config: @config
+            config: @config,
+            file_paths: (lint_file_paths(files, ext) if lint_by_path)
           }
-          lint_opts[:file_paths] = lint_file_paths(files, ext) if lint_by_path
-          case ext
-            when :scss
-              lints[:scsslint] = Maximus::Scsslint.new(lint_opts).result
 
-              # Do not run statistics if called from command line
-              if lint_opts[:commit].blank?
+          if nuclear
+            lints[:scsslint] = Maximus::Scsslint.new(lint_opts).result
+            lints[:jshint] = Maximus::Jshint.new(lint_opts).result
+            lints[:rubocop] = Maximus::Rubocop.new(lint_opts).result
+            lints[:railsbp] = Maximus::Railsbp.new(lint_opts).result
+            lints[:brakeman] = Maximus::Brakeman.new(lint_opts).result
+            statistics[:stylestat] = Maximus::Stylestats.new({config: @config}).result
+            statistics[:phantomas] = Maximus::Phantomas.new({config: @config}).result
+            statistics[:wraith] = Maximus::Wraith.new({config: @config}).result
+          else
+            case ext
+              when :scss
+                lints[:scsslint] = Maximus::Scsslint.new(lint_opts).result
 
                 # @todo stylestat is singular here because model name in Rails is singular.
                 #   But adding a .classify when it's converted to a model chops off the end s on 'phantomas',
@@ -164,27 +151,105 @@ module Maximus
                 # @todo double pipe here is best way to say, if it's already run, don't run again, right?
                 statistics[:phantomas] ||= Maximus::Phantomas.new({config: @config}).result
                 statistics[:wraith] ||= Maximus::Wraith.new({config: @config}).result
-              end
-            when :js
-              lints[:jshint] = Maximus::Jshint.new(lint_opts).result
-
-              # Do not run statistics if called from command line
-              if lint_opts[:commit].blank?
+              when :js
+                lints[:jshint] = Maximus::Jshint.new(lint_opts).result
 
                 statistics[:phantomas] ||= Maximus::Phantomas.new({config: @config}).result
 
                 # @todo double pipe here is best way to say, if it's already run, don't run again, right?
                 statistics[:wraith] ||= Maximus::Wraith.new({config: @config}).result
-              end
-            when :ruby
-              lints[:rubocop] = Maximus::Rubocop.new(lint_opts).result
-              lints[:railsbp] ||= Maximus::Railsbp.new(lint_opts).result
-              lints[:brakeman] = Maximus::Brakeman.new(lint_opts).result
-            when :rails
-              lints[:railsbp] ||= Maximus::Railsbp.new(lint_opts).result
+              when :ruby
+                lints[:rubocop] = Maximus::Rubocop.new(lint_opts).result
+                lints[:railsbp] ||= Maximus::Railsbp.new(lint_opts).result
+                lints[:brakeman] = Maximus::Brakeman.new(lint_opts).result
+              when :rails
+                lints[:railsbp] ||= Maximus::Railsbp.new(lint_opts).result
+            end
           end
         end
-        # @todo better way to silence git, in case there's a real error?
+        destroy_branch(base_branch, sha) unless @psuedo_commit
+      end
+      git_output
+    end
+
+    # Find first commit
+    # @since 0.1.5
+    # @return [String]
+    def first_commit
+      `git -C #{@settings[:root_dir]} rev-list --max-parents=0 HEAD`.strip!
+    end
+
+    # Get commit before current
+    # @since 0.1.5
+    # @param current_commit [String] (head_sha) commit to start at
+    # @param previous_by [Integer] (1) commit n commits ago
+    # @return [String]
+    def previous_commit(current_commit = head_sha, previous_by = 1)
+      `git -C #{@settings[:root_dir]} rev-list --max-count=#{previous_by + 1} #{current_commit} --reverse | head -n1`.strip!
+    end
+
+    # Define associations to linters based on file extension
+    # @return [Hash] linters and extension arrays
+    def associations
+      {
+        scss:   ['scss', 'sass'],
+        js:     ['js'],
+        ruby:   ['rb', 'Gemfile', 'lock', 'yml', 'Rakefile', 'ru', 'rdoc', 'rake', 'Capfile'],
+        rails:  ['slim', 'haml', 'jbuilder', 'erb']
+      }
+    end
+
+
+    protected
+
+      # Retrieve shas of all commits to be evaluated
+      # @since 0.1.5
+      #
+      # If working directory, just have a single item array.
+      #   The space here is important because git-lines checks for a second arg,
+      #   and if one is present, it runs git diff without a commit
+      #   or a comparison to a commit.
+      #
+      # Include the first sha because rev-list is doing a traversal
+      #   So sha1 is never included
+      #
+      # @param sha1 [String]
+      # @param sha2 [String]
+      # @return [Array] shas
+      def commit_range(sha1, sha2)
+        git_spread = @psuedo_commit ? "git #{sha1}" : `git -C #{@settings[:root_dir]} rev-list #{sha1}..#{sha2} --no-merges`
+        git_spread = git_spread.nil? ? [] : git_spread.split("\n")
+
+        git_spread << sha1 unless @psuedo_commit
+        git_spread
+      end
+
+      # Get sha if words passed for :commit config option
+      # @since 0.1.5
+      # @return [String] commit sha
+      def set_psuedo_commit
+        case @settings[:commit]
+          when 'master' then master_commit.sha
+          when 'last' then previous_commit(head_sha)
+          when 'working' then 'working'
+          else @settings[:commit]
+        end
+      end
+
+      # Create branch to run report on
+      # @todo better way to silence git, in case there's a real error?
+      # @since 0.1.5
+      # @param sha [String]
+      def create_branch(sha)
+        quietly { `git -C #{@settings[:root_dir]} checkout #{sha} -b maximus_#{sha}` }
+      end
+
+      # Destroy created branch
+      # @todo better way to silence git, in case there's a real error?
+      # @since 0.1.5
+      # @param base_branch [String] branch we started on
+      # @param sha [String] used to check against created branch name
+      def destroy_branch(base_branch, sha)
         quietly {
           if base_branch == "maximus_#{sha}"
             @g.branch('master').checkout
@@ -192,16 +257,10 @@ module Maximus
             @g.branch(base_branch).checkout
           end
           @g.branch("maximus_#{sha}").delete
-        } unless @psuedo_commit
+        }
       end
-      git_output
-    end
-
-
-    protected
 
       # Get list of file paths
-      #
       # @param files [Hash] hash of files denoted by key 'filename'
       # @param ext [String] file extension - different extensions are joined different ways
       # @return [String] file paths delimited by comma or space
@@ -214,19 +273,17 @@ module Maximus
       # Determine which lines were added (where and how many) in a commit
       #
       # @example output from method
-      #   {
-      #     'filename': [
+      #   { 'filename': [
       #       '0..10',
       #       '11..14'
-      #     ]
-      #   }
+      #    ] }
       #
       # @param git_sha [String] sha of the commit
       # @return [Hash] ranges by lines added in a commit by file name
       def lines_added(git_sha)
         new_lines = {}
-        lines_added = `#{File.join(File.dirname(__FILE__), 'reporter/git-lines.sh')} #{git_sha}`.split("\n")
-        lines_added.each do |filename|
+        git_lines = `#{File.join(File.dirname(__FILE__), 'reporter/git-lines.sh')} #{@settings[:root_dir]} #{git_sha}`.split("\n")
+        git_lines.each do |filename|
           fsplit = filename.split(':')
           # if file isn't already part of the array
           new_lines[fsplit[0]] ||= []
@@ -240,7 +297,7 @@ module Maximus
 
       # Get last commit on current branch
       # @return [String] sha
-      def sha
+      def head_sha
         @g.object('HEAD').sha
       end
 
@@ -256,42 +313,90 @@ module Maximus
         @g.branches[:master].gcommit
       end
 
-      # Store last commit as Ruby Git::Object
-      # @param commit_sha [String]
-      # @return [Git::Object]
-      def vccommit(commit_sha = sha)
-        @g.gcommit(commit_sha)
-      end
-
       # Get general stats of commit on HEAD versus last commit on master branch
       # @modified 0.1.4
-      # @param new_commit [Git::Object]
       # @param old_commit [Git::Object]
+      # @param new_commit [Git::Object]
       # @return [Git::Diff] hash of abbreviated, useful stats with added lines
-      def diff(new_commit = vccommit, old_commit = master_commit)
-        stats = @g.diff(new_commit, old_commit).stats
-        return if lines.blank? || diff.blank?
+      def diff(old_commit, new_commit)
+        stats = @g.diff(old_commit, new_commit).stats
+        lines = lines_added(new_commit.sha)
+        return if !lines.is_a?(Hash) || stats.blank?
         lines.each do |filename, filelines|
           stats[:files][filename][:lines_added] = filelines if stats[:files].has_key?(filename)
         end
         stats
       end
 
+      # Get diff stats on just the initial commit
+      # Ruby-git doesn't support this well
+      # @see diff
+      # @since 0.1.5
+      # @param commit_sha [String]
+      # @return [Hash] stat data similar to Ruby-git's Diff.stats return
+      def diff_initial(commit_sha)
+        # Start after the commit information
+        data = `git -C #{@settings[:root_dir]} log --numstat --oneline #{commit_sha}`.split("\n")[1..-1]
+        value = {
+          total: {
+            insertions: 0,
+            deletions: 0,
+            lines: 0,
+            files: data.length
+          },
+          files: {}
+        }
+        data.each do |d|
+          item = d.split("\t")
+          insertions = item[0].to_i
+          value[:total][:insertions] += insertions
+          value[:total][:lines] += insertions
+          value[:files][item[2]] = {
+            insertions: insertions,
+            deletions: 0,
+            lines_added: ["0..#{item[0]}"]
+          }
+        end
+        value
+      end
+
       # Get remote URL
       # @return [String, nil] nil returns if remotes is blank
       def remote
         @g.remotes.first.url unless @g.remotes.blank?
       end
 
-      # Define associations to linters based on file extension
-      # @return [Hash] linters and extension arrays
-      def associations
-        {
-          scss:   ['scss', 'sass'],
-          js:     ['js'],
-          ruby:   ['rb', 'Gemfile', 'lock', 'yml', 'Rakefile', 'ru', 'rdoc'],
-          rails:  ['slim', 'haml']
-        }
+      # Associate files by extension and match their changes
+      # @since 0.1.5
+      # @param git_sha [String]
+      # @param files [String] list of files from git return
+      # @return [Hash] files with matched extensions and changes
+      def match_associations(git_sha, files)
+        new_lines = lines_added(git_sha)
+
+        # File.extname is not used here in case dotfiles are encountered
+        files = files.split("\n").group_by { |f| f.split('.').pop }
+
+        # Don't worry about files that we don't have a lint or a statistic for
+        flat_associations = associations.clone.flatten(2)
+        files.delete_if { |k,v| !flat_associations.include?(k) || k.nil? }
+
+        associations.each do |ext, related|
+          files[ext] ||= []
+          related.each do |child|
+            unless files[child].blank?
+              files[child].each do |c|
+                # hack to ignore deleted files
+                files[child] = new_lines[c].blank? ? [] : [ filename: "#{@settings[:root_dir]}/#{c}", changes: new_lines[c] ]
+              end
+              files[ext].concat(files[child])
+              files.delete(child)
+            end
+          end
+        end
+
+        files.delete_if { |k,v| v.blank? }
+        files
       end
 
   end