inch 0.5.0.rc5 → 0.5.0.rc6

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

@@ -20,7 +20,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),
               Role::Object::Tagged => score_for_unconsidered_tags,
               Role::Object::TaggedAsAPI => nil,
               Role::Object::TaggedAsInternalAPI => nil,

data/lib/inch/language/ruby/evaluation/method_object.rb

@@ -53,7 +53,8 @@ module Inch
 
           def relevant_parameter_roles(param, per_param)
             {
-              Role::MethodParameter::WithWrongMention => -score_for(:parameters),
+              Role::MethodParameter::WithWrongMention =>
+                -score_for(:parameters),
               Role::MethodParameter::WithMention => per_param * 0.5,
               Role::MethodParameter::WithoutMention => per_param * 0.5,
               Role::MethodParameter::WithType => per_param * 0.5,

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

@@ -5,30 +5,30 @@ module Inch
   end
 end
 
-require "inch/language/ruby/provider/yard"
+require 'inch/language/ruby/provider/yard'
 
-require "inch/language/ruby/code_object/base"
-require "inch/language/ruby/code_object/namespace_object"
-require "inch/language/ruby/code_object/class_object"
-require "inch/language/ruby/code_object/class_variable_object"
-require "inch/language/ruby/code_object/constant_object"
-require "inch/language/ruby/code_object/method_object"
-require "inch/language/ruby/code_object/method_parameter_object"
-require "inch/language/ruby/code_object/module_object"
+require 'inch/language/ruby/code_object/base'
+require 'inch/language/ruby/code_object/namespace_object'
+require 'inch/language/ruby/code_object/class_object'
+require 'inch/language/ruby/code_object/class_variable_object'
+require 'inch/language/ruby/code_object/constant_object'
+require 'inch/language/ruby/code_object/method_object'
+require 'inch/language/ruby/code_object/method_parameter_object'
+require 'inch/language/ruby/code_object/module_object'
 
-require "inch/language/ruby/evaluation/base"
-require "inch/language/ruby/evaluation/namespace_object"
-require "inch/language/ruby/evaluation/class_object"
-require "inch/language/ruby/evaluation/class_variable_object"
-require "inch/language/ruby/evaluation/constant_object"
-require "inch/language/ruby/evaluation/method_object"
-require "inch/language/ruby/evaluation/module_object"
+require 'inch/language/ruby/evaluation/base'
+require 'inch/language/ruby/evaluation/namespace_object'
+require 'inch/language/ruby/evaluation/class_object'
+require 'inch/language/ruby/evaluation/class_variable_object'
+require 'inch/language/ruby/evaluation/constant_object'
+require 'inch/language/ruby/evaluation/method_object'
+require 'inch/language/ruby/evaluation/module_object'
 
-require "inch/language/ruby/roles/base"
-require "inch/language/ruby/roles/missing"
-require "inch/language/ruby/roles/object"
-require "inch/language/ruby/roles/method"
-require "inch/language/ruby/roles/method_parameter"
-require "inch/language/ruby/roles/namespace"
-require "inch/language/ruby/roles/constant"
-require "inch/language/ruby/roles/class_variable"
+require 'inch/language/ruby/roles/base'
+require 'inch/language/ruby/roles/missing'
+require 'inch/language/ruby/roles/object'
+require 'inch/language/ruby/roles/method'
+require 'inch/language/ruby/roles/method_parameter'
+require 'inch/language/ruby/roles/namespace'
+require 'inch/language/ruby/roles/constant'
+require 'inch/language/ruby/roles/class_variable'

data/lib/inch/language/ruby/provider/yard.rb

@@ -13,7 +13,7 @@ module Inch
             if method.getter?
               docstring.to_s == "Returns the value of attribute #{name}"
             elsif method.setter?
-              basename = name.to_s.gsub(/(\=)$/, "")
+              basename = name.to_s.gsub(/(\=)$/, '')
               docstring.to_s == "Sets the attribute #{basename}"
             else
               false
@@ -27,11 +27,11 @@ module Inch
           def self.implicit_tag?(tag, method)
             name = method.name
             if method.getter?
-              tag.tag_name == "return" &&
+              tag.tag_name == 'return' &&
                 tag.text == "the current value of #{name}"
             elsif method.setter?
-              tag.tag_name == "return" &&
-                tag.text == "the newly set value"
+              tag.tag_name == 'return' &&
+                tag.text == 'the newly set value'
             else
               false
             end
@@ -47,12 +47,12 @@ module Inch
   end
 end
 
-require "logger"
-require "yard"
+require 'logger'
+require 'yard'
 
 log.level = ::Logger::UNKNOWN # basically disable YARD's logging
 
-require "inch/language/ruby/provider/yard/parser"
-require "inch/language/ruby/provider/yard/docstring"
-require "inch/language/ruby/provider/yard/nodoc_helper"
-require "inch/language/ruby/provider/yard/object"
+require 'inch/language/ruby/provider/yard/parser'
+require 'inch/language/ruby/provider/yard/docstring'
+require 'inch/language/ruby/provider/yard/nodoc_helper'
+require 'inch/language/ruby/provider/yard/object'

data/lib/inch/language/ruby/provider/yard/nodoc_helper.rb

@@ -86,8 +86,8 @@ module Inch
               line_number.times { f.gets }
               result = $LAST_READ_LINE
               f.close
-              result.encode("UTF-8", "binary",
-                            invalid: :replace, undef: :replace, replace: "")
+              result.encode('UTF-8', 'binary',
+                            invalid: :replace, undef: :replace, replace: '')
             end
           end
         end

data/lib/inch/language/ruby/provider/yard/object.rb

@@ -32,7 +32,7 @@ module Inch
               # @param yard_object [YARD::CodeObject]
               # @return [Class]
               def class_for(yard_object)
-                class_name = yard_object.class.to_s.split("::").last
+                class_name = yard_object.class.to_s.split('::').last
                 const_get(class_name)
               rescue NameError
                 Base
@@ -53,11 +53,11 @@ module Inch
   end
 end
 
-require "inch/language/ruby/provider/yard/object/base"
-require "inch/language/ruby/provider/yard/object/namespace_object"
-require "inch/language/ruby/provider/yard/object/class_object"
-require "inch/language/ruby/provider/yard/object/class_variable_object"
-require "inch/language/ruby/provider/yard/object/constant_object"
-require "inch/language/ruby/provider/yard/object/method_object"
-require "inch/language/ruby/provider/yard/object/method_parameter_object"
-require "inch/language/ruby/provider/yard/object/module_object"
+require 'inch/language/ruby/provider/yard/object/base'
+require 'inch/language/ruby/provider/yard/object/namespace_object'
+require 'inch/language/ruby/provider/yard/object/class_object'
+require 'inch/language/ruby/provider/yard/object/class_variable_object'
+require 'inch/language/ruby/provider/yard/object/constant_object'
+require 'inch/language/ruby/provider/yard/object/method_object'
+require 'inch/language/ruby/provider/yard/object/method_parameter_object'
+require 'inch/language/ruby/provider/yard/object/module_object'

data/lib/inch/language/ruby/provider/yard/object/base.rb

@@ -1,4 +1,5 @@
-require "forwardable"
+require 'forwardable'
+require 'inch/utils/code_location'
 
 module Inch
   module Language
@@ -59,8 +60,8 @@ module Inch
                 nil
               end
 
-              # @return [Array,nil] the full names of the children of the current
-              #   object
+              # @return [Array,nil] the full names of the children of the
+              #   current object
               def children_fullnames
                 []
               end
@@ -75,11 +76,12 @@ module Inch
                 Array Bignum BasicObject Object Module Class Complex NilClass
                 Numeric String Float Fiber FiberError Continuation Dir File
                 Encoding Enumerator StopIteration Enumerator::Generator
-                Enumerator::Yielder Exception SystemExit SignalException Interrupt
-                StandardError TypeError ArgumentError IndexError KeyError
-                RangeError ScriptError SyntaxError LoadError NotImplementedError
-                NameError NoMethodError RuntimeError SecurityError NoMemoryError
-                EncodingError SystemCallError Encoding::CompatibilityError
+                Enumerator::Yielder Exception SystemExit SignalException
+                Interrupt StandardError TypeError ArgumentError IndexError
+                KeyError RangeError ScriptError SyntaxError LoadError
+                NotImplementedError NameError NoMethodError RuntimeError
+                SecurityError NoMemoryError EncodingError SystemCallError
+                Encoding::CompatibilityError
                 File::Stat IO Hash ENV IOError EOFError ARGF RubyVM
                 RubyVM::InstructionSequence Math::DomainError ZeroDivisionError
                 FloatDomainError Integer Fixnum Data TrueClass FalseClass Mutex
@@ -91,8 +93,9 @@ module Inch
                 Encoding::ConverterNotFoundError Encoding::Converter RubyVM::Env
 
                 Comparable Kernel File::Constants Enumerable Errno FileTest GC
-                ObjectSpace GC::Profiler IO::WaitReadable IO::WaitWritable Marshal
-                Math Process Process::UID Process::GID Process::Sys Signal
+                ObjectSpace GC::Profiler IO::WaitReadable IO::WaitWritable
+                Marshal Math Process Process::UID Process::GID Process::Sys
+                Signal
               )
               def core?
                 RUBY_CORE.include?(name.to_s)
@@ -103,13 +106,13 @@ module Inch
                 @docstring ||= Docstring.new(object.docstring)
               end
 
-              # Returns all files declaring the object in the form of an Array of
-              # Arrays containing the location of their declaration.
+              # Returns all files declaring the object in the form of an Array
+              # of Arrays containing the location of their declaration.
               #
               # @return [Array<CodeLocation>]
               def files
                 object.files.map do |(filename, line_no)|
-                  CodeLocation.new(base_dir, filename, line_no)
+                  Inch::Utils::CodeLocation.new(base_dir, filename, line_no)
                 end
               rescue ::YARD::CodeObjects::ProxyMethodError
                 # this error is raised by YARD
@@ -117,19 +120,11 @@ module Inch
                 []
               end
 
-              # CodeLocation is a utility class to find declarations of objects in
-              # files
-              class CodeLocation < Struct.new(:base_dir, :relative_path, :line_no)
-                def filename
-                  File.join(base_dir, relative_path)
-                end
-              end
-
               # Returns the name of the file where the object is declared first
               # @return [String] a filename
               def filename
-                # just checking the first file (which is the file where an object
-                # is first declared)
+                # just checking the first file (which is the file where an
+                # object is first declared)
                 files.first && files.first.filename
               end
 
@@ -182,8 +177,8 @@ module Inch
               #    ^    ^    ^      ^
               #    1 << 2 << 3  <<  4
               #
-              # +depth+ answers the question "how many layers of code objects are
-              # above this one?"
+              # +depth+ answers the question "how many layers of code objects
+              # are above this one?"
               #
               # @note top-level counts, that's why Foo has depth 1!
               #
@@ -242,7 +237,8 @@ module Inch
                 depth == 1
               end
 
-              # @return [Boolean] +true+ if the object has no documentation at all
+              # @return [Boolean] +true+ if the object has no documentation at
+              #   all
               def undocumented?
                 original_docstring.empty?
               end
@@ -270,7 +266,7 @@ module Inch
               attr_reader :private_tag
 
               def private_api_tag?
-                api_tag && api_tag.text == "private"
+                api_tag && api_tag.text == 'private'
               end
 
               def tag(name)
@@ -286,7 +282,8 @@ module Inch
               end
 
               # @return [Array]
-              #   YARD tags that are not already covered by other wrapper methods
+              #   YARD tags that are not already covered by other wrapper
+              #   methods
               def unconsidered_tags
                 @unconsidered_tags ||= tags.reject do |tag|
                   auto_generated_tag?(tag) ||

data/lib/inch/language/ruby/provider/yard/object/method_object.rb

@@ -1,4 +1,4 @@
-require "inch/language/ruby/provider/yard/object/method_signature"
+require 'inch/language/ruby/provider/yard/object/method_signature'
 
 module Inch
   module Language
@@ -70,7 +70,8 @@ module Inch
               # mentioned in the docstring (e.g. "Returns a String").
               def return_mentioned?
                 return_tags.any? do |t|
-                  !t.types.nil? && !t.types.empty? && !YARD.implicit_tag?(t, self)
+                  !t.types.nil? && !t.types.empty? &&
+                    !YARD.implicit_tag?(t, self)
                 end || docstring.mentions_return? && !implicit_docstring?
               end
 
@@ -120,7 +121,7 @@ module Inch
 
               # @return [MethodObject,nil]
               def corresponding_getter
-                clean_name = name.to_s.gsub(/(\=)$/, "")
+                clean_name = name.to_s.gsub(/(\=)$/, '')
                 parent.child(clean_name.to_sym)
               end
 

data/lib/inch/language/ruby/provider/yard/object/method_parameter_object.rb

@@ -41,7 +41,8 @@ module Inch
                 described_by_tag? || described_by_docstring?
               end
 
-              # @return [Boolean] +true+ if the parameter is mentioned in the docs
+              # @return [Boolean] +true+ if the parameter is mentioned in the
+              #   docs
               def mentioned?
                 !!@tag || mentioned_by_docstring?
               end
@@ -72,7 +73,7 @@ module Inch
                 if @method.docstring.describes_parameter?(name)
                   true
                 else
-                  unsplatted = name.gsub(/^[\&\*]/, "")
+                  unsplatted = name.gsub(/^[\&\*]/, '')
                   @method.docstring.describes_parameter?(unsplatted)
                 end
               end
@@ -81,7 +82,7 @@ module Inch
                 if @method.docstring.mentions_parameter?(name)
                   true
                 else
-                  unsplatted = name.gsub(/^[\&\*]/, "")
+                  unsplatted = name.gsub(/^[\&\*]/, '')
                   @method.docstring.mentions_parameter?(unsplatted)
                 end
               end

data/lib/inch/language/ruby/provider/yard/object/method_signature.rb

@@ -60,7 +60,7 @@ module Inch
               # Returns the actual signature of the method.
               # @return [String]
               def signature
-                relevant_object.signature.gsub(/^(def\ )/, "")
+                relevant_object.signature.gsub(/^(def\ )/, '')
               end
 
               private
@@ -95,7 +95,7 @@ module Inch
               # @param name [String] parameter name
               # @return [String]
               def normalize_parameter_name(name)
-                name.gsub(/[\&\*\$\[\]]/, "")
+                name.gsub(/[\&\*\$\[\]]/, '')
               end
 
               def parameter_tag(param_name)

data/lib/inch/language/ruby/provider/yard/object/namespace_object.rb

@@ -8,7 +8,8 @@ module Inch
             # inside itself (e.g. classes and modules)
             class NamespaceObject < Base
               def attributes
-                object.class_attributes.values + object.instance_attributes.values
+                object.class_attributes.values +
+                  object.instance_attributes.values
               end
 
               def children_fullnames

data/lib/inch/language/ruby/provider/yard/parser.rb

@@ -23,8 +23,8 @@ module Inch
             def parse(dir, config)
               Dir.chdir(dir) do
                 parse_yard_objects(config.included_files,
-                                    config.excluded_files,
-                                    config.read_dump_file)
+                                   config.excluded_files,
+                                   config.read_dump_file)
                 inject_base_dir(dir)
               end
             end

data/lib/inch/language/ruby/roles/base.rb

@@ -7,7 +7,7 @@ module Inch
           class Base < Inch::Evaluation::Role
             # Returns the type of the +object+ that is being evaluated.
             def object_type
-              object.class.to_s.split("::").last.gsub(/Object$/, "").downcase
+              object.class.to_s.split('::').last.gsub(/Object$/, '').downcase
             end
           end
         end

data/lib/inch/language/ruby/roles/method.rb

@@ -17,7 +17,8 @@ module Inch
               priority      +2
             end
 
-            # Role assigned to methods where the return value is typed in the docs
+            # Role assigned to methods where the return value is typed in the
+            # docs
             class WithReturnType < Base
               applicable_if :return_typed?
             end

data/lib/inch/language/ruby/roles/method_parameter.rb

@@ -65,7 +65,7 @@ module Inch
 
               def suggestion
                 "The parameter '#{object.name}' seems not to be part of the " \
-                  "signature."
+                  'signature.'
               end
             end
 

data/lib/inch/language/ruby/roles/missing.rb

@@ -11,8 +11,8 @@ module Inch
             end
 
             # @return [Fixnum]
-            #  a score that can be achieved by adding the missing thing mentioned
-            #  by the role
+            #  a score that can be achieved by adding the missing thing
+            #  mentioned by the role
             def potential_score
               @value.to_i
             end

data/lib/inch/language/ruby/roles/object.rb

@@ -45,15 +45,15 @@ module Inch
               priority      -7
             end
 
-            # Role assigned to objects explicitly or implicitly tagged to be part
-            # of an API. If the API is 'private'/'internal' TaggedAsInternalAPI is
-            # assigned instead.
+            # Role assigned to objects explicitly or implicitly tagged to be
+            # part of an API. If the API is 'private'/'internal'
+            # TaggedAsInternalAPI is assigned instead.
             class TaggedAsAPI < Base
               applicable_if :api_tag?
             end
 
-            # Role assigned to objects explicitly or implicitly tagged to be part
-            # of a private API.
+            # Role assigned to objects explicitly or implicitly tagged to be
+            # part of a private API.
             class TaggedAsInternalAPI < Base
               applicable_if :tagged_as_internal_api?
               priority      -5
@@ -109,7 +109,7 @@ module Inch
               applicable_unless :has_code_example?
 
               def suggestion
-                "Add a code example (optional)"
+                'Add a code example (optional)'
               end
             end
           end