navigasmic 0.1.1 → 0.1.3

data/.document

@@ -1,4 +1,4 @@
-README.rdoc
+README.textile
 lib/**/*.rb
 bin/*
 features/**/*.feature

data/README.textile

@@ -6,7 +6,29 @@ 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.
+Ok, so navigation is easy right?  Until you start managing active/highlighted, disabled states, and more if you may need them.  This can quickly become a mess, and all too often it just stays in the views with whatever logic tossed on top of it as people go.  I've seen it too many times, and I wanted to do something about it.
+
+I went in with these requirements:
+
+* Should be simple
+* Should be easily customizable
+* Should handle active/highlighted states
+* Should handle disabled states
+* Should be pleasant to use
+* Should use less code to create than it generates
+
+And then I wrote a DSL that met those requirements:
+
+<pre>
+  <% semantic_navigation :main do |n| %>
+    <%= n.group 'Media' do %>
+      <%= n.item 'Image Gallery', :link => '/media/images', :highlights_on => '/media/videos' %>
+      <%= n.item 'Videos', :link => '/media/videos', :disabled_if => proc { true } %>
+    <% end %>
+  <% end %>
+</pre>
+
+Since I clearly needed something that allowed for customization I ended up emulating the way Rails uses form builders.  With some ideas taken from formtastic, I setup navigasmic to use builders.  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.
 
@@ -197,7 +219,7 @@ I'm only testing with the latest Rails 2.4.x stable release, and it should work
 
 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
+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/gems/navigasmic":http://gemcutter.org/gems/navigasmic
 
 
 Copyright (c) Jeremy Jackson, released under the MIT license.

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.3

data/lib/builders/html_builder.rb

@@ -6,6 +6,10 @@ module Navigasmic
       :disabled => 'disabled',
       :highlighted => 'highlighted'
     }
+    @@wrapper_tag = :ul
+    @@group_tag = :ul
+    @@item_tag = :li
+    @@label_tag = :span
 
     attr_accessor :template, :name, :items
 
@@ -16,7 +20,7 @@ module Navigasmic
 
     def render(options, &proc)
       buffer = template.capture(self, &proc)
-      template.concat(template.content_tag(:ul, buffer, options))
+      template.concat(template.content_tag(@@wrapper_tag, buffer, options))
     end
 
     def group(label = nil, options = {}, &proc)
@@ -27,10 +31,10 @@ module Navigasmic
       options[:html][:id] ||= label.to_s.gsub(/\s/, '_').underscore
 
       buffer = template.capture(self, &proc)
-      group = template.content_tag(:ul, buffer)
+      group = template.content_tag(@@group_tag, buffer)
       label = label_for_group(label) unless label.blank?
 
-      template.content_tag(:li, label.to_s + group, options.delete(:html))
+      template.content_tag(@@item_tag, label.to_s + group, options.delete(:html))
     end
 
     def item(label, options = {}, &proc)
@@ -47,15 +51,15 @@ module Navigasmic
       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))
+      template.content_tag(@@item_tag, label + buffer, options.delete(:html))
     end
 
     def label_for_group(label)
-      template.content_tag(:span, label.to_s)
+      template.content_tag(@@label_tag, label.to_s)
     end
 
     def label_for_item(label)
-      template.content_tag(:span, label.to_s)
+      template.content_tag(@@label_tag, label.to_s)
     end
 
   end

data/navigasmic.gemspec

@@ -1,11 +1,11 @@
 # Generated by jeweler
-# DO NOT EDIT THIS FILE
-# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{navigasmic}
-  s.version = "0.1.1"
+  s.version = "0.1.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jeremy Jackson"]
@@ -53,3 +53,4 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
   end
 end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: navigasmic
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors: 
 - Jeremy Jackson