ancestry 4.1.0 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 236bf763182abf156d175085f58ec757d196523e4b6f388cfbd4830768194adb
-  data.tar.gz: b69ba3c642ee2ea03f46c62c23e7f45207d366f57ccfce2e77d0040fe3286a00
+  metadata.gz: 82bcd1895093ab9b569806ef05fc307fc2ca9ab53ffeb09199bd66fe3672ecfb
+  data.tar.gz: fe7d0d356641658be2953309c27dd28a42e81ed569690cc5e26b2721b1aa6a37
 SHA512:
-  metadata.gz: 0a29628a71c79f4d2889620833f91c25266bf491e0925edf8cdf38a74f0ee813f186ffc9dd1beb4d134ea0bcdb091a619f00fafcd557305a797468f4601cd75c
-  data.tar.gz: 9cbe99bad12c8b2a6a8a6f09b003d5ce17530e668f2dcf17be9502053606d26bf4f9b7ee7493a13a7b4d9fc44df8cd5d450477604fdbfa1aafbd2877193dc894
+  metadata.gz: f33384a1114d865662be0133c532249be0e7ea438a66e469947b3aaba3172378ae50309e02c4f219c1f161281a9e060bff6087a496850c26351fd83348627e79
+  data.tar.gz: 2a6cb3fb28f6c9a8228b522c590c2125c4e31056a97ac6a6cda96ea4152725fe89e375b59c894091ebcd3d5be36ad18b348c6691211bc6bea2b0a49502c9f423

data/CHANGELOG.md

@@ -3,7 +3,14 @@
 Doing our best at supporting [SemVer](http://semver.org/) with
 a nice looking [Changelog](http://keepachangelog.com).
 
-## Version [HEAD] <sub><sup>now</sub></sup>
+## Version [4.2.0] <sub><sup>2022-06-09</sub></sup>
+
+* added strategy: materialized_path2 [#571](https://github.com/stefankroes/ancestry/pull/571)
+* Added tree_view method [#561](https://github.com/stefankroes/ancestry/pull/561) (thx @bizcho)
+* Fixed bug when errors would not undo callbacks [#566](https://github.com/stefankroes/ancestry/pull/566) (thx @daniloisr)
+* ruby 3.0 support
+* rails 7.0 support (thx @chenillen, @petergoldstein)
+* Documentation fixes (thx @benkoshy, @mijoharas)
 
 ## Version [4.1.0] <sub><sup>2021-06-25</sub></sup>
 
@@ -263,7 +270,8 @@ Missed 2 commits (which are feature adds)
 * Validations
 
 
-[HEAD]: https://github.com/stefankroes/ancestry/compare/v4.1.0...HEAD
+[HEAD]: https://github.com/stefankroes/ancestry/compare/v4.2.0...HEAD
+[4.2.0]: https://github.com/stefankroes/ancestry/compare/v4.1.0...v4.2.0
 [4.1.0]: https://github.com/stefankroes/ancestry/compare/v4.0.0...v4.1.0
 [4.0.0]: https://github.com/stefankroes/ancestry/compare/v3.2.1...v4.0.0
 [3.2.1]: https://github.com/stefankroes/ancestry/compare/v3.2.0...v3.2.1

data/README.md

@@ -1,4 +1,4 @@
-[![Gitter](https://badges.gitter.im/Join+Chat.svg)](https://gitter.im/stefankroes/ancestry?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![Security](https://hakiri.io/github/stefankroes/ancestry/master.svg)](https://hakiri.io/github/stefankroes/ancestry/master)
+[![Gitter](https://badges.gitter.im/Join+Chat.svg)](https://gitter.im/stefankroes/ancestry?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
 # Ancestry
 
@@ -44,6 +44,8 @@ $ bundle install
 
 ```bash
 $ rails g migration add_ancestry_to_[table] ancestry:string:index
+# or use different column name of your choosing. e.g. name:
+# rails g migration add_name_to_[people] name:string:index
 ```
 
 *   Migrate your database:
@@ -57,6 +59,7 @@ with `C` or `POSIX` encoding. This is a more primitive encoding and just compare
 bytes. Since this column will just contains numbers and slashes, it works much
 better. It also works better for the uuid case as well.
 
+Alternatively, if you create a [`text_pattern_ops`](https://www.postgresql.org/docs/current/indexes-opclass.html) index for your postgresql column, subtree selection will use an efficient index for you regardless of whether you created the column with `POSIX` encoding.
 
 If you opt out of this, and are trying to run tests on postgres, you may need to
 set the environment variable `COLLATE_SYMBOLS=false`. Sorry to say that a discussion
@@ -64,6 +67,8 @@ on this topic is out of scope. The important take away is postgres sort order is
 not consistent across operating systems but other databases do not have this same
 issue.
 
+NOTE: A Btree index (as is recommended) has a limitaton of 2704 characters for the ancestry column. This means you can't have an tree with a depth that is too great (~> 900 items at most).
+
 ## Add ancestry to your model
 * Add to app/models/[model.rb]:
 
@@ -71,7 +76,8 @@ issue.
 # app/models/[model.rb]
 
 class [Model] < ActiveRecord::Base
-   has_ancestry
+   has_ancestry # or alternatively as below:
+   # has_ancestry ancestry_column: :name ## if you've used a different column name
 end
 ```
 

data/lib/ancestry/class_methods.rb

@@ -74,6 +74,20 @@ module Ancestry
       end
     end
 
+    def tree_view(column, data = nil)
+      data = arrange unless data
+      data.each do |parent, children|
+        if parent.depth == 0
+          puts parent[column]
+        else
+          num = parent.depth - 1
+          indent = "   "*num
+          puts " #{"|" if parent.depth > 1}#{indent}|_ #{parent[column]}"
+        end
+        tree_view(column, children) if children
+      end
+    end
+
     # Pseudo-preordered array of nodes.  Children will always follow parents,
     def sort_by_ancestry(nodes, &block)
       arranged = nodes if nodes.is_a?(Hash)

data/lib/ancestry/has_ancestry.rb

@@ -4,7 +4,7 @@ module Ancestry
       # Check options
       raise Ancestry::AncestryException.new(I18n.t("ancestry.option_must_be_hash")) unless options.is_a? Hash
       options.each do |key, value|
-        unless [:ancestry_column, :orphan_strategy, :cache_depth, :depth_cache_column, :touch, :counter_cache, :primary_key_format, :update_strategy].include? key
+        unless [:ancestry_column, :orphan_strategy, :cache_depth, :depth_cache_column, :touch, :counter_cache, :primary_key_format, :update_strategy, :strategy].include? key
           raise Ancestry::AncestryException.new(I18n.t("ancestry.unknown_option", key: key.inspect, value: value.inspect))
         end
       end
@@ -27,8 +27,13 @@ module Ancestry
       # Include dynamic class methods
       extend Ancestry::ClassMethods
 
-      validates_format_of self.ancestry_column, :with => derive_ancestry_pattern(options[:primary_key_format]), :allow_nil => true
-      extend Ancestry::MaterializedPath
+      if options[:strategy] == :materialized_path2
+        validates_format_of self.ancestry_column, :with => derive_materialized2_pattern(options[:primary_key_format]), :allow_nil => false
+        extend Ancestry::MaterializedPath2
+      else
+        validates_format_of self.ancestry_column, :with => derive_materialized_pattern(options[:primary_key_format]), :allow_nil => true
+        extend Ancestry::MaterializedPath
+      end
 
       update_strategy = options[:update_strategy] || Ancestry.default_update_strategy
       include Ancestry::MaterializedPathPg if update_strategy == :sql
@@ -97,7 +102,7 @@ module Ancestry
 
     private
 
-    def derive_ancestry_pattern(primary_key_format, delimiter = '/')
+    def derive_materialized_pattern(primary_key_format, delimiter = '/')
       primary_key_format ||= '[0-9]+'
 
       if primary_key_format.to_s.include?('\A')
@@ -106,6 +111,16 @@ module Ancestry
         /\A#{primary_key_format}(#{delimiter}#{primary_key_format})*\Z/
       end
     end
+
+    def derive_materialized2_pattern(primary_key_format, delimiter = '/')
+      primary_key_format ||= '[0-9]+'
+
+      if primary_key_format.to_s.include?('\A')
+        primary_key_format
+      else
+        /\A#{delimiter}(#{primary_key_format}#{delimiter})*\Z/
+      end
+    end
   end
 end
 

data/lib/ancestry/instance_methods.rb

@@ -173,7 +173,7 @@ module Ancestry
     def parent
       if has_parent?
         unscoped_where do |scope|
-          scope.find_by id: parent_id
+          scope.find_by scope.primary_key => parent_id
         end
       end
     end
@@ -297,6 +297,7 @@ module Ancestry
     def without_ancestry_callbacks
       @disable_ancestry_callbacks = true
       yield
+    ensure
       @disable_ancestry_callbacks = false
     end
 

data/lib/ancestry/materialized_path.rb

@@ -1,8 +1,12 @@
 module Ancestry
+  # store ancestry as grandparent_id/parent_id
+  # root a=nil,id=1   children=id,id/%      == 1, 1/%
+  # 3: a=1/2,id=3     children=a/id,a/id/%  == 1/2/3, 1/2/3/%
   module MaterializedPath
     BEFORE_LAST_SAVE_SUFFIX = '_before_last_save'.freeze
     IN_DATABASE_SUFFIX = '_in_database'.freeze
     ANCESTRY_DELIMITER='/'.freeze
+    ROOT=nil
 
     def self.extended(base)
       base.send(:include, InstanceMethods)
@@ -13,7 +17,7 @@ module Ancestry
     end
 
     def roots
-      where(arel_table[ancestry_column].eq(nil))
+      where(arel_table[ancestry_column].eq(ROOT))
     end
 
     def ancestors_of(object)
@@ -38,11 +42,12 @@ module Ancestry
     def indirects_of(object)
       t = arel_table
       node = to_node(object)
-      where(t[ancestry_column].matches("#{node.child_ancestry}/%", nil, true))
+      where(t[ancestry_column].matches("#{node.child_ancestry}#{ANCESTRY_DELIMITER}%", nil, true))
     end
 
     def descendants_of(object)
-      where(descendant_conditions(object))
+      node = to_node(object)
+      indirects_of(node).or(children_of(node))
     end
 
     # deprecated
@@ -55,7 +60,7 @@ module Ancestry
     def subtree_of(object)
       t = arel_table
       node = to_node(object)
-      where(descendant_conditions(node).or(t[primary_key].eq(node.id)))
+      descendants_of(node).or(where(t[primary_key].eq(node.id)))
     end
 
     def siblings_of(object)
@@ -84,13 +89,13 @@ module Ancestry
     module InstanceMethods
       # optimization - better to go directly to column and avoid parsing
       def ancestors?
-        read_attribute(self.ancestry_base_class.ancestry_column).present?
+        read_attribute(self.ancestry_base_class.ancestry_column) != ROOT
       end
       alias :has_parent? :ancestors?
 
       def ancestor_ids=(value)
         col = self.ancestry_base_class.ancestry_column
-        value.present? ? write_attribute(col, value.join(ANCESTRY_DELIMITER)) : write_attribute(col, nil)
+        value.present? ? write_attribute(col, generate_ancestry(value)) : write_attribute(col, ROOT)
       end
 
       def ancestor_ids
@@ -107,7 +112,7 @@ module Ancestry
 
       def parent_id_before_last_save
         ancestry_was = send("#{self.ancestry_base_class.ancestry_column}#{BEFORE_LAST_SAVE_SUFFIX}")
-        return unless ancestry_was.present?
+        return if ancestry_was == ROOT
 
         parse_ancestry_column(ancestry_was).last
       end
@@ -124,16 +129,18 @@ module Ancestry
         # New records cannot have children
         raise Ancestry::AncestryException.new(I18n.t("ancestry.no_child_for_new_record")) if new_record?
         path_was = self.send("#{self.ancestry_base_class.ancestry_column}#{IN_DATABASE_SUFFIX}")
-        path_was.blank? ? id.to_s : "#{path_was}/#{id}"
+        path_was.blank? ? id.to_s : "#{path_was}#{ANCESTRY_DELIMITER}#{id}"
       end
 
-      private
-
-      def parse_ancestry_column obj
-        return [] unless obj
+      def parse_ancestry_column(obj)
+        return [] if obj == ROOT
         obj_ids = obj.split(ANCESTRY_DELIMITER)
         self.class.primary_key_is_an_integer? ? obj_ids.map!(&:to_i) : obj_ids
       end
+
+      def generate_ancestry(ancestor_ids)
+        ancestor_ids.join(ANCESTRY_DELIMITER)
+      end
     end
   end
 end

data/lib/ancestry/materialized_path2.rb

@@ -0,0 +1,54 @@
+module Ancestry
+  # store ancestry as /grandparent_id/parent_id/
+  # root: a=/,id=1    children=a.id/% == /1/%
+  # 3:    a=/1/2/,id=3 children=a.id/% == /1/2/3/%
+  module MaterializedPath2 < MaterializedPath
+    def indirects_of(object)
+      t = arel_table
+      node = to_node(object)
+      where(t[ancestry_column].matches("#{node.child_ancestry}%#{ANCESTRY_DELIMITER}%", nil, true))
+    end
+
+    def subtree_of(object)
+      t = arel_table
+      node = to_node(object)
+      where(descendant_conditions(node).or(t[primary_key].eq(node.id)))
+    end
+
+    def siblings_of(object)
+      t = arel_table
+      node = to_node(object)
+      where(t[ancestry_column].eq(node[ancestry_column]))
+    end
+
+    def ordered_by_ancestry(order = nil)
+      reorder(Arel::Nodes::Ascending.new(arel_table[ancestry_column]), order)
+    end
+
+    # deprecated
+    def descendant_conditions(object)
+      t = arel_table
+      node = to_node(object)
+      t[ancestry_column].matches("#{node.child_ancestry}%", nil, true)
+    end
+
+    module InstanceMethods
+      def child_ancestry
+        # New records cannot have children
+        raise Ancestry::AncestryException.new('No child ancestry for new record. Save record before performing tree operations.') if new_record?
+        path_was = self.send("#{self.ancestry_base_class.ancestry_column}#{IN_DATABASE_SUFFIX}")
+        "#{path_was}#{id}#{ANCESTRY_DELIMITER}"
+      end
+
+      def parse_ancestry_column(obj)
+        return [] if obj == ROOT
+        obj_ids = obj.split(ANCESTRY_DELIMITER).delete_if(&:blank?)
+        self.class.primary_key_is_an_integer? ? obj_ids.map!(&:to_i) : obj_ids
+      end
+
+      def generate_ancestry(ancestor_ids)
+        "#{ANCESTRY_DELIMITER}#{ancestor_ids.join(ANCESTRY_DELIMITER)}#{ANCESTRY_DELIMITER}"
+      end
+    end
+  end
+end

data/lib/ancestry/version.rb

@@ -1,3 +1,3 @@
 module Ancestry
-  VERSION = "4.1.0"
+  VERSION = '4.2.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ancestry
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 4.2.0
 platform: ruby
 authors:
 - Stefan Kroes
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-28 00:00:00.000000000 Z
+date: 2022-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -118,6 +118,7 @@ files:
 - lib/ancestry/instance_methods.rb
 - lib/ancestry/locales/en.yml
 - lib/ancestry/materialized_path.rb
+- lib/ancestry/materialized_path2.rb
 - lib/ancestry/materialized_path_pg.rb
 - lib/ancestry/version.rb
 homepage: https://github.com/stefankroes/ancestry
@@ -144,7 +145,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.16
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Organize ActiveRecord model into a tree structure