acts_as_better_tree 0.9.3

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in acts_as_better_tree.gemspec
+gemspec
+gem 'sqlite3'
+gem 'rspec'
+gem 'rails', ">= 3.2.5"
+gem "factory_girl"

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Isaac Sloan
+
+MIT License
+
+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.md

@@ -0,0 +1,62 @@
+# ActsAsBetterTree
+
+acts_as_better_tree is great for anyone who needs a fast tree capable of handling millions of nodes without slowing down on writes like nestedset or on reads like a standard tree.
+It is backwards compatible with acts_as_tree and remains fast with large datasets by storing the ancestry of every node in the field csv_ids.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'acts_as_better_tree'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install acts_as_better_tree
+
+## Usage
+
+    Required fields are parent_id, root_id, csv_ids.
+
+    create_table :categories do |t|
+     t.column :root_id, :integer
+     t.column :parent_id, :integer
+     t.column :csv_ids, :string
+     t.column :name, :string
+    end
+
+    If upgrading from acts_as_tree just add root_id and csv_ids and run Category.build_csv_ids!
+
+    class Category < ActiveRecord::Base
+        acts_as_better_tree :order => "name"
+    end
+
+    Example:
+    root
+    \_ child1
+        \_ subchild1
+        \_ subchild2
+
+    root      = Category.create("name" => "root")
+    child1    = root.children.create("name" => "child1")
+    subchild1 = child1.children.create("name" => "subchild1")
+
+    root.parent   # => nil
+    child1.parent # => root
+    root.children # => [child1]
+    root.children.first.children.first # => subchild1
+
+Copyright (c) 2008 Isaac Sloan, released under the MIT license
+Inspired by David Heinemeier Hansson's acts_as_tree
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,4 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new('spec')

data/acts_as_better_tree.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/acts_as_better_tree/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Isaac Sloan"]
+  gem.email         = ["isaac@isaacsloan.com"]
+  gem.description   = %q{acts_as_better_tree is great for anyone who needs a fast tree capable of handling millions of nodes without slowing down on writes like nestedset or on reads like a standard tree.}
+  gem.summary       = %q{acts_as_better_tree is backwards compatible with acts_as_tree and remains fast with large datasets by storing the ancestry of every node in the field csv_ids.}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "acts_as_better_tree"
+  gem.require_paths = ["lib"]
+  gem.version       = ActsAsBetterTree::VERSION
+end

data/lib/acts_as_better_tree/version.rb

@@ -0,0 +1,3 @@
+module ActsAsBetterTree
+  VERSION = "0.9.3"
+end

data/lib/acts_as_better_tree.rb

@@ -0,0 +1,179 @@
+require "acts_as_better_tree/version"
+
+module ActiveRecord
+  module Acts
+    module BetterTree
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+        def acts_as_better_tree(options = {}, &b)
+          configuration = {:order => "id ASC", :destroy_dependent => true }
+          configuration.update(options) if options.is_a?(Hash)
+
+          belongs_to :parent, :class_name => name, :foreign_key => :parent_id
+          has_many :children, {:class_name => name, :foreign_key => :parent_id, :order => configuration[:order]}.merge(configuration[:destroy_dependent] ? {:dependent => :destroy} : {}), &b
+          has_many :parents_children, {:class_name => name, :primary_key => :parent_id, :foreign_key => :parent_id, :order => configuration[:order]}, &b
+          belongs_to :root, :class_name => name, :foreign_key => :root_id
+          scope :roots, :order => configuration[:order], :conditions => {:parent_id => nil}
+          after_create       :assign_csv_ids
+          after_validation  :update_csv_ids, :on => :update
+
+          instance_eval do
+            include ActiveRecord::Acts::BetterTree::InstanceMethods
+
+            def root(options = {})
+              roots(options).first
+            end
+
+            def traverse(nodes = self.roots, &block)
+              nodes.each do |node|
+                yield node
+                traverse(node.children, &block)
+              end
+            end
+
+            # Call this to upgrade an existing acts_as_tree to acts_as_better_tree
+            def build_csv_ids!(nodes = self.roots)
+              transaction do
+                traverse(nodes) do |node|
+                  node.csv_ids = node.build_csv_ids
+                  node.save
+                end
+              end
+            end
+          end
+        end
+      end
+
+      module InstanceMethods
+        def parent_foreign_key_changed?
+          parent_id_changed?
+        end
+
+        def ancestors
+          if self.csv_ids
+            ids = self.csv_ids.split(',')[0...-1]
+            (@ancestors ||= self.class.where(:id => ids).order('csv_ids ASC'))
+          else
+            node, nodes = self, []
+            nodes << node = node.parent while node.parent
+            (@ancestors ||= nodes.reverse)
+          end
+        end
+
+        def self_and_ancestors
+          ancestors + [self]
+        end
+
+        def self_and_children
+          [self] + children
+        end
+
+        def siblings
+          self_and_siblings - [self]
+        end
+
+        def self_and_siblings
+          unless parent_id.blank?
+            self.parents_children
+          else
+            self.class.roots
+          end
+        end
+
+        def ancestor_of?(node)
+          node.csv_ids.length > self.csv_ids.length && node.csv_ids.starts_with?(self.csv_ids)
+        end
+
+        def descendant_of?(node)
+          self.csv_ids.length > node.csv_ids.length && self.csv_ids.starts_with?(node.csv_ids)
+        end
+
+        def all_children(options = {})
+          find_all_children_with_csv_ids(nil, options)
+        end
+
+        def self_and_all_children
+          [self] + all_children
+        end
+
+        def depth
+          self.csv_ids.scan(/\,/).size
+        end
+
+        def childless?
+          return self.class.where(:parent_id => self.id).first.blank?
+        end
+
+        def root?
+          return self.parent.blank?
+        end
+
+        def move_to_child_of(category)
+          self.update_attributes(:parent_id => category.id)
+        end
+
+        def make_root
+          self.update_attributes(:parent_id => nil)
+        end
+
+        def to_csv(nodes = self.children)
+          csv = []
+          nodes.each do |node|
+            if node.childless?
+              csv += [node.self_and_ancestors.map(&:name).join(",")]
+            else
+              csv += [to_csv(node.children)]
+            end
+          end
+          return csv.join("\n")
+        end
+
+        def build_csv_ids
+          self.parent_id.blank? ? self.id.to_s : "#{self.parent.csv_ids},#{self.id}"
+        end
+
+        protected
+
+        def csv_id_like_pattern(prefix = nil)
+          (prefix || self.csv_ids) + ',%'
+        end
+
+        def build_root_id
+          return (self.parent_id ? self.parent.root_id : self.id)
+        end
+
+        def find_all_children_with_csv_ids(prefix = nil, options = {})
+          conditions = [self.class.send(:sanitize_sql, ['csv_ids LIKE ?', csv_id_like_pattern(prefix)])]
+          conditions << "(#{self.class.send(:sanitize_sql, options[:conditions])})" unless options[:conditions].blank?
+          options.update(:conditions => conditions.join(" AND "))
+          self.class.find(:all, options)
+        end
+
+        def assign_csv_ids
+          self.update_attributes(:csv_ids => build_csv_ids, :root_id => build_root_id)
+        end
+
+        def update_csv_ids
+          return unless parent_foreign_key_changed?
+          old_csv_ids = self.csv_ids
+          self.csv_ids = build_csv_ids
+          self.root_id = build_root_id
+          self.class.update_all("csv_ids = Replace(csv_ids, '#{old_csv_ids},', '#{self.csv_ids},'), root_id = #{self.root_id}", "csv_ids like '#{old_csv_ids},%'")
+        end
+      end
+    end
+  end
+end
+
+#ActiveRecord::Base.send :include, ActiveRecord::Acts::BetterTree
+#
+#ActiveRecord::Base.class_eval do
+#  include ActiveRecord::Acts::BetterTree
+#end
+
+class ActiveRecord::Base
+  include ActiveRecord::Acts::BetterTree
+end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: acts_as_better_tree
+version: !ruby/object:Gem::Version
+  version: 0.9.3
+  prerelease: 
+platform: ruby
+authors:
+- Isaac Sloan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-02 00:00:00.000000000 Z
+dependencies: []
+description: acts_as_better_tree is great for anyone who needs a fast tree capable
+  of handling millions of nodes without slowing down on writes like nestedset or on
+  reads like a standard tree.
+email:
+- isaac@isaacsloan.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- acts_as_better_tree.gemspec
+- lib/acts_as_better_tree.rb
+- lib/acts_as_better_tree/version.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.21
+signing_key: 
+specification_version: 3
+summary: acts_as_better_tree is backwards compatible with acts_as_tree and remains
+  fast with large datasets by storing the ancestry of every node in the field csv_ids.
+test_files: []