ancestry 3.0.2 → 3.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8088b41fa07084ef6a761d52c2d33b051c24eae3
-  data.tar.gz: ed5f0c0678e1d238adb4b68ed6d6239204c397a1
+  metadata.gz: c1c70fafe20e537ed6cb98a60e671dc01fd540ac
+  data.tar.gz: 583d3382374a761c553d99329f71be36ac423222
 SHA512:
-  metadata.gz: c97d7541dbba13b6a768edab18a21c2916fbb9ea0f61674f4831a0e56f0eed83bf3b1a18bd743b1f2e0eb26b6b78ca21c69271052e3fb1042d8cf194c74802ca
-  data.tar.gz: 7274762db4aee75b633c14fb158b68da2e4e525c4c5e5557c9c164aa6a2dc8d68c7cdc96f443112a327b0a21b76a3acc57cb09c7653ec5b24a4a839266b7313b
+  metadata.gz: 55df9269223d805cd09f8fb87b5e0a25cad36aaad892e3527217cd086e15c6105e5552c0d7cd108645fe9a947712986a0885252f4b71a861eec1525be374f0b7
+  data.tar.gz: 3f8ea178c2f3cc918ddd1fb79f8af4e3b8ed63704cd764bed42d8fb79da3b5316ab7160871eade25f8af9aac3bb004a298abc59f17e5b9759085c1ef8eb3c41d

data/README.md

@@ -12,13 +12,20 @@ gems, integrity checking, integrity restoration, arrangement of
 (sub)tree into hashes and different strategies for dealing with orphaned
 records.
 
+NOTE:
+
+- Ancestry 3.x supports Rails 5.0 and earlier.
+- Ancestry 4.0 only supports rails 5.0 and higher
+
 # Installation
 
 To apply Ancestry to any `ActiveRecord` model, follow these simple steps:
 
+
 ## Install
 
 * Add to Gemfile:
+
 ```ruby
 # Gemfile
 
@@ -26,6 +33,7 @@ gem 'ancestry'
 ```
 
 * Install required gems:
+
 ```bash
 $ bundle install
 ```
@@ -33,11 +41,13 @@ $ bundle install
 
 ## Add ancestry column to your table
 * Create migration:
+
 ```bash
 $ rails g migration add_ancestry_to_[table] ancestry:string:index
 ```
 
 *   Migrate your database:
+
 ```bash
 $ rake db:migrate
 ```

data/ancestry.gemspec

@@ -24,7 +24,7 @@ EOF
 
   s.authors  = ['Stefan Kroes', 'Keenan Brock']
   s.email    = 'keenan@thebrocks.net'
-  s.homepage = 'http://github.com/stefankroes/ancestry'
+  s.homepage = 'https://github.com/stefankroes/ancestry'
   s.license  = 'MIT'
 
   s.files = [

data/lib/ancestry/class_methods.rb

@@ -2,7 +2,7 @@ module Ancestry
   module ClassMethods
     # Fetch tree node if necessary
     def to_node object
-      if object.is_a?(self.ancestry_base_class) then object else find(object) end
+      if object.is_a?(self.ancestry_base_class) then object else unscoped_where{|scope| scope.find object} end
     end
 
     # Scope on relative depth options
@@ -206,5 +206,24 @@ module Ancestry
         yield self.ancestry_base_class.unscope(:where)
       end
     end
+
+    ANCESTRY_UNCAST_TYPES = [:string, :uuid, :text].freeze
+    if ActiveSupport::VERSION::STRING < "4.0"
+      def primary_key_is_an_integer?
+        if defined?(@primary_key_is_an_integer)
+          @primary_key_is_an_integer
+        else
+          @primary_key_is_an_integer = !ANCESTRY_UNCAST_TYPES.include?(columns_hash[primary_key.to_s].type)
+        end
+      end
+    else
+      def primary_key_is_an_integer?
+        if defined?(@primary_key_is_an_integer)
+          @primary_key_is_an_integer
+        else
+          @primary_key_is_an_integer = !ANCESTRY_UNCAST_TYPES.include?(type_for_attribute(primary_key))
+        end
+      end
+    end
   end
 end

data/lib/ancestry/has_ancestry.rb

@@ -46,7 +46,10 @@ module Ancestry
       scope :siblings_of, lambda { |object| where(sibling_conditions(object)) }
       scope :ordered_by_ancestry, Proc.new { |order|
         if %w(mysql mysql2 sqlite sqlite3 postgresql).include?(connection.adapter_name.downcase) && ActiveRecord::VERSION::MAJOR >= 5
-          reorder(Arel.sql("coalesce(#{connection.quote_table_name(table_name)}.#{connection.quote_column_name(ancestry_column)}, '')"), order)
+          reorder(
+            Arel::Nodes::Ascending.new(Arel::Nodes::NamedFunction.new('COALESCE', [arel_table[ancestry_column], Arel.sql("''")])),
+            order
+          )
         else
           reorder(Arel.sql("(CASE WHEN #{connection.quote_table_name(table_name)}.#{connection.quote_column_name(ancestry_column)} IS NULL THEN 0 ELSE 1 END), #{connection.quote_table_name(table_name)}.#{connection.quote_column_name(ancestry_column)}"), order)
         end

data/lib/ancestry/instance_methods.rb

@@ -1,11 +1,14 @@
 module Ancestry
   module InstanceMethods
+    BEFORE_LAST_SAVE_SUFFIX = ActiveRecord::VERSION::STRING >= '5.1.0' ? '_before_last_save' : '_was'
+    IN_DATABASE_SUFFIX = ActiveRecord::VERSION::STRING >= '5.1.0' ? '_in_database' : '_was'
+
     # Validate that the ancestors don't include itself
     def ancestry_exclude_self
       errors.add(:base, "#{self.class.name.humanize} cannot be a descendant of itself.") if ancestor_ids.include? self.id
     end
 
-    # Update descendants with new ancestry
+    # Update descendants with new ancestry (before save)
     def update_descendants_with_new_ancestry
       # If enabled and node is existing and ancestry was updated and the new ancestry is sane ...
       if !ancestry_callbacks_disabled? && !new_record? && ancestry_changed? && sane_ancestry?
@@ -16,7 +19,9 @@ module Ancestry
             descendant.update_attribute(
               self.ancestry_base_class.ancestry_column,
               descendant.read_attribute(descendant.class.ancestry_column).gsub(
+                # child_ancestry_was
                 /^#{self.child_ancestry}/,
+                # future child_ancestry
                 if ancestors? then "#{read_attribute self.class.ancestry_column }/#{id}" else id.to_s end
               )
             )
@@ -25,7 +30,7 @@ module Ancestry
       end
     end
 
-    # Apply orphan strategy
+    # Apply orphan strategy (before destroy - no changes)
     def apply_orphan_strategy
       if !ancestry_callbacks_disabled? && !new_record?
         case self.ancestry_base_class.orphan_strategy
@@ -35,6 +40,7 @@ module Ancestry
               new_ancestry = if descendant.ancestry == child_ancestry
                 nil
               else
+                # child_ancestry did not change so child_ancestry_was will work here
                 descendant.ancestry.gsub(/^#{child_ancestry}\//, '')
               end
               descendant.update_attribute descendant.class.ancestry_column, new_ancestry
@@ -61,7 +67,7 @@ module Ancestry
       end
     end
 
-    # Touch each of this record's ancestors
+    # Touch each of this record's ancestors (after save)
     def touch_ancestors_callback
       if !ancestry_callbacks_disabled? && self.ancestry_base_class.touch_ancestors
         # Touch each of the old *and* new ancestors
@@ -73,12 +79,17 @@ module Ancestry
       end
     end
 
-    # The ancestry value for this record's children
+    # The ancestry value for this record's children (before save)
+    # This is technically child_ancestry_was
     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?
 
-      if self.send("#{self.ancestry_base_class.ancestry_column}_was").blank? then id.to_s else "#{self.send "#{self.ancestry_base_class.ancestry_column}_was"}/#{id}" end
+      if self.send("#{self.ancestry_base_class.ancestry_column}#{IN_DATABASE_SUFFIX}").blank?
+        id.to_s
+      else
+        "#{self.send "#{self.ancestry_base_class.ancestry_column}#{IN_DATABASE_SUFFIX}"}/#{id}"
+      end
     end
 
     # Ancestors
@@ -93,10 +104,6 @@ module Ancestry
       changed.include?(self.ancestry_base_class.ancestry_column.to_s)
     end
 
-    def parse_ancestry_column obj
-      obj.to_s.split('/').map { |id| cast_primary_key(id) }
-    end
-
     def ancestor_ids
       parse_ancestry_column(read_attribute(self.ancestry_base_class.ancestry_column))
     end
@@ -109,14 +116,20 @@ module Ancestry
       self.ancestry_base_class.scope_depth(depth_options, depth).ordered_by_ancestry.where ancestor_conditions
     end
 
+    # deprecate
     def ancestor_was_conditions
-      {primary_key_with_table => ancestor_ids_was}
+      {primary_key_with_table => ancestor_ids_before_last_save}
     end
 
+    # deprecated - probably don't want to use anymore
     def ancestor_ids_was
       parse_ancestry_column(send("#{self.ancestry_base_class.ancestry_column}_was"))
     end
 
+    def ancestor_ids_before_last_save
+      parse_ancestry_column(send("#{self.ancestry_base_class.ancestry_column}#{BEFORE_LAST_SAVE_SUFFIX}"))
+    end
+
     def path_ids
       ancestor_ids + [id]
     end
@@ -143,6 +156,8 @@ module Ancestry
 
     # Parent
 
+    # currently parent= does not work in after save callbacks
+    # assuming that parent hasn't changed
     def parent= parent
       write_attribute(self.ancestry_base_class.ancestry_column, if parent.nil? then nil else parent.child_ancestry end)
     end
@@ -288,16 +303,10 @@ module Ancestry
 
   private
 
-    def cast_primary_key(key)
-      if [:string, :uuid, :text].include? primary_key_type
-        key
-      else
-        key.to_i
-      end
-    end
-
-    def primary_key_type
-      @primary_key_type ||= column_for_attribute(self.class.primary_key).type
+    def parse_ancestry_column obj
+      obj_ids = obj.to_s.split('/')
+      obj_ids.map!(&:to_i) if self.class.primary_key_is_an_integer?
+      obj_ids
     end
 
     def unscoped_descendants
@@ -306,9 +315,10 @@ module Ancestry
       end
     end
 
+    # works with after save context (hence before_last_save)
     def unscoped_current_and_previous_ancestors
       unscoped_where do |scope|
-        scope.where id: (ancestor_ids + ancestor_ids_was).uniq
+        scope.where id: (ancestor_ids + ancestor_ids_before_last_save).uniq
       end
     end
 

data/lib/ancestry/materialized_path.rb

@@ -41,7 +41,7 @@ module Ancestry
     def subtree_conditions(object)
       t = arel_table
       node = to_node(object)
-      descendant_conditions(object).or(t[primary_key].eq(node.id))
+      descendant_conditions(node).or(t[primary_key].eq(node.id))
     end
 
     def sibling_conditions(object)

data/lib/ancestry/version.rb

@@ -1,3 +1,3 @@
 module Ancestry
-  VERSION = "3.0.2"
+  VERSION = "3.0.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ancestry
 version: !ruby/object:Gem::Version
-  version: 3.0.2
+  version: 3.0.3
 platform: ruby
 authors:
 - Stefan Kroes
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-23 00:00:00.000000000 Z
+date: 2018-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -134,7 +134,7 @@ files:
 - lib/ancestry/instance_methods.rb
 - lib/ancestry/materialized_path.rb
 - lib/ancestry/version.rb
-homepage: http://github.com/stefankroes/ancestry
+homepage: https://github.com/stefankroes/ancestry
 licenses:
 - MIT
 metadata:
@@ -158,7 +158,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.6.14.1
 signing_key: 
 specification_version: 4
 summary: Organize ActiveRecord model into a tree structure