closure_tree 1.0.0.beta2 → 1.0.0.beta3

data/README.rdoc

@@ -79,17 +79,17 @@ Then:
   puts grandparent.self_and_descendants.collect{ |t| t.name }.join(" > ")
   "grandparent > parent > child"
 
-  child.ancestry_names
+  child.ancestry_path
   ["grandparent", "parent", "child"]
 
 === <code>find_or_create_by_path</code>
 
-If your model has a single string column that can build a given node (like a "name" or a "title"),
-you can use that to find_or_create:
+We can do all the node creation and add_child calls from the prior section with one method call:
+  child = Tag.find_or_create_by_path "grandparent", "parent", "child"
 
-  Tag.find_or_create_by_path %w{one two three}
+You can <code>find</code> as well as <code>find_or_create</code> by "ancestry paths". Ancestry paths may be built using any column in your model. The default column is <code>name</code>, which can be changed with the :name_column option provided to <code>acts_as_tree</code>.
 
-You can customize the column name with the :name_column option in <code>acts_as_tree</code>.
+Note that the other columns will be null if nodes are created, other than auto-generated columns like ID and created_at timestamp. Only the specified column will receive the path element value.
 
 == Accessing Data
 

data/lib/closure_tree/acts_as_tree.rb

@@ -91,10 +91,11 @@ module ClosureTree #:nodoc:
         [self].concat ancestors.to_a
       end
 
-      # Returns an array, root first, of self_and_ancestors' +name_column+ values
-      # (so child.ancestry_names == +%w{grandparent parent child}+
-      def ancestry_names
-        self_and_ancestors.reverse.collect { |n| n.send name_column.to_sym }
+      # Returns an array, root first, of self_and_ancestors' values of the +to_s_column+, which defaults
+      # to the +name_column+.
+      # (so child.ancestry_path == +%w{grandparent parent child}+
+      def ancestry_path to_s_column = name_column
+        self_and_ancestors.reverse.collect { |n| n.send to_s_column.to_sym }
       end
 
       def self_and_descendants
@@ -128,22 +129,25 @@ module ClosureTree #:nodoc:
         new_parent.add_child self
       end
 
-      # Find a child node whose +ancestry_names+ minus self.ancestry_names is +path+
-      def find_by_path path
-        _find_or_create_by_path path, "find_by_#{name_column}".to_sym
+      # Find a child node whose +ancestry_path+ minus self.ancestry_path is +path+.
+      # If the first argument is a symbol, it will be used as the column to search by
+      def find_by_path *path
+        _find_or_create_by_path "find", path
       end
 
-      # Find a child node whose +ancestry_names+ minus self.ancestry_names is +path+
-      def find_or_create_by_path path
-        _find_or_create_by_path path, "find_or_create_by_#{name_column}".to_sym
+      # Find a child node whose +ancestry_path+ minus self.ancestry_path is +path+
+      def find_or_create_by_path *path
+        _find_or_create_by_path "find_or_create", path
       end
 
       protected
 
-      def _find_or_create_by_path path, methodname
+      def _find_or_create_by_path method_prefix, path
+        to_s_column = path.first.is_a?(Symbol) ? path.shift.to_s : name_column
+        path.flatten!
         node = self
-        while (name = path.shift and node)
-          node = node.children.send(methodname, name)
+        while (s = path.shift and node)
+          node = node.children.send("#{method_prefix}_by_#{to_s_column}".to_sym, s)
         end
         node
       end
@@ -170,27 +174,29 @@ module ClosureTree #:nodoc:
         nil
       end
 
-      # Find the node whose +ancestry_names+ is +path+
-      def find_by_path path
-        self.where(name_sym => path.last).each do |n|
-          return n if path == n.ancestry_names
+      # Find the node whose +ancestry_path+ is +path+
+      # If the first argument is a symbol, it will be used as the column to search by
+      def find_by_path *path
+        to_s_column = path.first.is_a?(Symbol) ? path.shift.to_s : name_column
+        path.flatten!
+        self.where(to_s_column => path.last).each do |n|
+          return n if path == n.ancestry_path(to_s_column)
         end
         nil
       end
 
-      # Find or create nodes such that the +ancestry_names+ is +path+
-      def find_or_create_by_path path
+      # Find or create nodes such that the +ancestry_path+ is +path+
+      def find_or_create_by_path *path
         # short-circuit if we can:
         n = find_by_path path
         return n if n
 
-        name = path.shift
-        node = roots.where(name_sym => name).first
-        node = create!(name_sym => name) unless node
-        while (name = path.shift)
-          node = node.children.send("find_or_create_by_#{name_column}".to_sym, name)
-        end
-        node
+        column_sym = path.first.is_a?(Symbol) ? path.shift : name_sym
+        path.flatten!
+        s = path.shift
+        node = roots.where(column_sym => s).first
+        node = create!(column_sym => s) unless node
+        node.find_or_create_by_path column_sym, path
       end
 
       private

data/lib/closure_tree/version.rb

@@ -1,3 +1,3 @@
 module ClosureTree
-  VERSION = "1.0.0.beta2" unless defined?(::ClosureTree::VERSION)
+  VERSION = "1.0.0.beta3" unless defined?(::ClosureTree::VERSION)
 end

data/test/dummy/db/migrate/20110522004834_create_tags.rb

@@ -3,6 +3,7 @@ class CreateTags < ActiveRecord::Migration
 
     create_table :tags do |t|
       t.string :name
+      t.string :title
       t.integer :parent_id
       t.timestamps
     end

data/test/dummy/db/schema.rb

@@ -14,6 +14,7 @@ ActiveRecord::Schema.define(:version => 20110522004834) do
 
   create_table "tags", :force => true do |t|
     t.string   "name"
+    t.string   "title"
     t.integer  "parent_id"
     t.datetime "created_at"
     t.datetime "updated_at"

data/test/dummy/test/fixtures/tags.yml

@@ -2,15 +2,17 @@
 
 grandparent:
   name: grandparent
+  title: Nonnie
 
 parent:
   name: parent
   parent: grandparent
+  title: Mom
 
 child:
   name: child
   parent: parent
-
+  title: Kid 
 
 people:
   name: people

data/test/dummy/test/unit/tag_test.rb

@@ -57,26 +57,32 @@ class TagTest < ActiveSupport::TestCase
   end
 
   def test_ancestry_path
-    assert_equal %w{grandparent parent child}, tags(:child).ancestry_names
+    assert_equal %w{grandparent parent child}, tags(:child).ancestry_path
+    assert_equal %w{grandparent parent child}, tags(:child).ancestry_path(:name)
+    assert_equal %w{Nonnie Mom Kid}, tags(:child).ancestry_path(:title)
   end
 
   def test_find_by_path
     # class method:
     assert_equal tags(:child), Tag.find_by_path(%w{grandparent parent child})
-    assert_equal tags(:child), Tag.find_or_create_by_path(%w{grandparent parent child})
+    assert_equal tags(:child), Tag.find_by_path(:title, %w{Nonnie Mom Kid})
     # instance method:
     assert_equal tags(:child), tags(:parent).find_by_path(%w{child})
+    assert_equal tags(:child), tags(:parent).find_by_path(:title, %w{Kid})
     assert_equal tags(:child), tags(:grandparent).find_by_path(%w{parent child})
+    assert_equal tags(:child), tags(:grandparent).find_by_path(:title, %w{Mom Kid})
     assert_nil tags(:parent).find_by_path(%w{child larvae})
   end
 
   def test_find_or_create_by_path
     # class method:
-    assert_equal %w{events anniversary}, Tag.find_or_create_by_path(%w{events anniversary}).ancestry_names
+    assert_equal tags(:child), Tag.find_or_create_by_path(%w{grandparent parent child})
+    assert_equal tags(:child), Tag.find_or_create_by_path(:title, %w{Nonnie Mom Kid})
+    assert_equal %w{events anniversary}, Tag.find_or_create_by_path(%w{events anniversary}).ancestry_path
     a = Tag.find_or_create_by_path(%w{a})
-    assert_equal %w{a}, a.ancestry_names
+    assert_equal %w{a}, a.ancestry_path
     # instance method:
-    assert_equal %w{a b c}, a.find_or_create_by_path(%w{b c}).ancestry_names
+    assert_equal %w{a b c}, a.find_or_create_by_path(%w{b c}).ancestry_path
   end
 
   def test_descendants

metadata

@@ -2,7 +2,7 @@
 name: closure_tree
 version: !ruby/object:Gem::Version 
   prerelease: 6
-  version: 1.0.0.beta2
+  version: 1.0.0.beta3
 platform: ruby
 authors: []
 
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-25 00:00:00 -07:00
+date: 2011-05-26 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -73,7 +73,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -1571970483886197148
+      hash: 2257595380188246970
       segments: 
       - 0
       version: "0"