nav 0.2.0 → 0.3.2

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Rudolf Schmidt
+
+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,74 @@
+= Nav
+Navigation made easy
+
+== Installation
+  # system wide
+  gem install nav
+
+  # in your Gemfile
+  gem 'nav'
+
+== Usage
+=== Basics
+Nav is automatically available within ActionView::Base and can be used like so:
+  <%= nav do |n| %>
+    <% n.action "Home", "/" %>
+    <% n.action "Login", login_url %>
+  <% end %>
+
+  # When rendered, this generates the following:
+  <ul>
+    <li class="first current first_current">
+      <a href="/">Home</a>
+    </li>
+    <li class="last after_current last_after_current">
+      <a href="/login">Login</a>
+    </li>
+  </ul>
+
+It will determine the current page you are on and add the :current: class to the <li> element. Also, 
+the element before and after the current element have the classes :before_current: and :after_current:. 
+Additionally, Nav will mark the first and last <li> element of the list as :first: and :last:. Like so, 
+you can apply styles accordingly.
+
+=== Adding attributes to the nav element
+You can give any possible html option to nav, like classes, etc.
+  <%= nav :class => 'main' do |n| %>
+    ...
+  <% end %>
+
+  # results in
+  <ul class='main'>
+    ...
+  </ul>
+
+=== Adding attributes to an action
+You are able to add specific behaviour when defining an :action. For instance, if you want to disable a specific 
+element, you may pass :disabled: to it:
+  <%= nav do |n| %>
+    <%= n.action "Disabled", "/", :disabled => true %>
+  <% end %>
+
+This will add a "disabled" class to the <li> element. 
+
+Sometimes you may want to define yourself which of the elements is the current one. You can pass :current: as
+option. This can be done in various ways.
+  # Pass true or false to the :current: argument
+  <%= nav do |n| %>
+   <% n.action "My special current", "/", :current => true %>
+  <% end %>
+  
+  # Pass a regular expression to the :current: argument. For instance, the following will mark any url as current
+  # that has "account", followed by a "/" and any typee of numeric value: 
+  <%= nav do |n| %>
+   <% n.action "My special current", "/", :current => /account\/\d+/ %>
+  <% end %>
+
+  # Lastly, you may also pass a proc:
+  <%= nav do |n| %>
+   <% n.action "My special current", "/", :current => Proc.new { !current_user.nil? } %>
+  <% end %>
+
+
+
+Copyright (c) 2011 Rudolf Schmidt, released under the MIT license

data/lib/nav/builder.rb

@@ -0,0 +1,89 @@
+module Nav
+  class Builder
+    def initialize( template, options = {} )
+      @template, @options = template, options
+      @actions = []
+      
+      yield self if block_given?
+    end
+
+    def action( name, options = {}, html_options = {} )
+      wrapper_options = {
+        :current => html_options.delete(:current),
+        :disabled => html_options.delete(:disabled),
+        :force_current => html_options.delete(:force_current),
+        :url => options,
+        :prepend => html_options.delete(:prepend),
+        :append => html_options.delete(:append)
+      }
+      
+      @actions << [link_to(name, options, html_options), wrapper_options, options]
+    end
+
+    def to_s
+      content_tag( :ul, actions.html_safe, @options ).html_safe if actions?
+    end
+
+
+    private
+
+    def actions
+      @actions.collect { |a| action_wrapper(*a) }.join
+    end
+
+    def actions?
+      @actions.any?
+    end
+
+    def action_wrapper( contents, options = {}, url_for_options = {} )
+      present = [contents, options, url_for_options] # the one we're dealing with
+      present_index  = @actions.index( present )
+      
+      before_present = @actions.at( present_index - 1 ) if present_index > 0
+      after_present  = @actions.at( present_index + 1 ) if present_index < @actions.size
+
+      classes = []
+      classes << "first" if @actions.first == present
+      classes << "last"  if @actions.last == present
+      classes << "current"  if current?( *present )
+      classes << "disabled" if options.delete(:disabled)
+      classes << "before_current" if after_present && current?( *after_present )
+      classes << "after_current"  if before_present && current?( *before_present )
+      classes << classes.join("_") if classes.any?
+
+      contents = options[:prepend].to_s + contents + options[:append].to_s
+
+      content_tag :li, contents.html_safe, :class => classes.join(" ")
+    end
+
+    def current?( contents, options = {}, url_for_options = {} )
+      current = options[:current]
+      
+      is_current = case current
+        when TrueClass then true
+        when Regexp then request_uri.match(current).nil? ? false : true
+        when Proc then current.call
+        else false
+      end
+
+      return true if is_current && !options[:disabled] && options[:force_current]
+      return true if is_current || !url_for_options.is_a?(Symbol) && @template.current_page?(url_for_options) && url_for_options != {} && !options[:disabled]
+
+      false
+    end
+
+    def request_uri
+      @request_uri or @request_uri = @template.request.request_uri
+    end
+
+
+    def content_tag( *args )
+      @template.content_tag( *args ).html_safe
+    end
+
+    def link_to( *args )
+      @template.link_to( *args ).html_safe
+    end
+  end
+end
+

data/lib/nav/version.rb

@@ -1,5 +1,5 @@
 module Nav
 
-  VERSION = "0.2.0"
+  VERSION = "0.3.2"
   
 end

data/lib/nav.rb

@@ -1,104 +1,12 @@
-require_relative "nav/version"
-
 module Nav
 
-  def nav( options = {}, &block )
-    builder = Builder.new( self, options )
-    yield( builder )
-
-    builder.to_html if builder.actions?
-  end
-
-  
-  private
-
-  class Builder
-
-    def initialize( template, options = {} )
-      @template, @options = template, options
-
-      @actions = []
-    end
-
-    
-    def action( name, options = {}, html_options = {} )
-      wrapper_options = {
-        :current => html_options.delete(:current),
-        :disabled => html_options.delete(:disabled),
-        :force_current => html_options.delete(:force_current),
-        :url => options,
-        :prepend => html_options.delete(:prepend),
-        :append => html_options.delete(:append)
-      }
-      
-      @actions << [link_to(name, options, html_options), wrapper_options, options]
-    end
-
-    def actions?; @actions.any?; end
-
-    def to_html
-      content_tag( :ul, actions.html_safe, @options ).html_safe
-    end
-
-
-    private
+  autoload :Builder, File.dirname(__FILE__) + '/nav/builder'
 
-    def actions
-      @actions.collect{ |a| action_wrapper(*a) }.join
-    end
-
-    def action_wrapper( contents, options = {}, url_for_options = {} )
-      present = [contents, options, url_for_options] # the one we're dealing with
-      present_index  = @actions.index( present )
-      
-      before_present = @actions.at( present_index - 1 ) if present_index > 0
-      after_present  = @actions.at( present_index + 1 ) if present_index < @actions.size
-
-      classes = []
-      classes << "first" if @actions.first == present
-      classes << "last"  if @actions.last == present
-      classes << "current"  if current?( *present )
-      classes << "disabled" if options.delete(:disabled)
-      classes << "before_current" if after_present && current?( *after_present )
-      classes << "after_current"  if before_present && current?( *before_present )
-      classes << classes.join("_") if classes.any?
-
-      contents = options[:prepend].to_s + contents + options[:append].to_s
-
-      content_tag :li, contents.html_safe, :class => classes.join(" ")
-    end
-
-    def current?( contents, options = {}, url_for_options = {} )
-      current = options[:current]
-      
-      is_current = case current
-        when TrueClass then true
-        when Regexp then request_uri.match(current).nil? ? false : true
-        when Proc then current.call
-        else false
-      end
-
-      return true if is_current && !options[:disabled] && options[:force_current]
-      return true if is_current || !url_for_options.is_a?(Symbol) && @template.current_page?(url_for_options) && url_for_options != {} && !options[:disabled]
-
-      false
-    end
-
-    def request_uri
-      @request_uri or @request_uri = @template.request.request_uri
-    end
-
-
-    def content_tag( *args )
-      @template.content_tag( *args ).html_safe
-    end
-
-    def link_to( *args )
-      @template.link_to( *args ).html_safe
-    end
-    
+  def nav( options = {}, &block )
+    Nav::Builder.new( self, options, &block ) 
   end
 
 end
 
 ActionView::Base.send :include, Nav
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nav
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-11 00:00:00.000000000Z
+date: 2011-10-31 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
-  requirement: &16865520 !ruby/object:Gem::Requirement
+  requirement: &16805620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '3'
   type: :runtime
   prerelease: false
-  version_requirements: *16865520
+  version_requirements: *16805620
 - !ruby/object:Gem::Dependency
   name: rr
-  requirement: &16865000 !ruby/object:Gem::Requirement
+  requirement: &16804580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *16865000
+  version_requirements: *16804580
 description: Simple nagivation builder
 email: 
 executables: []
@@ -41,8 +41,11 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
+- LICENSE.txt
+- README.rdoc
 - Rakefile
 - lib/nav.rb
+- lib/nav/builder.rb
 - lib/nav/version.rb
 - nav.gemspec
 - test/nav_test.rb
@@ -67,7 +70,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: nav
-rubygems_version: 1.8.6
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Simple nagivation builder