nanoc-toolbox 0.0.1

data/.gitignore

@@ -0,0 +1,3 @@
+pkg/*
+*.gem
+.bundle

data/Gemfile

@@ -0,0 +1,4 @@
+source :gemcutter
+
+# Specify your gem's dependencies in nanoc-toolbox.gemspec
+gemspec

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

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

@@ -0,0 +1,200 @@
+module Nanoc::Toolbox::Helpers
+
+  # NANOC Helper for the Navigation related stuff.
+  # This module contains functionality for generating navigation menus for your
+  # pages, like navigation menu, breadcrumbs or a table of for a given Item
+  #
+  # @author Anouar ADLANI <anouar@adlani.com>
+  module Navigation
+    # Generate a navigation menu for a given item. 
+    # The menu will be generated form the identifier of the root. The root itself 
+    # will not be rendered. It generate the menu by parsing all the descendent of 
+    # the passed item.
+    # 
+    # @param  [String]  identifier - the identifier string of the root element
+    # @param  [Hash]    params - The Optional parameters
+    # @option params [Interger] :depth (3) maximum depth of the rendered menu
+    # @option params [String] :collection_tag ('ol') collection englobing tag name
+    # @option params [String] :item_tag ('li') item englobing tag name
+    # 
+    # @return [String] The output ready to be displayed by the caller
+    def navigation_for(identifier, params={})
+      # Parse params or set to default values
+      params[:depth]            ||= 3
+      params[:collection_tag]   ||= 'ol'
+      params[:item_tag]         ||= 'li'
+    
+      # Decrease the depth level
+      params[:depth] -= 1
+    
+      # Get root item for which we need to draw the navigation
+      root = @items.find { |i| i.identifier == identifier }
+    
+      # Do not render if there is no child
+      return nil unless root.children
+    
+      # Find all sections, and render them
+      sections = find_item_tree(root)
+      render_menu(sections, params)
+    end
+  
+  
+    # Generate a Table of Content for a given item. The toc will be generated
+    # form the item content. The parsing is done with Nokogiri through XPath.
+    # By default this helper method await for the following structure
+    # 
+    # @param  [String]  identifier - the identifier string of the root element
+    # @param  [Hash]    params - The Optional parameters
+    # @option params [Interger] :depth (3) maximum depth of the rendered menu
+    # @option params [String] :collection_tag ('ol') collection englobing tag name
+    # @option params [String] :item_tag ('li') item englobing tag name
+    # 
+    # @return [String] The output ready to be displayed by the caller
+    #
+    # @see http://nokogiri.org/
+    def toc_for(item_rep, params={})
+      require 'nokogiri'
+
+      # Parse params or set to default values
+      params[:depth]            ||= 3
+      params[:collection_tag]   ||= 'ol'
+      params[:item_tag]         ||= 'li'
+      params[:path]             ||= 'div[@class="section"]'
+      params[:class]            ||= 'toc'
+    
+      # Retreive the parsed content and init nokogiri
+      compiled_content = @item_rep.instance_eval { @content[:pre] }
+      doc = Nokogiri::HTML(compiled_content)
+      doc_root = doc.xpath('/html/body').first
+    
+      # Find all sections, and render them
+      sections = find_toc_sections(doc_root, "#{params[:path]}", 2)
+      render_menu(sections, params)
+    end
+  
+  
+    # Generate a Breadcrumb for a given item. The breadcrumbs, is starting with 
+    # the root item and ending with the item itself. 
+    #
+    # Requires the Helper: Nanoc3::Helpers::Breadcrumbs
+    # 
+    # @param  [String]  identifier - the identifier string of element
+    # @param  [Hash]    params - The Optional parameters
+    # @option params [String] :collection_tag ('ol') collection englobing tag name
+    # @option params [String] :item_tag ('li') item englobing tag name
+    # 
+    # @return [String] The output ready to be displayed by the caller
+    #
+    # @see Nanoc3::Helpers::Breadcrumbs#breadcrumbs_for_identifier
+    def breadcrumb_for(identifier, params={})
+    
+      # Parse params or set to default values
+      params[:collection_tag]   ||= 'ul'
+      params[:item_tag]         ||= 'li'
+    
+      # Retreive the breadcrumbs trail and format them
+      sections = find_breadcrumbs_trail(identifier)
+      render_menu(sections, params)
+    end
+  
+    # Render a Hash to a HTML List by default
+    #
+    # Hash like :
+    #   [{:title => 'Title', :link => 'http://example.com', :subsections =>  [{}, {}, ...]},{...}]
+    #
+    # Results to an output like the following (by default):
+    #   <ul>
+    #     <li>
+    #       <a href="http://example.com">Title</a>
+    #       <ul>
+    #         <li><a href="">Title</a></li>
+    #       </ul>
+    #     </li>
+    #     <li><a href="http://example.com">Title</a></li>
+    #     <li><a href="http://example.com">Title</a></li>
+    #   </ul>
+    #
+    # @param  [Array]  items - The array of links that need to be rendered
+    # @param  [Hash]    params - The Optional parameters
+    # @option params [String] :collection_tag ('ol') collection englobing tag name
+    # @option params [String] :item_tag ('li') item englobing tag name
+    # 
+    # @return [String] The output ready to be displayed by the caller
+    def render_menu(items, params={})
+
+      # Parse params or set to default values
+      params[:depth]            ||= 3
+      params[:collection_tag]   ||= 'ol'
+      params[:item_tag]         ||= 'li'
+    
+      # Decrease the depth level
+      params[:depth] -= 1
+    
+      out = items.map { |item|
+        output = ""
+      
+        # Render only if there is depth left
+        if params[:depth].to_i  >= 0 && item[:subsections] && item[:subsections]
+          output = render_menu(item[:subsections], params) 
+          params[:depth] += 1 # Increase the depth level after the call of navigation_for
+        end
+        content_tag(params[:item_tag], link_to(item[:title], item[:link]) + output)
+      }
+      content_tag(params[:collection_tag], out.join())
+    end
+  
+    private
+
+      # Helper method that wrap a content within an HTML Tag
+      def content_tag(name, content="", &block)
+        "<#{name}>#{content}</#{name}>"
+      end
+    
+      # Recursive method that extract from an XPath pattern the document structure 
+      # and return the "permalinks" to each sections in an Array of Hash that 
+      # could be used by the rendering method. The structure is deducted by the 
+      # H1-6 header within the html element defined by the XPATH
+      def find_toc_sections(section, section_xpath, title_level=1)
+        return {} unless section.xpath(section_xpath)
+      
+        sections = section.xpath(section_xpath).map do |subsection|
+          header = subsection.xpath("h#{title_level}").first
+          sub_id = subsection['id']
+          sub_title = header.inner_html if header
+          subsections = {}
+          if subsection.xpath("#{section_xpath}") && title_level <= 6
+            subsections = find_toc_sections(subsection, "#{section_xpath}", title_level+1)
+          end
+          { :title => sub_title, :link => '#'+sub_id, :subsections =>  subsections }
+        end
+        sections
+      end
+    
+      # Recursive method that extract from an XPath pattern the document structure 
+      # and return the "permalinks" in a Array of Hash that could be used by the 
+      # rendering method
+      def find_item_tree(root)
+        return nil unless root.children
+      
+        # For each child call the find_item_tree on it and then render the generate the hash
+        sections = root.children.map do |child|
+          subsections = find_item_tree(child) 
+
+          { :title        => (child[:short_title] || child[:title] || child.identifier), 
+            :link         => relative_path_to(child),
+            :subsections  => subsections }
+        end
+        sections
+      end
+    
+      def find_breadcrumbs_trail(root)      
+        sections = breadcrumbs_for_identifier(root).map do |child|
+
+          { :title        => (child[:short_title] || child[:title] || child.identifier), 
+            :link         => relative_path_to(child),
+            :subsections  => nil }
+          
+        end
+      end
+  end
+end

data/lib/nanoc/toolbox/helpers.rb

@@ -0,0 +1,5 @@
+require 'nanoc/toolbox/helpers/navigation'
+
+module Nanoc::Toolbox::Helpers
+
+end

data/lib/nanoc/toolbox/version.rb

@@ -0,0 +1,5 @@
+module Nanoc
+  module Toolbox
+    VERSION = "0.0.1"
+  end
+end

data/lib/nanoc/toolbox.rb

@@ -0,0 +1,7 @@
+require 'nanoc/toolbox/version'
+require 'nanoc/toolbox/helpers'
+module Nanoc
+  module Toolbox
+    # Your code goes here...
+  end
+end

data/nanoc-toolbox.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path("../lib/nanoc/toolbox/version", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "nanoc-toolbox"
+  s.version     = Nanoc::Toolbox::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Anouar ADLANI"]
+  s.email       = ["anouar@adlani.com"]
+  s.homepage    = "http://rubygems.org/gems/nanoc-tools"
+  s.summary     = "A collection of helper and filters for nanoc"
+  s.description = ""
+  
+
+  s.required_rubygems_version = ">= 1.3.6"
+  s.rubyforge_project         = "nanoc-toolbox"
+
+  s.add_dependency "nanoc", ">= 3.1.6"
+  
+  s.add_development_dependency "bundler", ">= 1.0.0"
+
+  s.files        = `git ls-files`.split("\n")
+  s.executables  = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact
+  s.require_path = 'lib'
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification 
+name: nanoc-toolbox
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Anouar ADLANI
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-06 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: nanoc
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 1
+        - 6
+        version: 3.1.6
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  version_requirements: *id002
+description: ""
+email: 
+- anouar@adlani.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Rakefile
+- lib/nanoc/toolbox.rb
+- lib/nanoc/toolbox/helpers.rb
+- lib/nanoc/toolbox/helpers/navigation.rb
+- lib/nanoc/toolbox/version.rb
+- nanoc-toolbox.gemspec
+has_rdoc: true
+homepage: http://rubygems.org/gems/nanoc-tools
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: nanoc-toolbox
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A collection of helper and filters for nanoc
+test_files: []
+