hierarchical_db 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d5df75659995cdfaddbf11cea42937d84c05b289
-  data.tar.gz: 6f45c938e09c8c46ae626ded1ca2ef32d1084de3
+  metadata.gz: 64883431f195b17073aa612d3557ceb12c8fd81e
+  data.tar.gz: 6db08ffc8ac1a1a2b3d130814dee8af8f93b1b72
 SHA512:
-  metadata.gz: 16c1f50b554fa28bd522153ad3e02a628213f39cdf715ed03e5ff75ce4ae6788f512dcadf08562e0834f6f3b09d5fb94dc0d18b4cd780100eb4101de579a7ea3
-  data.tar.gz: 7da0954f5a0e45a81b6a8c017e56f47b14b10fcdde06a82ca900950573a3e181c2bb8f404aa41911165ff5d7b5a065dc9d9027a81e93dd58a40275688cd9a728
+  metadata.gz: 5f71f74d22c63b69addb577443565ef5872732354668234a3c2570fd32e8096e8ad32b4d7c0706774b9dca796674013d330207cb34a9c98dd43709aa7ed6c444
+  data.tar.gz: e9587fd1e7683d319186b67aa4e04bd601b920b742be8cb202b05d6ba3fff165c8e6764b3a3db33dc3dcb6e8938389b89f8f56d3bacd757b4bb743bf54ff02bd

data/README.md

@@ -1,8 +1,6 @@
 # HierarchicalDb
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/hierarchical_db`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+This gem has the implementation of **[Hierarchical databases](http://www.sitepoint.com/hierarchical-data-database/)**
 
 ## Installation
 
@@ -20,9 +18,45 @@ Or install it yourself as:
 
     $ gem install hierarchical_db
 
+Next you have to add a migration into your model with attributes *lft* and *rgt*. For example, if you have a model called *Territory* (to manage countries, cities and all the other hierarchies) with the following relationship:
+```ruby
+class Territory < ActiveRecord::Base
+  belongs_to :parent_territory, class_name: 'Territory'
+end
+```
+You have to add a migration like this:
+```ruby
+class AddSortedTreeFields < ActiveRecord::Migration
+  def change
+    add_column :territories, :lft, :integer
+    add_column :territories, :rgt, :integer
+  end
+end
+```
+Into the model you have to include Hierarchies adding the code below:
+```ruby
+class Territory < ActiveRecord::Base
+  include HierarchicalDb #we added this
+  belongs_to :parent_territory, class_name: 'Territory'
+end
+```
+Finally we add two alias methods that are useful and necessary to deal with hierarchies:
+```ruby
+class Territory < ActiveRecord::Base
+  include HierarchicalDb 
+  belongs_to :parent_territory, class_name: 'Territory'
+  # alias methods
+  alias_method :children, :territories #we added this
+  alias_method :parent, :parent_territory #we added this
+end
+```
 ## Usage
 
-TODO: Write usage instructions here
+Continuing the example, if you have data inside your Territory model, then you have to execute :
+```ruby
+  Territory.sort_tree
+```
+This command initializes your tree and fills *lft* and *rgt* attributes with corresponding information.
 
 ## Development
 

data/hierarchical_db.gemspec

@@ -5,12 +5,12 @@ require 'hierarchical_db/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "hierarchical_db"
-  spec.version       = "0.0.1"
+  spec.version       = "0.0.2"
   spec.authors       = ["Gustavo"]
   spec.email         = ["ginzunza@rebuss.cl"]
 
   spec.summary       = ""
-  spec.description   = "it gem helps to store hierarchical data in a database"
+  spec.description   = "helps to store and deal with data inside hierarchical databases"
   spec.homepage      = "https://github.com/ginzunza/hierarchical_db"
   spec.license       = "MIT"
 

data/lib/generators/hierarchical_db_generator.rb

@@ -0,0 +1,29 @@
+require 'rails/generators/named_base'
+require 'rails/generators/active_record'
+
+module GemName
+  module Generators
+    class GemNameGenerator < ActiveRecord::Generators::Base
+
+    include Rails::Generators::ResourceHelpers
+
+    namespace "gem_name"
+
+    desc "Creates GemName Migrations"
+
+    source_root File.expand_path("../templates", __FILE__)
+
+    def copy_migration
+      migration_template "migration_existing.rb", "db/migrate/add_gem_name_to_#{plural_name.downcase}"
+    end
+
+      def migration_data
+  <<RUBY
+    ## Add active column to table
+    t.integer :lft
+    t.integer :rgt
+  RUBY
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hierarchical_db
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Gustavo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-01-11 00:00:00.000000000 Z
+date: 2016-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,7 +38,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
-description: it gem helps to store hierarchical data in a database
+description: helps to store and deal with data inside hierarchical databases
 email:
 - ginzunza@rebuss.cl
 executables: []
@@ -55,7 +55,9 @@ files:
 - bin/console
 - bin/setup
 - hierarchical_db-0.0.0.gem
+- hierarchical_db-0.0.1.gem
 - hierarchical_db.gemspec
+- lib/generators/hierarchical_db_generator.rb
 - lib/hierarchical_db.rb
 - lib/hierarchical_db/version.rb
 homepage: https://github.com/ginzunza/hierarchical_db