fast_tree 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ef95899f36c494fb5bc3cea8317205591f61dae7
-  data.tar.gz: f84331649e1fbf73db8853f7629ef8b7144f69a4
+  metadata.gz: 1a2408d73a49d03de109154c5bc8897bfcbeadaf
+  data.tar.gz: 48bda26709f050ccc1b56ac535220aaf89169696
 SHA512:
-  metadata.gz: 7a5137010f0f12bf4e6c03543814b542d218c61fecc8aee0e886e7fc7c66a6c39d2f51b1bcd9e843ef50ed99f07333e48002859ea5412dcb8d2b2e6d6ef94f9c
-  data.tar.gz: 8a6291deac4b760f876f50f24a2fec8c65262a1bf20b60c3a67041d60d4e6cdd4e13f3b789f71782c33a2e9c16f55782aacfde2534d60a5e8e5508082d9b66fd
+  metadata.gz: 59bd83c3ee0bb38e65dfe8ce9152619a18c65b06eddedfb65b765581e7afd354fc4687f82d25d86058c4d12894e20ad278c8eaa48802eafd4d2e4f30c78ee74f
+  data.tar.gz: c89f948f54b279fc8a857764995353abac0bf56e0bbb38e1ba6ef5afcb6e952757df66db150a1ce5c92211a813f2cd77feecb115d7036100c4baf7e71a210796

data/README.md

@@ -24,18 +24,30 @@ $ gem install fast_tree
 ## Usage
 
 `fast_tree` provides a generator which adds left and right pointers used in nested sets model to your model class.
-Even if you have created a class or not, execute following commands in the terminal:
+Even if you have created a target class or not, execute following commands in your terminal:
 
 ```bash
 $ bin/rails g fast_tree YOUR_MODEL_NAME
 ```
 
-After executing the command, add following sentence into your model:
+and, execute migration by `bundle exec rake db:migrate`.
+
+After that, add the following line into your model:
 
 ```ruby
 include FastTree::Model
 ```
 
+It seems like:
+
+```ruby
+class YOUR_MODEL_NAME < ApplicationRecord
+  include FastTree::Model
+
+  ...
+end
+```
+
 Finally, you can use several methods as class methods and instance methods.
 
 If you are interested in how it works, see the section "How It Works" below.
@@ -137,6 +149,63 @@ target = YOUR_MODEL_NAME.second
 root_of_subtree.move_to(targe)
 ```
 
+### Find root
+
+To get the root node from the tree,
+
+```
+root = YOUR_MODEL_NAME.find_root
+```
+
+### Deal with subtrees
+
+To get subtree from a root node,
+
+```ruby
+# root can be any node in the tree
+root = YOUR_MODEL_NAME.take
+root.subtree.each do |node|
+  # do something
+end
+```
+
+NOTE: `subtree` method returns ActiveRelation, so that you can use `each`, `map` or anything you want!
+
+### Tree traverse algorithms
+
+In `fast_tree`, several tree-traverse algorithms, such as DFS and BFS, are provided.
+
+#### DFS (Depth First Search)
+
+To get nodes by DFS,
+
+```ruby
+root = YOUR_MODEL_NAME.take
+root.subtree.dfs.each do |node|
+  # do something
+end
+```
+
+#### BFS (Breadth First Search)
+
+To get nodes by BFS,
+
+```ruby
+root = YOUR_MODEL_NAME.take
+root.subtree.bfs.each do |node|
+  # do something
+end
+```
+
+### Boolean methods
+
+`fast_tree` provides several boolean methods, such as:
+
+- root?
+- leaf?
+- has_children?
+
+, as instance methods.
 
 ## How It Works
 The migration file will create a migration file, such as:
@@ -148,11 +217,13 @@ class AddFastTreeToTestTrees < ActiveRecord::Migration[5.0]
       ## Pointers
       t.integer :l_ptr
       t.integer :r_ptr
+      t.integer :depth
 
     end
 
     add_index :test_trees, :l_ptr
     add_index :test_trees, :r_ptr
+    add_index :test_trees, :depth
   end
 
   def self.down

data/lib/fast_tree/model/subtree/traverse.rb

@@ -0,0 +1,20 @@
+module FastTree
+  module Model
+    module Subtree
+      module Traverse
+        extend ActiveSupport::Concern
+
+        included do
+          scope :bfs, -> { order(depth: :asc, l_ptr: :asc) }
+          scope :dfs, -> { order(l_ptr: :asc) }
+        end
+
+        def subtree
+          self.class.where(self.class.arel_table[:l_ptr].gteq(l_ptr))
+                    .where(self.class.arel_table[:r_ptr].lteq(r_ptr))
+        end
+
+      end
+    end
+  end
+end

data/lib/fast_tree/model.rb

@@ -2,6 +2,11 @@ module FastTree
   module Model
     extend ActiveSupport::Concern
 
+    included do
+      include FastTree::Model::Subtree::Traverse
+    end
+
+
     # =================
     # Class Methods
     # =================
@@ -13,22 +18,28 @@ module FastTree
       # ====================
 
       def add_parent(parent, children, &block)
+        parent_depth = children.first.depth
+
         # create space for parent
         ptrs = _create_parent_embedded_space(children)
 
         # parent node's pointer
         parent.l_ptr = ptrs[:l_ptr]
         parent.r_ptr = ptrs[:r_ptr]
+        parent.depth = parent_depth
         parent.save
       end
 
       def create_parent(attributes = {}, children, &block)
+        parent_depth = children.first.depth
+
         # create space for parent
         ptrs = _create_parent_embedded_space(children)
 
         # parent node's pointer
         attributes[:l_ptr] = ptrs[:l_ptr]
         attributes[:r_ptr] = ptrs[:r_ptr]
+        attributes[:depth] = parent_depth
 
         self.create(attributes, &block)
       end
@@ -40,6 +51,7 @@ module FastTree
         else
           attributes[:l_ptr] = 0
           attributes[:r_ptr] = 1
+          attributes[:depth] = 0
           self.create(attributes, &block)
         end
       end
@@ -69,6 +81,12 @@ UPDATE #{self.to_s.underscore.pluralize}
                 WHEN l_ptr > #{right}
                   THEN r_ptr + 2
                 ELSE r_ptr
+              END,
+      depth = CASE
+                WHEN l_ptr >= #{left}
+                  AND r_ptr <= #{right}
+                  THEN depth + 1
+                ELSE depth
               END
   WHERE r_ptr > #{left}
         EOS
@@ -134,6 +152,7 @@ UPDATE #{self.to_s.underscore.pluralize}
       # child node's pointer
       node.l_ptr = r_ptr
       node.r_ptr = r_ptr + 1
+      node.depth = depth + 1
       node.save
     end
 
@@ -144,6 +163,7 @@ UPDATE #{self.to_s.underscore.pluralize}
       # create child
       attributes[:l_ptr] = r_ptr
       attributes[:r_ptr] = r_ptr + 1
+      attributes[:depth] = depth + 1
       self.class.create(attributes, &block)
     end
 
@@ -154,19 +174,17 @@ UPDATE #{self.to_s.underscore.pluralize}
       _update_nodes(node.l_ptr, node.r_ptr, "r_ptr >= #{r_ptr}", width + 1)
 
       bias = node.l_ptr + 1 - l_ptr
+      base_depth = depth
       subtree.each do |st_node|
         attributes = st_node.attributes.to_h
         attributes.delete("id")
-        attributes["l_ptr"] = attributes["l_ptr"] + bias
-        attributes["r_ptr"] = attributes["r_ptr"] + bias
+        attributes["l_ptr"] += bias
+        attributes["r_ptr"] += bias
+        attributes["depth"] += node.depth - base_depth + 1
         self.class.create(attributes)
       end
     end
 
-    def depth
-      path.size - 1
-    end
-
     def move_to(node)
       # NOTE:
       # copy_to and remove change node ids
@@ -184,9 +202,11 @@ UPDATE #{self.to_s.underscore.pluralize}
 
       # move subtree under the given node
       bias = node.l_ptr + 1 - l_ptr
+      base_depth = depth
       subtree.each do |st_node|
         st_node.l_ptr += bias
         st_node.r_ptr += bias
+        st_node.depth += node.depth - base_depth + 1
         st_node.save
       end
     end
@@ -217,6 +237,23 @@ UPDATE #{self.to_s.underscore.pluralize}
     end
 
 
+    #
+    # Boolean Methods
+    #
+
+    def root?
+      self.l_ptr == 0
+    end
+
+    def leaf?
+      l_ptr == r_ptr - 1
+    end
+
+    def has_children?
+      l_ptr != r_ptr - 1
+    end
+
+
     protected
 
       def _update_nodes(left, right, condition, diff = 2)

data/lib/fast_tree/version.rb

@@ -1,3 +1,3 @@
 module FastTree
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/lib/fast_tree.rb

@@ -1,11 +1,13 @@
 require 'rails'
 
-module FastTree
-
-  # =====================================
-  # Implementation of Fast Tree Structure
-  # =====================================
 
+module FastTree
   autoload :Model, 'fast_tree/model'
 
+  module Model
+    module Subtree
+      autoload :Traverse, 'fast_tree/model/subtree/traverse'
+    end
+  end
+
 end

data/lib/generators/active_record/fast_tree_generator.rb

@@ -26,6 +26,7 @@ module ActiveRecord
       ## Pointers
       t.integer :l_ptr
       t.integer :r_ptr
+      t.integer :depth
 RUBY
       end
 

data/lib/generators/active_record/templates/migration.rb

@@ -12,5 +12,6 @@ class FastTreeCreate<%= table_name.camelize %> < ActiveRecord::Migration<%= migr
 
     add_index :<%= table_name %>, :l_ptr
     add_index :<%= table_name %>, :r_ptr
+    add_index :<%= table_name %>, :depth
   end
 end

data/lib/generators/active_record/templates/migration_existing.rb

@@ -10,6 +10,7 @@ class AddFastTreeTo<%= table_name.camelize %> < ActiveRecord::Migration<%= migra
 
     add_index :<%= table_name %>, :l_ptr
     add_index :<%= table_name %>, :r_ptr
+    add_index :<%= table_name %>, :depth
   end
 
   def self.down

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fast_tree
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Chisato Hasegawa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-07 00:00:00.000000000 Z
+date: 2017-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -64,6 +64,7 @@ files:
 - Rakefile
 - lib/fast_tree.rb
 - lib/fast_tree/model.rb
+- lib/fast_tree/model/subtree/traverse.rb
 - lib/fast_tree/version.rb
 - lib/generators/active_record/fast_tree_generator.rb
 - lib/generators/active_record/templates/migration.rb
@@ -91,7 +92,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: '["Rails plugin for Fast Tree Structure", "fast_tree is an implementation