closure_tree 3.5.2 → 3.6.0

data/README.md

@@ -1,4 +1,4 @@
-# Closure Tree [![Build Status](https://secure.travis-ci.org/mceachen/closure_tree.png?branch=master)](http://travis-ci.org/mceachen/closure_tree)
+# Closure Tree
 
 Closure Tree is a mostly-API-compatible replacement for the
 [ancestry](https://github.com/stefankroes/ancestry),
@@ -18,6 +18,17 @@ See [Bill Karwin](http://karwin.blogspot.com/)'s excellent
 [Models for hierarchical data presentation](http://www.slideshare.net/billkarwin/models-for-hierarchical-data)
 for a description of different tree storage algorithms.
 
+## Table of Contents
+
+- [Installation](#installation)
+- [Usage](#usage)
+- [Accessing Data](#accessing-data)
+- [Polymorphic hierarchies with STI](#sti)
+- [Deterministic ordering](#deterministic-ordering)
+- [FAQ](#faq)
+- [Testing](#testing)
+- [Change log](#change-log)
+
 ## Installation
 
 Note that closure_tree only supports Rails 3.0 and later, and has test coverage for MySQL, PostgreSQL, and SQLite.
@@ -187,7 +198,8 @@ HT: [ancestry](https://github.com/stefankroes/ancestry#arrangement) and [elhoyos
 When you include ```acts_as_tree``` in your model, you can provide a hash to override the following defaults:
 
 * ```:parent_column_name``` to override the column name of the parent foreign key in the model's table. This defaults to "parent_id".
-* ```:hierarchy_table_name``` to override the hierarchy table name. This defaults to the singular name of the model + "_hierarchies".
+* ```:hierarchy_table_name``` to override the hierarchy class name. This defaults to the singular name of the model + "Hierarchy", like ```TagHierarchy```.
+* ```:hierarchy_table_name``` to override the hierarchy table name. This defaults to the singular name of the model + "_hierarchies", like ```tag_hierarchies```.
 * ```:dependent``` determines what happens when a node is destroyed. Defaults to ```nullify```.
     * ```:nullify``` will simply set the parent column to null. Each child node will be considered a "root" node. This is the default.
     * ```:delete_all``` will delete all descendant nodes (which circumvents the destroy hooks)
@@ -321,6 +333,15 @@ root.children.collect(&:name)
 => ["a", "b", "c"]
 ```
 
+## FAQ
+
+### Does this gem support multiple parents?
+
+No. This gem's API is based on the assumption that each node has either 0 or 1 parent.
+
+The underlying closure tree structure will support multiple parents, but there would be many
+breaking-API changes to support it. I'm open to suggestions and pull requests.
+
 ## Testing
 
 Closure tree is [tested under every combination](http://travis-ci.org/#!/mceachen/closure_tree) of
@@ -331,6 +352,13 @@ Closure tree is [tested under every combination](http://travis-ci.org/#!/mceache
 
 ## Change log
 
+### 3.6.0
+
+* Added support for:
+  * ```:hierarchy_class_name``` as an option
+  * ActiveRecord::Base.table_name_prefix
+  * ActiveRecord::Base.table_name_suffix
+
 ### 3.5.2
 
 * Added ```find_all_by_generation```

data/Rakefile

@@ -16,5 +16,11 @@ RSpec::Core::RakeTask.new(:spec)
 
 task :default => :spec
 
+task :specs_with_db_ixes do
+  [["", ""], ["db_prefix_", ""], ["", "_db_suffix"], ["abc_", "_123"]].each do |prefix, suffix|
+    fail unless system("rake spec DB_PREFIX=#{prefix} DB_SUFFIX=#{suffix}")
+  end
+end
+
 # Run the specs using all the different database engines:
-# for DB in sqlite3 mysql postgresql ; do rake ; done
+# for DB in sqlite3 mysql postgresql ; do rake ; done

data/lib/closure_tree/acts_as_tree.rb

@@ -31,6 +31,8 @@ module ClosureTree
         alias :eql? :==
       RUBY
 
+      self.hierarchy_class.table_name = hierarchy_table_name
+
       unless order_option.nil?
         include ClosureTree::DeterministicOrdering
         include ClosureTree::DeterministicNumericOrdering if order_is_numeric
@@ -388,12 +390,17 @@ module ClosureTree
     end
 
     def hierarchy_table_name
-      # We need to use the table_name, not ct_class.to_s.demodulize, because they may have overridden the table name
-      closure_tree_options[:hierarchy_table_name] || ct_table_name.singularize + "_hierarchies"
+      # We need to use the table_name, not something like ct_class.to_s.demodulize + "_hierarchies",
+      # because they may have overridden the table name, which is what we want to be consistent with
+      # in order for the schema to make sense.
+      tablename = closure_tree_options[:hierarchy_table_name] ||
+        remove_prefix_and_suffix(ct_table_name).singularize + "_hierarchies"
+
+      ActiveRecord::Base.table_name_prefix + tablename + ActiveRecord::Base.table_name_suffix
     end
 
     def hierarchy_class_name
-      hierarchy_table_name.singularize.camelize
+      closure_tree_options[:hierarchy_class_name] || ct_class.to_s + "Hierarchy"
     end
 
     def quoted_hierarchy_table_name
@@ -445,6 +452,12 @@ module ClosureTree
     def quoted_table_name
       connection.quote_column_name ct_table_name
     end
+
+    def remove_prefix_and_suffix(table_name)
+      prefix = Regexp.escape(ActiveRecord::Base.table_name_prefix)
+      suffix = Regexp.escape(ActiveRecord::Base.table_name_suffix)
+      table_name.gsub(/^#{prefix}(.+)#{suffix}$/, "\\1")
+    end
   end
 
   module DeterministicOrdering

data/lib/closure_tree/version.rb

@@ -1,3 +1,3 @@
 module ClosureTree
-  VERSION = "3.5.2" unless defined?(::ClosureTree::VERSION)
+  VERSION = "3.6.0" unless defined?(::ClosureTree::VERSION)
 end

data/spec/cuisine_type_spec.rb

@@ -25,6 +25,6 @@ describe CuisineType do
   end
 
   it "sets the table_name of the hierarchy class properly" do
-    CuisineTypeHierarchy.table_name.should == "cuisine_type_hierarchies"
+    CuisineTypeHierarchy.table_name.should == ActiveRecord::Base.table_name_prefix + "cuisine_type_hierarchies" + ActiveRecord::Base.table_name_suffix
   end
 end

data/spec/db/schema.rb

@@ -1,72 +1,82 @@
 # encoding: UTF-8
+class ActiveRecord::ConnectionAdapters::AbstractAdapter
+  def force_add_index(table_name, columns, options = {})
+    begin
+      remove_index!(table_name, options[:name])
+    rescue ActiveRecord::StatementInvalid, ArgumentError
+    end
+    add_index table_name, columns, options
+  end
+end
+
 ActiveRecord::Schema.define(:version => 0) do
 
   create_table "tags", :force => true do |t|
-    t.string   "name"
-    t.string   "title"
-    t.integer  "parent_id"
-    t.integer  "sort_order"
+    t.string "name"
+    t.string "title"
+    t.integer "parent_id"
+    t.integer "sort_order"
     t.datetime "created_at"
     t.datetime "updated_at"
   end
 
   create_table "tag_hierarchies", :id => false, :force => true do |t|
-    t.integer "ancestor_id",   :null => false
+    t.integer "ancestor_id", :null => false
     t.integer "descendant_id", :null => false
-    t.integer "generations",   :null => false
+    t.integer "generations", :null => false
   end
 
   create_table "destroyed_tags", :force => true do |t|
-    t.string   "name"
+    t.string "name"
   end
 
-  add_index :tag_hierarchies, [:ancestor_id, :descendant_id], :unique => true
-  add_index :tag_hierarchies, [:descendant_id]
+  force_add_index "tag_hierarchies", [:ancestor_id, :descendant_id], :unique => true, :name => "tag_anc_desc_idx"
+  force_add_index "tag_hierarchies", [:descendant_id], :name => "tag_desc_idx"
 
   create_table "users", :force => true do |t|
-    t.string   "email"
-    t.integer  "referrer_id"
+    t.string "email"
+    t.integer "referrer_id"
     t.datetime "created_at"
     t.datetime "updated_at"
   end
 
   create_table "contracts", :force => true do |t|
-    t.integer  "user_id",   :null => false
+    t.integer "user_id", :null => false
   end
 
   create_table "referral_hierarchies", :id => false, :force => true do |t|
-    t.integer "ancestor_id",   :null => false
+    t.integer "ancestor_id", :null => false
     t.integer "descendant_id", :null => false
-    t.integer "generations",   :null => false
+    t.integer "generations", :null => false
   end
 
-  add_index :referral_hierarchies, [:ancestor_id, :descendant_id], :unique => true
-  add_index :referral_hierarchies, [:descendant_id]
+  force_add_index "referral_hierarchies", [:ancestor_id, :descendant_id], :unique => true, :name => "ref_anc_desc_idx"
+  force_add_index "referral_hierarchies", [:descendant_id], :name => "ref_desc_idx"
 
   create_table "labels", :force => true do |t|
-    t.string   "name"
-    t.string   "type"
-    t.integer  "sort_order"
-    t.integer  "mother_id"
+    t.string "name"
+    t.string "type"
+    t.integer "sort_order"
+    t.integer "mother_id"
   end
 
   create_table "label_hierarchies", :id => false, :force => true do |t|
-    t.integer "ancestor_id",   :null => false
+    t.integer "ancestor_id", :null => false
     t.integer "descendant_id", :null => false
-    t.integer "generations",   :null => false
+    t.integer "generations", :null => false
   end
 
-  add_index :label_hierarchies, [:ancestor_id, :descendant_id], :unique => true
-  add_index :label_hierarchies, [:descendant_id]
+  force_add_index "label_hierarchies", [:ancestor_id, :descendant_id], :unique => true, :name => "lh_anc_desc_idx"
+  force_add_index "label_hierarchies", [:descendant_id], :name => "lh_desc_idx"
 
   create_table "cuisine_types", :force => true do |t|
-    t.string   "name"
-    t.integer  "parent_id"
+    t.string "name"
+    t.integer "parent_id"
   end
 
   create_table "cuisine_type_hierarchies", :id => false, :force => true do |t|
-    t.integer "ancestor_id",   :null => false
+    t.integer "ancestor_id", :null => false
     t.integer "descendant_id", :null => false
-    t.integer "generations",   :null => false
+    t.integer "generations", :null => false
   end
 end

data/spec/spec_helper.rb

@@ -14,21 +14,19 @@ require 'action_controller' # rspec-rails needs this :(
 
 require 'closure_tree'
 
-log = Logger.new(plugin_test_dir + "/debug.log")
-log.sev_threshold = Logger::DEBUG
-log.datetime_format = "%Y-%m-%d %H:%M:%S"
-log.formatter = Logger::Formatter.new
-
-ActiveRecord::Base.logger = log
+#log = Logger.new(STDOUT)
+#log.sev_threshold = Logger::DEBUG
+#ActiveRecord::Base.logger = log
 
 require 'yaml'
 require 'erb'
 ENV["DB"] ||= "sqlite3mem"
+ActiveRecord::Base.table_name_prefix = ENV['DB_PREFIX'].to_s
+ActiveRecord::Base.table_name_suffix = ENV['DB_SUFFIX'].to_s
 ActiveRecord::Base.configurations = YAML::load(ERB.new(IO.read(plugin_test_dir + "/db/database.yml")).result)
 ActiveRecord::Base.establish_connection(ENV["DB"])
 ActiveRecord::Migration.verbose = false
-load(File.join(plugin_test_dir, "db", "schema.rb"))
-
+require 'db/schema'
 require 'support/models'
 require 'rspec/rails' # TODO: clean this up-- I don't want to pull the elephant through the mouse hole just for fixture support
 

data/spec/support/models.rb

@@ -20,6 +20,7 @@ end
 class User < ActiveRecord::Base
   acts_as_tree :parent_column_name => "referrer_id",
     :name_column => 'email',
+    :hierarchy_class_name => 'ReferralHierarchy',
     :hierarchy_table_name => 'referral_hierarchies'
 
   has_many :contracts

data/spec/tag_spec.rb

@@ -390,7 +390,7 @@ end
 describe "Tag with AR whitelisted attributes enabled" do
   before(:all) do
     ActiveRecord::Base.attr_accessible(nil) # turn on whitelisted attributes
-    ActiveRecord::Base.subclasses.each{|ea|ea.reset_column_information}
+    ActiveRecord::Base.descendants.each{|ea|ea.reset_column_information}
   end
   it_behaves_like Tag
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: closure_tree
 version: !ruby/object:Gem::Version
-  version: 3.5.2
+  version: 3.6.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-04 00:00:00.000000000 Z
+date: 2012-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -192,7 +192,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4543577055875281407
+      hash: 1756781626803345033
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -201,7 +201,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4543577055875281407
+      hash: 1756781626803345033
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23