inch 0.4.9 → 0.4.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cda3975f7c4c00946ceb1e4bd66a3c8df91715a6
-  data.tar.gz: d5f36041326be52c7c0e5959dcfe776133a768d0
+  metadata.gz: 8db784f667f4f70a4d90d9ab4ea5485e38f31590
+  data.tar.gz: ff193873fff093ae113b9efde21245b69019f0ad
 SHA512:
-  metadata.gz: 1d8dec948b24ed11f4697b2deca0bf47de8eab10a474e61305afef05eade69d2b444aa0d81507658b8849d9bd50fcbedda5ccae2ea90b321132c5532c2744018
-  data.tar.gz: b2af424aacd0b6a1d6aceb3bca229ed4d069ad81cae8be57308db6c3ceeefab14d7db28f3c2d98d47bf324a6209d06938b0c246525bfd058276ffb7c3655cc49
+  metadata.gz: ff12fd72f9f142eb7ae4217f003f5f4579f1a05f15baf4d95e583b489380096bdd2b041870b7bd5e4bc2ab8e11ebbb51aabdcc2890683e986f9f49d61440e1e8
+  data.tar.gz: 16b3b9c9a18eea2cb34db191565efeaf01f00688b445cd20417ef0446c2a541a02b9ce561da3a89463932fe6b3dc9f302c006571d5c0baba359ed52c6f0c7849

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

@@ -73,9 +73,8 @@ module Inch
 
             # Returns +true+ if a return value is described by words.
             def return_described?
-              return_tags.any? do |t|
-                !t.text.empty? && !YARD.implicit_tag?(t, self)
-              end || docstring.describes_return? && !implicit_docstring?
+              return_described_via_tag? ||
+                docstring.describes_return? && !implicit_docstring?
             end
 
             def return_typed?
@@ -145,6 +144,19 @@ module Inch
                 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/version.rb

@@ -1,3 +1,3 @@
 module Inch
-  VERSION = "0.4.9"
+  VERSION = "0.4.10"
 end

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

@@ -41,10 +41,14 @@ module Foo
     def method_without_docstring(p1, p2 = nil)
     end
 
-    # @return [void]
+    # @return [String]
     def method_without_params_or_docstring
     end
 
+    # @return [void]
+    def method_without_usable_return_value
+    end
+
     # Provides an example of a method without parameters
     # missing the return type.
     #

data/test/integration/cli/command/suggest_test.rb

@@ -13,7 +13,7 @@ describe ::Inch::CLI::Command::Suggest do
     refute out.empty?, "there should be some output"
     assert err.empty?, "there should be no errors"
     assert_match /\bFoo::Bar#method_with_wrong_doc\b/, out
-    assert_match /\bFoo::Bar#method_without_docstring\b/, out
+    assert_match /\bFoo::Bar#method_with_rdoc_doc\b/, out
     assert_match /\bFoo::Bar#method_with_unstructured_doc\b/, out
   end
 
@@ -32,7 +32,7 @@ describe ::Inch::CLI::Command::Suggest do
     refute out.empty?, "there should be some output"
     assert err.empty?, "there should be no errors"
     assert_match /\bFoo::Bar#method_with_wrong_doc\b/, out
-    assert_match /\bFoo::Bar#method_without_docstring\b/, out
+    assert_match /\bFoo::Bar#method_with_rdoc_doc\b/, out
     assert_match /\bFoo::Bar#method_with_unstructured_doc\b/, out
   end
 
@@ -53,7 +53,7 @@ describe ::Inch::CLI::Command::Suggest do
     refute out.empty?, "there should be some output"
     assert err.empty?, "there should be no errors"
     assert_match /\bFoo::Bar#method_with_wrong_doc\b/, out
-    assert_match /\bFoo::Bar#method_without_docstring\b/, out
+    assert_match /\bFoo::Bar#method_with_rdoc_doc\b/, out
     assert_match /\bFoo::Bar#method_with_unstructured_doc\b/, out
   end
 

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

@@ -99,6 +99,15 @@ describe ::Inch::CodeObject::Proxy::MethodObject do
       refute m.has_doc?
       refute m.has_parameters?
       assert m.return_mentioned?
+      refute m.return_described?
+
+      assert m.score
+    end
+
+    it "should handle unusable return value when only @return [void] is given" do
+      m = @objects.find("Foo::Bar#method_without_usable_return_value")
+      assert m.return_mentioned?
+      assert m.return_described?
 
       assert m.score
     end

metadata

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