pg_ltree 1.1.6 → 1.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f2b26d6c59f672404d75047f8111c4279ba48997
-  data.tar.gz: 01e1adf826c8d150d244102a3db4c374b18cefb4
+SHA256:
+  metadata.gz: ba0cf379067eb0d7c24ff36828795d78b6cbbdc5b6738c45427868164940516d
+  data.tar.gz: c63501e14473075c2916567fdee20d974c09fe77d93c0553b9d16c185af436a1
 SHA512:
-  metadata.gz: 2594e997cde3d85f712b3a635c55a00384e3191e34b86c0463677a1df7e57523fab057d24f6d5f4009bcc9ef5f9b999f462bc57bf6501ec30c6ffb0a7ff4cbe3
-  data.tar.gz: 2304afa590efe9ba7ae065f37b74479ddfe331661d95291361c773bce97c1d06b7023455d488b196a9cc4b1b276700067cc2882db0604423ff080b4af3129895
+  metadata.gz: 8c8545986852ec4d61a2b9623a2142d4f79e2a3613d75fb7efff6511e70699531831527a625b89693b4b9d21c8bc7e4937f432bb14315ea82c01cc4a6eb34079
+  data.tar.gz: 1be5c7b2a06dc1228ba07ab50284f5d6af6147a27bbec92fb6768b92d7f718399dacf6150532ea2c1939a5660cd62e7f650463d7f534301df5cde8b29d7e9fb6

data/Rakefile

@@ -20,30 +20,3 @@ Rake::TestTask.new(:test) do |t|
   t.verbose = false
 end
 
-desc 'Default: run unit tests.'
-task default: 'test:all'
-
-namespace :test do
-  AVAILABLE_CASES = %w(
-    activerecord_40_pg_017 activerecord_40_pg_018
-    activerecord_41_pg_017 activerecord_41_pg_018
-    activerecord_42_pg_017 activerecord_42_pg_018
-    activerecord_50_pg_018 activerecord_51_pg_020
-    activerecord_51_pg_021
-  ).freeze
-
-  AVAILABLE_CASES.each do |version|
-    desc "Test pg_ltree against #{version}"
-    task version do
-      sh "bundle install --gemfile=gemfiles/#{version}.gemfile --quiet"
-      sh "BUNDLE_GEMFILE='gemfiles/#{version}.gemfile' bundle exec rake -t test"
-    end
-  end
-
-  desc 'Run all tests for pg_ltree'
-  task :all do
-    AVAILABLE_CASES.each do |version|
-      sh "rake test:#{version}"
-    end
-  end
-end

data/lib/pg_ltree/ltree.rb

@@ -3,18 +3,16 @@ module PgLtree
   #
   # @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, options: { cascade: true })
+    def ltree(column = :path, cascade: true)
       cattr_accessor :ltree_path_column
 
       self.ltree_path_column = column
 
-      if options[:cascade]
+      if cascade
         after_update :cascade_update
         after_destroy :cascade_destroy
       end
@@ -44,12 +42,12 @@ module PgLtree
       #
       # @return [ActiveRecord::Relation] relations of node's leaves
       def leaves
-        subquery =
-          unscoped.select("COUNT(subquery.#{ltree_path_column}) = 1")
-                  .from("#{table_name} AS subquery")
-                  .where("subquery.#{ltree_path_column} <@ #{table_name}.#{ltree_path_column}")
-        subquery = subquery.where(subquery: current_scope.where_values_hash) if current_scope
-        where subquery.to_sql
+        subquery = unscoped.select("#{table_name}.#{ltree_path_column}")
+                           .from("#{table_name} AS subquery")
+                           .where("#{table_name}.#{ltree_path_column} <> subquery.#{ltree_path_column}")
+                           .where("#{table_name}.#{ltree_path_column} @> subquery.#{ltree_path_column}")
+
+        where.not ltree_path_column => subquery
       end
 
       # Get all with nodes when path liked the lquery
@@ -92,11 +90,22 @@ module PgLtree
         public_send ltree_path_column
       end
 
-      # Get lTree previous value
+      # Get ltree original value before the save just occurred
+      # https://api.rubyonrails.org/classes/ActiveRecord/AttributeMethods/Dirty.html#method-i-attribute_before_last_save
       #
       # @return [String] ltree previous value
-      def ltree_path_was
-        public_send :"#{ltree_path_column}_was"
+      def ltree_path_before_last_save
+        public_send :attribute_before_last_save, ltree_path_column
+      end
+
+      # Get lTree previous value
+      # originally +attribute_was+ used in before create/update, destroy won't call +save+ so this work
+      # https://api.rubyonrails.org/classes/ActiveRecord/AttributeMethods/Dirty.html#method-i-attribute_in_database
+      #
+      # @return [String] ltree value in database
+
+      def ltree_path_in_database
+        public_send :attribute_in_database, ltree_path_column
       end
 
       # Check what current node is root
@@ -226,15 +235,15 @@ module PgLtree
       #
       # @return [ActiveRecord::Relation]
       def cascade_update
-        ltree_scope.where(["#{ltree_scope.table_name}.#{ltree_path_column} <@ ?", ltree_path_was]).where(["#{ltree_scope.table_name}.#{ltree_path_column} != ?", ltree_path])
-                   .update_all ["#{ltree_path_column} = ? || subpath(#{ltree_path_column}, nlevel(?))", ltree_path, ltree_path_was]
+        ltree_scope.where(["#{ltree_scope.table_name}.#{ltree_path_column} <@ ?", ltree_path_before_last_save]).where(["#{ltree_scope.table_name}.#{ltree_path_column} != ?", ltree_path])
+                   .update_all ["#{ltree_path_column} = ? || subpath(#{ltree_path_column}, nlevel(?))", ltree_path, ltree_path_before_last_save]
       end
 
       # Delete all children for current path
       #
       # @return [ActiveRecord::Relation]
       def cascade_destroy
-        ltree_scope.where("#{ltree_scope.table_name}.#{ltree_path_column} <@ ?", ltree_path_was).delete_all
+        ltree_scope.where("#{ltree_scope.table_name}.#{ltree_path_column} <@ ?", ltree_path_in_database).destroy_all
       end
     end
   end

data/lib/pg_ltree/scoped_for.rb

@@ -1,8 +1,6 @@
 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
     #
@@ -21,7 +19,7 @@ module PgLtree
       #
       # @return current class
       def ltree_scope
-        self.class.where *(ltree_scoped_for.map { |column| { column => public_send(column) } })
+        self.class.where(*(ltree_scoped_for.map { |column| { column => public_send(column) } }))
       end
     end
   end

data/lib/pg_ltree/version.rb

@@ -1,7 +1,4 @@
 # Organize ActiveRecord model into a tree structure with PostgreSQL LTree
-#
-# @author a.ponomarenko
 module PgLtree
-  # Gem Version
-  VERSION = '1.1.6'.freeze
+  VERSION = '1.1.9'.freeze
 end

data/lib/pg_ltree/versions/rails_older_than_51.rb

@@ -0,0 +1,28 @@
+module PgLtree
+  module Versions
+    module RailsOlderThan51
+      def ltree(column = :path, options: { cascade: true })
+        super
+        include InstanceMethods
+      end
+
+      module InstanceMethods
+        # Get lTree previous value
+        #
+        # Related changes in > Rails 5.1.0
+        # https://github.com/rails/rails/pull/25337
+        #
+        # @return [String] Rails 5.1 replace attribute_was method with two methods, this is a wrapper for older rails
+        def ltree_path_before_last_save
+          public_send :attribute_was, ltree_path_column
+        end
+
+        #
+        # @return [String] Rails 5.1 replace attribute_was method with two methods, this is a wrapper for older rails
+        def ltree_path_in_database
+          public_send :attribute_was, ltree_path_column
+        end
+      end
+    end
+  end
+end

data/lib/pg_ltree.rb

@@ -1,3 +1,4 @@
+require 'active_record'
 require 'pg_ltree/ltree'
 require 'pg_ltree/scoped_for'
 require 'pg_ltree/version'
@@ -9,7 +10,8 @@ if defined?(ActiveRecord)
 
   # The behavior of _was changes in Rails 5.1
   # http://blog.toshima.ru/2017/04/06/saved-change-to-attribute.html
-  if ActiveRecord::VERSION::MAJOR > 5 || (ActiveRecord::VERSION::MAJOR == 5 && ActiveRecord::VERSION::MINOR >= 1)
-    ActiveRecord::Base.extend(PgLtree::Versions::Rails51)
+  # This is for backward compability
+  if ActiveRecord::VERSION::MAJOR < 5 || (ActiveRecord::VERSION::MAJOR == 5 && ActiveRecord::VERSION::MINOR < 1)
+    ActiveRecord::Base.extend(PgLtree::Versions::RailsOlderThan51)
   end
 end

data/test/database.yml

@@ -1,5 +1,5 @@
 adapter:  postgresql
 host:     localhost
 username: postgres
-password: postgres
+password:
 database: pg_ltree_test

data/test/database.yml.sample

@@ -1,5 +1,5 @@
 adapter:  postgresql
 host:     localhost
 username: postgres
-password:
+password: postgres
 database: pg_ltree_test

data/test/pg_ltree/ltree_test.rb

@@ -17,6 +17,9 @@ class PgLtree::LtreeTest < BaseTest
       Top.Collections.Pictures.Astronomy.Stars
       Top.Collections.Pictures.Astronomy.Galaxies
       Top.Collections.Pictures.Astronomy.Astronauts
+      Top.Collections.Videos
+      Top.Collections.Videos.Vacation
+      Top.Collections.Videos.NewYear
     ).each do |path|
       TreeNode.create! path: path
     end
@@ -50,6 +53,20 @@ class PgLtree::LtreeTest < BaseTest
       Top.Collections.Pictures.Astronomy.Stars
       Top.Collections.Pictures.Astronomy.Galaxies
       Top.Collections.Pictures.Astronomy.Astronauts
+      Top.Collections.Videos.Vacation
+      Top.Collections.Videos.NewYear
+    )
+  end
+
+  test '#leaves with a relation' do
+    assert_equal TreeNode.where("path <> 'Top.Collections.Pictures.Astronomy.Stars'").leaves.pluck(:path), %w(
+      Top.Science.Astronomy.Astrophysics
+      Top.Science.Astronomy.Cosmology
+      Top.Hobbies.Amateurs_Astronomy
+      Top.Collections.Pictures.Astronomy.Galaxies
+      Top.Collections.Pictures.Astronomy.Astronauts
+      Top.Collections.Videos.Vacation
+      Top.Collections.Videos.NewYear
     )
   end
 
@@ -181,8 +198,52 @@ class PgLtree::LtreeTest < BaseTest
   end
 
   test '.cascade_destroy' do
-    TreeNode.find_by(path: 'Top.Collections').destroy
+    assert_equal TreeNode.where("path <@ 'Top.Collections'").pluck(:path), %w(
+      Top.Collections
+      Top.Collections.Pictures
+      Top.Collections.Pictures.Astronomy
+      Top.Collections.Pictures.Astronomy.Stars
+      Top.Collections.Pictures.Astronomy.Galaxies
+      Top.Collections.Pictures.Astronomy.Astronauts
+      Top.Collections.Videos
+      Top.Collections.Videos.Vacation
+      Top.Collections.Videos.NewYear
+    )
+
+    TreeNode.find_by(path: 'Top.Collections.Pictures').destroy
 
-    assert_equal TreeNode.where("path ~ 'Top.Collections'").pluck(:path), %w()
+    assert_equal TreeNode.where("path <@ 'Top.Collections'").pluck(:path), %w(
+      Top.Collections
+      Top.Collections.Videos
+      Top.Collections.Videos.Vacation
+      Top.Collections.Videos.NewYear
+    )
+  end
+
+  test '.destroy' do
+    assert_equal TreeWithoutCascadeNode.where("path <@ 'Top.Collections'").pluck(:path), %w(
+      Top.Collections
+      Top.Collections.Pictures
+      Top.Collections.Pictures.Astronomy
+      Top.Collections.Pictures.Astronomy.Stars
+      Top.Collections.Pictures.Astronomy.Galaxies
+      Top.Collections.Pictures.Astronomy.Astronauts
+      Top.Collections.Videos
+      Top.Collections.Videos.Vacation
+      Top.Collections.Videos.NewYear
+    )
+
+    TreeWithoutCascadeNode.find_by(path: 'Top.Collections.Pictures').destroy
+
+    assert_equal TreeWithoutCascadeNode.where("path <@ 'Top.Collections'").pluck(:path), %w(
+      Top.Collections
+      Top.Collections.Pictures.Astronomy
+      Top.Collections.Pictures.Astronomy.Stars
+      Top.Collections.Pictures.Astronomy.Galaxies
+      Top.Collections.Pictures.Astronomy.Astronauts
+      Top.Collections.Videos
+      Top.Collections.Videos.Vacation
+      Top.Collections.Videos.NewYear
+    )
   end
 end

data/test/pg_ltree/scoped_for_test.rb

@@ -17,6 +17,9 @@ class PgLtree::ScopedForTest < BaseTest
       Top.Collections.Pictures.Astronomy.Stars
       Top.Collections.Pictures.Astronomy.Galaxies
       Top.Collections.Pictures.Astronomy.Astronauts
+      Top.Collections.Videos
+      Top.Collections.Videos.Vacation
+      Top.Collections.Videos.NewYear
     ).each do |path|
       %i( active deactive ).each do |status|
         NotUniqTreeNode.create! new_path: path, status: status
@@ -47,6 +50,8 @@ class PgLtree::ScopedForTest < BaseTest
       Top.Collections.Pictures.Astronomy.Stars
       Top.Collections.Pictures.Astronomy.Galaxies
       Top.Collections.Pictures.Astronomy.Astronauts
+      Top.Collections.Videos.Vacation
+      Top.Collections.Videos.NewYear
     )
   end
 
@@ -161,32 +166,25 @@ class PgLtree::ScopedForTest < BaseTest
   end
 
   test '.cascade_destroy' do
-    assert_equal NotUniqTreeNode.where("new_path <@ 'Top.Collections'").pluck(:new_path), %w(
+    assert_equal NotUniqTreeNode.where("new_path <@ 'Top.Collections'").where(status: :active).pluck(:new_path), %w(
       Top.Collections
-      Top.Collections
-      Top.Collections.Pictures
       Top.Collections.Pictures
       Top.Collections.Pictures.Astronomy
-      Top.Collections.Pictures.Astronomy
       Top.Collections.Pictures.Astronomy.Stars
-      Top.Collections.Pictures.Astronomy.Stars
-      Top.Collections.Pictures.Astronomy.Galaxies
       Top.Collections.Pictures.Astronomy.Galaxies
       Top.Collections.Pictures.Astronomy.Astronauts
-      Top.Collections.Pictures.Astronomy.Astronauts
+      Top.Collections.Videos
+      Top.Collections.Videos.Vacation
+      Top.Collections.Videos.NewYear
     )
 
-    NotUniqTreeNode.find_by(new_path: 'Top.Collections', status: :active).destroy
+    NotUniqTreeNode.find_by(new_path: 'Top.Collections.Pictures', status: :active).destroy
 
-    assert_equal NotUniqTreeNode.where("new_path <@ 'Top.Collections'").where(status: :active).pluck(:new_path), %w()
-
-    assert_equal NotUniqTreeNode.where("new_path <@ 'Top.Collections'").where(status: :deactive).pluck(:new_path), %w(
+    assert_equal NotUniqTreeNode.where("new_path <@ 'Top.Collections'").where(status: :active).pluck(:new_path), %w(
       Top.Collections
-      Top.Collections.Pictures
-      Top.Collections.Pictures.Astronomy
-      Top.Collections.Pictures.Astronomy.Stars
-      Top.Collections.Pictures.Astronomy.Galaxies
-      Top.Collections.Pictures.Astronomy.Astronauts
+      Top.Collections.Videos
+      Top.Collections.Videos.Vacation
+      Top.Collections.Videos.NewYear
     )
   end
 end

data/test/test_helper.rb

@@ -7,6 +7,8 @@ rescue Bundler::BundlerError => e
   exit e.status_code
 end
 
+$VERBOSE=nil
+
 require 'pg'
 require 'pg_ltree'
 require 'minitest/autorun'
@@ -31,6 +33,13 @@ class BaseTest < ActiveSupport::TestCase
       exit 0
     end
 
+    begin
+      PG.connect(host: db_connection["host"], user: db_connection["username"], password: db_connection["password"])
+        .exec("CREATE DATABASE #{db_connection['database']}")
+    rescue
+      # Ignore errors on DB:CEATE
+    end
+
     ActiveRecord::Base.establish_connection db_connection
     ActiveRecord::Schema.verbose = false
 
@@ -69,3 +78,8 @@ end
 class TreeNode < ActiveRecord::Base
   ltree
 end
+
+class TreeWithoutCascadeNode < ActiveRecord::Base
+  self.table_name = 'tree_nodes'
+  ltree :path, cascade: false
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pg_ltree
 version: !ruby/object:Gem::Version
-  version: 1.1.6
+  version: 1.1.9
 platform: ruby
 authors:
 - Andrei Panamarenka
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-09-19 00:00:00.000000000 Z
+date: 2022-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,20 +16,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: '5.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '8.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: '5.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '8.0'
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
@@ -39,7 +39,7 @@ dependencies:
         version: 0.17.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '0.22'
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -49,7 +49,7 @@ dependencies:
         version: 0.17.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '0.22'
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -120,6 +120,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  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: Organise ActiveRecord model into a tree structure with PostgreSQL LTree
 email:
 - andrei.panamarenka@gmail.com
@@ -133,7 +147,7 @@ files:
 - lib/pg_ltree/ltree.rb
 - lib/pg_ltree/scoped_for.rb
 - lib/pg_ltree/version.rb
-- lib/pg_ltree/versions/rails_5_1.rb
+- lib/pg_ltree/versions/rails_older_than_51.rb
 - test/database.yml
 - test/database.yml.sample
 - test/pg_ltree/ltree_test.rb
@@ -144,7 +158,7 @@ homepage: https://github.com/sjke/pg_ltree
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -159,9 +173,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.12
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: Organise ActiveRecord model into a tree structure with PostgreSQL LTree
 test_files:

data/lib/pg_ltree/versions/rails_5_1.rb

@@ -1,32 +0,0 @@
-module PgLtree
-  module Versions
-    module Rails51
-      def ltree(column = :path, options: { cascade: true })
-        super
-
-        before_destroy :delete_ltree_column_value if options[:cascade]
-        include InstanceMethods
-      end
-
-      module InstanceMethods
-        # Get lTree previous value
-        #
-        # Related changes in > Rails 5.1.0
-        # https://github.com/rails/rails/pull/25337
-        #
-        # @return [String] ltree previous value
-        def ltree_path_was
-          public_send :"#{ltree_path_column}_before_last_save"
-        end
-
-        #
-        # In order for for cascade_destroy to work with the current callbacks, let's first delete the column :/.
-        # @author HoyaBoya [https://github.com/HoyaBoya]
-        #
-        def delete_ltree_column_value
-          update!(ltree_path_column => nil)
-        end
-      end
-    end
-  end
-end