happy-nav 0.1.0

data/.document

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

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Andy Pearson
+
+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.rdoc

@@ -0,0 +1,17 @@
+= happy-nav
+
+Happy Nav is the easy (and cheerful) way to create structured HTML for you site navigation.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Andy Pearson. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,46 @@
+require 'rubygems'
+require 'rake'
+require 'rspec/core/rake_task'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "happy-nav"
+    gem.summary = %Q{Happy Nav is the easy (and cheerful) way to create structured HTML for your site navigation.}
+    gem.description = %Q{Happy Nav is the easy (and cheerful) way to create structured HTML for your site navigation.}
+    gem.email = "andy@andy-pearson.com"
+    gem.homepage = "http://github.com/andypearson/happy-nav"
+    gem.authors = ["Andy Pearson"]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+desc 'Test the happ-nav plugin.'
+RSpec::Core::RakeTask.new('spec') do |t|
+  t.pattern = FileList['spec/**/*_spec.rb']
+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
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "happy-nav #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/happy-nav/navigation_presenter.rb

@@ -0,0 +1,137 @@
+class NavigationPresenter
+  
+  include ActionView::Helpers::TagHelper
+  
+  attr_accessor :items, :options
+  
+  def initialize(items = [], options = {}, current_items = [])
+    @items = items
+    @options = options
+    @current_items = current_items
+  end
+  
+  def to_html
+    unless @items.empty?
+      wrap do
+        h.content_tag :ul, :class => @options[:class] do i=0
+          content = ''
+          @items.each do |item| i=i+1
+            content += h.content_tag :li, :class => classes(i) do 
+              item_link(item) + nested_navigation(item).to_s
+            end
+          end
+          content.html_safe
+        end
+      end
+    else
+      ''
+    end
+  end
+  
+  def nested_navigation(item)
+    unless @options[:flat]
+      item = format_item(item)
+      if item[:items] && current_item?(item[:permalink])
+        options = {
+          :level => next_level,
+          :class => 'nav-sub-' + next_level.to_s,
+          :base_url => item[:url],
+          :wrap => false
+        }
+        NavigationPresenter.new(item[:items], options, @current_items[1..-1]).to_html
+      end
+    end
+  end
+  
+  def item_link(item, options = {})
+
+    item = format_item(item, options)
+    content = item[:text]
+    
+    if item[:summary]
+      item[:title] += ': '+item[:summary]
+      content = h.content_tag(:strong, content) + ' ' + content_tag(:em, item[:summary])
+    end
+    
+    if item[:id] || @options[:id]
+      item[:id] = item[:permalink] if @options[:id] === true || item[:id] === true
+      item[:id] = "nav_#{item[:id]}"
+    end
+    
+    h.link_to content, item[:url], {
+      :id => item[:id],
+      :class => (current_item?(item[:permalink]) ? 'current' : nil),
+      :title => item[:title],
+    }
+  end
+  
+  def item_url(text)
+    if (text == 'Home')
+      admin? ? '/admin' : '/'
+    else
+      base_url + '/' + text.parameterize('-')
+    end
+  end
+  
+  def base_url
+    if options[:base_url]
+      options[:base_url]
+    else
+      admin? ? '/admin' : ''
+    end
+  end
+  
+  def current_item(current_item)
+    @current_items << current_item
+  end
+  
+  private
+    
+    def h
+      ActionController::Base.helpers
+    end
+    
+    def classes(i)
+      classes = []
+      classes << 'first' if i==1
+      classes << 'last' if i==@items.length
+      !classes.empty? ? classes.join(' ') : nil
+    end
+    
+    def current_item?(permalink)
+      !@current_items.empty? && permalink == @current_items.first.parameterize('-')
+    end
+    
+    def admin?
+      @options[:admin]
+    end
+    
+    def format_item(item, options = {})
+      item = { :text => item } if item.kind_of? String
+      item = item.merge(options)
+      item[:id] = nil if !item[:id]
+      item[:url] = item_url(item[:text]) if !item[:url]
+      item[:title] = item[:text] if !item[:title]
+      item[:permalink] = item[:text].parameterize('-') if !item[:permalink]
+      item
+    end
+    
+    def current_level
+      @options[:level] ||= 0
+    end
+    
+    def next_level
+      current_level + 1
+    end
+    
+    def wrap(&block)
+      if @options[:wrap] === false
+        yield
+      else
+        h.content_tag :div, { :class => 'nav' } do
+          yield
+        end
+      end
+    end
+    
+end

data/lib/happy-nav/railtie.rb

@@ -0,0 +1,10 @@
+require 'happy-nav'
+require 'rails'
+
+module HappyNav
+  class Railtie < Rails::Railtie
+    initializer 'happy-nav.initialize', :after => :after_initialize do
+      ActionView::Base.send :include, HappyNav
+    end
+  end
+end

data/lib/happy-nav.rb

@@ -0,0 +1,23 @@
+require File.join(File.dirname(__FILE__), *%w[happy-nav navigation_presenter])
+require File.join(File.dirname(__FILE__), *%w[happy-nav railtie]) if defined?(::Rails::Railtie)
+
+module HappyNav
+  
+  def navigation(items = [], options = {})
+    unless items.empty?
+      @navigation_presenter = NavigationPresenter.new(items, options)
+      if @current_pages
+        @current_pages.each { |page| @navigation_presenter.current_item(page) }
+      end
+      @navigation = @navigation_presenter.to_html
+    end
+    @navigation ||= ''
+  end
+  
+  def current_page(page = nil)
+    @current_pages ||= []
+    @current_pages << page if page
+    @current_pages.first
+  end
+  
+end

data/spec/navigation_helper_spec.rb

@@ -0,0 +1,103 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe 'Happy Nav!' do
+  
+  include SpecHelperMethods
+  
+  before do
+    @view = ActionView::Base.new
+  end
+  
+  describe 'after loading the plugin' do
+    
+    it "should be mixed into ActionView::Base" do
+      ActionView::Base.included_modules.include?(HappyNav).should be_true
+    end
+    
+    it 'should respond to happy_title helper' do
+      @view.should respond_to(:navigation)
+    end
+    
+    it 'should respond to title helper' do
+      @view.should respond_to(:current_page)
+    end
+    
+  end
+  
+  describe '#navigation' do
+    
+    before do
+      @items = ['Home', 'About', 'Our Services', 'Contact']
+      @output = <<-eos
+        <div class="nav">
+          <ul>
+            <li class="first"><a href="/" title="Home">Home</a></li>
+            <li><a href="/about" title="About">About</a></li>
+            <li><a href="/our-services" title="Our Services">Our Services</a></li>
+            <li class="last"><a href="/contact" title="Contact">Contact</a></li>
+          </ul>
+        </div>
+      eos
+    end
+    
+    it 'should always return a string' do
+      @view.navigation.should be_a(String)
+    end
+    
+    it 'should return blank if there are no items' do
+      @view.navigation.should == ''
+    end
+    
+    it 'should return the formatted navigation if there are items' do
+      @view.navigation(@items).should == clean_string(@output)
+    end
+    
+    it 'should return the generated navigation multiple times' do
+      output = ''
+      output += @view.navigation(@items)
+      output += @view.navigation
+      output += @view.navigation
+      
+      output.should == clean_string(@output+@output+@output)
+    end
+    
+    it 'should regenerate the navigation if new items are passed' do
+      output = <<-eos
+        <div class="nav">
+          <ul>
+            <li class="first last"><a href="/about" title="About">About</a></li>
+          </ul>
+        </div>
+      eos
+      @view.navigation(@items).should == clean_string(@output)
+      @view.navigation(['About']).should == clean_string(output)
+    end
+    
+  end
+  
+  describe '#current_page' do
+    
+    it 'should be nil by default' do
+      @view.current_page.should == nil
+    end
+    
+    it 'should mark the current page' do
+      @view.current_page('Home')
+      @view.current_page.should == 'Home'
+    end
+    
+    it 'should render a navigation with the current page' do
+      output = <<-eos
+        <div class="nav">
+          <ul>
+            <li class="first last"><a href="/about" class="current" title="About">About</a></li>
+          </ul>
+        </div>
+      eos
+      @view.current_page('About')
+      @view.navigation(['About']).should == clean_string(output)
+    end
+    
+  end
+  
+end

data/spec/navigation_presenter_spec.rb

@@ -0,0 +1,261 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe NavigationPresenter do
+  
+  include SpecHelperMethods
+  
+  before do
+    @items = ['Home', 'About', 'Our Services', 'Contact']
+    @output = <<-eos
+      <div class="nav">
+        <ul>
+          <li class="first"><a href="/" title="Home">Home</a></li>
+          <li><a href="/about" title="About">About</a></li>
+          <li><a href="/our-services" title="Our Services">Our Services</a></li>
+          <li class="last"><a href="/contact" title="Contact">Contact</a></li>
+        </ul>
+      </div>
+    eos
+  end
+  
+  describe '#to_html' do
+    
+    it 'should return an empty string with no items' do
+      NavigationPresenter.new.to_html.should == ''
+    end
+    
+    it 'should always return a string' do
+      NavigationPresenter.new.to_html.should be_a(String)
+      NavigationPresenter.new(@items).to_html.should be_a(String)
+    end
+    
+    it 'should return a formatted navigation if there are items' do
+      NavigationPresenter.new(@items).to_html.should == clean_string(@output)
+    end
+    
+    it 'should correctly format a single item' do
+      output = <<-eos
+        <div class="nav">
+          <ul>
+            <li class="first last"><a href="/about" title="About">About</a></li>
+          </ul>
+        </div>
+      eos
+      
+      NavigationPresenter.new(['About']).to_html.should == clean_string(output)
+    end
+    
+    it 'should add an id to all links' do
+      output = <<-eos
+        <div class="nav">
+          <ul>
+            <li class="first"><a href="/" id="nav_home" title="Home">Home</a></li>
+            <li class="last"><a href="/contact" id="nav_contact" title="Contact">Contact</a></li>
+          </ul>
+        </div>
+      eos
+      
+      NavigationPresenter.new(['Home', 'Contact'], :id => true).to_html.should == clean_string(output)
+    end
+    
+    it 'should add a class to the unordered list' do
+      output = <<-eos
+        <div class="nav">
+          <ul class="ul-class">
+            <li class="first last"><a href="/about" title="About">About</a></li>
+          </ul>
+        </div>
+      eos
+      
+      NavigationPresenter.new(['About'], :class => 'ul-class').to_html.should == clean_string(output)
+    end
+    
+    it 'should not wrap the unordered list in a div' do
+      output = <<-eos
+        <ul>
+          <li class="first last"><a href="/about" title="About">About</a></li>
+        </ul>
+      eos
+      
+      NavigationPresenter.new(['About'], :wrap => false).to_html.should == clean_string(output)
+    end
+    
+    describe 'with nested items' do
+      
+      before do
+        @items = [
+          'Home',
+          {
+            :text => 'About Us',
+            :items => [
+              {
+                :text => 'Team',
+                :items => [
+                  'Guybrush Threepwood',
+                  'Ghost Pirate LeChuck'
+                ]
+              }
+            ]
+          },
+          {
+            :text => 'Our Services',
+            :items => ['Swash buckling']
+          },
+          'Contact'
+        ]
+      end
+      
+      it 'should render nested navigation links' do
+        output = <<-eos
+          <div class="nav">
+            <ul>
+              <li class="first"><a href="/" title="Home">Home</a></li>
+              <li>
+                <a href="/about-us" class="current" title="About Us">About Us</a>
+                <ul class="nav-sub-1">
+                  <li class="first last">
+                    <a href="/about-us/team" class="current" title="Team">Team</a>
+                    <ul class="nav-sub-2">
+                      <li class="first"><a href="/about-us/team/guybrush-threepwood" class="current" title="Guybrush Threepwood">Guybrush Threepwood</a></li>
+                      <li class="last"><a href="/about-us/team/ghost-pirate-lechuck" title="Ghost Pirate LeChuck">Ghost Pirate LeChuck</a></li>
+                    </ul>
+                  </li>
+                </ul>
+              </li>
+              <li><a href="/our-services" title="Our Services">Our Services</a></li>
+              <li class="last"><a href="/contact" title="Contact">Contact</a></li>
+            </ul>
+          </div>
+        eos
+        navigation_presenter = NavigationPresenter.new(@items)
+        navigation_presenter.current_item('About Us')
+        navigation_presenter.current_item('Team')
+        navigation_presenter.current_item('Guybrush Threepwood')
+        navigation_presenter.to_html.should == clean_string(output)
+      end
+      
+      it 'should render a flat list if flat is passed as an option' do
+        output = <<-eos
+          <div class="nav">
+            <ul>
+              <li class="first"><a href="/" title="Home">Home</a></li>
+              <li><a href="/about-us" class="current" title="About Us">About Us</a></li>
+              <li><a href="/our-services" title="Our Services">Our Services</a></li>
+              <li class="last"><a href="/contact" title="Contact">Contact</a></li>
+            </ul>
+          </div>
+        eos
+        navigation_presenter = NavigationPresenter.new(@items, :flat => true)
+        navigation_presenter.current_item('About Us')
+        navigation_presenter.current_item('Team')
+        navigation_presenter.current_item('Guybrush Threepwood')
+        navigation_presenter.to_html.should == clean_string(output)
+      end
+      
+    end
+    
+  end
+  
+  describe '#item_link' do
+    
+    before do
+      @navigation = NavigationPresenter.new
+    end
+    
+    it 'should always return a string' do
+      @navigation.item_link('Home').should be_a(String)
+    end
+    
+    it 'should return a link with a title' do
+      @navigation.item_link('About').should == '<a href="/about" title="About">About</a>'
+    end
+    
+    it 'should return a link to root if the page is "Home"' do
+      @navigation.item_link('Home').should == '<a href="/" title="Home">Home</a>'
+    end
+    
+    it 'should allow customisation using a Hash' do
+      @navigation.item_link({
+        :text => 'Custom',
+        :url => '/linky',
+        :title => 'Custom Title'
+      }).should == '<a href="/linky" title="Custom Title">Custom</a>'
+    end
+    
+    it 'should allow for a summary' do
+      @navigation.item_link({ :text => 'Summary', :summary => 'A quick summary...' }).should == '<a href="/summary" title="Summary: A quick summary..."><strong>Summary</strong> <em>A quick summary...</em></a>'
+    end
+    
+    it 'should mark "About" as the current page' do
+      @navigation.current_item('About')
+      @navigation.item_link('About').should == '<a href="/about" class="current" title="About">About</a>'
+    end
+    
+    it 'should allow for an id' do
+      @navigation.item_link({ :text => 'Linky', :id => true }).should == '<a href="/linky" id="nav_linky" title="Linky">Linky</a>'
+    end
+    
+    it 'should allow for a custom id' do
+      @navigation.item_link({ :text => 'Linky', :id => 'custom' }).should == '<a href="/linky" id="nav_custom" title="Linky">Linky</a>'
+    end
+    
+  end
+  
+  describe '#item_url' do
+    
+    before do
+      @navigation = NavigationPresenter.new
+    end
+    
+    it 'should always return a string' do
+      @navigation.item_url('Home').should be_a(String)
+    end
+    
+    it 'should return the path to root if the page is "Home"' do
+      @navigation.item_url('Home').should == '/'
+    end
+    
+    it 'should return a path' do
+      @navigation.item_url('About').should == '/about'
+    end
+    
+    it 'should path to the admin homepage' do
+      @navigation.stub!(:admin?).and_return(true)
+      @navigation.item_url('Home').should == '/admin'
+    end
+    
+    it 'should path to the admin namespace' do
+      @navigation.stub!(:admin?).and_return(true)
+      @navigation.item_url('About').should == '/admin/about'
+    end
+    
+    it 'should use the base_url option' do
+      @navigation.stub!(:options).and_return({ :base_url => '/example/base' })
+      @navigation.item_url('About').should == '/example/base/about'
+    end
+  
+  end
+  
+  describe '#admin?' do
+    
+    before do
+      @navigation = NavigationPresenter.new
+    end
+    
+    it 'should return false if the admin option is not set' do
+      @navigation.send(:admin?).should be_false
+    end
+    
+    it 'should return false if the admin option is false' do
+      @navigation.options[:admin] = false
+      @navigation.send(:admin?).should be_false
+    end
+    
+    it 'should return true if the admin option is true' do
+      @navigation.options[:admin] = true
+      @navigation.send(:admin?).should be_true
+    end
+    
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require 'active_support'
+require 'action_pack'
+require 'action_view'
+require 'action_controller'
+
+require File.join(File.dirname(__FILE__), "../lib/happy-nav")
+
+ActionView::Base.class_eval do
+  include HappyNav
+end
+
+module SpecHelperMethods
+  def clean_string(s)
+    s.gsub(/^\s+/, "").gsub(/\n/, "")
+  end
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification 
+name: happy-nav
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Andy Pearson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-26 00:00:00 +00:00
+default_executable: 
+dependencies: []
+
+description: Happy Nav is the easy (and cheerful) way to create structured HTML for your site navigation.
+email: andy@andy-pearson.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/happy-nav.rb
+- lib/happy-nav/navigation_presenter.rb
+- lib/happy-nav/railtie.rb
+- spec/navigation_helper_spec.rb
+- spec/navigation_presenter_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/andypearson/happy-nav
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Happy Nav is the easy (and cheerful) way to create structured HTML for your site navigation.
+test_files: 
+- spec/navigation_helper_spec.rb
+- spec/navigation_presenter_spec.rb
+- spec/spec_helper.rb