middleman-listpages 0.0.1 → 0.0.2

data/README.md

@@ -6,8 +6,8 @@ ability to list the child pages of a given page.
 # Install
 
 Add `middleman-listpages` to your `Gemfile`
-```
-gem "middleman-listpages", :git => "git://github.com/strathmeyer/middleman-listpages.git"
+```ruby
+gem "middleman-listpages", "~> 0.0.1"
 ```
 
 Then open your `config.rb` and add:
@@ -21,16 +21,64 @@ To display all pages:
 <%= list_pages %>
 ```
 
+This will generate HTML like this (assuming "Apples" is the current page):
+```html
+<ul>
+  <li class='active'><a href="/apples/">Apples</a></li>
+  <li>
+    <a href="/oranges/">Oranges</a>
+    <ul>
+      <li><a href="/oranges/navel/">Navel Oranges</a></li>
+      <li><a href="/oranges/clementine/">Clementine Oranges</a></li>
+    </ul>
+  </li>
+</ul>
+```
+
 To display all children of current page:
 ```erb
 <%= list_pages current_page %>
 ```
 
-To display one level of children of current page:
+You can use the `:depth` option to specify how many levels deep to display:
 ```erb
 <%= list_pages current_page, :depth => 1 %>
 ```
 
+If you want to use options when displaying the root page, pass `nil` as the
+first agrument:
+```erb
+<%= list_pages nil, :depth => 1 %>
+```
+
+To display the root page as well:
+```erb
+<%= list_pages nil, :include_root => true %>
+```
+
+This will generate:
+```html
+<ul>
+  <li><a href="/index.html">Index Page Title</a>
+  <li class='active'><a href="/apples/">Apples</a></li>
+  <li>
+    <a href="/oranges/">Oranges</a>
+    <ul>
+      <li><a href="/oranges/navel/">Navel Oranges</a></li>
+      <li><a href="/oranges/clementine/">Clementine Oranges</a></li>
+    </ul>
+  </li>
+</ul>
+```
+
+This will generate HTML like this (assuming "Apples" is the current page):
+```html
+<ul>
+  <li class='active'><a href="/apples/">Apples</a></li>
+  <li><a href="/oranges/">Oranges</a></li>
+</ul>
+```
+
 To display all children of a specific page:
 ```erb
 <%= list_pages sitemap.find_resource_by_destination_path('index.html') %>
@@ -43,15 +91,11 @@ Since you might have sub LIs inside that, you'll probably want to reset the CSS
 of the inner LIs via something like this:
 
 ```css
-li {
-  font-weight: normal;
+li, li.active li {
+    font-weight: normal;
 }
 
 li.active {
-  font-weight: bold;
-}
-
-li.active li {
-  font-weight: normal;
+    font-weight: bold;
 }
 ```

data/lib/middleman-listpages/_list.erb

@@ -0,0 +1,6 @@
+<ul>
+  <% if opts[:include_root] && opts[:current_depth] == 1 %>
+    <%= li_for sitemap.find_resource_by_destination_path('index.html') %>
+  <% end %>
+  <%= child_html.join("\n") %>
+</ul>

data/lib/middleman-listpages/_list_item.erb

@@ -0,0 +1,4 @@
+<li <%= active ? "class='active'" : "" %>>
+  <%= link_to page.data.title, page %>
+  <%= sub_list %>
+</li>

data/lib/middleman-listpages/extension.rb

@@ -1,3 +1,5 @@
+require 'erb'
+
 module Middleman
   module ListPages
     class << self
@@ -16,26 +18,38 @@ module Middleman
         end
 
         page ||= sitemap.find_resource_by_destination_path('index.html')
-        children = filter_children(page.children, opts[:extensions])
+        children = filter_children(page.children, opts.slice(:extensions))
 
         if children.empty?
           ""
         else
-          opts[:current_depth] +=  1
-          child_html = children.map { |child| li_for(child, opts.dup) }
-          "<ul>#{child_html.join}</ul>"
+          child_html = children.map do |child|
+            my_opts = opts.dup
+            my_opts[:current_depth] +=  1
+            sub_list = list_pages(child, my_opts)
+            li_for(child, sub_list, my_opts)
+          end
+
+          render('_list', binding)
         end
       end
 
-      def li_for(page, opts={})
-        child_html = list_pages(page, opts)
+      def li_for(page, sub_list=nil, opts={})
         active = (page.path == current_page.path)
 
-        "<li class='#{active ? "active" : ""}'>#{link_to page.data.title, page}#{child_html}</li>"
+        render('_list_item', binding)
+      end
+
+      private
+
+      def render(path, bound)
+        full_path = File.join(File.dirname(__FILE__), "#{path}.erb")
+        template = ERB.new(File.read full_path)
+        template.result bound
       end
 
-      def filter_children(children, extensions=nil)
-        extensions ||= ".html"
+      def filter_children(children, opts=nil)
+        extensions = opts[:extensions] || ".html"
         extensions = Array(extensions)
 
         children.reject { |p| p.data.title.nil? }.select do |p|

data/lib/middleman-listpages/version.rb

@@ -1,5 +1,5 @@
 module Middleman
   module ListPages
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: middleman-listpages
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -41,6 +41,8 @@ files:
 - features/.gitkeep
 - fixtures/.gitkeep
 - lib/middleman-listpages.rb
+- lib/middleman-listpages/_list.erb
+- lib/middleman-listpages/_list_item.erb
 - lib/middleman-listpages/extension.rb
 - lib/middleman-listpages/version.rb
 - lib/middleman_extension.rb
@@ -59,7 +61,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2220986079241718075
+      hash: 4217439097059215008
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -68,7 +70,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2220986079241718075
+      hash: 4217439097059215008
 requirements: []
 rubyforge_project: middleman-listpages
 rubygems_version: 1.8.23