yard-api 0.2.2 → 0.2.3

data/templates/api/fulldoc/html/css/highlight.css

@@ -1,70 +1,153 @@
 /*
-  Five-color theme from a single blue hue.
+
+Original style from softwaremaniacs.org (c) Ivan Sagalaev <Maniac@SoftwareManiacs.Org>
+
 */
+
 .hljs {
   display: block;
   overflow-x: auto;
   padding: 0.5em;
-  background: #eaeef3;
+  background: #f0f0f0;
   -webkit-text-size-adjust: none;
 }
 
 .hljs,
-.hljs-list .hljs-built_in {
-  color: #00193a;
+.hljs-subst,
+.hljs-tag .hljs-title,
+.nginx .hljs-title {
+  color: black;
 }
 
-.hljs-keyword,
+.hljs-string,
 .hljs-title,
-.hljs-important,
-.hljs-request,
-.hljs-header,
-.hljs-javadoctag {
-  font-weight: bold;
+.hljs-constant,
+.hljs-parent,
+.hljs-tag .hljs-value,
+.hljs-rules .hljs-value,
+.hljs-preprocessor,
+.hljs-pragma,
+.haml .hljs-symbol,
+.ruby .hljs-symbol,
+.ruby .hljs-symbol .hljs-string,
+.hljs-template_tag,
+.django .hljs-variable,
+.smalltalk .hljs-class,
+.hljs-addition,
+.hljs-flow,
+.hljs-stream,
+.bash .hljs-variable,
+.apache .hljs-tag,
+.apache .hljs-cbracket,
+.tex .hljs-command,
+.tex .hljs-special,
+.erlang_repl .hljs-function_or_atom,
+.asciidoc .hljs-header,
+.markdown .hljs-header,
+.coffeescript .hljs-attribute {
+  color: #800;
 }
 
+.smartquote,
 .hljs-comment,
+.hljs-annotation,
+.hljs-template_comment,
+.diff .hljs-header,
 .hljs-chunk,
-.hljs-template_comment {
-  color: #738191;
+.asciidoc .hljs-blockquote,
+.markdown .hljs-blockquote {
+  color: #888;
 }
 
-.hljs-string,
-.hljs-title,
-.hljs-parent,
-.hljs-built_in,
+.hljs-number,
+.hljs-date,
+.hljs-regexp,
 .hljs-literal,
-.hljs-filename,
-.hljs-value,
-.hljs-addition,
-.hljs-tag,
-.hljs-argument,
-.hljs-link_label,
-.hljs-blockquote,
-.hljs-header {
-  color: #0048ab;
+.hljs-hexcolor,
+.smalltalk .hljs-symbol,
+.smalltalk .hljs-char,
+.go .hljs-constant,
+.hljs-change,
+.lasso .hljs-variable,
+.makefile .hljs-variable,
+.asciidoc .hljs-bullet,
+.markdown .hljs-bullet,
+.asciidoc .hljs-link_url,
+.markdown .hljs-link_url {
+  color: #080;
 }
 
+.hljs-label,
+.hljs-javadoc,
+.ruby .hljs-string,
 .hljs-decorator,
-.hljs-prompt,
-.hljs-yardoctag,
-.hljs-subst,
-.hljs-symbol,
-.hljs-doctype,
-.hljs-regexp,
-.hljs-preprocessor,
-.hljs-pragma,
-.hljs-pi,
-.hljs-attribute,
+.hljs-filter .hljs-argument,
+.hljs-localvars,
+.hljs-array,
 .hljs-attr_selector,
-.hljs-javadoc,
-.hljs-xmlDocTag,
+.hljs-important,
+.hljs-pseudo,
+.hljs-pi,
+.haml .hljs-bullet,
+.hljs-doctype,
 .hljs-deletion,
+.hljs-envvar,
 .hljs-shebang,
-.hljs-string .hljs-variable,
-.hljs-link_url,
-.hljs-bullet,
-.hljs-sqbracket,
+.apache .hljs-sqbracket,
+.nginx .hljs-built_in,
+.tex .hljs-formula,
+.erlang_repl .hljs-reserved,
+.hljs-prompt,
+.asciidoc .hljs-link_label,
+.markdown .hljs-link_label,
+.vhdl .hljs-attribute,
+.clojure .hljs-attribute,
+.asciidoc .hljs-attribute,
+.lasso .hljs-attribute,
+.coffeescript .hljs-property,
 .hljs-phony {
-  color: #4c81c9;
+  color: #88f;
+}
+
+.hljs-keyword,
+.hljs-id,
+.hljs-title,
+.hljs-built_in,
+.css .hljs-tag,
+.hljs-javadoctag,
+.hljs-phpdoc,
+.hljs-dartdoc,
+.hljs-yardoctag,
+.smalltalk .hljs-class,
+.hljs-winutils,
+.bash .hljs-variable,
+.apache .hljs-tag,
+.hljs-type,
+.hljs-typename,
+.tex .hljs-command,
+.asciidoc .hljs-strong,
+.markdown .hljs-strong,
+.hljs-request,
+.hljs-status {
+  font-weight: bold;
+}
+
+.asciidoc .hljs-emphasis,
+.markdown .hljs-emphasis {
+  font-style: italic;
+}
+
+.nginx .hljs-built_in {
+  font-weight: normal;
+}
+
+.coffeescript .javascript,
+.javascript .xml,
+.lasso .markup,
+.tex .hljs-formula,
+.xml .javascript,
+.xml .vbscript,
+.xml .css,
+.xml .hljs-cdata {
+  opacity: 0.5;
 }

data/templates/api/{layout/html/scripts.erb → fulldoc/html/js/app.js}

@@ -1,5 +1,5 @@
-<script type="text/javascript">
-  $('h2.api_method_name').each(function(i, el) {
+$(function() {
+  $('.method-details__name').each(function(i, el) {
     var subtopic = $(el).data('subtopic');
     var $a = $(el).find('a');
     var anchorText = $.trim($a[0].innerHTML);
@@ -16,23 +16,6 @@
     $('<li>').append($link).appendTo($row);
   });
 
-  // Highlight the current page in the sidebar
-  $(function() {
-    var currentPage = location.pathname.match(/\/([^\/]+)$/)[1];
-    var $page = $('#sidebar [href="' + currentPage + '"]');
-
-    if (!currentPage) {
-      return;
-    }
-
-    // if ($page.length === 0) {
-    //   $page = $('#sidebar a[href=""]');
-    // }
-
-    // $page.addClass('active');
-    console.log('Highlighting current page:', $page, currentPage);
-  });
-
   $('#content pre').each(function(i, block) {
     var code;
     var $block = $(block);
@@ -49,4 +32,25 @@
 
     hljs.highlightBlock(block);
   });
-</script>
+
+  // Make it so that clicking one of these "tabs" for every @example_request
+  // dialect switch to that dialect's example. For example: switching between
+  // the generated JSON and cURL examples when those anchors are clicked.
+  $('.example-codeblocks__tabs').each(function() {
+    var $examples = $(this).siblings('.example-codeblocks__example');
+
+    $(this).find('a').each(function(index) {
+      var $example = $examples.eq(index);
+
+      $(this).on('click', function() {
+        $examples.hide().removeClass('active');
+        $example.show().addClass('active');
+
+        $(this).siblings('a.active').removeClass('active');
+        $(this).addClass('active');
+      });
+    });
+    
+    $(this).find('a:first').click();
+  });
+});

data/templates/api/fulldoc/html/js/highlight/styles/mono-blue.css

@@ -1,70 +1,153 @@
 /*
-  Five-color theme from a single blue hue.
+
+Original style from softwaremaniacs.org (c) Ivan Sagalaev <Maniac@SoftwareManiacs.Org>
+
 */
+
 .hljs {
   display: block;
   overflow-x: auto;
   padding: 0.5em;
-  background: #eaeef3;
+  background: #f0f0f0;
   -webkit-text-size-adjust: none;
 }
 
 .hljs,
-.hljs-list .hljs-built_in {
-  color: #00193a;
+.hljs-subst,
+.hljs-tag .hljs-title,
+.nginx .hljs-title {
+  color: black;
 }
 
-.hljs-keyword,
+.hljs-string,
 .hljs-title,
-.hljs-important,
-.hljs-request,
-.hljs-header,
-.hljs-javadoctag {
-  font-weight: bold;
+.hljs-constant,
+.hljs-parent,
+.hljs-tag .hljs-value,
+.hljs-rules .hljs-value,
+.hljs-preprocessor,
+.hljs-pragma,
+.haml .hljs-symbol,
+.ruby .hljs-symbol,
+.ruby .hljs-symbol .hljs-string,
+.hljs-template_tag,
+.django .hljs-variable,
+.smalltalk .hljs-class,
+.hljs-addition,
+.hljs-flow,
+.hljs-stream,
+.bash .hljs-variable,
+.apache .hljs-tag,
+.apache .hljs-cbracket,
+.tex .hljs-command,
+.tex .hljs-special,
+.erlang_repl .hljs-function_or_atom,
+.asciidoc .hljs-header,
+.markdown .hljs-header,
+.coffeescript .hljs-attribute {
+  color: #800;
 }
 
+.smartquote,
 .hljs-comment,
+.hljs-annotation,
+.hljs-template_comment,
+.diff .hljs-header,
 .hljs-chunk,
-.hljs-template_comment {
-  color: #738191;
+.asciidoc .hljs-blockquote,
+.markdown .hljs-blockquote {
+  color: #888;
 }
 
-.hljs-string,
-.hljs-title,
-.hljs-parent,
-.hljs-built_in,
+.hljs-number,
+.hljs-date,
+.hljs-regexp,
 .hljs-literal,
-.hljs-filename,
-.hljs-value,
-.hljs-addition,
-.hljs-tag,
-.hljs-argument,
-.hljs-link_label,
-.hljs-blockquote,
-.hljs-header {
-  color: #0048ab;
+.hljs-hexcolor,
+.smalltalk .hljs-symbol,
+.smalltalk .hljs-char,
+.go .hljs-constant,
+.hljs-change,
+.lasso .hljs-variable,
+.makefile .hljs-variable,
+.asciidoc .hljs-bullet,
+.markdown .hljs-bullet,
+.asciidoc .hljs-link_url,
+.markdown .hljs-link_url {
+  color: #080;
 }
 
+.hljs-label,
+.hljs-javadoc,
+.ruby .hljs-string,
 .hljs-decorator,
-.hljs-prompt,
-.hljs-yardoctag,
-.hljs-subst,
-.hljs-symbol,
-.hljs-doctype,
-.hljs-regexp,
-.hljs-preprocessor,
-.hljs-pragma,
-.hljs-pi,
-.hljs-attribute,
+.hljs-filter .hljs-argument,
+.hljs-localvars,
+.hljs-array,
 .hljs-attr_selector,
-.hljs-javadoc,
-.hljs-xmlDocTag,
+.hljs-important,
+.hljs-pseudo,
+.hljs-pi,
+.haml .hljs-bullet,
+.hljs-doctype,
 .hljs-deletion,
+.hljs-envvar,
 .hljs-shebang,
-.hljs-string .hljs-variable,
-.hljs-link_url,
-.hljs-bullet,
-.hljs-sqbracket,
+.apache .hljs-sqbracket,
+.nginx .hljs-built_in,
+.tex .hljs-formula,
+.erlang_repl .hljs-reserved,
+.hljs-prompt,
+.asciidoc .hljs-link_label,
+.markdown .hljs-link_label,
+.vhdl .hljs-attribute,
+.clojure .hljs-attribute,
+.asciidoc .hljs-attribute,
+.lasso .hljs-attribute,
+.coffeescript .hljs-property,
 .hljs-phony {
-  color: #4c81c9;
+  color: #88f;
+}
+
+.hljs-keyword,
+.hljs-id,
+.hljs-title,
+.hljs-built_in,
+.css .hljs-tag,
+.hljs-javadoctag,
+.hljs-phpdoc,
+.hljs-dartdoc,
+.hljs-yardoctag,
+.smalltalk .hljs-class,
+.hljs-winutils,
+.bash .hljs-variable,
+.apache .hljs-tag,
+.hljs-type,
+.hljs-typename,
+.tex .hljs-command,
+.asciidoc .hljs-strong,
+.markdown .hljs-strong,
+.hljs-request,
+.hljs-status {
+  font-weight: bold;
+}
+
+.asciidoc .hljs-emphasis,
+.markdown .hljs-emphasis {
+  font-style: italic;
+}
+
+.nginx .hljs-built_in {
+  font-weight: normal;
+}
+
+.coffeescript .javascript,
+.javascript .xml,
+.lasso .markup,
+.tex .hljs-formula,
+.xml .javascript,
+.xml .vbscript,
+.xml .css,
+.xml .hljs-cdata {
+  opacity: 0.5;
 }

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

@@ -15,7 +15,7 @@ def init
     return serialize_onefile_index
   end
 
-  serialize_index
+  serialize_index if File.exists?(api_options['readme'])
   serialize_static_pages
   serialize_resource_index if api_options['resource_index']
 

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

@@ -26,13 +26,13 @@ def serialize_resource(resource, controllers)
 end
 
 def method_details_list(controllers)
-  @meths = controllers.map do |controller|
+  meths = controllers.map do |controller|
     controller.meths(:inherited => false, :included => false)
   end.flatten
 
-  @meths = run_verifier(@meths)
+  meths = run_verifier(meths)
 
-  @meths.map do |object, i|
+  meths.map do |object, i|
     dump_object(object).tap do |object_info|
       object_info[:tags] = dump_object_tags(object)
     end
@@ -94,10 +94,6 @@ def get_route(object)
   route = routes.first
 
   if route.present?
-    # controller_path = "app/controllers/#{route.requirements[:controller]}_controller.rb"
-    # controller_path = nil unless File.file?(Rails.root+controller_path)
-
-    route_path = route.path.spec.to_s.gsub("(.:format)", "")
     verb = if route.verb.source =~ /\^?(\w*)\$/
       $1.upcase
     else
@@ -105,7 +101,7 @@ def get_route(object)
     end
 
     {
-      path: route_path,
+      path: route.path.spec.to_s.gsub("(.:format)", ""),
       verb: verb
     }
   end

data/templates/api/layout/html/_dynamic_styles.erb

@@ -1,16 +1,41 @@
-<style>
-  body {
-    padding-left: <%= api_options.sidebar_width + api_options.spacer %>px;
-    padding-right: <%= api_options.spacer %>px;
-  }
-
-  #sidebar {
-    width: <%= api_options.sidebar_width %>px;
-  }
+<%
+  content_width = api_options.content_width.to_i
+  content_width = 720 if content_width <= 0
+  sidebar_width = api_options.sidebar_width.to_i || 240
+  sidebar_width = 240 if sidebar_width <= 0
+%>
 
-  <% if api_options.content_width.to_i > 0 %>
+<style>
+  <% if api_options.centered %>
+    body {
+      margin: 0 auto;
+      width: <%= content_width %>px;
+    }
+ 
+    #sidebar {
+      margin-left: -<%= sidebar_width %>px;
+      width: <%= sidebar_width %>px;
+      left: auto;
+    }
+ 
     #content {
-      max-width: <%= api_options.content_width %>px;
+      padding-left: 3em;
     }
+  <% else %> 
+    body {
+      padding-left: <%= sidebar_width + api_options.spacer %>px;
+      padding-right: <%= api_options.spacer %>px;
+    }
+
+    #sidebar {
+      width: <%= sidebar_width %>px;
+    }
+
+    <% if content_width > 0 %>
+      #content {
+        max-width: <%= content_width %>px;
+      }
+    <% end %>
+
   <% end %>
 </style>

data/templates/api/layout/html/layout.erb

@@ -29,8 +29,9 @@
       <div id="content"><%= yieldall %></div>
     <% end %>
 
-    <%= erb(:footer) %>
-    <%= erb(:scripts) %>
+    <% if api_options.show_footer %>
+      <%= erb(:footer) %>
+    <% end %>
 
     <% inline_javascripts.each do |script| %>
       <%= erb(script) %>

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

@@ -32,6 +32,7 @@ def javascripts
   %w[
     js/jquery-1.11.1.min.js
     js/highlight/highlight.pack.js
+    js/app.js
   ]
 end
 
@@ -44,9 +45,15 @@ def contents
 end
 
 def index
-  legitimate_objects = @objects.reject {|o| o.root? || !is_class?(o) || !o.meths.find { |m| !m.tags('API').empty? } }
+  legitimate_objects = @objects.reject do |object|
+    object.root? ||
+    !is_class?(object) ||
+    !object.meths.find { |m| !m.tags('API').empty? }
+  end
 
-  @resources = legitimate_objects.sort_by {|o| o.tags('API').first.text }
+  @resources = legitimate_objects.sort_by do |object|
+    object.tags('API').first.text
+  end
 
   erb(:index)
 end

data/templates/api/layout/html/sidebar.erb

@@ -4,17 +4,18 @@
     <%= api_options['version'] %>
   </h1>
 
-  <h2 class='first'>Pages</h2>
+  <h2 class="sidebar__heading">API</h2>
 
   <nav id="static_pages">
-    <%= sidebar_link('Home', 'index.html') %>
+    <%= sidebar_link(api_options.readme_page_title, 'index.html') %>
     <% static_pages.each do |page| %>
       <%= sidebar_link(page[:title], page[:filename]) %>
     <% end %>
   </nav>
 
-  <h2>Resources</h2>
-  <nav id="api_resources">
+  <h2 class="sidebar__heading">Resources</h2>
+
+  <nav>
     <% if api_options['resource_index'] %>
       <%= sidebar_link('All Resources', 'all_resources.html') %>
     <% end %>

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

@@ -1,7 +1,4 @@
 def init
-  puts "> LAYOUT"
-  # puts options[:object]
-
   if options[:controllers]
     sections :layout, [T('topic'), T('appendix')]
   else

data/templates/api/method_details/html/header.erb

@@ -1,18 +1,29 @@
-<div class='method_details'>
+<div class='method-details'>
   <h2
-    class='api_method_name'
+    class='method-details__name'
     name='<%= @props[:method_link] %>'
     data-subtopic='<%= @props[:subtopic] %>'
   >
     <a
       name='<%= @props[:method_link] %>'
       href='#<%= @props[:method_link] %>'
+      class='method-details__name-link'
     >
       <%= object.tag('API').text %>
     </a>
 
+    <% if object.has_tag?('beta') && api_options["use_beta_flag"] %>
+      <span
+        class="method-details__beta-flag"
+        title="This API endpoint is not finalized, and there could be
+               breaking changes before its final release."
+      >
+        BETA
+      </span>
+    <% end %>
+
     <% if @props[:path] && !api_options.github_url.to_s.empty? %>
-      <span class='defined-in'>
+      <span class='method-details__defined-in'>
         <a href="<%= api_options.github_url %>/blob/<%= api_options.github_branch %>/<%= @props[:path] %>">
           <%= "#{@props[:controller]}Controller\##{@props[:action]}" %>
         </a>

data/templates/api/method_details/html/method_signature.erb

@@ -6,8 +6,16 @@
     end.join('/')
   %>
 
-  <h3 class='endpoint'>
+  <div class='endpoint__path'>
     <span class="verb <%= route[:verb].downcase %>"><%= route[:verb] %></span>
     <%= formatted_route_path %>
-  </h3>
+  </div>
+
+  <% if object.has_tag?('beta') && api_options["use_beta_banner"] %>
+    <p class='endpoint__beta-banner'>
+      BETA: This API endpoint is not finalized, and there could be breaking
+      changes before its final release.
+    </p>
+  <% end %>
 <% end %>
+