closure_tree 1.0.0.beta1 → 1.0.0.beta2

data/README.rdoc

@@ -34,7 +34,7 @@ Note that closure_tree is being developed for Rails 3.1.0.rc1
 
       class CreateTagHierarchy < ActiveRecord::Migration
         def change
-          create_table :tags_hierarchy do |t|
+          create_table :tags_hierarchy, :id => false do |t|
             t.integer  :ancestor_id, :null => false   # ID of the parent/grandparent/great-grandparent/... tag
             t.integer  :descendant_id, :null => false # ID of the target tag
             t.integer  :generations, :null => false   # Number of generations between the ancestor and the descendant. Parent/child = 1, for example.
@@ -79,6 +79,18 @@ Then:
   puts grandparent.self_and_descendants.collect{ |t| t.name }.join(" > ")
   "grandparent > parent > child"
 
+  child.ancestry_names
+  ["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:
+
+  Tag.find_or_create_by_path %w{one two three}
+
+You can customize the column name with the :name_column option in <code>acts_as_tree</code>.
+
 == Accessing Data
 
 === Class methods

data/lib/closure_tree/acts_as_tree.rb

@@ -6,7 +6,8 @@ module ClosureTree #:nodoc:
       self.closure_tree_options = {
         :parent_column_name => 'parent_id',
         :dependent => :delete_all, # or :destroy
-        :hierarchy_table_suffix => '_hierarchies'
+        :hierarchy_table_suffix => '_hierarchies',
+        :name_column => 'name'
       }.merge(options)
 
       include ClosureTree::Columns
@@ -90,6 +91,12 @@ 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 }
+      end
+
       def self_and_descendants
         [self].concat descendants.to_a
       end
@@ -121,8 +128,26 @@ 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
+      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
+      end
+
       protected
 
+      def _find_or_create_by_path path, methodname
+        node = self
+        while (name = path.shift and node)
+          node = node.children.send(methodname, name)
+        end
+        node
+      end
+
       def without_self(scope)
         scope.where(["#{quoted_table_name}.#{self.class.primary_key} != ?", self])
       end
@@ -145,6 +170,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
+        end
+        nil
+      end
+
+      # Find or create nodes such that the +ancestry_names+ 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
+      end
+
       private
       def rebuild_node_and_children node
         node.parent.add_child node if node.parent
@@ -162,6 +210,18 @@ module ClosureTree #:nodoc:
       closure_tree_options[:parent_column_name]
     end
 
+    def has_name?
+      ct_class.new.attributes.include? closure_tree_options[:name_column]
+    end
+
+    def name_column
+      closure_tree_options[:name_column]
+    end
+
+    def name_sym
+      name_column.to_sym
+    end
+
     def hierarchy_table_name
       ct_table_name + closure_tree_options[:hierarchy_table_suffix]
     end

data/lib/closure_tree/version.rb

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

data/test/dummy/config/database.yml

@@ -28,6 +28,12 @@ test:
   password:
   socket: /tmp/mysql.sock
 
+test_sqlite:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 5000
+
 production:
   adapter: mysql2
   encoding: utf8

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

@@ -56,6 +56,29 @@ class TagTest < ActiveSupport::TestCase
     assert_equal [tags(:child), tags(:parent), tags(:grandparent)], tags(:child).self_and_ancestors
   end
 
+  def test_ancestry_path
+    assert_equal %w{grandparent parent child}, tags(:child).ancestry_names
+  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})
+    # instance method:
+    assert_equal tags(:child), tags(:parent).find_by_path(%w{child})
+    assert_equal tags(:child), tags(:grandparent).find_by_path(%w{parent child})
+    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
+    a = Tag.find_or_create_by_path(%w{a})
+    assert_equal %w{a}, a.ancestry_names
+    # instance method:
+    assert_equal %w{a b c}, a.find_or_create_by_path(%w{b c}).ancestry_names
+  end
+
   def test_descendants
     assert_equal [tags(:child)], tags(:parent).descendants
     assert_equal [tags(:parent), tags(:child)], tags(:parent).self_and_descendants

metadata

@@ -2,7 +2,7 @@
 name: closure_tree
 version: !ruby/object:Gem::Version 
   prerelease: 6
-  version: 1.0.0.beta1
+  version: 1.0.0.beta2
 platform: ruby
 authors: []
 
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-24 00:00:00 -07:00
+date: 2011-05-25 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: 170453244524217629
+      hash: -1571970483886197148
       segments: 
       - 0
       version: "0"