inch 0.5.0.rc5 → 0.5.0.rc6

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

data/lib/inch/cli/command_parser.rb

@@ -56,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)
@@ -70,12 +70,12 @@ module Inch
       end
 
       def list_commands
-        ui.trace "Usage: inch <command> [options]"
+        ui.trace 'Usage: inch <command> [options]'
         ui.trace
-        ui.trace "Commands:"
+        ui.trace 'Commands:'
         commands.keys.sort_by { |k| k.to_s }.each do |command_name|
           command = commands[command_name].new
-          ui.trace format("  %-8s %s", command_name, command.description)
+          ui.trace format('  %-8s %s', command_name, command.description)
         end
       end
 

data/lib/inch/cli/sparkline_helper.rb

@@ -23,7 +23,7 @@ module Inch
         sparkline = Sparkr::Sparkline.new(list)
         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

@@ -21,7 +21,7 @@ module Inch
         wrapper = YardoptsWrapper.new
 
         dupped_args = args.dup
-        dupped_args.delete("--help")
+        dupped_args.delete('--help')
         dupped_args.delete_if do |arg|
           arg =~ /^\-/ && !VALID_YARD_SWITCHES.include?(arg)
         end

data/lib/inch/code_object.rb

@@ -3,6 +3,6 @@ module Inch
   end
 end
 
-require "inch/code_object/converter"
-require "inch/code_object/provider"
-require "inch/code_object/proxy"
+require 'inch/code_object/converter'
+require 'inch/code_object/provider'
+require 'inch/code_object/proxy'

data/lib/inch/code_object/provider.rb

@@ -12,11 +12,11 @@ module Inch
     # converted into CodeObject::Proxy objects that form the codebase:
     #
     #                        ::YARD::CodeObject
-    #                               ↓
+    #                               |
     #           ::Inch::CodeObject::Provider::YARD::Object::Base
-    #                               ↓
+    #                               |
     #                             (Hash)
-    #                               ↓
+    #                               |
     #                   ::Inch::CodeObject::Proxy
     #
     #

data/lib/inch/code_object/proxy.rb

@@ -37,7 +37,7 @@ module Inch
 
       # @return [Symbol] the programming language of the code object
       def language
-        raise NotImplementedError
+        fail NotImplementedError
       end
 
       # Used to persist the code object
@@ -54,17 +54,16 @@ module Inch
         "#<#{self.class}: #{fullname}>"
       end
 
-      private
-
       # Returns a Proxy class for the given +code_object+
       #
       # @param language [String,Symbol]
       # @param code_object [YARD::CodeObject]
       # @return [Class]
       def self.class_for(language, code_object)
-        class_name = code_object.class.to_s.split("::").last
+        class_name = code_object.class.to_s.split('::').last
         Config.namespace(language, :CodeObject).const_get(class_name)
       end
+      private_class_method :class_for
     end
   end
 end

data/lib/inch/codebase.rb

@@ -14,8 +14,8 @@ module Inch
   end
 end
 
-require "inch/codebase/proxy"
-require "inch/codebase/object"
-require "inch/codebase/objects"
-require "inch/codebase/objects_filter"
-require "inch/codebase/serializer"
+require 'inch/codebase/proxy'
+require 'inch/codebase/object'
+require 'inch/codebase/objects'
+require 'inch/codebase/objects_filter'
+require 'inch/codebase/serializer'

data/lib/inch/codebase/object.rb

@@ -29,7 +29,8 @@ module Inch
       # @param object_lookup [Codebase::Objects]
       def initialize(language, code_object, object_lookup)
         @language = language
-        @code_object = CodeObject::Proxy.for(language, code_object, object_lookup)
+        @code_object = CodeObject::Proxy.for(language, code_object,
+                                             object_lookup)
       end
 
       def evaluation

data/lib/inch/codebase/serializer.rb

@@ -1,7 +1,7 @@
 module Inch
   module Codebase
     class Serializer
-      INCH_DB_DIR = File.join(".inch", "db")
+      INCH_DB_DIR = File.join('.inch', 'db')
 
       def self.filename(revision)
         File.join(INCH_DB_DIR, revision)
@@ -10,7 +10,7 @@ module Inch
       def self.save(codebase, filename)
         content = Marshal.dump(codebase)
         FileUtils.mkdir_p(File.dirname(filename))
-        File.open(filename, "wb") { |file| file.write(content) }
+        File.open(filename, 'wb') { |file| file.write(content) }
       end
 
       def self.load(filename)

data/lib/inch/config.rb

@@ -5,12 +5,12 @@ module Inch
   class Config
     class << self
       def instance(language = :ruby)
-        if block = @blocks[language.to_s]
+        if (block = @blocks[language.to_s])
           config = Config::Base.new(language)
           config = config.update(&block)
           config
         else
-          raise "Language not registered: #{language}"
+          fail "Language not registered: #{language}"
         end
       end
 
@@ -41,7 +41,7 @@ module Inch
       end
 
       def namespace(language, submodule = nil)
-        name = language.to_s.split('_').collect { |w| w.capitalize }.join
+        name = language.to_s.split('_').map { |w| w.capitalize }.join
         const = ::Inch::Language.const_get(name)
         const = const.const_get(submodule) unless submodule.nil?
         const
@@ -50,6 +50,6 @@ module Inch
   end
 end
 
-require "inch/config/base"
-require "inch/config/evaluation"
-require "inch/config/codebase"
+require 'inch/config/base'
+require 'inch/config/evaluation'
+require 'inch/config/codebase'

data/lib/inch/config/codebase.rb

@@ -7,7 +7,7 @@ module Inch
       attr_accessor :excluded_files
       attr_accessor :read_dump_file
 
-      YAML_FILE = ".inch.yml"
+      YAML_FILE = '.inch.yml'
 
       def initialize(language = :ruby, included = nil, excluded = nil)
         @language = language
@@ -39,8 +39,8 @@ module Inch
       def update_via_yaml(dir)
         if (yaml = self.class.yaml(dir))
           Dir.chdir(dir) do
-            update_language yaml["language"]
-            update_files yaml["files"]
+            update_language yaml['language']
+            update_files yaml['files']
           end
         end
       end
@@ -77,8 +77,8 @@ module Inch
 
       def update_files(files)
         return if files.nil?
-        @included_files = expand_files(files["included"]) if files["included"]
-        @excluded_files = expand_files(files["excluded"]) if files["excluded"]
+        @included_files = expand_files(files['included']) if files['included']
+        @excluded_files = expand_files(files['excluded']) if files['excluded']
       end
 
       def update_language(language)

data/lib/inch/core_ext.rb

@@ -1 +1 @@
-require "inch/core_ext/string"
+require 'inch/core_ext/string'

data/lib/inch/core_ext/string.rb

@@ -1,3 +1,3 @@
-require "term/ansicolor"
+require 'term/ansicolor'
 
 String.send(:include, Term::ANSIColor)

data/lib/inch/evaluation.rb

@@ -9,19 +9,19 @@ module Inch
     private
 
     def self.class_for(language, code_object)
-      class_name = code_object.class.to_s.split("::").last
+      class_name = code_object.class.to_s.split('::').last
       language_namespace = Evaluation::Ruby
       language_namespace.const_get(class_name)
     end
   end
 end
 
-require "inch/utils/read_write_methods"
+require 'inch/utils/read_write_methods'
 
-require "inch/evaluation/file"
-require "inch/evaluation/grade"
-require "inch/evaluation/grade_list"
-require "inch/evaluation/priority_range"
+require 'inch/evaluation/file'
+require 'inch/evaluation/grade'
+require 'inch/evaluation/grade_list'
+require 'inch/evaluation/priority_range'
 
-require "inch/evaluation/proxy"
-require "inch/evaluation/role"
+require 'inch/evaluation/proxy'
+require 'inch/evaluation/role'

data/lib/inch/evaluation/proxy.rb

@@ -140,12 +140,11 @@ module Inch
         @roles.reduce(0) { |sum, r| sum + r.priority.to_i }
       end
 
-      private
-
       def self.class_for(language, code_object)
-        class_name = code_object.class.to_s.split("::").last
+        class_name = code_object.class.to_s.split('::').last
         Config.namespace(language, :Evaluation).const_get(class_name)
       end
+      private_class_method :class_for
     end
   end
 end

data/lib/inch/evaluation/role.rb

@@ -92,7 +92,7 @@ module Inch
       #
       # @return [String]
       def object_type
-        raise NotImplementedError
+        fail NotImplementedError
       end
     end
   end

data/lib/inch/language/elixir/code_object/base.rb

@@ -1,4 +1,4 @@
-require "forwardable"
+require 'forwardable'
 
 module Inch
   module Language
@@ -14,7 +14,8 @@ module Inch
             :elixir
           end
 
-          # @return [Boolean] if the current object is an alias for something else
+          # @return [Boolean] if the current object is an alias for something
+          #   else
           def alias?
             !aliased_object.nil?
           end
@@ -133,7 +134,8 @@ module Inch
             self[:original_docstring]
           end
 
-          # @return [Boolean] +true+ if the object was tagged not to be documented
+          # @return [Boolean] +true+ if the object was tagged not to be
+          #   documented
           def nodoc?
             self[:nodoc?]
           end
@@ -174,7 +176,7 @@ module Inch
           end
 
           def type
-            self.class.to_s.gsub(/Object$/, "")
+            self.class.to_s.gsub(/Object$/, '')
           end
 
           # @return [Boolean] +true+ if the object has no documentation at all

data/lib/inch/language/elixir/evaluation/base.rb

@@ -18,7 +18,8 @@ module Inch
               Role::Object::WithCodeExample => score_for(:code_example_single),
               Role::Object::WithMultipleCodeExamples =>
                 score_for(:code_example_multi),
-              Role::Object::WithoutCodeExample => score_for(:code_example_single)
+              Role::Object::WithoutCodeExample =>
+                score_for(:code_example_single)
             }
           end
         end

data/lib/inch/language/elixir/evaluation/function_object.rb

@@ -21,7 +21,7 @@ module Inch
                   nil
                 end,
               Role::Function::WithBangName => nil,
-              Role::Function::WithQuestioningName => nil,
+              Role::Function::WithQuestioningName => nil
             }
           end
         end

data/lib/inch/language/elixir/import.rb

@@ -5,20 +5,20 @@ module Inch
   end
 end
 
-require "inch/language/elixir/provider/reader"
+require 'inch/language/elixir/provider/reader'
 
-require "inch/language/elixir/code_object/base"
-require "inch/language/elixir/code_object/module_object"
-require "inch/language/elixir/code_object/function_object"
-require "inch/language/elixir/code_object/type_object"
+require 'inch/language/elixir/code_object/base'
+require 'inch/language/elixir/code_object/module_object'
+require 'inch/language/elixir/code_object/function_object'
+require 'inch/language/elixir/code_object/type_object'
 
-require "inch/language/elixir/evaluation/base"
-require "inch/language/elixir/evaluation/module_object"
-require "inch/language/elixir/evaluation/function_object"
-require "inch/language/elixir/evaluation/type_object"
+require 'inch/language/elixir/evaluation/base'
+require 'inch/language/elixir/evaluation/module_object'
+require 'inch/language/elixir/evaluation/function_object'
+require 'inch/language/elixir/evaluation/type_object'
 
-require "inch/language/elixir/roles/base"
-require "inch/language/elixir/roles/object"
-require "inch/language/elixir/roles/module"
-require "inch/language/elixir/roles/function"
-require "inch/language/elixir/roles/type"
+require 'inch/language/elixir/roles/base'
+require 'inch/language/elixir/roles/object'
+require 'inch/language/elixir/roles/module'
+require 'inch/language/elixir/roles/function'
+require 'inch/language/elixir/roles/type'

data/lib/inch/language/elixir/provider/reader.rb

@@ -16,4 +16,4 @@ module Inch
   end
 end
 
-require "inch/language/elixir/provider/reader/parser"
+require 'inch/language/elixir/provider/reader/parser'

data/lib/inch/language/elixir/provider/reader/docstring.rb

@@ -0,0 +1,13 @@
+
+module Inch
+  module Language
+    module Elixir
+      module Provider
+        module Reader
+          class Docstring < Ruby::Provider::YARD::Docstring
+          end
+        end
+      end
+    end
+  end
+end