inch 0.4.6 → 0.4.7

data/lib/inch/cli/sparkline_helper.rb

@@ -21,9 +21,9 @@ module Inch
 
       def __sparkline(list, grade_lists)
         sparkline = Sparkr::Sparkline.new(list)
-        sparkline.format do |tick, count, index|
+        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

@@ -8,7 +8,8 @@ module Inch
       attr_accessor :excluded
 
       VALID_YARD_SWITCHES = %w(--private --no-private --protected --no-public
-          --plugin --load --safe --yardopts --no-yardopts --document --no-document)
+                               --plugin --load --safe --yardopts --no-yardopts
+                               --document --no-document)
 
       # Parses the option and gracefully handles invalid switches
       #
@@ -17,7 +18,7 @@ module Inch
       #   array will be modified.
       # @return [void]
       def parse_yardopts_options(opts, args)
-        wrapper = YardoptsWrapper.new()
+        wrapper = YardoptsWrapper.new
 
         dupped_args = args.dup
         dupped_args.delete("--help")
@@ -35,7 +36,7 @@ module Inch
       end
 
       def yardopts_options(opts)
-        wrapper = YardoptsWrapper.new()
+        wrapper = YardoptsWrapper.new
         wrapper.add_yardoc_options(opts)
       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/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,16 +71,14 @@ module Inch
       def self.to_hash(o)
         attributes = {}
         OBJECT_ATTRIBUTES.each do |name|
-          if o.respond_to?(name)
-            attributes[name] = o.public_send(name)
-          end
+          next unless o.respond_to?(name)
+          attributes[name] = o.public_send(name)
         end
         attributes[:parameters] = o.parameters.map do |parameter|
           hash = {}
           PARAMETER_ATTRIBUTES.each do |pname|
-            if parameter.respond_to?(pname)
-              hash[pname] = parameter.public_send(pname)
-            end
+            next unless parameter.respond_to?(pname)
+            hash[pname] = parameter.public_send(pname)
           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,7 +3,6 @@ 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]
@@ -13,7 +12,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 +26,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
@@ -40,18 +39,17 @@ 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,11 +42,16 @@ module Inch
           end
 
           def mentions_return?
-            last_line =~ /^Returns\ /
+            last_lines.any? do |line|
+              line =~ /^#{tomdoc_modifiers}Returns\ /
+            end
           end
 
           def describes_return?
-            last_line =~ /^Returns\ (\w+\s){2,}/
+            last_lines.any? do |line|
+              line =~ /^#{tomdoc_modifiers}Returns\ (\w+\s){2,}/i ||
+                line =~ /^#{tomdoc_modifiers}Returns\ (nil|nothing)\.*/i
+            end
           end
 
           def to_s
@@ -59,18 +64,28 @@ module Inch
             @first_line ||= @text.lines.to_a.first
           end
 
-          def last_line
-            @last_line ||= @text.lines.to_a.last
+          # 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
           end
 
           def parse_code_examples
             code_examples = []
             example = nil
-            @text.lines.each_with_index do |line, index|
-              if line =~/^\s*+$/
+            @text.lines.each do |line|
+              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
@@ -81,22 +96,34 @@ module Inch
             code_examples.delete_if(&:empty?).map(&:join)
           end
 
-          def mention_parameter_patterns(name)
-            [
-              "+#{name}+",
-              "+#{name}+::",
-              "<tt>#{name}</tt>",
-              "<tt>#{name}</tt>::",
-              "#{name}::",
-              /^#{Regexp.escape(name)}\ \-\ /
-            ]
+          # 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)
+            name = Regexp.escape(_name)
+            type = /<[^>]+>/
+            arr = [
+              name,
+              /#{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
           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
@@ -104,10 +131,11 @@ 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
 
@@ -121,6 +149,10 @@ 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,7 +3,6 @@ module Inch
     module Provider
       module YARD
         module NodocHelper
-
           # Returns true if the code object is somehow marked not to be
           # documented.
           #
@@ -81,10 +80,11 @@ module Inch
           # @return [String]
           def get_line_no(filename, line_number)
             f = File.open(filename)
-            line_number.times{f.gets}
+            line_number.times { f.gets }
             result = $_
             f.close
-            result
+            result.encode("UTF-8", "binary",
+                          invalid: :replace, undef: :replace, replace: "")
           end
         end
       end

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

@@ -19,7 +19,8 @@ module Inch
               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
 
@@ -30,7 +31,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
@@ -50,10 +51,11 @@ 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/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/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"

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

@@ -1,4 +1,4 @@
-require 'forwardable'
+require "forwardable"
 
 module Inch
   module CodeObject
@@ -21,7 +21,9 @@ 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
             def initialize(object)
@@ -67,8 +69,29 @@ 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) +
-                      %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)
+            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
+            )
             def core?
               RUBY_CORE.include?(name.to_s)
             end
@@ -92,7 +115,8 @@ 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)
@@ -228,7 +252,7 @@ module Inch
             end
 
             def inspect
-              "#<#{self.class.to_s}: #{fullname}>"
+              "#<#{self.class}: #{fullname}>"
             end
 
             protected
@@ -248,7 +272,7 @@ module Inch
             end
 
             def private_api_tag?
-              api_tag && api_tag.text == 'private'
+              api_tag && api_tag.text == "private"
             end
 
             def tag(name)
@@ -269,12 +293,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

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

@@ -0,0 +1,12 @@
+module Inch
+  module CodeObject
+    module Provider
+      module YARD
+        module Object
+          class ClassVariableObject < Base
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,4 +1,4 @@
-require 'inch/code_object/provider/yard/object/method_signature'
+require "inch/code_object/provider/yard/object/method_signature"
 
 module Inch
   module CodeObject
@@ -46,7 +46,7 @@ module Inch
             end
 
             def parameter(name)
-              parameters.detect { |p| p.name == name.to_s }
+              parameters.find { |p| p.name == name.to_s }
             end
 
             def overridden?
@@ -66,14 +66,16 @@ module Inch
             # Returns +true+ if a return value is described by it's type or
             # mentioned in the docstring (e.g. "Returns a String").
             def return_mentioned?
-              return_tags.any? { |t| !t.types.nil? && !t.types.empty? && !YARD.implicit_tag?(t, self) } ||
-                docstring.mentions_return? && !implicit_docstring?
+              return_tags.any? do |t|
+                !t.types.nil? && !t.types.empty? && !YARD.implicit_tag?(t, self)
+              end || docstring.mentions_return? && !implicit_docstring?
             end
 
             # Returns +true+ if a return value is described by words.
             def return_described?
-              return_tags.any? { |t| !t.text.empty? && !YARD.implicit_tag?(t, self) } ||
-                docstring.describes_return? && !implicit_docstring?
+              return_tags.any? do |t|
+                !t.text.empty? && !YARD.implicit_tag?(t, self)
+              end || docstring.describes_return? && !implicit_docstring?
             end
 
             def return_typed?
@@ -102,24 +104,47 @@ module Inch
 
             private
 
-            # Returns +true+ if the docstring was generated by YARD
+            # Returns @return tags that are assigned to the getter
+            # corresponding to this setter.
+            #
+            # @return [Array<::YARD::Tag>]
+            def attributed_return_tags
+              if setter? && object.tags(:return).empty?
+                method = corresponding_getter
+                return method.object.tags(:return) if method
+              end
+              []
+            end
+
+            # @return [MethodObject,nil]
+            def corresponding_getter
+              clean_name = name.to_s.gsub(/(\=)$/, "")
+              parent.child(clean_name.to_sym)
+            end
+
+            # Returns +true+ if the docstring was generated by YARD.
             def implicit_docstring?
               YARD.implicit_docstring?(docstring, self)
             end
 
+            # @return [Array<::YARD::Tag>]
             def overload_tags
               object.tags(:overload)
             end
 
-            def return_tags
-              object.tags(:return) + overloaded_return_tags
-            end
-
+            # @return [Array<::YARD::Tag>]
             def overloaded_return_tags
               overload_tags.map do |overload_tag|
                 overload_tag.tag(:return)
               end.compact
             end
+
+            # @return [Array<::YARD::Tag>]
+            def return_tags
+              object.tags(:return) +
+                overloaded_return_tags +
+                  attributed_return_tags
+            end
           end
         end
       end