site_map 0.2.0

data/README.rdoc

@@ -0,0 +1,29 @@
+= SiteMap
+
+== Description
+
+SiteMap provides a way to model out your site's views in a hierarchal fashion. You configure your views and then it builds a tree structure from it that is easy to lookup specific nodes and also traverse their relationships, such as parent or children.
+
+== Installation
+
+    sudo gem install site_map
+
+== Basic Usage
+
+SiteMap by default looks for "config/site_map.rb" to try and load configurations from. Defining your site map is easy with a syntax similar to Rails routes:
+
+    SiteMap.define do |map|
+      map.view :user
+    end
+
+This creates a single view in your map that can be found with the index :user. Finding view node's is easy as well:
+
+    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.
+
+
+

data/Rakefile

@@ -0,0 +1,63 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'rake/testtask'
+
+require 'lib/site_map/version'
+
+spec = Gem::Specification.new do |s|
+  s.name             = 'site_map'
+  s.version          = SiteMap::Version.to_s
+  s.has_rdoc         = true
+  s.extra_rdoc_files = %w(README.rdoc)
+  s.rdoc_options     = %w(--main README.rdoc)
+  s.summary          = "SiteMap provides a way to model out your site's views in a hierarchal fashion."
+  s.author           = 'Collin Redding'
+  s.email            = 'TempestTTU@gmail.com'
+  s.homepage         = 'http://github.com/jcredding/site_map'
+  s.files            = %w(README.rdoc Rakefile) + Dir.glob("{lib}/**/*")
+  # s.executables    = ['site_map']
+
+  # s.add_dependency('gem_name', '~> 0.0.1')
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+
+  Rcov::RcovTask.new(:coverage) do |t|
+    t.libs       = ['test']
+    t.test_files = FileList["test/**/*_test.rb"]
+    t.verbose    = true
+    t.rcov_opts  = ['--text-report', "-x #{Gem.path}", '-x /Library/Ruby', '-x /usr/lib/ruby']
+  end
+
+  task :default => :coverage
+
+rescue LoadError
+  warn "\n**** Install rcov (sudo gem install relevance-rcov) to get coverage stats ****\n"
+  task :default => :test
+end
+
+
+desc 'Generate the gemspec to serve this gem'
+task :gemspec do
+  file = File.dirname(__FILE__) + "/#{spec.name}.gemspec"
+  File.open(file, 'w') {|f| f << spec.to_ruby }
+  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"
+end

data/lib/site_map/helpers/mapping.rb

@@ -0,0 +1,21 @@
+module SiteMap
+  module Helpers
+
+    module Mapping
+
+      def group(new_index, options={})
+        view_node = SiteMap::ViewNode.new(*view_node_params(new_index, options))
+        self.add_to_children(view_node)
+        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)
+        yield view_node if block_given?
+      end
+
+    end
+
+  end
+end

data/lib/site_map/helpers.rb

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

data/lib/site_map/map.rb

@@ -0,0 +1,42 @@
+require File.join('site_map', 'helpers', 'mapping')
+module SiteMap
+
+  class Map
+    include SiteMap::Helpers::Mapping
+    ATTRIBUTES = [:view_nodes, :index_of_nodes]
+    ATTRIBUTES.each{|attribute| attr_reader attribute }
+
+    def initialize
+      self.clear_nodes!
+    end
+
+    def find(view_node_index)
+      self.index_of_nodes[view_node_index.to_sym]
+    end
+
+    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
+    end
+
+    def clear_nodes!
+      @view_nodes = []
+      @index_of_nodes = {}
+    end
+
+    # convenience method
+    def map
+      self
+    end
+
+    protected
+
+    def view_node_params(index, options)
+      [index, self, options]
+    end
+
+  end
+
+end

data/lib/site_map/version.rb

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

data/lib/site_map/view_helpers.rb

@@ -0,0 +1,26 @@
+module SiteMap
+  module ViewHelpers
+
+    # Override in view scope to resolve against your labels
+    def view_node_label_options
+      {}
+    end
+
+    # subbing hash options into view node label code thanks to kelredd-useful
+    def view_node_label(view_node)
+      label_string = view_node.label
+      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)
+    end
+    def view_node_visible(view_node)
+      eval(view_node.visible)
+    end
+    alias :view_node_visible? :view_node_visible
+
+  end
+end

data/lib/site_map/view_node.rb

@@ -0,0 +1,63 @@
+require File.join('site_map', 'helpers', 'mapping')
+module SiteMap
+
+  class ViewNode
+    include SiteMap::Helpers::Mapping
+    ATTRIBUTES = [ :map, :index, :label, :url, :visible, :parent ]
+    ATTRIBUTES.each{|attribute| attr_reader attribute }
+
+    def initialize(index, map, options={})
+      raise(ArgumentError, "index and map arguements required") unless index && map
+      @index = index
+      @map = map
+      options.each do |method, value|
+        instance_variable_set("@#{method}", value)
+      end
+      @view_nodes = []
+    end
+
+    def [](attribute_sym)
+      instance_variable_get("@#{attribute_sym}")
+    end
+
+    def label
+      @label ? @label : @index.to_s
+    end
+    def visible
+      @visible ? @visible : 'true'
+    end
+
+    def add_to_children(view_node)
+      @view_nodes.push(view_node)
+    end
+
+    def children
+      @view_nodes
+    end
+    def ancestors
+      unless @ancestors
+        node, @ancestors = self, []
+        @ancestors << node = node.parent while node.parent
+        @ancestors.reverse!
+      end
+      @ancestors
+    end
+    def self_and_ancestors
+      @with_ancestors ||= self.ancestors.dup.push(self)
+    end
+    def siblings
+      @siblings ||= (self.self_and_siblings - [self])
+    end
+    def self_and_siblings
+      @with_siblings ||= self.parent.children
+    end
+
+    protected
+
+    def view_node_params(new_index, options)
+      [new_index, self.map, options.merge(:parent => self)]
+    end
+
+  end
+
+end

data/lib/site_map.rb

@@ -0,0 +1,37 @@
+Dir[File.join(File.dirname(__FILE__), "site_map" ,"*.rb")].each do |file|
+  require File.join('site_map', File.basename(file, ".rb"))
+end
+
+module SiteMap
+
+  def self.setup(*files)
+    files = files.first if files.first.is_a?(Array)
+    files << File.join('config', 'site_map.rb') if files.empty?
+    @@map ||= SiteMap::Map.new
+    @@map.clear_nodes!
+    files.each do |file|
+      begin
+        load file
+      rescue LoadError => exception
+      end
+    end
+  end
+
+  def self.[](view_node_index)
+    self.map.find(view_node_index.to_sym)
+  end
+
+  def self.view_nodes
+    self.map.view_nodes
+  end
+
+  def self.map
+    @@map
+  end
+
+  def self.define(&block)
+    yield @@map
+  end
+
+end
+SiteMap.setup

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification 
+name: site_map
+version: !ruby/object:Gem::Version 
+  version: 0.2.0
+platform: ruby
+authors: 
+- Collin Redding
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-15 00:00:00 -06:00
+default_executable: 
+dependencies: []
+
+description: 
+email: TempestTTU@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- README.rdoc
+- Rakefile
+- lib/site_map/helpers/mapping.rb
+- lib/site_map/helpers.rb
+- lib/site_map/map.rb
+- lib/site_map/version.rb
+- lib/site_map/view_helpers.rb
+- lib/site_map/view_node.rb
+- lib/site_map.rb
+has_rdoc: true
+homepage: http://github.com/jcredding/site_map
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: SiteMap provides a way to model out your site's views in a hierarchal fashion.
+test_files: []
+