yard-api 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2d00ad89d7b00ed7802d02bb20aaee24f7fdad86
-  data.tar.gz: f72ec72eadf4baa315a099c37d21276041bb2549
+  metadata.gz: e57e3582930e4a46f3b37f99587c6920eef9b569
+  data.tar.gz: 10ddc0a2d4286478cc9ffaf0bcba61594addc973
 SHA512:
-  metadata.gz: f6d040c1451a6d858f14baf9b744da36efe2ed87708bc7eabb6a9757fa350cb3d42350cbe8a1a34fa6f1dd94ae51c3e894911840215b154fbbcd4e0b8b159b72
-  data.tar.gz: 5dd3159103e8328edb0fca1e1be99279a1540815597b3ab186e95bcf206ed9fc6b622ca2b21f5767fcd492c1914a6b042f09bbd25918c45b2799337ec3cc94e4
+  metadata.gz: 52f99424016cc8c6926546d31e5196f79fc3d75e044b1aa371e7b161971584abf255b6f4335db309f8885bc42aba1ea10cb0ec1b473f9d0c2b0405e43b6acd77
+  data.tar.gz: cf0581d7c557506965ebd32dd890d99d29711052732db16b1e65b56193548c06f394b0a37c1121f7eb7f8301f41ff130bb17fa17f4e09b6f483f6e3d4ec0b8e1

data/README.md

@@ -14,6 +14,11 @@ TODO
 
 ## Changelog
 
+**14/9/2014**
+
+- Support for single-page output through the `one_file` option
+- Support for resource index generation ("All Resources") through the `resource_index` option
+
 **10/9/2014**
 
 - Support for github-flavored markdown when you're using Markdown as a markup, and `redcarpet` as the provider

data/lib/yard-api/templates/helpers/html_helper.rb

@@ -84,4 +84,31 @@ module YARD::Templates::Helpers::HtmlHelper
     bookmark = "#{appendix.name.to_s.gsub(' ', '+')}-appendix"
     link_url("#{html_file}##{bookmark}", appendix.title)
   end
+
+  def sidebar_link(title, href)
+    <<-HTML
+      <a href="#{url_for(href)}">#{title}</a>
+    HTML
+  end
+
+  # Turns text into HTML using +markup+ style formatting.
+  #
+  # @override Syntax highlighting is not performed on the HTML block.
+  # @param [String] text the text to format
+  # @param [Symbol] markup examples are +:markdown+, +:textile+, +:rdoc+.
+  #   To add a custom markup type, see {MarkupHelper}
+  # @return [String] the HTML
+  def htmlify(text, markup = options.markup)
+    markup_meth = "html_markup_#{markup}"
+    return text unless respond_to?(markup_meth)
+    return "" unless text
+    return text unless markup
+    html = send(markup_meth, text)
+    if html.respond_to?(:encode)
+      html = html.force_encoding(text.encoding) # for libs that mess with encoding
+      html = html.encode(:invalid => :replace, :replace => '?')
+    end
+    html = resolve_links(html)
+    html
+  end
 end

data/lib/yard-api/version.rb

@@ -1,5 +1,5 @@
 module YARD
   module APIPlugin
-    VERSION = "0.1.1"
+    VERSION = "0.1.2"
   end
 end

data/lib/yard-api/yardoc_task.rb

@@ -34,6 +34,7 @@ module YARD::APIPlugin
 
       set_option('title', config['title'])
       set_option('output-dir', config['output'])
+      set_option('one-file') if config['one_file']
       set_option('readme', config['readme']) if File.exists?(config['readme'])
       set_option('verbose') if config['verbose']
       set_option('debug') if config['debug']

data/templates/api/docstring/html/text.erb

@@ -1,6 +1,6 @@
 <% untagged = object.tags.reject { |tag| tag.tag_name == 'API' }.empty? %>
 
 <% text = object.docstring.strip %>
-<% text = '*No documentation available yet.*' if text.empty? && untagged %>
+<% text = '<em>No documentation available yet.</em>' if text.empty? && untagged %>
 
-<%= html_markup_markdown(text) %>
+<%= htmlify(text) %>

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

@@ -12,6 +12,7 @@ def init
   generate_assets
   serialize_index
   serialize_static_pages
+  serialize_mega_index if api_options['resource_index']
 
   options.delete(:objects)
 
@@ -42,6 +43,16 @@ def serialize_index
   options.delete(:file)
 end
 
+def serialize_mega_index
+  options[:all_resources] = true
+
+  Templates::Engine.with_serializer("all_resources.html", options[:serializer]) do
+    T('layout').run(options)
+  end
+
+  options.delete(:all_resources)
+end
+
 def asset(path, content)
   options[:serializer].serialize(path, content) if options[:serializer]
 end

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

@@ -9,7 +9,21 @@
       <%= erb(:sidebar) %>
     </div>
 
-    <div id="content"><%= yieldall %></div>
+    <% if options[:all_resources] %>
+      <div id="content">
+        <% if api_options['one_file'] %>
+          <% static_pages.each do |page| %>
+            <%= diskfile page[:src] %>
+          <% end %>
+        <% end %>
+
+        <% options[:resources].each do |resource, controllers| %>
+          <%= yieldall object: resource, controllers: controllers %>
+        <% end %>
+      </div>
+    <% else %>
+      <div id="content"><%= yieldall %></div>
+    <% end %>
 
     <%= erb(:footer) %>
     <%= erb(:scripts) %>

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

@@ -16,6 +16,18 @@
     $('<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 ($page.length === 0) {
+      $page = $('#sidebar a[href=""]');
+    }
+
+    $page.addClass('current');
+    console.log('Highlighting current page:', $page, currentPage);
+  });
+
   $('#content pre.code').each(function(i, block) {
     var code;
     var $block = $(block);

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

@@ -1,20 +1,15 @@
 include Helpers::FilterHelper
 
 def init
-  @breadcrumb = []
-
   @page_title = options[:title]
 
-  if @file
-    if @file.is_a?(String)
-      @contents = File.read(@file)
-      @file = File.basename(@file)
-    else
-      @contents = @file.contents
-      @file = File.basename(@file.path)
-    end
-    def @object.source_type; nil; end
+  if options[:inline_file]
+    @contents = File.read(options[:file])
+    sections :diskfile
+  elsif @file
     sections :layout, [:diskfile]
+  elsif options[:all_resources]
+    sections :layout, [T('topic'), T('appendix')]
   elsif options[:controllers]
     sections :layout, [T('topic'), T('appendix')]
   else
@@ -34,9 +29,19 @@ def index
   erb(:index)
 end
 
-def diskfile
+def diskfile(filename=@file)
+  if filename.is_a?(String)
+    @contents = File.read(filename)
+    filename = File.basename(filename)
+  elsif filename.is_a?(File)
+    @contents = filename.contents
+    filename = File.basename(filename.path)
+  end
+
+  extension = (File.extname(filename)[1..-1] || '').downcase
+
   content = "<div id='filecontents'>" +
-  case (File.extname(@file)[1..-1] || '').downcase
+  case extension
   when 'htm', 'html'
     @contents
   when 'txt'

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

@@ -5,25 +5,19 @@
   </h1>
 
   <h2 class='first'>Pages</h2>
-  <a
-    href="<%= url_for("index.html") %>"
-    class="<%= 'current' if options[:object] == 'index.html' %>">Home
-  </a>
+
+  <%= sidebar_link('Home', 'index.html') %>
 
   <% static_pages.each do |page| %>
-    <a  href="<%= url_for(page[:filename]) %>"
-        class="<%= 'current' if options[:object] == page[:filename] %>">
-      <%= page[:title] %>
-    </a>
+    <%= sidebar_link(page[:title], page[:filename]) %>
   <% end %>
 
   <h2>Resources</h2>
-  <% options[:resources].each_with_index do |(resource, controllers), i| %>
-    <%
-      link = url_for("#{topicize resource}.html")
-      klass = []
-      klass << "current" if resource == options[:object]
-    %>
-    <a class="<%= klass.join(' ') %>" href="<%= link %>"><%= resource %></a>
+  <% if api_options['resource_index'] %>
+    <%= sidebar_link('All Resources', 'all_resources.html') %>
+  <% end %>
+
+  <% options[:resources].each do |resource, controllers| %>
+    <%= sidebar_link resource, "#{topicize(resource)}.html" %>
   <% end %>
 </nav>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yard-api
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Ahmad Amireh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-10 00:00:00.000000000 Z
+date: 2014-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard