navigasmic 0.1.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Jeremy Jackson
+
+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, sublicense, 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 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
+NONINFRINGEMENT. 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.textile

@@ -0,0 +1,203 @@
+h1. Navigasmic
+
+Semantic navigation; a semantic way to build beautifully simple navigation structures in Rails.
+
+h2. The Story
+
+Most of the navigation styles I've done over the years pretty much boil down to this idea: Use simple markup, and do the rest with css (and javascript if you need it).  So, yeah, the default markup is beautifully simple (UL and LI tags).
+
+I wanted something that allowed for customization and ended up deciding that Rails forms outline that nicely.  With some ideas taken from formtastic, I setup navigasmic to work a lot like how Rails forms work, in that it uses builders.  For example, there are two builders that are provided (HTML for ERB, HAML, etc. and XML for ERB, Builder, etc), and these builders can be extended or replaced if you need more custom markup.
+
+Currently the HTML builder generates UL and LI tags, which helps with SEO, and the XML builder generates tags that can be used for XML site maps.
+
+h2. Installation
+
+The gem is hosted on gemcutter, so *if you haven't already*, add it as a gem source:
+
+<pre>
+  sudo gem sources -a http://gemcutter.org/
+</pre>
+
+Then install the navigasmic gem:
+
+<pre>
+  sudo gem install navigasmic
+</pre>
+
+h2. Usage
+
+h3. HAML
+  
+*Simple Usage*
+
+<pre>
+  - semantic_navigation :main do |n|
+    = n.group 'Media', :html => {:class => 'media'} do
+      = n.item 'Image Gallery', :link => {:controller => 'media/images'}
+      = n.item 'Videos', :link => {:controller => 'media/videos'}
+    = n.group 'Info' do
+      = n.item 'About Us', :link => '/about_us', :html => {:title => 'we are the coolest'}
+      = n.item 'Nothing Here'
+</pre>
+  ...produces...
+<pre>
+  <ul id="main" class="semantic-navigation">
+    <li class="media with-group">
+      <span>Media<span>
+      <ul>
+        <li id="image_gallery"><a href="/media/images"><span>Image Gallery</span></a></li>
+        <li id="videos"><a href="/media/videos"><span>Videos</span></a></li>
+      </ul>
+    </li>
+    <li class="with-group">
+      <span>Info<span>
+      <ul>
+        <li id="about_us" title="we are the coolest"><a href="/about_us/"><span>About Us</span></a></li>
+        <li id="videos"><span>Nothing Here</span></li>
+      </ul>
+    </li>
+  </ul>
+</pre>
+
+*Nesting of items and additional markup*
+
+<pre>
+  - semantic_navigation :main, :html => { :class => 'primary' } do |n|
+    = n.group 'Media' do
+      = n.item 'Image Gallery', :link => {:controller => 'media/images', :action => 'index'}
+      = n.item 'Videos', :link => {:controller => 'media/videos'}
+    .secondary
+      = n.group 'Info' do
+        = n.item 'About Us', :link => '/about_us' do
+          %ul
+            = n.item 'Nothing Here'
+</pre>
+  ...produces...
+<pre>
+  <ul id="main" class="primary semantic-navigation">
+    <li id="media" class="with-group">
+      <span>Media</span>
+      <ul>
+        <li id="image_gallery"><a href="/media/images"><span>Image Gallery</span></a></li>
+        <li id="videos"><a href="/media/videos"><span>Videos</span></a></li>
+      </ul>
+    </li>
+    <div class="secondary">
+      <li id="info" class="with-group">
+        <span>Info</span>
+        <ul>
+          <li id="about_us">
+            <a href="/about_us"><span>About Us</span></a>
+            <ul>
+              <li id="nothing_here"><span>Nothing Here</span></li>
+            </ul>
+          </li>
+        </ul>
+      </li>
+    </div>
+  </ul>
+</pre>
+
+*Highlighting* -- highlights on the media controller (or any that inherit from it), on the /images path, and on mondays
+
+<pre>
+  - semantic_navigation :main do
+    = n.item 'Image Gallery', :link => 'media/images'
+            :highlights_on => [{:controller => 'media'}, '/images', proc { Time.now.wday == 1 }]
+</pre>
+  ...produces
+<pre>
+  <ul id="main" class="semantic-navigation">
+    <li id="image_gallery" class="highlighted"><a href="/media/images"><span>Image Gallery</span></a></li>
+  </ul>
+</pre>
+
+*Disabling* -- disabled on tuesdays, and when not logged in
+
+<pre>
+  - semantic_navigation :main do
+    = n.item 'Image Gallery', :link => 'media/images'
+            :disabled_if => proc { Time.now.wday == 2 || !logged_in? }
+</pre>
+  ...produces
+<pre>
+  <ul id="main" class="semantic-navigation">
+    <li id="image_gallery" class="disabled"><span>Image Gallery</span></li>
+  </ul>
+</pre>
+
+h3. ERB
+
+*Nesting of items and additional markup*
+
+<pre>
+  <% semantic_navigation :main, :html => { :class => 'primary' } do |n| %>
+    <%= n.group 'Media' do %>
+      <%= n.item 'Image Gallery', :link => {:controller => 'media/images', :action => 'index'} %>
+      <%= n.item 'Videos', :link => {:controller => 'media/videos'} %>
+    <% end %>
+    <div class="secondary">
+      <%= n.group 'Info' do %>
+        <%= n.item 'About Us', :link => '/about_us' do %>
+          <ul><%= n.item 'Nothing Here' %></ul>
+        <% end %>
+      <% end %>
+    </div>
+  <% end %>
+</pre>
+  ...produces...
+<pre>
+  <ul id="main" class="primary semantic-navigation">
+    <li id="media" class="with-group">
+      <span>Media</span>
+      <ul>
+        <li id="image_gallery"><a href="/media/images"><span>Image Gallery</span></a></li>
+        <li id="videos"><a href="/media/videos"><span>Videos</span></a></li>
+      </ul>
+    </li>
+    <div class="secondary">
+      <li id="info" class="with-group">
+        <span>Info</span>
+        <ul>
+          <li id="about_us">
+            <a href="/about_us"><span>About Us</span></a>
+            <ul>
+              <li id="nothing_here"><span>Nothing Here</span></li>
+            </ul>
+          </li>
+        </ul>
+      </li>
+    </div>
+  </ul>  
+</pre>
+
+h3. XML
+
+<pre>
+...Still working on the xml builder...
+</pre>
+
+h3. Other
+
+You can always create your own builder by extending one of the existing ones, or creating one from scratch.
+
+Then just specify your builder, or do it as a configuration.
+
+@semantic_navigation :main, :builder => MyCustomBuilder do@
+
+@Navigasmic::SemanticNavigationHelper.builder = MyCustomBuilder@
+
+h2. Documentation
+
+RDoc documentation _should_ be automatically generated after each commit and made available on the "rdoc.info website":http://rdoc.info/projects/jejacks0n/navigasmic.
+
+h2. Compatibility
+
+I'm only testing with the latest Rails 2.4.x stable release, and it should work under Rails 2.3.x as well.  Feel free to add backwards compatibility if you need it.
+
+h2. Project Info
+
+Navigasmic is hosted on Github: "http://github.com/jejacks0n/navigasmic":http://github.com/jejacks0n/navigasmic, and the gem is available on Gemcutter: "http://gemcutter.org/navigasmic":http://gemcutter.org/navigasmic
+
+
+Copyright (c) Jeremy Jackson, released under the MIT license.

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "navigasmic"
+    gem.summary = %Q{Semantic navigation for Rails}
+    gem.description = %Q{Semantic navigation; a semantic way to build beautifully simple navigation structures in Rails.}
+    gem.email = "jejacks0n@gmail.com"
+    gem.homepage = "http://github.com/jejacks0n/navigasmic"
+    gem.authors = ["Jeremy Jackson"]
+    gem.add_development_dependency "thoughtbot-shoulda"
+    # 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. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "navigasmic #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/lib/builders/html_builder.rb

@@ -0,0 +1,62 @@
+module Navigasmic
+  class HtmlNavigationBuilder
+
+    @@classnames = {
+      :with_group => 'with-group',
+      :disabled => 'disabled',
+      :highlighted => 'highlighted'
+    }
+
+    attr_accessor :template, :name, :items
+
+    def initialize(template, name, options = {}, &proc)
+      @template, @name, @items = template, name.to_s, options, []
+      render(options.delete(:html), &proc)
+    end
+
+    def render(options, &proc)
+      buffer = template.capture(self, &proc)
+      template.concat(template.content_tag(:ul, buffer, options))
+    end
+
+    def group(label = nil, options = {}, &proc)
+      raise ArgumentError, "Missing block" unless block_given?
+
+      options[:html] ||= {}
+      options[:html][:class] = template.add_class(options[:html][:class], @@classnames[:with_group])
+      options[:html][:id] ||= label.to_s.gsub(/\s/, '_').underscore
+
+      buffer = template.capture(self, &proc)
+      group = template.content_tag(:ul, buffer)
+      label = label_for_group(label) unless label.blank?
+
+      template.content_tag(:li, label.to_s + group, options.delete(:html))
+    end
+
+    def item(label, options = {}, &proc)
+      buffer = block_given? ? template.capture(self, &proc) : ''
+
+      item = NavigationItem.new(label, options)
+
+      options[:html] ||= {}
+      options[:html][:id] ||= label.to_s.gsub(/\s/, '_').underscore
+
+      options[:html][:class] = template.add_class(options[:html][:class], @@classnames[:disabled]) if item.disabled?
+      options[:html][:class] = template.add_class(options[:html][:class], @@classnames[:highlighted]) if item.highlighted?(template.request.path, template.params)
+
+      label = label_for_item(label)
+      label = template.link_to(label, item.link) unless item.link.empty?
+
+      template.content_tag(:li, label + buffer, options.delete(:html))
+    end
+
+    def label_for_group(label)
+      template.content_tag(:span, label.to_s)
+    end
+
+    def label_for_item(label)
+      template.content_tag(:span, label.to_s)
+    end
+
+  end
+end

data/lib/builders/xml_builder.rb

@@ -0,0 +1,62 @@
+module Navigasmic
+  class XmlNavigationBuilder
+
+    @@classnames = {
+      :with_group => 'with-group',
+      :disabled => 'disabled',
+      :highlighted => 'highlighted'
+    }
+
+    attr_accessor :template, :name, :items
+
+    def initialize(template, name, options = {}, &proc)
+      @template, @name, @items = template, name.to_s, options, []
+      render(options.delete(:html), &proc)
+    end
+
+    def render(options, &proc)
+      buffer = template.capture(self, &proc)
+      template.concat(template.content_tag(:ol, buffer, options))
+    end
+
+    def group(label = nil, options = {}, &proc)
+      raise ArgumentError, "Missing block" unless block_given?
+
+      options[:html] ||= {}
+      options[:html][:class] = template.add_class(options[:html][:class], @@classnames[:with_group])
+      options[:html][:id] ||= label.to_s.gsub(/\s/, '_').underscore
+
+      buffer = template.capture(self, &proc)
+      group = template.content_tag(:ol, buffer)
+      label = label_for_group(label) unless label.blank?
+
+      template.content_tag(:li, label.to_s + group, options.delete(:html))
+    end
+
+    def item(label, options = {}, &proc)
+      buffer = block_given? ? template.capture(self, &proc) : ''
+
+      item = NavigationItem.new(label, options)
+
+      options[:html] ||= {}
+      options[:html][:id] ||= label.to_s.gsub(/\s/, '_').underscore
+
+      options[:html][:class] = template.add_class(options[:html][:class], @@classnames[:disabled]) if item.disabled?
+      options[:html][:class] = template.add_class(options[:html][:class], @@classnames[:highlighted]) if item.highlighted?(template.request.path, template.params)
+
+      label = label_for_item(label)
+      label = template.link_to(label, item.link) unless item.link.empty?
+
+      template.content_tag(:li, label + buffer, options.delete(:html))
+    end
+
+    def label_for_group(label)
+      template.content_tag(:span, label.to_s)
+    end
+
+    def label_for_item(label)
+      template.content_tag(:span, label.to_s)
+    end
+
+  end
+end

data/lib/navigasmic.rb

@@ -0,0 +1,126 @@
+# coding: utf-8
+require File.join(File.dirname(__FILE__), *%w[builders html_builder])
+require File.join(File.dirname(__FILE__), *%w[builders xml_builder])
+
+module Navigasmic #:nodoc:
+
+  # Semantic navigation helper methods
+  #
+  # Example Usage:
+  #
+  #   <% semantic_navigation :primary, :html => {:class => 'primary'} do |n| %>
+  #     <%= n.item 'Blog Posts', :link => {:controller => 'posts'} %>
+  #   <% end %>
+  #
+  #   <% semantic_navigation :primary, :builder => MyCustomBuilder do |n| %>
+  #     <%= n.group 'My Thoughts' do %>
+  #       <%= n.item 'Blog Posts', :link => {:controller => 'posts'} %>
+  #     <% end %>
+  #   <% end %>
+  #
+  #   <% semantic_navigation :primary do |n| %>
+  #     <%= n.group 'My Thoughts' do %>
+  #       <%= n.item 'Blog Posts', :link => {:controller => 'posts'} do %>
+  #         <ul>
+  #           <%= n.item 'Recent Posts', :link => {:controller => 'posts', :action => 'recent'} %>
+  #         </ul>
+  #       <% end %>
+  #     <% end %>
+  #   <% end %>
+  module SemanticNavigationHelper
+
+    @@builder = ::Navigasmic::HtmlNavigationBuilder
+    mattr_accessor :builder
+
+    def semantic_navigation(name, *args, &proc)
+      raise ArgumentError, "Missing block" unless block_given?
+
+      options = args.extract_options!
+      
+      options[:html] ||= {}
+      options[:html][:class] = add_class(options[:html][:class], 'semantic-navigation')
+      options[:html][:id] ||= name.to_s.underscore
+
+      builder = options[:builder] || HtmlNavigationBuilder
+      builder.new(@template, name, options, &proc)
+    end
+
+    def add_class(classnames, classname)
+      out = (classnames.is_a?(String) ? classnames.split(' ') : []) << classname
+      out.join(' ')
+    end
+
+  end
+  
+  #
+  #
+  #
+  #
+  #
+  class NavigationItem
+
+    attr_accessor :label, :link
+
+    def initialize(label, options = {})
+      @label = label
+      @link = options[:link] || {}
+
+      @disabled_conditions = options[:disabled_if] || proc { false }
+
+      options[:highlights] = [options[:highlights]] if options[:highlights].kind_of?(Hash)
+      @highlights_on = options[:highlights] || []
+      @highlights_on << @link if link?
+    end
+
+    def link?
+      @link && !@link.empty?
+    end
+
+    def disabled?
+      @disabled_conditions.call
+    end
+
+    def highlighted?(path, params = {})
+      params = clean_unwanted_keys(params)
+      result = false
+
+      @highlights_on.each do |highlight|
+        highlighted = true
+
+        case highlight
+        when String
+          highlighted &= path == highlight
+        when Proc
+          h = highlight.call
+          raise 'proc highlighting rules must evaluate to TrueClass or FalseClass' unless (h.is_a?(TrueClass) || h.is_a?(FalseClass))
+          highlighted &= h
+        when Hash
+          h = clean_unwanted_keys(highlight)
+          h.each_key do |key|
+            h_key = h[key].to_s.dup
+            h_key.gsub!(/^\//, '') if key == :controller
+            highlighted &= h_key == params[key].to_s
+          end
+        else
+          raise 'highlighting rules should be a String, Proc or a Hash'
+        end
+
+        result |= highlighted
+      end
+
+      return result
+    end
+
+    private
+
+    # removes unwanted keys from a Hash and returns a new hash
+    def clean_unwanted_keys(hash)
+      ignored_keys = [:only_path, :use_route]
+      hash.dup.delete_if { |key, value| ignored_keys.include?(key) }
+    end
+
+  end
+
+end
+
+ActionController::Base.helper Navigasmic::SemanticNavigationHelper

data/navigasmic.gemspec

@@ -0,0 +1,55 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{navigasmic}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jeremy Jackson"]
+  s.date = %q{2010-01-09}
+  s.description = %q{Semantic navigation; a semantic way to build beautifully simple navigation structures in Rails.}
+  s.email = %q{jejacks0n@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.textile"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.textile",
+     "Rakefile",
+     "VERSION",
+     "lib/builders/html_builder.rb",
+     "lib/builders/xml_builder.rb",
+     "lib/navigasmic.rb",
+     "navigasmic.gemspec",
+     "test/navigasmic_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/jejacks0n/navigasmic}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Semantic navigation for Rails}
+  s.test_files = [
+    "test/navigasmic_test.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+  end
+end

data/test/navigasmic_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class NavigasmicTest < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'navigasmic'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: navigasmic
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+platform: ruby
+authors: 
+- Jeremy Jackson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-09 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Semantic navigation; a semantic way to build beautifully simple navigation structures in Rails.
+email: jejacks0n@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.textile
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.textile
+- Rakefile
+- VERSION
+- lib/builders/html_builder.rb
+- lib/builders/xml_builder.rb
+- lib/navigasmic.rb
+- navigasmic.gemspec
+- test/navigasmic_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/jejacks0n/navigasmic
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Semantic navigation for Rails
+test_files: 
+- test/navigasmic_test.rb
+- test/test_helper.rb