apipie-dsl 2.0.0

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

@@ -0,0 +1,10 @@
+<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>
+<%= render_help %>

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

@@ -0,0 +1,4 @@
+<h1 class='page-header'><%= t('apipie_dsl.no_doc_found') %></h1>
+<p><%= t('apipie_dsl.no_docs_found_descr') %></p>
+<p><%= t('apipie_dsl.follow_instructions_html', href: link_to(t('apipie_dsl.follow_instructions_href'),
+        'https://github.com/ofedoren/apipie-dsl#getting-started', :target => '_blank')) %></p>

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

@@ -0,0 +1,72 @@
+<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 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]}) %>
+  <% if @versions && @versions.size > 1 %>
+  <li class='pull-right'>
+    <%= @versions.collect { |v| link_to v, ApipieDSL.full_url(v+@doc[:link_extension]) }.join(' / ').html_safe %>
+  </li>
+  <% end %>
+</ul>
+
+<div><%= raw @doc[:info] %></div>
+
+<h1 class='page-header'><%= t('apipie_dsl.classes') %></h1>
+
+<% @doc[:classes].each_value do |klass| %>
+  <% next unless klass[:show] && in_section?(@section, klass[:id]) %>
+  <h2>
+    <a href='<%= klass[:doc_url] %><%= @doc[:link_extension] %>'>
+      <%= klass[:name] %>
+    </a>
+    <% if klass[:deprecated] %>
+        <code>DEPRECATED</code>
+    <% end %>
+    <br>
+    <small><%= klass[:short_description] %></small>
+  </h2>
+  <% unless klass[:properties].empty? %>
+    <table class='table'>
+      <thead>
+        <tr>
+          <th><%= t('apipie_dsl.property') %></th>
+          <th><%= t('apipie_dsl.description') %></th>
+        </tr>
+      </thead>
+      <tbody>
+        <%= render partial: 'index_class_prop', collection: klass[:properties], as: :prop, locals: { link_extension: @doc[:link_extension], doc_url: klass[:doc_url] } %>
+      </tbody>
+    </table>
+  <% end %>
+  <% unless klass[:methods].empty? %>
+    <table class='table'>
+      <thead>
+        <tr>
+          <th><%= t('apipie_dsl.method') %></th>
+          <th><%= t('apipie_dsl.description') %></th>
+        </tr>
+      </thead>
+      <tbody>
+        <%= render partial: 'index_class_meth', collection: klass[:methods], as: :meth, locals: { link_extension: @doc[:link_extension] } %>
+      </tbody>
+    </table>
+  <% end %>
+<% end %>
+
+<% unless content_for(:apipie_dsl_footer) == @doc[:copyright] %>
+  <%= content_for :apipie_dsl_footer, raw(@doc[:copyright]) %>
+<% end %>

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

@@ -0,0 +1,52 @@
+<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>
+    <a href='<%= @klass[:doc_url] %><%= @doc[:link_extension] %>'>
+      <%= @klass[:name] %>
+    </a>
+    <span class='divider'>/</span>
+  </li>
+  <li class='active'><%= @method[:name] %></li>
+  <%= render(:partial => 'languages', :locals => {:doc_url => @method[:doc_url]}) %>
+</ul>
+
+<div class='page-header'>
+  <h1>
+    <%= method_signature(@method) %>
+    <% if @method[:deprecated] %>
+      <code>DEPRECATED</code>
+    <% end %>
+    <br>
+    <small><%= raw @method[:short_description] %></small>
+  </h1>
+</div>
+
+<div>
+  <% unless @method[:see].empty? %>
+    Also see <%= @method[:see].map { |s| link_to(s[:description] || s[:link], "#{s[:url]}#{@doc[:link_extension]}") }.to_sentence.html_safe %>.
+  <% end %>
+
+  <%= render(:partial => 'method_detail', :locals => {:method => @method, :h_level => 2}) %>
+</div>
+
+<% unless content_for(:apipie_dsl_footer) == @doc[:copyright] %>
+  <%= content_for :apipie_dsl_footer, raw(@doc[:copyright]) %>
+<% end %>

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

@@ -0,0 +1,116 @@
+<% @doc[:classes].sort_by(&:first).each do |key, klass| %>
+  <% next unless klass[:show] %>
+  <h4><a href='#<%= key %>'><%= klass[:name] %></a></h4>
+  <ul>
+    <% klass[:properties].each do |prop| %>
+      <% next unless prop[:show] %>
+      <li><a href='#<%= key %>-<%= prop[:name] %>'><%= prop[:name] %></a></li>
+    <% end %>
+
+    <% klass[:methods].each do |method| %>
+      <% next unless method[:show] %>
+      <li><a href='#<%= key %>-<%= method[:name] %>'><%= method[:name] %></a></li>
+    <% end %>
+  </ul>
+<% end %>
+
+<% @doc[:classes].sort_by(&:first).each do |key, klass| %>
+  <% next unless klass[:show] %>
+  <hr/>
+  <div>
+    <h2 id="<%= key %>">
+      <a href='#<%= key %>'><%= klass[:name] %></a><br>
+      <small><%= raw klass[:short_description] %></small>
+    </h2>
+  </div>
+
+  <% unless klass[:full_description].blank? %>
+    <div><%= raw klass[:full_description] %></div>
+  <% end %>
+
+  <div>
+    <% klass[:properties].each do |prop| %>
+      <% next unless prop[:show] %>
+      <hr/>
+
+      <h3 id="<%= "#{key}-#{prop[:name]}" %>">
+      <a href='#<%= key %>'><%= klass[:name] %></a> / <a href='#<%= "#{key}-#{prop[:name]}" %>'><%= prop[:name] %></a>
+      </h3>
+
+      <div>
+        <%= raw prop[:short_description] %>
+        <% unless prop[:examples].blank? %>
+          <h4><%= t('apipie_dsl.examples') %></h4>
+          <% prop[:examples].each do |example| %>
+            <pre class="wiki"><%= example %></pre>
+          <% end %>
+        <% end %>
+
+        <% unless prop[:returns].blank? %>
+          <h2><%= t('apipie_dsl.returns') %></h2>
+          <% if prop[:returns][:description] %>
+            <p><%= prop[:returns][:description] %></p>
+          <% end %>
+          <table class='table'>
+            <thead>
+              <tr>
+                <th><%= t("apipie_dsl.#{prop[:returns][:object][:class]}") %></th>
+                <th><%= t('apipie_dsl.details') %></th>
+              </tr>
+            </thead>
+            <tbody>
+              <%= render(partial: 'returns', locals: { return_object: prop[:returns][:object] }) %>
+            </tbody>
+          </table>
+        <% end %>
+      </div>
+    <% end %>
+
+    <% klass[:methods].each do |method| %>
+      <% next unless method[:show] %>
+      <hr/>
+
+      <h3 id="<%= "#{key}-#{method[:name]}" %>">
+      <a href='#<%= key %>'><%= klass[:name] %></a> / <a href='#<%= "#{key}-#{method[:name]}" %>'><%= method[:name] %></a>
+      </h3>
+
+      <div>
+        <%= raw method[:full_description] %>
+        <% unless method[:examples].blank? %>
+          <h4><%= t('apipie_dsl.examples') %></h4>
+          <% method[:examples].each do |example| %>
+            <pre class="wiki"><%= example %></pre>
+          <% end %>
+        <% end %>
+
+        <% unless method[:raises].blank? %>
+          <h2><%= t('apipie_dsl.raises') %></h2>
+          <%= render(partial: 'raises', locals: { raises: method[:raises] }) %>
+        <% end %>
+
+        <% unless method[:params].blank? %>
+          <h4><%= t('apipie_dsl.params') %></h4>
+          <%= render(:partial => 'params_plain', :locals => {:params => method[:params]}) %>
+        <% end %>
+
+        <% unless method[:returns].blank? %>
+          <h2><%= t('apipie_dsl.returns') %></h2>
+          <% 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 %>
+      </div>
+    <% end %>
+  </div>
+<% end %>

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

@@ -0,0 +1,158 @@
+<% @doc[:classes].sort_by(&:first).each do |key, klass| %>
+  <% next unless klass[:show] %>
+  <h4><a href='#<%= key %>'><%= klass[:name] %></a></h4>
+  <ul>
+    <% klass[:properties].each do |prop| %>
+      <% next unless prop[:show] %>
+      <li><a href='#<%= key %>-<%= prop[:name] %>'><%= prop[:name] %></a></li>
+    <% end %>
+
+    <% klass[:methods].each do |method| %>
+      <% next unless method[:show] %>
+      <li><a href='#<%= key %>-<%= method[:name] %>'><%= method[:name] %></a></li>
+    <% end %>
+  </ul>
+<% end %>
+
+<div><%= @doc[:info].html_safe %></div>
+
+<hr>
+
+<% @doc[:classes].sort_by(&:first).each do |key, klass| %>
+  <% next unless klass[:show] %>
+  <ul class='breadcrumb'  id='<%= key %>'>
+    <li><a href='#'><%= @doc[:name] %></a><span class='divider'>/</span></li>
+    <li class='active'><%= klass[:name] %></li>
+  </ul>
+
+  <div class='page-header'>
+    <h1>
+      <a href='#<%= key %>'><%= klass[:name] %></a><br>
+      <small><%= raw klass[:short_description] %></small>
+    </h1>
+  </div>
+
+  <% unless klass[:full_description].blank? %>
+    <div><%= raw klass[:full_description] %></div>
+  <% end %>
+
+  <div class='accordion' id='prop-accordion'>
+
+    <% klass[:properties].each do |prop| %>
+      <% next unless prop[:show] %>
+      <hr>
+
+      <ul class='breadcrumb' id='<%= key %>-<%= prop[:name] %>'>
+        <li>
+          <a href='#'><%= @doc[:name] %></a>
+          <span class='divider'>/</span>
+        </li>
+        <li>
+          <a href='#<%= key %>'><%= klass[:name] %></a>
+          <span class='divider'>/</span>
+        </li>
+        <li class='active'><%= prop[:name] %></li>
+      </ul>
+
+      <div>
+        <%= raw prop[:short_description] %>
+        <% unless prop[:examples].blank? %>
+          <h2><%= t('apipie_dsl.examples') %></h2>
+          <% prop[:examples].each do |example| %>
+            <pre><%= example %></pre>
+          <% end %>
+        <% end %>
+
+        <% unless prop[:returns].blank? %>
+          <h2><%= t('apipie_dsl.returns') %></h2>
+          <% if prop[:returns][:description] %>
+            <p><%= prop[:returns][:description] %></p>
+          <% end %>
+          <table class='table'>
+            <thead>
+              <tr>
+                <th><%= t("apipie_dsl.#{prop[:returns][:object][:class]}") %></th>
+                <th><%= t("apipie_dsl.details") %></th>
+              </tr>
+            </thead>
+            <tbody>
+              <%= render(partial: 'returns', locals: { return_object: prop[:returns][:object] }) %>
+            </tbody>
+          </table>
+        <% end %>
+      </div>
+    <% end %>
+  </div>
+
+  <div class='accordion' id='meth-accordion'>
+
+    <% klass[:methods].each do |method| %>
+      <% next unless method[:show] %>
+      <hr>
+
+      <ul class='breadcrumb' id='<%= key %>-<%= method[:name] %>'>
+        <li>
+          <a href='#'><%= @doc[:name] %></a>
+          <span class='divider'>/</span>
+        </li>
+        <li>
+          <a href='#<%= key %>'><%= klass[:name] %></a>
+          <span class='divider'>/</span>
+        </li>
+        <li class='active'><%= method[:name] %></li>
+      </ul>
+
+      <div>
+        <%= raw method[:full_description] %>
+        <% unless method[:examples].blank? %>
+          <h2><%= t('apipie_dsl.examples') %></h2>
+          <% method[:examples].each do |example| %>
+            <pre><%= example %></pre>
+          <% end %>
+        <% end %>
+
+        <% unless method[:raises].blank? %>
+          <h2><%= t('apipie_dsl.raises') %></h2>
+          <%= render(:partial => 'raises', :locals => {:raises => method[:raises]}) %>
+        <% end %>
+
+        <% unless method[:params].blank? %>
+          <h2><%= t('apipie_dsl.params') %></h2>
+          <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? %>
+          <h2><%= t('apipie_dsl.returns') %></h2>
+          <% 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 %>
+      </div>
+    <% end %>
+  </div>
+<% end %>
+
+<% unless content_for(:apipie_dsl_footer) == @doc[:copyright] %>
+  <%= content_for :apipie_dsl_footer, raw(@doc[:copyright]) %>
+<% end %>

data/app/views/layouts/apipie_dsl/apipie_dsl.html.erb

@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title><%= t('apipie_dsl.dsl_documentation', :default => 'DSL Documentation') %></title>
+  <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  <%= ApipieDSL.include_stylesheets %>
+  <link type='text/css' rel='stylesheet' href='<%= ApipieDSL.full_url("stylesheets/application.css")%>'/>
+  <!-- IE6-8 support of HTML5 elements -->
+  <!--[if lt IE 9]>
+    <script src="//html5shim.googlecode.com/svn/trunk/html5.js"></script>
+  <![endif]-->
+</head>
+<body>
+  <div class="container-fluid">
+    <div class="row-fluid">
+      <div id='container'>
+        <%= yield %>
+      </div>
+    </div>
+    <hr>
+    <footer><%= yield :apipie_dsl_footer %></footer>
+  </div>
+  <%= ApipieDSL.include_javascripts %>
+</body>
+</html>

data/lib/apipie-dsl.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'apipie_dsl'