yard-api 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e57e3582930e4a46f3b37f99587c6920eef9b569
-  data.tar.gz: 10ddc0a2d4286478cc9ffaf0bcba61594addc973
+  metadata.gz: 199b61a69ee11af6ea6ba0dddb1b7227647258ec
+  data.tar.gz: 7d1e0fec57a1f4366d698c272af0c96056fdf1e7
 SHA512:
-  metadata.gz: 52f99424016cc8c6926546d31e5196f79fc3d75e044b1aa371e7b161971584abf255b6f4335db309f8885bc42aba1ea10cb0ec1b473f9d0c2b0405e43b6acd77
-  data.tar.gz: cf0581d7c557506965ebd32dd890d99d29711052732db16b1e65b56193548c06f394b0a37c1121f7eb7f8301f41ff130bb17fa17f4e09b6f483f6e3d4ec0b8e1
+  metadata.gz: 412350ca78f192d978a921c57f0a0294e184fe3ce9c754a9e9374a19ba4128deaf0e1f81e98c4f6e2f9599abe07b99d1b53874580c048ae22fdefeb7cbafbe44
+  data.tar.gz: a4ce1b0807cf2e4c5c27aadb4223a28f22a0a96a4a73a0fae2650c36692a5fba2bab480ff42d4f7464a9b51db2b8cbde5e8b33913a517ce72d9c6b9a92d423ac

data/lib/yard-api/options.rb

@@ -1,6 +1,7 @@
 module YARD::APIPlugin
   class Options < YARD::Options
     default_attr :title, 'Rails API Project'
+    default_attr :source, 'doc/api'
     default_attr :static, []
     default_attr :files, []
     default_attr :route_namespace, ''
@@ -8,6 +9,11 @@ module YARD::APIPlugin
     default_attr :footer_copyright, nil
     default_attr :footer_note, nil
 
+    default_attr :one_file, false
+    default_attr :verbose, false
+    default_attr :debug, false
+    default_attr :theme, 'default'
+
     attr_accessor :readme
   end
 end

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

@@ -35,13 +35,15 @@ module YARD::Templates::Helpers::HtmlHelper
       elsif entry.is_a?(String)
         [ entry ]
       end
-    end.flatten.compact
+    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)
 
-    if readme_page.present?
+    if readme_page.present? && !options.one_file
       pages.delete_if { |page| page.match(readme_page) }
     end
 
@@ -57,6 +59,10 @@ module YARD::Templates::Helpers::HtmlHelper
         File.basename(page).sub(/\.\w+$/, '').gsub(/\W/, ' ').gsub(/\s+/, ' ').capitalize
       end
 
+      if options.verbose
+        puts "Serializing static page #{page}"
+      end
+
       {
         src: page,
         filename: filename,
@@ -85,9 +91,9 @@ module YARD::Templates::Helpers::HtmlHelper
     link_url("#{html_file}##{bookmark}", appendix.title)
   end
 
-  def sidebar_link(title, href)
+  def sidebar_link(title, href, options={})
     <<-HTML
-      <a href="#{url_for(href)}">#{title}</a>
+      <a href="#{url_for(href)}" class="#{options[:class_name]}">#{title}</a>
     HTML
   end
 

data/lib/yard-api/version.rb

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

data/lib/yard-api/yardoc_task.rb

@@ -4,8 +4,8 @@ module YARD::APIPlugin
   class YardocTask < ::YARD::Rake::YardocTask
     attr_reader :config
 
-    def initialize()
-      super(:yard_api, &:run)
+    def initialize(name=:yard_api)
+      super(name, &:run)
     end
 
     def run

data/lib/yard-api.rb

@@ -45,4 +45,11 @@ module YARD
   module Templates
     Engine.register_template_path YARD::APIPlugin::TEMPLATE_PATH
   end
+
+  module CLI
+    class YardocOptions < Templates::TemplateOptions
+      default_attr :resources, []
+      default_attr :json_objects, []
+    end
+  end
 end

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

@@ -12,7 +12,7 @@ def init
   generate_assets
   serialize_index
   serialize_static_pages
-  serialize_mega_index if api_options['resource_index']
+  serialize_resource_index if api_options['resource_index']
 
   options.delete(:objects)
 
@@ -38,12 +38,24 @@ def serialize_resource(resource, controllers)
 end
 
 def serialize_index
+  return serialize_onefile_index if api_options.one_file
+
   options[:file] = api_options['readme']
   serialize('index.html')
   options.delete(:file)
 end
 
-def serialize_mega_index
+def serialize_onefile_index
+  options[:all_resources] = true
+
+  Templates::Engine.with_serializer('index.html', options[:serializer]) do
+    T('onefile').run(options)
+  end
+
+  options.delete(:all_resources)
+end
+
+def serialize_resource_index
   options[:all_resources] = true
 
   Templates::Engine.with_serializer("all_resources.html", options[:serializer]) do
@@ -58,9 +70,9 @@ def asset(path, content)
 end
 
 def generate_assets
-  asset_root = Pathname.new(File.dirname(__FILE__))
-  (Dir[asset_root + "css/**/*.css"] + Dir[asset_root + "js/**/*.js"]).each do |file|
-    file = Pathname.new(file).relative_path_from(asset_root).to_s
+  layout = Object.new.extend(T('layout'))
+
+  [].concat(layout.stylesheets).concat(layout.javascripts).uniq.each do |file|
     asset(file, file(file, true))
   end
 end

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

@@ -3,17 +3,10 @@
 
 <title><%= api_options['title'] %></title>
 
-<link
-  rel="stylesheet"
-  href="<%= url_for("css/common.css") %>"
-  type="text/css"
-  media="screen"
-  charset="utf-8" />
+<% stylesheets.each do |stylesheet| %>
+  <link rel="stylesheet" href="<%= url_for(stylesheet) %>" type="text/css" charset="utf-8" />
+<% end %>
 
-<link
-  href="<%= url_for("css/highlight.css") %>"
-  rel="stylesheet"
-  type="text/css" />
-
-<script src="<%= url_for("js/highlight/highlight.pack.js") %>" type="text/javascript"></script>
-<script src="<%= url_for("js/jquery-1.11.1.min.js") %>" type="text/javascript"></script>
+<% javascripts.each do |javascript| %>
+  <script src="<%= url_for(javascript) %>" type="text/javascript"></script>
+<% end %>

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

@@ -4,7 +4,7 @@
     <%= erb(:headers) %>
   </head>
 
-  <body>
+  <body class="theme-<%= api_options.theme %>">
     <div id="sidebar">
       <%= erb(:sidebar) %>
     </div>

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

@@ -28,7 +28,7 @@
     console.log('Highlighting current page:', $page, currentPage);
   });
 
-  $('#content pre.code').each(function(i, block) {
+  $('#content pre').each(function(i, block) {
     var code;
     var $block = $(block);
     var $codeEl = $block.find('> code');

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

@@ -17,6 +17,20 @@ def init
   end
 end
 
+def stylesheets
+  %w[
+    css/common.css
+    css/highlight.css
+  ]
+end
+
+def javascripts
+  %w[
+    js/jquery-1.11.1.min.js
+    js/highlight/highlight.pack.js
+  ]
+end
+
 def contents
   @contents
 end

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

@@ -1,4 +1,4 @@
-<nav>
+<div>
   <h1>
     <%= api_options['title'] %>
     <%= api_options['version'] %>
@@ -6,18 +6,21 @@
 
   <h2 class='first'>Pages</h2>
 
-  <%= sidebar_link('Home', 'index.html') %>
-
-  <% static_pages.each do |page| %>
-    <%= sidebar_link(page[:title], page[:filename]) %>
-  <% end %>
+  <nav id="static_pages">
+    <%= sidebar_link('Home', 'index.html') %>
+    <% static_pages.each do |page| %>
+      <%= sidebar_link(page[:title], page[:filename]) %>
+    <% end %>
+  </nav>
 
   <h2>Resources</h2>
-  <% if api_options['resource_index'] %>
-    <%= sidebar_link('All Resources', 'all_resources.html') %>
-  <% end %>
+  <nav id="api_resources">
+    <% 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>
+    <% options[:resources].each do |resource, controllers| %>
+      <%= sidebar_link resource, "#{topicize(resource)}.html" %>
+    <% end %>
+  </nav>
+</div>

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

@@ -0,0 +1 @@
+include T('api/layout/html')

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

@@ -0,0 +1,15 @@
+<div>
+  <h1>
+    <%= sidebar_link("#{api_options.title} #{api_options.version}", 'index.html') %>
+  </h1>
+
+  <nav id="static_pages">
+    <% static_pages.each do |page| %>
+      <%= sidebar_link(page[:title], page[:filename]) %>
+    <% end %>
+
+    <% options[:resources].each do |resource, controllers| %>
+      <%= sidebar_link resource, "#{topicize(resource)}.html", class_name: "api_resource_link" %>
+    <% end %>
+  </nav>
+</div>

data/yard-api.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |s|
   s.has_rdoc    = 'yard'
   s.license     = 'AGPL3'
   s.add_dependency 'yard', '0.8.7'
-  s.add_dependency 'yard-appendix', '>=0.1.8'
-  s.add_development_dependency 'rspec'
-  s.add_development_dependency 'gem-release'
+  s.add_dependency 'yard-appendix', '~> 0.1.8'
+  s.add_development_dependency 'rspec', '~> 0'
+  s.add_development_dependency 'gem-release', '~> 0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yard-api
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Ahmad Amireh
@@ -28,42 +28,42 @@ dependencies:
   name: yard-appendix
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.1.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.1.8
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: gem-release
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
 description: |2
@@ -102,6 +102,8 @@ files:
 - templates/api/method_details/html/header.erb
 - templates/api/method_details/html/method_signature.erb
 - templates/api/method_details/html/setup.rb
+- templates/api/onefile/html/setup.rb
+- templates/api/onefile/html/sidebar.erb
 - templates/api/tags/html/_example_code_block.erb
 - templates/api/tags/html/argument.erb
 - templates/api/tags/html/emits.erb