inch 0.5.0.rc5 → 0.5.0.rc6

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

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

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

@@ -7,12 +7,12 @@ module Inch
 
           def descriptions
             [
-              "",
-              "Lists objects that can be improved regarding their " \
-                "documentation ordered by their grade.",
-              "",
-              "Example: " + "$ inch list lib/**/*.rb --all".color(:cyan),
-              "",
+              '',
+              'Lists objects that can be improved regarding their ' \
+                'documentation ordered by their grade.',
+              '',
+              'Example: ' + '$ inch list lib/**/*.rb --all'.color(:cyan),
+              '',
               description_hint_grades,
               description_hint_arrows
             ]
@@ -20,7 +20,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
               @numbers = true
             end
           end

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

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

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

@@ -9,8 +9,8 @@ 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

@@ -25,13 +25,13 @@ module Inch
 
           def descriptions
             [
-              "",
-              "Suggests objects and files that can be improved regarding " \
-                "their documentation.",
-              "",
-              "Example: " +
-                "$ inch suggest lib/**/*.rb --pedantic".color(:cyan),
-              "",
+              '',
+              'Suggests objects and files that can be improved regarding ' \
+                'their documentation.',
+              '',
+              'Example: ' +
+                '$ inch suggest lib/**/*.rb --pedantic'.color(:cyan),
+              '',
               description_hint_grades,
               description_hint_arrows
             ]
@@ -40,14 +40,14 @@ module Inch
           protected
 
           def suggest_options(opts)
-            opts.separator ""
-            opts.separator "Suggest options:"
+            opts.separator ''
+            opts.separator 'Suggest options:'
 
-            opts.on("-n", "--objects [COUNT]", "Show COUNT objects") do |count|
+            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
               # 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

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

@@ -18,7 +18,7 @@ module Inch
             degraded = @comparer.degraded_objects
 
             if added.empty? && improved.empty? && degraded.empty?
-              ui.trace "No changes."
+              ui.trace 'No changes.'
             else
               show(added, improved, degraded)
             end
@@ -29,7 +29,7 @@ module Inch
           def show(added, improved, degraded)
             unless added.empty? && improved.empty?
               ui.trace
-              ui.header("Added or improved:", :green)
+              ui.header('Added or improved:', :green)
               added.each do |compare|
                 puts_added compare.after
               end
@@ -40,7 +40,7 @@ module Inch
 
             unless degraded.empty?
               ui.trace
-              ui.header("Degraded:", :red)
+              ui.header('Degraded:', :red)
               degraded.each do |compare|
                 puts_degraded compare.before, compare.after
               end
@@ -48,20 +48,20 @@ module Inch
             ui.trace
             ui.trace rev_hint
             ui.trace
-            ui.trace "Format: grade (before -> after), priority, and name. " \
+            ui.trace 'Format: grade (before -> after), priority, and name. ' \
                       "Try `--help' for options.".dark
           end
 
           def puts_added(o)
             grade = colored_grade(o)
-            change = "  +  ".dark + grade + "  " + priority_arrow(o.priority)
+            change = '  +  '.dark + grade + '  ' + priority_arrow(o.priority)
             ui.sub(" #{change}  #{o.fullname}")
           end
 
           def puts_improved(before, o)
             before_grade = colored_grade(before)
             grade = colored_grade(o)
-            change = before_grade + " -> ".dark + grade + "  " +
+            change = before_grade + ' -> '.dark + grade + '  ' +
               priority_arrow(o.priority)
             ui.sub(" #{change}  #{o.fullname}")
           end
@@ -79,13 +79,13 @@ module Inch
 
           def rev_hint
             if @options.since_last_commit?
-              "Showing changes since your last commit."
+              'Showing changes since your last commit.'
             elsif @options.since_last_push?
-              "Showing changes since you last pushed."
+              'Showing changes since you last pushed.'
             else
               revisions = @options.revisions
               before_rev = revisions[0]
-              after_rev = revisions[1] || "now"
+              after_rev = revisions[1] || 'now'
               "Showing changes between #{before_rev} and #{after_rev}."
             end
           end

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
@@ -56,7 +56,7 @@ module Inch
 
           def print_roles_info(o)
             if o.roles.empty?
-              echo "No roles assigned.".dark
+              echo 'No roles assigned.'.dark
             else
               o.roles.each do |role|
                 print_role_info(role)
@@ -66,7 +66,7 @@ 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)
@@ -86,9 +86,9 @@ module Inch
 
           def print_namespace_info(o)
             if o.namespace?
-              echo "Children:"
+              echo 'Children:'
               o.children.each do |child|
-                echo "+ " + child.fullname.color(COLOR)
+                echo '+ ' + child.fullname.color(COLOR)
               end
               echo separator
             end
@@ -105,20 +105,20 @@ module Inch
 
           def colored_score(value, score)
             if value < 0
-              ("-" + score).red
+              ('-' + score).red
             elsif value > 0
-              ("+" + score).green
+              ('+' + score).green
             else
-              " " + score
+              ' ' + score
             end
           end
 
-          def echo(msg = "")
+          def echo(msg = '')
             ui.edged(COLOR, msg)
           end
 
           def separator
-            "-".color(COLOR) * (CLI::COLUMNS - 2)
+            '-'.color(COLOR) * (CLI::COLUMNS - 2)
           end
 
           class CommentAndAbbrevSource < Struct.new(:code_object)
@@ -131,7 +131,7 @@ module Inch
             end
 
             def to_s
-              comments.join("") + abbrev_source
+              comments.join('') + abbrev_source
             end
 
             private
@@ -139,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

@@ -32,7 +32,7 @@ module Inch
             if @omitted > 0
               ui.trace
               ui.trace "This output omitted #{@omitted} objects. ".dark +
-                  "Use `--all` to display all objects.".dark
+                  'Use `--all` to display all objects.'.dark
             end
           end
 

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

@@ -40,22 +40,22 @@ module Inch
 
           def print_roles_info(o)
             if o.roles.empty?
-              echo "No roles assigned.".dark
+              echo 'No roles assigned.'.dark
             else
               o.roles.each do |role|
                 next unless role.suggestion
-                echo "+".color(COLOR) + " #{role.suggestion}"
+                echo '+'.color(COLOR) + " #{role.suggestion}"
               end
             end
             echo separator
           end
 
-          def echo(msg = "")
+          def echo(msg = '')
             ui.edged(COLOR, msg)
           end
 
           def separator
-            "-".color(COLOR) * (CLI::COLUMNS - 2)
+            '-'.color(COLOR) * (CLI::COLUMNS - 2)
           end
 
           def grade(score)

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

@@ -1,5 +1,5 @@
-require "json"
-require "yaml"
+require 'json'
+require 'yaml'
 
 module Inch
   module CLI
@@ -31,25 +31,25 @@ module Inch
             print_grades_by_priority
             print_priorities
             ui.trace
-            ui.trace "Try `--format json|yaml` for raw numbers.".dark
+            ui.trace '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(' ')
             ui.trace
-            ui.trace "Grade distribution: (undocumented, C, B, A)"
+            ui.trace 'Grade distribution: (undocumented, C, B, A)'
             ui.trace
             ui.trace "  Overall:  #{sparkline}  #{objects.size.to_s.rjust(5)} " \
-              "objects"
+              'objects'
             ui.trace
           end
 
           def print_grades_by_priority
-            ui.trace "Grade distribution by priority:"
+            ui.trace 'Grade distribution by priority:'
             ui.trace
             Evaluation::PriorityRange.all.each do |priority_range|
               list = objects.select { |o| priority_range.include?(o.priority) }
-              sparkline = grades_sparkline(list).to_s(" ")
+              sparkline = grades_sparkline(list).to_s(' ')
               ui.trace "        #{priority_range.arrow}   #{sparkline}  " \
                     "#{list.size.to_s.rjust(5)} objects"
               ui.trace
@@ -68,16 +68,16 @@ module Inch
             sparkline.format do |tick, _count, index|
               tick.color(PRIORITY_COLORS[index])
             end
-            ui.trace "  #{grade_list.grade}:  " + sparkline.to_s(" ") +
+            ui.trace "  #{grade_list.grade}:  " + sparkline.to_s(' ') +
                   " #{grade_list.objects.size.to_s.rjust(5)} objects"
             ui.trace
           end
 
           def print_priorities
             arrows = Evaluation::PriorityRange.all.map(&:arrow)
-            ui.trace "Priority distribution in grades: (low to high)"
+            ui.trace 'Priority distribution in grades: (low to high)'
             ui.trace
-            ui.trace "      #{arrows.reverse.join("      ")}"
+            ui.trace "      #{arrows.reverse.join('      ')}"
             @grade_lists.reverse.each do |grade_list|
               print_grade_list(grade_list)
             end
@@ -93,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
 

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

@@ -1,4 +1,4 @@
-require "sparkr"
+require 'sparkr'
 
 module Inch
   module CLI
@@ -11,10 +11,10 @@ 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]
@@ -47,8 +47,8 @@ module Inch
           end
 
           def display_distribution
-            sparkline = grades_sparkline(@relevant_objects).to_s(" ")
-            ui.trace "Grade distribution (undocumented, C, B, A):  " + sparkline
+            sparkline = grades_sparkline(@relevant_objects).to_s(' ')
+            ui.trace 'Grade distribution (undocumented, C, B, A):  ' + sparkline
             ui.trace
             ui.trace priority_filter_hint
           end
@@ -65,11 +65,11 @@ module Inch
 
           def display_files
             ui.trace
-            ui.trace "You might want to look at these files:"
+            ui.trace 'You might want to look at these files:'
             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
@@ -93,16 +93,16 @@ module Inch
 
           def display_no_objects_hint
             hint = if @options.pedantic
-                     "Even by my standards."
+                     'Even by my standards.'
                    else
-                     "Try --pedantic to be excessively concerned with minor " \
-                       "details and rules."
+                     'Try --pedantic to be excessively concerned with minor ' \
+                       'details and rules.'
                    end
-            ui.trace "Nothing to suggest.".color(:green) + " #{hint}"
+            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)