acts_as_king 0.0.1

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+html/*
+.DS_Store

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in acts_as_king.gemspec
+gemspec

data/README.rdoc

@@ -0,0 +1,52 @@
+== ActsAsKing
+
+Rails gem to provide self referencing hierarchy for ActiveRecord models.
+
+=== Installation
+
+  gem install acts_as_king
+
+More preferrably in your Gemfile
+  gem 'acts_as_king'
+
+=== Usage
+
+The target for ActsAsKing is to be an easy to use, self explanitory gem.
+
+Create a migration to add parent_id to your model:
+  rails g migration AddParentIdToComments
+
+Add a column to your comments table
+  class AddParentIdToComments < ActiveRecord::Migration
+    def self.up
+      add_column :comments, :parent_id, :integer
+      add_index :comments, :parent_id
+    end
+  end
+
+
+In your model:
+
+  class Comment < ActiveRecord::Base
+    acts_as_king
+  end
+
+Create a couple of comments
+
+  comment_1 = Comment.create # id: 1
+  comment_2 = Comment.create(:parent => comment_1) # id: 2
+
+Get all top level comments
+
+  comments = Comment.kings
+  => [#<Comment id: 1, parent_id: nil>]
+
+Get the first top level comment and display the immediate children
+
+  comment = Comment.kings.first
+  comment.children
+  => [#<Comment id: 2, parent_id: 1>]
+
+=== Contributing
+
+Contributing is easy. Fork the repository. Hack away. Create tests. Send a pull request.

data/Rakefile

@@ -0,0 +1,20 @@
+require 'bundler'
+require 'rake/testtask'
+require 'hanna/rdoctask'
+
+Bundler::GemHelper.install_tasks
+
+Rake::TestTask.new('test') do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+Rake::RDocTask.new(:rdoc) do |rd|
+  rd.main = "README.rdoc"
+  rd.rdoc_files.include("README.rdoc", "lib/**/*.rb")
+  rd.options << "--all"
+end
+
+task :default => :test
+

data/acts_as_king.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "acts_as_king/version"
+
+Gem::Specification.new do |s|
+  s.name        = "acts_as_king"
+  s.version     = ActsAsKing::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Drew Tempelmeyer"]
+  s.email       = ["drewtemp@gmail.com"]
+  s.homepage    = "http://github.com/drewtempelmeyer/acts_as_king"
+  s.summary     = %q{Hierarchical ActiveRecord models. Inspired by acts_as_tree. Trees are shady.}
+  s.description = %q{Hierarchical ActiveRecord models. Inspired by acts_as_tree. Trees are shady.}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'rails', ['>= 3.0.0']
+  s.add_development_dependency 'shoulda'
+  s.add_development_dependency 'sqlite3-ruby'
+  s.add_development_dependency 'hanna'
+
+end

data/lib/acts_as_king.rb

@@ -0,0 +1,74 @@
+require 'acts_as_king/railtie' if defined?(Rails)
+
+# Written by Drew Tempelmeyer
+module ActsAsKing
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  module ClassMethods
+
+    # Defines that the model should have a self referencing hierarchy. This allows you to have threaded comments or any other type
+    # of self referencing hierarchy. <tt>ActsAsKing</tt> creates a belongs_to
+    # association (parent) and has_many association (children). It also defines
+    # a <tt>kings</tt> scope for your model to return all top level records.
+    #
+    # === Example
+    #
+    #   class Comment < ActiveRecord::Base
+    #     acts_as_king
+    #   end
+    #
+    #   comment_1 = Comment.create
+    #   comment_2 = Comment.create(:parent => comment_1) # defines parent
+    #
+    #   # return an array of all top level records
+    #   Comment.kings # => [#<Comment id: 1>]
+    #
+    #   # return an array of children belonging to comment_1
+    #   comment_1.children # => [#<Comment id: 2>]
+    #
+    #   # get the parent record for comment_2
+    #   comment_2.parent # => #<Comment id: 1>
+    #
+    #
+    def acts_as_king(options = {})
+      options = { :foreign_key => 'parent_id' }.merge(options)
+
+      belongs_to :parent, :class_name => name, :foreign_key => options[:foreign_key]
+      has_many :children, :class_name => name, :foreign_key => options[:foreign_key], :dependent => :destroy
+
+      class_eval <<-EOL
+        include ActsAsKing::InstanceMethods
+
+        scope :kings, where("#{options[:foreign_key]} IS NULL")
+      EOL
+
+    end
+
+  end
+
+  module InstanceMethods
+    
+    # Retrieves all of the parents of the instance. (Think of it including
+    # grandparents as well.)
+    #
+    # ==== Example
+    #
+    # If you had three records in a structure similar to this:
+    #   #<Comment id: 1, parent_id: nil>
+    #     #<Comment id: 2, parent_id: 1>
+    #       #<Comment id: 3, parent_id: 2>
+    # 
+    # You would do the following to return all ancestors
+    #   comment_3.ancestors # => [#<Comment id: 2, parent_id: 1>, #<Comment id: 1, parent_id: nil>]
+    #
+    def ancestors
+      current, all = self, []
+      all << current = current.parent while current.parent
+      all
+    end
+
+  end
+
+end

data/lib/acts_as_king/railtie.rb

@@ -0,0 +1,12 @@
+require 'rails'
+
+module ActsAsKing
+  class Railtie < Rails::Railtie
+    initializer "acts_as_king" do
+      ActiveSupport.on_load(:active_record) do
+        ActiveRecord::Base.send(:include, ActsAsKing)
+      end
+    end
+  end
+end
+

data/lib/acts_as_king/version.rb

@@ -0,0 +1,3 @@
+module ActsAsKing
+  VERSION = "0.0.1"
+end

data/test/acts_as_king_test.rb

@@ -0,0 +1,46 @@
+require './test/helper'
+
+class ActsAsKingTest < Test::Unit::TestCase
+
+  context "ActsAsKing" do
+
+    setup do
+      setup_db
+      @post = Post.create
+      @comment = Comment.create(:post => @post)
+      @sub_comment = Comment.create(:post => @post, :parent => @comment)
+      @level_3 = Comment.create(:post => @post, :parent => @sub_comment)
+    end
+
+    teardown do
+      destroy_db
+    end
+
+    should "be one post" do
+      assert_equal 1, Post.count
+    end
+
+    should "be three comments" do
+      assert_equal 3, Comment.count
+    end
+
+    should "be one king comment" do
+      assert_equal 1, Comment.kings.count
+    end
+
+    should "king comment should have one child" do
+      assert_equal 1, @comment.children.count
+    end
+
+    should "child comment should return array of parents" do
+      assert_equal [@comment], @sub_comment.ancestors
+    end
+
+    should "return multiple ancestors" do
+      assert_equal [@sub_comment, @comment], @level_3.ancestors
+    end
+    
+  end
+
+end
+

data/test/helper.rb

@@ -0,0 +1,38 @@
+$LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'active_record'
+require 'acts_as_king'
+require 'test/unit'
+require 'shoulda'
+
+ActiveRecord::Base.send(:include, ActsAsKing)
+ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => ':memory:')
+ActiveRecord::Migration.verbose = false
+
+def setup_db
+  ActiveRecord::Schema.define(:version => 1) do
+    create_table :posts, :force => true do |t|
+    end
+
+    create_table :comments, :force => true do |t|
+      t.integer :post_id, :null => false
+      t.integer :parent_id
+    end
+  end
+end
+
+def destroy_db
+  ActiveRecord::Base.connection.tables.each do |table|
+    ActiveRecord::Base.connection.drop_table(table)
+  end
+end
+
+class Post < ActiveRecord::Base
+  has_many :comments, :dependent => :destroy
+end
+
+class Comment < ActiveRecord::Base
+  belongs_to :post
+  acts_as_king
+end
+

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification 
+name: acts_as_king
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Drew Tempelmeyer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-14 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 3.0.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: sqlite3-ruby
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: hanna
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id004
+description: Hierarchical ActiveRecord models. Inspired by acts_as_tree. Trees are shady.
+email: 
+- drewtemp@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.rdoc
+- Rakefile
+- acts_as_king.gemspec
+- lib/acts_as_king.rb
+- lib/acts_as_king/railtie.rb
+- lib/acts_as_king/version.rb
+- test/acts_as_king_test.rb
+- test/helper.rb
+homepage: http://github.com/drewtempelmeyer/acts_as_king
+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.2
+signing_key: 
+specification_version: 3
+summary: Hierarchical ActiveRecord models. Inspired by acts_as_tree. Trees are shady.
+test_files: 
+- test/acts_as_king_test.rb
+- test/helper.rb