closure_tree 1.0.0.beta1

data/MIT-LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2011 Matthew McEachen
+
+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.rdoc

@@ -0,0 +1,109 @@
+= Closure Tree
+
+Closure Tree is a mostly-API-compatible replacement for the
+acts_as_tree and awesome_nested_set gems, but with much better
+mutation performance thanks to the Closure Tree storage algorithm.
+
+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.
+
+== Setup
+
+Note that closure_tree is being developed for Rails 3.1.0.rc1
+
+1.  Add this to your Gemfile: <code>gem 'closure_tree'</code>
+
+2.  Run <code>bundle install</code>
+
+3.  Add <code>acts_as_tree</code> to your hierarchical model(s).
+
+4.  Add a migration to add a <code>parent_id</code> column to the model you want to act_as_tree.
+
+    Note that if the column is null, the tag will be considered a root node.
+
+      class AddParentIdToTag < ActiveRecord::Migration
+        def change
+          add_column :tag, :parent_id, :integer
+        end
+      end
+
+5.  Add a database migration to store the hierarchy for your model. By
+    convention the table name will be the model's table name, followed by
+    "_hierarchy". Note that by calling <code>acts_as_tree</code>, a "virtual model" (in this case, <code>TagsHierarchy</code>) will be added automatically, so you don't need to create it.
+
+      class CreateTagHierarchy < ActiveRecord::Migration
+        def change
+          create_table :tags_hierarchy 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.
+          end
+
+          # For "all progeny of..." selects:
+          add_index :tags_hierarchy, [:ancestor_id, :descendant_id], :unique => true
+
+          # For "all ancestors of..." selects
+          add_index :tags_hierarchy, [:descendant_id]
+        end
+      end
+
+6.  Run <code>rake db:migrate</code>
+
+7.  If you're migrating away from another system where your model already has a
+    <code>parent_id</code> column, run <code>Tag.rebuild!</code> and the
+    ..._hierarchy table will be truncated and rebuilt.
+
+    If you're starting from scratch you don't need to call <code>rebuild!</code>.
+
+== Usage
+
+=== Creation
+
+Create a root node:
+
+  grandparent = Tag.create!(:name => 'Grandparent')
+
+There are two equivalent ways to add children. Either use the <code>add_child</code> method:
+
+  parent = Tag.create!(:name => 'Parent')
+  grandparent.add_child parent
+
+Or append to the <code>children</code> collection:
+
+  child = Tag.create!(:name => 'Child')
+  parent.children << child
+
+Then:
+
+  puts grandparent.self_and_descendants.collect{ |t| t.name }.join(" > ")
+  "grandparent > parent > child"
+
+== Accessing Data
+
+=== Class methods
+
+[Tag.root] returns an arbitrary root node
+[Tag.roots] returns all root nodes
+[Tag.leaves] returns all leaf nodes
+
+=== Instance methods
+
+[tag.root] returns the root for this node
+[tag.root?] returns true if this is a root node
+[tag.child?] returns true if this is a child node. It has a parent.
+[tag.leaf?] returns true if this is a leaf node. It has no children.
+[tag.level] returns the level, or "generation", for this node in the tree. A root node = 0
+[tag.parent] returns the node's immediate parent
+[tag.children] returns an array of immediate children (just those in the next level).
+[tag.ancestors] returns an array of all parents, parents' parents, etc, excluding self.
+[tag.self_and_ancestors] returns an array of all parents, parents' parents, etc, including self.
+[tag.siblings] returns an array of brothers and sisters (all at that level), excluding self.
+[tag.self_and_siblings] returns an array of brothers and sisters (all at that level), including self.
+[tag.descendants] returns an array of all children, childrens' children, etc., excluding self.
+[tag.self_and_descendants] returns an array of all children, childrens' children, etc., including self.
+
+== Thanks to
+
+* https://github.com/collectiveidea/awesome_nested_set
+* https://github.com/patshaughnessy/class_factory

data/Rakefile

@@ -0,0 +1,31 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+Bundler::GemHelper.install_tasks
+
+
+require 'rdoc/task'
+
+RDoc::Task.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ClosureTree'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/lib/closure_tree.rb

@@ -0,0 +1,3 @@
+require 'closure_tree/acts_as_tree'
+
+ActiveRecord::Base.send :extend, ClosureTree::ActsAsTree

data/lib/closure_tree/acts_as_tree.rb

@@ -0,0 +1,198 @@
+module ClosureTree #:nodoc:
+  module ActsAsTree #:nodoc:
+    def acts_as_tree options = {}
+
+      class_attribute :closure_tree_options
+      self.closure_tree_options = {
+        :parent_column_name => 'parent_id',
+        :dependent => :delete_all, # or :destroy
+        :hierarchy_table_suffix => '_hierarchies'
+      }.merge(options)
+
+      include ClosureTree::Columns
+      extend ClosureTree::Columns
+
+      # Auto-inject the hierarchy table
+      # See https://github.com/patshaughnessy/class_factory/blob/master/lib/class_factory/class_factory.rb
+      class_attribute :hierarchy_class
+      self.hierarchy_class = Object.const_set hierarchy_class_name, Class.new(ActiveRecord::Base)
+
+      self.hierarchy_class.class_eval <<-RUBY
+        belongs_to :ancestor, :class_name => "#{base_class.to_s}"
+        belongs_to :descendant, :class_name => "#{base_class.to_s}"
+      RUBY
+
+      include ClosureTree::Model
+
+      belongs_to :parent, :class_name => base_class.to_s,
+                 :foreign_key => parent_column_name
+
+      has_many :children,
+               :class_name => base_class.to_s,
+               :foreign_key => parent_column_name,
+               :before_add => :add_child
+
+      has_many :ancestors_hierarchy,
+               :class_name => hierarchy_class_name,
+               :foreign_key => "descendant_id"
+
+      has_many :ancestors, :through => :ancestors_hierarchy,
+               :order => "generations asc"
+
+      has_many :descendants_hierarchy,
+               :class_name => hierarchy_class_name,
+               :foreign_key => "ancestor_id"
+
+      has_many :descendants, :through => :descendants_hierarchy,
+               :order => "generations asc"
+
+      scope :roots, where(parent_column_name => nil)
+
+      scope :leaves, includes(:descendants_hierarchy).where("#{hierarchy_table_name}.descendant_id is null")
+    end
+  end
+
+  module Model
+    extend ActiveSupport::Concern
+    module InstanceMethods
+      def parent_id
+        self[parent_column_name]
+      end
+
+      def parent_id= new_parent_id
+        self[parent_column_name] = new_parent_id
+      end
+
+      # Returns true if this node has no parents.
+      def root?
+        parent_id.nil?
+      end
+
+      # Returns true if this node has no children.
+      def leaf?
+        children.empty?
+      end
+
+      def leaves
+        self.class.scoped.includes(:descendants_hierarchy).where("#{hierarchy_table_name}.descendant_id is null and #{hierarchy_table_name}.ancestor_id = #{id}")
+      end
+
+      # Returns true if this node has a parent, and is not a root.
+      def child?
+        !parent_id.nil?
+      end
+
+      def level
+        ancestors.size
+      end
+
+      def self_and_ancestors
+        [self].concat ancestors.to_a
+      end
+
+      def self_and_descendants
+        [self].concat descendants.to_a
+      end
+
+      def self_and_siblings
+        self.class.scoped.where(:parent_id => parent_id)
+      end
+
+      def siblings
+        without_self(self_and_siblings)
+      end
+
+      # You must use this method, or add child nodes to the +children+ association, to
+      # make the hierarchy table stay consistent.
+      def add_child child_node
+        child_node.update_attribute :parent_id, self.id
+        self_and_ancestors.inject(1) do |gen, ancestor|
+          hierarchy_class.create!(:ancestor => ancestor, :descendant => child_node, :generations => gen)
+          gen + 1
+        end
+        nil
+      end
+
+      def move_to_child_of new_parent
+        connection.execute <<-SQL
+          DELETE FROM #{quoted_hierarchy_table_name}
+          WHERE descendant_id = #{child_node.id}
+        SQL
+        new_parent.add_child self
+      end
+
+      protected
+
+      def without_self(scope)
+        scope.where(["#{quoted_table_name}.#{self.class.primary_key} != ?", self])
+      end
+
+    end
+
+    module ClassMethods
+      # Returns an arbitrary node that has no parents.
+      def root
+        roots.first
+      end
+
+      # Rebuilds the hierarchy table based on the parent_id column in the database.
+      # Note that the hierarchy table will be truncated.
+      def rebuild!
+        connection.execute <<-SQL
+          DELETE FROM #{quoted_hierarchy_table_name}
+        SQL
+        roots.each { |n| rebuild_node_and_children n }
+        nil
+      end
+
+      private
+      def rebuild_node_and_children node
+        node.parent.add_child node if node.parent
+        node.children.each { |child| rebuild_node_and_children child }
+      end
+    end
+  end
+
+  # Mixed into both classes and instances to provide easy access to the column names
+  module Columns
+
+    protected
+
+    def parent_column_name
+      closure_tree_options[:parent_column_name]
+    end
+
+    def hierarchy_table_name
+      ct_table_name + closure_tree_options[:hierarchy_table_suffix]
+    end
+
+    def hierarchy_class_name
+      hierarchy_table_name.singularize.camelize
+    end
+
+    def quoted_hierarchy_table_name
+      connection.quote_column_name hierarchy_table_name
+    end
+
+    def scope_column_names
+      Array closure_tree_options[:scope]
+    end
+
+    def quoted_parent_column_name
+      connection.quote_column_name parent_column_name
+    end
+
+    def ct_class
+      (self.is_a?(Class) ? self : self.class)
+    end
+
+    def ct_table_name
+      ct_class.table_name
+    end
+
+    def quoted_table_name
+      connection.quote_column_name ct_table_name
+    end
+
+  end
+end

data/lib/closure_tree/version.rb

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

data/lib/tasks/closure_tree_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :closure_tree do
+#   # Task goes here
+# end

data/test/dummy/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/test/dummy/app/models/tag.rb

@@ -0,0 +1,3 @@
+class Tag < ActiveRecord::Base
+  acts_as_tree
+end

data/test/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run Dummy::Application

data/test/dummy/config/application.rb

@@ -0,0 +1,53 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require
+require "closure_tree"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Custom directories with classes and modules you want to be autoloadable.
+    # config.autoload_paths += %W(#{config.root}/extras)
+
+    # Only load the plugins named here, in the order given (default is alphabetical).
+    # :all can be used as a placeholder for all plugins not explicitly named.
+    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+    # Activate observers that should always be running.
+    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # Please note that JavaScript expansions are *ignored altogether* if the asset
+    # pipeline is enabled (see config.assets.enabled below). Put your defaults in
+    # app/assets/javascripts/application.js in that case.
+    #
+    # JavaScript files you want as :defaults (application.js is always included).
+    # config.action_view.javascript_expansions[:defaults] = %w(prototype prototype_ujs)
+
+
+    # Configure the default encoding used in templates for Ruby 1.9.
+    config.encoding = "utf-8"
+
+    # Configure sensitive parameters which will be filtered from the log file.
+    config.filter_parameters += [:password]
+
+    # Enable IdentityMap for Active Record, to disable set to false or remove the line below.
+    config.active_record.identity_map = true
+
+    # Enable the asset pipeline
+    config.assets.enabled = true
+  end
+end
+

data/test/dummy/config/boot.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+gemfile = File.expand_path('../../../../Gemfile', __FILE__)
+
+if File.exist?(gemfile)
+  ENV['BUNDLE_GEMFILE'] = gemfile
+  require 'bundler'
+  Bundler.setup
+end
+
+$:.unshift File.expand_path('../../../../lib', __FILE__)

data/test/dummy/config/database.yml

@@ -0,0 +1,39 @@
+# MySQL.  Versions 4.1 and 5.0 are recommended.
+#
+# Install the MySQL driver:
+#   gem install mysql2
+#
+# And be sure to use new-style password hashing:
+#   http://dev.mysql.com/doc/refman/5.0/en/old-client.html
+development:
+  adapter: mysql2
+  encoding: utf8
+  reconnect: false
+  database: dummy_development
+  pool: 5
+  username: root
+  password:
+  socket: /tmp/mysql.sock
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: mysql2
+  encoding: utf8
+  reconnect: false
+  database: dummy_test
+  pool: 5
+  username: root
+  password:
+  socket: /tmp/mysql.sock
+
+production:
+  adapter: mysql2
+  encoding: utf8
+  reconnect: false
+  database: dummy_production
+  pool: 5
+  username: root
+  password:
+  socket: /tmp/mysql.sock

data/test/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the rails application
+require File.expand_path('../application', __FILE__)
+
+# Initialize the rails application
+Dummy::Application.initialize!

data/test/dummy/config/environments/development.rb

@@ -0,0 +1,25 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # In the development environment your application's code is reloaded on
+  # every request.  This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Log error messages when you accidentally call methods on nil.
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger
+  config.active_support.deprecation = :log
+
+  # Only use best-standards-support built into browsers
+  config.action_dispatch.best_standards_support = :builtin
+end
+

data/test/dummy/config/environments/production.rb

@@ -0,0 +1,52 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # Code is not reloaded between requests
+  config.cache_classes = true
+
+  # Full error reports are disabled and caching is turned on
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # Disable Rails's static asset server (Apache or nginx will already do this)
+  config.serve_static_assets = false
+
+  # Compress both stylesheets and JavaScripts
+  config.assets.js_compressor  = :uglifier
+  config.assets.css_compressor = :scss
+
+  # Specifies the header that your server uses for sending files
+  # (comment out if your front-end server doesn't support this)
+  config.action_dispatch.x_sendfile_header = "X-Sendfile" # Use 'X-Accel-Redirect' for nginx
+
+  # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
+  # config.force_ssl = true
+
+  # See everything in the log (default is :info)
+  # config.log_level = :debug
+
+  # Use a different logger for distributed setups
+  # config.logger = SyslogLogger.new
+
+  # Use a different cache store in production
+  # config.cache_store = :mem_cache_store
+
+  # Enable serving of images, stylesheets, and javascripts from an asset server
+  # config.action_controller.asset_host = "http://assets.example.com"
+
+  # Precompile additional assets (application.js, application.css, and all non-JS/CSS are already added)
+  # config.assets.precompile += %w( search.js )
+
+  # Disable delivery errors, bad email addresses will be ignored
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable threaded mode
+  # config.threadsafe!
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation can not be found)
+  config.i18n.fallbacks = true
+
+  # Send deprecation notices to registered listeners
+  config.active_support.deprecation = :notify
+end

data/test/dummy/config/environments/test.rb

@@ -0,0 +1,39 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # The test environment is used exclusively to run your application's
+  # test suite.  You never need to work with it otherwise.  Remember that
+  # your test database is "scratch space" for the test suite and is wiped
+  # and recreated between test runs.  Don't rely on the data there!
+  config.cache_classes = true
+
+  # Configure static asset server for tests with Cache-Control for performance
+  config.serve_static_assets = true
+  config.static_cache_control = "public, max-age=3600"
+
+  # Log error messages when you accidentally call methods on nil
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Raise exceptions instead of rendering exception templates
+  config.action_dispatch.show_exceptions = false
+
+  # Disable request forgery protection in test environment
+  config.action_controller.allow_forgery_protection    = false
+
+  # Tell Action Mailer not to deliver emails to the real world.
+  # The :test delivery method accumulates sent emails in the
+  # ActionMailer::Base.deliveries array.
+  config.action_mailer.delivery_method = :test
+
+  # Use SQL instead of Active Record's schema dumper when creating the test database.
+  # This is necessary if your schema can't be completely dumped by the schema dumper,
+  # like if you have constraints or database-specific column types
+  # config.active_record.schema_format = :sql
+
+  # Print deprecation notices to the stderr
+  config.active_support.deprecation = :stderr
+end

data/test/dummy/config/routes.rb

@@ -0,0 +1,3 @@
+Dummy::Application.routes.draw do
+
+end

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

@@ -0,0 +1,23 @@
+class CreateTags < ActiveRecord::Migration
+  def change
+
+    create_table :tags do |t|
+      t.string :name
+      t.integer :parent_id
+      t.timestamps
+    end
+
+    create_table :tags_hierarchies, :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.
+    end
+
+    # For "all progeny of..." selects:
+    add_index :tags_hierarchies, [:ancestor_id, :descendant_id], :unique => true
+
+    # For "all ancestors of..." selects
+    add_index :tags_hierarchies, :descendant_id
+
+  end
+end

data/test/dummy/db/schema.rb

@@ -0,0 +1,31 @@
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# Note that this schema.rb definition is the authoritative source for your
+# database schema. If you need to create the application database on another
+# system, you should be using db:schema:load, not running all the migrations
+# from scratch. The latter is a flawed and unsustainable approach (the more migrations
+# you'll amass, the slower it'll run and the greater likelihood for issues).
+#
+# It's strongly recommended to check this file into your version control system.
+
+ActiveRecord::Schema.define(:version => 20110522004834) do
+
+  create_table "tags", :force => true do |t|
+    t.string   "name"
+    t.integer  "parent_id"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+  create_table "tags_hierarchies", :id => false, :force => true do |t|
+    t.integer "ancestor_id",   :null => false
+    t.integer "descendant_id", :null => false
+    t.integer "generations",   :null => false
+  end
+
+  add_index "tags_hierarchies", ["ancestor_id", "descendant_id"], :name => "index_tags_hierarchies_on_ancestor_id_and_descendant_id", :unique => true
+  add_index "tags_hierarchies", ["descendant_id"], :name => "index_tags_hierarchies_on_descendant_id"
+
+end

data/test/dummy/script/rails

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require File.expand_path('../../config/boot',  __FILE__)
+require 'rails/commands'

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

@@ -0,0 +1,61 @@
+# Read about fixtures at http://api.rubyonrails.org/classes/Fixtures.html
+
+grandparent:
+  name: grandparent
+
+parent:
+  name: parent
+  parent: grandparent
+
+child:
+  name: child
+  parent: parent
+
+
+people:
+  name: people
+
+# people has no children
+
+events:
+  name: events
+
+# events has only one child
+
+birthday:
+  name: birthday
+  parent: events
+
+places:
+  name: places
+
+# places has many children, with many depths
+
+home:
+  name: home
+  parent: places
+
+indoor:
+  name: indoor
+  parent: places
+
+outdoor:
+  name: outdoor
+  parent: places
+
+museum:
+  name: museum
+  parent: places
+
+united_states:
+  name: united_states
+  parent: places
+
+california:
+  name: california
+  parent: united_states
+
+san_francisco:
+  name: san_francisco
+  parent: california
+

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

@@ -0,0 +1,75 @@
+require 'test_helper'
+
+class TagTest < ActiveSupport::TestCase
+
+  fixtures :tags
+
+  def setup
+    Tag.rebuild!
+  end
+
+  def test_roots
+    roots = Tag.roots.to_a
+    assert roots.include?(tags(:people))
+    assert roots.include?(tags(:events))
+    assert !roots.include?(tags(:child))
+    assert tags(:people).root?
+    assert !tags(:child).root?
+  end
+
+  def test_add_child
+    sb = Tag.create!(:name => "Santa Barbara")
+    assert sb.leaf?
+    tags(:california).add_child sb
+    assert sb.leaf?
+    validate_city_tag sb
+  end
+
+  def test_add_through_children
+    eg = Tag.create!(:name => "El Granada")
+    assert eg.leaf?
+    tags(:california).children << eg
+    assert eg.leaf?
+    validate_city_tag eg
+  end
+
+  def test_level
+    assert_equal 0, tags(:grandparent).level
+    assert_equal 1, tags(:parent).level
+    assert_equal 2, tags(:child).level
+  end
+
+  def test_parent
+    assert_equal nil, tags(:grandparent).parent
+    assert_equal tags(:grandparent), tags(:parent).parent
+    assert_equal tags(:parent), tags(:child).parent
+  end
+
+  def test_children
+    assert tags(:grandparent).children.include? tags(:parent)
+    assert tags(:parent).children.include? tags(:child)
+    assert tags(:child).children.empty?
+  end
+
+  def test_ancestors
+    assert_equal [tags(:parent), tags(:grandparent)], tags(:child).ancestors
+    assert_equal [tags(:child), tags(:parent), tags(:grandparent)], tags(:child).self_and_ancestors
+  end
+
+  def test_descendants
+    assert_equal [tags(:child)], tags(:parent).descendants
+    assert_equal [tags(:parent), tags(:child)], tags(:parent).self_and_descendants
+
+    assert_equal [tags(:parent), tags(:child)], tags(:grandparent).descendants
+    assert_equal [tags(:grandparent), tags(:parent), tags(:child)], tags(:grandparent).self_and_descendants
+
+    assert_equal "grandparent > parent > child", tags(:grandparent).self_and_descendants.collect { |t| t.name }.join(" > ")
+  end
+
+  def validate_city_tag city
+    assert tags(:california).children.include?(city)
+    assert_equal [tags(:california), tags(:united_states), tags(:places)], city.ancestors
+    assert_equal [city, tags(:california), tags(:united_states), tags(:places)], city.self_and_ancestors
+  end
+end
+

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+# Configure Rails Environment
+ENV["RAILS_ENV"] = "test"
+
+require File.expand_path("../dummy/config/environment.rb",  __FILE__)
+require "rails/test_help"
+
+Rails.backtrace_cleaner.remove_silencers!
+
+# Load support files
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification 
+name: closure_tree
+version: !ruby/object:Gem::Version 
+  prerelease: 6
+  version: 1.0.0.beta1
+platform: ruby
+authors: []
+
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-24 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+description: "  A mostly-API-compatible replacement for the acts_as_tree and awesome_nested_set gems,\n  but with much better mutation performance thanks to the Closure Tree storage algorithm\n"
+email: 
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/closure_tree/acts_as_tree.rb
+- lib/closure_tree/version.rb
+- lib/closure_tree.rb
+- lib/tasks/closure_tree_tasks.rake
+- MIT-LICENSE
+- Rakefile
+- README.rdoc
+- test/dummy/Rakefile
+- test/dummy/app/models/.gitkeep
+- test/dummy/app/models/tag.rb
+- test/dummy/config.ru
+- test/dummy/config/application.rb
+- test/dummy/config/boot.rb
+- test/dummy/config/database.yml
+- test/dummy/config/environment.rb
+- test/dummy/config/environments/development.rb
+- test/dummy/config/environments/production.rb
+- test/dummy/config/environments/test.rb
+- test/dummy/config/routes.rb
+- test/dummy/db/migrate/20110522004834_create_tags.rb
+- test/dummy/db/schema.rb
+- test/dummy/log/.gitkeep
+- test/dummy/script/rails
+- test/dummy/test/fixtures/tags.yml
+- test/dummy/test/unit/tag_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 170453244524217629
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 1.3.1
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Hierarchies for ActiveRecord models using a Closure Tree storage algorithm
+test_files: 
+- test/dummy/Rakefile
+- test/dummy/app/models/.gitkeep
+- test/dummy/app/models/tag.rb
+- test/dummy/config.ru
+- test/dummy/config/application.rb
+- test/dummy/config/boot.rb
+- test/dummy/config/database.yml
+- test/dummy/config/environment.rb
+- test/dummy/config/environments/development.rb
+- test/dummy/config/environments/production.rb
+- test/dummy/config/environments/test.rb
+- test/dummy/config/routes.rb
+- test/dummy/db/migrate/20110522004834_create_tags.rb
+- test/dummy/db/schema.rb
+- test/dummy/log/.gitkeep
+- test/dummy/script/rails
+- test/dummy/test/fixtures/tags.yml
+- test/dummy/test/unit/tag_test.rb
+- test/test_helper.rb