text_based_nested_set 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 00dbca035b8e477e826841cbbda16c6648fdace6
-  data.tar.gz: aaed56d81da79ef4c0358820efb709c492c1c75f
+  metadata.gz: 801c7e1b6c9348f8d13efbde0c51d6cf76b85287
+  data.tar.gz: 148ad9c927c282fcd9568b97db9bdc44a474f634
 SHA512:
-  metadata.gz: 3ba9f837ddb26838b7e825a7615127d5e27bf94464be68277425f2ff8183a8495bd5cbd50d499db349437bdf8522422b26264a021a7679a23af7647a370751b7
-  data.tar.gz: b6ef1f7ce94c5457940b727e9721146214f48986485ae1ddada2362fba01eb72b569deddf67104fdf46b6a63fbfd182f29be5ded576d41c5798f91db9fe46ca4
+  metadata.gz: 4ec694a77e0dc41ff0af8c5fb97ce857bc3f61e313a5e4a8c8e8b0a31d564e5c09efbb125784d9deff3a7a93c7331059f46bdcde3d89771f03922e2ec3cb408b
+  data.tar.gz: 00a489336c447a164b5e3a20ba70477b917dad493fda790ed05cf005b9a9cd88380e9849aade04a31d9fef498782e99e09062c3c46f3e06fb040229ac7fa5e1c

data/README.md

@@ -1,9 +1,13 @@
 # TextBasedNestedSet
 
 this acts provides Text Based Nested Set functionality.
+
 Text Based Nested Set is another way to implementation of an SQL Nested Set created by Trever Shick(http://threebit.net/tutorials/nestedset/varcharBasedNestedSet.html).
+
 Compare to lft and rgt Nested Set, this implementation can updates and deletions without require all of the nodes to be updated.
 
+The methods provided by this gem can found in spec/text_based_nested_set_spec.rb
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -22,16 +26,35 @@ Or install it yourself as:
 
 ## Usage
 
-set up:
-1. Add parent_id, path, position column to exsiting model
+### set up:
+
+* Add parent_id, path, position column to exsiting model
+```ruby
 class AddTextBasedNestedSetToDemo < ActiveRecord::Migration
   def change
     add_column :demos, :parent_id, :integer, default: 0
     add_column :demos, :path, :string, default: '/0/'
-    add_column :demos, position, :integer, default: 0
+    add_column :demos, :position, :integer, default: 0
   end
 end
-2. add acts_as_text_based_nested_set method to target model
+```
+
+* add acts_as_text_based_nested_set method to target model
+```ruby
+class Demo < ActiveRecord::Base
+  acts_as_based_nested_set
+end
+```
+
+### convert from awesome_nested_set
+
+this gem provide a function to help you convert awesome_nested_set table to text based_nested_set table
+
+* Make sure to add path and position column to target model. Then should change parent_id's default value to 0
+* start up a rails console and run:
+```ruby
+  Demo.convert_from_awesome_nested_set
+```
 
 ## Contributing
 

data/lib/text_based_nested_set/model.rb

@@ -139,6 +139,11 @@ module BeyondAlbert
           current_class.where(id: parent_ids)
         end
 
+        def self_and_ancestors
+          parent_ids = self.path.split('/').select {|v| v != "" && v != "0"} << self.id
+          current_class.where(id: parent_ids)
+        end
+
         def children
           children_path = self.path + self.id.to_s + '/'
           current_class.where(path: children_path).order('position')

data/lib/text_based_nested_set/text_based_nested_set.rb

@@ -1,8 +1,8 @@
 require 'text_based_nested_set/model'
 
 module BeyondAlbert #:nodoc:
-	module Acts #:nodoc:
-		module TextBasedNestedSet #:nodoc:
+  module Acts #:nodoc:
+    module TextBasedNestedSet #:nodoc:
 
       # this acts provides Text Based Nested Set functionality.
       # Text Based Nested Set is another way to implementation of an SQL Nested Set created by Trever Shick.
@@ -22,11 +22,11 @@ module BeyondAlbert #:nodoc:
       # See BeyondAlbert::Acts::TextBasedNestedSet::Model 
       # for a list ofclass methods and instance methods 
       # added to acts_as_text_based_nested_set models.
-			def acts_as_text_based_nested_set(options = {})
-				include Model
+      def acts_as_text_based_nested_set(options = {})
+        include Model
 
         before_destroy :destroy_descendants
-			end
-		end
-	end
+      end
+    end
+  end
 end

data/lib/text_based_nested_set/version.rb

@@ -1,3 +1,3 @@
 module TextBasedNestedSet
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/text_based_nested_set_spec.rb

@@ -1,61 +1,61 @@
 require 'spec_helper'
 
 describe 'TextBasedNestedSet' do
-	before :each do
-		# test tree:
-		# root(1)
-		#  |__child_1(2)
-		#  |     |__child_1_1(4)
-		#  |     |     |__child_1_1_1(7)
-		#  |     |__child_1_2(5)
-		#  |     |     |__child_1_2_1(8)
-		#  |     |__child_1_3(6)
-		#  |__child_2(3) 
-		@root = create(:category, id: 1, parent_id: 0, path: "/0/", position: 0)
-		@child_1 = create(:category, id: 2, name: "child_1", parent_id: 1, path: "/0/1/", position: 0)
-		@child_2 = create(:category, id: 3, name: "child_2", parent_id: 1, path: "/0/1/", position: 1)
-		@child_1_1 = create(:category, id: 4, name: "child_1_1", parent_id: 2, path: "/0/1/2/", position: 0)
-		@child_1_2 = create(:category, id: 5, name: "child_1_2", parent_id: 2, path: "/0/1/2/", position: 1)
-		@child_1_3 = create(:category, id: 6, name: "child_1_3", parent_id: 2, path: "/0/1/2/", position: 2)
-		@child_1_1_1 = create(:category, id: 7, name: "child_1_1_1", parent_id: 4, path: "/0/1/2/4/", position: 0)	
-		@child_1_2_1 = create(:category, id: 8, name: "child_1_2_1", parent_id: 5, path: "/0/1/2/5/", position: 0)
-	end
-
-	describe 'move_to_root' do
-		it 'should move to the root of the tree' do
-			@child_1_2.move_to_root
-			@child_1_2.reload
-			@child_1_1.reload
-			@child_1_3.reload
-			@child_1_2_1.reload
-			expect(@child_1_2.path).to eq("/0/")
-			expect(@child_1_2.parent_id).to eq(0)
-			expect(@child_1_2.position).to eq(0)
-			expect(@child_1_1.position).to eq(0)
-			expect(@child_1_3.position).to eq(1)
-			expect(@child_1_2_1.path).to eq("/0/5/")
-			expect(@child_1.descendants).to eq([@child_1_1, @child_1_3, @child_1_1_1])
-		end
-	end
-
-	describe 'move_to_left_of' do
-		it 'should move to the left of target node' do
-			@child_1_2.move_to_left_of(@child_2)
+  before :each do
+    # test tree:
+    # root(1)
+    #  |__child_1(2)
+    #  |     |__child_1_1(4)
+    #  |     |     |__child_1_1_1(7)
+    #  |     |__child_1_2(5)
+    #  |     |     |__child_1_2_1(8)
+    #  |     |__child_1_3(6)
+    #  |__child_2(3) 
+    @root = create(:category, id: 1, parent_id: 0, path: "/0/", position: 0)
+    @child_1 = create(:category, id: 2, name: "child_1", parent_id: 1, path: "/0/1/", position: 0)
+    @child_2 = create(:category, id: 3, name: "child_2", parent_id: 1, path: "/0/1/", position: 1)
+    @child_1_1 = create(:category, id: 4, name: "child_1_1", parent_id: 2, path: "/0/1/2/", position: 0)
+    @child_1_2 = create(:category, id: 5, name: "child_1_2", parent_id: 2, path: "/0/1/2/", position: 1)
+    @child_1_3 = create(:category, id: 6, name: "child_1_3", parent_id: 2, path: "/0/1/2/", position: 2)
+    @child_1_1_1 = create(:category, id: 7, name: "child_1_1_1", parent_id: 4, path: "/0/1/2/4/", position: 0)	
+    @child_1_2_1 = create(:category, id: 8, name: "child_1_2_1", parent_id: 5, path: "/0/1/2/5/", position: 0)
+  end
+
+  describe 'move_to_root' do
+    it 'should move to the root of the tree' do
+      @child_1_2.move_to_root
+      @child_1_2.reload
+      @child_1_1.reload
+      @child_1_3.reload
+      @child_1_2_1.reload
+      expect(@child_1_2.path).to eq("/0/")
+      expect(@child_1_2.parent_id).to eq(0)
+      expect(@child_1_2.position).to eq(0)
+      expect(@child_1_1.position).to eq(0)
+      expect(@child_1_3.position).to eq(1)
+      expect(@child_1_2_1.path).to eq("/0/5/")
+      expect(@child_1.descendants).to eq([@child_1_1, @child_1_3, @child_1_1_1])
+    end
+  end
+
+  describe 'move_to_left_of' do
+    it 'should move to the left of target node' do
+      @child_1_2.move_to_left_of(@child_2)
 
       @child_1_2.reload
       @child_2.reload
       @child_1_3.reload
       @child_1_2_1.reload
-			expect(@child_1_2.path).to eq('/0/1/')
-			expect(@child_1_2.position).to eq(1)
-			expect(@child_2.position).to eq(2)
-			expect(@child_1_3.position).to eq(1)
-			expect(@child_1_2_1.path).to eq('/0/1/5/')
-		end
-	end
-	
-	describe 'move_to_right_of' do
-		it 'should move to the right of target node' do
+      expect(@child_1_2.path).to eq('/0/1/')
+      expect(@child_1_2.position).to eq(1)
+      expect(@child_2.position).to eq(2)
+      expect(@child_1_3.position).to eq(1)
+      expect(@child_1_2_1.path).to eq('/0/1/5/')
+    end
+  end
+
+  describe 'move_to_right_of' do
+    it 'should move to the right of target node' do
       @child_1_1.move_to_right_of(@child_1)
 
       @child_1_1.reload
@@ -67,11 +67,11 @@ describe 'TextBasedNestedSet' do
       expect(@child_2.position).to eq(2)
       expect(@child_1_2.position).to eq(0)
       expect(@child_1_3.position).to eq(1)
-		end
-	end
+    end
+  end
 
-	describe 'move_to_child_of' do
-		it 'should move to the child of target node' do
+  describe 'move_to_child_of' do
+    it 'should move to the child of target node' do
       @child_1_2.move_to_child_of(@child_1_1)
 
       @child_1_2.reload
@@ -81,37 +81,43 @@ describe 'TextBasedNestedSet' do
       expect(@child_1_2.position).to eq(1)
       expect(@child_1_3.position).to eq(1)
       expect(@child_1_2_1.path).to eq('/0/1/2/4/5/')
-		end
-	end
+    end
+  end
 
-	describe 'parent' do
-		it "should return current node's parent node" do
-			expect(@child_1_1.parent.name).to eq("child_1")
-		end
+  describe 'parent' do
+    it "should return current node's parent node" do
+      expect(@child_1_1.parent.name).to eq("child_1")
+    end
 
     it "should return nil when current node is root node" do
       expect(@root.parent).to eq(nil)
     end
-	end
+  end
 
-	describe 'ancestors' do
-		it "should return current node's ancestors node" do
-			expect(@child_1_1.ancestors).to eq([@root, @child_1])
-		end
-	end
+  describe 'ancestors' do
+    it "should return current node's ancestors node" do
+      expect(@child_1_1.ancestors).to eq([@root, @child_1])
+    end
+  end
 
-	describe 'children' do
-		it "should return current node's children node" do
-			expect(@child_1.children).to eq([@child_1_1, @child_1_2, @child_1_3])
-		end
-	end
+  describe 'self_and_ancestors' do
+    it "should return current node's ancestors node include self" do
+      expect(@child_1_1.self_and_ancestors).to eq([@root, @child_1, @child_1_1])
+    end
+  end
 
-	describe 'descendants' do
-		it "should return current node's all descendants" do
-			expect(@child_1.descendants).to eq([@child_1_1, @child_1_2, @child_1_3, @child_1_1_1, @child_1_2_1])
-			expect(@root.descendants).to eq([@child_1, @child_2, @child_1_1, @child_1_2, @child_1_3, @child_1_1_1, @child_1_2_1])
-		end
-	end
+  describe 'children' do
+    it "should return current node's children node" do
+      expect(@child_1.children).to eq([@child_1_1, @child_1_2, @child_1_3])
+    end
+  end
+
+  describe 'descendants' do
+    it "should return current node's all descendants" do
+      expect(@child_1.descendants).to eq([@child_1_1, @child_1_2, @child_1_3, @child_1_1_1, @child_1_2_1])
+      expect(@root.descendants).to eq([@child_1, @child_2, @child_1_1, @child_1_2, @child_1_3, @child_1_1_1, @child_1_2_1])
+    end
+  end
 
   describe 'right_sibling' do
     it "should return current node's right sibling" do
@@ -133,27 +139,27 @@ describe 'TextBasedNestedSet' do
     end
   end
 
-	describe 'root?' do
-		it "should return true if current node is root node" do
-			expect(@root.root?).to eq(true)
-		end
+  describe 'root?' do
+    it "should return true if current node is root node" do
+      expect(@root.root?).to eq(true)
+    end
 
-		it "should return false if current node is not root node" do
-			expect(@child_1.root?).to eq(false)
-		end
-	end
+    it "should return false if current node is not root node" do
+      expect(@child_1.root?).to eq(false)
+    end
+  end
 
-	describe 'convert_from_awesome_nested_set' do
-		it "should convert awesome nested set to text based nested set" do
+  describe 'convert_from_awesome_nested_set' do
+    it "should convert awesome nested set to text based nested set" do
       @root.update(parent_id: nil)
       @root.reload
       Category.convert_from_awesome_nested_set
       expect(@root.path).to eq('/0/')
-		end
-	end
+    end
+  end
 
-	describe 'rebuild' do
-		it "should rebuild current node's all descendants, set path and position again " do
+  describe 'rebuild' do
+    it "should rebuild current node's all descendants, set path and position again " do
       @root.descendants.each do |d|
         d.update(path: nil, position: nil)
       end
@@ -181,8 +187,8 @@ describe 'TextBasedNestedSet' do
       expect(@child_1.path).to eq('/0/1/')
       expect(@child_1.position).to eq(0)
       expect(@child_1_1_1.path).to eq('/0/1/2/4/')
-		end
-	end
+    end
+  end
 
   describe 'private destroy_descendants' do
     it 'should destroy descendants when itself be destroyed' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: text_based_nested_set
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - beyondalbert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-22 00:00:00.000000000 Z
+date: 2015-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler