path_finder 1.0.0

data/.gitignore

@@ -0,0 +1 @@
+pkg/**

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 [name of plugin creator]
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.textile

@@ -0,0 +1,44 @@
+h2. PathFinder
+
+A Rails plugin which extends ActiveRecord using the decorator pattern to allow self-referential models (eg. acts_as_tree) to maintain a textual path representing itself and its ancestors.
+
+h3. Install
+
+gem install path_finder
+
+h3. Example
+
+In association with a catch-all route you can find a record using the URL:
+
+Hierarchy -> Generated Path
+
+# Categories -> /categories
+## Books -> /categories/books
+### Hardback -> /categories/books/hardback
+### Paperback -> /categories/books/paperback
+## Websites -> /categories/websites
+	
+Example URL: http://mywebsite.co.uk/categories/books/hardback
+	
+_category_controller.rb_
+
+def show
+  @category = Category.find_by_path(request.path)
+end
+
+_category.rb_
+
+class Category < ActiveRecord::Base
+  acts_as_tree
+  path_finder :column => 'path', :uid => 'to_param', :deliminator => '/'
+
+	def to_param
+		permalink
+	end
+end
+
+h3. Notes
+
+The model must respond_to 'children'
+
+Copyright (c) 2010 Kris Leech, released under the MIT license

data/Rakefile

@@ -0,0 +1,38 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the path_finder plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the path_finder plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'PathFinder'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "path_finder"
+    gemspec.summary = "Textual path for self-referential models"
+    gemspec.description = "Textual path for self-referential models"
+    gemspec.email = "kris.leech@interkonect.com"
+    gemspec.homepage = "http://github.com/krisleech/Path-Finder"
+    gemspec.authors = ["Kris Leech"]
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end
+

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/init.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + "/rails/init"

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/path_finder.rb

@@ -0,0 +1,148 @@
+# PathFinder
+
+# Usage:
+# path_finder :column => 'path', :uid => 'to_param', :deliminator => '/'
+
+module PathFinder
+
+    
+  def path_finder(options = {})
+    raise "Options for path_finder must be a Hash" unless options.is_a? Hash
+    options.each do |key, value|
+      unless [:column, :uid, :deliminator].include? key
+        raise "Unknown option for path_finder: #{key.inspect} => #{value.inspect}."
+      end
+    end
+
+    send :include, InstanceMethods
+    send :extend, ClassMethods
+
+    options = {
+            :column => 'path',
+            :uid => 'to_param',
+            :deliminator => '/'
+          }.merge(options)
+
+    # Create class attributes for options and set defaults
+    self.cattr_accessor :path_finder_column
+    self.path_finder_column = options[:column] #|| 'path'
+
+    self.cattr_accessor :path_finder_uid
+    self.path_finder_uid = options[:uid] #|| 'to_param'
+
+    self.cattr_accessor :path_finder_deliminator
+    self.path_finder_deliminator = options[:deliminator] #|| '/'
+
+    before_validation_on_create :set_path
+    validates_presence_of self.path_finder_column.to_sym
+
+    if options[:set_depth]
+      # add before_save to set depth column
+    end
+
+  end # end path_finder
+
+
+  module ClassMethods
+    def path_finder_added?
+      true
+    end
+
+    # Recalculate all paths for given collection
+    def recreate_paths!(collection = nil)
+      raise 'No collection given' unless collection.is_a? Array
+      collection.each do |obj|
+        obj.recreate_path!
+        self.recreate_paths!(obj.children) unless obj.children.empty?
+      end
+    end
+  end
+
+  module InstanceMethods
+    # Note: self is an instance of "ActiveRecord"
+
+
+    # FIXME: private
+    # before_validation_on_create
+    def set_path
+      return unless self.send(self.class.path_finder_column).blank?
+      unless self.root?
+        self.send(self.class.path_finder_column + '=', [self.parent.send(self.class.path_finder_column), self.send(self.class.path_finder_uid)].join(self.class.path_finder_deliminator).gsub('//', '/'))
+      else
+        self.send(self.class.path_finder_column + '=', self.send(self.class.path_finder_uid))
+      end
+    end
+
+    def path_array
+      unless self.send(self.class.path_finder_column).blank?
+        self.send(self.class.path_finder_column.split(self.class.path_finder_deliminator))
+      else
+        if new_record? && parent
+          parent.path_array + [self.send(self.class.path_finder_uid)]
+        else
+          [] # this should not be possible (test required)
+        end
+      end
+    end
+
+    def leaf?
+      children.empty?
+    end
+
+    def node?
+      !leaf?
+    end
+
+    def root?
+      parent_id.nil?
+    end
+
+    # return a breadcrumb for any attribute
+    def path_text(attribute = 'name', join = ' | ')
+      ancestors.collect { |item| item.send(attribute) }.join(join)
+    end
+
+    def self_and_descendants
+      descendants + [self]
+    end
+
+    def descendants
+      children.map(&:descendants).flatten + children
+    end
+
+    def recreate_path!
+      set_path
+      save!
+    end
+
+    # Call method for ancestors, stop if we get an non-nil answer
+    def send_down(*args)
+      result = self.send(*args)
+      if result.nil? && !self.root?
+        result = self.parent.send_down(*args)
+      end
+      result
+    end
+
+    # Call method on all children
+    def send_up(*args)
+      return if children.empty?
+      children.each do | child |
+        child.send_up(*args)
+      end
+    end
+
+    # ALTERNATIVE
+    #   def self_and_descendants
+    #    self.class.find(:all, :conditions => ['path LIKE ?', self.path + '%'])
+    #  end
+    #
+    #
+    #  def descendants
+    #    self_and_all_children.reject { |c| c.id == self.id }
+    #  end
+    #
+  end
+end
+
+ActiveRecord::Base.send :extend, PathFinder

data/path_finder.gemspec

@@ -0,0 +1,53 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{path_finder}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Kris Leech"]
+  s.date = %q{2010-02-11}
+  s.description = %q{Textual path for self-referential models}
+  s.email = %q{kris.leech@interkonect.com}
+  s.extra_rdoc_files = [
+    "README.textile"
+  ]
+  s.files = [
+    ".gitignore",
+     "MIT-LICENSE",
+     "README.textile",
+     "Rakefile",
+     "VERSION",
+     "init.rb",
+     "install.rb",
+     "lib/path_finder.rb",
+     "path_finder.gemspec",
+     "rails/init.rb",
+     "tasks/path_finder_tasks.rake",
+     "test/path_finder_test.rb",
+     "test/test_helper.rb",
+     "uninstall.rb"
+  ]
+  s.homepage = %q{http://github.com/krisleech/Path-Finder}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Textual path for self-referential models}
+  s.test_files = [
+    "test/path_finder_test.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/rails/init.rb

@@ -0,0 +1 @@
+require 'path_finder'

data/tasks/path_finder_tasks.rake

@@ -0,0 +1,4 @@
+ desc ""
+ task :path_finder do
+   puts 'Hello World!'
+ end

data/test/path_finder_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class PathFinderTest < ActiveSupport::TestCase
+  # Replace this with your real tests.
+  test "the truth" do
+    assert true
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'active_support'
+require 'active_support/test_case'

data/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification 
+name: path_finder
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Kris Leech
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-11 00:00:00 +00:00
+default_executable: 
+dependencies: []
+
+description: Textual path for self-referential models
+email: kris.leech@interkonect.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.textile
+files: 
+- .gitignore
+- MIT-LICENSE
+- README.textile
+- Rakefile
+- VERSION
+- init.rb
+- install.rb
+- lib/path_finder.rb
+- path_finder.gemspec
+- rails/init.rb
+- tasks/path_finder_tasks.rake
+- test/path_finder_test.rb
+- test/test_helper.rb
+- uninstall.rb
+has_rdoc: true
+homepage: http://github.com/krisleech/Path-Finder
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: Textual path for self-referential models
+test_files: 
+- test/path_finder_test.rb
+- test/test_helper.rb