inch 0.4.10 → 0.5.0.rc1

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.find { |p| p.name == name.to_s }
+              parameters.detect { |p| p.name == name.to_s }
             end
 
             def overridden?
@@ -66,14 +66,13 @@ 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? do |t|
-                !t.types.nil? && !t.types.empty? && !YARD.implicit_tag?(t, self)
-              end || docstring.mentions_return? && !implicit_docstring?
+              return_tags.any? { |t| !t.types.nil? && !t.types.empty? && !YARD.implicit_tag?(t, self) } ||
+                docstring.mentions_return? && !implicit_docstring?
             end
 
             # Returns +true+ if a return value is described by words.
             def return_described?
-              return_described_via_tag? ||
+              return_tags.any? { |t| !t.text.empty? && !YARD.implicit_tag?(t, self) } ||
                 docstring.describes_return? && !implicit_docstring?
             end
 
@@ -103,60 +102,24 @@ module Inch
 
             private
 
-            # 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.
+            # 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
 
-            # @return [Array<::YARD::Tag>]
+            def return_tags
+              object.tags(:return) + overloaded_return_tags
+            end
+
             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
-
-            # Returns +true+ if a return value is described by words.
-            def return_described_via_tag?
-              return_tags.any? do |t|
-                return_tag_describes_unusable_value?(t) ||
-                  !t.text.empty? && !YARD.implicit_tag?(t, self)
-              end
-            end
-
-            def return_tag_describes_unusable_value?(t)
-              return if t.types.nil?
-              t.types.size == 1 && %w(void nil nothing).include?(t.types.first)
-            end
           end
         end
       end

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

@@ -7,11 +7,9 @@ module Inch
           class MethodParameterObject
             attr_reader :name # @return [String]
 
-            # @param method [YARD::Object::MethodObject] the method the
-            #   parameter belongs to
+            # @param method [YARD::Object::MethodObject] the method the parameter belongs to
             # @param name [String] the name of the parameter
-            # @param in_signature [String] how the parameter is noted in the
-            #   method's signature
+            # @param in_signature [String] how the parameter is noted in the method's signature
             # @param tag [YARD::Tags::Tag] the Tag object for the parameter
             def initialize(method, name, in_signature, tag)
               @method = method
@@ -23,8 +21,7 @@ module Inch
             BAD_NAME_EXCEPTIONS = %w(id)
             BAD_NAME_THRESHOLD = 3
 
-            # @return [Boolean] +true+ if the name of the parameter is
-            #   uncommunicative
+            # @return [Boolean] +true+ if the name of the parameter is uncommunicative
             def bad_name?
               return false if BAD_NAME_EXCEPTIONS.include?(name)
               name.size < BAD_NAME_THRESHOLD || name =~ /[0-9]$/
@@ -55,8 +52,7 @@ module Inch
               @tag && @tag.types && !@tag.types.empty?
             end
 
-            # @return [Boolean] +true+ if the parameter is mentioned in the
-            #   docs, but not present in the method's signature
+            # @return [Boolean] +true+ if the parameter is mentioned in the docs, but not present in the method's signature
             def wrongly_mentioned?
               mentioned? && !@in_signature
             end
@@ -71,7 +67,7 @@ module Inch
               if @method.docstring.describes_parameter?(name)
                 true
               else
-                unsplatted = name.gsub(/^[\&\*]/, "")
+                unsplatted = name.gsub(/^[\&\*]/, '')
                 @method.docstring.describes_parameter?(unsplatted)
               end
             end
@@ -80,7 +76,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/code_object/provider/yard/object/method_signature.rb

@@ -8,13 +8,11 @@ module Inch
             attr_reader :method, :docstring
 
             # @param method [Provider::YARD::Object::MethodObject]
-            # @param yard_tag [::YARD::Tags::Tag,nil] if nil, the method's
-            #   normal signature is used
+            # @param method [::YARD::Tags::Tag,nil] if nil, the method's normal signature is used
             def initialize(method, yard_tag = nil)
               @method = method
               @yard_tag = yard_tag
-              @docstring =
-                Provider::YARD::Docstring.new(relevant_object.docstring)
+              @docstring = Provider::YARD::Docstring.new(relevant_object.docstring)
             end
 
             def all_signature_parameter_names
@@ -45,28 +43,26 @@ module Inch
             # @param name [String,Symbol]
             # @return [MethodParameterObject]
             def parameter(name)
-              parameters.find { |p| p.name == name.to_s }
+              parameters.detect { |p| p.name == name.to_s }
             end
 
             # Returns +true+ if the other signature is identical to self
             # @param other [MethodSignature]
             # @return [Boolean]
             def same?(other)
-              all_signature_parameter_names ==
-                other.all_signature_parameter_names
+              all_signature_parameter_names == other.all_signature_parameter_names
             end
 
             # Returns the actual signature of the method.
             # @return [String]
             def signature
-              relevant_object.signature.gsub(/^(def\ )/, "")
+              relevant_object.signature.gsub(/^(def\ )/, '')
             end
 
             private
 
             def all_parameter_names
-              all_names = all_signature_parameter_names +
-                parameter_tags.map(&:name)
+              all_names = all_signature_parameter_names + parameter_tags.map(&:name)
               all_names.map do |name|
                 normalize_parameter_name(name) if name
               end.compact.uniq
@@ -94,11 +90,11 @@ module Inch
             # @param name [String] parameter name
             # @return [String]
             def normalize_parameter_name(name)
-              name.gsub(/[\&\*\$\[\]]/, "")
+              name.gsub(/[\&\*\$\[\]]/, '')
             end
 
             def parameter_tag(param_name)
-              parameter_tags.find do |tag|
+              parameter_tags.detect do |tag|
                 tag.name == param_name
               end
             end

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

@@ -28,7 +28,9 @@ module Inch
 
             # called by MethodObject#getter?
             def child(name)
-              children.find { |child| child.name == name } if children
+              if children
+                children.detect { |child| child.name == name }
+              end
             end
 
             def children
@@ -36,6 +38,7 @@ module Inch
                 YARD::Object.for(o)
               end
             end
+
           end
         end
       end

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

@@ -11,7 +11,7 @@ module Inch
           # @see #parse
           # @return [CodeObject::Provider::YARD::Parser] the instance that ran
           def self.parse(*args)
-            parser = new
+            parser = self.new
             parser.parse(*args)
             parser
           end
@@ -46,8 +46,8 @@ module Inch
               object.base_dir = dir
 
               object.aliases_fullnames.each do |fullname|
-                alias_object = objects.find { |o| o.fullname == fullname }
-                alias_object.aliased_object_fullname = object.fullname
+                _alias = objects.detect { |o| o.fullname == fullname }
+                _alias.aliased_object_fullname = object.fullname
               end
             end
           end

data/lib/inch/code_object/proxy.rb

@@ -11,7 +11,7 @@ module Inch
         # @return [CodeObject::Proxy::Base]
         def for(code_object)
           attributes = Converter.to_hash(code_object)
-          class_for(code_object).new(attributes)
+          proxy_object = class_for(code_object).new(attributes)
         end
 
         private
@@ -21,7 +21,7 @@ module Inch
         # @param code_object [YARD::CodeObject]
         # @return [Class]
         def class_for(code_object)
-          class_name = code_object.class.to_s.split("::").last
+          class_name = code_object.class.to_s.split('::').last
           const_get(class_name)
         end
       end
@@ -29,11 +29,10 @@ module Inch
   end
 end
 
-require "inch/code_object/proxy/base"
-require "inch/code_object/proxy/namespace_object"
-require "inch/code_object/proxy/class_object"
-require "inch/code_object/proxy/class_variable_object"
-require "inch/code_object/proxy/constant_object"
-require "inch/code_object/proxy/method_object"
-require "inch/code_object/proxy/method_parameter_object"
-require "inch/code_object/proxy/module_object"
+require 'inch/code_object/proxy/base'
+require 'inch/code_object/proxy/namespace_object'
+require 'inch/code_object/proxy/class_object'
+require 'inch/code_object/proxy/constant_object'
+require 'inch/code_object/proxy/method_object'
+require 'inch/code_object/proxy/method_parameter_object'
+require 'inch/code_object/proxy/module_object'

data/lib/inch/code_object/proxy/base.rb

@@ -1,4 +1,4 @@
-require "forwardable"
+require 'forwardable'
 
 module Inch
   module CodeObject
@@ -42,9 +42,9 @@ module Inch
 
         # @return [Symbol]
         def grade
-          @grade ||= Evaluation.new_grade_lists.find do |range|
-            range.scores.include?(score)
-          end.grade
+          @grade ||= Evaluation.new_grade_lists.detect { |range|
+                range.scores.include?(score)
+              }.grade
         end
 
         # @return [Boolean] if the current object is an alias for something else
@@ -52,10 +52,9 @@ module Inch
           !aliased_object.nil?
         end
 
-        # @return [CodeObject::Proxy::Base] the object the current object is an
-        #   alias of
+        # @return [CodeObject::Proxy::Base] the object the current object is an alias of
         def aliased_object
-          object_lookup.find(self[:aliased_object_fullname])
+          object_lookup.find( self[:aliased_object_fullname] )
         end
 
         # @return [Boolean] +true+ if the object has an @api tag
@@ -171,10 +170,9 @@ module Inch
           self[:nodoc?]
         end
 
-        # @return [CodeObject::Proxy::Base,nil] the parent of the current object
-        #   or +nil+
+        # @return [CodeObject::Proxy::Base,nil] the parent of the current object or +nil+
         def parent
-          object_lookup.find(self[:parent_fullname])
+          object_lookup.find( self[:parent_fullname] )
         end
 
         def private?
@@ -207,7 +205,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
@@ -235,7 +233,7 @@ module Inch
         end
 
         def inspect
-          "#<#{self.class}: #{fullname}>"
+          "#<#{self.class.to_s}: #{fullname}>"
         end
       end
     end

data/lib/inch/code_object/proxy/method_object.rb

@@ -36,7 +36,7 @@ module Inch
         end
 
         def parameter(name)
-          parameters.find { |p| p.name == name.to_s }
+          parameters.detect { |p| p.name == name.to_s }
         end
 
         def parameters
@@ -50,8 +50,7 @@ module Inch
         end
 
         def overridden_method
-          @overridden_method ||=
-            object_lookup.find(self[:overridden_method_fullname])
+          @overridden_method ||= object_lookup.find(self[:overridden_method_fullname])
         end
 
         def return_mentioned?

data/lib/inch/code_object/proxy/method_parameter_object.rb

@@ -14,8 +14,7 @@ module Inch
         BAD_NAME_EXCEPTIONS = %w(id)
         BAD_NAME_THRESHOLD = 3
 
-        # @return [Boolean] +true+ if the name of the parameter is
-        #   uncommunicative
+        # @return [Boolean] +true+ if the name of the parameter is uncommunicative
         def bad_name?
           return false if BAD_NAME_EXCEPTIONS.include?(name)
           name.size < BAD_NAME_THRESHOLD || name =~ /[0-9]$/
@@ -39,7 +38,7 @@ module Inch
         def name
           self[:name]
         end
-        alias_method :fullname, :name
+        alias fullname name
 
         # @return [Boolean] +true+ if the parameter is a splat argument
         def splat?
@@ -51,8 +50,7 @@ module Inch
           self[:typed?]
         end
 
-        # @return [Boolean] +true+ if the parameter is mentioned in the docs,
-        #   but not present in the method's signature
+        # @return [Boolean] +true+ if the parameter is mentioned in the docs, but not present in the method's signature
         def wrongly_mentioned?
           self[:wrongly_mentioned?]
         end

data/lib/inch/codebase.rb

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

data/lib/inch/codebase/objects_filter.rb

@@ -41,14 +41,16 @@ module Inch
       end
 
       def filter_depth
-        @list = @list.select { |o| o.depth <= options.depth } if options.depth
+        if options.depth
+          @list = @list.select { |o| o.depth <= options.depth }
+        end
       end
 
       def filter_visibility
         @list = @list.select do |o|
           options.visibility.include?(o.visibility)
         end
-        unless options.visibility.include?(:private)
+        if !options.visibility.include?(:private)
           @list = @list.reject do |o|
             o.tagged_as_private?
           end

data/lib/inch/codebase/serializer.rb

@@ -9,12 +9,12 @@ 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) }
+        FileUtils.mkdir_p( File.dirname(filename) )
+        File.open(filename, 'wb') { |file| file.write(content) }
       end
 
       def self.load(filename)
-        codebase = Marshal.load(File.binread(filename))
+        codebase = Marshal.load( File.binread(filename) )
         codebase.objects.each do |object|
           object.object_lookup = codebase.objects
         end

data/lib/inch/config.rb

@@ -20,5 +20,5 @@ module Inch
   end
 end
 
-require "inch/config/base"
-require "inch/config/codebase"
+require 'inch/config/base'
+require 'inch/config/codebase'