yard-api 0.2.2 → 0.2.3

data/templates/api/method_details/html/setup.rb

@@ -4,12 +4,16 @@ RouteHelper = YARD::Templates::Helpers::RouteHelper
 
 def init
   sections :header, [:method_signature, T('docstring')]
+  
+
+  super
 end
 
 def header
   routes = get_current_routes
+  route = options[:current_route] = routes.first
 
-  unless route = routes.first
+  unless route
     ::YARD::APIPlugin.log(
       "[error] Unable to find route for object: #{object}",
       ::Logger::ERROR
@@ -39,20 +43,11 @@ def header
   end
 
   @props[:routes] = routes.map do |route|
-    {}.tap do |spec|
-      spec[:path] = route.path.spec.to_s.gsub("(.:format)", "")
-      spec[:verb] = route.verb.source =~ /\^?(\w*)\$/ ? $1.upcase : route.verb.source
-    end
+    {
+      path: RouteHelper.get_route_path(route),
+      verb: RouteHelper.get_route_verb(route)
+    }
   end
 
   erb(:header)
-end
-
-def get_current_routes
-  controller_name = object.parent.path.underscore
-  controller_name.sub!("_controller", '') unless controller_name.include?('/')
-
-  action = object.path.sub(/^.*#/, '').sub(/_with_.*$/, '')
-
-  RouteHelper.api_methods_for_controller_and_action(controller_name, action)
-end
+end

data/templates/api/tags/html/_example_code_block.erb

@@ -1,8 +1,51 @@
 <% tag = options[:tag] %>
+<% multi_dialect = options[:multi_dialect] %>
 <% title = tag.name %>
+<%
+	json_blob = begin
+		JSON.parse(tag.text).to_json
+	rescue JSON::ParserError => e
+		puts '*' * 80
+		puts "  Invalid JSON payload in endpoint: #{object.path.to_s}"
+		puts "  Please make sure it is valid JSON."
+		puts '*' * 80
+		
+		if api_options.strict then
+			raise e
+		else
+			return
+		end
+	end
+%>
 
 <% if title && !title.empty? %>
   <header class="example-title"><%= title.strip %></header>
 <% end %>
 
-<pre class="example code js"><%= html_syntax_highlight(tag.text, :plain) %></pre>
+<div class="example-codeblocks">
+	<% if multi_dialect %>
+		<div class="example-codeblocks__tabs">
+			<a class="example-codeblocks__tab">JSON</a>
+			<a class="example-codeblocks__tab">cURL</a>
+		</div>
+	<% end %>
+
+	<pre class="example-codeblocks__example example code js"><%= html_syntax_highlight(tag.text, :plain) %></pre>
+	<% if multi_dialect %>
+		<pre class="example-codeblocks__example example code shell">
+curl \
+  -X <%= YARD::Templates::Helpers::RouteHelper.get_route_verb(options[:current_route]) %> \
+  -H "Authorization: Bearer $TOKEN" \
+  -H 'Content-Type: application/json' \
+  -H 'Accept: application/json' \
+  -d '<%= JSON.parse(tag.text).to_json %>' \
+  <%=
+  	[
+			"http://&lt;#{api_options.url_title}&gt;",
+			api_options.url_prefix,
+			YARD::Templates::Helpers::RouteHelper.get_route_path(options[:current_route])
+		].compact.reject(&:empty?).join('')
+  %>
+		</pre>
+	<% end %>
+</div>

data/templates/api/tags/html/argument/_list.erb

@@ -1,21 +1,26 @@
-<ul class="argument">
+<ul class="argument-listing">
   <% @argument_tags.each do |tag| %>
-    <li>
-      <code class="argument-name"><%= h tag.unscoped_name %></code>
-      <span class="argument-type"><%= tag.type %></span>
-      <% if (tag.accepted_values || []).any? %>
-        <span class="argument-values fade">
-          <em>[ <%= tag.accepted_values.join(', ') %> ]</em>
-        </span>
-      <% end %>
+    <li class="argument-listing__argument">
+      <div class="argument-listing__argument-details">
+        <code class="argument-listing__argument-name"><%= h tag.name %></code>
+        <span class="argument-listing__argument-type"><%= tag.type %></span>
 
-      <% if tag.is_required %>
-        <em class="argument-required">Required</em>
-      <% end %>
+        <% if (tag.accepted_values || []).any? %>
+          <span class="argument-listing__argument-values">
+            <span>[ <%= tag.accepted_values.join(', ') %> ]</span>
+          </span>
+        <% end %>
 
-      <% if !tag.text.empty? %>
-        <%= html_markup_markdown(tag.text) %>
-      <% end %>
+        <% if tag.is_required %>
+          <span class="argument-listing__argument-required">Required</span>
+        <% end %>
+      </div>
+
+      <div class="argument-listing__argument-text">
+        <% if !tag.text.empty? %>
+          <%= html_markup_markdown(tag.text) %>
+        <% end %>
+      </div>
     </li>
   <% end %>
 </ul>

data/templates/api/tags/html/argument/_table.erb

@@ -14,7 +14,7 @@
   <tbody>
     <% @argument_tags.each do |tag| %>
       <tr>
-        <td><code class="argument-name"><%= h tag.unscoped_name %></code></td>
+        <td><code class="argument-name"><%= h tag.name %></code></td>
         <td><span class="argument-type"><%= tag.type %></span></td>
         
         <% if has_accepted_values %>

data/templates/api/tags/html/argument.erb

@@ -1,5 +1,5 @@
-<section class="endpoint-arguments">
-  <h4>Parameters:</h4>
+<section>
+  <h4 class="arguments-header">Parameters</h4>
 
   <% if api_options.tabular_arguments %>
     <%= erb :"argument/_table" %>

data/templates/api/tags/html/example_request.erb

@@ -1,13 +1,13 @@
 <% if object.has_tag?(:example_request) %>
   <div class="examples">
     <% if object.tags(:example_request).length > 1 %>
-      <h4>Example Requests:</h4>
+      <h4>Example Requests</h4>
     <% else %>
-      <h4>Example Request:</h4>
+      <h4>Example Request</h4>
     <% end %>
 
     <% object.tags(:example_request).each do |tag| %>
-      <%= tag_partial '_example_code_block', tag %>
+      <%= tag_partial '_example_code_block', tag, { multi_dialect: true } %>
     <% end %>
   </div>
 <% end %>

data/templates/api/tags/html/example_response.erb

@@ -2,9 +2,9 @@
   <% tags = object.tags(:example_response) %>
   <div class="examples example_response">
     <% if tags.length > 1 %>
-      <h4>Example Responses:</h4>
+      <h4>Example Responses</h4>
     <% else %>
-      <h4>Example Response:</h4>
+      <h4>Example Response</h4>
     <% end %>
 
     <% tags.each do |tag| %>

data/templates/api/topic/html/method_details_list.erb

@@ -1,5 +1,5 @@
-<div id="Services" class="method_details_list">
-<% @meths.each_with_index do |meth, i| %>
-  <%= yieldall :object => meth, :index => i %>
-<% end %>
+<div>
+	<% @meths.each_with_index do |meth, i| %>
+	  <%= yieldall :object => meth, :index => i %>
+	<% end %>
 </div>

data/templates/api/topic/html/topic_doc.erb

@@ -11,17 +11,17 @@
 <% end %>
 
 <section>
-  <header><strong>Interfaces</strong></header>
-  <ul id="quicklinks">
-  </ul>
+  <h2>Interfaces</h2>
+
+  <ul id="quicklinks"></ul>
 </section>
 
 <% @json_objects.each do |name, json| %>
   <% properties = render_properties(json) %>
   <div class='object_definition'>
     <h3>
-      <a name="<%= name %>"></a><%= name %> object synposis:
+      <a name="<%= name %>"></a><%= name %> object synopsis:
     </h3>
     <pre class="example code"><%= html_syntax_highlight(properties ? properties : json, :plain) %></pre>
   </div>
-<% end %>
+<% end %>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yard-api
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Ahmad Amireh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-21 00:00:00.000000000 Z
+date: 2015-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
@@ -96,10 +96,9 @@ files:
 - templates/api/appendix/json/setup.rb
 - templates/api/docstring/html/setup.rb
 - templates/api/docstring/html/text.erb
-- templates/api/docstring/json/setup.rb
 - templates/api/fulldoc/html/css/common.css
 - templates/api/fulldoc/html/css/highlight.css
-- templates/api/fulldoc/html/js/highlight.zip
+- templates/api/fulldoc/html/js/app.js
 - templates/api/fulldoc/html/js/highlight/CHANGES.md
 - templates/api/fulldoc/html/js/highlight/LICENSE
 - templates/api/fulldoc/html/js/highlight/README.md
@@ -164,7 +163,6 @@ files:
 - templates/api/layout/html/footer.erb
 - templates/api/layout/html/headers.erb
 - templates/api/layout/html/layout.erb
-- templates/api/layout/html/scripts.erb
 - templates/api/layout/html/setup.rb
 - templates/api/layout/html/sidebar.erb
 - templates/api/layout/json/layout.erb
@@ -195,7 +193,6 @@ files:
 - templates/api/topic/html/method_details_list.erb
 - templates/api/topic/html/setup.rb
 - templates/api/topic/html/topic_doc.erb
-- templates/api/topic/json/setup.rb
 - yard-api.gemspec
 homepage: https://github.com/amireh/yard-api
 licenses:

data/templates/api/docstring/json/setup.rb

@@ -1,4 +0,0 @@
-def init
-  puts "> HI from docstring!"
-  # sections :text, T('tags')
-end

data/templates/api/topic/json/setup.rb

@@ -1,25 +0,0 @@
-def init
-  # sections :header, [:topic_doc, :method_details_list, [T('method_details')]]
-  sections :method_details_list, [T('method_details')]
-  @resource = object
-  # @beta = options[:controllers].any? { |c| c.tag('beta') }
-  puts "Topic: HEE? #{@resource}"
-end
-
-def method_details_list
-  @meths = options[:controllers].map { |c| c.meths(:inherited => false, :included => false) }.flatten
-  @meths = run_verifier(@meths)
-
-  # puts "Methods: #{@meths}"
-
-  buffer = [];
-
-  @meths.each_with_index do |meth, i|
-    # puts "#{i} => #{meth.tags}"
-    buffer.push(yieldall :object => meth, :index => i)
-  end
-
-  puts "Buffer: #{buffer.to_json}"
-
-  buffer.to_json
-end