maximus 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7967be47ba9de75aa1e59c138a2af4b01c5242a4
-  data.tar.gz: c2332ff9d712472bea8babb615ea3c8ccd1a8069
+  metadata.gz: 70e71aa9bf1801ab2da6baad0c7a6de45759d5b2
+  data.tar.gz: 1f3fc9752270915bfe051d3e76ba034816c7c42b
 SHA512:
-  metadata.gz: afcc4bdd7489bd5e5c0f54fdd2c5dc6039a0f81ada004df458e69a3d24ebc2df521a7e50a8c313a3346439def9a05d3bb0eed672c593aa23399a8c2e66c2b9ff
-  data.tar.gz: de955683da789d3027c4c6adaca3d1a3624dd2df33ff9fdc4c91a0ec0e4e35c9e46e2b76764030f9de5bc40f65ef131b9cde2963c9e8cc6a806a8ff3c078c9cc
+  metadata.gz: 2d24180804d7722eeaef5faedabc1ef5b0915af20ff9cee8cb30ce230cff669bd994f1de046894d6e96c35894f35aab4cce5b6248ab4a6d48b39961099bd287a
+  data.tar.gz: 04e6694a21cc3926fc9338b26827480f8423e104fb5562ead917959edb7a563f12a01c180ad154ded26ab4c4bb4ff6433bcc9f684d4ced8559ae98a71fc6334a

data/README.md

@@ -1,5 +1,7 @@
 # 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)
+
 The all-in-one linting solution.
 
 Plays nice with Middleman and Rails.

data/lib/maximus.rb

@@ -4,7 +4,6 @@ require 'maximus/helper'
 require 'maximus/git_control'
 require 'maximus/lint'
 require 'maximus/statistic'
-require 'maximus/rake_tasks'
 
 # Get statistics
 Dir[File.expand_path('maximus/statistics/*.rb', File.dirname(__FILE__))].each do |file|

data/lib/maximus/cli.rb

@@ -1,5 +1,6 @@
 require 'thor'
 
+# @since 0.1.0
 class Maximus::CLI < Thor
   include Thor::Actions
   class_option :path, aliases: ["-p", "-u", "\--url"], default: nil, desc: "Space-separated path(s) to URLs or files"
@@ -46,7 +47,7 @@ class Maximus::CLI < Thor
     return Maximus::GitControl.new({ commit: options[:commit], is_dev: true }).lints_and_stats(true)
   end
 
-  # TODO - something better than just installing in the global npm file
+  # @todo something better than just installing in the global npm file
   # and including phantomjs
   desc "install", "Install all dependencies"
   def install

data/lib/maximus/constants.rb

@@ -1,3 +1,5 @@
 # Global application constants.
+#
+# @since 0.1.0
 module Maximus
 end

data/lib/maximus/git_control.rb

@@ -5,10 +5,23 @@ require 'rainbow'
 require 'rainbow/ext/string'
 
 module Maximus
+  # @since 0.1.0
   class GitControl
 
     include Helper
 
+    # Git management
+    #
+    # @param opts [Hash] the options to initialize and pass to other classes
+    # @option opts [Boolean] :is_dev whether or not the class was initialized from the command line
+    # @option opts [String] :log ('log/maximus_git.log') path to log file
+    # @option opts [String] :root_dir base directory
+    # @option opts [String] :base_url ('http://localhost:3000') the host - used for Statistics
+    # @option opts [String, Integer] :port port number - used for Statistics
+    # @option opts [String, Array] :path ('') path to files. Accepts glob notation
+    # @option opts [String] :commit accepts sha, "working", "last", or "master".
+    #   Used in the command line
+    # @return [void] this method is used to set up instance variables
     def initialize(opts = {})
       opts[:is_dev] ||= false
       opts[:log] = Logger.new('log/maximus_git.log') if opts[:log].nil?
@@ -24,7 +37,10 @@ module Maximus
       @g = Git.open(@opts[:root_dir], :log => log)
     end
 
-    # Returns Hash of commit data
+    # 30,000 foot view of a commit
+    #
+    # @param commitsha [String] the sha of the commit
+    # @return [Hash] commit data
     def commit_export(commitsha = sha)
       ce_commit = vccommit(commitsha)
       ce_diff = diff(ce_commit, @g.object('HEAD^'))
@@ -40,8 +56,21 @@ module Maximus
     end
 
     # Compare two commits and get line number ranges of changed patches
-    # Returns Hash grouped by file extension (defined in assoc) => { filename, changes: (changed line ranges) }
-    # Example: 'sha' => { rb: {filename: 'file.rb', changes: { ['0..4'], ['10..20'] }  }}
+    #
+    # @example output from the method
+    #   {
+    #     'sha': {
+    #       rb: {
+    #         filename: 'file.rb',
+    #         changes: {
+    #           ['0..4'],
+    #           ['10..20']
+    #         }
+    #       }
+    #     }
+    #   }
+    #
+    # @return [Hash] diff_return files changed grouped by file extension and line number
     def compare(sha1 = master_commit.sha, sha2 = sha)
       diff_return = {}
 
@@ -54,10 +83,10 @@ module Maximus
         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
+      # 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 ? ['working directory'] : `git rev-list #{sha1}..#{sha2} --no-merges`.split("\n")
 
       # Include the first sha because rev-list is doing a traversal
@@ -96,17 +125,29 @@ module Maximus
       diff_return
     end
 
-    # Run appropriate lint for every sha in commit history
-    # Creates new branch based on each sha, then deletes it
-    # Different from above method as it returns the entire lint, not just the lines relevant to commit
-    # Returns Hash with all data grouped by task
-    # Example: { 'sha': { lints: { scsslint: { files_inspec... }, statisti... } }, 'sha...' }
+    # Run appropriate lint for every sha in commit history.
+    # For each sha a new branch is created then deleted
+    #
+    # @example sample output
+    #   {
+    #     'sha': {
+    #       lints: {
+    #         scsslint: {
+    #           files_inspec...
+    #         },
+    #       },
+    #       statisti...
+    #     },
+    #     'sha'...
+    #   }
+    #
+    # @return [Hash] data all data grouped by task
     def lints_and_stats(lint_by_path = false, git_shas = compare)
       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?
+        # @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 @@is_dev
         git_output[sha.to_sym] = {
@@ -126,6 +167,7 @@ module Maximus
           port: @opts[:port],
           root_dir: @opts[:root_dir]
         }
+
         # This is where everything goes down
         exts.each do |ext, files|
           # For relevant_lines data
@@ -135,27 +177,27 @@ module Maximus
             when :scss
               lints[:scsslint] = Maximus::Scsslint.new(lint_opts).result
 
-              # Do not run statistics if called by rake task :compare
+              # Do not run statistics if called from command line
               if lint_opts[:commit].blank?
 
-                # 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',
-                # which breaks the model name. This could be a TODO
+                # @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',
+                #   which breaks the model name.
                 statistics[:stylestat] = Maximus::Stylestats.new(stat_opts).result
 
-                # TODO - double pipe here is best way to say, if it's already run, don't run again, right?
+                # @todo double pipe here is best way to say, if it's already run, don't run again, right?
                 statistics[:phantomas] ||= Maximus::Phantomas.new(stat_opts).result
                 statistics[:wraith] = Maximus::Wraith.new(stat_opts).result
               end
             when :js
               lints[:jshint] = Maximus::Jshint.new(lint_opts).result
 
-              # Do not run statistics if called by rake task :compare
+              # Do not run statistics if called from command line
               if lint_opts[:commit].blank?
 
                 statistics[:phantomas] = Maximus::Phantomas.new(stat_opts).result
 
-                # TODO - double pipe here is best way to say, if it's already run, don't run again, right?
+                # @todo double pipe here is best way to say, if it's already run, don't run again, right?
                 statistics[:wraith] ||= Maximus::Wraith.new(stat_opts).result
               end
             when :ruby
@@ -166,7 +208,7 @@ module Maximus
               lints[:railsbp] ||= Maximus::Railsbp.new(lint_opts).result
           end
         end
-        # TODO - better way to silence git, in case there's a real error?
+        # @todo better way to silence git, in case there's a real error?
         quietly {
           @g.branch(base_branch).checkout
           @g.branch("maximus_#{sha}").delete
@@ -179,15 +221,28 @@ module Maximus
     protected
 
     # Get list of file paths
-    # Returns String delimited by comma or space
+    #
+    # @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
 
-    # Returns Array of ranges by lines added in a commit by file name
-    # {'filename' => ['0..10', '11..14']}
+    # 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")
@@ -204,44 +259,50 @@ module Maximus
     end
 
     # Get last commit on current branch
-    # Returns String
+    #
+    # @return [String] sha
     def sha
       @g.object('HEAD').sha
     end
 
-    # Get branch name
-    # Returns String
+    # 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
-    # Returns Git::Object
+    #
+    # @return [Git::Object]
     def master_commit
       @g.branches[:master].gcommit
     end
 
     # Store last commit as Ruby Git::Object
-    # Returns Git::Object
+    # @param commitsha [String]
+    # @return [Git::Object]
     def vccommit(commitsha = sha)
       @g.gcommit(commitsha)
     end
 
     # Get general stats of commit on HEAD versus last commit on master branch
-    # Roadmap - include lines_added in this method's output
-    # Returns Git::Diff
+    #
+    # @return [Git::Diff]
     def diff(new_commit = vccommit, old_commit = master_commit)
       @g.diff(new_commit, old_commit).stats
     end
 
     # Get remote URL
-    # Returns String or nil if remotes is blank
+    #
+    # @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
-    # Returns Hash of linters and extension arrays
+    #
+    # @return [Hash] linters and extension arrays
     def associations
       {
         scss:   ['scss', 'sass'],

data/lib/maximus/helper.rb

@@ -5,51 +5,70 @@ require 'active_support/core_ext/object/blank'
 require 'yaml'
 
 module Maximus
+  # @since 0.1.0
   module Helper
 
-    # See if Rails or a framework, i.e. Middleman
-    # This will usually be stored as a class variable in the inherited class, like @@is_rails = is_rails? in lint.rb
-    # Returns Boolean
+    # See if project linted is a Rails app
+    # This will usually be stored as a class variable in the inherited class
+    # @example class variable
+    #   @@is_rails = is_rails?
+    #
+    # @see Lint#initialize
+    #
+    # @return [Boolean]
     def is_rails?
       defined?(Rails)
     end
 
     # Get root directory of file being called
-    # Returns String (path)
+    #
+    # @return [String] absolute path to root directory
     def root_dir
       is_rails? ? Rails.root.to_s : Dir.pwd.to_s
     end
 
-    # Verify that node module is installed on the box before continuing
-    # Continues if module exists
-    def node_module_exists(node_module, install_instructions = 'npm install -g')
-      cmd = `if hash #{node_module} 2>/dev/null; then
+    # Verify that command is available on the box before continuing
+    #
+    # @param command [String] command to check
+    # @param install_instructions [String] how to install the missing command
+    # @return [void] aborts the action if command not found
+    def node_module_exists(command, install_instructions = 'npm install -g')
+      cmd = `if hash #{command} 2>/dev/null; then
         echo "true"
       else
         echo "false"
       fi`
       if cmd.include? "false"
-        command_msg = "Missing command #{node_module}".color(:red)
-        abort "#{command_msg}: Please run `#{install_instructions} #{node_module}` And try again\n"
+        command_msg = "Missing command #{command}".color(:red)
+        abort "#{command_msg}: Please run `#{install_instructions} #{command}` And try again\n"
+        exit 1
       end
     end
 
-    # Look for a custom config in the app's config/ directory; otherwise, use the built-in one
-    # TODO - best practice that this inherits the @opts from the model it's being included in?
-    # Returns String
+    # Look for a custom config in the app's config/ directory;
+    # otherwise, use the built-in one.
+    # @todo best practice that this inherits the @opts from the model it's being included in?
+    #
+    # @param filename [String]
+    # @return [String] absolute path to the reporter file
     def check_default(filename)
       user_file = "#{@opts[:root_dir]}/config/#{filename}"
       File.exist?(user_file) ? user_file : File.join(File.dirname(__FILE__), "config/#{filename}")
     end
 
     # Grab the absolute path of the reporter file
-    # Returns String
+    #
+    # @param filename [String]
+    # @return [String] absolute path to the reporter file
     def reporter_path(filename)
       File.join(File.dirname(__FILE__),"reporter/#{filename}")
     end
 
     # Find all files that were linted by extension
-    # Returns Array
+    #
+    # @param path [String] path to folders
+    # @param ext [String] file extension to search for
+    # @return [Array<String>] list of file paths
     def file_list(path, ext = 'scss', remover = '')
       # Necessary so that directories aren't counted
       collect_path = path.include?("*") ? path : "#{path}/**/*.#{ext}"
@@ -58,20 +77,26 @@ module Maximus
     end
 
     # Count how many files were linted
-    # Returns Integer
+    #
+    # @param path [String] path to folders
+    # @param ext [String] file extension to search for
+    # @return [Integer] number of files matched by the path
     def file_count(path, ext = 'scss')
       file_list(path, ext).length
     end
 
     # Convert string to boolean
-    # Returns Boolean
+    #
+    # @param str [String] the string to evaluate
+    # @return [Boolean] whether or not the string is true
     def truthy(str)
       return true if str == true || str =~ (/^(true|t|yes|y|1)$/i)
       return false if str == false || str.blank? || str =~ (/^(false|f|no|n|0)$/i)
     end
 
     # Edit and save a YAML file
-    # Returns closed File
+    #
+    # @return [void]
     def edit_yaml(yaml_location, &block)
       d = YAML.load_file(yaml_location)
       block.call(d)
@@ -79,41 +104,53 @@ module Maximus
     end
 
     # Request user input
-    # Returns user input as String
+    #
+    # @param args [Array<String>] prompts to request
+    # @return [String] user input to use elsewhere
     def prompt(*args)
       print(*args)
       STDIN.gets
     end
 
-    # Defines base log
-    # Returns @@log variable for use
+    # Defines base logger
+    #
+    # @return [Logger] @@log for logging use
     def mlog
       @@log ||= Logger.new(STDOUT)
       @@log.level ||= Logger::INFO
       @@log
     end
 
-    # Determine if current process was called by a rake task
-    # Returns Boolean
-    # http://stackoverflow.com/questions/2467208/how-can-i-tell-if-rails-code-is-being-run-via-rake-or-script-generate
-    def is_rake_task?
-      File.basename($0) == 'rake'
-    end
-
     # Convert the array from lines_added into spelled-out ranges
-    # Example: lines_added = {'filename' => ['0..10', '11..14']}
-    # Becomes {'filename' => {[0,1,2,3,4,5,6,7,8,9,10], [11,12,13,14]}}
-    # This is a git_control helper primarily but it's used in Lint
-    # TODO - I'm sure there's a better way of doing this
-    # TODO - figure out a better place to put this than in Helper
-    # Returns Hash of spelled-out arrays of integers
+    # This is a GitControl helper but it's used in Lint
+    # @see GitControl#lines_added
+    # @see Lint#relevant_lint
+    #
+    # @example typical output
+    #   lines_added = {'filename' => ['0..10', '11..14']}
+    #   lines_added_to_range(lines_added)
+    #   # output
+    #   {
+    #     'filename': {
+    #       {
+    #         [0,1,2,3,4,5,6,7,8,9,10],
+    #         [11,12,13,14]
+    #       }
+    #     }
+    #   }
+    #
+    # @todo I'm sure there's a better way of doing this
+    # @todo figure out a better place to put this than in Helper
+    # @return [Hash] changes_array of spelled-out arrays of integers
     def lines_added_to_range(file)
       changes_array = file[:changes].map { |ch| ch.split("..").map(&:to_i) }
       changes_array.map { |e| (e[0]..e[1]).to_a }.flatten!
     end
 
-    # Ensure @path exists
-    # Returns Boolean
+    # Ensure path exists
+    #
+    # @param path [String, Array] path to files can be directory or glob
+    # @return [Boolean]
     def path_exists(path = @path)
       path = path.split(' ') if path.is_a?(String) && path.include?(' ')
       if path.is_a?(Array)