inch 0.5.0.rc5 → 0.5.0.rc6

data/lib/inch/api/suggest.rb

@@ -1,4 +1,4 @@
-require "inch/utils/weighted_list"
+require 'inch/utils/weighted_list'
 
 module Inch
   module API

data/lib/inch/cli.rb

@@ -11,7 +11,7 @@ module Inch
       # @return [Fixnum]
       def get_term_columns(default = 80)
         str = `stty size`
-        rows_cols = str.split(" ").map(&:to_i)
+        rows_cols = str.split(' ').map(&:to_i)
         rows_cols[1] || default
       rescue
         default
@@ -21,9 +21,9 @@ module Inch
   end
 end
 
-require "inch/cli/arguments"
-require "inch/cli/sparkline_helper"
-require "inch/cli/trace_helper"
-require "inch/cli/yardopts_helper"
+require 'inch/cli/arguments'
+require 'inch/cli/sparkline_helper'
+require 'inch/cli/trace_helper'
+require 'inch/cli/yardopts_helper'
 
-require "inch/cli/command"
+require 'inch/cli/command'

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

@@ -69,7 +69,7 @@ module Inch
         #
         # @return [String]
         def description
-          ""
+          ''
         end
 
         # Returns the name of the command by which it is referenced
@@ -101,7 +101,7 @@ module Inch
         protected
 
         def initialize_cli_options
-          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
@@ -116,7 +116,9 @@ module Inch
         def to_config(options)
           config = Config.for(@options.language, Dir.pwd).codebase
           config.included_files = options.paths unless options.paths.empty?
-          config.excluded_files = options.excluded unless options.excluded.empty?
+          unless options.excluded.empty?
+            config.excluded_files = options.excluded
+          end
           config.read_dump_file = options.read_dump_file
           config
         end

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

@@ -23,7 +23,6 @@ module Inch
 
           @codebase = ::Inch::Codebase.parse(Dir.pwd, to_config(@options))
         end
-
       end
     end
   end

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)
@@ -24,7 +24,7 @@ module Inch
 
           before_rev, after_rev = revisions[0], revisions[1]
           diff = API::Diff.new(work_dir, to_config(@options),
-                                          before_rev, after_rev)
+                               before_rev, after_rev)
 
           Output::Diff.new(@options, diff.comparer)
         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,12 @@ 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
@@ -36,8 +36,8 @@ module Inch
             end
           end
 
-          attribute :usage, ""    # usage description for the command
-          attribute :language, "ruby"    # the programming language
+          attribute :usage, ''    # usage description for the command
+          attribute :language, 'ruby'    # the programming language
           attribute :read_dump_file, nil
           attribute :paths, []    # the paths of the to-be-analysed sources
           attribute :excluded, [] # paths to be excluded from the analysis
@@ -53,7 +53,7 @@ module Inch
             opts.banner = usage
 
             descriptions.each do |text|
-              opts.separator "  " + text
+              opts.separator '  ' + text
             end
 
             set_options(opts)
@@ -95,9 +95,9 @@ module Inch
           #
           # @return [String]
           def description_hint_arrows
-            arrows = Evaluation::PriorityRange.all.map(&:arrow).join(" ")
+            arrows = Evaluation::PriorityRange.all.map(&:arrow).join(' ')
             "Arrows (#{arrows}) hint at the importance of the object " \
-              "being documented."
+              'being documented.'
           end
 
           # Returns a decriptive hint explaining the arrows used to represent
@@ -106,8 +106,8 @@ module Inch
           # @return [String]
           def description_hint_grades
             grades = Evaluation::Grade.all
-            "School grades (#{grades.join(", ")}) are assigned and " \
-              "displayed with each object."
+            "School grades (#{grades.join(', ')}) are assigned and " \
+              'displayed with each object.'
           end
 
           def get_paths(args)
@@ -120,22 +120,24 @@ module Inch
           # @param [OptionParser] opts the option parser object
           # @return [void]
           def common_options(opts)
-            opts.separator ""
-            opts.separator "Other options:"
-            opts.on("--[no-]color", "Run without color") do |v|
+            opts.separator ''
+            opts.separator 'Other options:'
+            opts.on('--[no-]color', 'Run without color') do |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("-l", "--language [LANGUAGE]", "Set language (ruby|nodejs).") do |language|
+            opts.on_tail('-l', '--language [LANGUAGE]',
+                         'Set language (elixir|nodejs|ruby).') do |language|
               @language = language
             end
-            opts.on_tail("-r", "--read-from-dump [FILE]", "Read objects from dump.") do |file|
+            opts.on_tail('-r', '--read-from-dump [FILE]',
+                         'Read objects from dump.') do |file|
               @read_dump_file = file
             end
-            opts.on_tail("-h", "--help", "Show this help.") do
+            opts.on_tail('-h', '--help', 'Show this help.') do
               ui.trace opts
               exit
             end

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

@@ -18,7 +18,7 @@ module Inch
             opts.banner = usage
 
             descriptions.each do |text|
-              opts.separator "  " + text
+              opts.separator '  ' + text
             end
 
             set_options(opts)
@@ -42,43 +42,43 @@ module Inch
           # @param opts [OptionParser]
           # @return [void]
           def list_options(opts)
-            opts.separator ""
-            opts.separator "List options:"
+            opts.separator ''
+            opts.separator 'List options:'
 
-            opts.on("--all", "Show all objects in the output") do
+            opts.on('--all', 'Show all objects in the output') do
               @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
 
-            opts.on("--no-public", "Do not show public objects") do
+            opts.on('--no-public', 'Do not show public objects') do
               set_visibility :public, false
             end
-            opts.on("--no-protected", "Do not show protected objects") do
+            opts.on('--no-protected', 'Do not show protected objects') do
               set_visibility :protected, false
             end
-            opts.on("--private", "Show private objects") do
+            opts.on('--private', 'Show private objects') do
               set_visibility :private, true
             end
 
-            opts.on("--only-undocumented", "Only show undocumented objects") do
+            opts.on('--only-undocumented', 'Only show undocumented objects') do
               @undocumented = :only
             end
-            opts.on("--no-undocumented", "Only show documented objects") do
+            opts.on('--no-undocumented', 'Only show documented objects') do
               @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/base_object.rb

@@ -10,7 +10,7 @@ module Inch
             opts.banner = usage
 
             descriptions.each do |text|
-              opts.separator "  " + text
+              opts.separator '  ' + text
             end
 
             set_options(opts)

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

@@ -5,19 +5,19 @@ module Inch
         class Console < BaseObject
           def descriptions
             [
-              "",
-              "Provides a PRY based REPL to inspect objects.",
-              "",
-              "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)"
+              '',
+              'Provides a PRY based REPL to inspect objects.',
+              '',
+              '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)'
             ]
           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
@@ -8,18 +8,18 @@ module Inch
           include Utils::ShellHelper
 
           def initialize
-            @before_rev = "HEAD"
+            @before_rev = 'HEAD'
             @after_rev  = nil
           end
 
           def descriptions
             [
-              "",
-              "Shows changes in documentation between two revisions " \
-                "(defaults to last commit against current)",
-              "",
-              "Example: " + "$ inch diff HEAD^..HEAD".color(:cyan),
-              "",
+              '',
+              'Shows changes in documentation between two revisions ' \
+                '(defaults to last commit against current)',
+              '',
+              'Example: ' + '$ inch diff HEAD^..HEAD'.color(:cyan),
+              '',
               description_hint_grades,
               description_hint_arrows
             ]
@@ -41,12 +41,12 @@ module Inch
             if object_names.empty?
               [@before_rev, @after_rev]
             else
-              object_names.first.split("..")
+              object_names.first.split('..')
             end
           end
 
           def since_last_commit?
-            revisions == ["HEAD", nil]
+            revisions == ['HEAD', nil]
           end
 
           def since_last_push?
@@ -56,15 +56,15 @@ module Inch
           private
 
           def diff_options(opts)
-            opts.separator ""
-            opts.separator "Diff options:"
+            opts.separator ''
+            opts.separator 'Diff options:'
 
-            opts.on("--since-last-commit",
-                    "Run diff against last commit (default)") do
-              @before_rev = "HEAD"
+            opts.on('--since-last-commit',
+                    'Run diff against last commit (default)') do
+              @before_rev = 'HEAD'
             end
-            opts.on("-p", "--since-last-push",
-                    "Run diff against last pushed commit") do
+            opts.on('-p', '--since-last-push',
+                    'Run diff against last pushed commit') do
               @before_rev = pushed_rev
               @since_last_push = true
             end
@@ -79,11 +79,11 @@ module Inch
           end
 
           def current_branch
-            git Dir.pwd, "rev-parse --abbrev-ref HEAD"
+            git Dir.pwd, 'rev-parse --abbrev-ref HEAD'
           end
 
           def remote
-            "origin"
+            'origin'
           end
         end
       end