radiant-navigation-extension 2.0.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,48 @@
+= 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
+
+= NOTES
+
+* This does not behave like the original extension and has been made to simply support calling the tag
+
+= CREDITS
+
+* Ryan Heneise
+* Marty Haught
+* Benny Degezelle

data/Rakefile

@@ -0,0 +1,137 @@
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "radiant-navigation-extension"
+    gem.summary = %Q{Navigation Generation for Radiant CMS}
+    gem.description = %Q{Navigation provides a way to generate navigation (with useful classes)}
+    gem.email = "dk@dirkkelly.com"
+    gem.homepage = "http://github.com/dirkkelly/radiant-navigation-extension"
+    gem.authors = ["Phil Schilter", "Dirk Kelly"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. This is only required if you plan to package navigation as a gem."
+end
+
+# In rails 1.2, plugins aren't available in the path until they're loaded.
+# Check to see if the rspec plugin is installed first and require
+# it if it is.  If not, use the gem version.
+
+# Determine where the RSpec plugin is by loading the boot
+unless defined? RADIANT_ROOT
+  ENV["RAILS_ENV"] = "test"
+  case
+  when ENV["RADIANT_ENV_FILE"]
+    require File.dirname(ENV["RADIANT_ENV_FILE"]) + "/boot"
+  when File.dirname(__FILE__) =~ %r{vendor/radiant/vendor/extensions}
+    require "#{File.expand_path(File.dirname(__FILE__) + "/../../../../../")}/config/boot"
+  else
+    require "#{File.expand_path(File.dirname(__FILE__) + "/../../../")}/config/boot"
+  end
+end
+
+require 'rake'
+require 'rake/rdoctask'
+require 'rake/testtask'
+
+rspec_base = File.expand_path(RADIANT_ROOT + '/vendor/plugins/rspec/lib')
+$LOAD_PATH.unshift(rspec_base) if File.exist?(rspec_base)
+require 'spec/rake/spectask'
+require 'cucumber'
+require 'cucumber/rake/task'
+
+# Cleanup the RADIANT_ROOT constant so specs will load the environment
+Object.send(:remove_const, :RADIANT_ROOT)
+
+extension_root = File.expand_path(File.dirname(__FILE__))
+
+task :default => :spec
+task :stats => "spec:statsetup"
+
+desc "Run all specs in spec directory"
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_opts = ['--options', "\"#{extension_root}/spec/spec.opts\""]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+task :features => 'spec:integration'
+
+namespace :spec do
+  desc "Run all specs in spec directory with RCov"
+  Spec::Rake::SpecTask.new(:rcov) do |t|
+    t.spec_opts = ['--options', "\"#{extension_root}/spec/spec.opts\""]
+    t.spec_files = FileList['spec/**/*_spec.rb']
+    t.rcov = true
+    t.rcov_opts = ['--exclude', 'spec', '--rails']
+  end
+  
+  desc "Print Specdoc for all specs"
+  Spec::Rake::SpecTask.new(:doc) do |t|
+    t.spec_opts = ["--format", "specdoc", "--dry-run"]
+    t.spec_files = FileList['spec/**/*_spec.rb']
+  end
+
+  [:models, :controllers, :views, :helpers].each do |sub|
+    desc "Run the specs under spec/#{sub}"
+    Spec::Rake::SpecTask.new(sub) do |t|
+      t.spec_opts = ['--options', "\"#{extension_root}/spec/spec.opts\""]
+      t.spec_files = FileList["spec/#{sub}/**/*_spec.rb"]
+    end
+  end
+  
+  desc "Run the Cucumber features"
+  Cucumber::Rake::Task.new(:integration) do |t|
+    t.fork = true
+    t.cucumber_opts = ['--format', (ENV['CUCUMBER_FORMAT'] || 'pretty')]
+    # t.feature_pattern = "#{extension_root}/features/**/*.feature"
+    t.profile = "default"
+  end
+
+  # Setup specs for stats
+  task :statsetup do
+    require 'code_statistics'
+    ::STATS_DIRECTORIES << %w(Model\ specs spec/models)
+    ::STATS_DIRECTORIES << %w(View\ specs spec/views)
+    ::STATS_DIRECTORIES << %w(Controller\ specs spec/controllers)
+    ::STATS_DIRECTORIES << %w(Helper\ specs spec/views)
+    ::CodeStatistics::TEST_TYPES << "Model specs"
+    ::CodeStatistics::TEST_TYPES << "View specs"
+    ::CodeStatistics::TEST_TYPES << "Controller specs"
+    ::CodeStatistics::TEST_TYPES << "Helper specs"
+    ::STATS_DIRECTORIES.delete_if {|a| a[0] =~ /test/}
+  end
+
+  namespace :db do
+    namespace :fixtures do
+      desc "Load fixtures (from spec/fixtures) into the current environment's database.  Load specific fixtures using FIXTURES=x,y"
+      task :load => :environment do
+        require 'active_record/fixtures'
+        ActiveRecord::Base.establish_connection(RAILS_ENV.to_sym)
+        (ENV['FIXTURES'] ? ENV['FIXTURES'].split(/,/) : Dir.glob(File.join(RAILS_ROOT, 'spec', 'fixtures', '*.{yml,csv}'))).each do |fixture_file|
+          Fixtures.create_fixtures('spec/fixtures', File.basename(fixture_file, '.*'))
+        end
+      end
+    end
+  end
+end
+
+desc 'Generate documentation for the navigation extension.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'NavigationExtension'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+# For extensions that are in transition
+desc 'Test the navigation extension.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+# Load any custom rakefiles for extension
+Dir[File.dirname(__FILE__) + '/tasks/*.rake'].sort.each { |f| require f }

data/VERSION

@@ -0,0 +1 @@
+2.0.1

data/lib/navigation/tags/core.rb

@@ -0,0 +1,116 @@
+module Navigation
+  module Tags
+    module Core
+      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"] [include_root="true"] [depth="2"] [expand_all="true"]
+        [only="^/(articles|notices)"] [except="\.(css|js|xml)/*$"] /></code></pre> 
+        *Attributes:*
+
+        * @root@ defaults to "root page", where to start building the navigation from, you can i.e. use "sexy-dresses" to build a nav under sexy dresses
+        * @include_root@ defaults to false, set to true to include the root page (i.e. Home)
+        * @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
+
+        * @only@ a string or regular expresssion. only pages whose urls match this are included
+        * @except@ a string or regular expresssion. pages whose urls match this are not shown. except will override only. use to eliminate non-content file-types
+
+        * @id@, @class@,..: go as html attributes of the outer ul
+      }
+
+      tag "nav" do |tag|
+        root_url = tag.attr.delete('root').to_s || "/"
+        root     = Page.find_by_url(root_url)
+        depth    = tag.attr.delete('depth').to_i || 1
+        tree     = ""
+        
+        raise NavTagError, "No page found at \"#{root_url}\" to build navigation from." if root.class_name.eql?('FileNotFoundPage')
+        
+        if tag.attr['include_root']
+          css_class = [("current" if tag.locals.page == root), "first"].compact
+          first_set = true
+          
+          tree << %{<li class="#{css_class.join(' ') unless css_class.empty?}" id="#{(root.slug == '/' ? 'home' : root.slug) if tag.attr['ids_for_lis']}">}
+          tree << %{<a href="#{root.url}" id="link_#{(child_page.slug == '/' ? 'home' : root.slug) if tag.attr['ids_for_links']}">}
+          tree << %{#{root.breadcrumb}}
+          tree << %{</a></li>}
+        end
+        
+        for child in root.children
+          unless Helpers.not_allowed?(tag,child)
+            depth -= 1            
+            tree  << Helpers.sub_nav(tag, child, depth, first_set)
+          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}>
+        #{tree}
+        </ul>}
+        
+      end
+      
+      # Inspired by this thread: 
+      # http://www.mail-archive.com/radiant@lists.radiantcms.org/msg03234.html
+      # Author: Marty Haught
+      desc %{
+        Renders the contained element if the current item is an ancestor of the current page or if it is the page itself. 
+      }
+      tag "if_ancestor_or_self" do |tag|
+        if tag.globals.actual_page.url.starts_with?(tag.locals.page.url)
+          tag.expand
+        end
+      end
+
+      desc %{
+        Renders the contained element if the current item is also the current page. 
+      }
+      tag "if_self" do |tag|
+        if tag.locals.page == tag.globals.page
+          tag.expand
+        end
+      end
+
+      desc %{    
+        Renders the contained elements only if the current contextual page has children.
+
+        *Usage:*
+        <pre><code><r:if_children>...</r:if_children></code></pre>
+      }
+      tag "if_children" do |tag|
+        if tag.locals.page.children.present?
+          tag.expand 
+        end
+      end
+      
+      desc %{    
+        Renders the contained elements unless the current contextual page has children.
+
+        *Usage:*
+        <pre><code><r:if_children>...</r:if_children></code></pre>
+      }
+      tag "unless_children" do |tag|
+        unless tag.locals.page.children.blank?
+          tag.expand
+        end
+      end
+      
+    end
+  end
+end

data/lib/navigation/tags/helpers.rb

@@ -0,0 +1,46 @@
+module Navigation
+  module Tags
+    class Helpers
+      class << self
+
+        def not_allowed?(tag,child_page)
+          (tag.attr['only'] and !child_page.url.match(tag.attr['only'])) or
+          (tag.attr['except'] and child_page.url.match(tag.attr['except'])) or
+          child_page.part("no-map") or child_page.virtual? or !child_page.published? or child_page.class_name.eql? "FileNotFoundPage"    
+        end
+        
+        def sub_nav(tag, child_page, depth, first_set = false)
+          current_page = tag.locals.page
+          
+          css_class = []
+          css_class << 'first' unless first_set
+          css_class << "current" if current_page == child_page
+          css_class << "has_children" if child_page.children.present?
+          css_class << "parent_of_current" if current_page.url.starts_with?(child_page.url) and current_page != child_page
+          css_class.compact!
+          
+          r =  %{<li class="#{css_class.join(' ') unless css_class.empty?}" id="nav_#{child_page.slug if tag.attr['ids_for_lis']}">}
+          r << %{<a href="#{child_page.url}" id="link_#{(child_page.slug == '/' ? 'home' : child_page.slug) if tag.attr['ids_for_links']}">}
+          r << %{#{child_page.breadcrumb}}
+          r << %{</a>}
+          
+          allowed_children = child_page.children.delete_if{ |c| not_allowed?(tag,c) }
+          
+          if tag.attr['expand_all'] or current_page.url.starts_with?(child_page.url)
+            if allowed_children.present? and depth.present? and child_page.class_name != 'ArchivePage'
+              r << %{<ul>}
+              child_page.children.each do |child|
+                depth -= 1
+                r << sub_nav(tag,child,depth,first_set)
+              end
+              r << %{</ul>}
+            end
+          end
+          
+          r << %{</li>}
+        end
+        
+      end
+    end
+  end
+end

data/lib/radiant-navigation-extension.rb

@@ -0,0 +1 @@
+# Nothing to see here

data/navigation_extension.rb

@@ -0,0 +1,13 @@
+# Uncomment this if you reference any of your controllers in activate
+# require_dependency 'application'
+
+class NavigationExtension < Radiant::Extension
+  version YAML::load_file(File.join(File.dirname(__FILE__), 'VERSION'))
+  description "Makes building navigations much easier."
+  url "http://github.com/dirkkelly/radiant-navigation-extension"
+  
+  def activate
+    Page.send :include, Navigation::Tags::Core
+  end
+  
+end

data/radiant-navigation-extension.gemspec

@@ -0,0 +1,46 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{radiant-navigation-extension}
+  s.version = "2.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Phil Schilter", "Dirk Kelly"]
+  s.date = %q{2010-11-28}
+  s.description = %q{Navigation provides a way to generate navigation (with useful classes)}
+  s.email = %q{dk@dirkkelly.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README"
+  ]
+  s.files = [
+    "CHANGELOG",
+    "LICENSE",
+    "README",
+    "Rakefile",
+    "VERSION",
+    "lib/navigation/tags/core.rb",
+    "lib/navigation/tags/helpers.rb",
+    "lib/radiant-navigation-extension.rb",
+    "navigation_extension.rb",
+    "radiant-navigation-extension.gemspec"
+  ]
+  s.homepage = %q{http://github.com/dirkkelly/radiant-navigation-extension}
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Navigation Generation for Radiant CMS}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+name: radiant-navigation-extension
+version: !ruby/object:Gem::Version 
+  hash: 13
+  prerelease: false
+  segments: 
+  - 2
+  - 0
+  - 1
+  version: 2.0.1
+platform: ruby
+authors: 
+- Phil Schilter
+- Dirk Kelly
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-28 00:00:00 +08:00
+default_executable: 
+dependencies: []
+
+description: Navigation provides a way to generate navigation (with useful classes)
+email: dk@dirkkelly.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README
+files: 
+- CHANGELOG
+- LICENSE
+- README
+- Rakefile
+- VERSION
+- lib/navigation/tags/core.rb
+- lib/navigation/tags/helpers.rb
+- lib/radiant-navigation-extension.rb
+- navigation_extension.rb
+- radiant-navigation-extension.gemspec
+has_rdoc: true
+homepage: http://github.com/dirkkelly/radiant-navigation-extension
+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 Generation for Radiant CMS
+test_files: []
+