site_map 0.2.9 → 0.3.0

data/Rakefile

@@ -55,9 +55,11 @@ task :gemspec do
   puts "Created gemspec: #{file}"
 end
 
-require 'cucumber'
-require 'cucumber/rake/task'
-
-Cucumber::Rake::Task.new(:features) do |t|
-  t.cucumber_opts = "test/features --format pretty"
+task :environment do
+  require File.join(File.dirname(__FILE__), 'test', 'test_helper.rb')
+  files_path = File.expand_path(File.join(File.dirname(__FILE__), 'test', 'support', 'config', 'site_map', '*.rb'))
+  files = Dir[files_path].sort
+  SiteMap.setup(files)
 end
+
+load File.join(File.dirname(__FILE__), 'lib', 'site_map', 'tasks', 'view_nodes.rake')

data/lib/site_map/helpers/mapping.rb

@@ -52,10 +52,10 @@ module SiteMap
 
       protected
 
-      def add_node(new_index, type, options={})
-        view_node = SiteMap::ViewNode.new(*view_node_params(new_index, type, options))
+      def add_node(new_index, node_type, options={})
+        view_node = SiteMap::ViewNode.new(*view_node_params(new_index, node_type, options))
         self.add_to_children(view_node)
-        self.map.add_to_index(new_index, view_node) unless type == :group
+        self.map.add_to_index(new_index, view_node) unless node_type == :group
         view_node
       end
 

data/lib/site_map/map.rb

@@ -37,8 +37,8 @@ module SiteMap
 
     protected
 
-    def view_node_params(index, type, options)
-      [index, self, type, options]
+    def view_node_params(index, node_type, options)
+      [index, self, node_type, options]
     end
 
   end

data/lib/site_map/tasks/view_nodes.rake

@@ -0,0 +1,54 @@
+namespace :site_map do
+
+  desc 'Print out all defined view nodes based on the current SiteMap configuration'
+  task :nodes => :environment do
+    index_length = SiteMap.map.index_of_nodes.collect{|key, value| key.inspect.length}.max
+    index_length += (SiteMap.map.index_of_nodes.collect{|key, value| value.ancestors.size}.max * 2)
+    label_length = SiteMap.map.index_of_nodes.collect{|key, value| value.label.inspect.length}.max
+    url_length = SiteMap.map.index_of_nodes.collect{|key, value| value.url.inspect.length}.max
+    options = {
+      :spacing => 0,
+      :index_length => index_length,
+      :label_length => label_length,
+      :url_length => url_length
+    }
+    display_header(options)
+    display_view_nodes(SiteMap.view_nodes, options)
+    print "\n * - denotes an that this index is an alias of the previous node (that isn't an alias)"
+    print "\n indentation denotes children nodes"
+    print "\n\n"
+  end
+
+  def display_view_nodes(view_nodes, options={})
+    view_nodes.each do |view_node|
+      display_view_node(view_node, view_node.index, options)
+      view_node.aliases.each do |alias_key|
+        display_view_node(view_node, alias_key, options)
+      end
+      display_view_nodes(view_node.children, options.merge(:spacing => (options[:spacing] + 2)))
+    end
+  end
+
+  def display_view_node(view_node, key=nil, options={})
+    key ||= view_node.index
+    print "#{(' ' * options[:spacing])}#{key.inspect}#{'*' if key != view_node.index}".ljust(options[:index_length])
+    print " | "
+    print "#{view_node.label.inspect.ljust(options[:label_length])}"
+    print " | "
+    print "#{view_node.url.inspect.ljust(options[:url_length])}"
+    print " | "
+    print "#{view_node.visible.inspect}"
+    print "\n"
+  end
+
+  def display_header(options={})
+    print "Node Index".ljust(options[:index_length])
+    print " | "
+    print "Label".ljust(options[:label_length])
+    print " | "
+    print "URL".ljust(options[:url_length])
+    print " | "
+    print "Visible"
+    print "\n"
+  end
+end

data/lib/site_map/tasks.rb

@@ -0,0 +1,3 @@
+Dir[File.join(File.dirname(__FILE__), "tasks" ,"*.rake")].each do |file|
+  load File.join('site_map', 'tasks', File.basename(file))
+end

data/lib/site_map/version.rb

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

data/lib/site_map/view_node.rb

@@ -3,7 +3,7 @@ module SiteMap
 
   class ViewNode
     include SiteMap::Helpers::Mapping
-    ATTRIBUTES = [ :map, :index, :label, :url, :visible, :resource, :parent, :type ]
+    ATTRIBUTES = [ :map, :index, :label, :url, :visible, :resource, :parent, :node_type ]
     ATTRIBUTES.each{|attribute| attr_reader attribute }
 
     TYPES = [ :view, :group, :member, :collection ]
@@ -24,11 +24,11 @@ module SiteMap
       :show => BASE_URL_TEMPLATE[:member]
     }
 
-    def initialize(index, map, type, options={})
-      raise(ArgumentError, "index, map and type arguements required") unless index && map && type
+    def initialize(index, map, node_type, options={})
+      raise(ArgumentError, "index, map and node_type arguements required") unless index && map && node_type
       @index = index
       @map = map
-      @type = type
+      @node_type = node_type
       options.each do |method, value|
         instance_variable_set("@#{method}", value)
       end
@@ -49,6 +49,12 @@ module SiteMap
       @visible ? @visible : 'true'
     end
 
+    def aliases
+      @aliases ||= self.map.index_of_nodes.collect do |key, view_node|
+        key if view_node.index == self.index && key != self.index
+      end.compact
+    end
+
     def add_to_children(view_node)
       @view_nodes.push(view_node)
     end
@@ -74,12 +80,12 @@ module SiteMap
       @with_siblings ||= self.parent.children
     end
 
-    TYPES.each do |type|
-      self.send(:define_method, "#{type}?", lambda{ self.type == type })
+    TYPES.each do |node_type|
+      self.send(:define_method, "#{node_type}?", lambda{ self.node_type == node_type })
     end
 
     def inspect
-      attributes_string = [:index, :type, :label, :url, :visible].collect do |attribute|
+      attributes_string = [:index, :node_type, :label, :url, :visible].collect do |attribute|
         "#{attribute}: #{self.send(attribute).inspect}"
       end.join(", ")
       "#<#{self.class} #{attributes_string}>"
@@ -88,7 +94,7 @@ module SiteMap
     protected
 
     def default_label
-      case(@type)
+      case(@node_type)
       when :group
         self.title_string(@index)
       when :collection
@@ -100,7 +106,7 @@ module SiteMap
       end
     end
     def default_url
-      case(@type)
+      case(@node_type)
       when :group
         self.children.empty? ? @url : self.children.first.url
       when :collection
@@ -113,18 +119,18 @@ module SiteMap
     end
 
     def resource_label(resource_text)
-      template = (LABEL_ACTION_TEMPLATES[@action] || BASE_LABEL_TEMPLATE[@type])
+      template = (LABEL_ACTION_TEMPLATES[@action] || BASE_LABEL_TEMPLATE[@node_type])
       template.gsub(':action', self.title_string(@action.to_s)).gsub(':resource', resource_text)
     end
     def resource_url
-      resource_text = if @type == :collection
+      resource_text = if @node_type == :collection
         action_str = unless URL_ACTION_TEMPLATES[@action]
           @action.to_s
         end
-        parent_str = if [:member, :collection].include?(self.parent.type)
+        parent_str = if self.parent && [:member, :collection].include?(self.parent.node_type)
           self.single_string(self.parent.resource)
         end
-        template = (URL_ACTION_TEMPLATES[@action] || BASE_URL_TEMPLATE[@type])
+        template = (URL_ACTION_TEMPLATES[@action] || BASE_URL_TEMPLATE[@node_type])
         resourced_url = [action_str, parent_str, template].flatten.compact.join('_')
         resourced_url = [resourced_url, ("(@#{parent_str})" if parent_str)].compact.join
         resourced_url.gsub(':resource', (@action == :new ? self.single_string : @resource.to_s))
@@ -132,7 +138,7 @@ module SiteMap
         action_str = unless URL_ACTION_TEMPLATES[@action]
           @action.to_s
         end
-        template = (URL_ACTION_TEMPLATES[@action] || BASE_URL_TEMPLATE[@type])
+        template = (URL_ACTION_TEMPLATES[@action] || BASE_URL_TEMPLATE[@node_type])
         resourced_url = [action_str, template].flatten.compact.join('_')
         resourced_url.gsub(':resource', self.single_string)
       end
@@ -147,8 +153,8 @@ module SiteMap
       string.to_s.respond_to?(:titleize) ? string.to_s.titleize : string.to_s
     end
 
-    def view_node_params(new_index, type, options)
-      [new_index, self.map, type, options.merge(:parent => self)]
+    def view_node_params(new_index, node_type, options)
+      [new_index, self.map, node_type, options.merge(:parent => self)]
     end
 
   end

data/lib/site_map.rb

@@ -1,5 +1,7 @@
 Dir[File.join(File.dirname(__FILE__), "site_map" ,"*.rb")].each do |file|
-  require File.join('site_map', File.basename(file, ".rb"))
+  unless ['tasks', 'version'].include?(File.basename(file, ".rb"))
+    require File.join('site_map', File.basename(file, ".rb"))
+  end
 end
 
 module SiteMap

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: site_map
 version: !ruby/object:Gem::Version 
-  version: 0.2.9
+  version: 0.3.0
 platform: ruby
 authors: 
 - Collin Redding
@@ -29,6 +29,8 @@ files:
 - lib/site_map/helpers/mapping.rb
 - lib/site_map/helpers.rb
 - lib/site_map/map.rb
+- lib/site_map/tasks/view_nodes.rake
+- lib/site_map/tasks.rb
 - lib/site_map/version.rb
 - lib/site_map/view_helpers.rb
 - lib/site_map/view_node.rb