mongoid_tree 0.0.0 → 0.1.0

data/.bundle/config

@@ -0,0 +1,2 @@
+--- 
+BUNDLE_DISABLE_SHARED_GEMS: "1"

data/.gitignore

@@ -19,3 +19,5 @@ rdoc
 pkg
 
 ## PROJECT::SPECIFIC
+
+.rvmrc

data/.rspec

@@ -1 +1,2 @@
+--format nested
 --color

data/Gemfile

@@ -1,6 +1,9 @@
-gem "mongoid", ">= 2.0.0.beta7"
+source :rubygems
+gem "jeweler"
+gem "mongoid", "= 2.0.0.beta.16"
 # Currently used MongoDB version : 1.4.3
 
-gem "rspec", ">= 2.0.0.beta.15"
-gem "cucumber", ">= 0.8.2"
-gem "yard"
+gem "rspec", ">= 2.0.0.beta.19"
+gem "cucumber", ">= 0.8.5"
+gem "yard"
+gem "factory_girl"

data/Gemfile.lock

@@ -0,0 +1,62 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.0.0.rc)
+      activesupport (= 3.0.0.rc)
+      builder (~> 2.1.2)
+      i18n (~> 0.4.1)
+    activesupport (3.0.0.rc)
+    bson (1.0.4)
+    builder (2.1.2)
+    cucumber (0.8.5)
+      builder (~> 2.1.2)
+      diff-lcs (~> 1.1.2)
+      gherkin (~> 2.1.4)
+      json_pure (~> 1.4.3)
+      term-ansicolor (~> 1.0.4)
+    diff-lcs (1.1.2)
+    factory_girl (1.3.1)
+    gemcutter (0.6.1)
+    gherkin (2.1.4)
+      trollop (~> 1.16.2)
+    git (1.2.5)
+    i18n (0.4.1)
+    jeweler (1.4.0)
+      gemcutter (>= 0.1.0)
+      git (>= 1.2.5)
+      rubyforge (>= 2.0.0)
+    json_pure (1.4.3)
+    mongo (1.0.7)
+      bson (>= 1.0.4)
+    mongoid (2.0.0.beta.16)
+      activemodel (= 3.0.0.rc)
+      bson (= 1.0.4)
+      mongo (= 1.0.7)
+      tzinfo (= 0.3.22)
+      will_paginate (~> 3.0.pre)
+    rspec (2.0.0.beta.19)
+      rspec-core (= 2.0.0.beta.19)
+      rspec-expectations (= 2.0.0.beta.19)
+      rspec-mocks (= 2.0.0.beta.19)
+    rspec-core (2.0.0.beta.19)
+    rspec-expectations (2.0.0.beta.19)
+      diff-lcs (>= 1.1.2)
+    rspec-mocks (2.0.0.beta.19)
+    rubyforge (2.0.4)
+      json_pure (>= 1.1.7)
+    term-ansicolor (1.0.5)
+    trollop (1.16.2)
+    tzinfo (0.3.22)
+    will_paginate (3.0.pre2)
+    yard (0.5.8)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  cucumber (>= 0.8.5)
+  factory_girl
+  jeweler
+  mongoid (= 2.0.0.beta.16)
+  rspec (>= 2.0.0.beta.19)
+  yard

data/README.rdoc

@@ -1,6 +1,14 @@
 = mongoid_tree
 
-Description goes here.
+For our commercial application we need a proper tree structure with Depth-First and Breadth-First searches, parent and child information. Also subtrees need to be exported to JSON.
+
+Initially I thought of an embedded solution, but this will only be possible once MongoDB supports embedded collections, and even deep-embedded collections.
+
+However this tree is right now on the top of our priority list, means we will put effort into this and release everything in this public gem, as soon as we implement and test it. It will be fully tested with RSpec.
+The lack of a proper tree structure is quite noticeable in the mongoid forums.
+
+This gem will receive long-term support since we use it in a commercial long-term application.
+
 
 == Note on Patches/Pull Requests
  

data/VERSION

@@ -1 +1 @@
-0.0.0
+0.1.0

data/cucumber.yml

@@ -0,0 +1,3 @@
+default: --format pretty features --color
+autotest-all: --color --require features --require lib --format pretty features 
+autotest: --color --require features --require lib features --format pretty

data/features/step_definitions/mongoid_tree_steps.rb

@@ -0,0 +1,50 @@
+Given /^I have no nodes$/ do
+  Node.delete_all
+end
+
+Given /^the following nodes exist:$/ do |nodes_table|
+  # table is a Cucumber::Ast::Table
+  nodes_table.hashes.each do |hash|
+    node = Node.new(:name => hash[:name])
+    if !(hash[:parent] == "")
+      parent = Node.find(:first, :conditions => { :name => hash[:parent]})
+      parent.children << node
+      parent.save!
+      node.save!
+    else
+      Node.create( :name => hash[:name])
+    end
+  end
+end
+
+Given /^I create a tree$/ do
+    12.times{ Factory.create(:node) }
+    
+    Node.where(:name  => "Node_1").first.children << Node.where(:name => "Node_7").first
+    Node.where(:name  => "Node_7").first.insert_before(Node.where(:name => "Node_2").first)
+    Node.where(:name  => "Node_1").first.children << Node.where(:name => "Node_8").first
+    Node.where(:name  => "Node_2").first.children << Node.where(:name => "Node_3").first
+    Node.where(:name  => "Node_3").first.insert_after(Node.where(:name => "Node_6").first)
+    Node.where(:name  => "Node_8").first.children << Node.where(:name => "Node_9").first
+    Node.where(:name  => "Node_9").first.children << Node.where(:name => "Node_11").first
+    Node.where(:name  => "Node_3").first.children << Node.where(:name => "Node_5").first
+    Node.where(:name  => "Node_9").first.insert_after(Node.where(:name => "Node_12").first)
+    Node.where(:name  => "Node_5").first.insert_before(Node.where(:name => "Node_4").first)
+    Node.where(:name  => "Node_11").first.insert_before(Node.where(:name => "Node_10").first)
+end
+
+
+When /^I request the children depth first$/ do
+  @root = Node.find(:first, :conditions => { :name => "Node_1" })
+  @root.should_not be(nil)
+  @children = @root.depth_first.map{|node| [node.name]}
+end
+
+Then /^I should get the children in the following order$/ do |expected_children_order|
+  # table is a Cucumber::Ast::Table
+  expected_children_order.diff!(@children)
+end
+
+Then /^I should have (\d+) Nodes$/ do |count|
+  Node.count.should be(count.to_i)
+end

data/features/support/env.rb

@@ -1,4 +1,4 @@
 $LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../lib')
-require 'mongoid_tree'
+require File.expand_path(File.dirname(__FILE__)+'/../../spec/spec_helper')
 
 require 'rspec/expectations'

data/features/traversal.feature

@@ -0,0 +1,93 @@
+Feature: Tree Searches / Traversals
+    In order to traverse
+    As a user
+    I want a depth-first representation of the tree
+  
+    Scenario: Depth First Search
+        # For a visual representation see http://en.wikipedia.org/wiki/File:Depth-first-tree.svg
+        Given I have no nodes
+        And the following nodes exist:   
+             | name    | parent |
+             | Node_1  |        |
+             | Node_2  | Node_1 |
+             | Node_7  | Node_1 |
+             | Node_8  | Node_1 |
+             | Node_3  | Node_2 |
+             | Node_6  | Node_2 |
+             | Node_9  | Node_8 |
+             | Node_12 | Node_8 |
+             | Node_4  | Node_3 |
+             | Node_5  | Node_3 |
+             | Node_10 | Node_9 |
+             | Node_11 | Node_9 |
+        And I should have 12 Nodes
+        When I request the children depth first
+        Then I should get the children in the following order
+            |Node_1|
+            |Node_2|
+            |Node_3|
+            |Node_4|
+            |Node_5|
+            |Node_6|
+            |Node_7|
+            |Node_8|
+            |Node_9|
+            |Node_10|
+            |Node_11|
+            |Node_12|
+    
+    
+        Scenario: Depth First Search with other create Order
+            # For a visual representation see http://en.wikipedia.org/wiki/File:Depth-first-tree.svg
+            Given I have no nodes
+            And the following nodes exist:   
+                 | name    | parent |
+                 | Node_1  |        |
+                 | Node_2  | Node_1 |
+                 | Node_7  | Node_1 |
+                 | Node_8  | Node_1 |
+                 | Node_9  | Node_8 |
+                 | Node_10 | Node_9 |
+                 | Node_11 | Node_9 |
+                 | Node_3  | Node_2 |
+                 | Node_6  | Node_2 |
+                 | Node_12 | Node_8 |
+                 | Node_4  | Node_3 |
+                 | Node_5  | Node_3 |
+            And I should have 12 Nodes
+            When I request the children depth first
+            Then I should get the children in the following order
+                |Node_1|
+                |Node_2|
+                |Node_3|
+                |Node_4|
+                |Node_5|
+                |Node_6|
+                |Node_7|
+                |Node_8|
+                |Node_9|
+                |Node_10|
+                |Node_11|
+                |Node_12|
+                
+        # This scenario creates a tree using ".children << node", insert_before(node), insert_after(node)
+        # Details in the "And i have a tree" step
+        Scenario: Depth First Search with insert
+            # For a visual representation see http://en.wikipedia.org/wiki/File:Depth-first-tree.svg
+            Given I have no nodes
+            And I create a tree                
+            And I should have 12 Nodes
+            When I request the children depth first
+            Then I should get the children in the following order
+                |Node_1|
+                |Node_2|
+                |Node_3|
+                |Node_4|
+                |Node_5|
+                |Node_6|
+                |Node_7|
+                |Node_8|
+                |Node_9|
+                |Node_10|
+                |Node_11|
+                |Node_12|

data/lib/mongoid_tree.rb

@@ -0,0 +1,73 @@
+module Mongoid
+    module Acts
+        module Tree
+            extend ActiveSupport::Concern
+            include Comparable
+
+            included do
+                references_many :children, :class_name => self.name, :stored_as => :array, :inverse_of => :parent do
+                    def <<(*objects)
+                        objects.flatten.each_with_index do |object, index|
+                            if object.position == nil
+                                object.position = @parent.send(@foreign_key).count + index + 1
+                            end
+                        end
+                        super(objects)
+                    end
+                end
+                
+                referenced_in :parent, :class_name  => self.name, :inverse_of => :children
+                
+                # This stores the position in the children array of the parent object.
+                # Makes it easier to flatten / export / import a tree
+                field :position, :type => Integer
+            end
+
+            module InstanceMethods
+                
+                #Comparable
+                def <=> (another_node)
+                    self.position <=> another_node.position
+                end
+
+                def depth_first
+                    result = [self]
+                    if children.empty?
+                        return result
+                    else
+                        self.children.each do |child|
+                            result += child.depth_first
+                        end    
+                    end
+                    return result                    
+                end
+
+
+                def insert_before( new_child )
+                    new_child.position = self.position
+                    self.parent.children.each do |child|
+                        if child.position >= new_child.position
+                            child.position += 1
+                        end
+                    end
+                    self.parent.children << new_child
+                end
+
+                def insert_after ( new_child )
+                    self.save
+                    self.parent.save
+                    new_child.position = self.position
+                    self.parent.children.each do |child|
+                        if child.position >= new_child.position
+                            child.position += 1
+                        end
+                    end
+                    self.parent.children << new_child 
+                end
+            end
+
+
+
+        end
+    end
+end

data/mongoid_tree.gemspec

@@ -0,0 +1,80 @@
+# 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{mongoid_tree}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Rainer Kuhn"]
+  s.date = %q{2010-08-10}
+  s.description = %q{Fully featured tree implementation for Mongoid using materialized paths and relative associations. Featuring Depth and Breadth first search.}
+  s.email = %q{rkuhn@littleweblab.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".bundle/config",
+     ".gitignore",
+     ".rspec",
+     ".yardoc/checksums",
+     ".yardoc/objects/root.dat",
+     ".yardoc/proxy_types",
+     "Gemfile",
+     "Gemfile.lock",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "autotest/discover.rb",
+     "cucumber.yml",
+     "doc/_index.html",
+     "doc/class_list.html",
+     "doc/css/common.css",
+     "doc/css/full_list.css",
+     "doc/css/style.css",
+     "doc/file.README.html",
+     "doc/file_list.html",
+     "doc/frames.html",
+     "doc/index.html",
+     "doc/js/app.js",
+     "doc/js/full_list.js",
+     "doc/js/jquery.js",
+     "doc/method_list.html",
+     "doc/top-level-namespace.html",
+     "features/step_definitions/mongoid_tree_steps.rb",
+     "features/support/env.rb",
+     "features/traversal.feature",
+     "lib/mongoid_tree.rb",
+     "mongoid_tree.gemspec",
+     "spec/factories/node.rb",
+     "spec/models/node.rb",
+     "spec/mongoid_tree_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/rayls/mongoid_tree}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Materialized paths based tree implementation for Mongoid}
+  s.test_files = [
+    "spec/factories/node.rb",
+     "spec/models/node.rb",
+     "spec/mongoid_tree_spec.rb",
+     "spec/spec_helper.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
+    else
+    end
+  else
+  end
+end
+

data/spec/factories/node.rb

@@ -0,0 +1,3 @@
+Factory.define :node do |f|
+    f.sequence(:name) {|n| "Node_#{n}"}
+end

data/spec/models/node.rb

@@ -0,0 +1,10 @@
+class Node
+    include Mongoid::Document
+    include Mongoid::Acts::Tree
+    
+   
+    field :name
+
+    validates_presence_of :name
+
+end

data/spec/mongoid_tree_spec.rb

@@ -1,7 +1,93 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe "MongoidTree" do
-  it "fails" do
-    fail "hey buddy, you should probably rename this file and start specing for real"
-  end
+
+    before do
+        [ Node ].each { |klass| klass.collection.remove }
+    end
+
+    describe "A tree of nodes" do
+
+        context "A node with a child" do
+            
+            before do
+                @parent = Node.new(:name => "Parent")
+                @child = Node.new(:name => "Child")
+                @parent.children << @child
+                @parent.save
+            end
+            
+            it "should have 1 child" do
+                @parent.children.count.should be(1)
+                @parent.children.first.should eq(@child)
+            end        
+
+            it "a child should know it's parent" do
+                @child.parent.should eq(@parent)
+            end
+            
+            it "the child should be at position 1" do
+              @parent.children.first.position.should eq(1)
+            end
+            
+        end
+
+        context "a node with 2 children" do
+            
+            def reload
+                @parent.reload
+                @child_1.reload
+                @child_2.reload
+                @new_child.reload
+            end
+            
+            before do
+                @parent = Node.new(:name => "Parent")
+                @child_1 = Node.new(:name => "Child_1")
+                @child_2 = Node.new(:name => "Child_2")
+                @new_child = Node.new(:name => "new_child")
+                @parent.children << @child_1
+                @parent.children << @child_2
+                @child_1.position.should eq(1)
+                @child_2.position.should eq(2)
+                @parent.save
+            end
+            
+            it "should add a child before child 1" do
+                @child_1.insert_before(@new_child)
+                reload
+                @parent.children.sort.should eq([@new_child, @child_1, @child_2])
+            end
+
+            it "should add a child after child 1" do
+                @child_1.insert_after(@new_child)
+                reload
+                @parent.children.sort.should eq([@child_1, @new_child, @child_2])
+            end
+
+            it "should add a child before child 2" do
+                @child_2.insert_before(@new_child)
+                reload
+                @parent.children.sort.should eq([@child_1, @new_child, @child_2])
+            end
+
+            it "should add a child after child 2" do
+                @child_2.insert_after(@new_child)
+                reload
+                @parent.children.sort.should eq([@child_1, @child_2, @new_child])
+            end
+
+            it "should append a child to children" do
+                @parent.reload
+                @parent.children << @new_child
+                @parent.children.count.should eq(3)
+                @parent.save
+                @new_child.save
+                reload                
+                @parent.children.sort.should eq([@child_1, @child_2, @new_child])
+            end
+            
+        end
+
+    end
 end

data/spec/spec_helper.rb

@@ -1,9 +1,27 @@
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require "mongoid"
+
 require 'mongoid_tree'
 require 'rspec'
 require 'rspec/autorun'
+require "factory_girl"
+
+Mongoid.configure do |config|
+  name = "mongoid_tree_test"
+  host = "localhost"
+  config.master = Mongo::Connection.new.db(name)
+  # config.slaves = [
+    # Mongo::Connection.new(host, 27018, :slave_ok => true).db(name)
+  # ]
+end
+
+# I have never got the hang of including files, probably because the Syntax is so horrible.
+# This is the easiest I could come up with.
+Dir[File.dirname(__FILE__) + '/models/*.rb'].each {|file| require file }
+Dir[File.dirname(__FILE__) + "/factories/*.rb"].each {|file| require file } 
 
 RSpec.configure do |config|
-  
+
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
+  - 1
   - 0
-  - 0
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors: 
 - Rainer Kuhn
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-07 00:00:00 +02:00
+date: 2010-08-10 00:00:00 +02:00
 default_executable: 
 dependencies: []
 
@@ -28,18 +28,20 @@ extra_rdoc_files:
 - LICENSE
 - README.rdoc
 files: 
-- .document
+- .bundle/config
 - .gitignore
 - .rspec
 - .yardoc/checksums
 - .yardoc/objects/root.dat
 - .yardoc/proxy_types
 - Gemfile
+- Gemfile.lock
 - LICENSE
 - README.rdoc
 - Rakefile
 - VERSION
 - autotest/discover.rb
+- cucumber.yml
 - doc/_index.html
 - doc/class_list.html
 - doc/css/common.css
@@ -54,10 +56,13 @@ files:
 - doc/js/jquery.js
 - doc/method_list.html
 - doc/top-level-namespace.html
-- features/mongoid_tree.feature
 - features/step_definitions/mongoid_tree_steps.rb
 - features/support/env.rb
+- features/traversal.feature
 - lib/mongoid_tree.rb
+- mongoid_tree.gemspec
+- spec/factories/node.rb
+- spec/models/node.rb
 - spec/mongoid_tree_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true
@@ -93,5 +98,7 @@ signing_key:
 specification_version: 3
 summary: Materialized paths based tree implementation for Mongoid
 test_files: 
+- spec/factories/node.rb
+- spec/models/node.rb
 - spec/mongoid_tree_spec.rb
 - spec/spec_helper.rb

data/.document

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

data/features/mongoid_tree.feature

@@ -1,9 +0,0 @@
-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