inch 0.4.3.rc1 → 0.4.3.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8df11f0c3f8e4f6ac9aea9b24fc63cd6ecc9d31f
-  data.tar.gz: b91f994c074b34d6d67f81ee36b17c6029c8961d
+  metadata.gz: 51a684b0122ca78cb12bfe784278c7f1e2aced3b
+  data.tar.gz: 047e6d479de69c949e4adf3c79f72ea63f5db753
 SHA512:
-  metadata.gz: e98e2c4bbcf6f32fd6fb9df7b03be207be2d92d103615493b9be1859d1f4fe14e90292d89c4d3cf4090f11d7f2e38c5d8b9cf4b7299cdb5ae6963e02320fbd14
-  data.tar.gz: 8cd1a2706a738a6cb5d4fe970d09aa519e058494c66cdf3d84e4def4b054d600ad49af9634a0f1965b9c42c452f3765b103a97f7b04effa3d7b78943b7f5f5ea
+  metadata.gz: 9d6ef7ac83572913777a95e3408b54c1451d3d9c3a96772b30f106f0bf452b5fe28c0bf687b3e3caad58ec94342916b27bf62ddb6b3e86405bc738e1283d3782
+  data.tar.gz: c7fcf1abab329c2c18b84b11a1419b4aa5be23c852f4ea4403d82c1d09247d0fef3560fc3f799589d7e72bbdbcdae3c5300f8f8ad48d673403b4f26e97c0c2cc

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

@@ -29,8 +29,12 @@ module Inch
               end
             end
 
+            def has_code_example?
+              super || signatures.any? { |s| s.has_code_example? }
+            end
+
             def has_doc?
-              super && !implicit_docstring? || signatures.any? { |t| t.has_doc? }
+              super && !implicit_docstring? || signatures.any? { |s| s.has_doc? }
             end
 
             def method?
@@ -77,8 +81,14 @@ module Inch
             end
 
             def signatures
-              [self, *overload_tags].map do |tag_or_self|
-                MethodSignature.new(self, tag_or_self)
+              base = MethodSignature.new(self, nil)
+              overloaded = overload_tags.map do |tag|
+                MethodSignature.new(self, tag)
+              end
+              if overloaded.any? { |s| s.same?(base) }
+                overloaded
+              else
+                [base] + overloaded
               end
             end
 

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

@@ -4,9 +4,30 @@ module Inch
       module YARD
         module Object
           # Utility class to describe (overloaded) method signatures
-          class MethodSignature < Struct.new(:method, :tag_or_method)
+          class MethodSignature < Struct.new(:method, :yard_tag)
+            attr_reader :method, :yard_tag
+
+            # @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
+            end
+
+            def all_signature_parameter_names
+              if tag?
+                yard_tag.parameters.map(&:first)
+              else
+                yard_object.parameters.map(&:first)
+              end
+            end
+
             def has_code_example?
-              !yard_object.tags(:example).empty?
+              if tag?
+                !yard_tag.tags(:example).empty?
+              else
+                !yard_object.tags(:example).empty?
+              end
             end
 
             def has_doc?
@@ -25,17 +46,24 @@ module Inch
               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
+            end
+
             # Returns the actual signature of the method.
             # @return [String]
             def signature
               if tag?
-                tag_or_method.signature
+                yard_tag.signature
               else
                 yard_object.signature.gsub(/^(def\ )/, '')
               end
             end
 
-            #private
+            private
 
             def all_parameter_names
               all_names = all_signature_parameter_names + parameter_tags.map(&:name)
@@ -44,17 +72,9 @@ module Inch
               end.compact.uniq
             end
 
-            def all_signature_parameter_names
-              if tag?
-                tag_or_method.parameters.map(&:first)
-              else
-                yard_object.parameters.map(&:first)
-              end
-            end
-
             def docstring
               if tag?
-                tag_or_method.docstring
+                yard_tag.docstring
               else
                 yard_object.docstring
               end
@@ -88,18 +108,18 @@ module Inch
 
             def parameter_tags
               if tag?
-                tag_or_method.tags(:param)
+                @yard_tag.tags(:param)
               else
                 yard_object.tags(:param)
               end
             end
 
             def tag?
-              tag_or_method.respond_to?(:signature)
+              !yard_tag.nil?
             end
 
             def yard_object
-              tag_or_method.object
+              method.object
             end
           end
         end

data/lib/inch/version.rb

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

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

@@ -180,13 +180,13 @@ module Overloading
   def missing_param_names(*identifiers)
   end
 
-  # Creates a Hello OpenFlow message.
+  # Tests that the default signature can be overloaded by tags
   #
-  # @overload params_only_in_overloads()
+  # @overload params_also_in_overloads()
   #   @example
   #     Hello.new
   #
-  # @overload params_only_in_overloads(transaction_id)
+  # @overload params_also_in_overloads(transaction_id)
   #   @example
   #     Hello.new(123)
   #   @param [Number] transaction_id
@@ -199,6 +199,29 @@ module Overloading
   # @param [Hash] user_options the options to create a message with.
   # @option user_options [Number] :transaction_id
   # @option user_options [Number] :xid an alias to transaction_id.
+  def params_also_in_overloads(user_options = {})
+  end
+
+  # Tests that the default signature can be present as an overload tag.
+  #
+  # @overload params_only_in_overloads()
+  #   @example
+  #     Hello.new
+  #
+  # @overload params_only_in_overloads(transaction_id)
+  #   @example
+  #     Hello.new(123)
+  #   @param [Number] transaction_id
+  #     An unsigned 32-bit integer number associated with this
+  #     message. If not specified, an auto-generated value is set.
+  #
+  # @overload params_only_in_overloads(user_options)
+  #   @example
+  #     Hello.new(transaction_id: 123)
+  #     Hello.new(xid: 123)
+  #   @param [Hash] user_options the options to create a message with.
+  #   @option user_options [Number] :transaction_id
+  #   @option user_options [Number] :xid an alias to transaction_id.
   def params_only_in_overloads(user_options = {})
   end
 end

data/test/unit/code_object/provider/yard/object/method_object_test.rb

@@ -7,34 +7,62 @@ describe ::Inch::CodeObject::Provider::YARD::Parser do
     @objects = @parser.objects
   end
 
-  it "should work for Overloading#params_only_in_overloads" do
-    m = @objects.detect { |o| o.fullname == 'Overloading#params_only_in_overloads' }
+  it "should work for Overloading#params_also_in_overloads" do
+    m = @objects.detect { |o| o.fullname == 'Overloading#params_also_in_overloads' }
 
     assert m.has_code_example?
 
-    refute m.signatures.empty?
     assert_equal 3, m.signatures.size
     assert_equal 2, m.parameters.size # at this moment, this counts all parameters in all overloaded signatures
 
     signature = m.signatures[0]
-    assert_equal "params_only_in_overloads(user_options = {})", signature.signature
+    assert_equal "params_also_in_overloads(user_options = {})", signature.signature
     assert_equal 1, signature.parameters.size
     refute signature.parameter(:user_options).nil?
     assert signature.has_code_example?
     assert signature.has_doc?
 
     signature = m.signatures[1]
-    assert_equal "params_only_in_overloads()", signature.signature
+    assert_equal "params_also_in_overloads()", signature.signature
     assert signature.parameters.empty?, "Should have been empty: #{signature.parameters.inspect}"
     assert signature.has_code_example?
     refute signature.has_doc?
 
     signature = m.signatures[2]
+    assert_equal "params_also_in_overloads(transaction_id)", signature.signature
+    assert_equal 1, signature.parameters.size
+    refute signature.parameter(:transaction_id).nil?
+    assert signature.has_code_example?
+    refute signature.has_doc?
+  end
+
+  it "should work for Overloading#params_only_in_overloads" do
+    m = @objects.detect { |o| o.fullname == 'Overloading#params_only_in_overloads' }
+
+    assert m.has_code_example?
+
+    assert_equal 3, m.signatures.size
+    assert_equal 2, m.parameters.size # at this moment, this counts all parameters in all overloaded signatures
+
+    signature = m.signatures[0]
+    assert_equal "params_only_in_overloads()", signature.signature
+    assert signature.parameters.empty?, "Should have been empty: #{signature.parameters.inspect}"
+    assert signature.has_code_example?
+    refute signature.has_doc?
+
+    signature = m.signatures[1]
     assert_equal "params_only_in_overloads(transaction_id)", signature.signature
     assert_equal 1, signature.parameters.size
     refute signature.parameter(:transaction_id).nil?
     assert signature.has_code_example?
     refute signature.has_doc?
+
+    signature = m.signatures[2]
+    assert_equal "params_only_in_overloads(user_options)", signature.signature
+    assert_equal 1, signature.parameters.size
+    refute signature.parameter(:user_options).nil?
+    assert signature.has_code_example?
+    #assert signature.has_doc?
   end
 
   it "should work" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: inch
 version: !ruby/object:Gem::Version
-  version: 0.4.3.rc1
+  version: 0.4.3.rc2
 platform: ruby
 authors:
 - René Föhring
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-25 00:00:00.000000000 Z
+date: 2014-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler