yard-api 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c4a7dbe342296a08ff5f47833f80909d984d0607
-  data.tar.gz: 278a23bc1ba6409da13fa24b7c755b19a0a38d09
+  metadata.gz: 8e7c2eba4abe4ecd107cc9cc902e36c05e5816e9
+  data.tar.gz: bc34644b9a32d557a6863d6e316d2e1c9bfd70b1
 SHA512:
-  metadata.gz: 4fcbd79b911d4e108f36a5dbdc8bb52457ed88b12c4324350d71da1c7c48e84e821ccc910c94297843b12004473861be20b5252418f6f80c4539399868f8a970
-  data.tar.gz: 2d4c8731cf3ac058083028f433113cb2b9f41ef7603506f831329cdb1f7449532d4df9fc3b13702462023df2d065297d5cf87abe8d3262ee781f87807f771187
+  metadata.gz: d0abfc99e7f6d40e331219a96f5813b8a716d0fb7c78d0fc683543c6231053991833fec5450ca604deafa0ce7b55ec2618acd01336ec3480df3e250d2cb792e4
+  data.tar.gz: 3324e947fa1ed339a7cc8f9ca90d019a561fca7a4a6b2e3cbc099d2645112cb1a354549e18ebe6269d8a2cc89d1dee78f314293595b69311ae5926cd92217e27

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

@@ -71,12 +71,13 @@ module YARD::Templates::Helpers::BaseHelper
 
   def lookup_topic(controller_name)
     controller = nil
-    topic = options[:resources].find { |r,cs|
-      cs.any? { |c|
-        controller = c if c.name.to_s == controller_name
-        !controller.nil?
-      }
-    }
+    topic = options[:resources].find do |resource, controllers|
+      controllers.detect do |_controller|
+        if _controller.path.to_s == controller_name
+          controller = _controller
+        end
+      end
+    end
 
     [ topic, controller ]
   end
@@ -84,7 +85,7 @@ module YARD::Templates::Helpers::BaseHelper
   def lookup_appendix(title)
     appendix = nil
 
-    puts "looking up appendix: #{title}"
+    puts "Looking up appendix: #{title}" if api_options.verbose
 
     if object
       # try in the object scope

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

@@ -12,6 +12,8 @@ module YARD::Templates::Helpers::HtmlHelper
   end
 
   def static_pages()
+    return @static_pages if @static_pages
+
     options = YARD::APIPlugin.options
 
     paths = Array(options.static).map do |entry|
@@ -37,8 +39,6 @@ module YARD::Templates::Helpers::HtmlHelper
       end
     end.flatten.compact.uniq.map { |path| File.join(options.source, path) }
 
-    puts "Static pages: #{paths}" if options.verbose
-
     markdown_exts = YARD::Templates::Helpers::MarkupHelper::MARKUP_EXTENSIONS[:markdown]
     readme_page = options.readme
     pages = Dir.glob(paths)
@@ -47,7 +47,7 @@ module YARD::Templates::Helpers::HtmlHelper
       pages.delete_if { |page| page.match(readme_page) }
     end
 
-    pages.map do |page|
+    @static_pages = pages.map do |page|
       filename = 'file.' + File.split(page).last.sub(/\..*$/, '.html')
 
       # extract page title if it's a markdown document; title is expected to
@@ -73,22 +73,30 @@ module YARD::Templates::Helpers::HtmlHelper
 
   # override yard-appendix link_appendix
   def link_appendix(ref)
-    __errmsg = "unable to locate referenced appendix '#{ref}'"
+    puts "Linking appendix: #{ref}" if api_options.verbose
 
-    puts "looking up appendix: #{ref}"
     unless appendix = lookup_appendix(ref.to_s)
-      raise __errmsg
+      raise "Unable to locate referenced appendix '#{ref}'"
     end
 
-    topic, controller = *lookup_topic(appendix.namespace.to_s)
+    html_file = if options[:all_resources] && api_options.one_file
+      'index.html'
+    elsif options[:all_resources]
+      'all_resources.html'
+    else
+      topic, controller = *lookup_topic(appendix.namespace.to_s)
 
-    unless topic
-      raise __errmsg
+      unless topic
+        raise "Unable to locate topic for appendix: #{ref}"
+      end
+
+      "#{topicize(topic.first)}.html"
     end
 
-    html_file = "#{topicize topic.first}.html"
     bookmark = "#{appendix.name.to_s.gsub(' ', '+')}-appendix"
-    link_url("#{html_file}##{bookmark}", appendix.title)
+    link_url("#{html_file}##{bookmark}", appendix.title).tap do |link|
+      puts "\tAppendix link: #{link}" if api_options.verbose
+    end
   end
 
   def sidebar_link(title, href, options={})

data/lib/yard-api/version.rb

@@ -1,5 +1,5 @@
 module YARD
   module APIPlugin
-    VERSION = "0.1.5"
+    VERSION = "0.1.6"
   end
 end

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

@@ -7,13 +7,19 @@ end
 def appendix
   controllers = options[:controllers]
 
+  if options[:all_resources]
+    controllers = options[:resources].flatten.select { |o|
+      o.is_a?(YARD::CodeObjects::NamespaceObject)
+    }
+  end
+
   unless controllers && controllers.is_a?(Array)
     return
   end
 
-  @appendixes = controllers.collect { |c|
-    c.children.select { |o| :appendix == o.type }
-  }.flatten
+  @appendixes = controllers.collect do |controller|
+    controller.children.select { |tag| :appendix == tag.type }
+  end.flatten.uniq
 
   super
 end

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

@@ -1,12 +1,12 @@
 <article>
-  <%= html_markup_markdown(@docstring.strip) %>
+  <%= htmlify(@docstring) %>
 </article>
 
 <% c = options[:controllers].detect { |c| c.has_tag?(:note) } %>
 <% c && c.tags(:note).each do |tag| %>
   <blockquote class="note">
     <p><strong>Note</strong></p>
-    <%= html_markup_markdown tag.text %>
+    <%= htmlify tag.text %>
   </blockquote>
 <% end %>
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yard-api
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Ahmad Amireh