treeoid 0.0.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Jeremy Weiland
+
+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,17 @@
+= treeoid
+
+A tree hierarchy module for Mongoid::Document classes. Super beta.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Jeremy Weiland. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,67 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "treeoid"
+    gem.summary = %q{Tree structure mixin for Mongoid::Document classes}
+    gem.description = %q{With treeoid, you can create tree-style hierarchies for Mongoid classes. Just "include Treeoid" and you're ready to roll. You get a "parent" accessor, a "children" array, plus a scope called "hierarchically" that spits everything out in hierarchical order - perfect for front end rendering.}
+    gem.email = "jeremy6d@gmail.com"
+    gem.homepage = "http://github.com/jeremy6d/treeoid"
+    gem.authors = ["Jeremy Weiland"]
+    gem.add_runtime_dependency "mongoid", ">= 2.0.0.beta11"
+    gem.add_development_dependency "thoughtbot-shoulda", "~> 2.11.1"
+    gem.add_development_dependency "jnunemaker-matchy", ">= 0.4.0"
+    gem.add_development_dependency "cucumber", "~> 0.8.5"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+begin
+  require 'cucumber/rake/task'
+  Cucumber::Rake::Task.new(:features)
+
+  task :features => :check_dependencies
+rescue LoadError
+  task :features do
+    abort "Cucumber is not available. In order to run features, you must: sudo gem install cucumber"
+  end
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "treeoid #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/features/support/env.rb

@@ -0,0 +1,6 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../lib')
+require 'treeoid'
+
+require 'test/unit/assertions'
+
+World(Test::Unit::Assertions)

data/features/treeoid.feature

@@ -0,0 +1,9 @@
+Feature: something something
+  In order to something something
+  A user something something
+  something something something
+
+  Scenario: something something
+    Given inspiration
+    When I create a sweet new gem
+    Then everyone should see how awesome I am

data/lib/treeoid.rb

@@ -0,0 +1,49 @@
+module Treeoid
+  def self.included(base)
+    base.class_eval do
+      field :ancestry, :type => Array
+
+      references_many :children, :class_name => base.name, :foreign_key => :parent_id
+      referenced_in   :parent,   :class_name => base.name
+
+      validate :hierarchical_integrity
+      before_save :set_ancestry!
+      after_save :set_child_ancestries!
+
+      scope :root, where(:parent_id => nil)
+      
+      def has_children?
+        !children.empty?
+      end
+
+      def has_parent?
+        !parent.nil?
+      end
+      
+    protected    
+      def hierarchical_integrity
+        return unless parent_id
+        errors.add(:parent_id, "cannot be itself") if parent_id == self.id
+        unless self.class.where(:ancestry => id).id(parent_id).empty?
+          errors.add(:parent_id, "cannot be a current child") 
+        end
+      end
+
+      def set_ancestry!
+        new_path = [(parent.try(:ancestry) || parent_id), id].compact.flatten
+        write_attribute :ancestry, new_path
+        
+      end
+      
+      def set_child_ancestries!
+        children.each(&:save)
+      end
+    end
+    
+    base.instance_eval do
+      def hierarchically
+        criteria.asc :ancestry
+      end
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,23 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'mongoid'
+require 'matchy'
+require 'treeoid'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+Mongoid.configure do |config|
+  name = "treeoid_test"
+  host = "localhost"
+  config.master = Mongo::Connection.new.db(name)
+end
+
+class Test::Unit::TestCase
+  def teardown
+    Mongoid.master.collections.reject do |c| 
+      c.name == 'system.indexes' 
+    end.each(&:drop)
+  end
+end

data/test/test_treeoid.rb

@@ -0,0 +1,71 @@
+require 'helper'
+
+class TestTreeoid < Test::Unit::TestCase
+  class Node
+    include Mongoid::Document
+    include Treeoid
+    
+    field :title, :type => String
+  end
+  
+  context "A treeoid hierarchy" do
+    setup do
+      @node_one   = Node.create :title => "one"
+      @node_two   = Node.create :parent => @node_one, :title => "two"
+      @node_three = Node.create :title => "three"
+      @node_four  = Node.create :parent => @node_two, :title => "four"
+      @node_five  = Node.create :parent => @node_one, :title => "five"
+      assert_equal 5, Node.count
+    end
+    
+    should "be able to access all root nodes" do
+      Node.root.size.should == 2
+      Node.root.should include(@node_three, @node_one)
+    end
+
+    should "be able to add a child node" do
+      @new_node = Node.create :title => "blah"
+      @new_node.children << @node_one
+      @new_node.save
+      @new_node.children.should include(@node_one)
+    end
+
+    should "be able to assign a parent" do
+      @node_one.parent = @node_three
+      @node_one.save
+      @node_one.parent.should == @node_three
+    end
+
+    should "not allow a node to be its own parent" do
+      @node_one.parent = @node_one
+      @node_one.should_not be_valid
+      @node_one.errors[:parent_id].should include("cannot be itself")
+    end
+    
+    should "not allow a node's parent to be set to a current child" do
+      @node_one.parent = @node_four
+      @node_one.should_not be_valid
+      @node_one.errors[:parent_id].should include("cannot be a current child")
+    end
+    
+    should "recalculate the paths of all children when path is set" do
+      @node_one.parent = @node_three
+      @node_one.save
+      @node_one.children.each do |child|
+        child.ancestry.first.should == @node_three.id
+      end
+    end
+    
+    should "correctly set a root node's path correctly" do
+      @node_one.ancestry.should == [@node_one.id]
+    end
+    
+    should "correctly set a child node's path" do
+      @node_four.ancestry.should == [@node_one, @node_two, @node_four].map { |p| p.id }
+    end
+    
+    should "return in hierarchical order" do
+      Node.hierarchically.to_a.should == [@node_one, @node_two, @node_four, @node_five, @node_three]
+    end
+  end
+end

data/treeoid.gemspec

@@ -0,0 +1,66 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{treeoid}
+  s.version = "0.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jeremy Weiland"]
+  s.date = %q{2010-07-28}
+  s.description = %q{With treeoid, you can create tree-style hierarchies for Mongoid classes. Just "include Treeoid" and you're ready to roll. You get a "parent" accessor, a "children" array, plus a scope called "hierarchically" that spits everything out in hierarchical order - perfect for front end rendering.}
+  s.email = %q{jeremy6d@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "features/step_definitions/treeoid_steps.rb",
+     "features/support/env.rb",
+     "features/treeoid.feature",
+     "lib/treeoid.rb",
+     "test/helper.rb",
+     "test/test_treeoid.rb",
+     "treeoid.gemspec"
+  ]
+  s.homepage = %q{http://github.com/jeremy6d/treeoid}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Tree structure mixin for Mongoid::Document classes}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_treeoid.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<mongoid>, [">= 2.0.0.beta11"])
+      s.add_development_dependency(%q<thoughtbot-shoulda>, ["~> 2.11.1"])
+      s.add_development_dependency(%q<jnunemaker-matchy>, [">= 0.4.0"])
+      s.add_development_dependency(%q<cucumber>, ["~> 0.8.5"])
+    else
+      s.add_dependency(%q<mongoid>, [">= 2.0.0.beta11"])
+      s.add_dependency(%q<thoughtbot-shoulda>, ["~> 2.11.1"])
+      s.add_dependency(%q<jnunemaker-matchy>, [">= 0.4.0"])
+      s.add_dependency(%q<cucumber>, ["~> 0.8.5"])
+    end
+  else
+    s.add_dependency(%q<mongoid>, [">= 2.0.0.beta11"])
+    s.add_dependency(%q<thoughtbot-shoulda>, ["~> 2.11.1"])
+    s.add_dependency(%q<jnunemaker-matchy>, [">= 0.4.0"])
+    s.add_dependency(%q<cucumber>, ["~> 0.8.5"])
+  end
+end
+

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification 
+name: treeoid
+version: !ruby/object:Gem::Version 
+  hash: 31
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 0
+  version: 0.0.0
+platform: ruby
+authors: 
+- Jeremy Weiland
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-28 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mongoid
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: -1967355489
+        segments: 
+        - 2
+        - 0
+        - 0
+        - beta11
+        version: 2.0.0.beta11
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 33
+        segments: 
+        - 2
+        - 11
+        - 1
+        version: 2.11.1
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: jnunemaker-matchy
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 0
+        - 4
+        - 0
+        version: 0.4.0
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: cucumber
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 53
+        segments: 
+        - 0
+        - 8
+        - 5
+        version: 0.8.5
+  type: :development
+  version_requirements: *id004
+description: With treeoid, you can create tree-style hierarchies for Mongoid classes. Just "include Treeoid" and you're ready to roll. You get a "parent" accessor, a "children" array, plus a scope called "hierarchically" that spits everything out in hierarchical order - perfect for front end rendering.
+email: jeremy6d@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- features/step_definitions/treeoid_steps.rb
+- features/support/env.rb
+- features/treeoid.feature
+- lib/treeoid.rb
+- test/helper.rb
+- test/test_treeoid.rb
+- treeoid.gemspec
+has_rdoc: true
+homepage: http://github.com/jeremy6d/treeoid
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Tree structure mixin for Mongoid::Document classes
+test_files: 
+- test/helper.rb
+- test/test_treeoid.rb