site_map 0.2.0 → 0.2.5

data/README.rdoc

@@ -20,10 +20,13 @@ This creates a single view in your map that can be found with the index :user. F
 
     SiteMap[:user]
 
-If the a view node with the index :user exists in the site map, then it will return it and can be used as needed.
-
-Copyright (c) 2009 John Collin Redding
-See the attached MIT License.
+If the a view node with the index :user exists in the site map, then it will return it and can be used as needed. SiteMap can also be used to define views in a resource based method. You can define a collection of view node's with the collection method:
 
+    SiteMap.define do |map|
+      map.collection :users
+    end
 
+This defines a single view node with an index of :users__index. It then uses the alias method, to also allow looking up the view node with :users__new and :users_create. SiteMap also defines a member method, which creates a node with :users__show, and alias' :users__edit, :users__update and :users__destroy.
 
+Copyright (c) 2010 John Collin Redding
+See the attached MIT License.

data/lib/site_map/exceptions.rb

@@ -0,0 +1,8 @@
+module SiteMap
+  module Exceptions
+
+    class NonExistantViewNode < StandardError
+    end
+
+  end
+end

data/lib/site_map/helpers/mapping.rb

@@ -4,16 +4,48 @@ module SiteMap
     module Mapping
 
       def group(new_index, options={})
-        view_node = SiteMap::ViewNode.new(*view_node_params(new_index, options))
-        self.add_to_children(view_node)
+        view_node = self.add_node(new_index, :group, options)
         yield view_node if block_given?
       end
       def view(new_index, options={})
-        view_node = SiteMap::ViewNode.new(*view_node_params(new_index, options))
-        self.add_to_children(view_node)
-        self.map.add_to_index(view_node)
+        view_node = self.add_node(new_index, :view, options)
+        yield view_node if block_given?
+      end
+
+      def alias(new_index, existing_index)
+        view_node = SiteMap[existing_index]
+        raise(SiteMap::Exceptions::NonExistantViewNode, "view node with index #{existing_index} does not exist for aliasing") unless view_node
+        self.map.add_to_index(new_index, view_node)
+      end
+
+      def collection(resource, options={})
+        base_index = "#{resource}__:action"
+        new_index = base_index.gsub(':action', 'index').to_sym
+        view_node = self.add_node(new_index, :view, options)
+        [:new, :create].each do |action|
+          action_index = base_index.gsub(':action', action.to_s).to_sym
+          view_node.alias(action_index, new_index)
+        end
         yield view_node if block_given?
       end
+      def member(resource, options={})
+        base_index = "#{resource}__:action"
+        new_index = base_index.gsub(':action', 'show').to_sym
+        view_node = self.add_node(new_index, :view, options)
+        [:edit, :update, :destroy].each do |action|
+          action_index = base_index.gsub(':action', action.to_s).to_sym
+          view_node.alias(action_index, new_index)
+        end
+      end
+
+      protected
+
+      def add_node(new_index, type, options={})
+        view_node = SiteMap::ViewNode.new(*view_node_params(new_index, type, options))
+        self.add_to_children(view_node)
+        self.map.add_to_index(new_index, view_node) unless type == :group
+        view_node
+      end
 
     end
 

data/lib/site_map/map.rb

@@ -17,8 +17,8 @@ module SiteMap
     def add_to_children(view_node)
       @view_nodes.push(view_node)
     end
-    def add_to_index(view_node)
-      @index_of_nodes[view_node.index.to_sym] = view_node
+    def add_to_index(index, view_node)
+      @index_of_nodes[index.to_sym] = view_node
     end
 
     def clear_nodes!
@@ -31,10 +31,14 @@ module SiteMap
       self
     end
 
+    def inspect
+      "#<#{self.class}>"
+    end
+
     protected
 
-    def view_node_params(index, options)
-      [index, self, options]
+    def view_node_params(index, type, options)
+      [index, self, type, options]
     end
 
   end

data/lib/site_map/version.rb

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

data/lib/site_map/view_node.rb

@@ -3,13 +3,16 @@ module SiteMap
 
   class ViewNode
     include SiteMap::Helpers::Mapping
-    ATTRIBUTES = [ :map, :index, :label, :url, :visible, :parent ]
+    ATTRIBUTES = [ :map, :index, :label, :url, :visible, :parent, :type ]
     ATTRIBUTES.each{|attribute| attr_reader attribute }
 
-    def initialize(index, map, options={})
-      raise(ArgumentError, "index and map arguements required") unless index && map
+    TYPES = [ :view, :group ]
+
+    def initialize(index, map, type, options={})
+      raise(ArgumentError, "index, map and type arguements required") unless index && map && type
       @index = index
       @map = map
+      @type = type
       options.each do |method, value|
         instance_variable_set("@#{method}", value)
       end
@@ -23,6 +26,13 @@ module SiteMap
     def label
       @label ? @label : @index.to_s
     end
+    def url
+      if !@url && self.group?
+        self.children.empty? ? @url : self.children.first.url
+      else
+        @url
+      end
+    end
     def visible
       @visible ? @visible : 'true'
     end
@@ -52,10 +62,21 @@ module SiteMap
       @with_siblings ||= self.parent.children
     end
 
+    TYPES.each do |type|
+      self.send(:define_method, "#{type}?", lambda{ self.type == type })
+    end
+
+    def inspect
+      attributes_string = [:index, :type, :label, :url, :visible].collect do |attribute|
+        "#{attribute}: #{self.send(attribute).inspect}"
+      end.join(", ")
+      "#<#{self.class} #{attributes_string}>"
+    end
+
     protected
 
-    def view_node_params(new_index, options)
-      [new_index, self.map, options.merge(:parent => self)]
+    def view_node_params(new_index, type, options)
+      [new_index, self.map, type, options.merge(:parent => self)]
     end
 
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: site_map
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.2.5
 platform: ruby
 authors: 
 - Collin Redding
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-15 00:00:00 -06:00
+date: 2010-01-18 00:00:00 -06:00
 default_executable: 
 dependencies: []
 
@@ -24,6 +24,7 @@ extra_rdoc_files:
 files: 
 - README.rdoc
 - Rakefile
+- lib/site_map/exceptions.rb
 - lib/site_map/helpers/mapping.rb
 - lib/site_map/helpers.rb
 - lib/site_map/map.rb