yard-api 0.3.5 → 0.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9bb31c38d0e0da32afec85858785e0983828d3d6
-  data.tar.gz: 7c9473a9bf603bed99dca94993402e2f4e0e7fb8
+  metadata.gz: 06c93991353fbc833a7ca45b81836c7667838845
+  data.tar.gz: 30f2b0a1b805366a5fb1794f2d395999ad177558
 SHA512:
-  metadata.gz: 591fbf739b125a4c4a6057f209df2e03f6914b6b6e0b932a8f9bad46387275bb4d0dcea16e91b2885d20d21c0fe6b9cda3871c61f94a37b9a976d712ee44a78e
-  data.tar.gz: 754ef7e03bcdf38789fe330fa62389f240d0b57579d6ef157d9e883647dad3540630ac1e26a660f3d550217c338fbf09e9d972161defe6efca0d61dc33f7dfde
+  metadata.gz: 98c3d661fc6bf8f33de2754ed07b56b826d066f32e752629459f180c11e7097c2106f8b6d163a28606ca96d25f4bc01bf4d9143a6631947774b58d6415a2abd7
+  data.tar.gz: fab1bbb48be6ed00328df8cb4407c970aec1ac72f83478f97d20a38cc96f3dc7f2c025abb20c2dae4fd18f07d22ebfc9edab99c54f1196ae9a10ffc2e53977ee

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

@@ -11,6 +11,12 @@ module YARD::Templates::Helpers::HtmlHelper
     link
   end
 
+  def visible_static_pages()
+    @@visible_static_pages ||= begin
+      static_pages.reject { |page| page[:exclude_from_sidebar] }
+    end
+  end
+
   def static_pages()
     @@static_pages ||= begin
       locate_static_pages(YARD::APIPlugin.options)
@@ -19,6 +25,7 @@ module YARD::Templates::Helpers::HtmlHelper
 
   def locate_static_pages(options)
     title_overrides = {}
+    excludes = {}
 
     paths = Array(options.static).map do |entry|
       pages = if entry.is_a?(Hash)
@@ -29,6 +36,7 @@ module YARD::Templates::Helpers::HtmlHelper
         end
 
         title_overrides[entry['path']] = entry['title']
+        excludes[entry['path']] = true if entry['exclude_from_sidebar']
 
         entry['path']
       elsif entry.is_a?(Array)
@@ -62,7 +70,8 @@ module YARD::Templates::Helpers::HtmlHelper
       {
         src: page,
         filename: filename,
-        title: title
+        title: title,
+        exclude_from_sidebar: !!excludes[page]
       }
     end.sort_by { |page| page[:title] }
   end

data/lib/yard-api/version.rb

@@ -1,5 +1,5 @@
 module YARD
   module APIPlugin
-    VERSION = "0.3.5"
+    VERSION = "0.3.6"
   end
 end

data/spec/helpers/html_helper_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+require 'tempfile'
+
+describe YARD::Templates::Helpers::HtmlHelper do
+  let(:html) { Class.new { include YARD::Templates::Helpers::HtmlHelper }.new }
+  let(:included) { Tempfile.new('included') }
+  let(:excluded) { Tempfile.new('excluded') }
+
+  before do
+    html.singleton_class.class_variable_set(:@@static_pages, nil)
+    html.singleton_class.class_variable_set(:@@visible_static_pages, nil)
+    set_option('static', [
+      {'path' => included.path, 'title' => 'Included'},
+      {'path' => excluded.path, 'title' => 'Excluded', 'exclude_from_sidebar' => true}
+    ])
+  end
+
+  after do
+    included.close(true)
+    excluded.close(true)
+  end
+
+  describe '#visible_static_pages' do
+    it 'excludes pages with exclude_from_sidebar option' do
+      pages = html.visible_static_pages
+      expect(pages.count).to eq(1)
+      expect(pages[0][:title]).to eq('Included')
+      expect(pages[0][:exclude_from_sidebar]).to be_falsey
+    end
+  end
+
+  describe '#static_pages' do
+    it 'includes pages with exclude_from_sidebar option' do
+      pages = html.static_pages
+      expect(pages.count).to eq(2)
+
+      page = pages.find { |p| p[:exclude_from_sidebar] }
+      expect(page).to_not be_nil
+      expect(page[:title]).to eq('Excluded')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,5 +1,3 @@
-require 'byebug' if RUBY_VERSION > '1.9.3'
-
 # This file was generated by the `rspec --init` command. Conventionally, all
 # specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
 # The generated `.rspec` file contains `--require spec_helper` which will cause this

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

@@ -16,7 +16,7 @@
     <% if options[:all_resources] %>
       <div id="content">
         <% if api_options.one_file %>
-          <% static_pages.each do |page| %>
+          <% visible_static_pages.each do |page| %>
             <%= diskfile page[:src] %>
           <% end %>
         <% end %>

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

@@ -15,7 +15,7 @@
       )
     %>
 
-    <% static_pages.each do |page| %>
+    <% visible_static_pages.each do |page| %>
       <%=
         sidebar_link(page[:filename], page[:title], object == page[:filename])
       %>

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

@@ -4,7 +4,7 @@
   </h1>
 
   <nav id="static_pages">
-    <% static_pages.each do |page| %>
+    <% visible_static_pages.each do |page| %>
       <%= sidebar_link(page[:title], page[:filename]) %>
     <% end %>
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yard-api
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.3.6
 platform: ruby
 authors:
 - Ahmad Amireh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-06 00:00:00.000000000 Z
+date: 2016-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
@@ -80,6 +80,7 @@ files:
 - lib/yard-api/version.rb
 - lib/yard-api/yardoc_task.rb
 - spec/fulldoc_spec.rb
+- spec/helpers/html_helper_spec.rb
 - spec/spec_helper.rb
 - spec/tags/argument_spec.rb
 - tasks/yard_api.rake
@@ -206,7 +207,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: A YARD plugin for documenting APIs in Rails projects.