maximus 0.1.3 → 0.1.4

data/lib/maximus/git_control.rb

@@ -10,15 +10,10 @@ module Maximus
     #
     # Inherits settings from {Config#initialize}
     # @param opts [Hash] options passed directly to config
-    # @option opts [Boolean] :is_dev (false) whether or not the class was initialized from the command line
-    #   This is set here again in case only GitControl needs to be directly called (outside of command line)
     # @option opts [Config object] :config custom Maximus::Config object
     # @option opts [String] :commit accepts sha, "working", "last", or "master".
-    # @return [void] this method is used to set up instance variables
     def initialize(opts = {})
-      opts[:is_dev] ||= false
-
-      opts[:config] ||= Maximus::Config.new({commit: opts[:commit], is_dev: opts[:is_dev] })
+      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') )
@@ -26,19 +21,19 @@ module Maximus
     end
 
     # 30,000 foot view of a commit
-    #
-    # @param commitsha [String] the sha of the commit
+    # @param commit_sha [String] the sha of the commit
     # @return [Hash] commit data
-    def commit_export(commitsha = sha)
-      ce_commit = vccommit(commitsha)
+    def commit_export(commit_sha = sha)
+      ce_commit = vccommit(commit_sha)
       ce_diff = diff(ce_commit, @g.object('HEAD^'))
       {
-        commitsha: commitsha,
+        commit_sha: commit_sha,
         branch: branch,
         message: ce_commit.message,
         remote_repo: remote,
         git_author: ce_commit.author.name,
         git_author_email: ce_commit.author.email,
+        commit_date: ce_commit.author.date.to_s,
         diff: ce_diff
       }
     end
@@ -75,7 +70,7 @@ module Maximus
       #   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 ? ['working directory'] : `git rev-list #{sha1}..#{sha2} --no-merges`.split("\n")
+      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
@@ -191,7 +186,11 @@ module Maximus
         end
         # @todo better way to silence git, in case there's a real error?
         quietly {
-          @g.branch(base_branch).checkout
+          if base_branch == "maximus_#{sha}"
+            @g.branch('master').checkout
+          else
+            @g.branch(base_branch).checkout
+          end
           @g.branch("maximus_#{sha}").delete
         } unless @psuedo_commit
       end
@@ -201,98 +200,99 @@ module Maximus
 
     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
-    def lint_file_paths(files, ext)
-      file_list = files.map { |f| f[:filename] }.compact
-      # Lints accept files differently
-      ext == :ruby ? file_list.join(' ') : file_list.join(',')
-    end
+      # 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
+      def lint_file_paths(files, ext)
+        file_list = files.map { |f| f[:filename] }.compact
+        # Lints accept files differently
+        ext == :ruby ? file_list.join(' ') : file_list.join(',')
+      end
 
-    # Determine which lines were added (where and how many) in a commit
-    #
-    # @example output from method
-    #   {
-    #     '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|
-        fsplit = filename.split(':')
-        # if file isn't already part of the array
-        new_lines[fsplit[0]] ||= []
-        new_lines[fsplit[0]] << fsplit[1] unless fsplit[1].nil?
-        # no repeats
-        new_lines[fsplit[0]].uniq!
+      # Determine which lines were added (where and how many) in a commit
+      #
+      # @example output from method
+      #   {
+      #     '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|
+          fsplit = filename.split(':')
+          # if file isn't already part of the array
+          new_lines[fsplit[0]] ||= []
+          new_lines[fsplit[0]] << fsplit[1] unless fsplit[1].nil?
+          # no repeats
+          new_lines[fsplit[0]].uniq!
+        end
+        new_lines.delete("/dev/null")
+        new_lines
       end
-      new_lines.delete("/dev/null")
-      new_lines
-    end
 
-    # Get last commit on current branch
-    #
-    # @return [String] sha
-    def sha
-      @g.object('HEAD').sha
-    end
+      # Get last commit on current branch
+      # @return [String] sha
+      def sha
+        @g.object('HEAD').sha
+      end
 
-    # Get current branch name
-    #
-    # @return [String]
-    def branch
-      `env -i git rev-parse --abbrev-ref HEAD`.strip!
-    end
+      # Get current branch name
+      # @return [String]
+      def branch
+        `env -i git rev-parse --abbrev-ref HEAD`.strip!
+      end
 
-    # Get last commit on the master branch
-    #
-    # @return [Git::Object]
-    def master_commit
-      @g.branches[:master].gcommit
-    end
+      # Get last commit on the master branch
+      # @return [Git::Object]
+      def master_commit
+        @g.branches[:master].gcommit
+      end
 
-    # Store last commit as Ruby Git::Object
-    #
-    # @param commitsha [String]
-    # @return [Git::Object]
-    def vccommit(commitsha = sha)
-      @g.gcommit(commitsha)
-    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
-    #
-    # @return [Git::Diff]
-    def diff(new_commit = vccommit, old_commit = master_commit)
-      @g.diff(new_commit, old_commit).stats
-    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]
+      # @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?
+        lines.each do |filename, filelines|
+          stats[:files][filename][:lines_added] = filelines if stats[:files].has_key?(filename)
+        end
+        stats
+      end
 
-    # Get remote URL
-    #
-    # @return [String, nil] nil returns if remotes is blank
-    def remote
-      @g.remotes.first.url unless @g.remotes.blank?
-    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']
-      }
-    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']
+        }
+      end
 
   end
 end

data/lib/maximus/helper.rb

@@ -6,6 +6,7 @@ require 'yaml'
 require 'tempfile'
 
 module Maximus
+  # Methods used in more than one place
   # @since 0.1.0
   module Helper
 

data/lib/maximus/lint.rb

@@ -1,6 +1,8 @@
 require 'json'
 
 module Maximus
+
+  # Parent class for all lints (inherited by children)
   # @since 0.1.0
   # @attr_accessor output [Hash] result of a lint parsed by Lint#refine
   class Lint
@@ -21,11 +23,12 @@ module Maximus
     #  end
     #
     # Inherits settings from {Config#initialize}
+    # @see Config#initialize
     #
     # @param opts [Hash] ({}) options passed directly to the lint
-    # @option git_files [Hash] filename: file location
+    # @option opts [Hash] :git_files filename: file location
     #   @see GitControl#lints_and_stats
-    # @option file_paths [Array, String] lint only specific files or directories
+    # @option opts [Array, String] :file_paths lint only specific files or directories
     #   Accepts globs too
     #   which is used to define paths from the URL
     # @option opts [Config object] :config custom Maximus::Config object
@@ -33,8 +36,8 @@ module Maximus
     def initialize(opts = {})
 
       # Only run the config once
-      @@config ||= opts[:config] || Maximus::Config.new(opts)
-      @settings ||= @@config.settings
+      @config = opts[:config] || Maximus::Config.new(opts)
+      @settings = @config.settings
 
       @git_files = opts[:git_files]
       @path = opts[:file_paths] || @settings[:file_paths]
@@ -89,151 +92,149 @@ module Maximus
       @output[:lint_conventions] = lint_conventions
       @output[:lint_refactors] = lint_refactors
       lint_count = (lint_errors.length + lint_warnings.length + lint_conventions.length + lint_refactors.length)
-      if @@config.is_dev?
+      if @config.is_dev?
         puts lint_dev_format(data) unless data.blank?
         puts lint_summarize
         lint_ceiling lint_count
       else
-        @@config.log.info lint_summarize
+        @config.log.info lint_summarize
         # Because this should be returned in the format it was received
         @output[:raw_data] = data.to_json
       end
-      @@config.destroy_temp(@task)
+      @config.destroy_temp(@task)
       @output
     end
 
 
     protected
 
-    # List all files inspected
-    #
-    # @param ext [String] extension to search for
-    # @param delimiter [String] comma or space separated
-    # @param remove [String] remove from all file names
-    # @return all_files [Array<string>] list of file names
-    def files_inspected(ext, delimiter = ',', remove = @settings[:root_dir])
-      @path.is_a?(Array) ? @path.split(delimiter) : file_list(@path, ext, remove)
-    end
+      # List all files inspected
+      #
+      # @param ext [String] extension to search for
+      # @param delimiter [String] comma or space separated
+      # @param remove [String] remove from all file names
+      # @return all_files [Array<string>] list of file names
+      def files_inspected(ext, delimiter = ',', remove = @settings[:root_dir])
+        @path.is_a?(Array) ? @path.split(delimiter) : file_list(@path, ext, remove)
+      end
 
-    # Compare lint output with lines changed in commit
-    #
-    # @param lint [Hash] output lint data
-    # @param files [Hash<String: String>] filename: filepath
-    # @return [Array] lints that match the lines in commit
-    def relevant_lints(lint, files)
-      all_files = {}
-      files.each do |file|
-
-        # sometimes data will be blank but this is good - it means no errors raised in the lint
-        unless lint.blank?
-          lint_file = lint[file[:filename].to_s]
-
-          expanded = lines_added_to_range(file)
-          revert_name = file[:filename].gsub("#{@settings[:root_dir]}/", '')
-          unless lint_file.blank?
-            all_files[revert_name] = []
-
-            # @todo originally I tried .map and delete_if, but this works,
-            #   and the other method didn't cover all bases.
-            #   Gotta be a better way to write this though
-            lint_file.each do |l|
-              if expanded.include?(l['line'].to_i)
-                all_files[revert_name] << l
+      # Compare lint output with lines changed in commit
+      #
+      # @param lint [Hash] output lint data
+      # @param files [Hash<String: String>] filename: filepath
+      # @return [Array] lints that match the lines in commit
+      def relevant_lints(lint, files)
+        all_files = {}
+        files.each do |file|
+
+          # sometimes data will be blank but this is good - it means no errors raised in the lint
+          unless lint.blank?
+            lint_file = lint[file[:filename].to_s]
+
+            expanded = lines_added_to_range(file)
+            revert_name = file[:filename].gsub("#{@settings[:root_dir]}/", '')
+            unless lint_file.blank?
+              all_files[revert_name] = []
+
+              # @todo originally I tried .map and delete_if, but this works,
+              #   and the other method didn't cover all bases.
+              #   Gotta be a better way to write this though
+              lint_file.each do |l|
+                if expanded.include?(l['line'].to_i)
+                  all_files[revert_name] << l
+                end
               end
+              # If there's nothing there, then it definitely isn't a relevant lint
+              all_files.delete(revert_name) if all_files[revert_name].blank?
             end
-            # If there's nothing there, then it definitely isn't a relevant lint
-            all_files.delete(revert_name) if all_files[revert_name].blank?
+          else
+            # Optionally store the filename with a blank array
+            #   @example all_files[file[:filename].to_s.gsub("#{@settings[:root_dir]}/", '')] = []
           end
-        else
-          # Optionally store the filename with a blank array
-          #   @example all_files[file[:filename].to_s.gsub("#{@settings[:root_dir]}/", '')] = []
         end
+        @output[:files_linted] = all_files.keys
+        all_files
       end
-      @output[:files_linted] = all_files.keys
-      all_files
-    end
 
-    # Look for a config defined from Config#initialize
-    #
-    # @since 0.1.2
-    # @param search_for [String]
-    # @return [String, Boolean] path to temp file
-    def temp_config(search_for)
-      return false if @settings.nil?
-      @settings[search_for.to_sym].blank? ? false : @settings[search_for.to_sym]
-    end
+      # Look for a config defined from Config#initialize
+      #
+      # @since 0.1.2
+      # @param search_for [String]
+      # @return [String, Boolean] path to temp file
+      def temp_config(search_for)
+        return false if @settings.nil?
+        @settings[search_for.to_sym].blank? ? false : @settings[search_for.to_sym]
+      end
 
 
     private
 
-    # Send abbreviated results to console or to the log
-    #
-    # @return [String] console message to display
-    def lint_summarize
-      puts "\n" if @@config.is_dev?
-
-      puts "#{'Warning'.color(:red)}: #{@output[:lint_errors].length} errors found in #{@task.to_s}" if @output[:lint_errors].length > 0
-
-      success = @task.to_s.color(:green)
-      success += ": "
-      success += "[#{@output[:lint_warnings].length}]".color(:yellow)
-      success += " " + "[#{@output[:lint_errors].length}]".color(:red)
-      if @task == 'rubocop'
-        success += " " + "[#{@output[:lint_conventions].length}]".color(:cyan)
-        success += " " + "[#{@output[:lint_refactors].length}]".color(:white)
-      end
+      # Send abbreviated results to console or to the log
+      #
+      # @return [String] console message to display
+      def lint_summarize
+        puts "\n" if @config.is_dev?
+
+        puts "#{'Warning'.color(:red)}: #{@output[:lint_errors].length} errors found in #{@task.to_s}" if @output[:lint_errors].length > 0
+
+        success = @task.to_s.color(:green)
+        success += ": "
+        success += "[#{@output[:lint_warnings].length}]".color(:yellow)
+        success += " " + "[#{@output[:lint_errors].length}]".color(:red)
+        if @task == 'rubocop'
+          success += " " + "[#{@output[:lint_conventions].length}]".color(:cyan)
+          success += " " + "[#{@output[:lint_refactors].length}]".color(:white)
+        end
 
-      success
-    end
+        success
+      end
 
-    # If there's just too much to handle, through a warning.
-    # MySQL may not store all the data and throw an abortive error if the blob is too large
-    # If prompt returns truthy, execution continues
-    #
-    # @param lint_length [Integer] count of how many lints
-    # @return [String] console message to display
-    def lint_ceiling(lint_length)
-      if lint_length > 100
-        lint_dev_format
-        failed_task = "#{@task}".color(:green)
-        errors = Rainbow("#{lint_length} failures.").red
-        errormsg = ["You wouldn't stand a chance in Rome.\nResolve thy errors and train with #{failed_task} again.", "The gods frown upon you, mortal.\n#{failed_task}. Again.", "Do not embarrass the city. Fight another day. Use #{failed_task}.", "You are without honor. Replenish it with another #{failed_task}.", "You will never claim the throne with a performance like that.", "Pompeii has been lost.", "A wise choice. Do not be discouraged from another #{failed_task}."].sample
-        errormsg += "\n\n"
-
-        go_on = prompt "\n#{errors} Continue? (y/n) "
-        abort errormsg unless truthy(go_on)
+      # If there's just too much to handle, through a warning.
+      #
+      # @param lint_length [Integer] count of how many lints
+      # @return [String] console message to display
+      def lint_ceiling(lint_length)
+        if lint_length > 100
+          lint_dev_format
+          failed_task = "#{@task}".color(:green)
+          errors = Rainbow("#{lint_length} failures.").red
+          errormsg = ["You wouldn't stand a chance in Rome.\nResolve thy errors and train with #{failed_task} again.", "The gods frown upon you, mortal.\n#{failed_task}. Again.", "Do not embarrass the city. Fight another day. Use #{failed_task}.", "You are without honor. Replenish it with another #{failed_task}.", "You will never claim the throne with a performance like that.", "Pompeii has been lost.", "A wise choice. Do not be discouraged from another #{failed_task}."].sample
+          errormsg += "\n\n"
+
+          go_on = prompt "\n#{errors} Continue? (y/n) "
+          abort errormsg unless truthy(go_on)
+        end
       end
-    end
 
-    # Dev display, executed only when called from command line
-    #
-    # @param errors [Hash] data from lint
-    # @return [String] console message to display
-    def lint_dev_format(errors = @output[:raw_data])
-      return if errors.blank?
-      pretty_output = ''
-      errors.each do |filename, error_list|
-        pretty_output += "\n"
-        filename = filename.gsub("#{@settings[:root_dir]}/", '')
-        pretty_output += filename.color(:cyan).underline
-        pretty_output += "\n"
-        error_list.each do |message|
-          pretty_output += case message['severity']
-            when 'warning' then 'W'.color(:yellow)
-            when 'error' then 'E'.color(:red)
-            when 'convention' then 'C'.color(:cyan)
-            when 'refactor' then 'R'.color(:white)
-            else '?'.color(:blue)
-          end
-          pretty_output += ' '
-          pretty_output += message['line'].to_s.color(:blue)
-          pretty_output += " #{message['linter'].color(:green)}: "
-          pretty_output += message['reason']
+      # Dev display, executed only when called from command line
+      #
+      # @param errors [Hash] data from lint
+      # @return [String] console message to display
+      def lint_dev_format(errors = @output[:raw_data])
+        return if errors.blank?
+        pretty_output = ''
+        errors.each do |filename, error_list|
+          pretty_output += "\n"
+          filename = filename.gsub("#{@settings[:root_dir]}/", '')
+          pretty_output += filename.color(:cyan).underline
           pretty_output += "\n"
+          error_list.each do |message|
+            pretty_output += case message['severity']
+              when 'warning' then 'W'.color(:yellow)
+              when 'error' then 'E'.color(:red)
+              when 'convention' then 'C'.color(:cyan)
+              when 'refactor' then 'R'.color(:white)
+              else '?'.color(:blue)
+            end
+            pretty_output += ' '
+            pretty_output += message['line'].to_s.color(:blue)
+            pretty_output += " #{message['linter'].color(:green)}: "
+            pretty_output += message['reason']
+            pretty_output += "\n"
+          end
         end
+        pretty_output
       end
-      pretty_output
-    end
 
   end
 end