apipie-dsl 2.2.7 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 751af0c065bd8a384dc9c710dc53da2275015666c7076c3a13eb4c89f47860d3
-  data.tar.gz: fab345212215d732917c7c16375088d850933f147f4c49d757732dea8576ad0f
+  metadata.gz: 95dfead8f64abaa0afb0acb4c8af97c43a484d0486596a08049420baff6ba9a4
+  data.tar.gz: 5f454030f583bd23a2728693c6950c6c145223289448f1f6ae681c021cc0897f
 SHA512:
-  metadata.gz: 490ad088339064f5495b3c1271ec549446444b17b4c0b7fc71b16ad1afc5b458b6d22525e2e2158a73f41aab346c4201333410f95c509bad971dcda5f17aa694
-  data.tar.gz: 9e6285a8b353bdc8e87bf7485955bd6ce250734bd2140272329518080da2ebe316d9fc7c7f70b146d04263d601f8eb0b017b3cc8eda4e3f44dee730279c61954
+  metadata.gz: e0d8dccd8fdaa5bbd2c8cc1ef4a89cdda096fa000ace242518f5196a420cf7cc7e62f4790d3f9e6c1b7335bdc2dd65c5b6dbe5133fceb7b6477376d3bf95d640
+  data.tar.gz: c5a0a6ba9167b2bf13e117ca608d997689ab97eb76e422a69423dab1c8152c7e203594dde8d9d6216e661c4116a5d6f5f113ed95913b41b8d41cb6418f8f3232

data/app/helpers/apipie_dsl_helper.rb

@@ -12,17 +12,35 @@ module ApipieDslHelper
     end
   end
 
-  def escaped_method_name(method, escaping = '')
-    return method.gsub('?', escaping) if method.is_a?(String)
+  def escaped_method_name(method, options = {})
+    options[:escaping] ||= ''
+    options[:pattern] ||= /[?]/
+    return method.gsub(options[:pattern], options[:escaping]) if method.is_a?(String)
+  end
+
+  def apipie_dsl_menu
+    content_tag(:ul, class: 'breadcrumb') do
+      content = dsl_sections.map do |section|
+        content_tag(:li, class: section == @section ? 'active' : '') do
+          link_to(_(section.titleize), @doc[:doc_url] + section_ext(section) + @doc[:link_extension])
+        end
+      end.join(' | ').html_safe
+
+      unless ApipieDSL.configuration.help_layout.nil?
+        content += content_tag(:li, class: "pull-right #{'active' if @section == 'help'}") do
+          link_to(_('Help'), @doc[:doc_url] + section_ext('help') + @doc[:link_extension])
+        end
+      end
+    end
   end
 
   def apipie_dsl_example(source, output = nil)
     text = content_tag(:p, _('Example input:')) +
-      content_tag(:pre, source)
+      content_tag(:pre, source, class: 'wiki')
 
     if output.present?
       text += content_tag(:p, _('Example output:')) +
-        content_tag(:pre, output)
+        content_tag(:pre, output, class: 'wiki')
     end
 
     text.html_safe
@@ -31,11 +49,11 @@ module ApipieDslHelper
   def apipie_erb_wrap(content, mode: :loud, open_trim: false, close_trim: false)
     case mode
     when :loud
-      '<%= ' + content + " #{close_trim ? '-' : ''}%>"
+      "<%= #{content} #{close_trim ? '-' : ''}%>"
     when :comment
-      '<%# ' + content + " #{close_trim ? '-' : ''}%>"
+      "<%# #{content} #{close_trim ? '-' : ''}%>"
     else
-      "<%#{open_trim ? '- ' : ' '}" + content + " #{close_trim ? '-' : ''}%>"
+      "<%#{open_trim ? '-' : ''} #{content} #{close_trim ? '-' : ''}%>"
     end
   end
 
@@ -45,6 +63,10 @@ module ApipieDslHelper
       'nil'
     when ''
       "\"\""
+    when Symbol
+      ":#{default}"
+    when String
+      "\"#{default}\""
     else
       default
     end
@@ -81,6 +103,9 @@ module ApipieDslHelper
     # Try to convert to a constant in case of LazyValidator usage
     # Will raise const missing exception in case of wrong usage of the method
     if obj.is_a?(String)
+      ref = ApipieDSL.refs[version][ApipieDSL.get_class_name(obj)]
+      return "<a href='#{ref.doc_url(ref.sections.first)}#{link_extension}'>#{obj}</a>" if ref
+
       obj = ApipieDSL.configuration.rails? ? obj.constantize : obj.split('::').reduce(::Module, :const_get)
     end
     return obj.to_s unless [::Module, ::Class, ::Array].include?(obj.class)
@@ -119,9 +144,10 @@ module ApipieDslHelper
   end
 
   def current_version(classes)
-    if classes.is_a?(Array)
+    case classes
+    when Array
       classes.first[:version]
-    elsif classes.is_a?(Hash)
+    when Hash
       classes.values.first[:version]
     else
       raise ApipieDSL::Error, "Cannot find current version for #{classes}"

data/app/public/apipie_dsl/stylesheets/application.css

@@ -5,3 +5,14 @@ body {
 .sidebar-nav {
   padding: 9px 0;
 }
+
+pre:not(.prettyprint):not(.wiki) {
+  margin: 0 0 9px;
+  padding: 0;
+  font-family: "Helvetica Neue",Helvetica,Arial,sans-serif;
+  font-size: 13px;
+  line-height: 18px;
+  color: #333333;
+  background-color: inherit;
+  border: none;
+}

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

@@ -1,7 +1,7 @@
 <% if prop[:show] %>
   <tr>
     <td>
-      <a href='<%= doc_url %><%= link_extension %>#link-description-<%= escaped_method_name(prop[:name], '_') %>'>
+      <a href='<%= doc_url %><%= link_extension %>#link-description-<%= escaped_method_name(prop[:name], escaping: '_') %>'>
         <%= prop[:name] %>
       </a>
       <% if prop[:deprecated] %>

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

@@ -8,7 +8,7 @@
       <div>
         <% (meth[:signature] || [method_signature(meth)]).each do |signature| %>
           <h2>
-            <a href='#description-<%= escaped_method_name(meth[:name], '_') %>'
+            <a href='#description-<%= escaped_method_name(meth[:name], escaping: '_') %>'
              class='accordion-toggle'
              data-toggle='collapse'
              data-parent='#meth-accordion'>
@@ -29,7 +29,7 @@
         Also see <%= meth[:see].map { |s| link_to(s[:description] || s[:link], "#{s[:url]}#{link_extension}") }.to_sentence.html_safe %>.
       <% end %>
 
-      <div id='description-<%= escaped_method_name(meth[:name], '_') %>' class='collapse accordion-body'>
+      <div id='description-<%= escaped_method_name(meth[:name], escaping: '_') %>' class='collapse accordion-body'>
         <%= render partial: 'method_detail', locals: { method: meth, h_level: 3 } %>
       </div>
     </td>

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

@@ -9,7 +9,8 @@
     <td>
       <strong><%= param[:full_name] %> </strong><br>
       <small>
-        <%=  t("apipie_dsl.#{param[:type]}") %>
+        <%=  t("apipie_dsl.#{param[:type]}") %><br>
+        <%= param[:type] == 'keyword' ? 'Optional' : '' %>
       </small>
     </td>
     <td>

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

@@ -4,7 +4,7 @@
       <td>
         <div>
           <h2>
-            <a id='link-description-<%= escaped_method_name(prop[:name], '_') %>' href='#description-<%= escaped_method_name(prop[:name], '_') %>'
+            <a id='link-description-<%= escaped_method_name(prop[:name], escaping: '_', pattern: /[?!]/) %>' href='#description-<%= escaped_method_name(prop[:name], escaping: '_', pattern: /[?!]/) %>'
              class='accordion-toggle'
              data-toggle='collapse'
              data-parent='#prop-accordion'>
@@ -15,7 +15,7 @@
           </h2>
         </div>
 
-        <div id='description-<%= escaped_method_name(prop[:name], '_') %>' class='collapse accordion-body'>
+        <div id='description-<%= escaped_method_name(prop[:name], escaping: '_', pattern: /[?!]/) %>' class='collapse accordion-body'>
           <%= render partial: 'property_detail', locals: { property: prop, h_level: 3 } %>
         </div>
       </td>

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

@@ -3,6 +3,16 @@
   <%= render(partial: 'metadata', locals: { meta: property[:metadata] }) %>
 <% end %>
 
+<% unless property[:examples].blank? %>
+  <%= heading(t('apipie_dsl.examples'), h_level) %>
+  <% property[:examples].each do |example| %>
+    <% if example[:desc] %>
+      <p><%= example[:desc] %></p>
+    <% end %>
+    <pre class="prettyprint"><%= example[:example] %></pre>
+  <% end %>
+<% end %>
+
 <% unless property[:params].blank? %>
   <%= heading(t('apipie_dsl.params'), h_level) %>
   <table class='table'>

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

@@ -1,18 +1,4 @@
-<ul class='breadcrumb'>
-  <% dsl_sections.each do |section| %>
-    <% if section == @section %>
-      <li class='active'><a href='<%= @doc[:doc_url] %><%= section_ext(section) %><%= @doc[:link_extension] %>'><%= t("apipie_dsl.#{@section}") %></a></li>
-    <% else %>
-      <li><a href='<%= @doc[:doc_url] %><%= section_ext(section) %><%= @doc[:link_extension] %>'><%= t("apipie_dsl.#{section}") %></a></li>
-    <% end %>
-  <% end %>
-  <% unless ApipieDSL.configuration.help_layout.nil? %>
-    <li class='pull-right'>
-      <% section = 'help' %>
-      <a href='<%= @doc[:doc_url] %><%= section_ext(section) %><%= @doc[:link_extension] %>'><%= t("apipie_dsl.#{section}") %></a>
-    </li>
-  <% end %>
-</ul>
+<%= apipie_dsl_menu %>
 <ul class='breadcrumb'>
   <li>
     <a href='<%= @doc[:doc_url] %><%= section_ext(@section) %><%= @doc[:link_extension] %>'><%= @doc[:name] %> <%= @klass[:version] %></a>

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

@@ -1,12 +1,4 @@
 <% if ApipieDSL.configuration.help_layout %>
-  <ul class='breadcrumb'>
-    <% dsl_sections.each do |section| %>
-      <li><a href='<%= @doc[:doc_url] %><%= section_ext(section) %><%= @doc[:link_extension] %>'><%= t("apipie_dsl.#{section}") %></a></li>
-    <% end %>
-      <li class='active pull-right'>
-        <% section = 'help' %>
-        <a href='<%= @doc[:doc_url] %><%= section_ext(section) %><%= @doc[:link_extension] %>'><%= t("apipie_dsl.#{section}") %></a>
-      </li>
-  </ul>
+  <%= apipie_dsl_menu %>
   <%= render_help %>
 <% end %>

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

@@ -1,18 +1,5 @@
-<ul class='breadcrumb'>
-  <% dsl_sections.each do |section| %>
-    <% if section == @section %>
-      <li class='active'><a href='<%= @doc[:doc_url] %><%= section_ext(section) %><%= @doc[:link_extension] %>'><%= t("apipie_dsl.#{@section}") %></a></li>
-    <% else %>
-      <li><a href='<%= @doc[:doc_url] %><%= section_ext(section) %><%= @doc[:link_extension] %>'><%= t("apipie_dsl.#{section}") %></a></li>
-    <% end %>
-  <% end %>
-  <% unless ApipieDSL.configuration.help_layout.nil? %>
-    <li class='pull-right'>
-      <% section = 'help' %>
-      <a href='<%= @doc[:doc_url] %><%= section_ext(section) %><%= @doc[:link_extension] %>'><%= t("apipie_dsl.#{section}") %></a>
-    </li>
-  <% end %>
-</ul>
+<%= apipie_dsl_menu %>
+
 <ul class='breadcrumb'>
   <li class='active'><a href='<%= @doc[:doc_url] %><%= section_ext(@section) %><%= @doc[:link_extension] %>'><%= @doc[:name] %> <%= current_version(@doc[:classes]) %></a></li>
   <%= render(partial: 'languages', locals: { doc_url: @doc[:doc_url] + section_ext(@section) }) %>
@@ -27,7 +14,7 @@
 
 <h1 class='page-header'><%= t('apipie_dsl.classes') %></h1>
 
-<% @doc[:classes].each_value do |klass| %>
+<% @doc[:classes].sort_by { |id, c| c[:name] }.each do |id, klass| %>
   <% next unless klass[:show] && in_section?(@section, klass[:id]) %>
   <h2>
     <a href='<%= klass[:doc_url] %><%= @doc[:link_extension] %>'>

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

@@ -1,18 +1,4 @@
-<ul class='breadcrumb'>
-  <% dsl_sections.each do |section| %>
-    <% if section == @section %>
-      <li class='active'><a href='<%= @doc[:doc_url] %><%= section_ext(section) %><%= @doc[:link_extension] %>'><%= t("apipie_dsl.#{@section}") %></a></li>
-    <% else %>
-      <li><a href='<%= @doc[:doc_url] %><%= section_ext(section) %><%= @doc[:link_extension] %>'><%= t("apipie_dsl.#{section}") %></a></li>
-    <% end %>
-  <% end %>
-  <% unless ApipieDSL.configuration.help_layout.nil? %>
-    <li class='pull-right'>
-      <% section = 'help' %>
-      <a href='<%= @doc[:doc_url] %><%= section_ext(section) %><%= @doc[:link_extension] %>'><%= t("apipie_dsl.#{section}") %></a>
-    </li>
-  <% end %>
-</ul>
+<%= apipie_dsl_menu %>
 <ul class='breadcrumb'>
   <li>
     <a href='<%= @doc[:doc_url] %><%= section_ext(@section) %><%= @doc[:link_extension] %>'><%= @doc[:name] %> <%= @klass[:version] %></a>

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

@@ -1,4 +1,4 @@
-<% @doc[:classes].sort_by(&:first).each do |key, klass| %>
+<% @doc[:classes].sort_by { |id, c| c[:name] }.each do |key, klass| %>
   <% next unless klass[:show] %>
   <h4><a href='#<%= key %>'><%= klass[:name] %></a></h4>
   <ul>
@@ -14,7 +14,7 @@
   </ul>
 <% end %>
 
-<% @doc[:classes].sort_by(&:first).each do |key, klass| %>
+<% @doc[:classes].sort_by { |id, c| c[:name] }.each do |key, klass| %>
   <% next unless klass[:show] %>
   <hr/>
   <div>
@@ -42,7 +42,10 @@
         <% unless prop[:examples].blank? %>
           <h4><%= t('apipie_dsl.examples') %></h4>
           <% prop[:examples].each do |example| %>
-            <pre class="wiki"><%= example %></pre>
+            <% if example[:desc] %>
+              <p><%= example[:desc] %></p>
+            <% end %>
+            <pre class="wiki"><%= example[:example] %></pre>
           <% end %>
         <% end %>
 
@@ -79,7 +82,10 @@
         <% unless method[:examples].blank? %>
           <h4><%= t('apipie_dsl.examples') %></h4>
           <% method[:examples].each do |example| %>
-            <pre class="wiki"><%= example %></pre>
+            <% if example[:desc] %>
+              <p><%= example[:desc] %></p>
+            <% end %>
+            <pre class="wiki"><%= example[:example] %></pre>
           <% end %>
         <% end %>
 

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

@@ -1,4 +1,4 @@
-<% @doc[:classes].sort_by(&:first).each do |key, klass| %>
+<% @doc[:classes].sort_by { |id, c| c[:name] }.each do |key, klass| %>
   <% next unless klass[:show] %>
   <h4><a href='#<%= key %>'><%= klass[:name] %></a></h4>
   <ul>
@@ -18,7 +18,7 @@
 
 <hr>
 
-<% @doc[:classes].sort_by(&:first).each do |key, klass| %>
+<% @doc[:classes].sort_by { |id, c| c[:name] }.each do |key, klass| %>
   <% next unless klass[:show] %>
   <ul class='breadcrumb'  id='<%= key %>'>
     <li><a href='#'><%= @doc[:name] %></a><span class='divider'>/</span></li>
@@ -59,7 +59,10 @@
         <% unless prop[:examples].blank? %>
           <h2><%= t('apipie_dsl.examples') %></h2>
           <% prop[:examples].each do |example| %>
-            <pre><%= example %></pre>
+            <% if example[:desc] %>
+              <p><%= example[:desc] %></p>
+            <% end %>
+            <pre><%= example[:example] %></pre>
           <% end %>
         <% end %>
 
@@ -107,7 +110,10 @@
         <% unless method[:examples].blank? %>
           <h2><%= t('apipie_dsl.examples') %></h2>
           <% method[:examples].each do |example| %>
-            <pre><%= example %></pre>
+            <% if example[:desc] %>
+              <p><%= example[:desc] %></p>
+            <% end %>
+            <pre class="prettyprint"><%= example[:example] %></pre>
           <% end %>
         <% end %>
 

data/lib/apipie_dsl/application.rb

@@ -6,7 +6,7 @@ module ApipieDSL
       require 'apipie_dsl/static_dispatcher'
 
       class Engine < Rails::Engine
-        initializer 'static assets', :before => :build_middleware_stack do |app|
+        initializer 'static assets', before: :build_middleware_stack do |app|
           app.middleware.use ::ApipieDSL::StaticDispatcher, "#{root}/app/public"
         end
       end

data/lib/apipie_dsl/class_description.rb

@@ -12,7 +12,7 @@ module ApipieDSL
       @properties = []
       @version = version || ApipieDSL.configuration.default_version
       @parent = ApipieDSL.get_class_description(ApipieDSL.superclass_for(klass), version)
-      @refs = []
+      @refs = [@name]
       @sections = []
       @show = true
       update_from_dsl_data(dsl_data) if dsl_data
@@ -20,17 +20,22 @@ module ApipieDSL
 
     def update_from_dsl_data(dsl_data)
       @name = dsl_data[:class_name] if dsl_data[:class_name]
-      @full_description = ApipieDSL.markup_to_html(dsl_data[:description])
-      @short_description = dsl_data[:short_description]
+      @full_description = ApipieDSL.markup_to_html(dsl_data[:description]) if dsl_data[:description]
+      @short_description = dsl_data[:short_description] || @short_description
       @tag_list = dsl_data[:tag_list]
-      @metadata = dsl_data[:meta]
+      if dsl_data[:meta].is_a?(Hash)
+        @metadata&.merge!(dsl_data[:meta])
+      elsif dsl_data[:meta]
+        @metadata = dsl_data[:meta]
+      end
       @deprecated = dsl_data[:deprecated] || false
       @show = dsl_data[:show] || @show
-      @properties = (dsl_data[:properties] || []).map do |args|
-        ApipieDSL::MethodDescription.from_dsl_data(self, args)
+      prop_names = @properties.map(&:name)
+      (dsl_data[:properties] || []).each do |args|
+        @properties << ApipieDSL::MethodDescription.from_dsl_data(self, args) unless prop_names.include?(args.first.to_s)
       end
-      @refs = dsl_data[:refs] || [@name]
-      @sections = dsl_data[:sections] || @sections
+      @refs = (@refs + dsl_data[:refs]).uniq if dsl_data[:refs]
+      @sections = (@sections + dsl_data[:sections]).uniq if dsl_data[:sections]
       return unless dsl_data[:app_info]
 
       ApipieDSL.configuration.app_info[version] = dsl_data[:app_info]
@@ -65,10 +70,6 @@ module ApipieDSL
       @methods.values
     end
 
-    def property_descriptions
-      @properties
-    end
-
     def doc_url(section = nil)
       crumbs = []
       crumbs << version if ApipieDSL.configuration.version_in_url
@@ -97,8 +98,8 @@ module ApipieDSL
         full_description: ApipieDSL.translate(@full_description, lang),
         version: version,
         metadata: @metadata,
-        properties: @properties.map { |prop_desc| prop_desc.docs(section, lang) },
-        methods: methods,
+        properties: @properties.map { |prop_desc| prop_desc.docs(section, lang) }.sort_by { |p| p[:name] },
+        methods: methods.sort_by { |m| m[:name] },
         deprecated: @deprecated,
         show: @show
       }

data/lib/apipie_dsl/dsl.rb

@@ -202,9 +202,10 @@ module ApipieDSL
         options[:desc] = desc_or_options
       end
 
-      if retobj_or_options.is_a?(Hash)
+      case retobj_or_options
+      when Hash
         options.merge!(retobj_or_options)
-      elsif retobj_or_options.is_a?(Symbol)
+      when Symbol
         options[:param_group] = retobj_or_options
       else
         options[:object_of] ||= retobj_or_options
@@ -347,7 +348,7 @@ module ApipieDSL
       include ApipieDSL::Klass
       include ApipieDSL::Method
 
-      attr_reader :class_scope
+      attr_accessor :class_scope
 
       def initialize(class_scope)
         @class_scope = class_scope
@@ -385,10 +386,9 @@ module ApipieDSL
       end
 
       def self.extension_data
-        @extension_data ||= []
+        @extension_data ||= { methods: [] }
       end
 
-      # rubocop:disable Metrics/AbcSize
       def self.define_validators(class_scope, method_desc)
         return if method_desc.nil? || ![true, :implicitly, :explicitly].include?(ApipieDSL.configuration.validate)
         return unless [true, :implicitly].include?(ApipieDSL.configuration.validate)
@@ -415,7 +415,7 @@ module ApipieDSL
       def self.update_method_desc(method_desc, dsl_data)
         method_desc.full_description = dsl_data[:description] || method_desc.full_description
         method_desc.short_description = dsl_data[:short_description] || method_desc.short_description
-        if dsl_data[:meta]&.is_a?(Hash)
+        if dsl_data[:meta].is_a?(Hash)
           method_desc.metadata&.merge!(dsl_data[:meta])
         else
           method_desc.metadata = dsl_data[:meta]
@@ -430,7 +430,6 @@ module ApipieDSL
         end
         ParameterDescription.merge(method_desc.plain_params, params)
       end
-      # rubocop:enable Metrics/AbcSize
     end
   end
 
@@ -456,9 +455,10 @@ module ApipieDSL
     end
 
     def apipie(context = :method, desc_or_options = nil, options = {}, &block)
-      if desc_or_options.is_a?(Hash)
+      case desc_or_options
+      when Hash
         options = options.merge(desc_or_options)
-      elsif desc_or_options.is_a?(String)
+      when String
         options[:desc] = desc_or_options
       end
       options[:name] ||= context.to_s
@@ -509,9 +509,10 @@ module ApipieDSL
     private
 
     def prepare_delegatee(scope, desc_or_options, options, &block)
-      if desc_or_options.is_a?(Hash)
+      case desc_or_options
+      when Hash
         options = options.merge(desc_or_options)
-      elsif desc_or_options.is_a?(String)
+      when String
         options[:desc] = desc_or_options
       end
 
@@ -530,9 +531,10 @@ module ApipieDSL
     include ApipieDSL::Delegatable
 
     def apipie(context = :method, desc_or_options = nil, options = {}, &block)
-      if desc_or_options.is_a?(Hash)
+      case desc_or_options
+      when Hash
         options = options.merge(desc_or_options)
-      elsif desc_or_options.is_a?(String)
+      when String
         options[:desc] = desc_or_options
       end
       options[:name] ||= context.to_s
@@ -553,16 +555,19 @@ module ApipieDSL
 
       delegatee = Delegatee.instance_for(self).with(&block)
       delegatee.dsl_data[:update_only] = true
-      # Don't eval the block, since it will be evaluated after method is defined
+
       return if context == :method
 
-      # Currently method extensions are supported only
+      # Save instance to reuse when actual scope is set
+      Delegatee.extension_data[:class] = delegatee
       Delegatee.instance_reset
     end
 
     def prepended(klass)
       super
-      Delegatee.extension_data.each do |method_name, dsl_data|
+      Delegatee.extension_data[:class]&.class_scope = klass
+      Delegatee.extension_data[:class]&.eval_dsl_for(:class)
+      Delegatee.extension_data[:methods].each do |method_name, dsl_data|
         class_scope = klass
         if dsl_data[:update_only]
           class_name = ApipieDSL.get_class_name(class_scope)
@@ -592,7 +597,7 @@ module ApipieDSL
       return if Delegatee.instance.nil?
 
       dsl_data = Delegatee.instance.eval_dsl_for(:method)
-      Delegatee.extension_data << [method_name, dsl_data]
+      Delegatee.extension_data[:methods] << [method_name, dsl_data]
     ensure
       Delegatee.instance_reset
     end

data/lib/apipie_dsl/errors.rb

@@ -2,10 +2,12 @@
 
 module ApipieDSL
   class Error < StandardError; end
+
   class ParamError < Error
     attr_accessor :param
 
     def initialize(param)
+      super
       @param = param
     end
   end
@@ -46,6 +48,7 @@ module ApipieDSL
     attr_accessor :value
 
     def initialize(value)
+      super
       @value = value
     end
 
@@ -70,6 +73,7 @@ module ApipieDSL
     attr_reader :value
 
     def initialize(value)
+      super
       @value = value
     end
 

data/lib/apipie_dsl/parameter_description.rb

@@ -33,7 +33,6 @@ module ApipieDSL
       end
     end
 
-    # rubocop:disable Metrics/ParameterLists
     def initialize(method_description, name, validator, desc_or_options = nil, options = {}, &block)
       if desc_or_options.is_a?(Hash)
         options = options.merge(desc_or_options)
@@ -64,7 +63,6 @@ module ApipieDSL
       end
       raise StandardError, "Validator for #{validator} not found." unless @validator
     end
-    # rubocop:enable Metrics/ParameterLists
 
     def validator
       return @validator unless @validator.is_a?(ApipieDSL::Validator::Lazy)

data/lib/apipie_dsl/return_description.rb

@@ -12,8 +12,6 @@ module ApipieDSL
         @param_group = { scope: @scope }
         @options = options
         @return_type = (@options.keys & %i[array_of one_of object_of param_group]).first
-
-        return unless @options[@return_type].is_a?(::Class)
       end
 
       # this routine overrides Param#default_param_group_scope

data/lib/apipie_dsl/routing.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ApipieDSL
   module Routing
     module MapperExtensions

data/lib/apipie_dsl/tasks/apipie_dsl/cache.rake

@@ -8,6 +8,9 @@ namespace :apipie_dsl do
     task :cache, [:include_json] => :environment do |_task, args|
       args.with_defaults(include_json: false)
       include_json = %w[1 true].include?(args[:include_json])
+      cache_part = ENV['cache_part']
+      generate_index = (cache_part == 'classes' ? false : true)
+      generate_classes = (cache_part == 'index' ? false : true)
       time_start = Time.now
       puts "#{time_start} | Started"
       ApipieDSL::TasksUtils.with_loaded_documentation do
@@ -24,12 +27,16 @@ namespace :apipie_dsl do
               ApipieDSL.url_prefix = "../../#{subdir}"
               doc = ApipieDSL.docs(version, nil, nil, lang, section)
               doc[:docs][:link_extension] = "#{ApipieDSL::TasksUtils.lang_ext(lang)}.html"
-              ApipieDSL::TasksUtils.generate_index_page(file_base_version, doc, include_json, true, lang, section)
-              ApipieDSL.url_prefix = "../../../#{subdir}"
-              section_out = "#{file_base_version}/#{section}"
-              ApipieDSL::TasksUtils.generate_class_pages(version, section_out, doc, include_json, lang, section)
-              ApipieDSL.url_prefix = "../../../../#{subdir}"
-              ApipieDSL::TasksUtils.generate_method_pages(version, section_out, doc, include_json, lang, section)
+              if generate_index
+                ApipieDSL::TasksUtils.generate_index_page(file_base_version, doc, include_json, true, lang, section)
+              end
+              if generate_classes
+                ApipieDSL.url_prefix = "../../../#{subdir}"
+                section_out = "#{file_base_version}/#{section}"
+                ApipieDSL::TasksUtils.generate_class_pages(version, section_out, doc, include_json, lang, section)
+                ApipieDSL.url_prefix = "../../../../#{subdir}"
+                ApipieDSL::TasksUtils.generate_method_pages(version, section_out, doc, include_json, lang, section)
+              end
             end
             ApipieDSL.url_prefix = "../../#{subdir}"
             doc = ApipieDSL.docs(version, nil, nil, lang)
@@ -61,12 +68,16 @@ namespace :apipie_dsl do
               ApipieDSL.url_prefix = "../../#{subdir}"
               doc = ApipieDSL.docs(version, nil, nil, lang, section)
               doc[:docs][:link_extension] = "#{ApipieDSL::TasksUtils.lang_ext(lang)}.html"
-              ApipieDSL::TasksUtils.generate_index_page(file_base_version, doc, include_json, true, lang, section)
-              ApipieDSL.url_prefix = "../../../#{subdir}"
-              section_out = "#{file_base_version}/#{section}"
-              ApipieDSL::TasksUtils.generate_class_pages(version, section_out, doc, include_json, lang, section)
-              ApipieDSL.url_prefix = "../../../../#{subdir}"
-              ApipieDSL::TasksUtils.generate_method_pages(version, section_out, doc, include_json, lang, section)
+              if generate_index
+                ApipieDSL::TasksUtils.generate_index_page(file_base_version, doc, include_json, true, lang, section)
+              end
+              if generate_classes
+                ApipieDSL.url_prefix = "../../../#{subdir}"
+                section_out = "#{file_base_version}/#{section}"
+                ApipieDSL::TasksUtils.generate_class_pages(version, section_out, doc, include_json, lang, section)
+                ApipieDSL.url_prefix = "../../../../#{subdir}"
+                ApipieDSL::TasksUtils.generate_method_pages(version, section_out, doc, include_json, lang, section)
+              end
             end
             ApipieDSL.url_prefix = "../../#{subdir}"
             doc = ApipieDSL.docs(version, nil, nil, lang)

data/lib/apipie_dsl/tasks_utils.rb

@@ -21,8 +21,8 @@ module ApipieDSL
         base_paths.unshift("#{Rails.root}/app/views/apipie_dsl/apipie_dsls") if File.directory?("#{Rails.root}/app/views/apipie_dsl/apipie_dsls")
       end
       layouts_paths = [File.expand_path('../../app/views/layouts', __dir__)]
-      if ApipieDSL.configuration.rails?
-        layouts_paths.unshift("#{Rails.root}/app/views/layouts") if File.directory?("#{Rails.root}/app/views/layouts/apipie_dsl")
+      if ApipieDSL.configuration.rails? && File.directory?("#{Rails.root}/app/views/layouts/apipie_dsl")
+        layouts_paths.unshift("#{Rails.root}/app/views/layouts")
       end
       paths = ActionView::PathSet.new(base_paths + layouts_paths)
       @renderer = ActionView::Base.new(paths, {})

data/lib/apipie_dsl/utils.rb

@@ -60,18 +60,7 @@ module ApipieDSL
     end
   end
 end
-if RUBY_VERSION < '2.5.0'
-  class Hash
-    def transform_keys
-      result = {}
-      each do |key, value|
-        new_key = yield key
-        result[new_key] = value
-      end
-      result
-    end
-  end
-end
+
 if defined? Rails
   class Module
     # https://github.com/rails/rails/pull/35035

data/lib/apipie_dsl/validator.rb

@@ -17,6 +17,7 @@ module ApipieDSL
         BaseValidator.find(@param_description, @argument.constantize, @options, @block)
       end
     end
+
     # To create a new validator, inherit from ApipieDSL::Validator::BaseValidator
     # and implement class method 'build' and instance method 'validate'
     class BaseValidator
@@ -49,6 +50,7 @@ module ApipieDSL
       end
 
       def self.inherited(subclass)
+        super(subclass)
         @validators ||= []
         @validators.unshift(subclass)
       end
@@ -325,9 +327,7 @@ module ApipieDSL
         return false unless value.is_a?(Hash)
 
         @hash_params&.each do |name, param|
-          if ApipieDSL.configuration.validate_value?
-            param.validate(value[name]) if value.key?(name)
-          end
+          param.validate(value[name]) if ApipieDSL.configuration.validate_value? && value.key?(name)
         end
         true
       end

data/lib/apipie_dsl/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apipie-dsl
 version: !ruby/object:Gem::Version
-  version: 2.2.7
+  version: 2.4.0
 platform: ruby
 authors:
 - Oleh Fedorenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-26 00:00:00.000000000 Z
+date: 2021-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -206,14 +206,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Ruby DSL documentation tool