navigator 0.1.0

data/CHANGELOG.rdoc

@@ -0,0 +1,3 @@
+= v0.1.0
+
+* Initial version.

data/LICENSE.rdoc

@@ -0,0 +1,20 @@
+Copyright (c) 2012 {Red Alchemist}[http://www.redalchemist.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, 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,99 @@
+= Overview
+
+{<img src="https://secure.travis-ci.org/bkuhlmann/navigator.png" />}[http://travis-ci.org/bkuhlmann/navigator]
+
+Enhances Rails with a DSL for menu navigation.
+
+= Features
+
+* A simple DSL for creating navigation menus.
+* Supports sub-menus, nested tags, HTML attributes, etc.
+* Supports the following HTML tags: ul, li, a, b, em, s, small, span, strong, sub, and sup.
+* Provides the "item" convenience method which combines the "li" and "a" HTML tags into a single method for less typing.
+
+= Requirements
+
+1. {Ruby 1.9.x}[http://www.ruby-lang.org].
+2. {Ruby on Rails}[http://rubyonrails.org].
+
+= Setup
+
+Type the following from the command line to install:
+
+  gem install navigator
+
+Add the following to your Gemfile:
+
+  gem "navigator"
+
+= Usage
+
+The following are examples using the render_navigation view helper:
+
+== Unordered List (simple)
+
+  render_navigation do
+    item "Dashboard", "/dashboard"
+    item "News", "/posts"
+  end
+
+Yields:
+
+  <ul>
+    <li><a href="/dashboard">Dashboard</a></li>
+    <li><a href="/posts">Posts</a></li>
+  </ul>
+
+== Unordered List (with attributes)
+
+  render_navigation "ul", class: "nav" do
+    item "Dashboard", "/dashboard", class: "active"
+    item "News", "/posts"
+  end
+
+Yields:
+
+  <ul class="nav">
+    <li class="active"><a href="/dashboard">Dashboard</a></li>
+    <li><a href="/posts">Posts</a></li>
+  </ul>
+
+== Nav (with links)
+
+  render_navigation "nav" do
+    a "Dashboard", href: "/dashboard"
+    a "News", href: "/posts"
+  end
+
+Yields:
+
+  <nav>
+    <a href="/dashboard">Dashboard</a>
+    <a href="/posts">Posts</a>
+  </nav>
+
+= Tests
+
+To test, do the following:
+
+1. cd to the gem root.
+2. bundle install
+3. bundle exec rspec spec
+
+= Contributions
+
+Please log all feedback/issues via {GitHub Issues}[https://github.com/bkuhlmann/navigator/issues]. Thanks.
+
+= Credits
+
+Developed by {Brooke Kuhlmann}[http://www.redalchemist.com] at {Red Alchemist}[http://www.redalchemist.com]
+
+= License
+
+Copyright (c) 2012 {Red Alchemist}[http://www.redalchemist.com].
+Read the LICENSE for details.
+
+= History
+
+Read the CHANGELOG for details.
+Built with Gemsmith[https://github.com/bkuhlmann/gemsmith].

data/lib/navigator.rb

@@ -0,0 +1,14 @@
+require File.join File.dirname(__FILE__), "navigator", "tag.rb"
+require File.join File.dirname(__FILE__), "navigator", "menu.rb"
+
+# Rails Enhancements
+if defined? Rails
+  # Dependencies
+  require File.join File.dirname(__FILE__), "navigator", "version.rb"
+  require File.join File.dirname(__FILE__), "navigator", "action_view", "instance_methods.rb"
+
+  # View
+  if defined? ActionView
+    ActionView::Base.send :include, Navigator::ActionView
+  end
+end

data/lib/navigator/action_view/instance_methods.rb

@@ -0,0 +1,18 @@
+module Navigator
+  module ActionView
+	  def self.included base
+	    base.send :include, InstanceMethods
+	  end
+
+    module InstanceMethods
+      # Renders a navigation menu.
+      # ==== Parameters
+      # * +tag+ - Optional. The menu tag. Default: "ul"
+      # * +attributes+ - Optional. The menu tag attributes. Default: {}
+      # * +block+ - Optional. The code block.
+      def render_navigation tag = "ul", attributes = {}, &block
+        raw Menu.new(self, tag, attributes, &block).render
+      end
+    end
+  end
+end

data/lib/navigator/menu.rb

@@ -0,0 +1,82 @@
+module Navigator
+  # Builds and renders HTML menus. Examples:
+  # Example 1:
+  # <ul>
+  #   <li>One</li>
+  #   <li>Two</li>
+  # </ul>
+  # Example 2:
+  # <nav>
+  #   <a href="/one">One</a>
+  #   <a href="/two">Two</a>
+  # </nav>
+  class Menu
+    attr_accessor :options
+    
+    # Initializes the menu.
+    # ==== Parameters
+    # * +template+ - Required. The view template.
+    # * +tag+ - Optional. The menu tag. Default: "ul"
+    # * +attributes+ - Optional. The tag attributes. Default: {}
+    # * +options+ - Optional. The menu options. Default: {active: "active"}
+    # * +block+ - Optional. The code block.
+    def initialize template, tag = "ul", attributes = {}, options = {}, &block
+      @template = template
+      @tag = Tag.new tag, nil, attributes
+      @options = options.reverse_merge! active: "active"
+      @items = []
+      instance_eval(&block) if block_given?
+    end
+
+    # Adds a HTML tag to the menu.
+    # ==== Parameters
+    # * +name+ - Required. The tag name.
+    # * +content+ - Optional. The tag content. Default: nil
+    # * +attributes+ - Optional. The HTML attributes (hash) for the tag. Default: {}
+    # * +block+ - Optional. The tag code block.
+    def add name, content = nil, attributes = {}, &block
+      tag = Tag.new name, content, attributes
+      if block_given?
+        @items << tag.prefix
+        @items << tag.content
+        instance_eval(&block)
+        @items << tag.suffix
+      else
+        @items << tag.render
+      end
+    end
+
+    # Build a list item tag (li) that contains a link tag (a).
+    # This is a convenience method for adding simple list items as links.
+    # ==== Parameters
+    # * +content+ - Required. The content of the link (not the item!)
+    # * +url+ - Required. The link url.
+    # * +item_attributes+ - Optional. The item HTML attributes. Default: {}
+    # * +link_attributes+ - Optional. The link HTML attributes. Default: {}
+    def item content, url, item_attributes = {}, link_attributes = {}
+      add "li", nil, item_attributes do
+        add "a", content, {href: url}.reverse_merge!(link_attributes)
+      end
+    end
+
+    # Delegates missing method names to the .add method for supported tags only.
+    # Supported Tags: ul, li, a, b, em, s, small, span, strong, sub, and sup.
+    # All other method calls are sent to the view template for processing (if apt).
+    # ==== Parameters
+    # * +name+ - Required. The method name.
+    # * +args+ - Optional. The method arguments.
+    # * +block+ - Optional. The code block.
+    def method_missing name, *args, &block
+      if name.to_s =~ /^(ul|li|a|b|em|s|small|span|strong|sub|sup)$/
+        add(*args.unshift(name), &block)
+      else
+        @template.send name, *args
+      end
+    end
+
+    # Renders the menu.
+    def render
+      [@tag.prefix, @tag.content, @items.compact.join(''), @tag.suffix].compact * ''
+    end
+  end
+end

data/lib/navigator/tag.rb

@@ -0,0 +1,36 @@
+module Navigator
+  # Represents a HTML tag.
+  class Tag
+    attr_accessor :name, :content, :attributes
+
+    # Initalizes the HTML tag.
+    # ==== Parameters
+    # * +name+ - Required. The tag name.
+    # * +content+ - Optional. The tag content. Default: nil
+    # * +attributes+ - Optional. The tag attributes. Default: {}
+    def initialize name, content = nil, attributes = {}
+      @name, @content, @attributes = name, content, attributes
+    end
+
+    # Answers the attributes as fully formed HTML attributes for the tag.
+    def html_attributes
+      @attributes.map {|key, value| "#{key}=\"#{value}\""}.compact * ' '
+    end
+
+    # Answers the HTML tag prefix (i.e. the opening tag). Example: <li>.
+    def prefix
+      attrs = html_attributes.empty? ? nil : " #{html_attributes}"
+      ["<#{@name}", attrs, '>'].compact * ''      
+    end
+    
+    # Answers the HTML tag suffix (i.e. the closing tag). Example: </li>.
+    def suffix
+      "</#{@name}>"
+    end
+
+    # Renders the fully assembled HTML tag with attributes and content (if apt).
+    def render
+      [prefix, @content, suffix].compact * ''
+    end
+  end
+end

data/lib/navigator/version.rb

@@ -0,0 +1,3 @@
+module Navigator
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: navigator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Brooke Kuhlmann
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &70219033230180 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70219033230180
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70219033229380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70219033229380
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: &70219033228680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70219033228680
+description: Enhances Rails with a DSL for menu navigation complete with sub-menus,
+  nested tags, HTML attributes, etc.
+email: brooke@redalchemist.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+- CHANGELOG.rdoc
+- LICENSE.rdoc
+files:
+- lib/navigator/action_view/instance_methods.rb
+- lib/navigator/menu.rb
+- lib/navigator/tag.rb
+- lib/navigator/version.rb
+- lib/navigator.rb
+- README.rdoc
+- CHANGELOG.rdoc
+- LICENSE.rdoc
+homepage: http://www.redalchemist.com
+licenses:
+- MIT
+post_install_message: ! '(W): www.redalchemist.com. (T): @ralchemist.'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ~>
+    - !ruby/object:Gem::Version
+      version: 1.9.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Enhances Rails with a DSL for menu navigation.
+test_files: []