@@ -6,38 +6,38 @@ This plugin uses an acts_as_tree model and creates a breadcrumbs trail attribute
=== Homepage
-* http://actsasflinn.com/some_post_to_come
+* http://github.com/actsasflinn/acts_as_breadcrumbs
=== Installation
-* script/plugin install svn://rubyforge.org/var/svn/phillyonrails/acts_as_breadcrumbs/trunk
+* script/plugin install git://github.com/actsasflinn/acts_as_breadcrumbs.git
=== Requirements
-* acts_as_tree - The model has to acts_as_tree!
+* awesome_nested_set http://github.com/collectiveidea/awesome_nested_set
== Examples
class WebPage < ActiveRecord::Base
- acts_as_tree
- acts_as_breadcrumbs(:attr => :url, :basename => :slug, :separator => "/")
- acts_as_breadcrumbs(:basename => :title, :separator => " > ")
+ acts_as_nested_set
+ acts_as_breadcrumbs :url, :basename => :slug, :separator => "/"
+ acts_as_breadcrumbs :basename => :title, :separator => " > "
end
-web_page.urls #=> "foo/bar/baz"
+web_page.url #=> "foo/bar/baz"
web_page.breadcrumbs #=> "Foo > Bar > Baz"
class Location < ActiveRecord::Base
- acts_as_tree
- acts_as_breadcrumbs(:attr => :location_string)
+ acts_as_nested_set
+ acts_as_breadcrumbs :location_string
end
location.location_string #=> "HQ:FL01:RM03"
class Soldier < ActiveRecord::Base
- acts_as_tree
- acts_as_breadcrumbs(:attr => :chain_o_command, :separator => " > ")
+ acts_as_nested_set
+ acts_as_breadcrumbs :chain_o_command, :separator => " > "
end
soldier.chain_o_command #=> "General Hailstone > Colonel Stanley > LTC Mueller"
README
@@ -1,4 +1,4 @@
-# Copyright (c) 2007 Flinn Mueller
+# Copyright (c) 2007-2009 Flinn Mueller
# Released under the MIT License. See the MIT-LICENSE file for more details.
module ActiveRecord #:nodoc:
@@ -9,10 +9,10 @@ module ActiveRecord #:nodoc:
# attribute based on a base attribute.
module Breadcrumbs
def self.included(base) # :nodoc:
- base.extend ClassMethods
+ base.extend Crummy
end
- module ClassMethods
+ module Crummy
# acts_as_breadcrumbs creates a cached trail of breadcrumbs based
# on acts_as_tree methods, parent and children
#
@@ -25,65 +25,63 @@ module ActiveRecord #:nodoc:
# Examples:
#
# class WebPage < ActiveRecord::Base
- # acts_as_breadcrumbs(:attr => :url, :basename => :slug, :separator => "/")
- # acts_as_breadcrumbs(:basename => :title, :separator => " > ")
+ # acts_as_breadcrumbs :url, :basename => :slug, :separator => "/"
+ # acts_as_breadcrumbs :basename => :title, :separator => " > "
# end
#
- # web_page.urls #=> "foo/bar/baz"
+ # web_page.url #=> "foo/bar/baz"
# web_page.breadcrumbs #=> "Foo > Bar > Baz" # "Foo > Bar > Baz"
#
# class Location < ActiveRecord::Base
- # acts_as_breadcrumbs(:attr => :location_string)
+ # acts_as_breadcrumbs :location_string
# end
#
# location.location_string #=> "HQ:FL01:RM03"
#
# class Soldier < ActiveRecord::Base
- # acts_as_breadcrumbs(:attr => :chain_o_command, :separator => " > ")
+ # acts_as_breadcrumbs :chain_o_command, :separator => " > "
# end
#
# soldier.chain_o_command #=> "General Hailstone > Colonel Stanley > LTC Mueller"
#
- def acts_as_breadcrumbs(options = {})
- breadcrumbs_attr = options.delete(:attr) || :breadcrumbs
- breadcrumbs_basename = options.delete(:basename) || :name
- breadcrumbs_separator = options.delete(:separator) || ":"
- breadcrumbs_include_root = options.include?(:include_root) ? options.delete(:include_root) : true
+ def acts_as_breadcrumbs(*args)
+ include InstanceMethods
- # Creates a breadcrumb string based on an acts_as_tree model
- create = "
- def create_breadcrumb_#{breadcrumbs_attr}
- trail = self.ancestors.collect(&:#{breadcrumbs_basename})
- trail.reverse!
- trail << self.#{breadcrumbs_basename}
- trail.shift unless #{breadcrumbs_include_root}
- self.#{breadcrumbs_attr} = trail.join(\"#{breadcrumbs_separator}\")
- end
- "
+ options = args.extract_options!
+ options.reverse_merge!({ :basename => :name, :separator => ":", :include_root => true })
+ attribute = args.first || :breadcrumbs
- # Updates all this records's child breadcrumb strings
- # Go through each child, update the breadcrumb,
- # if it's different from the stored breadcrumb then save
- # then do the same of all of it's children
- update = "
- def update_breadcrumb_#{breadcrumbs_attr}
- children.each do |c|
- old_breadcrumbs = c.#{breadcrumbs_attr}
- c.create_breadcrumb_#{breadcrumbs_attr}
- c.save unless old_breadcrumbs == c.#{breadcrumbs_attr}
- c.update_breadcrumb_#{breadcrumbs_attr}
- end
- end
- "
+ self.send(:before_save, proc{ |record| record.set_breadcrumb_for(attribute, options) })
+ self.send(:after_save, proc{ |record| record.update_breadcrumb_for(attribute, options) })
+ end
+ end
+
+ module InstanceMethods
+ def breadcrumb_for(attribute, options = {})
+ crumbs = []
- save_callbacks = "
- before_save :create_breadcrumb_#{breadcrumbs_attr}
- after_save :update_breadcrumb_#{breadcrumbs_attr}
- "
+ if self.root?
+ crumbs << self.send(options[:basename]) if options[:include_root]
+ else
+ crumbs << self.send(options[:basename])
+ crumbs << self.parent.send(attribute)
+ end
- self.class_eval(create)
- self.class_eval(update)
- self.class_eval(save_callbacks)
+ crumbs = crumbs.collect{ |crumb| crumb unless crumb.blank? }.compact
+ crumbs.reverse.join(options[:separator])
+ end
+
+ def set_breadcrumb_for(attribute, options = {})
+ crumb = breadcrumb_for(attribute, options)
+ self.send("#{attribute}=".to_sym, crumb) unless crumb.blank?
+ end
+
+ def update_breadcrumb_for(attribute, options = {})
+ if self.send("#{options[:basename]}_changed?".to_sym)
+ descendants.each do |node|
+ node.class.update_all({ attribute => node.breadcrumb_for(attribute, options) }, :id => node.id)
+ end
+ end
end
end
lib/acts_as_breadcrumbs.rb
@@ -1,62 +1,81 @@
require File.join(File.dirname(__FILE__), 'test_helper')
class Node < ActiveRecord::Base
- acts_as_tree # need this
+ acts_as_nested_set # need this
acts_as_breadcrumbs
end
class Location < ActiveRecord::Base
- acts_as_tree # need this
- acts_as_breadcrumbs(:attr => :location_string)
+ acts_as_nested_set # need this
+ acts_as_breadcrumbs :location_string
end
class Soldier < ActiveRecord::Base
- acts_as_tree # need this
- acts_as_breadcrumbs(:attr => :chain_o_command, :separator => " > ", :include_root => false)
+ acts_as_nested_set # need this
+ acts_as_breadcrumbs :chain_o_command, :separator => " > ", :include_root => false
end
class WebPage < ActiveRecord::Base
- acts_as_tree # need this
- acts_as_breadcrumbs(:attr => :url, :basename => :slug, :separator => "/")
- acts_as_breadcrumbs(:basename => :title, :separator => " > ")
+ acts_as_nested_set # need this
+ acts_as_breadcrumbs :url, :basename => :slug, :separator => "/"
+ acts_as_breadcrumbs :basename => :title, :separator => " > "
+
+ def slug
+ title.parameterize.to_s
+ end
end
class BreadcrumbsTest < Test::Unit::TestCase
- fixtures :nodes, :locations, :soldiers, :web_pages
-
def test_no_options
- nodes(:node_3).save
- assert_equal "Root:Level 1:Level 2", nodes(:node_3).breadcrumbs
+ root = Node.create(:name => "Root")
+ child1 = root.children.create(:name => "Level 1")
+ child2 = child1.children.create(:name => "Level 2")
+ root2 = Node.create(:name => "Root 2")
+
+ assert_equal "Root:Level 1:Level 2", child2.breadcrumbs
end
def test_alternate_attribute
- locations(:location_3).save
- assert_equal "HQ:FL01:RM03", locations(:location_3).location_string
+ root = Location.create(:name => "HQ")
+ child1 = root.children.create(:name => "FL01")
+ child2 = child1.children.create(:name => "RM03")
+
+ assert_equal "HQ:FL01:RM03", child2.location_string
end
def test_basename
- web_pages(:web_page_3).save
- assert_equal "foo/bar/baz", web_pages(:web_page_3).url
+ root = WebPage.create(:title => "Foo")
+ child1 = root.children.create(:title => "Bar")
+ child2 = child1.children.create(:title => "Baz")
+
+ assert_equal "foo/bar/baz", child2.url
end
def test_separator
- soldiers(:soldier_4).save
- assert_equal "General Hailstone > Colonel Stanley > LTC Mueller", soldiers(:soldier_4).chain_o_command
+ root = Soldier.create(:name => "President Paul")
+ child1 = root.children.create(:name => "General Hailstone")
+ child2 = child1.children.create(:name => "Colonel Stanley")
+ child3 = child2.children.create(:name => "LTC Mueller")
+
+ assert_equal "General Hailstone > Colonel Stanley > LTC Mueller", child3.chain_o_command
end
def test_include_root
- locations(:location_1).save
- assert_equal "HQ", locations(:location_1).location_string
+ root = Location.create(:name => "HQ")
+ assert_equal "HQ", root.location_string
end
def test_not_include_root
- soldiers(:soldier_1).save
- assert_equal "", soldiers(:soldier_1).chain_o_command
+ root = Soldier.create(:name => "President Paul")
+ assert_equal "", root.chain_o_command
end
def test_two_breadcrumbs
- web_pages(:web_page_3).save
- assert_equal "foo/bar/baz", web_pages(:web_page_3).url
- assert_equal "Foo > Bar > Baz", web_pages(:web_page_3).breadcrumbs
+ root = WebPage.create(:title => "Foo")
+ child1 = root.children.create(:title => "Bar")
+ child2 = child1.children.create(:title => "Baz")
+
+ assert_equal "foo/bar/baz", child2.url
+ assert_equal "Foo > Bar > Baz", child2.breadcrumbs
end
end
\ No newline at end of file
test/breadcrumbs_test.rb
@@ -1,9 +1,9 @@
sqlite:
:adapter: sqlite
- :dbfile: acts_as_breadcrumbs_plugin.sqlite.db
+ :database: acts_as_breadcrumbs_plugin.sqlite.db
sqlite3:
:adapter: sqlite3
- :dbfile: acts_as_breadcrumbs_plugin.sqlite3.db
+ :database: acts_as_breadcrumbs_plugin.sqlite3.db
postgresql:
:adapter: postgresql
:username: postgres
test/database.yml
@@ -1,29 +1,43 @@
ActiveRecord::Schema.define(:version => 1) do
-
create_table :nodes, :force => true do |t|
- t.column :parent_id, :integer
- t.column :name, :string
- t.column :breadcrumbs, :string
+ t.string :name
+ t.string :breadcrumbs
+
+ # nested_set
+ t.integer :parent_id
+ t.integer :lft
+ t.integer :rgt
end
create_table :locations, :force => true do |t|
- t.column :parent_id, :integer
- t.column :name, :string
- t.column :location_string, :string
+ t.string :name
+ t.string :location_string
+
+ # nested_set
+ t.integer :parent_id
+ t.integer :lft
+ t.integer :rgt
end
create_table :soldiers, :force => true do |t|
- t.column :parent_id, :integer
- t.column :name, :string
- t.column :chain_o_command, :string
+ t.string :name
+ t.string :chain_o_command
+
+ # nested_set
+ t.integer :parent_id
+ t.integer :lft
+ t.integer :rgt
end
create_table :web_pages, :force => true do |t|
- t.column :parent_id, :integer
- t.column :title, :string
- t.column :slug, :string
- t.column :url, :string
- t.column :breadcrumbs, :string
- end
+ t.string :title
+ t.string :slug
+ t.string :url
+ t.string :breadcrumbs
+ # nested_set
+ t.integer :parent_id
+ t.integer :lft
+ t.integer :rgt
+ end
end
\ No newline at end of file
test/schema.rb
@@ -3,32 +3,10 @@ $:.unshift(File.dirname(__FILE__) + '/../lib')
require 'test/unit'
require File.expand_path(File.join(File.dirname(__FILE__), '../../../../config/environment.rb'))
require 'rubygems'
-require 'active_support/breakpoint'
require 'active_record/fixtures'
+require 'test_help'
config = YAML::load(IO.read(File.dirname(__FILE__) + '/database.yml'))
ActiveRecord::Base.logger = Logger.new(File.dirname(__FILE__) + "/debug.log")
-ActiveRecord::Base.establish_connection(config[ENV['DB'] || 'sqlite'])
-
+ActiveRecord::Base.establish_connection(config[ENV['DB'] || 'sqlite3'])
load(File.dirname(__FILE__) + "/schema.rb")
-
-Test::Unit::TestCase.fixture_path = File.dirname(__FILE__) + "/fixtures/"
-$LOAD_PATH.unshift(Test::Unit::TestCase.fixture_path)
-
-class Test::Unit::TestCase #:nodoc:
- def create_fixtures(*table_names)
- if block_given?
- Fixtures.create_fixtures(Test::Unit::TestCase.fixture_path, table_names) { yield }
- else
- Fixtures.create_fixtures(Test::Unit::TestCase.fixture_path, table_names)
- end
- end
-
- # Turn off transactional fixtures if you're working with MyISAM tables in MySQL
- self.use_transactional_fixtures = true
-
- # Instantiated fixtures are slow, but give you @david where you otherwise would need people(:david)
- self.use_instantiated_fixtures = false
-
- # Add more helper methods to be used by all tests here...
-end
\ No newline at end of file
test/test_helper.rb
test/fixtures/locations.yml
test/fixtures/nodes.yml
test/fixtures/soldiers.yml
test/fixtures/web_pages.yml
87f2daefa021ad6c48acd2f550a386f76fab66dd
Flinn
flinn@actsasflinn.com
http://github.com/actsasflinn/acts_as_breadcrumbs/commit/f6298840701ac5f001dac7380d7f9e2e83c8797c
f6298840701ac5f001dac7380d7f9e2e83c8797c
2009-11-05T23:21:17-08:00
2009-11-05T23:21:17-08:00
update to use awesome_nested_set
70d1c88f6dd8af8f2b36ec59dd2cfb12afc9e444
Flinn
flinn@actsasflinn.com