apipie-dsl 2.0.0

data/app/public/apipie_dsl/stylesheets/bundled/prettify.css

@@ -0,0 +1,30 @@
+.com { color: #93a1a1; }
+.lit { color: #195f91; }
+.pun, .opn, .clo { color: #93a1a1; }
+.fun { color: #dc322f; }
+.str, .atv { color: #D14; }
+.kwd, .linenums .tag { color: #1e347b; }
+.typ, .atn, .dec, .var { color: teal; }
+.pln { color: #48484c; }
+
+.prettyprint {
+  padding: 8px;
+  background-color: #f7f7f9;
+  border: 1px solid #e1e1e8;
+}
+.prettyprint.linenums {
+  -webkit-box-shadow: inset 40px 0 0 #fbfbfc, inset 41px 0 0 #ececf0;
+     -moz-box-shadow: inset 40px 0 0 #fbfbfc, inset 41px 0 0 #ececf0;
+          box-shadow: inset 40px 0 0 #fbfbfc, inset 41px 0 0 #ececf0;
+}
+
+/* Specify class=linenums on a pre to get line numbering */
+ol.linenums {
+  margin: 0 0 0 33px; /* IE indents via margin-left */
+}
+ol.linenums li {
+  padding-left: 12px;
+  color: #bebec5;
+  line-height: 18px;
+  text-shadow: 0 1px 0 #fff;
+}

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

@@ -0,0 +1,11 @@
+<% if meth[:show] %>
+  <tr>
+    <td>
+      <a href='<%= meth[:doc_url] %><%= link_extension %>'><%= meth[:name] %></a>
+      <% if meth[:deprecated] %>
+        <code>DEPRECATED</code>
+      <% end %>
+    </td>
+    <td width='60%'><%= meth[:short_description] %></td>
+  </tr>
+<% end %>

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

@@ -0,0 +1,13 @@
+<% if prop[:show] %>
+  <tr>
+    <td>
+      <a href='<%= doc_url %><%= link_extension %>#link-description-<%= escaped_method_name(prop[:name], '_') %>'>
+        <%= prop[:name] %>
+      </a>
+      <% if prop[:deprecated] %>
+        <code>DEPRECATED</code>
+      <% end %>
+    </td>
+    <td width='60%'><%= prop[:short_description] %></td>
+  </tr>
+<% end %>

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

@@ -0,0 +1,6 @@
+<% if @languages && @languages.size > 1 %>
+<li class='pull-right'>
+  &nbsp;[ <%= @languages.collect { |lang| link = link_to(lang, "#{doc_url}.#{lang}.html");
+    lang == @language ? content_tag(:b, link) : link }.join(' | ').html_safe %> ]
+</li>
+<% end %>

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

@@ -0,0 +1 @@
+<pre class="prettyprint lang-yaml"><%= meta.to_yaml.gsub(/---\n/, "") %></pre>

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

@@ -0,0 +1,34 @@
+<div class='accordion' id='meth-accordion'>
+  <% if meth[:show] %>
+  <tr>
+    <td>
+      <div class='pull-right small'>
+        <a href='<%= meth[:doc_url] %><%= link_extension %>'> >>> </a>
+      </div>
+      <div>
+        <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 %>
+          <br>
+          <small><%= raw meth[:short_description] %></small>
+        </h2>
+      </div>
+
+      <% unless meth[:see].empty? %>
+        Also see <%= meth[:see].map { |s| link_to(s[:description], "#{s[:link]}#{link_extension}") }.to_sentence.html_safe %>.
+      <% end %>
+
+      <div id='description-<%= escaped_method_name(meth[:name], '_') %>' class='collapse accordion-body'>
+        <%= render partial: 'method_detail', locals: { method: meth, h_level: 3 } %>
+      </div>
+    </td>
+  </tr>
+  <% end %>
+</div>

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

@@ -0,0 +1,58 @@
+<% unless method[:aliases].blank? %>
+<%= heading(t('apipie_dsl.aliases'), h_level) %>
+  <pre class="prettyprint"><%= method[:aliases].join(', ') %></pre>
+<% end %>
+
+<%= raw method[:full_description] %>
+
+<% unless method[:raises].blank? %>
+  <%= heading(t('apipie_dsl.raises'), h_level) %>
+  <%= render(:partial => 'raises', :locals => {:raises => method[:raises]}) %>
+<% end %>
+
+<% unless method[:metadata].blank? %>
+  <%= heading(t('apipie_dsl.metadata'), h_level) %>
+  <%= render(:partial => 'metadata', :locals => {:meta => method[:metadata]}) %>
+<% end %>
+
+<% unless method[:examples].blank? %>
+  <%= heading(t('apipie_dsl.examples'), h_level) %>
+  <% method[:examples].each do |example| %>
+    <% if example[:desc] %>
+      <p><%= example[:desc] %></p>
+    <% end %>
+    <pre class="prettyprint"><%= example[:example] %></pre>
+  <% end %>
+<% end %>
+
+<% unless method[:params].blank? %>
+  <%= heading(t('apipie_dsl.params'), h_level) %>
+  <table class='table'>
+    <thead>
+      <tr>
+        <th><%= t('apipie_dsl.param_name') %></th>
+        <th><%= t('apipie_dsl.description') %></th>
+      </tr>
+    </thead>
+    <tbody>
+      <%= render(:partial => 'params', :locals => {:params => method[:params]}) %>
+    </tbody>
+  </table>
+<% end %>
+<% unless method[:returns].blank? %>
+  <%= heading(t('apipie_dsl.returns'), h_level) %>
+  <% if method[:returns][:description] %>
+    <p><%= method[:returns][:description] %></p>
+  <% end %>
+  <table class='table'>
+    <thead>
+      <tr>
+        <th><%= t("apipie_dsl.#{method[:returns][:object][:class]}") %></th>
+        <th><%= t("apipie_dsl.details") %></th>
+      </tr>
+    </thead>
+    <tbody>
+      <%= render(:partial => 'returns', :locals => {:return_object => method[:returns][:object]}) %>
+    </tbody>
+  </table>
+<% end %>

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

@@ -0,0 +1,47 @@
+<% level ||= 0 %>
+<% col = 255 - level * 5 %>
+<% params.each do |param| %>
+  <% if !param[:show] %>
+    <%= render(:partial => 'params', :locals => {:level => level, :params => param[:params]}) unless param[:params].blank? %>
+    <% next %>
+  <% end %>
+  <tr style='background-color:rgb(<%= "#{col},#{col},#{col}" %>);'>
+    <td>
+      <strong><%= param[:full_name] %> </strong><br>
+      <small>
+        <%=  t("apipie_dsl.#{param[:type]}") %>
+      </small>
+    </td>
+    <td>
+      <%= param[:description].html_safe %>
+      <%- if param[:type] != 'required' %>
+        <p><strong>Default value:</strong></p>
+        <ul>
+          <li><%= resolve_default(param[:default]) %></li>
+        </ul>
+      <%- end %>
+      <%- if param[:validations].present? || param[:validator].present? %>
+        <p><strong>Validations:</strong></p>
+        <ul>
+          <%- if param[:validator].present? %>
+            <li><%= ApipieDSL.markup_to_html(param[:validator]).html_safe %></li>
+          <%- end %>
+          <%- if param[:validations].present? %>
+            <%- param[:validations].each do |item| %>
+              <li><%= item.html_safe %></li>
+            <%- end %>
+          <%- end %>
+        </ul>
+      <%- end %>
+
+      <% unless param[:metadata].blank? %>
+        <br>
+        Metadata:
+        <%= render(:partial => 'metadata', :locals => {:meta => param[:metadata]}) %>
+      <% end %>
+    </td>
+
+  </tr>
+
+  <%= render(:partial => 'params', :locals => {:level => level + 1, :params => param[:params]}) unless param[:params].blank? %>
+<% end %>

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

@@ -0,0 +1,19 @@
+<ul>
+  <% params.each do |param| %>
+    <% if !param[:show] %>
+      <%= render(:partial => 'params_plain', :locals => {:params => param[:params]}) unless param[:params].blank? %>
+      <% next %>
+    <% end %>
+    <li>
+      <strong><%= param[:name] %> </strong>:
+      <small>
+        <%= t("apipie.#{param[:type]}") %>
+        <% if param[:validator] %>
+          [ <%= ApipieDSL.markup_to_html(param[:validator]).html_safe %> ]
+        <% end %>
+      </small>
+      <%= param[:description].html_safe %>
+    </li>
+    <%= render(:partial => 'params_plain', :locals => {:params => param[:params]}) unless param[:params].blank? %>
+  <% end %>
+</ul>

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

@@ -0,0 +1,24 @@
+<div class='accordion' id='prop-accordion'>
+    <% if prop[:show] %>
+    <tr>
+      <td>
+        <div>
+          <h2>
+            <a id='link-description-<%= escaped_method_name(prop[:name], '_') %>' href='#description-<%= escaped_method_name(prop[:name], '_') %>'
+             class='accordion-toggle'
+             data-toggle='collapse'
+             data-parent='#prop-accordion'>
+              <%= prop[:name] %>
+            </a>
+            <br>
+            <small><%= raw prop[:short_description] %></small>
+          </h2>
+        </div>
+
+        <div id='description-<%= escaped_method_name(prop[:name], '_') %>' class='collapse accordion-body'>
+          <%= render partial: 'property_detail', locals: { property: prop, h_level: 3 } %>
+        </div>
+      </td>
+    </tr>
+  <% end %>
+</div>

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

@@ -0,0 +1,35 @@
+<% unless property[:metadata].blank? %>
+  <%= heading(t('apipie_dsl.metadata'), h_level) %>
+  <%= render(partial: 'metadata', locals: { meta: property[:metadata] }) %>
+<% end %>
+
+<% unless property[:params].blank? %>
+  <%= heading(t('apipie_dsl.params'), h_level) %>
+  <table class='table'>
+    <thead>
+      <tr>
+        <th><%= t('apipie_dsl.param_name') %></th>
+        <th><%= t('apipie_dsl.description') %></th>
+      </tr>
+    </thead>
+    <tbody>
+      <%= render(partial: 'params', locals: { params: property[:params] }) %>
+    </tbody>
+  </table>
+<% end %>
+
+<%= heading(t('apipie_dsl.returns'), h_level) %>
+<% if property[:returns][:description] %>
+  <p><%= property[:returns][:description] %></p>
+<% end %>
+<table class='table'>
+  <thead>
+    <tr>
+      <th><%= t("apipie_dsl.#{property[:returns][:object][:class]}") %></th>
+      <th><%= t("apipie_dsl.details") %></th>
+    </tr>
+  </thead>
+  <tbody>
+    <%= render(partial: 'returns', locals: { return_object: property[:returns][:object]}) %>
+  </tbody>
+</table>

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

@@ -0,0 +1,23 @@
+<% show_metadata = raises.reject { |ex| ex[:metadata].blank? }.size > 0 %>
+
+<table class="table table-bordered">
+	<thead>
+		<tr>
+			<th><%= t('apipie_dsl.exeption', default: 'Exception') %></th>
+			<th><%= t('apipie_dsl.exeption_description', default: [:description, 'Description']) %></th>
+			<% if show_metadata %><th><%= t('apipie_dsl.exeption_metadata', default: [:metadata, 'Metadata']) %></th><% end %>
+		</tr>
+	</thead>
+
+	<tbody>
+		<% raises.each do |ex| %>
+			<tr>
+				<td><span class="label"> <%= ex[:error] %> </span></td>
+				<td><%= ex[:description].html_safe %></td>
+				<% if show_metadata %>
+				<td><%= render(partial: 'metadata', locals: { meta: ex[:metadata] }) unless ex[:metadata].blank? %></td>
+				<% end %>
+			</tr>
+		<% end %>
+	</tbody>
+</table>

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

@@ -0,0 +1,53 @@
+<% level ||= 0 %>
+<% col = 255 - level * 5 %>
+<% if return_object[:class] == Hash && return_object[:data] && return_object[:data].is_a?(Enumerable) %>
+  <% return_object[:data].each do |param| %>
+    <% if !param[:show] %>
+      <%= render(:partial => 'params', :locals => {:level => level, :params => param[:params]}) unless param[:params].blank? %>
+      <% next %>
+    <% end %>
+    <tr style='background-color:rgb(<%= "#{col},#{col},#{col}" %>);'>
+      <td>
+        <strong><%= param[:full_name] %> </strong><br>
+        <small>
+          <%=  t("apipie_dsl.#{param[:type]}") %>
+        </small>
+      </td>
+      <td>
+        <%= param[:description].html_safe %>
+        <%- if param[:validations].present? || param[:validator].present? %>
+          <p><strong>Validations:</strong></p>
+          <ul>
+            <%- if param[:validator].present? %>
+              <li><%= ApipieDSL.markup_to_html(param[:validator]).html_safe %></li>
+            <%- end %>
+            <%- if param[:validations].present? %>
+              <%- param[:validations].each do |item| %>
+                <li><%= item.html_safe %></li>
+              <%- end %>
+            <%- end %>
+          </ul>
+        <%- end %>
+
+        <% unless param[:metadata].blank? %>
+          <br>
+          Metadata:
+          <%= render(:partial => 'metadata', :locals => {:meta => param[:metadata]}) %>
+        <% end %>
+      </td>
+
+    </tr>
+
+    <%= render(:partial => 'params', :locals => {:level => level + 1, :params => param[:params]}) unless param[:params].blank? %>
+  <% end %>
+<% else %>
+  <tr style='background-color:rgb(<%= "#{col},#{col},#{col}" %>);'>
+    <td>
+      <strong><%= return_object[:meta] %> </strong><br>
+    </td>
+    <td>
+      <% obj = return_object[:data].blank? ? return_object[:class] : return_object[:data] %>
+      <%= raw(class_references(obj, current_version(@doc[:classes]), @doc[:link_extension])).gsub('"', '').html_safe %>
+    </td>
+  </tr>
+<% end %>

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

@@ -0,0 +1,17 @@
+<h1 class='page-header'>
+  <%= t('apipie_dsl.oops') %>
+  <small>
+  <% if params[:method].blank? %>
+    <%= t('apipie_dsl.class_not_found_html', klass: "<code>#{h(params[:class])}</code>".html_safe) %>
+  <% else %>
+    <%= t('apipie_dsl.method_not_found_html', klass: "<code>#{h(params[:class])}</code>".html_safe,
+        :method => "<code>#{h(params[:method])}</code>".html_safe) %>
+  <% end %>
+  </small>
+</h1>
+
+<% if @doc %>
+  <%= t('apipie_dsl.goto_homepage_html', :href => link_to(
+    t('apipie_dsl.goto_homepage_href', :app_name => @doc[:name]),
+    File.join(@doc[:doc_url], @doc[:link_extension]))) %>
+<% end %>

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

@@ -0,0 +1,75 @@
+<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>
+<ul class='breadcrumb'>
+  <li>
+    <a href='<%= @doc[:doc_url] %><%= section_ext(@section) %><%= @doc[:link_extension] %>'><%= @doc[:name] %> <%= @klass[:version] %></a>
+    <span class='divider'>/</span>
+  </li>
+  <li class='active'>
+    <%= @klass[:name] %>
+  </li>
+  <%= render(:partial => 'languages', :locals => {:doc_url => @klass[:doc_url]}) %>
+</ul>
+
+<div class='page-header'>
+  <h1>
+    <%= @klass[:name] %>
+    <% if @klass[:deprecated] %>
+        <code>DEPRECATED</code>
+    <% end %>
+    <br>
+    <small><%= raw @klass[:short_description] %></small>
+  </h1>
+</div>
+
+<% unless @klass[:full_description].blank? %>
+  <div><%= raw @klass[:full_description] %></div>
+<% end %>
+
+<% unless @klass[:metadata].blank? %>
+  <h2>Metadata</h2>
+  <%= render(:partial => 'metadata', :locals => {:meta => @klass[:metadata]}) %>
+<% end %>
+
+<% unless @klass[:properties].empty? %>
+  <table class='table'>
+    <thead>
+      <tr>
+        <th><%= t('apipie_dsl.property') %></th>
+      </tr>
+    </thead>
+    <tbody>
+      <%= render partial: 'property', collection: @klass[:properties], as: :prop %>
+    </tbody>
+  </table>
+<% end %>
+
+<% unless @klass[:methods].empty? %>
+  <table class='table'>
+    <thead>
+      <tr>
+        <th><%= t('apipie_dsl.method') %></th>
+      </tr>
+    </thead>
+    <tbody>
+      <%= render partial: 'method', collection: @klass[:methods], as: :meth, locals: { link_extension: @doc[:link_extension] } %>
+    </tbody>
+  </table>
+<% end %>
+
+<% unless content_for(:apipie_dsl_footer) == @doc[:copyright] %>
+  <%= content_for :apipie_dsl_footer, raw(@doc[:copyright]) %>
+<% end %>