hierarchical_db 0.1.10 → 0.1.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3cd5a0a3c0ca253364f9e3c65a798860b282ec25
-  data.tar.gz: f7c515e07bda5d3915e732ec8361cbfdbbcd56e6
+  metadata.gz: 9a37eb0bc5a842cbaa2ca967fbbccbbb8933bc45
+  data.tar.gz: d1b9f93c3b683bfdd38c94e98a807fed857c452f
 SHA512:
-  metadata.gz: 087388cc9d776558e40e279fcaa596663d8e26c5afce4c905ec3cf8e4498ff8db43d18dca581182ea044eff61f2bf89a8307907aa501ecec0b7b7ea7afe4a2be
-  data.tar.gz: 8be015ba14c7254af2c5371d0f084ce31634d3b78d9f00ade8ed45a149e0d35b68c07fc0eacbe677ecf72f77496936d8e3ccfa421cf1da4a17ca6e946dca684e
+  metadata.gz: cd188572650b78d01f48347e085db2a7010269b905dbbedf6583a7e340ef4fea42560c0615925b2fbb7a9c7b588ee5d0609a3a80464e537d9abff8444d3947f4
+  data.tar.gz: f528942a23f742e79619840726fb43e2001cf94fdc4b0dc13397a23216723bf8377ea139d7e02496dffbcb01c4678007ac1316ded4a7c005927d43a9b2fb5639

data/README.md

@@ -35,16 +35,22 @@ Next into the model you have to include Hierarchies adding the code below:
 class Territory < ActiveRecord::Base
   include HierarchicalDb #we added this
   belongs_to :parent_territory, class_name: 'Territory'
+  has_many :territories, class_name: 'Territory', foreign_key: 'parent_territory_id'
 end
 ```
-Finally we add two alias methods that are useful and necessary to deal with hierarchies:
+Finally we add two alias methods that are useful and necessary to deal with hierarchies and his parent method:
 ```ruby
 class Territory < ActiveRecord::Base
   include HierarchicalDb 
   belongs_to :parent_territory, class_name: 'Territory'
+  has_many :territories, class_name: 'Territory', foreign_key: 'parent_territory_id'
   # alias methods
   alias_method :children, :territories #we added this
   alias_method :parent, :parent_territory #we added this
+
+  def parent_key
+    'parent_territory_id'
+  end
 end
 ```
 ## Usage
@@ -56,6 +62,17 @@ Continuing the example, if you have data inside your Territory model, then you h
 This is a Class method and is imperative to use this after load seeds or when you first enter information inside your model. If you don't have any data inside your model this method doesn't have any sense. On the other hand, if you have data inside your model and you has never executed *sort_tree* then this gem won't work.<br>
 Sort_tree initializes your tree and fills *lft* and *rgt* attributes with corresponding information.<br>
 After execute this command you will able to use all useful methods below
+###Example Model
+For all our examples we will use territories model with the data below:
+![GitHub Logo](/img/tree.png) <br>
+Territory model has the attributes: name, lft, rgt, id and parent_territory_id
+
+id | name | lft | rgt | parent_territory_id
+------------ | ------------- | ------------- | ------------- | ------------- 
+1 | Chile | 1| 8 | nil
+2 | Región Metropolitana | 6| 7 | 1
+3 | Región del BíoBío | 2| 5 | 1
+4 | Concepción | 3| 4 | 3
 ###Useful Methods
 
 #####display_tree
@@ -63,6 +80,13 @@ This is a Class method and returns graphically and tabulated the entire tree. Ex
 ```ruby
 Territory.display_tree
 ```
+It returns:
+```
+1-Chile
+  3-Región del BíoBío
+    4-Concepción
+  2-Región Metropolitana
+```
 #####descendants
 Returns an array with all childrens order by lft attribute, example:
 ```ruby
@@ -83,7 +107,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/hierarchical_db. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/ginzunza/hierarchical_db. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
 
 
 ## License

data/hierarchical_db.gemspec

@@ -5,7 +5,7 @@ require 'hierarchical_db/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "hierarchical_db"
-  spec.version       = "0.1.10"
+  spec.version       = "0.1.13"
   spec.authors       = ["Gustavo"]
   spec.email         = ["ginzunza@rebuss.cl"]
 

data/lib/generators/templates/migration_existing.rb

@@ -2,5 +2,6 @@ class HierarchicalDb<%= plural_name.camelize %> < ActiveRecord::Migration
   def change
     add_column :<%= plural_name %>, :lft, :integer
     add_column :<%= plural_name %>, :rgt, :integer
+    add_column :<%= plural_name %>, :lvl, :integer
    end
 end

data/lib/hierarchical_db.rb

@@ -25,7 +25,7 @@ module HierarchicalDb extend ActiveSupport::Concern
         root_nodes[0].sort_subtree(1)
       else
         right = 2
-        root_nodes.each{|n| right = n.sort_subtree(right) }
+        root_nodes.each{|n| right = n.sort_subtree(right, 1) }
       end
     end
 
@@ -35,11 +35,12 @@ module HierarchicalDb extend ActiveSupport::Concern
     end
   end
 
-  def sort_subtree left
+  def sort_subtree left, lvl
     right = left + 1
-    self.children.each{|child| right = child.sort_subtree(right) }
+    self.children.each{|child| right = child.sort_subtree(right, lvl + 1) }
     self.lft = left
     self.rgt = right
+    self.lvl = lvl
     self.save
     return right + 1
   end
@@ -56,12 +57,17 @@ module HierarchicalDb extend ActiveSupport::Concern
     (self.rgt - self.lft - 1)/2
   end
 
+  def childs
+    descendants.where(:lvl => self.lvl + 1)
+  end
+
   def insert_node
     unless self.class.is_sorted?
       return
     end
     father = self.parent
     previous_right = ""
+    lvl = ""
     #case it has descendants
     unless father.nil?
       last_brother = father.descendants.where(:rgt => father.descendants.maximum(:rgt))
@@ -69,9 +75,11 @@ module HierarchicalDb extend ActiveSupport::Concern
       unless last_brother.empty?
         last_brother = last_brother[0]
         previous_right = last_brother.rgt
+        lvl = last_brother.lvl
       #case hasn't brothers
       else
         previous_right = father.rgt - 1
+        lvl = father.lvl + 1 
       end
       childs = self.class.where("lft > ?", previous_right)
       childs.each do |t|
@@ -91,6 +99,7 @@ module HierarchicalDb extend ActiveSupport::Concern
     end
     self.lft = previous_right + 1
     self.rgt = previous_right + 2
+    self.lvl = lvl
   end
 
   def destroy_node

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hierarchical_db
 version: !ruby/object:Gem::Version
-  version: 0.1.10
+  version: 0.1.13
 platform: ruby
 authors:
 - Gustavo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-01-13 00:00:00.000000000 Z
+date: 2016-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -55,6 +55,7 @@ files:
 - bin/console
 - bin/setup
 - hierarchical_db.gemspec
+- img/tree.png
 - lib/generators/hierarchical_db/templates/migration_existing.rb
 - lib/generators/hierarchical_db_generator.rb
 - lib/generators/templates/migration_existing.rb