inch 0.4.4.rc2 → 0.4.4.rc3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 939665081ef1fae175405f3e47c6aab33b96449a
-  data.tar.gz: 384311683a56411b6408f0206af6e5428c828d04
+  metadata.gz: 906e6d4610f4a1e6b81d26882e245c6b79080963
+  data.tar.gz: 5777392ea8de43a8536c7e223be7b2fbdf16af38
 SHA512:
-  metadata.gz: 38867d8c71272f70cc7195cc2e65a1830b0cd63a88738ee23bc1cc04d4a5ee90e28ecdfb511f442655708841a1cb747919c4adec8596a194daee63cfb4f8e241
-  data.tar.gz: dc096ab206cc711c66203426303b5e44aff321dbcf849a7579da4ba91db842b1fc320c88206de44858a3aaa3ee9527a2bb6a3b823f3fe598097ac89102276c10
+  metadata.gz: 0e7375a37a7d8166fb730f61c7bf2fcf935d2919d463342c4327d9f2a47911086ebe1bcc007787a64c79f94a48c158178165483d880f884fe672bc16a7015267
+  data.tar.gz: 18d13d4469bdfcc1beff48798a6aeacb5e9b2eda677e9a766b32eb3ec5fee6ad6a0c4a7dad1c67e5335914c897044a7a3870c524230f576707b4728402f39e02

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

@@ -4,6 +4,39 @@ module Inch
       # Parses the source tree (using YARD)
       module YARD
 
+        # Returns +true+ if the docstring was generated by YARD
+        #
+        # @param docstring [Docstring,String]
+        # @param method [MethodObject]
+        def self.implicit_docstring?(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
+
+        # Returns +true+ if the tag was generated by YARD
+        #
+        # @param tag [::YARD::Tag]
+        # @param method [MethodObject]
+        def self.implicit_tag?(tag, method)
+          name = method.name
+          if method.getter?
+            tag.tag_name == 'return' &&
+              tag.text == "the current value of #{name}"
+          elsif method.setter?
+            tag.tag_name == 'return' &&
+              tag.text == 'the newly set value'
+          else
+            false
+          end
+        end
+
         def self.parse(dir, config = Inch::Config.codebase)
           Parser.parse(dir, config)
         end

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

@@ -3,22 +3,6 @@ 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,11 +64,12 @@ module Inch
             end
 
             def return_mentioned?
-              !return_tags.empty? || docstring.mentions_return? && !implicit_docstring?
+              return_tags.any? { |t| !t.types.empty? && !YARD.implicit_tag?(t, self) } ||
+                docstring.mentions_return? && !implicit_docstring?
             end
 
             def return_described?
-              return_tags.any? { |t| !t.text.empty? } ||
+              return_tags.any? { |t| !t.text.empty? && !YARD.implicit_tag?(t, self) } ||
                 docstring.describes_return? && !implicit_docstring?
             end
 
@@ -100,7 +101,7 @@ module Inch
 
             # Returns +true+ if the docstring was generated by YARD
             def implicit_docstring?
-              Docstring.implicit?(docstring, self)
+              YARD.implicit_docstring?(docstring, self)
             end
 
             def overload_tags

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

@@ -70,7 +70,7 @@ module Inch
 
             # Returns +true+ if the docstring was generated by YARD
             def implicit_docstring?
-              Docstring.implicit?(docstring, method)
+              YARD.implicit_docstring?(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.rc2"
+  VERSION = "0.4.4.rc3"
 end

data/test/fixtures/simple/lib/role_methods.rb

@@ -2,6 +2,8 @@ def root_method
 end
 
 module InchTest
+  StructGetSet = Struct.new(:struct_getset)
+
   attr_accessor :attr_getset
 
   def manual_getset

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

@@ -272,6 +272,22 @@ describe ::Inch::CodeObject::Proxy::MethodObject do
     assert_equal 0, m.score
   end
 
+  def test_struct_getset
+    m = @objects.find("InchTest::StructGetSet#struct_getset")
+    assert m.getter?, "should be a getter"
+    refute m.setter?
+    refute m.has_doc?
+    assert_equal 0, m.score
+  end
+
+  def test_struct_getset2
+    m = @objects.find("InchTest::StructGetSet#struct_getset=")
+    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
     # it should assign the same score whether the parameter is
     # described with or without the splat (*) operator

metadata

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