nanoc-toolbox 0.0.3 → 0.0.4

data/CHANGELOG.md

@@ -1,14 +1,17 @@
 # Changelog
 
 ## developement
+* NEW:      add_section Filter
+* CHANGED:  bugfix on navigation helper
+
 
 ## Release 0.0.3
 
-* NEW: 		Gravatar Helper
+* NEW: 		  Gravatar Helper
 * CHANGED:	Better Yardoc documentation
-* NEW:		RSpec tests
-* NEW:		HTML Tag Helper
-* NEW:		HtlmTidy Filter
+* NEW:		  RSpec tests
+* NEW:		  HTML Tag Helper
+* NEW:		  HtlmTidy Filter
 
 ## Release 0.0.2
 

data/README.md

@@ -12,6 +12,9 @@ The nanoc-toolbox is a collection of filters and helpers for the static site gen
 * Gravatar Helper
 * HtmlTag Helper
 
+* AddSection Filter
+* HtmlTidy Filter
+
 ## Requirements
 
 * nanoc3

data/lib/nanoc/toolbox/filters.rb

@@ -1,4 +1,5 @@
 require 'nanoc/toolbox/filters/html_tidy'
+require 'nanoc/toolbox/filters/add_sections'
 
 # This module will regroup all the filters for nanoc
 module Nanoc::Toolbox::Filters

data/lib/nanoc/toolbox/filters/add_sections.rb

@@ -0,0 +1,92 @@
+module Nanoc::Toolbox::Filters
+
+  # This filters adds section div’s based on headers. For example, this:
+  # @example
+  #   h1
+  #   p
+  #   foo
+  #     p
+  #     h2
+  #     p
+  #   p
+  #   h2
+  #   p
+  #   p
+  #   h1
+  #   p
+  #   
+  #   section
+  #     h1
+  #     p
+  #     foo
+  #       p
+  #       section
+  #         h2
+  #         p
+  #       p
+  #     section
+  #       h2
+  #       p
+  #       p
+  #   section
+  #     p
+  # @author Denis Defreyne <denis.defreyne@stoneship.org>
+  class AddSections < Nanoc3::Filter
+
+    identifiers :add_sections
+
+    def run(content, arguments={})
+      require 'nokogiri'
+
+      # Parse
+      doc = Nokogiri::HTML.fragment(content)
+
+      # Add sections for all headers
+      (1..6).each do |level|
+        # For each header on this level
+        doc.css("h#{level}").each do |header|
+          # Get all siblings
+          siblings = header.parent.children
+
+          # Remove previous siblings
+          siblings_after = []
+          should_include = false
+          siblings.each do |sibling|
+            if sibling == header
+              should_include = true
+            elsif should_include
+              siblings_after << sibling
+            end
+          end
+
+          # Remove next siblings that should not be part of this section
+          siblings_in_between = []
+          siblings_after.each do |sibling|
+            if sibling.name =~ /^h(\d)/ && $1.to_i <= level
+              break
+            else
+              siblings_in_between << sibling
+            end
+          end
+
+          # Create section
+          section = Nokogiri::XML::Node.new('div', doc)
+          section['class'] = 'section'
+          section['id'] = header.content.downcase.gsub(/\W+/, '-').gsub(/^-|-$/, '')
+          header.add_previous_sibling(section)
+
+          # Move children into section
+          header.unlink
+          section.add_child(header)
+          siblings_in_between.each do |sibling|
+            sibling.unlink
+            section.add_child(sibling)
+          end
+        end
+      end
+
+      # Done
+      doc.to_s
+    end
+  end
+end

data/lib/nanoc/toolbox/helpers/navigation.rb

@@ -18,17 +18,10 @@ module Nanoc::Toolbox::Helpers
     #
     # @param  [String]  identifier - the identifier string of the root element
     # @param  [Hash]    options - The Optional parameters
-    # @option options [Interger] :depth (3) maximum depth of the rendered menu
-    # @option options [String] :collection_tag ('ol') collection englobing tag name
-    # @option options [String] :item_tag ('li') item englobing tag name
+    # @option options (see #render_menu)
     #
     # @return [String] The output ready to be displayed by the caller
     def navigation_for(identifier, options={})
-      # Parse options or set to default values
-      options[:depth]            ||= 3
-      options[:collection_tag]   ||= 'ol'
-      options[:item_tag]         ||= 'li'
-
       # Get root item for which we need to draw the navigation
       root = @items.find { |i| i.identifier == identifier }
 
@@ -46,9 +39,7 @@ module Nanoc::Toolbox::Helpers
     #
     # @param  [String]  item_rep - the representation of desired item
     # @param  [Hash]    options - The Optional parameters
-    # @option options [Interger] :depth (3) maximum depth of the rendered menu
-    # @option options [String] :collection_tag ('ol') collection englobing tag name
-    # @option options [String] :item_tag ('li') item englobing tag name
+    # @option options (see #render_menu)
     #
     # @return [String] The output ready to be displayed by the caller
     #
@@ -57,9 +48,6 @@ module Nanoc::Toolbox::Helpers
       require 'nokogiri'
 
       # Parse options or set to default values
-      options[:depth]            ||= 3
-      options[:collection_tag]   ||= 'ol'
-      options[:item_tag]         ||= 'li'
       options[:path]             ||= 'div[@class="section"]'
 
       # Retreive the parsed content and init nokogiri
@@ -80,8 +68,7 @@ module Nanoc::Toolbox::Helpers
     #
     # @param  [String]  identifier - the identifier string of element
     # @param  [Hash]    options - The Optional parameters
-    # @option options [String] :collection_tag ('ol') collection englobing tag name
-    # @option options [String] :item_tag ('li') item englobing tag name
+    # @option options (see #render_menu)
     #
     # @return [String] The output ready to be displayed by the caller
     #
@@ -90,8 +77,7 @@ module Nanoc::Toolbox::Helpers
 
       # Parse options or set to default values
       options[:collection_tag]   ||= 'ul'
-      options[:item_tag]         ||= 'li'
-
+      
       # Retreive the breadcrumbs trail and format them
       sections = find_breadcrumbs_trail(identifier)
       render_menu(sections, options)
@@ -122,8 +108,11 @@ module Nanoc::Toolbox::Helpers
     #
     # @param  [Array]  items - The array of links that need to be rendered
     # @param  [Hash]    options - The Optional parameters
-    # @option options [String] :collection_tag ('ol') collection englobing tag name
-    # @option options [String] :item_tag ('li') item englobing tag name
+    # @option options [Interger] :depth (3) maximum depth of the rendered menu
+    # @option options [String] :collection_tag ('ol') tag englobing collection of items
+    # @option options [String] :item_tag ('li') tag englobing item
+    # @option options [String] :title_tag ('h2') tag englobing the title
+    # @option options [String] :title ('') Title of the menu, if nil will not display title
     #
     # @return [String] The output ready to be displayed by the caller
     def render_menu(items, options={})
@@ -132,7 +121,14 @@ module Nanoc::Toolbox::Helpers
       options[:depth]            ||= 3
       options[:collection_tag]   ||= 'ol'
       options[:item_tag]         ||= 'li'
-
+      options[:title_tag]        ||= 'h2'
+      options[:title]            ||= nil
+      
+      # Parse the title and remove it from the options
+      title =  options[:title] ? content_tag(options[:title_tag], options[:title]) : ''
+      options.delete(:title_tag) 
+      options.delete(:title) 
+      
       # Decrease the depth level
       options[:depth] -= 1
 
@@ -148,7 +144,8 @@ module Nanoc::Toolbox::Helpers
 
       end.join()
 
-      content_tag(options[:collection_tag], rendered_menu) unless rendered_menu.empty?
+      
+      title + content_tag(options[:collection_tag], rendered_menu) unless rendered_menu.strip.empty?
     end
 
     private
@@ -163,12 +160,11 @@ module Nanoc::Toolbox::Helpers
         # For each section found call the find_toc_sections on it with an
         # increased header level (ex: h1 => h2) and then generate the hash res
         sections = section.xpath(section_xpath).map do |subsection|
-          header = subsection.xpath("h#{title_level}").first
+          header = subsection.css("h1, h2, h3, h4, h5, h6").first
           sub_id = subsection['id']
-          sub_title = header.inner_html if header
+          sub_title = header ? header.inner_html : 'untitled'
           subsections = {}
 
-
           if subsection.xpath("#{section_xpath}") && title_level <= 6
             subsections = find_toc_sections(subsection, "#{section_xpath}", title_level+1)
           end

data/lib/nanoc/toolbox/version.rb

@@ -4,7 +4,7 @@ module Nanoc
     module Version
       MAJOR = 0
       MINOR = 0
-      PATCH = 3
+      PATCH = 4
       BUILD = nil
 
       STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join(".")

data/spec/data/filters/item_without_sections.html

@@ -0,0 +1,25 @@
+<div>
+  <h1>Title</h1>
+  
+  <h2>Sub title1</h2>
+  <p>Lorem Ipsum</p>
+  
+  <h3>Sub Sub Title1</h3>
+  <p>Lorem Ipsum</p>
+
+  <h3>Sub Sub Title2</h3>
+  <p>Lorem Ipsum</p>
+
+  <h3>Sub Sub Title3</h3>
+  <p>Lorem Ipsum</p>
+
+  
+  <h2>Sub title2</h2>
+  <p>Lorem Ipsum</p>
+
+  <h2>Sub title3</h2>
+  <p>Lorem Ipsum</p>
+  
+  <h2>Sub title4</h2>
+  <p>Lorem Ipsum</p>
+</div>

data/spec/filters/add_sections_spec.rb

@@ -0,0 +1,38 @@
+# <div>
+#   <h1>Title</h1>
+#   
+#     <h2>Sub title1</h2>
+#     <p>Lorem Ipsum</p>
+#   
+#       <h3>Sub Sub Title1</h3>
+#       <p>Lorem Ipsum</p>
+# 
+#       <h3>Sub Sub Title2</h3>
+#       <p>Lorem Ipsum</p>
+# 
+#       <h3>Sub Sub Title3</h3>
+#       <p>Lorem Ipsum</p>
+# 
+#   
+#     <h2>Sub title2</h2>
+#     <p>Lorem Ipsum</p>
+# 
+#     <h2>Sub title3</h2>
+#     <p>Lorem Ipsum</p>
+#   
+#     <h2>Sub title4</h2>
+#     <p>Lorem Ipsum</p>
+# </div>
+
+require "spec_helper"
+require "nokogiri"
+
+describe Nanoc::Toolbox::Filters::AddSections do
+  before(:each) do
+    @filter = described_class.new
+  end
+  
+  describe ".run" do
+
+  end
+end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 3
-  version: 0.0.3
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
 - Anouar ADLANI
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-12 00:00:00 +01:00
+date: 2011-01-17 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -97,6 +97,7 @@ files:
 - Rakefile
 - lib/nanoc/toolbox.rb
 - lib/nanoc/toolbox/filters.rb
+- lib/nanoc/toolbox/filters/add_sections.rb
 - lib/nanoc/toolbox/filters/html_tidy.rb
 - lib/nanoc/toolbox/helpers.rb
 - lib/nanoc/toolbox/helpers/gravatar.rb
@@ -104,6 +105,8 @@ files:
 - lib/nanoc/toolbox/helpers/navigation.rb
 - lib/nanoc/toolbox/version.rb
 - nanoc-toolbox.gemspec
+- spec/data/filters/item_without_sections.html
+- spec/filters/add_sections_spec.rb
 - spec/filters/html_tidy_spec.rb
 - spec/helpers/gravatar_spec.rb
 - spec/helpers/html_tag_spec.rb