radiant-navigation_tags-extension 0.2.1

data/CHANGELOG

@@ -0,0 +1,8 @@
+[Tuesday; October 9, 2007]
+
+Added 3 optional parameters; "root", "include_root" and "depth"
+- By default, root is still "/", otherwise you can use this to build sub-nav's
+- You can still include the root_page by setting include_root to true
+- Default depth is 1, which means no sub-ul's
+
+Thanks for the patch: Benny Degezelle

data/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2007 Ryan Heneise (http://www.artofmission.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sub-license, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice, and every other copyright notice found in this 
+software, and all the attributions in every file, and this permission notice 
+shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+

data/README

@@ -0,0 +1,44 @@
+= Navigation Tags
+
+Provides hierarchical tree navigation based on Radiant's site structure. Outputs navigation in the form of a -very flexible and CSS'able- unordered list. Also provides r:if_self and r:if_ancestor_or_self
+
+== Usage
+
+  <r:nav [root="/"] [include_root="true"] [depth="2"] [expand_all="true"] [ids_for_lis="true"] />
+
+  Given this directory tree: 
+
+   * Home
+   ** About
+   *** Contact us
+   ** Blog
+   *** First Article
+   *** Second Article
+   ** Catalog
+
+  <r:nav /> would output a navigation list like: 
+
+  <ul>
+    <li class="parent_of_current has_children"><a href="/about/">About</a>
+      <ul>
+        <li class="current"><a href="/about/contact">Contact Us</a></li>
+      </ul>
+    </li>
+    <li class="has_children"><a href="/blog/">Blog</a></li>
+    <li class="has_children"><a href="/catalogue">Catalogue</a></li>
+  </ul>
+
+  == Available tag attributes:
+
+  * ids_for_lis: 	defaults to false, 			enable this to give each li an id (it's slug)
+  * root: 		defaults to "/", 	          which page to start building the navigation from
+  * include_root: defaults to false, 		  set to true to include the root page (i.e. Home)
+  * depth: 		defaults to 2,				      which will print out the first two levels of pages.
+  * expand_all: 	defaults to false, 			enable this to have all li's create sub-ul's of their children, i.o. only the currently active li
+  * id, class, monkeyballs, ... 	        will be used as html attributes for the ul
+
+= CREDITS
+
+* Ryan Heneise
+* Marty Haught
+* Benny Degezelle

data/Rakefile

@@ -0,0 +1,41 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the navigation_tags extension.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the navigation_tags extension.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'NavigationTagsExtension'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+# Load any custom rakefiles for extension
+Dir[File.dirname(__FILE__) + '/tasks/*.rake'].sort.each { |f| require f }
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "radiant-navigation_tags-extension"
+    gem.summary = %Q{Navigation tags extension for Radiant CMS}
+    gem.description = %Q{Adds r:nav, a versatile navigation building tag to Radiant CMS}
+    gem.email = "benny@gorilla-webdesign.be"
+    gem.homepage = "https://github.com/jomz/navigation_tags"
+    gem.authors = ["Benny Degezelle"]
+    gem.add_dependency 'radiant', ">=0.9.1"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. This is only required if you plan to package copy_move as a gem."
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.1

data/lib/navigation_tags.rb

@@ -0,0 +1,135 @@
+module NavigationTags
+  include Radiant::Taggable
+  include ActionView::Helpers::TagHelper
+
+  class NavTagError < StandardError; end
+
+  desc %{Render a navigation menu. Walks down the directory tree, expanding the tree up to the current page.
+
+    *Usage:*
+    <pre><code><r:nav [id="subnav"] [root=\"/products\"] [append_urls=\"/,/about-us/contact\"] [depth=\"2\"] [expand_all=\"true\"]/></code></pre> 
+    *Attributes:*
+
+    root: defaults to "/", where to start building the navigation from, you can i.e. use "/products" to build a subnav
+    append_urls: urls of pages to add to the end of the navigation ul seperated by a comma
+    prepend_urls: urls of pages to add to the beginning of the navigation ul seperated by a comma
+    ids_for_lis: defaults to false, enable this to give each li an id (it's slug prefixed with nav_)
+    ids_for_links: defaults to false, enable this to give each link an id (it's slug prefixed with nav_)
+
+    depth: defaults to 1, which means no sub-ul's, set to 2 or more for a nested list
+    expand_all: defaults to false, enable this to have all li's create sub-ul's of their children, i.o. only the currently active li
+    id, class,..: go as html attributes of the outer ul
+  }
+
+  tag "nav" do |tag|
+    if tag.double?
+      root = Page.find_by_path(tag.expand)
+    elsif defined?(Globalize2Extension) && Globalize2Extension.locales.size > 1
+      root = Page.find_by_path(root_url = tag.attr.delete('root') || "/#{I18n.locale}")
+    else
+      root = Page.find_by_path(root_url = tag.attr.delete('root') || "/")
+    end
+
+    raise NavTagError, "No page found at \"#{root_url}\" to build navigation from." if root.class_name.eql?('FileNotFoundPage')
+
+    depth = tag.attr.delete('depth') || 1
+    ['ids_for_lis', 'ids_for_links', 'expand_all', 'first_set', 'prepend_urls', 'append_urls'].each do |prop|
+      eval "@#{prop} = tag.attr.delete('#{prop}') || false"
+    end
+    
+    lis = []
+    
+    if @prepend_urls
+      @prepend_urls.split(",").compact.each do |url|
+        page = Page.find_by_path(url)
+        if page.class_name != "FileNotFoundPage"
+          lis << li_for_current_page_vs_navigation_item(tag.locals.page, page)
+        end
+      end
+    end
+
+    for child in root.children
+      lis << tag.render('sub-nav', {:page => child, :depth => depth.to_i - 1, :first_set => @first_set })
+    end
+    
+    if @append_urls
+      @append_urls.split(",").compact.each do |url|
+        page = Page.find_by_path(url)
+        if page.class_name != "FileNotFoundPage"
+          lis << li_for_current_page_vs_navigation_item(tag.locals.page, page)
+        end
+      end
+    end
+
+    if tag.attr
+      html_options = tag.attr.stringify_keys
+      tag_options = tag_options(html_options)
+    else
+      tag_options = nil
+    end
+
+    %{<ul#{tag_options}>
+    #{lis.join}
+    </ul>}
+
+  end
+
+  tag "sub-nav" do |tag|
+    current_page = tag.locals.page
+    child_page = tag.attr[:page]
+    @depth ||= tag.attr.delete(:depth)
+    @first_set ||= tag.attr.delete(:first_set)
+    return if @depth < 0 or child_page.virtual? or !child_page.published? or child_page.class_name.eql? "FileNotFoundPage" or child_page.part("no-map")
+    
+    r = %{<li#{li_attrs_for_current_page_vs_navigation_item(current_page, child_page)}>
+      #{link_for_page(child_page)}\n}
+      # mind the open li
+    rr = ""
+    if child_page.children.size > 0 and 
+        @depth.to_i > 0 and
+        child_page.class_name != 'ArchivePage' and
+        (@expand_all || current_page.url.starts_with?(child_page.url) )
+      @first_set = false
+      child_page.children.each do |child|
+        rr << tag.render('sub-nav', :page => child, :depth => @depth.to_i - 1, :first_set => @first_set ) unless child.part("no-map") || !child.published?
+      end
+      
+      r << "<ul>\n" + rr + "</ul>\n" unless rr.empty?
+    end
+    r << "</li>\n"
+  end
+
+  def li_attrs_for_current_page_vs_navigation_item current_page, child_page
+    classes = [
+      ("current" if current_page == child_page),
+      ("has_children" if child_page.children.size > 0),
+      ("parent_of_current" if current_page.url.starts_with?(child_page.url) and current_page != child_page)
+    ]
+    if !@first_set
+      classes << "first"
+      @first_set = true
+    end
+    
+    result = ""
+    if classes.any?
+      result = " class=\"#{classes.compact.join(" ")}\""
+    end
+    if @ids_for_lis
+      result << " id=\"nav_" + child_page.slug + "\""
+    end
+    result
+  end
+  
+  def li_for_current_page_vs_navigation_item current_page, child_page
+    "<li#{li_attrs_for_current_page_vs_navigation_item(current_page, child_page)}>#{link_for_page(child_page)}</li>"
+  end
+  
+  def link_for_page page
+    if @ids_for_links
+      "<a href=\"#{page.url}\" id=\"#{("link_" + (page.slug == "/" ? 'home' : page.slug))}\">#{escape_once(page.breadcrumb)}</a>"
+    else
+      "<a href=\"#{page.url}\">#{escape_once(page.breadcrumb)}</a>"
+    end
+  end
+
+end

data/lib/tasks/navigation_tags_extension_tasks.rake

@@ -0,0 +1,17 @@
+namespace :radiant do
+  namespace :extensions do
+    namespace :navigation_tags do
+      
+      desc "Runs the migration of the Navigation Tags extension"
+      task :migrate => :environment do
+        require 'radiant/extension_migrator'
+        if ENV["VERSION"]
+          NavigationTagsExtension.migrator.migrate(ENV["VERSION"].to_i)
+        else
+          NavigationTagsExtension.migrator.migrate
+        end
+      end
+    
+    end
+  end
+end

data/navigation_tags_extension.rb

@@ -0,0 +1,10 @@
+class NavigationTagsExtension < Radiant::Extension
+  version "2.1"
+  description "Makes building navigations much easier."
+  url "https://github.com/jomz/navigation_tags"
+    
+  def activate
+    Page.send :include, NavigationTags
+  end
+  
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification 
+name: radiant-navigation_tags-extension
+version: !ruby/object:Gem::Version 
+  hash: 21
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 1
+  version: 0.2.1
+platform: ruby
+authors: 
+- Benny Degezelle
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-29 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: radiant
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 57
+        segments: 
+        - 0
+        - 9
+        - 1
+        version: 0.9.1
+  type: :runtime
+  version_requirements: *id001
+description: Adds r:nav, a versatile navigation building tag to Radiant CMS
+email: benny@gorilla-webdesign.be
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README
+files: 
+- CHANGELOG
+- LICENSE
+- README
+- Rakefile
+- VERSION
+- lib/navigation_tags.rb
+- lib/tasks/navigation_tags_extension_tasks.rake
+- navigation_tags_extension.rb
+has_rdoc: true
+homepage: https://github.com/jomz/navigation_tags
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Navigation tags extension for Radiant CMS
+test_files: []
+