inch 0.4.4.rc1 → 0.4.4.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f7dd851b019ec788a43552657ad1b35493956676
-  data.tar.gz: 3653aae1e38341b48df225a67b1334d6cb667c3b
+  metadata.gz: 939665081ef1fae175405f3e47c6aab33b96449a
+  data.tar.gz: 384311683a56411b6408f0206af6e5428c828d04
 SHA512:
-  metadata.gz: edcdc37b91816acdd782a9f0a40d569bb9009ca0119d60fad5c1e0fdb6d2555e57f74a93fbb5b5cba409f19e601f2617b7eb07ff09100c68ceff756a12037842
-  data.tar.gz: 0e5d86540f4ef8cf5fe45ef76ce4bfda05159e56668114b00e0d2fd5066ddfab30ad664d6779e7cd80fe0fd5532b9bbfe043007072bc34bac20f53195797d0d3
+  metadata.gz: 38867d8c71272f70cc7195cc2e65a1830b0cd63a88738ee23bc1cc04d4a5ee90e28ecdfb511f442655708841a1cb747919c4adec8596a194daee63cfb4f8e241
+  data.tar.gz: dc096ab206cc711c66203426303b5e44aff321dbcf849a7579da4ba91db842b1fc320c88206de44858a3aaa3ee9527a2bb6a3b823f3fe598097ac89102276c10

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

@@ -3,6 +3,22 @@ module Inch
     module Provider
       module YARD
         class Docstring
+          # Returns +true+ if the docstring was generated by YARD
+          #
+          # @param docstring [Docstring,String]
+          # @param method [MethodObject]
+          def self.implicit?(docstring, method)
+            name = method.name
+            if method.getter?
+              docstring.to_s == "Returns the value of attribute #{name}"
+            elsif method.setter?
+              basename = name.to_s.gsub(/(\=)$/, '')
+              docstring.to_s == "Sets the attribute #{basename}"
+            else
+              false
+            end
+          end
+
           def initialize(text)
             @text = text.to_s
           end

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

@@ -64,12 +64,12 @@ module Inch
             end
 
             def return_mentioned?
-              !return_tags.empty? || docstring.mentions_return?
+              !return_tags.empty? || docstring.mentions_return? && !implicit_docstring?
             end
 
             def return_described?
               return_tags.any? { |t| !t.text.empty? } ||
-                docstring.describes_return?
+                docstring.describes_return? && !implicit_docstring?
             end
 
             def return_typed?
@@ -98,6 +98,11 @@ module Inch
 
             private
 
+            # Returns +true+ if the docstring was generated by YARD
+            def implicit_docstring?
+              Docstring.implicit?(docstring, self)
+            end
+
             def overload_tags
               object.tags(:overload)
             end

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

@@ -5,13 +5,14 @@ module Inch
         module Object
           # Utility class to describe (overloaded) method signatures
           class MethodSignature < Struct.new(:method, :yard_tag)
-            attr_reader :method
+            attr_reader :method, :docstring
 
             # @param method [Provider::YARD::Object::MethodObject]
             # @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)
             end
 
             def all_signature_parameter_names
@@ -67,21 +68,9 @@ module Inch
               end.compact.uniq
             end
 
-            def docstring
-              @docstring ||= Docstring.new(relevant_object.docstring)
-            end
-
             # Returns +true+ if the docstring was generated by YARD
             def implicit_docstring?
-              name = method.name
-              if method.getter?
-                docstring.to_s == "Returns the value of attribute #{name}"
-              elsif method.setter?
-                basename = name.to_s.gsub(/(\=)$/, '')
-                docstring.to_s == "Sets the attribute #{basename}"
-              else
-                false
-              end
+              Docstring.implicit?(docstring, method)
             end
 
             # Returns how the given parameter is noted in the method's

data/lib/inch/version.rb

@@ -1,3 +1,3 @@
 module Inch
-  VERSION = "0.4.4.rc1"
+  VERSION = "0.4.4.rc2"
 end

data/test/unit/code_object/proxy/method_object_test.rb

@@ -220,30 +220,40 @@ describe ::Inch::CodeObject::Proxy::MethodObject do
     m = @objects.find("InchTest#getter")
     assert m.getter?, "should be a getter"
     refute m.setter?
+    refute m.has_doc?
+    assert_equal 0, m.score
   end
 
   def test_setter
     m = @objects.find("InchTest#attr_setter=")
     refute m.getter?
     assert m.setter?, "should be a setter"
+    refute m.has_doc?
+    assert_equal 0, m.score
   end
 
   def test_setter2
     m = @objects.find("InchTest#manual_setter=")
     refute m.getter?
     assert m.setter?, "should be a setter"
+    refute m.has_doc?
+    assert_equal 0, m.score
   end
 
   def test_manual_getset
     m = @objects.find("InchTest#manual_getset")
     assert m.getter?, "should be a getter"
     refute m.setter?
+    refute m.has_doc?
+    assert_equal 0, m.score
   end
 
   def test_manual_getset2
     m = @objects.find("InchTest#manual_getset=")
     refute m.getter?
     assert m.setter?, "should be a setter"
+    refute m.has_doc?
+    assert_equal 0, m.score
   end
 
   def test_attr_getset
@@ -251,6 +261,7 @@ describe ::Inch::CodeObject::Proxy::MethodObject do
     assert m.getter?, "should be a getter"
     refute m.setter?
     refute m.has_doc?
+    assert_equal 0, m.score
   end
 
   def test_attr_getset2
@@ -258,6 +269,7 @@ describe ::Inch::CodeObject::Proxy::MethodObject do
     refute m.getter?
     assert m.setter?, "should be a setter"
     refute m.has_doc?
+    assert_equal 0, m.score
   end
 
   def test_splat_parameter_notation

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: inch
 version: !ruby/object:Gem::Version
-  version: 0.4.4.rc1
+  version: 0.4.4.rc2
 platform: ruby
 authors:
 - René Föhring