site_map 0.3.1 → 0.3.2

data/README.rdoc

@@ -12,7 +12,7 @@ SiteMap provides a way to model out your site's views in a hierarchal fashion. Y
 
 === Basic Definition
 
-SiteMap provides a simple syntax for defining a site's views.
+SiteMap provides a simple syntax for defining a site's views. Add the following to +config/site_map.rb+ (site_map will load this when required) or an initializer for your app:
 
     require 'site_map'
     SiteMap.define do |map|
@@ -41,45 +41,9 @@ Every site map view node also has a +label+, +url+ and +visible+ attribute. The
       })
     end
 
-So same basic configuration, but I've added custom options for the previously mentioned attributes. Firstly, url and visible attributes are intended to be eav'd within the view space of an app. This allows you to specify very custom ways to determine a path or check if a node should be shown. Label's are not intended to be eval'd, but are dynamic in a different way, by subbing out symbol names with an options hash, again in the view space. This is explained more and used within site map's view helpers.
+So same basic configuration, but I've added custom options for the previously mentioned attributes. Firstly, url and visible attributes are intended to be eval'd within the view space (scope) of an app. This allows you to specify very custom ways to determine a path or check if a node should be shown. Label's are not intended to be eval'd, but are dynamic in a different way, by subbing out symbol names with an options hash, again in the view space (scope). This is explained more and used within site map's view helpers.
 
-Secondly, not every attribute has to be set. By default, a site map's visible is always +true+, and it's url is +nil+. Label also has a default, based on the index. For labels, site map will try to use a +titleize+ method on the string version of it's index. If defined, the titleized string is returned, otherwise just the string version of the index is.
-
-=== Groups and nesting
-
-Site map provides other ways to define nodes and also allows nesting nodes within other nodes.
-
-    require 'site_map'
-    SiteMap.define do |map|
-      map.view :home
-      map.view :about
-      map.group :community do |community_group|
-        community_group.view :forum
-        community_group.view :blog
-      end
-    end
-
-In this definition, we are using a new method +group+. A group node is very similar to a regular view node, and is intended to group similar views. In this case, we have created a group, called community with a blog and forum view as children. A group's definition syntax is the same as a view's, but it has different defaulting logic and behavior within the site map. A group's url will default to it's first child's url, in this case the forum view's url. I'll explain the differences in how a group behaves in the looking up views and traversing the site map sections later.
-
-=== Looking up a view node
-
-Enough we defining the site map, on to actually retrieving what's been defined. Assuming the previous definition:
-
-    view_node = SiteMap[:forum]
-    view_node = SiteMap[:community] # => returns nil, can't look up group nodes
-
-Specifying the index of a node will return that view node. When you look up a group node's index, it isn't returned. Group node's are not intended to be looked up, but still exist in the relationships of a view node.
-
-=== View node relationships
-
-After looking up a view node, you can access it's relationships.
-
-  view_node = SiteMap[:forum]
-  view_node.parent                # => returns community group node
-  view_node.siblings              # => returns an array with blog view node in it, [SiteMap[:blog]]
-  view_node.parent.children       # => returns an array with blog and forum view nodes, [SiteMap[:forum], SiteMap[:blog]]
-
-Other relationship methods include +ancestors+, +self_and_siblings+ and +self_and_ancestors+.
+SiteMap also has other ways to define your site map. Check out the wiki for more help: http://wiki.github.com/jcredding/site_map/
 
 Copyright (c) 2010 John Collin Redding
 See the attached MIT License.

data/lib/site_map/version.rb

@@ -3,7 +3,7 @@ module SiteMap
 
     MAJOR = 0
     MINOR = 3
-    TINY  = 1
+    TINY  = 2
 
     def self.to_s # :nodoc:
       [MAJOR, MINOR, TINY].join('.')

data/lib/site_map/view_helpers.rb

@@ -8,14 +8,14 @@ module SiteMap
 
     # subbing hash options into view node label, code thanks to kelredd-useful
     def view_node_label(view_node)
-      label_string = view_node.label
+      label_string = view_node.label.dup
       view_node_label_options.each do |label_key, value|
         label_string.gsub!(":#{label_key}", value.to_s)
       end
       label_string
     end
     def view_node_url(view_node)
-      eval(view_node.url)
+      eval(view_node.url.to_s)
     end
     def view_node_visible(view_node)
       eval(view_node.visible.to_s)
@@ -23,18 +23,40 @@ module SiteMap
     alias :view_node_visible? :view_node_visible
 
     def display_title(options = {})
-      options = { :connector => " > " }.merge(options)
-      [ view_node_label(@view_node.parent),
-        view_node_label(@view_node)
-      ].join(options[:connector])
+      self.display_joined_view_nodes([@view_node.parent, @view_node], options.merge({
+        :html => false
+      }))
     end
-    def display_crumbs
-
+    def display_crumbs(options = {})
+      options[:html] ||= {:class => "breadcrumb"}
+      self.display_joined_view_nodes(@view_node.self_and_ancestors, options)
     end
     def display_menu
 
     end
 
+    def display_joined_view_nodes(view_nodes, options = {})
+      options = {
+        :connector => " > ",
+        :html => true
+      }.merge(options)
+      display_view_nodes = view_nodes.collect do |view_node|
+        if options[:html]
+          html_options = options[:html].kind_of?(::Hash) ? options[:html] : {}
+          content_tag(:a, view_node_label(view_node), html_options.merge({
+            :href => view_node_url(view_node)
+          }))
+        else
+          view_node_label(view_node)
+        end
+      end
+      display_connector = if options[:html]
+        content_tag(:span, options[:connector])
+      else
+        options[:connector]
+      end
+      display_view_nodes.join(display_connector)
+    end
 
   end
 end

data/lib/site_map/view_node.rb

@@ -69,6 +69,7 @@ module SiteMap
     def children
       @view_nodes
     end
+    alias_method :views, :children
     def ancestors
       unless @ancestors
         node, @ancestors = self, []
@@ -80,12 +81,24 @@ module SiteMap
     def self_and_ancestors
       @with_ancestors ||= self.ancestors.dup.push(self)
     end
+    alias_method :sna, :self_and_ancestors
     def siblings
       @siblings ||= (self.self_and_siblings - [self])
     end
     def self_and_siblings
       @with_siblings ||= self.parent.children
     end
+    alias_method :sns, :self_and_siblings
+    def previous_sibling
+      sns[sns.index(self)-1]
+    end
+    alias_method :previous_view, :previous_sibling
+    alias_method :prev, :previous_sibling
+    def next_sibling
+      sns[(idx = sns.index(self)+1) == sns.length ? 0 : idx]
+    end
+    alias_method :next_view, :next_sibling
+    alias_method :next, :next_sibling
 
     TYPES.each do |node_type|
       self.send(:define_method, "#{node_type}?", lambda{ self.node_type == node_type })
@@ -102,14 +115,12 @@ module SiteMap
 
     def default_label
       case(@node_type)
-      when :group
-        self.title_string(@index)
       when :collection
         self.resource_label((@action == :new ? self.single_string : self.title_string))
       when :member
         self.resource_label(self.single_string)
       else
-        @index.to_s.titleize
+        self.title_string(@index)
       end
     end
     def default_url
@@ -121,7 +132,7 @@ module SiteMap
       when :member
         self.resource_url
       else
-        "/#{@index.to_s.underscore.dasherize}"
+        "/#{@index.to_s.downcase.gsub(/[^a-z0-9\-_\+]+/, '-')}"
       end
     end
 

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 3
-  - 1
-  version: 0.3.1
+  - 2
+  version: 0.3.2
 platform: ruby
 authors: 
 - Collin Redding
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-16 00:00:00 -05:00
+date: 2010-04-19 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency