Merge pull request #168 from ohai/support-single-overload

Support single overload

lib/sord/generator.rb

@@ -294,6 +294,15 @@ def add_methods(item)
           next
         end
 
+        # If the method has YARD's "@overload" tags, the information of the
+        # first one is merged into meth object
+        # NOTE: This code does not handle the second and subsequent @overload tags
+        if meth.tag("overload")
+          meth.parameters = meth.tag("overload").parameters
+          meth.tag("overload").tags.each { |tag| meth.add_tag(tag) }
+          meth.docstring += meth.tag("overload").docstring
+        end
+
         # Sort parameters
         meth.parameters.reverse.sort! { |pair1, pair2| sort_params(pair1, pair2) }
 

spec/generator_spec.rb

@@ -2017,4 +2017,57 @@ def z(a: -> {}); end
       end
     RUBY
   end
+
+  it 'works with YARD\'s overload tag' do
+    YARD.parse_string(<<-RUBY)
+      class A
+        # @overload x(a, b)
+        #   @param a [String]
+        #   @param b [Integer]
+        #   @return [void]
+        def x(*args); end
+      end
+    RUBY
+
+    expect(rbi_gen.generate.strip).to eq fix_heredoc(<<-RUBY)
+      # typed: strong
+      class A
+        # _@param_ `a`
+        # 
+        # _@param_ `b`
+        sig { params(a: String, b: Integer).void }
+        def x(a, b); end
+      end
+    RUBY
+  end
+
+  it 'works with YARD\'s overload tag with toplevel return tag' do
+    YARD.parse_string(<<-RUBY)
+      class A
+        # Comment for method x
+        # @overload x(a, b)
+        #   Overload comment
+        #   @param a [String]
+        #   @param b [Integer]
+        # @return [Integer] example integer
+        def x(*args); end
+      end
+    RUBY
+
+    expect(rbi_gen.generate.strip).to eq fix_heredoc(<<-RUBY)
+      # typed: strong
+      class A
+        # Comment for method x
+        # Overload comment
+        # 
+        # _@param_ `a`
+        # 
+        # _@param_ `b`
+        # 
+        # _@return_ — example integer
+        sig { params(a: String, b: Integer).returns(Integer) }
+        def x(a, b); end
+      end
+    RUBY
+  end
 end