ltree_hierarchy 0.0.5 → 0.0.6

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    MTUwOWNjYTQ3NTM5YmQ3NzA0ZGE4MmMwMzczNjQzMTM1N2RiMGY1OQ==
-  data.tar.gz: !binary |-
-    MzQwZGU1ZWIwZGY5MzNjM2I5OGQ1MTRkZDE4NmFjZWMxYmJiYjEzYw==
+SHA1:
+  metadata.gz: ddf71fca7fa2fce2c558501cbb85eea76a98b2a8
+  data.tar.gz: 2b94b34ba4601dabaff8b0499615a9e9b9250118
 SHA512:
-  metadata.gz: !binary |-
-    NDBiNjg4MTFkNDg3Nzk3ZGQzY2ZkZjY4YjJmYTE2ZmNiYTAyZTJhZDIxMjFk
-    MDMyZGM4ZWMwYWMyYmY4NDRkNjY4Yjc3N2RlMTMzOGU2Yjk0N2IyNDhlZDA2
-    ZDE3NTBiMGNjZTU5YWM4MTQ5ZjM5YjY3YWVlYWIyMjZjYWNiMTY=
-  data.tar.gz: !binary |-
-    ZWY1YTg3MWY4NTM4NzJhNzQzZmExNWQ5MmVlNGNmMmQ4MzlhNDY1ZWZiOGY4
-    OGRhYWJhMjU5MDg5N2JjYWViYWFkNjI3NjM5NDYxZjhlZmY1NzI2ZmFiM2I2
-    NGFlOTMwODRiOTYxOGVlZTFjYjNkYzJlOGQ1Y2JjZDMzOWFjODQ=
+  metadata.gz: 14442c8f23722c9eb7019e93f15d64307114323b2eb57ba0dcb4193b62db142ff251a98b8c38c97994f9b3a9a5a8128770ef3a0a53d9b16b5786189044700c25
+  data.tar.gz: b9efa3414d82f84d940fb889c675819b7812a51cdffcff4da91945c2724f739fbb1af181cb456495a9f22bf5394bdc747750c67700dab437ec40a4865d46e9a1

data/Gemfile.lock

@@ -1,39 +1,36 @@
 PATH
   remote: .
   specs:
-    ltree_hierarchy (0.0.4)
+    ltree_hierarchy (0.0.5)
       activerecord (>= 3.1.0)
       pg
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (4.0.0)
-      activesupport (= 4.0.0)
-      builder (~> 3.1.0)
-    activerecord (4.0.0)
-      activemodel (= 4.0.0)
-      activerecord-deprecated_finders (~> 1.0.2)
-      activesupport (= 4.0.0)
-      arel (~> 4.0.0)
-    activerecord-deprecated_finders (1.0.3)
-    activesupport (4.0.0)
-      i18n (~> 0.6, >= 0.6.4)
-      minitest (~> 4.2)
-      multi_json (~> 1.3)
+    activemodel (4.1.6)
+      activesupport (= 4.1.6)
+      builder (~> 3.1)
+    activerecord (4.1.6)
+      activemodel (= 4.1.6)
+      activesupport (= 4.1.6)
+      arel (~> 5.0.0)
+    activesupport (4.1.6)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    arel (5.0.1.20140414130214)
+    builder (3.2.2)
+    i18n (0.7.0)
+    json (1.8.2)
+    minitest (5.5.1)
+    pg (0.17.1)
+    rake (10.4.2)
+    thread_safe (0.3.4)
+    tzinfo (1.2.2)
       thread_safe (~> 0.1)
-      tzinfo (~> 0.3.37)
-    arel (4.0.0)
-    atomic (1.1.14)
-    builder (3.1.4)
-    i18n (0.6.5)
-    minitest (4.7.5)
-    multi_json (1.8.0)
-    pg (0.17.0)
-    rake (10.1.0)
-    thread_safe (0.1.3)
-      atomic
-    tzinfo (0.3.37)
 
 PLATFORMS
   ruby

data/README.md

@@ -1,54 +1,85 @@
-# ltree_hierarchy
+# Ltree Hierarchy
 
 A simplistic gem that allows ActiveRecord models to be organized in a tree or hierarchy. It uses a materialized path implementation based around PostgreSQL's [ltree](http://www.postgresql.org/docs/current/static/ltree.html) data type, associated functions and operators.
 
-[![Build Status](https://api.travis-ci.org/robworley/ltree_hierarchy.png)](https://travis-ci.org/robworley/ltree_hierarchy)
-
 ## Why might you want to use it?
 
 - You want to be able to construct optimized hierarchical queries with ease, both from Ruby AND raw SQL.
 - You want to be able to compose complex arel expressions from pre-defined building blocks.
 - You prefer PostgreSQL over other relational DBs.
 
-## Getting started
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ltree_hierarchy'
+
+And then execute:
+
+    $ bundle
+
+Add ltree extension to PostgreSQL:
+
+    $ psql -U postgres -d my_database
+    -> CREATE EXTENSION IF NOT EXISTS ltree;
+
+Update your table:
 
-Follow these steps to apply to any ActiveRecord model:
+``` ruby
+class AddLtreeToLocations < ActiveRecord::Migration
+  def self.up
+    add_column :locations, :parent_id, :integer
+    add_column :locations, :path, :ltree
 
-1. Install
- - Add to Gemfile: **gem 'ltree_hierarchy', :git => 'git://github.com/robworley/ltree_hierarchy.git'**
- - Install required gems: **bundle install**
-2. Add parent_id (integer) and path (ltree) columns to your table.
-3. Add ltree hierarchy to your model
-   - Add to app/models/[model].rb: has_ltree_hierarchy
+    add_index :locations, :parent_id
+  end
 
-## Organizing records into a tree
+  def self.down
+    remove_index :locations, :parent_id
+    remove_column :locations, :parent_id
+    remove_column :locations, :path
+  end
+end
+```
 
-Set the parent association or parent_id:
+Run migrations:
 
-Node.create! :name => 'New York', :parent => Node.create!(:name => 'USA')
+    $ bundle exec rake db:migrate
 
-## Navigating the tree
+## Usage
 
-The usual basic tree stuff. Use the following methods on any model instance:
+``` ruby
+  class Location < ActiveRecord::Base
+    has_ltree_hierarchy
+  end
 
-- parent
-- ancestors
-- self_and_ancestors
-- siblings
-- self_and_siblings
-- children
-- self_and_children
-- descendents
-- self_and_descendents
-- leaves
+  root     = Location.create!(name: 'UK')
+  child    = Location.create!(name: 'London', parent: root)
+  subchild = Location.create!(name: 'Hackney', parent: child)
 
-Useful class methods:
+  root.parent   # => nil
+  child.parent # => root
+  root.children # => [child]
+  root.children.first.children.first # => subchild
+  subchild.root # => root
+```
 
-- roots
-- leaves
-- at_depth(n)
-- lowest_common_ancestors(scope)
+- `.roots`
+- `.leaves`
+- `.at_depth(n)`
+- `.lowest_common_ancestors(scope)`
+- `#parent`
+- `#ancestors`
+- `#self_and_ancestors`
+- `#siblings`
+- `#self_and_siblings`
+- `#children`
+- `#self_and_children`
+- `#descendents`
+- `#self_and_descendents`
+- `#leaves`
 
 ## TODO
 
-- Better error message for circular references. Don't neglect i18n.
+- [ ] Better error message for circular references.
+- [ ] Don't neglect i18n.

data/lib/ltree_hierarchy/hierarchy.rb

@@ -133,7 +133,7 @@ module Ltree
       end
 
       def leaf?
-        !children.any?
+        !children.exists?
       end
 
       def depth # 1-based, for compatibility with ltree's nlevel().
@@ -146,6 +146,10 @@ module Ltree
         end
       end
 
+      def root
+        ltree_scope.where("#{ltree_path_column} = subpath(?, 0, 1)", ltree_path).first
+      end
+
       def ancestors
         ltree_scope.where("#{ltree_path_column} @> ? AND #{ltree_fragment_column} != ?", ltree_path, ltree_fragment)
       end

data/lib/ltree_hierarchy/version.rb

@@ -1,5 +1,5 @@
 module Ltree
   module Hierarchy
-    VERSION = "0.0.5"
+    VERSION = "0.0.6"
   end
 end

metadata

@@ -1,55 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: ltree_hierarchy
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Rob Worley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-04 00:00:00.000000000 Z
+date: 2015-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Organizes ActiveRecord models into a tree/hierarchy using a materialized
@@ -61,14 +75,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/ltree_hierarchy/hierarchy.rb
-- lib/ltree_hierarchy/version.rb
-- lib/ltree_hierarchy.rb
 - Gemfile
 - Gemfile.lock
 - MIT-LICENSE
-- Rakefile
 - README.md
+- Rakefile
+- lib/ltree_hierarchy.rb
+- lib/ltree_hierarchy/hierarchy.rb
+- lib/ltree_hierarchy/version.rb
 homepage: https://github.com/robworley/ltree_hierarchy
 licenses:
 - MIT
@@ -79,17 +93,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: ltree_hierarchy
-rubygems_version: 2.1.5
+rubygems_version: 2.4.7
 signing_key: 
 specification_version: 4
 summary: Organize ActiveRecord models into a tree using PostgreSQL's ltree datatype