ancestry 4.3.0 → 4.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 19e9d786304fcb6d41f135572b0475167d378bafd24f1e084bab1aa87b759dc5
-  data.tar.gz: 34d82c19057c6036e0e05080fa84569cf4343b8a2ebb19f718ea5093e398e4bf
+  metadata.gz: c49a8b31bcfbc287a47c4b03ceed6902efc763ef2b120b89fbd18aa9ac93a30e
+  data.tar.gz: f1cf8e4f308fb7ec6b18526a4c86e715416e841fd91f010205b6bdfdd4e3accb
 SHA512:
-  metadata.gz: e954ca39aabe660070650e2917f5efdd115a10da25c8d7874b565278d2ba6b69b2c17b3bc6138452fec2823675f6ff7c767b10d33c999ac568133736c08fbccf
-  data.tar.gz: 4b3561088670192638cfd7016936d80cb547cf6b1f8f642af62800876fe49de22373ff6f2802442d5f5330668bca487b0b232491eb28d24090fcc6a531f6e45a
+  metadata.gz: 7d8d4702482f4d9a3183d991031b9fdb870ad2ff6de7eac8a8a3fac7dd8bb68d7b34bef6add6f22ec5ef51d430194082cce6d8a15d63b8f059feb2ecc7ef4875
+  data.tar.gz: '09e1135d7334ff5181df9574c4554ea0a28c4b350b50049d56e16cb0cec07a7b3e60a7ebc33d119dd6704211d152d293627a7c7372a604ce05167e877515164e'

data/CHANGELOG.md

@@ -3,6 +3,17 @@
 Doing our best at supporting [SemVer](http://semver.org/) with
 a nice looking [Changelog](http://keepachangelog.com).
 
+## Version [4.3.2] <sub><sup>2023-03-25</sub></sup>
+
+* Fix: added back fields that were removed in #589 [#647](https://github.com/stefankroes/ancestry/pull/647) (thx @rastamhadi)
+  - path_ids_in_database
+
+## Version [4.3.1] <sub><sup>2023-03-19</sub></sup>
+
+* Fix: added back fields that were removed in #589 [#637](https://github.com/stefankroes/ancestry/pull/637) (thx @znz)
+  - ancestor_ids_in_database
+  - parent_id_in_database
+
 ## Version [4.3.0] <sub><sup>2023-03-09</sub></sup>
 
 * Fix: materialized_path2 strategy [#597](https://github.com/stefankroes/ancestry/pull/597) (thx @kshnurov)
@@ -13,7 +24,22 @@ a nice looking [Changelog](http://keepachangelog.com).
 * Documented column collation and testing [#601](https://github.com/stefankroes/ancestry/pull/601) [#607](https://github.com/stefankroes/ancestry/pull/607) (thx @kshnurov)
 * Added initializer with default_ancestry_format [#612](https://github.com/stefankroes/ancestry/pull/612) [#613](https://github.com/stefankroes/ancestry/pull/613)
 * ruby 3.2 support [#596](https://github.com/stefankroes/ancestry/pull/596) (thx @petergoldstein)
-* arrange is 3x faster and uses 20-30x less memory [#415](https://github.com/stefankroes/ancestry/pull/415)
+* Reduce memory for sort_by_ancestry [#415](https://github.com/stefankroes/ancestry/pull/415)
+
+#### Notable features
+
+Default configuration values are provided for a few options: `update_strategy`, `ancestry_format`, and `primary_key_format`.
+These can be set in an initializer via `Ancestry.default_{ancestry_format} = value`
+
+A new `ancestry_format` of `:materialized_path2` formats the ancestry column with leading and trailing slashes.
+It shows promise to make the `ancestry` field more sql friendly.
+
+Both of these are better documented in [the readme](/README.md).
+
+#### Breaking changes
+
+- `ancestry_primary_key_format` is now specified or a single key not the whole regular expression.
+  We used to accept `/\A[0-9]+(/[0-9]+)*` or `'[0-9]'`, but now we only accept `'[0-9]'`.
 
 ## Version [4.2.0] <sub><sup>2022-06-09</sub></sup>
 

data/lib/ancestry/has_ancestry.rb

@@ -83,12 +83,7 @@ module Ancestry
       # Create counter cache column accessor and set to option or default
       if options[:counter_cache]
         cattr_accessor :counter_cache_column
-
-        if options[:counter_cache] == true
-          self.counter_cache_column = :children_count
-        else
-          self.counter_cache_column = options[:counter_cache]
-        end
+        self.counter_cache_column = options[:counter_cache] == true ? 'children_count' : options[:counter_cache].to_s
 
         after_create :increase_parent_counter_cache, if: :has_parent?
         after_destroy :decrease_parent_counter_cache, if: :has_parent?

data/lib/ancestry/instance_methods.rb

@@ -62,7 +62,7 @@ module Ancestry
 
     # Counter Cache
     def increase_parent_counter_cache
-      self.ancestry_base_class.increment_counter _counter_cache_column, parent_id
+      self.ancestry_base_class.increment_counter counter_cache_column, parent_id
     end
 
     def decrease_parent_counter_cache
@@ -74,7 +74,7 @@ module Ancestry
       return if defined?(@_trigger_destroy_callback) && !@_trigger_destroy_callback
       return if ancestry_callbacks_disabled?
 
-      self.ancestry_base_class.decrement_counter _counter_cache_column, parent_id
+      self.ancestry_base_class.decrement_counter counter_cache_column, parent_id
     end
 
     def update_parent_counter_cache
@@ -83,14 +83,10 @@ module Ancestry
       return unless changed
 
       if parent_id_was = parent_id_before_last_save
-        self.ancestry_base_class.decrement_counter _counter_cache_column, parent_id_was
+        self.ancestry_base_class.decrement_counter counter_cache_column, parent_id_was
       end
 
-      parent_id && self.ancestry_base_class.increment_counter(_counter_cache_column, parent_id)
-    end
-
-    def _counter_cache_column
-      self.ancestry_base_class.counter_cache_column.to_s
+      parent_id && increase_parent_counter_cache
     end
 
     # Ancestors
@@ -137,6 +133,10 @@ module Ancestry
       ancestor_ids_before_last_save + [id]
     end
 
+    def path_ids_in_database
+      ancestor_ids_in_database + [id]
+    end
+
     def path depth_options = {}
       self.ancestry_base_class.scope_depth(depth_options, depth).ordered_by_ancestry.inpath_of(self)
     end

data/lib/ancestry/materialized_path.rb

@@ -124,10 +124,18 @@ module Ancestry
         parse_ancestry_column(read_attribute(self.ancestry_base_class.ancestry_column))
       end
 
+      def ancestor_ids_in_database
+        parse_ancestry_column(attribute_in_database(self.class.ancestry_column))
+      end
+
       def ancestor_ids_before_last_save
         parse_ancestry_column(attribute_before_last_save(self.ancestry_base_class.ancestry_column))
       end
 
+      def parent_id_in_database
+        parse_ancestry_column(attribute_in_database(self.class.ancestry_column)).last
+      end
+
       def parent_id_before_last_save
         parse_ancestry_column(attribute_before_last_save(self.ancestry_base_class.ancestry_column)).last
       end

data/lib/ancestry/version.rb

@@ -1,3 +1,3 @@
 module Ancestry
-  VERSION = '4.3.0'
+  VERSION = '4.3.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ancestry
 version: !ruby/object:Gem::Version
-  version: 4.3.0
+  version: 4.3.2
 platform: ruby
 authors:
 - Stefan Kroes
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-09 00:00:00.000000000 Z
+date: 2023-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -112,7 +112,6 @@ files:
 - MIT-LICENSE
 - README.md
 - lib/ancestry.rb
-- lib/ancestry/array_pattern_validator.rb
 - lib/ancestry/class_methods.rb
 - lib/ancestry/exceptions.rb
 - lib/ancestry/has_ancestry.rb
@@ -121,8 +120,6 @@ files:
 - lib/ancestry/materialized_path.rb
 - lib/ancestry/materialized_path2.rb
 - lib/ancestry/materialized_path_pg.rb
-- lib/ancestry/materialized_path_string.rb
-- lib/ancestry/materialized_path_string2.rb
 - lib/ancestry/version.rb
 homepage: https://github.com/stefankroes/ancestry
 licenses:
@@ -148,7 +145,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.2.32
 signing_key:
 specification_version: 4
 summary: Organize ActiveRecord model into a tree structure

data/lib/ancestry/array_pattern_validator.rb

@@ -1,27 +0,0 @@
-module Ancestry
-  class ArrayPatternValidator < ActiveModel::EachValidator
-    def initialize(options)
-      raise ArgumentError, "Pattern unspecified, Specify using :pattern" unless options[:pattern]
-
-      options[:pattern] = /\A#{options[:pattern].to_s}\Z/ unless options[:pattern].to_s.include?('\A')
-      options[:id] = true unless options.key?(:id)
-      options[:integer] = true unless options.key?(:integer)
-
-      super
-    end
-
-    def validate_each(record, attribute, value)
-      if options[:id] && value.include?(record.id)
-        record.errors.add(attribute, I18n.t("ancestry.exclude_self", {:class_name => self.class.name.humanize}))
-      end
-
-      if value.any? { |v| v.to_s !~ options[:pattern] }
-        record.errors.add(attribute, "illegal characters")
-      end
-
-      if options[:integer] && value.any? { |v| v < 1 }
-        record.errors.add(attribute, "non positive ancestor id")
-      end
-    end
-  end
-end

data/lib/ancestry/materialized_path_string.rb

@@ -1,46 +0,0 @@
-module Ancestry
-  class MaterializedPathString < ActiveRecord::Type::Value
-    def initialize(casting: :to_i, delimiter: '/')
-      @casting = casting&.to_proc
-      @delimiter = delimiter
-    end
-
-    def type
-      :materialized_path_string
-    end
-
-    # convert to database type
-    def serialize(value)
-      if value.kind_of?(Array)
-        value.map(&:to_s).join(@delimiter).presence
-      elsif value.kind_of?(Integer)
-        value.to_s
-      elsif value.nil? || value.kind_of?(String)
-        value
-      else
-        byebug
-        puts "curious type: #{value.class}"
-      end
-    end
-
-    def cast(value)
-      cast_value(value) #unless value.nil? (want to get rid of this - fix default value)
-    end
-
-    # called by cast (form or setter) or deserialize (database)
-    def cast_value(value)
-      if value.kind_of?(Array)
-        super
-      elsif value.nil?
-        # would prefer to use default here
-        # but with default, it kept thinking the field had changed when it hadn't
-        # (that may be a rails bug though)
-        super([])
-      else
-        #TODO: test ancestry=1
-        super(value.to_s.split(@delimiter).map(&@casting))
-      end
-    end
-  end
-end
-ActiveRecord::Type.register(:materialized_path_string, Ancestry::MaterializedPathString)

data/lib/ancestry/materialized_path_string2.rb

@@ -1,46 +0,0 @@
-  # used for materialized path
-  class MaterializedPathString2 < ActiveRecord::Type::Value
-    def initialize(casting: :to_i, delimiter: '/')
-      @casting = casting&.to_proc
-      @delimiter = delimiter
-    end
-
-    def type
-      :materialized_path_string2
-    end
-
-    # convert to database type
-    def serialize(value)
-      if value.kind_of?(Array)
-        # TODO: check all values to ensure no extra slashes
-        value.empty? ? @delimiter : "#{@delimiter}#{value.map(&:to_s).join(@delimiter)}#{@delimiter}"
-      elsif value.kind_of?(Integer)
-        value.to_s
-      elsif value.nil? || value.kind_of?(String)
-        value
-      else
-        byebug
-        puts "curious type: #{value.class}"
-      end
-    end
-
-    def cast(value)
-      cast_value(value) #unless value.nil? (want to get rid of this - fix default value)
-    end
-
-    # called by cast (form or setter) or deserialize (database)
-    def cast_value(value)
-      if value.kind_of?(Array)
-        super
-      elsif value.nil?
-        # would prefer to use default here
-        # but with default, it kept thinking the field had changed when it hadn't
-        super([])
-      else
-        #TODO: test ancestry=1
-        super(value.to_s.split(@delimiter).map(&@casting))
-      end
-    end
-  end
-end
-ActiveRecord::Type.register(:materialized_path_string2, Ancestry::MaterializedPathString)