inch 0.4.3 → 0.4.4.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dab543a34157a4fe5467c6dbb51a94c112f29a83
-  data.tar.gz: 674f4bd46b9f9b23b10bb5b8264f31019fb6d686
+  metadata.gz: f7dd851b019ec788a43552657ad1b35493956676
+  data.tar.gz: 3653aae1e38341b48df225a67b1334d6cb667c3b
 SHA512:
-  metadata.gz: 6dc8d3ee59dceb8c04145f470820a28a6aff12d2c3462f893bdafc7b274b243bf6f1b12057606c91b2b0573dc0696334b46c993843d2048acc145a12765d8257
-  data.tar.gz: 1270332e354f079ae12c9548d7f40f96b0c94c1debef1974c710ad80e7e03891bce603ef0fd4c6d89db8c19724b53d204d4e2f5f2c00f7a091453f6718ffdbbb
+  metadata.gz: edcdc37b91816acdd782a9f0a40d569bb9009ca0119d60fad5c1e0fdb6d2555e57f74a93fbb5b5cba409f19e601f2617b7eb07ff09100c68ceff756a12037842
+  data.tar.gz: 0e5d86540f4ef8cf5fe45ef76ce4bfda05159e56668114b00e0d2fd5066ddfab30ad664d6779e7cd80fe0fd5532b9bbfe043007072bc34bac20f53195797d0d3

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

@@ -49,6 +49,10 @@ module Inch
             last_line =~ /^Returns\ (\w+\s){2,}/
           end
 
+          def to_s
+            @text
+          end
+
           private
 
           def first_line

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

@@ -30,11 +30,11 @@ module Inch
             end
 
             def has_code_example?
-              super || signatures.any? { |s| s.has_code_example? }
+              signatures.any? { |s| s.has_code_example? }
             end
 
             def has_doc?
-              super && !implicit_docstring? || signatures.any? { |s| s.has_doc? }
+              signatures.any? { |s| s.has_doc? }
             end
 
             def method?
@@ -98,18 +98,6 @@ module Inch
 
             private
 
-            # Returns +true+ if the docstring was generated by YARD
-            def implicit_docstring?
-              if getter?
-                docstring == "Returns the value of attribute #{name}"
-              elsif setter?
-                basename = name.to_s.gsub(/(\=)$/, '')
-                docstring == "Sets the attribute #{basename}"
-              else
-                false
-              end
-            end
-
             def overload_tags
               object.tags(:overload)
             end

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

@@ -5,7 +5,7 @@ module Inch
         module Object
           # Utility class to describe (overloaded) method signatures
           class MethodSignature < Struct.new(:method, :yard_tag)
-            attr_reader :method, :yard_tag
+            attr_reader :method
 
             # @param method [Provider::YARD::Object::MethodObject]
             # @param method [::YARD::Tags::Tag,nil] if nil, the method's normal signature is used
@@ -15,23 +15,19 @@ module Inch
             end
 
             def all_signature_parameter_names
-              if tag?
-                yard_tag.parameters.map(&:first)
-              else
-                yard_object.parameters.map(&:first)
-              end
+              relevant_object.parameters.map(&:first)
             end
 
             def has_code_example?
-              if tag?
-                !yard_tag.tags(:example).empty?
+              if docstring.contains_code_example?
+                true
               else
-                !yard_object.tags(:example).empty?
+                !relevant_object.tags(:example).empty?
               end
             end
 
             def has_doc?
-              !docstring.empty?
+              !docstring.empty? && !implicit_docstring?
             end
 
             def parameters
@@ -42,6 +38,9 @@ module Inch
               end
             end
 
+            # Returns the parameter with the given +name+.
+            # @param name [String,Symbol]
+            # @return [MethodParameterObject]
             def parameter(name)
               parameters.detect { |p| p.name == name.to_s }
             end
@@ -56,11 +55,7 @@ module Inch
             # Returns the actual signature of the method.
             # @return [String]
             def signature
-              if tag?
-                yard_tag.signature
-              else
-                yard_object.signature.gsub(/^(def\ )/, '')
-              end
+              relevant_object.signature.gsub(/^(def\ )/, '')
             end
 
             private
@@ -73,10 +68,19 @@ module Inch
             end
 
             def docstring
-              if tag?
-                yard_tag.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
-                yard_object.docstring
+                false
               end
             end
 
@@ -107,19 +111,11 @@ module Inch
             end
 
             def parameter_tags
-              if tag?
-                @yard_tag.tags(:param)
-              else
-                yard_object.tags(:param)
-              end
-            end
-
-            def tag?
-              !yard_tag.nil?
+              relevant_object.tags(:param)
             end
 
-            def yard_object
-              method.object
+            def relevant_object
+              @yard_tag || method.object
             end
           end
         end

data/lib/inch/version.rb

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

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

@@ -250,12 +250,14 @@ describe ::Inch::CodeObject::Proxy::MethodObject do
     m = @objects.find("InchTest#attr_getset")
     assert m.getter?, "should be a getter"
     refute m.setter?
+    refute m.has_doc?
   end
 
   def test_attr_getset2
     m = @objects.find("InchTest#attr_getset=")
     refute m.getter?
     assert m.setter?, "should be a setter"
+    refute m.has_doc?
   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.3
+  version: 0.4.4.rc1
 platform: ruby
 authors:
 - René Föhring
@@ -315,9 +315,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.2.2