apipie-dsl 2.1.1 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a4101d45b403c1034aeadf0175b74213fc86d40268efb89f122a4f0c56da3b8
-  data.tar.gz: 7740ed0a5a764a690acf3a44bc0d773df59f204a18042a92a27026ddc9c86cc6
+  metadata.gz: 8712c1245add4425a89c69480c9a2e043a0c40a71199e64ce2dc4df6b3352973
+  data.tar.gz: e37febc7bf4200644582443d6d39224ab172f666e849abcd219b60a4e28c2809
 SHA512:
-  metadata.gz: 253276c771d1c838c85b3bbb4d523e3881ca362b2c791c5164b52cfcf812db7050f956c4d02378da6740fd55f10e778b0a25b0a3816890f8db0dcd5a8b4add46
-  data.tar.gz: a19479b561f1ca2b98d2fa3596a02419a3076922ff0cb00b82f759fb02459d098651f3985e458fd0214cbffbb27bf7d49820a6d181505605f656099495f20201
+  metadata.gz: 1b8b7af91cb70d835a8227038aef33b559bdd43f8bfcc42a92b83b990b2e212808016a119e5a0543a5f36a4a819b990f8a2127dfe8bc3f987882bea50e4984cf
+  data.tar.gz: 6e7c84c789542c09838bb37650af701bcf24f8210f451e74bbf097541e05659cba3d76be5a29aa687b2176ab8e7c335335671ba7f76110a0ca697d93816384d8

data/app/helpers/apipie_dsl_helper.rb

@@ -44,7 +44,7 @@ module ApipieDslHelper
       when 'keyword'
         "#{param[:name]}: #{default}"
       end
-    end.join(', ')
+    end.compact.join(', ')
 
     block_param = method_desc[:params].find { |p| p[:type] == 'block' }
 

data/app/views/apipie_dsl/apipie_dsls/_method.erb

@@ -6,13 +6,17 @@
         <a href='<%= meth[:doc_url] %><%= link_extension %>'> >>> </a>
       </div>
       <div>
+        <% (meth[:signature] || [method_signature(meth)]).each do |signature| %>
+          <h2>
+            <a href='#description-<%= escaped_method_name(meth[:name], '_') %>'
+             class='accordion-toggle'
+             data-toggle='collapse'
+             data-parent='#meth-accordion'>
+              <%= signature %>
+            </a>
+          </h2>
+        <% end %>
         <h2>
-          <a href='#description-<%= escaped_method_name(meth[:name], '_') %>'
-           class='accordion-toggle'
-           data-toggle='collapse'
-           data-parent='#meth-accordion'>
-            <%= method_signature(meth) %>
-          </a>
           <% if meth[:deprecated] %>
             <code>DEPRECATED</code>
           <% end %>

data/app/views/apipie_dsl/apipie_dsls/method.html.erb

@@ -29,8 +29,10 @@
 </ul>
 
 <div class='page-header'>
+  <% (@method[:signature] || [method_signature(@method)]).each do |signature| %>
+    <h1> <%= signature %> </h1>
+  <% end %>
   <h1>
-    <%= method_signature(@method) %>
     <% if @method[:deprecated] %>
       <code>DEPRECATED</code>
     <% end %>

data/lib/apipie_dsl/dsl.rb

@@ -175,6 +175,10 @@ module ApipieDSL
       dsl_data[:aliases] = names
     end
 
+    def signature(*signature)
+      dsl_data[:signature] = signature
+    end
+
     # Describe possible errors
     #
     # Example:

data/lib/apipie_dsl/method_description.rb

@@ -2,7 +2,7 @@
 
 module ApipieDSL
   class MethodDescription
-    attr_reader :name, :klass, :see, :examples
+    attr_reader :name, :klass, :see, :examples, :signature
     attr_accessor :full_description, :short_description, :metadata, :show,
                   :raises, :returns, :aliases
     alias_method :class_description, :klass
@@ -54,6 +54,8 @@ module ApipieDSL
       end
 
       @aliases = dsl_data[:aliases]
+
+      @signature = dsl_data[:signature]
     end
 
     def id
@@ -105,7 +107,8 @@ module ApipieDSL
         see: see.map(&:docs),
         show: @show,
         examples: @examples,
-        aliases: aliases
+        aliases: aliases,
+        signature: signature
       }
     end
   end

data/lib/apipie_dsl/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ApipieDSL
-  VERSION = '2.1.1'
+  VERSION = '2.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apipie-dsl
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.2.0
 platform: ruby
 authors:
 - Oleh Fedorenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-01 00:00:00.000000000 Z
+date: 2020-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler