nav 0.5.0 → 0.6.0

data/README.md

@@ -0,0 +1,149 @@
+Navigation made easy
+
+## Installation
+System wide
+
+```console
+gem install nav
+```
+
+In your Gemfile
+
+```ruby
+gem 'nav'
+```
+
+## Usage
+
+Nav is writte for ActionView::Base and can be used in your rails views like so:
+
+```erb
+<%= nav do |n| %>
+  <% n.action "Home", "/" %>
+  <% n.action "Login", login_url %>
+<% end %>
+```
+
+When rendered, this generates the following:
+
+```html
+<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 id, classes, etc.
+
+```erb
+<%= nav :class => 'main' do |n| %>
+  ...
+<% end %>
+```
+
+Which results in
+
+```html
+<ul class='main'>
+  ...
+</ul>
+```
+
+### Adding attributes to an action
+
+#### Disabling 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. It will add a disabled class to the `li` element.
+
+```erb
+<%= nav do |n| %>
+  <% n.action "Disabled", "/", :disabled => true %>
+<% end %>
+```
+
+#### Manually set the current action
+
+In case want to define which of the elements is the current one. You can pass `current` as
+option. This can be done in various ways.
+
+##### Boolean
+
+```erb
+<%= nav do |n| %>
+ <% n.action "My special current", "/", :current => true %>
+<% end %>
+```
+##### Regular Expression
+
+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 type 
+of numeric value, like "account/1" or "user/account/123". However, "account/my" will 
+not match.
+
+```erb
+<%= nav do |n| %>
+ <% n.action "My special current", "/", :current => /account\/\d+/ %>
+<% end %>
+```
+
+##### Proc
+
+Pass a Proc in order to determine the current on the fly. Make sure that it returns
+`true` or `false`.
+
+```erb
+<%= nav do |n| %>
+ <% n.action "My special current", "/", :current => Proc.new { !current_user.nil? } %>
+<% end %>
+```
+## Custom actions
+
+If you prefer to not use links for your navigation or simply want to customize your 
+navigation, you may do so by padding a block to the `action`.
+
+You can use any rails view helpers or just good old plain html. The following 
+examples are equivalent:
+
+```erb
+<%= nav do |n| %>
+  <% n.action :class => 'customized' do %>
+    <span>Home</span>
+  <% end %>
+<% end %>
+```
+
+
+```erb
+<%= nav do |n| %>
+  <% n.action :class => 'customized' do %>
+    <%= content_tag :span, 'Home' %>
+  <% end %>
+<% end %>
+```
+
+... and will result in:
+
+```html
+<ul>
+  <li class="last">
+    <span>Home</span>
+  </li>
+</ul>
+```
+
+
+
+Copyright (c) 2011-2012 Rudolf Schmidt, released under the MIT license
+

data/lib/nav/builder.rb

@@ -19,9 +19,9 @@ module Nav
     #   action :current => true do
     #     content_tag :span, "A simple text""
     #   end
-    def action( name = nil, options = {}, html_options = {} )
-      @actions << if block_given?
-        [ yield, name || {}, {} ]
+    def action( name = nil, options = {}, html_options = {}, &block )
+      @actions << if block
+        [ @template.capture(&block), name || {}, {} ]
       else
         wrapper_options = {
           :current => html_options.delete(:current),

data/lib/nav/version.rb

@@ -1,5 +1,5 @@
 module Nav
 
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
   
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nav
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-31 00:00:00.000000000Z
+date: 2012-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
-  requirement: &23153860 !ruby/object:Gem::Requirement
+  requirement: &70123352610920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '3'
   type: :runtime
   prerelease: false
-  version_requirements: *23153860
+  version_requirements: *70123352610920
 - !ruby/object:Gem::Dependency
   name: rr
-  requirement: &23153120 !ruby/object:Gem::Requirement
+  requirement: &70123352610360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *23153120
+  version_requirements: *70123352610360
 description: Simple nagivation builder
 email: 
 executables: []
@@ -42,7 +42,7 @@ files:
 - .gitignore
 - Gemfile
 - LICENSE.txt
-- README.rdoc
+- README.md
 - Rakefile
 - lib/nav.rb
 - lib/nav/builder.rb
@@ -70,8 +70,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: nav
-rubygems_version: 1.8.10
+rubygems_version: 1.8.17
 signing_key: 
 specification_version: 3
 summary: Simple nagivation builder
-test_files: []
+test_files:
+- test/nav_test.rb
+- test/test_helper.rb

data/README.rdoc

@@ -1,74 +0,0 @@
-= 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