inch 0.4.10 → 0.5.0.rc1

data/lib/inch/cli/command.rb

@@ -1,19 +1,19 @@
-require "inch/cli/command/base"
-require "inch/cli/command/base_list"
-require "inch/cli/command/base_object"
+require 'inch/cli/command/base'
+require 'inch/cli/command/base_list'
+require 'inch/cli/command/base_object'
 
-require "inch/cli/command/options/base"
-require "inch/cli/command/options/base_list"
-require "inch/cli/command/options/base_object"
+require 'inch/cli/command/options/base'
+require 'inch/cli/command/options/base_list'
+require 'inch/cli/command/options/base_object'
 
-require "inch/cli/command/output/base"
+require 'inch/cli/command/output/base'
 
-require "inch/cli/command_parser"
+require 'inch/cli/command_parser'
 
-require "inch/cli/command/list"
-require "inch/cli/command/show"
-require "inch/cli/command/stats"
-require "inch/cli/command/suggest"
-require "inch/cli/command/console"
-require "inch/cli/command/inspect"
-require "inch/cli/command/diff"
+require 'inch/cli/command/list'
+require 'inch/cli/command/show'
+require 'inch/cli/command/stats'
+require 'inch/cli/command/suggest'
+require 'inch/cli/command/console'
+require 'inch/cli/command/inspect'
+require 'inch/cli/command/diff'

data/lib/inch/cli/command/base.rb

@@ -60,7 +60,7 @@ module Inch
         end
 
         def initialize
-          name = self.class.to_s.split("::").last
+          name = self.class.to_s.split('::').last
           options_class = Command::Options.const_get(name)
           @options = options_class.new
           @options.usage = usage
@@ -87,9 +87,9 @@ module Inch
         #
         # @abstract
         # @note Override with implementation
-        # @param *_args [Array<String>]
-        def run(*_args)
-          fail NotImplementedError
+        # @param *args [Array<String>]
+        def run(*args)
+          raise NotImplementedError
         end
 
         # Returns a description of the command's usage pattern

data/lib/inch/cli/command/console.rb

@@ -1,6 +1,6 @@
-require "pry"
-require "inch/cli/command/options/console"
-require "inch/cli/command/output/console"
+require 'pry'
+require 'inch/cli/command/options/console'
+require 'inch/cli/command/output/console'
 
 module Inch
   module CLI
@@ -9,11 +9,11 @@ module Inch
         register_command_as :console
 
         def description
-          "Shows a console"
+          'Shows a console'
         end
 
         def usage
-          "Usage: inch console [paths] [OBJECT_NAME] [options]"
+          'Usage: inch console [paths] [OBJECT_NAME] [options]'
         end
 
         def run(*args)

data/lib/inch/cli/command/diff.rb

@@ -1,6 +1,6 @@
-require "pry"
-require "inch/cli/command/options/diff"
-require "inch/cli/command/output/diff"
+require 'pry'
+require 'inch/cli/command/options/diff'
+require 'inch/cli/command/output/diff'
 
 module Inch
   module CLI
@@ -11,11 +11,11 @@ module Inch
         register_command_as :diff
 
         def description
-          "Shows a diff"
+          'Shows a diff'
         end
 
         def usage
-          "Usage: inch diff [REV..[REV]] [options]"
+          'Usage: inch diff [REV..[REV]] [options]'
         end
 
         def run(*args)
@@ -33,8 +33,9 @@ module Inch
         # @return [Array<String>] the revisions passed in the command_line
         def revisions
           @revisions ||= @options.revisions.map do |rev|
-            next unless rev
-            git(work_dir, "rev-parse #{rev}").strip
+            if rev
+              git(work_dir, "rev-parse #{rev}").strip
+            end
           end
         end
 

data/lib/inch/cli/command/inspect.rb

@@ -1,5 +1,5 @@
-require "inch/cli/command/options/inspect"
-require "inch/cli/command/output/inspect"
+require 'inch/cli/command/options/inspect'
+require 'inch/cli/command/output/inspect'
 
 module Inch
   module CLI
@@ -8,12 +8,11 @@ module Inch
         register_command_as :inspect
 
         def description
-          "Inspects an object"
+          'Inspects an object'
         end
 
         def usage
-          "Usage: inch inspect [paths] OBJECT_NAME [[OBJECT_NAME2] ...] " \
-            "[options]"
+          'Usage: inch inspect [paths] OBJECT_NAME [[OBJECT_NAME2] ...] [options]'
         end
 
         def run(*args)

data/lib/inch/cli/command/list.rb

@@ -1,5 +1,5 @@
-require "inch/cli/command/options/list"
-require "inch/cli/command/output/list"
+require 'inch/cli/command/options/list'
+require 'inch/cli/command/output/list'
 
 module Inch
   module CLI
@@ -8,11 +8,11 @@ module Inch
         register_command_as :list
 
         def description
-          "Lists all objects with their results"
+          'Lists all objects with their results'
         end
 
         def usage
-          "Usage: inch list [paths] [options]"
+          'Usage: inch list [paths] [options]'
         end
 
         # Runs the commandline utility, parsing arguments and displaying a

data/lib/inch/cli/command/options/base.rb

@@ -1,4 +1,4 @@
-require "optparse"
+require 'optparse'
 
 module Inch
   module CLI
@@ -91,8 +91,8 @@ module Inch
           #
           # @return [String]
           def description_hint_arrows
-            arrows = Evaluation::PriorityRange.all.map(&:arrow).join(" ")
-            "Arrows (#{arrows}) hint at the importance of the object " \
+            arrows = Evaluation::PriorityRange.all.map(&:arrow).join(' ')
+            "Arrows (#{arrows}) hint at the importance of the object " +
               "being documented."
           end
 
@@ -102,7 +102,7 @@ module Inch
           # @return [String]
           def description_hint_grades
             grades = Evaluation::Grade.all
-            "School grades (#{grades.join(", ")}) are assigned and " \
+            "School grades (#{grades.join(', ')}) are assigned and " +
               "displayed with each object."
           end
 
@@ -126,13 +126,13 @@ module Inch
             opts.separator ""
             opts.separator "Other options:"
             opts.on("--[no-]color", "Run without color") do |v|
-              Term::ANSIColor.coloring = v
+              Term::ANSIColor::coloring = v
             end
-            opts.on_tail("-v", "--version", "Show version.") do
+            opts.on_tail('-v', '--version', 'Show version.') do
               ui.trace "inch #{Inch::VERSION}"
               exit
             end
-            opts.on_tail("-h", "--help", "Show this help.") do
+            opts.on_tail('-h', '--help', 'Show this help.') do
               ui.trace opts
               exit
             end
@@ -165,7 +165,7 @@ module Inch
           # Resets the command-line interface before each run
           def reset
             # color is enabled by default, can be turned of by switch --no-color
-            Term::ANSIColor.coloring = true
+            Term::ANSIColor::coloring = true
           end
 
           # Callback when an unrecognize option is parsed

data/lib/inch/cli/command/options/base_list.rb

@@ -11,7 +11,7 @@ module Inch
           attribute :depth
 
           attribute :show_all, false
-          alias_method :show_all?, :show_all
+          alias :show_all? :show_all
 
           def parse(args)
             opts = OptionParser.new
@@ -37,6 +37,7 @@ module Inch
 
           protected
 
+
           # Sets all list related options for the current Options object
           #
           # @param opts [OptionParser]
@@ -49,13 +50,10 @@ module Inch
               @show_all = true
             end
 
-            opts.on("--only-namespaces",
-                    "Only show namespaces (classes, modules)") do
+            opts.on("--only-namespaces", "Only show namespaces (classes, modules)") do
               @namespaces = :only
             end
-            opts.on("--no-namespaces",
-                    "Only show namespace children (methods, constants, " \
-                    "attributes)") do
+            opts.on("--no-namespaces", "Only show namespace children (methods, constants, attributes)") do
               @namespaces = :none
             end
 
@@ -76,9 +74,7 @@ module Inch
               @undocumented = :none
             end
 
-            opts.on("--depth [DEPTH]",
-                    "Only show objects up to a given DEPTH " \
-                    "in the class tree") do |depth|
+            opts.on("--depth [DEPTH]", "Only show objects up to a given DEPTH in the class tree") do |depth|
               @depth = depth.to_i
             end
           end

data/lib/inch/cli/command/options/console.rb

@@ -8,18 +8,17 @@ module Inch
               "",
               "Provides a PRY based REPL to inspect objects.",
               "",
-              "Example: " +
-                "$ inch console lib/**/*.rb Foo::Bar#initialize".color(:cyan),
+              "Example: " + "$ inch console lib/**/*.rb Foo::Bar#initialize".color(:cyan),
               "",
               "Shortcut commands on the prompt are:",
               "",
               "all".ljust(5) + " returns all code objects",
               "f".ljust(5) + " finds an object by its path",
               "ff".ljust(5) + " finds all objects given a partial path",
-              "o".ljust(5) +
-                " returns the code object for OBJECT_NAME (if present)"
+              "o".ljust(5) + " returns the code object for OBJECT_NAME (if present)",
             ]
           end
+
         end
       end
     end

data/lib/inch/cli/command/options/diff.rb

@@ -1,4 +1,4 @@
-require "inch/utils/shell_helper"
+require 'inch/utils/shell_helper'
 
 module Inch
   module CLI
@@ -59,13 +59,11 @@ module Inch
             opts.separator ""
             opts.separator "Diff options:"
 
-            opts.on("--since-last-commit",
-                    "Run diff against last commit (default)") do
+            opts.on("--since-last-commit", "Run diff against last commit (default)") do |count|
               @before_rev = "HEAD"
             end
-            opts.on("-p", "--since-last-push",
-                    "Run diff against last pushed commit") do
-              @before_rev = pushed_rev
+            opts.on("-p", "--since-last-push", "Run diff against last pushed commit") do |count|
+              @before_rev = get_pushed_rev
               @since_last_push = true
             end
           end
@@ -73,8 +71,8 @@ module Inch
           # @return [String] the reference for the pushed revision
           #
           # @example
-          #   pushed_rev # => "origin/master"
-          def pushed_rev
+          #   get_pushed_rev # => "origin/master"
+          def get_pushed_rev
             "#{remote}/#{current_branch}"
           end
 

data/lib/inch/cli/command/options/inspect.rb

@@ -3,11 +3,11 @@ module Inch
     module Command
       module Options
         class Inspect < BaseObject
+
           def descriptions
             [
               "",
-              "Example: " +
-                "$ inch inspect lib/**/*.rb Foo::Bar#initialize".color(:cyan),
+              "Example: " + "$ inch inspect lib/**/*.rb Foo::Bar#initialize".color(:cyan),
               "",
               "Shows one or more objects in detail."
             ]

data/lib/inch/cli/command/options/list.rb

@@ -8,8 +8,7 @@ module Inch
           def descriptions
             [
               "",
-              "Lists objects that can be improved regarding their " \
-                "documentation ordered by their grade.",
+              "Lists objects that can be improved regarding their documentation ordered by their grade.",
               "",
               "Example: " + "$ inch list lib/**/*.rb --all".color(:cyan),
               "",
@@ -20,7 +19,7 @@ module Inch
 
           def list_options(opts)
             super
-            opts.on("--numbers", "Show numbers instead of grades and arrows") do
+            opts.on("--numbers", "Show numbers instead of grades and arrows") do |depth|
               @numbers = true
             end
           end

data/lib/inch/cli/command/options/show.rb

@@ -3,11 +3,11 @@ module Inch
     module Command
       module Options
         class Show < BaseObject
+
           def descriptions
             [
               "",
-              "Example: " +
-                "$ inch show lib/**/*.rb Foo::Bar#initialize".color(:cyan),
+              "Example: " + "$ inch show lib/**/*.rb Foo::Bar#initialize".color(:cyan),
               "",
               "Shows one or more objects in detail.",
               description_hint_grades,

data/lib/inch/cli/command/options/stats.rb

@@ -9,8 +9,7 @@ module Inch
 
           def list_options(opts)
             super
-            opts.on("-f", "--format [FORMAT]", FORMATS,
-                    "Set output FORMAT") do |format|
+            opts.on("-f", "--format [FORMAT]", FORMATS, "Set output FORMAT") do |format|
               @format = format
             end
           end

data/lib/inch/cli/command/options/suggest.rb

@@ -26,11 +26,9 @@ module Inch
           def descriptions
             [
               "",
-              "Suggests objects and files that can be improved regarding " \
-                "their documentation.",
+              "Suggests objects and files that can be improved regarding their documentation.",
               "",
-              "Example: " +
-                "$ inch suggest lib/**/*.rb --pedantic".color(:cyan),
+              "Example: " + "$ inch suggest lib/**/*.rb --pedantic".color(:cyan),
               "",
               description_hint_grades,
               description_hint_arrows
@@ -46,8 +44,7 @@ module Inch
             opts.on("-n", "--objects [COUNT]", "Show COUNT objects") do |count|
               @object_count = count.to_i
             end
-            opts.on("--pedantic",
-                    "Be excessively concerned with minor details and rules") do
+            opts.on("--pedantic", "Be excessively concerned with minor details and rules") do |count|
               # all objects are considered a priority
               @object_min_priority = -99
               # only objects with the highest score are omitted from the list

data/lib/inch/cli/command/output/base.rb

@@ -1,4 +1,4 @@
-require "optparse"
+require 'optparse'
 
 module Inch
   module CLI
@@ -20,13 +20,15 @@ module Inch
 
           def priority_arrow(priority, color = :white)
             Evaluation::PriorityRange.all.each do |range|
-              return range.arrow.color(color).dark if range.include?(priority)
+              if range.include?(priority)
+                return range.arrow.color(color).dark
+              end
             end
           end
 
-          def print_file_info(o, color)
+          def print_file_info(o, _color)
             o.files.each do |f|
-              echo "-> #{f.filename}:#{f.line_no}".color(color)
+              echo "-> #{f.filename}:#{f.line_no}".color(_color)
             end
             echo separator
           end

data/lib/inch/cli/command/output/console.rb

@@ -35,10 +35,11 @@ module Inch
             @codebase.objects.find(fullname)
           end
 
-          alias_method :all, :all_objects
-          alias_method :ff, :find_objects
-          alias_method :f, :find_object
-          alias_method :o, :object
+          alias :all :all_objects
+          alias :ff :find_objects
+          alias :f :find_object
+          alias :o :object
+
 
           def run
             ui.trace

data/lib/inch/cli/command/output/diff.rb

@@ -27,7 +27,7 @@ module Inch
           private
 
           def show(added, improved, degraded)
-            unless added.empty? && improved.empty?
+            if !(added.empty? && improved.empty?)
               ui.trace
               ui.header("Added or improved:", :green)
               added.each do |compare|
@@ -38,7 +38,7 @@ module Inch
               end
             end
 
-            unless degraded.empty?
+            if !degraded.empty?
               ui.trace
               ui.header("Degraded:", :red)
               degraded.each do |compare|
@@ -54,6 +54,7 @@ module Inch
 
           def puts_added(o)
             grade = colored_grade(o)
+            priority = o.priority
             change = "  +  ".dark + grade + "  " + priority_arrow(o.priority)
             ui.sub(" #{change}  #{o.fullname}")
           end
@@ -61,11 +62,10 @@ module Inch
           def puts_improved(before, o)
             before_grade = colored_grade(before)
             grade = colored_grade(o)
-            change = before_grade + " -> ".dark + grade + "  " +
-              priority_arrow(o.priority)
+            change = before_grade + " -> ".dark + grade + "  " + priority_arrow(o.priority)
             ui.sub(" #{change}  #{o.fullname}")
           end
-          alias_method :puts_degraded, :puts_improved
+          alias :puts_degraded :puts_improved
 
           def colored_grade(o)
             r = grade_list(o.grade.to_sym)
@@ -74,7 +74,7 @@ module Inch
 
           def grade_list(grade_symbol)
             @grade_lists ||= Evaluation.new_grade_lists
-            @grade_lists.find { |r| r.grade.to_sym == grade_symbol }
+            @grade_lists.detect { |r| r.grade.to_sym == grade_symbol }
           end
 
           def rev_hint