inch 0.4.10 → 0.5.0.rc1

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/converter.rb

@@ -52,7 +52,7 @@ module Inch
         unconsidered_tag_count
         undocumented?
         visibility
-      ).map(&:to_sym)
+        ).map(&:to_sym)
 
       PARAMETER_ATTRIBUTES = %w(
         name
@@ -62,7 +62,7 @@ module Inch
         splat?
         typed?
         wrongly_mentioned?
-      ).map(&:to_sym)
+        ).map(&:to_sym)
 
       # Returns an attributes Hash for a given code object
       #
@@ -71,14 +71,16 @@ module Inch
       def self.to_hash(o)
         attributes = {}
         OBJECT_ATTRIBUTES.each do |name|
-          next unless o.respond_to?(name)
-          attributes[name] = o.public_send(name)
+          if o.respond_to?(name)
+            attributes[name] = o.public_send(name)
+          end
         end
         attributes[:parameters] = o.parameters.map do |parameter|
           hash = {}
           PARAMETER_ATTRIBUTES.each do |pname|
-            next unless parameter.respond_to?(pname)
-            hash[pname] = parameter.public_send(pname)
+            if parameter.respond_to?(pname)
+              hash[pname] = parameter.public_send(pname)
+            end
           end
           hash
         end

data/lib/inch/code_object/provider.rb

@@ -33,4 +33,4 @@ module Inch
   end
 end
 
-require "inch/code_object/provider/yard"
+require 'inch/code_object/provider/yard'

data/lib/inch/code_object/provider/yard.rb

@@ -3,6 +3,7 @@ module Inch
     module Provider
       # Parses the source tree (using YARD)
       module YARD
+
         # Returns +true+ if the docstring was generated by YARD
         #
         # @param docstring [Docstring,String]
@@ -12,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
@@ -26,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
@@ -39,17 +40,18 @@ module Inch
         def self.parse(dir, config = Inch::Config.codebase)
           Parser.parse(dir, config)
         end
+
       end
     end
   end
 end
 
-require "logger"
-require "yard"
+require 'logger'
+require 'yard'
 
 log.level = ::Logger::UNKNOWN # basically disable YARD's logging
 
-require "inch/code_object/provider/yard/parser"
-require "inch/code_object/provider/yard/docstring"
-require "inch/code_object/provider/yard/nodoc_helper"
-require "inch/code_object/provider/yard/object"
+require 'inch/code_object/provider/yard/parser'
+require 'inch/code_object/provider/yard/docstring'
+require 'inch/code_object/provider/yard/nodoc_helper'
+require 'inch/code_object/provider/yard/object'

data/lib/inch/code_object/provider/yard/docstring.rb

@@ -42,16 +42,11 @@ module Inch
           end
 
           def mentions_return?
-            last_lines.any? do |line|
-              line =~ /^#{tomdoc_modifiers}Returns\ /
-            end
+            last_line =~ /^Returns\ /
           end
 
           def describes_return?
-            last_lines.any? do |line|
-              line =~ /^#{tomdoc_modifiers}Returns\ (\w+\s){2,}/i ||
-                line =~ /^#{tomdoc_modifiers}Returns\ (nil|nothing)\.*/i
-            end
+            last_line =~ /^Returns\ (\w+\s){2,}/
           end
 
           def to_s
@@ -64,28 +59,18 @@ module Inch
             @first_line ||= @text.lines.to_a.first
           end
 
-          # Returns the last lines of the docstring.
-          # @return [Array<String>] the last line and, if the last line(s) is
-          #   indented, the last unindented line
-          def last_lines
-            @last_lines ||= begin
-              list = []
-              @text.lines.to_a.reverse.each do |line|
-                list << line
-                break if line =~ /^\S/
-              end
-              list.reverse
-            end
+          def last_line
+            @last_line ||= @text.lines.to_a.last
           end
 
           def parse_code_examples
             code_examples = []
             example = nil
-            @text.lines.each do |line|
-              if line =~ /^\s*+$/
+            @text.lines.each_with_index do |line, index|
+              if line =~/^\s*+$/
                 code_examples << example if example
                 example = []
-              elsif line =~ /^\ {2,}\S+/
+              elsif line =~/^\ {2,}\S+/
                 example << line if example
               else
                 code_examples << example if example
@@ -96,34 +81,22 @@ module Inch
             code_examples.delete_if(&:empty?).map(&:join)
           end
 
-          # Returns patterns in which method parameters are mentioned
-          # in inline docs.
-          #
-          # @param name [String] the name of the method parameter
-          # @return [Array<Regexp>]
           def mention_parameter_patterns(name)
-            escaped_name = Regexp.escape(name)
-            type = /<[^>]+>/
             [
-              escaped_name,
-              /#{escaped_name}#{type}/ # matches "param1<String,nil>"
-            ].map do |expr|
-              [
-                /#{expr}\:\:/,            # param1::
-                /\+#{expr}\+/,            # +param1+
-                /\+#{expr}\+\:\:/,        # +param1+::
-                /<tt>#{expr}<\/tt>/,      # <tt>param1</tt>
-                /<tt>#{expr}<\/tt>\:\:/,  # <tt>param1</tt>::
-                /^#{expr}\ \-\ /          # param1 -
-              ]
-            end.flatten
+              "+#{name}+",
+              "+#{name}+::",
+              "<tt>#{name}</tt>",
+              "<tt>#{name}</tt>::",
+              "#{name}::",
+              /^#{Regexp.escape(name)}\ \-\ /
+            ]
           end
 
           def describe_parameter_extra_regexps(name)
             [
               "#{name}::",
               "+#{name}+::",
-              "<tt>#{name}</tt>::"
+              "<tt>#{name}</tt>::",
             ].map do |pattern|
               r = pattern.is_a?(Regexp) ? pattern : Regexp.escape(pattern)
               /#{r}\n\ {2,}.+/m
@@ -131,11 +104,10 @@ module Inch
           end
 
           def describe_parameter_regexps(name)
-            same_line_regexps =
-              mention_parameter_patterns(name).map do |pattern|
-                r = pattern.is_a?(Regexp) ? pattern : Regexp.escape(pattern)
-                /^#{r}\s?\S+/
-              end
+            same_line_regexps = mention_parameter_patterns(name).map do |pattern|
+              r = pattern.is_a?(Regexp) ? pattern : Regexp.escape(pattern)
+              /^#{r}\s?\S+/
+            end
             same_line_regexps + describe_parameter_extra_regexps(name)
           end
 
@@ -149,10 +121,6 @@ module Inch
               end
             end
           end
-
-          def tomdoc_modifiers
-            /((Public|Private|Internal)\:\ )*/
-          end
         end
       end
     end

data/lib/inch/code_object/provider/yard/nodoc_helper.rb

@@ -3,6 +3,7 @@ module Inch
     module Provider
       module YARD
         module NodocHelper
+
           # Returns true if the code object is somehow marked not to be
           # documented.
           #
@@ -80,11 +81,10 @@ module Inch
           # @return [String]
           def get_line_no(filename, line_number)
             f = File.open(filename)
-            line_number.times { f.gets }
-            result = $_ # LAST_READ_LINE
+            line_number.times{f.gets}
+            result = $_
             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/code_object/provider/yard/object.rb

@@ -16,11 +16,10 @@ module Inch
             # @return [Provider::YARD::Object]
             def for(yard_object)
               @cache ||= {}
-              if (proxy_object = @cache[cache_key(yard_object)])
+              if proxy_object = @cache[cache_key(yard_object)]
                 proxy_object
               else
-                @cache[cache_key(yard_object)] =
-                  class_for(yard_object).new(yard_object)
+                @cache[cache_key(yard_object)] = class_for(yard_object).new(yard_object)
               end
             end
 
@@ -31,7 +30,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
@@ -51,11 +50,10 @@ module Inch
   end
 end
 
-require "inch/code_object/provider/yard/object/base"
-require "inch/code_object/provider/yard/object/namespace_object"
-require "inch/code_object/provider/yard/object/class_object"
-require "inch/code_object/provider/yard/object/class_variable_object"
-require "inch/code_object/provider/yard/object/constant_object"
-require "inch/code_object/provider/yard/object/method_object"
-require "inch/code_object/provider/yard/object/method_parameter_object"
-require "inch/code_object/provider/yard/object/module_object"
+require 'inch/code_object/provider/yard/object/base'
+require 'inch/code_object/provider/yard/object/namespace_object'
+require 'inch/code_object/provider/yard/object/class_object'
+require 'inch/code_object/provider/yard/object/constant_object'
+require 'inch/code_object/provider/yard/object/method_object'
+require 'inch/code_object/provider/yard/object/method_parameter_object'
+require 'inch/code_object/provider/yard/object/module_object'

data/lib/inch/code_object/provider/yard/object/base.rb

@@ -1,4 +1,4 @@
-require "forwardable"
+require 'forwardable'
 
 module Inch
   module CodeObject
@@ -21,17 +21,14 @@ module Inch
             AUTO_GENERATED_TAG_NAMES = %w(raise yield)
 
             # convenient shortcuts to (YARD) code object
-            def_delegators :object,
-                           :type, :namespace, :source, :source_type, :group,
-                           :dynamic, :visibility
+            def_delegators :object, :type, :namespace, :source, :source_type, :group, :dynamic, :visibility
 
-            # @param object [YARD::CodeObjects::Base] the actual (YARD) code
-            #   object
+            # @param object [YARD::CodeObjects::Base] the actual (YARD) code object
             def initialize(object)
               @object = object
-              @api_tag = __api_tag
-              @parent = __parent
-              @private_tag = __private_tag
+              @__api_tag = __api_tag
+              @__parent = __parent
+              @__private_tag = __private_tag
             end
 
             # Returns the fullname of the object that the current object
@@ -48,18 +45,18 @@ module Inch
               !api_tag.nil?
             end
 
-            attr_reader :api_tag
+            def api_tag
+              @__api_tag
+            end
 
             # To be overridden
             # @see Proxy::NamespaceObject
-            # @return [CodeObject::Proxy::Base,nil] the child inside the current
-            #   object or +nil+
-            def child(_name)
+            # @return [CodeObject::Proxy::Base,nil] the child inside the current object or +nil+
+            def child(name)
               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
@@ -70,29 +67,8 @@ module Inch
               []
             end
 
-            RUBY_CORE = %w(
-              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
-              File::Stat IO Hash ENV IOError EOFError ARGF RubyVM
-              RubyVM::InstructionSequence Math::DomainError ZeroDivisionError
-              FloatDomainError Integer Fixnum Data TrueClass FalseClass Mutex
-              Thread Proc LocalJumpError SystemStackError Method UnboundMethod
-              Binding Process::Status Random Range Rational RegexpError Regexp
-              MatchData Symbol Struct ThreadGroup ThreadError Time
-              Encoding::UndefinedConversionError
-              Encoding::InvalidByteSequenceError
-              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
-            )
+            RUBY_CORE = %w(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 File::Stat IO Hash ENV IOError EOFError ARGF RubyVM RubyVM::InstructionSequence Math::DomainError ZeroDivisionError FloatDomainError Integer Fixnum Data TrueClass FalseClass Mutex Thread Proc LocalJumpError SystemStackError Method UnboundMethod Binding Process::Status Random Range Rational RegexpError Regexp MatchData Symbol Struct ThreadGroup ThreadError Time Encoding::UndefinedConversionError Encoding::InvalidByteSequenceError Encoding::ConverterNotFoundError Encoding::Converter RubyVM::Env) +
+                      %w(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)
             def core?
               RUBY_CORE.include?(name.to_s)
             end
@@ -116,8 +92,7 @@ module Inch
               []
             end
 
-            # CodeLocation is a utility class to find declarations of objects in
-            # files
+            # 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)
@@ -157,9 +132,9 @@ module Inch
               if tags(:example).size > 1 || docstring.code_examples.size > 1
                 true
               else
-                if (tag = tag(:example))
+                if tag = tag(:example)
                   multi_code_examples?(tag.text)
-                elsif (text = docstring.code_examples.first)
+                elsif text = docstring.code_examples.first
                   multi_code_examples?(text)
                 else
                   false
@@ -211,7 +186,9 @@ module Inch
             end
 
             # @return [Array,nil] the parent of the current object or +nil+
-            attr_reader :parent
+            def parent
+              @__parent
+            end
 
             def __parent
               YARD::Object.for(object.parent) if object.parent
@@ -251,7 +228,7 @@ module Inch
             end
 
             def inspect
-              "#<#{self.class}: #{fullname}>"
+              "#<#{self.class.to_s}: #{fullname}>"
             end
 
             protected
@@ -266,10 +243,12 @@ module Inch
               !private_tag.nil?
             end
 
-            attr_reader :private_tag
+            def private_tag
+              @__private_tag
+            end
 
             def private_api_tag?
-              api_tag && api_tag.text == "private"
+              api_tag && api_tag.text == 'private'
             end
 
             def tag(name)
@@ -290,12 +269,12 @@ module Inch
               @unconsidered_tags ||= tags.reject do |tag|
                 auto_generated_tag?(tag) ||
                   CONSIDERED_YARD_TAGS.include?(tag.tag_name)
-              end
+                end
             end
 
             def __depth(i = 0)
               if parent
-                parent.__depth(i + 1)
+                parent.__depth(i+1)
               else
                 i
               end