inch 0.5.0.rc3 → 0.5.0.rc4

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

@@ -48,7 +48,7 @@ module Inch
           def print_code_info(o)
             if o.method?
               CommentAndAbbrevSource.new(o).lines.each do |line|
-                echo line.gsub(/\n$/m, '').color(COMMENT_COLOR)
+                echo line.gsub(/\n$/m, "").color(COMMENT_COLOR)
               end
               echo separator
             end
@@ -66,13 +66,11 @@ module Inch
           end
 
           def print_role_info(role)
-            name = role.class.to_s.split('::Role::').last
+            name = role.class.to_s.split("::Role::").last
             score = colored_role_score(role)
 
             priority = role.priority.to_s.rjust(4)
-            if role.priority == 0
-              priority = priority.dark
-            end
+            priority = priority.dark if role.priority == 0
 
             echo name.ljust(40) + score + priority
             print_min_max_score(role)
@@ -133,7 +131,7 @@ module Inch
             end
 
             def to_s
-              comments.join('') + abbrev_source
+              comments.join("") + abbrev_source
             end
 
             private
@@ -141,12 +139,12 @@ module Inch
             def abbrev_source
               lines = code_object.source.to_s.lines.to_a
               if lines.size >= 5
-                indent = lines[1].scan(/^(\s+)/).flatten.join('')
+                indent = lines[1].scan(/^(\s+)/).flatten.join("")
                 lines = lines[0..1] +
                         ["#{indent}# ... snip ...\n"] +
                         lines[-2..-1]
               end
-              lines.join('')
+              lines.join("")
             end
 
             def comments

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

@@ -79,7 +79,6 @@ module Inch
             priority = object.priority
             "#{score}  #{priority}  #{object.fullname}"
           end
-
         end
       end
     end

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

@@ -42,10 +42,9 @@ module Inch
             if o.roles.empty?
               echo "No roles assigned.".dark
             else
-              o.roles.each_with_index do |role, index|
-                if role.suggestion
-                  echo "+".color(COLOR) + " #{role.suggestion}"
-                end
+              o.roles.each do |role|
+                next unless role.suggestion
+                echo "+".color(COLOR) + " #{role.suggestion}"
               end
             end
             echo separator
@@ -61,7 +60,7 @@ module Inch
 
           def grade(score)
             grade_lists ||= Evaluation.new_grade_lists
-            r = grade_lists.detect { |r| r.scores.include?(score) }
+            r = grade_lists.find { |v| v.scores.include?(score) }
             "#{r.grade} - #{r.label}".color(r.color)
           end
         end

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

@@ -1,5 +1,5 @@
-require 'json'
-require 'yaml'
+require "json"
+require "yaml"
 
 module Inch
   module CLI
@@ -11,10 +11,10 @@ module Inch
           attr_reader :objects
 
           PRIORITY_COLORS = [
-              [213,212,211,210,210,209,209],
-              [177],
-              [203, 203, 204, 204, 205, 206, 207]
-            ].flatten.map { |s| :"color#{s}" }
+            [213, 212, 211, 210, 210, 209, 209],
+            [177],
+            [203, 203, 204, 204, 205, 206, 207]
+          ].flatten.map { |s| :"color#{s}" }
 
           def initialize(options, objects, grade_lists)
             @options = options
@@ -31,25 +31,26 @@ module Inch
             print_grades_by_priority
             print_priorities
             puts
-            puts 'Try `--format json|yaml` for raw numbers.'.dark
+            puts "Try `--format json|yaml` for raw numbers.".dark
           end
 
           def print_grades
-            sparkline = grade_lists_sparkline(@grade_lists).to_s(' ')
+            sparkline = grade_lists_sparkline(@grade_lists).to_s(" ")
             puts
-            puts 'Grade distribution: (undocumented, C, B, A)'
+            puts "Grade distribution: (undocumented, C, B, A)"
             puts
-            puts "  Overall:  #{sparkline}  #{objects.size.to_s.rjust(5)} objects"
+            puts "  Overall:  #{sparkline}  #{objects.size.to_s.rjust(5)} " \
+              "objects"
             puts
           end
 
           def print_grades_by_priority
-            puts 'Grade distribution by priority:'
+            puts "Grade distribution by priority:"
             puts
             Evaluation::PriorityRange.all.each do |priority_range|
               list = objects.select { |o| priority_range.include?(o.priority) }
-              sparkline = grades_sparkline(list).to_s(' ')
-              puts "        #{priority_range.arrow}   #{sparkline}  " +
+              sparkline = grades_sparkline(list).to_s(" ")
+              puts "        #{priority_range.arrow}   #{sparkline}  " \
                     "#{list.size.to_s.rjust(5)} objects"
               puts
             end
@@ -64,10 +65,10 @@ module Inch
             end
 
             sparkline = Sparkr::Sparkline.new(priorities.values)
-            sparkline.format do |tick, count, index|
-              tick.color( PRIORITY_COLORS[index] )
+            sparkline.format do |tick, _count, index|
+              tick.color(PRIORITY_COLORS[index])
             end
-            puts "  #{grade_list.grade}:  " + sparkline.to_s(' ') +
+            puts "  #{grade_list.grade}:  " + sparkline.to_s(" ") +
                   " #{grade_list.objects.size.to_s.rjust(5)} objects"
             puts
           end
@@ -76,7 +77,7 @@ module Inch
             arrows = Evaluation::PriorityRange.all.map(&:arrow)
             puts "Priority distribution in grades: (low to high)"
             puts
-            puts "      #{arrows.reverse.join('      ')}"
+            puts "      #{arrows.reverse.join("      ")}"
             @grade_lists.reverse.each do |grade_list|
               print_grade_list(grade_list)
             end
@@ -92,9 +93,9 @@ module Inch
 
           def stats_hash
             {
-              'grade_lists' => __grade_lists,
-              'scores' => __scores,
-              'priorities' => __priorities
+              "grade_lists" => __grade_lists,
+              "scores" => __scores,
+              "priorities" => __priorities
             }
           end
 
@@ -123,7 +124,6 @@ module Inch
             end
             hash
           end
-
         end
       end
     end

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

@@ -1,4 +1,4 @@
-require 'sparkr'
+require "sparkr"
 
 module Inch
   module CLI
@@ -11,18 +11,20 @@ module Inch
 
           FILE_COLOR = :dark # TODO: store all colors somewhere
           RANGE_LABELS = {
-            :A => "Nearly perfect:",
-            :B => "Properly documented, could be improved:",
-            :C => "Not properly documented:",
-            :U => "Undocumented:",
+            A: "Nearly perfect:",
+            B: "Properly documented, could be improved:",
+            C: "Not properly documented:",
+            U: "Undocumented:"
           }
 
           # @param options [Command::Options::Suggest]
-          # @param relevant_objects [Array<CodeObject::Proxy::Base>] the objects meeting the criteria defined in +options+
-          # @param objects_to_display [Array<CodeObject::Proxy::Base>]
+          # @param relevant_objects [Array<CodeObject::Proxy>] the objects
+          #   meeting the criteria defined in +options+
+          # @param objects_to_display [Array<CodeObject::Proxy>]
           # @param grade_lists [Array<Evaluation::GradeList>]
           # @param files [Array<Evaluation::File>]
-          def initialize(options, relevant_objects, objects_to_display, grade_lists, files)
+          def initialize(options, relevant_objects, objects_to_display,
+                         grade_lists, files)
             @options = options
             @objects = objects_to_display
             @relevant_objects = relevant_objects
@@ -45,7 +47,7 @@ module Inch
           end
 
           def display_distribution
-            sparkline = grades_sparkline(@relevant_objects).to_s(' ')
+            sparkline = grades_sparkline(@relevant_objects).to_s(" ")
             puts "Grade distribution (undocumented, C, B, A):  " + sparkline
             puts
             puts priority_filter_hint
@@ -54,10 +56,10 @@ module Inch
           def priority_filter_hint
             arrows = min_priority_arrows
             pretext = if @options.pedantic
-              "Considering priority objects: #{arrows}"
-            else
-              "Only considering priority objects: #{arrows}"
-            end
+                        "Considering priority objects: #{arrows}"
+                      else
+                        "Only considering priority objects: #{arrows}"
+                      end
             "#{pretext}  (use `--help` for options).".dark
           end
 
@@ -67,7 +69,7 @@ module Inch
             ui.trace
 
             files.each do |file|
-              filename = file.fullname.gsub(base_dir, '')
+              filename = file.fullname.gsub(base_dir, "")
               ui.edged(FILE_COLOR, filename.color(FILE_COLOR))
             end
             ui.trace
@@ -77,29 +79,30 @@ module Inch
             @options.grades_to_display.map do |grade|
               r = grade_list(grade)
               grade_objects = objects.select { |o| o.grade == r.grade }
-              unless grade_objects.empty?
-                ui.trace
-                ui.header(RANGE_LABELS[r.grade.to_sym], r.color, r.bg_color)
-                grade_objects.each do |o|
-                  grade = o.grade.to_s.ljust(2).color(r.color)
-                  priority = o.priority
-                  ui.sub(" #{grade} #{priority_arrow(priority, r.color)}  #{o.fullname}")
-                end
+              next if grade_objects.empty?
+              ui.trace
+              ui.header(RANGE_LABELS[r.grade.to_sym], r.color, r.bg_color)
+              grade_objects.each do |o|
+                grade = o.grade.to_s.ljust(2).color(r.color)
+                priority = o.priority
+                ui.sub(" #{grade} #{priority_arrow(priority, r.color)}  " \
+                       "#{o.fullname}")
               end
             end
           end
 
           def display_no_objects_hint
             hint = if @options.pedantic
-              "Even by my standards."
-            else
-              "Try --pedantic to be excessively concerned with minor details and rules."
-            end
+                     "Even by my standards."
+                   else
+                     "Try --pedantic to be excessively concerned with minor " \
+                       "details and rules."
+                   end
             ui.trace "Nothing to suggest.".color(:green) + " #{hint}"
           end
 
           def min_priority_arrows
-            priority_arrows_gte(@options.object_min_priority).join(' ')
+            priority_arrows_gte(@options.object_min_priority).join(" ")
           end
 
           def priority_arrows_gte(min_priority)
@@ -109,7 +112,7 @@ module Inch
           end
 
           def grade_list(grade_symbol)
-            @grade_lists.detect { |r| r.grade.to_sym == grade_symbol }
+            @grade_lists.find { |r| r.grade.to_sym == grade_symbol }
           end
         end
       end

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

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

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

@@ -1,5 +1,5 @@
-require 'inch/cli/command/options/stats'
-require 'inch/cli/command/output/stats'
+require "inch/cli/command/options/stats"
+require "inch/cli/command/output/stats"
 
 module Inch
   module CLI
@@ -8,11 +8,11 @@ module Inch
         register_command_as :stats
 
         def description
-          'Show statistics'
+          "Show statistics"
         end
 
         def usage
-          'Usage: inch stats [paths] [options]'
+          "Usage: inch stats [paths] [options]"
         end
 
         def run(*args)

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

@@ -1,5 +1,5 @@
-require 'inch/cli/command/options/suggest'
-require 'inch/cli/command/output/suggest'
+require "inch/cli/command/options/suggest"
+require "inch/cli/command/output/suggest"
 
 module Inch
   module CLI
@@ -8,11 +8,11 @@ module Inch
         register_command_as :suggest, true
 
         def description
-          'Suggests some objects to be documented (better)'
+          "Suggests some objects to be documented (better)"
         end
 
         def usage
-          'Usage: inch suggest [paths] [options]'
+          "Usage: inch suggest [paths] [options]"
         end
 
         # Runs the commandline utility, parsing arguments and displaying a
@@ -23,8 +23,8 @@ module Inch
         def run(*args)
           prepare_codebase(*args)
           context = API::Suggest.new(codebase, @options)
-          Output::Suggest.new(@options, context.all_objects,
-            context.objects, context.grade_lists, context.files)
+          Output::Suggest.new(@options, context.all_objects, context.objects,
+                              context.grade_lists, context.files)
         end
       end
     end

data/lib/inch/cli/command_parser.rb

@@ -1,6 +1,7 @@
 module Inch
   module CLI
-    # CommandParser parses a command-line arguments to decide which Command to run.
+    # CommandParser parses a command-line arguments to decide which Command to
+    # run.
     #
     # The basic form translates this shell command
     #
@@ -55,7 +56,7 @@ module Inch
       # argument.
       # @return [Command::Base]
       def run(*args)
-        if ['--help', '-h'].include?(args.join)
+        if ["--help", "-h"].include?(args.join)
           list_commands
         else
           run_command(*args)
@@ -72,9 +73,9 @@ module Inch
         ui.trace "Usage: inch <command> [options]"
         ui.trace
         ui.trace "Commands:"
-        commands.keys.sort_by {|k| k.to_s }.each do |command_name|
+        commands.keys.sort_by { |k| k.to_s }.each do |command_name|
           command = commands[command_name].new
-          ui.trace "  %-8s %s" % [command_name, command.description]
+          ui.trace format("  %-8s %s", command_name, command.description)
         end
       end
 
@@ -87,7 +88,7 @@ module Inch
         else
           possible_command_name = args.first.to_sym
 
-          if commands.has_key?(possible_command_name)
+          if commands.key?(possible_command_name)
             command_name = possible_command_name
             args.shift
           else

data/lib/inch/cli/sparkline_helper.rb

@@ -1,10 +1,10 @@
 module Inch
   module CLI
     module SparklineHelper
-      def grade_lists_sparkline(_grade_lists)
-        grade_lists = _grade_lists.reverse
-        list = grade_lists.map { |r| r.objects.size }
-        __sparkline(list, grade_lists)
+      def grade_lists_sparkline(grade_lists)
+        new_grade_lists = grade_lists.reverse
+        list = new_grade_lists.map { |r| r.objects.size }
+        __sparkline(list, new_grade_lists)
       end
 
       def grades_sparkline(objects)
@@ -21,9 +21,9 @@ module Inch
 
       def __sparkline(list, grade_lists)
         sparkline = Sparkr::Sparkline.new(list)
-        sparkline.format do |tick, count, index|
+        sparkline.format do |tick, _count, index|
           t = tick.color(grade_lists[index].color)
-          index == 0 ? t + ' ' : t
+          index == 0 ? t + " " : t
         end
       end
     end

data/lib/inch/cli/trace_helper.rb

@@ -1,4 +1,4 @@
-require 'inch/utils/ui'
+require "inch/utils/ui"
 
 module Inch
   module CLI

data/lib/inch/cli/yardopts_helper.rb

@@ -8,7 +8,8 @@ module Inch
       attr_accessor :excluded
 
       VALID_YARD_SWITCHES = %w(--private --no-private --protected --no-public
-          --plugin --load --safe --yardopts --no-yardopts --document --no-document)
+                               --plugin --load --safe --yardopts --no-yardopts
+                               --document --no-document)
 
       # Parses the option and gracefully handles invalid switches
       #
@@ -17,7 +18,7 @@ module Inch
       #   array will be modified.
       # @return [void]
       def parse_yardopts_options(opts, args)
-        wrapper = YardoptsWrapper.new()
+        wrapper = YardoptsWrapper.new
 
         dupped_args = args.dup
         dupped_args.delete("--help")
@@ -35,7 +36,7 @@ module Inch
       end
 
       def yardopts_options(opts)
-        wrapper = YardoptsWrapper.new()
+        wrapper = YardoptsWrapper.new
         wrapper.add_yardoc_options(opts)
       end