pg_ltree 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f6149a7caa97eb49d20b3f8b9c144d98ee6af04e
+  data.tar.gz: ab7a5c2f1d37d3f55c2c49bda92eb8f0fe43e4c2
+SHA512:
+  metadata.gz: 2226c78595c239d7db0e29dc69d91ff93a1a2c4a47903fe531c88efe7d7022a24eef7b873afd5efb1610d60b6d32f3d9f22fe115f1983a6908d701e2cfe33d4e
+  data.tar.gz: 1a2df813b90353f92db7ab1b4f5c0dc2f65af997a6c337a8df45ab906cce7ae676c6f3d53873ce3164905b4241704cece1a8744adaa54a71a3ea7dbc48394d75

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Andrei Panamarenka
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,29 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'PgLtree'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/pg_ltree/ltree.rb

@@ -0,0 +1,190 @@
+module PgLtree
+  # Implementatios Postgres ltree for ActiveRecord
+  #
+  # @see [ActiveRecord::Base]
+  # @see http://www.postgresql.org/docs/current/static/ltree.html
+  #
+  # @author a.ponomarenko
+  module Ltree
+
+    # Initialzie ltree for active model
+    #
+    # @param column [String] ltree column name
+    def ltree(column = :path)
+      cattr_accessor :ltree_path_column
+
+      self.ltree_path_column = column
+
+      has_and_belongs_to_many column.to_s.tableize.to_sym,
+            class_name: self.class.name,
+            association_foreign_key: 'path'
+
+      extend ClassMethods
+      include InstanceMethods
+    end
+
+    # Define class methods
+    module ClassMethods
+      # Get roots
+      #
+      # @return [ActiveRecord::Relation] relations of node's roots
+      def roots
+        at_depth 1
+      end
+
+      # Get nodes on the level
+      #
+      # @param depth [Integer] Depth of the nodes
+      # @return [ActiveRecord::Relation] relations of nodes for the depth
+      def at_depth(depth)
+        where "NLEVEL(#{ltree_path_column}) = ?", depth
+      end
+
+      # Get all leaves
+      #
+      # @return [ActiveRecord::Relation] relations of node's leaves
+      def leaves
+        subquery =
+          select("COUNT(subquery.#{ltree_path_column}) = 1")
+          .from("#{table_name} AS subquery")
+          .where("subquery.#{ltree_path_column} <@ #{table_name}.#{ltree_path_column}").to_sql
+        where subquery
+      end
+
+      # Get all with nodes when path liked the lquery
+      #
+      # @param lquery [String] ltree query
+      # @return [ActiveRecord::Relation] relations of node'
+      def where_path_liked(lquery)
+        where "#{ltree_path_column} ~ ?", lquery
+      end
+    end
+
+    # Define instance methods
+    module InstanceMethods
+
+      # Get default scope of ltree
+      #
+      # @return current class
+      def ltree_scope
+        self.class
+      end
+
+      # Get lTree column
+      #
+      # @return [String] ltree column name
+      def ltree_path_column
+        ltree_scope.ltree_path_column
+      end
+
+      # Get lTree value
+      #
+      # @return [String] ltree current value
+      def ltree_path
+        public_send ltree_path_column
+      end
+
+      # Get lTree previous value
+      #
+      # @return [String] ltree previous value
+      def ltree_path_was
+        public_send :"#{ltree_path_column}_was"
+      end
+
+      # Check what current node is root
+      #
+      # @return [Boolean] True - for root node, False - for childen node
+      def root?
+        depth == 1
+      end
+
+      # Get node depth
+      #
+      # @return [Integer] node depth
+      def depth
+        ltree_scope.distinct.pluck("NLEVEL('#{ltree_path}')").first || nil
+      end
+
+      # Get root of the node
+      #
+      # return [Object] root node
+      def root
+        ltree_scope.where("#{ltree_path_column} = SUBPATH(?, 0, 1)", ltree_path).first
+      end
+
+      # Get parent of the node
+      #
+      # return [Object] root node
+      def parent
+        ltree_scope.find_by "#{ltree_path_column} = SUBPATH(?, 0, NLEVEL(?) - 1)", ltree_path, ltree_path
+      end
+
+      # Get leaves of the node
+      #
+      # @return [ActiveRecord::Relation]
+      def leaves
+        ltree_scope.leaves.where("#{ltree_path_column} <@ ?", ltree_path).where.not ltree_path_column => ltree_path
+      end
+
+      # Check what current node have leaves
+      #
+      # @return [Boolean] True - if node have leaves, False - if node doesn't have leaves
+      def leaf?
+        leaves.count == 0
+      end
+
+      # Get self and ancestors
+      #
+      # @return [ActiveRecord::Relation]
+      def self_and_ancestors
+        ltree_scope.where("#{ltree_path_column} @> ?", ltree_path)
+      end
+
+      # Get ancestors
+      #
+      # @return [ActiveRecord::Relation]
+      def ancestors
+        self_and_ancestors.where.not ltree_path_column => ltree_path
+      end
+
+      # Get self and descendents
+      #
+      # @return [ActiveRecord::Relation]
+      def self_and_descendents
+        ltree_scope.where("#{ltree_path_column} <@ ?", ltree_path)
+      end
+
+      # Get descendents
+      #
+      # @return [ActiveRecord::Relation]
+      def descendents
+        self_and_descendents.where.not ltree_path_column => ltree_path
+      end
+
+      # Get self and siblings
+      #
+      # @return [ActiveRecord::Relation]
+      def self_and_siblings
+        ltree_scope.where(
+          "SUBPATH(?, 0, NLEVEL(?) - 1) @> #{ltree_path_column} AND nlevel(#{ltree_path_column}) = NLEVEL(?)",
+          ltree_path, ltree_path, ltree_path
+        )
+      end
+
+      # Get siblings
+      #
+      # @return [ActiveRecord::Relation]
+      def siblings
+        self_and_siblings.where.not ltree_path_column => ltree_path
+      end
+
+      # Get children
+      #
+      # @return [ActiveRecord::Relation]
+      def children
+        ltree_scope.where "? @> #{ltree_path_column} AND nlevel(#{ltree_path_column}) = NLEVEL(?) + 1",
+          ltree_path, ltree_path
+      end
+    end
+  end
+end

data/lib/pg_ltree/scoped_for.rb

@@ -0,0 +1,45 @@
+module PgLtree
+  # Narrowing the Scope for ActiveRecord Model
+  # @note When model have composite uniq key (for example: state + path), you should use this module for narrowing the scope
+  #
+  # @author a.ponomarenko
+  module ScopedFor
+
+    # Define base instance scope for model by columns
+    #
+    # @param columns [Array] List of scoped fields
+    def ltree_scoped_for(columns = [])
+      cattr_accessor :ltree_scoped_for
+
+      self.ltree_scoped_for = Array.wrap(columns)
+
+      extend ClassMethods
+      include InstanceMethods
+    end
+
+    # Define class methods
+    module ClassMethods
+      # Get all leaves
+      #
+      # @return [ActiveRecord::Relation] relations of node's leaves
+      def leaves
+        subquery =
+          select("COUNT(subquery.#{ltree_path_column}) = (SELECT COUNT(DISTINCT #{ltree_scoped_for.first}) FROM #{table_name})")
+          .from("#{table_name} AS subquery")
+          .where("subquery.#{ltree_path_column} <@ #{table_name}.#{ltree_path_column}").to_sql
+        where subquery
+      end
+    end
+
+    # Define instance methods
+    module InstanceMethods
+
+      # Get default scope of ltree
+      #
+      # @return current class
+      def ltree_scope
+        self.class.where *(ltree_scoped_for.map { |column| { column => public_send(column) } })
+      end
+    end
+  end
+end

data/lib/pg_ltree/version.rb

@@ -0,0 +1,8 @@
+# Organise ActiveRecord model into a tree structure with PostgreSQL LTree
+#
+# @author a.ponomarenko
+module PgLtree
+
+  # Gem Version
+  VERSION = "1.0.0"
+end

data/lib/pg_ltree.rb

@@ -0,0 +1,5 @@
+require "pg_ltree/ltree"
+require "pg_ltree/scoped_for"
+require "pg_ltree/version"
+
+ActiveRecord::Base.extend(PgLtree::Ltree)

data/lib/tasks/pg_ltree_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :pg_ltree do
+#   # Task goes here
+# end

data/test/doc/_index.html

@@ -0,0 +1,88 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>
+  Documentation by YARD 0.8.7.6
+  
+</title>
+
+  <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
+
+  <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
+
+<script type="text/javascript" charset="utf-8">
+  hasFrames = window.top.frames.main ? true : false;
+  relpath = '';
+  framesUrl = "frames.html#!_index.html";
+</script>
+
+
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+
+
+  </head>
+  <body>
+    <div id="header">
+      <div id="menu">
+  
+
+  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+
+      <div id="search">
+  
+    <a class="full_list_link" id="class_list_link"
+        href="class_list.html">
+      Class List
+    </a>
+  
+    <a class="full_list_link" id="method_list_link"
+        href="method_list.html">
+      Method List
+    </a>
+  
+    <a class="full_list_link" id="file_list_link"
+        href="file_list.html">
+      File List
+    </a>
+  
+</div>
+      <div class="clear"></div>
+    </div>
+
+    <iframe id="search_frame"></iframe>
+
+    <div id="content"><h1 class="noborder title">Documentation by YARD 0.8.7.6</h1>
+<div id="listing">
+  <h1 class="alphaindex">Alphabetic Index</h1>
+  
+<div class="clear"></div>
+<h2>Namespace Listing A-Z</h2>
+
+
+
+
+<table>
+  <tr>
+    <td valign='top' width="33%">
+      
+    </td>
+  </tr>
+</table>
+
+</div>
+
+</div>
+
+    <div id="footer">
+  Generated on Sun Aug  9 21:09:19 2015 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.8.7.6 (ruby-2.2.0).
+</div>
+
+  </body>
+</html>

data/test/doc/class_list.html

@@ -0,0 +1,58 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    
+      <link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen" charset="utf-8" />
+    
+      <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
+    
+
+    
+      <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+    
+      <script type="text/javascript" charset="utf-8" src="js/full_list.js"></script>
+    
+
+    <title>Class List</title>
+    <base id="base_target" target="_parent" />
+  </head>
+  <body>
+    <script type="text/javascript" charset="utf-8">
+      var hasFrames = false;
+      try {
+        hasFrames = window.top.frames.main ? true : false;
+      } catch (e) { }
+      if (hasFrames) {
+        document.getElementById('base_target').target = 'main';
+        document.body.className = 'frames';
+      }
+    </script>
+    <div id="content">
+      <h1 id="full_list_header">Class List</h1>
+      <div id="nav">
+        
+          <span><a target="_self" href="class_list.html">
+            Classes
+          </a></span>
+        
+          <span><a target="_self" href="method_list.html">
+            Methods
+          </a></span>
+        
+          <span><a target="_self" href="file_list.html">
+            Files
+          </a></span>
+        
+      </div>
+      <div id="search">Search: <input type="text" /></div>
+
+      <ul id="full_list" class="class">
+        <li><span class='object_link'><a href="top-level-namespace.html" title="Top Level Namespace (root)">Top Level Namespace</a></span></li>
+
+
+      </ul>
+    </div>
+  </body>
+</html>

data/test/doc/css/common.css

@@ -0,0 +1 @@
+/* Override this file with custom rules */

data/test/doc/css/full_list.css

@@ -0,0 +1,57 @@
+body {
+  margin: 0;
+  font-family: "Lucida Sans", "Lucida Grande", Verdana, Arial, sans-serif;
+  font-size: 13px;
+  height: 101%;
+  overflow-x: hidden;
+}
+
+h1 { padding: 12px 10px; padding-bottom: 0; margin: 0; font-size: 1.4em; }
+.clear { clear: both; }
+#search { position: absolute; right: 5px; top: 9px; padding-left: 24px; }
+#content.insearch #search, #content.insearch #noresults { background: url(data:image/gif;base64,R0lGODlhEAAQAPYAAP///wAAAPr6+pKSkoiIiO7u7sjIyNjY2J6engAAAI6OjsbGxjIyMlJSUuzs7KamppSUlPLy8oKCghwcHLKysqSkpJqamvT09Pj4+KioqM7OzkRERAwMDGBgYN7e3ujo6Ly8vCoqKjY2NkZGRtTU1MTExDw8PE5OTj4+PkhISNDQ0MrKylpaWrS0tOrq6nBwcKysrLi4uLq6ul5eXlxcXGJiYoaGhuDg4H5+fvz8/KKiohgYGCwsLFZWVgQEBFBQUMzMzDg4OFhYWBoaGvDw8NbW1pycnOLi4ubm5kBAQKqqqiQkJCAgIK6urnJyckpKSjQ0NGpqatLS0sDAwCYmJnx8fEJCQlRUVAoKCggICLCwsOTk5ExMTPb29ra2tmZmZmhoaNzc3KCgoBISEiIiIgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACH/C05FVFNDQVBFMi4wAwEAAAAh/hpDcmVhdGVkIHdpdGggYWpheGxvYWQuaW5mbwAh+QQJCAAAACwAAAAAEAAQAAAHaIAAgoMgIiYlg4kACxIaACEJCSiKggYMCRselwkpghGJBJEcFgsjJyoAGBmfggcNEx0flBiKDhQFlIoCCA+5lAORFb4AJIihCRbDxQAFChAXw9HSqb60iREZ1omqrIPdJCTe0SWI09GBACH5BAkIAAAALAAAAAAQABAAAAdrgACCgwc0NTeDiYozCQkvOTo9GTmDKy8aFy+NOBA7CTswgywJDTIuEjYFIY0JNYMtKTEFiRU8Pjwygy4ws4owPyCKwsMAJSTEgiQlgsbIAMrO0dKDGMTViREZ14kYGRGK38nHguHEJcvTyIEAIfkECQgAAAAsAAAAABAAEAAAB2iAAIKDAggPg4iJAAMJCRUAJRIqiRGCBI0WQEEJJkWDERkYAAUKEBc4Po1GiKKJHkJDNEeKig4URLS0ICImJZAkuQAhjSi/wQyNKcGDCyMnk8u5rYrTgqDVghgZlYjcACTA1sslvtHRgQAh+QQJCAAAACwAAAAAEAAQAAAHZ4AAgoOEhYaCJSWHgxGDJCQARAtOUoQRGRiFD0kJUYWZhUhKT1OLhR8wBaaFBzQ1NwAlkIszCQkvsbOHL7Y4q4IuEjaqq0ZQD5+GEEsJTDCMmIUhtgk1lo6QFUwJVDKLiYJNUd6/hoEAIfkECQgAAAAsAAAAABAAEAAAB2iAAIKDhIWGgiUlh4MRgyQkjIURGRiGGBmNhJWHm4uen4ICCA+IkIsDCQkVACWmhwSpFqAABQoQF6ALTkWFnYMrVlhWvIKTlSAiJiVVPqlGhJkhqShHV1lCW4cMqSkAR1ofiwsjJyqGgQAh+QQJCAAAACwAAAAAEAAQAAAHZ4AAgoOEhYaCJSWHgxGDJCSMhREZGIYYGY2ElYebi56fhyWQniSKAKKfpaCLFlAPhl0gXYNGEwkhGYREUywag1wJwSkHNDU3D0kJYIMZQwk8MjPBLx9eXwuETVEyAC/BOKsuEjYFhoEAIfkECQgAAAAsAAAAABAAEAAAB2eAAIKDhIWGgiUlh4MRgyQkjIURGRiGGBmNhJWHm4ueICImip6CIQkJKJ4kigynKaqKCyMnKqSEK05StgAGQRxPYZaENqccFgIID4KXmQBhXFkzDgOnFYLNgltaSAAEpxa7BQoQF4aBACH5BAkIAAAALAAAAAAQABAAAAdogACCg4SFggJiPUqCJSWGgkZjCUwZACQkgxGEXAmdT4UYGZqCGWQ+IjKGGIUwPzGPhAc0NTewhDOdL7Ykji+dOLuOLhI2BbaFETICx4MlQitdqoUsCQ2vhKGjglNfU0SWmILaj43M5oEAOwAAAAAAAAAAAA==) no-repeat center left; }
+#full_list { padding: 0; list-style: none; margin-left: 0; }
+#full_list ul { padding: 0; }
+#full_list li { padding: 5px; padding-left: 12px; margin: 0; font-size: 1.1em; list-style: none; }
+#noresults { padding: 7px 12px; }
+#content.insearch #noresults { margin-left: 7px; }
+ul.collapsed ul, ul.collapsed li { display: none; }
+ul.collapsed.search_uncollapsed { display: block; }
+ul.collapsed.search_uncollapsed li { display: list-item; }
+li a.toggle { cursor: default; position: relative; left: -5px; top: 4px; text-indent: -999px; width: 10px; height: 9px; margin-left: -10px; display: block; float: left; background: url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABQAAAASCAYAAABb0P4QAAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAAK8AAACvABQqw0mAAAABx0RVh0U29mdHdhcmUAQWRvYmUgRmlyZXdvcmtzIENTM5jWRgMAAAAVdEVYdENyZWF0aW9uIFRpbWUAMy8xNC8wOeNZPpQAAAE2SURBVDiNrZTBccIwEEXfelIAHUA6CZ24BGaWO+FuzZAK4k6gg5QAdGAq+Bxs2Yqx7BzyL7Llp/VfzZeQhCTc/ezuGzKKnKSzpCxXJM8fwNXda3df5RZETlIt6YUzSQDs93sl8w3wBZxCCE10GM1OcWbWjB2mWgEH4Mfdyxm3PSepBHibgQE2wLe7r4HjEidpnXMYdQPKEMJcsZ4zs2POYQOcaPfwMVOo58zsAdMt18BuoVDPxUJRacELbXv3hUIX2vYmOUvi8C8ydz/ThjXrqKqqLbDIAdsCKBd+Wo7GWa7o9qzOQHVVVXeAbs+yHHCH4aTsaCOQqunmUy1yBUAXkdMIfMlgF5EXLo2OpV/c/Up7jG4hhHcYLgWzAZXUc2b2ixsfvc/RmNNfOXD3Q/oeL9axJE1yT9IOoUu6MGUkAAAAAElFTkSuQmCC) no-repeat bottom left; }
+li.collapsed a.toggle { opacity: 0.5; cursor: default; background-position: top left; }
+li { color: #888; cursor: pointer; }
+li.deprecated { text-decoration: line-through; font-style: italic; }
+li.r1 { background: #f0f0f0; }
+li.r2 { background: #fafafa; }
+li:hover { background: #ddd; }
+li small:before { content: "("; }
+li small:after { content: ")"; }
+li small.search_info { display: none; }
+a:link, a:visited { text-decoration: none; color: #05a; }
+li.clicked { background: #05a; color: #ccc; }
+li.clicked a:link, li.clicked a:visited { color: #eee; }
+li.clicked a.toggle { opacity: 0.5; background-position: bottom right; }
+li.collapsed.clicked a.toggle { background-position: top right; }
+#search input { border: 1px solid #bbb; -moz-border-radius: 3px; -webkit-border-radius: 3px; }
+#nav { margin-left: 10px; font-size: 0.9em; display: none; color: #aaa; }
+#nav a:link, #nav a:visited { color: #358; }
+#nav a:hover { background: transparent; color: #5af; }
+.frames #nav span:after { content: ' | '; }
+.frames #nav span:last-child:after { content: ''; }
+
+.frames #content h1 { margin-top: 0; }
+.frames li { white-space: nowrap; cursor: normal; }
+.frames li small { display: block; font-size: 0.8em; }
+.frames li small:before { content: ""; }
+.frames li small:after { content: ""; }
+.frames li small.search_info { display: none; }
+.frames #search { width: 170px; position: static; margin: 3px; margin-left: 10px; font-size: 0.9em; color: #888; padding-left: 0; padding-right: 24px; }
+.frames #content.insearch #search { background-position: center right; }
+.frames #search input { width: 110px; }
+.frames #nav { display: block; }
+
+#full_list.insearch li { display: none; }
+#full_list.insearch li.found { display: list-item; padding-left: 10px; }
+#full_list.insearch li a.toggle { display: none; }
+#full_list.insearch li small.search_info { display: block; }