poly_belongs_to 0.1.9 → 0.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2485663b8e0b1364a05b151975b527c56e95bada
-  data.tar.gz: 33338ae33151a22083b535ea79a706b237cf64aa
+  metadata.gz: a87c53ed8f75c2ffbf32fba761b35e633bd8c0ba
+  data.tar.gz: 6483b2649d7128f5a8b6a6cef5c3a9ff040a1112
 SHA512:
-  metadata.gz: 52ceb7ef74ed74c91012ae7ac3fa662da98653ee5258f538544911147ff873eaafad836b39bd095532ae28c79bbe07071ab62a7b636f4cc000a5748f69f0310c
-  data.tar.gz: 5c0e6bd0b258619346e12753beb23a15ea830f884d19eee585a137b692ac1309575dfc2c9e7f7e041794c3044fae8ab4facf597e29fc2ab2e6f712cc908f72d8
+  metadata.gz: ef4a8c310620f69522b4ae9fa6e7b9a90f242bd38b5205969d77d60036bbf8af4f2961b339eede164ee5b3025a2a471863b96c64a601e384b75481c5888be33d
+  data.tar.gz: 6c8b1386efe6f406057e52e376c9dfda301db3ca9c0b8cae953438b7276ebcf77c2cef9f3e5f6630440872ca94c56e050a6de215c131dfdf65b5c9849c4ca99c

data/README.md

@@ -61,6 +61,10 @@ MyObject.first.pbt_type
 MyObject.first.pbt_parent
 # => #<User id: 123 ... >
 
+# Get Top Hierarchical Parent Object (Works on all belongs_to Objects)
+MyObject.first.pbt_top_parent
+# => #<User id: 123 ... >
+
 # Mutliple Parent Objects (List of one item for Polymorphic, full list otherwise.)
 Tire.first.pbt_parents
 # => [#<User id: 123 ... >, #<Car id: 234 ... >]
@@ -128,14 +132,19 @@ PolyBelongsTo::Pbt::IsSingular[ obj, child ]
 PolyBelongsTo::Pbt::IsPlural[ obj, child ]
 
 # Returns the symbol for the CollectionProxy the child belongs to in relation to obj
-# NOTE: For has_one the symbol is not a CollectionProxy, but the instance
+# NOTE: For has_one the symbol is not a CollectionProxy, but represents the instance
 PolyBelongsTo::Pbt::CollectionProxy[ obj, child ]
 
-# Always returns a collection proxy; fakes a collection proxy for has_one.
+# Always returns a collection proxy; fakes a collection proxy for has_one
 PolyBelongsTo::Pbt::AsCollectionProxy[ obj, child ]
 
 # Wrapper for has_one objects to be a collection proxy
 PolyBelongsTo::FakedCollection.new(obj, child)
+
+# Track which DB records have already been processed
+# Current recommended methods to use on instance are
+#                 :add?, :include?, :flag, :flagged?
+PolyBelongsTo::SingletonSet.new
 ```
 ##Record Duplication
 
@@ -169,7 +178,6 @@ contact.save
 
 
 # For a fully recursive copy do the same with pbt_deep_dup_build
-# Keep in mind this is vulnerable to infinite loops!
 contact.pbt_deep_dup_build( User.last.profile )
 
 # Remeber to save!

data/lib/poly_belongs_to/core.rb

@@ -56,7 +56,7 @@ module PolyBelongsTo
 
     def pbt_parent
       val = pbt
-      if val
+      if val && !pbt_id.nil?
         if poly?
           "#{pbt_type}".constantize.find(pbt_id)
         else
@@ -67,6 +67,17 @@ module PolyBelongsTo
       end
     end
 
+    def pbt_top_parent
+      record = self
+      return nil unless record.pbt_parent
+      no_repeat = PolyBelongsTo::SingletonSet.new
+      while !no_repeat.include?(record.pbt_parent) && !record.pbt_parent.nil?
+        no_repeat.add?(record)
+        record = record.pbt_parent
+      end
+      record
+    end
+
     def pbt_parents
       if poly?
         Array[pbt_parent].compact

data/lib/poly_belongs_to/singleton_set.rb

@@ -18,15 +18,20 @@ module PolyBelongsTo
       result
     end
 
+    # <b>DEPRECATED:</b> Please use <tt>add?</tt> instead. Behavior changing in 0.2.0.
     def add(record)
+      warn "[DEPRECATION] `add` will revert to normal behavior in 0.2.0.  Please maintain behavior with `add?` instead."
       add?(record)
     end
 
+    # <b>DEPRECATED:</b> Please use <tt>add?</tt> instead. Behavior changing in 0.2.0.
     def <<(record)
+      warn "[DEPRECATION] `<<` will revert to normal behavior in 0.2.0.  Please maintain behavior with `add?` instead."
       add?(record)
     end
 
     def include?(record)
+      return nil unless record
       @set.include?(formatted_name(record))
     end
 
@@ -35,10 +40,12 @@ module PolyBelongsTo
     end
 
     def flagged?(record)
+      return nil unless record
       @flagged.include?(formatted_name(record))
     end
 
     def method_missing(mthd)
+      # TODO Add parameter support and substiture record parameters with formatted_name(record)
       @set.send(mthd)
     end
   end  

data/lib/poly_belongs_to/version.rb

@@ -1,3 +1,3 @@
 module PolyBelongsTo
-  VERSION = "0.1.9"
+  VERSION = "0.1.10"
 end

data/test/core_test.rb

@@ -179,6 +179,31 @@ class CoreTest < ActiveSupport::TestCase
       profile.pbt_parent.id.must_be_same_as user.id
     end
 
+    it "#pbt_parent returns nil if no ID is set for parent relationship" do
+      alpha = Alpha.new; alpha.save
+      alpha.pbt_parent.must_be_nil
+    end
+
+    it "#pbt_top_parent climbs up belongs_to hierarchy to the top; polymorphic relationships first" do
+      alpha = Alpha.new;         alpha.save
+      beta  = alpha.betas.build; beta.save
+      capa  = beta.capas.build;  capa.save
+      delta = capa.deltas.build; delta.save
+      delta.pbt_top_parent.must_equal alpha
+    end
+
+    it "#pbt_top_parent with circular relation goes till the repeat" do
+      alpha = Alpha.new;         alpha.save
+      beta  = alpha.betas.build; beta.save
+      capa  = beta.capas.build;  capa.save
+      delta = capa.deltas.build; delta.save
+      alpha.update(delta_id: delta.id)
+      delta.pbt_top_parent.must_equal alpha
+      alpha.pbt_top_parent.must_equal beta
+      beta. pbt_top_parent.must_equal capa
+      capa. pbt_top_parent.must_equal delta
+    end
+
     it "#pbt_parents can show multiple parents" do
       user = User.new(id: 1)
       user.cars.build