apipie-dsl 2.2.5 → 2.2.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3abb36cc2c2a73c3d36df30adc52256d373862ef6e8d1d206502b35d2b6de2fc
-  data.tar.gz: b38860b723fe7a8e805e8dc9f29d36edad87a249a4bd1c2ac3b5776afed9f450
+  metadata.gz: 990ebec629f1450a927333b32acec610e62378a52dd4d04247de392fa15376ad
+  data.tar.gz: 15a19b903fa3a51096eda59a022ffcfaaaf1bbe82d9253a25b7696a6c04321bc
 SHA512:
-  metadata.gz: e83577ac774732338ed3ae5a9036aab988fd28fa95c173d331747f95e110c3a7393107728cdf92fdadde3e157b0731b01099a024deba10ea3625ee74a7271021
-  data.tar.gz: 8dd6360df8ce33373c4657646df2be53e1b3bae450cce471e476b70108e30ef4d7a081c5afa381849972390abe9db73f9998bd5ac159059c2cc699862e03c802
+  metadata.gz: 8b0a2d9ea7df944cb6b1585db1bc18bc98220ffab60e612e832e9eddbd0e19668067da1b950b342b906a36e922c4f539d35ccf4a9d70977593a5931195d16e94
+  data.tar.gz: ab9e8070fed5ce6cb24c5da93ec3c4b297cb792fa704b5e3fcc2f74c40927deaf608e0401de6dc5eef46fc784e9a89300b9317768398a44f78805c2ccb766333

data/app/helpers/apipie_dsl_helper.rb

@@ -12,8 +12,49 @@ 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, class: 'wiki')
+
+    if output.present?
+      text += content_tag(:p, _('Example output:')) +
+        content_tag(:pre, output, class: 'wiki')
+    end
+
+    text.html_safe
+  end
+
+  def apipie_erb_wrap(content, mode: :loud, open_trim: false, close_trim: false)
+    case mode
+    when :loud
+      '<%= ' + content + " #{close_trim ? '-' : ''}%>"
+    when :comment
+      '<%# ' + content + " #{close_trim ? '-' : ''}%>"
+    else
+      "<%#{open_trim ? '- ' : ' '}" + content + " #{close_trim ? '-' : ''}%>"
+    end
   end
 
   def resolve_default(default)
@@ -22,6 +63,8 @@ module ApipieDslHelper
       'nil'
     when ''
       "\"\""
+    when Symbol
+      ":#{default}"
     else
       default
     end
@@ -58,6 +101,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)

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'>
@@ -26,10 +26,10 @@
       </div>
 
       <% unless meth[:see].empty? %>
-        Also see <%= meth[:see].map { |s| link_to(s[:description], "#{s[:link]}#{link_extension}") }.to_sentence.html_safe %>.
+        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/_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) }) %>

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

@@ -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

@@ -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/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

data/lib/apipie_dsl/dsl.rb

@@ -347,7 +347,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,7 +385,7 @@ module ApipieDSL
       end
 
       def self.extension_data
-        @extension_data ||= []
+        @extension_data ||= { methods: [] }
       end
 
       # rubocop:disable Metrics/AbcSize
@@ -553,16 +553,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 +595,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/tasks_utils.rb

@@ -73,7 +73,7 @@ module ApipieDSL
         class_file_base = File.join(file_base, class_desc[:id])
         FileUtils.mkdir_p(File.dirname(class_file_base)) unless File.exist?(File.dirname(class_file_base))
 
-        doc = ApipieDSL.docs(version, class_name, nil, lang)
+        doc = ApipieDSL.docs(version, class_name, nil, lang, section)
         doc[:docs][:link_extension] = (lang ? ".#{lang}.html" : '.html')
         render_page("#{class_file_base}#{lang_ext(lang)}.html", 'class',
                     doc: doc[:docs], klass: doc[:docs][:classes].first,
@@ -90,7 +90,7 @@ module ApipieDSL
           method_file_base = File.join(file_base, class_name.to_s, method[:name].to_s)
           FileUtils.mkdir_p(File.dirname(method_file_base)) unless File.exist?(File.dirname(method_file_base))
 
-          doc = ApipieDSL.docs(version, class_name, method[:name], lang)
+          doc = ApipieDSL.docs(version, class_name, method[:name], lang, section)
           doc[:docs][:link_extension] = (lang ? ".#{lang}.html" : '.html')
           render_page("#{method_file_base}#{lang_ext(lang)}.html", 'method',
                       doc: doc[:docs], klass: doc[:docs][:classes].first,

data/lib/apipie_dsl/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apipie-dsl
 version: !ruby/object:Gem::Version
-  version: 2.2.5
+  version: 2.2.10
 platform: ruby
 authors:
 - Oleh Fedorenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-26 00:00:00.000000000 Z
+date: 2020-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler