deferring 0.1.5 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 817f36897a24bc0726ce52d33dfc118591fc18da
-  data.tar.gz: 6313e1831bf0294321b30daf3933da1891429603
+  metadata.gz: 9640c37fd475fa2857be6686a2f2b726a4f6a6ef
+  data.tar.gz: dfd12c320ff1fdcd8f2331a6b3180c473a894524
 SHA512:
-  metadata.gz: 8999de2bd86c4621d82d658b0168339aa0ba42cdd4252be88047e5248ef4d5ac3ac7c85499479a2338c23816a529add87cd613a76e032c57d7e7669dac977561
-  data.tar.gz: 5a9ccdc63b1a1c9fa4d1c218ed7343b9c0f2f9b4ccc0609da86c587f08235c42c64f2060d6461127ff2572740762830ec1379b4e9c1af5f8f958e5710c619597
+  metadata.gz: b8b85bcb7252d0af7f901ea97db87b1b0556ab3061f43d8dd9fa37b5dcc431cd59878a4dd0300571b241036f072a06d6a17d26db6374c0ce30712b2455952844
+  data.tar.gz: a614b0996a14b2ba60b5faa317e9f1d481685442c333dcb459b87f7240fc8b3e8df2a91c237188615a82fd5dcfca4fe62def66ca7ba05afe1ca57e90135f48bb

data/gemfiles/rails_30.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../
   specs:
-    deferring (0.1.4)
+    deferring (0.2.0)
       activerecord (> 3.0)
 
 GEM

data/gemfiles/rails_32.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../
   specs:
-    deferring (0.1.4)
+    deferring (0.2.0)
       activerecord (> 3.0)
 
 GEM

data/gemfiles/rails_40.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../
   specs:
-    deferring (0.1.4)
+    deferring (0.2.0)
       activerecord (> 3.0)
 
 GEM

data/gemfiles/rails_41.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../
   specs:
-    deferring (0.1.4)
+    deferring (0.2.0)
       activerecord (> 3.0)
 
 GEM

data/lib/deferring.rb

@@ -21,6 +21,7 @@ module Deferring
       args.first.to_s,
       listeners,
       autosave: autosave,
+      type: :habtm,
       validate: validate)
   end
 
@@ -42,6 +43,7 @@ module Deferring
       inverse_association_name: inverse_association_name,
       autosave: autosave,
       type: :has_many,
+      dependent: options[:dependent],
       validate: validate)
   end
 
@@ -136,8 +138,9 @@ module Deferring
   def generate_deferred_association_methods(association_name, listeners, options = {})
     inverse_association_name = options[:inverse_association_name]
     autosave = options.fetch(:autosave, true)
-    type = options.fetch(:type, :habtm)
+    type = options.fetch(:type)
     validate = options.fetch(:validate, true)
+    dependent = options[:dependent]
 
     # Store the original accessor methods of the association.
     alias_method :"original_#{association_name}", :"#{association_name}"
@@ -152,7 +155,7 @@ module Deferring
     # if none are found.
     # TODO: add force_reload argument?
     define_method :"#{association_name}" do
-      find_or_create_deferred_association(association_name, listeners, inverse_association_name)
+      find_or_create_deferred_association(association_name, listeners, inverse_association_name, dependent)
       send(:"deferred_#{association_name}")
     end
 
@@ -161,7 +164,7 @@ module Deferring
     # Replaces the collection's content by deleting and adding objects as
     # appropriate.
     define_method :"#{association_name}=" do |objects|
-      find_or_create_deferred_association(association_name, listeners, inverse_association_name)
+      find_or_create_deferred_association(association_name, listeners, inverse_association_name, dependent)
       send(:"deferred_#{association_name}").objects = objects
     end
 
@@ -170,7 +173,7 @@ module Deferring
     # Replace the collection by the objects identified by the primary keys in
     # ids.
     define_method :"#{association_name.singularize}_ids=" do |ids|
-      find_or_create_deferred_association(association_name, listeners, inverse_association_name)
+      find_or_create_deferred_association(association_name, listeners, inverse_association_name, dependent)
 
       ids ||= []
       klass = self.class.reflect_on_association(:"#{association_name}").klass
@@ -183,7 +186,7 @@ module Deferring
     #
     # Returns an array of the associated objects' ids.
     define_method :"#{association_name.singularize}_ids" do
-      find_or_create_deferred_association(association_name, listeners, inverse_association_name)
+      find_or_create_deferred_association(association_name, listeners, inverse_association_name, dependent)
       send(:"deferred_#{association_name}").ids
     end
 
@@ -197,7 +200,7 @@ module Deferring
 
     after_validation :"perform_deferred_#{association_name}_validation!"
     define_method :"perform_deferred_#{association_name}_validation!" do
-      find_or_create_deferred_association(association_name, listeners, inverse_association_name)
+      find_or_create_deferred_association(association_name, listeners, inverse_association_name, dependent)
 
       # Do not perform validations for HABTM associations as they are always
       # validated by Rails upon saving.
@@ -233,21 +236,21 @@ module Deferring
     #  the save after the parent object has been saved
     after_save :"perform_deferred_#{association_name}_save!"
     define_method :"perform_deferred_#{association_name}_save!" do
-      find_or_create_deferred_association(association_name, listeners, inverse_association_name)
+      find_or_create_deferred_association(association_name, listeners, inverse_association_name, dependent)
 
       # Send the objects of our delegated association to the original
       # association and store the result.
       send(:"original_#{association_name}=", send(:"deferred_#{association_name}").objects)
 
       # Store the new value of the association into our delegated association.
-      update_deferred_association(association_name, listeners, inverse_association_name)
+      update_deferred_association(association_name, listeners, inverse_association_name, dependent)
     end
 
     define_method :"reload_with_deferred_#{association_name}" do |*args|
-      find_or_create_deferred_association(association_name, listeners, inverse_association_name)
+      find_or_create_deferred_association(association_name, listeners, inverse_association_name, dependent)
 
       send(:"reload_without_deferred_#{association_name}", *args).tap do
-        update_deferred_association(association_name, listeners, inverse_association_name)
+        update_deferred_association(association_name, listeners, inverse_association_name, dependent)
       end
     end
     alias_method_chain :reload, :"deferred_#{association_name}"
@@ -257,11 +260,11 @@ module Deferring
   end
 
   def generate_update_deferred_assocation_method
-    define_method :update_deferred_association do |name, listeners, inverse_association_name|
+    define_method :update_deferred_association do |name, listeners, inverse_association_name, dependent|
       klass = self.class.reflect_on_association(:"#{name}").klass
       send(
         :"deferred_#{name}=",
-        DeferredAssociation.new(send(:"original_#{name}"), klass, self, inverse_association_name))
+        DeferredAssociation.new(send(:"original_#{name}"), klass, self, inverse_association_name, dependent))
       listeners.each do |event_name, callback_method|
         l = DeferredCallbackListener.new(event_name, self, callback_method)
         send(:"deferred_#{name}").add_callback_listener(l)
@@ -270,9 +273,9 @@ module Deferring
   end
 
   def generate_find_or_create_deferred_association_method
-    define_method :find_or_create_deferred_association do |name, listeners, inverse_association_name|
+    define_method :find_or_create_deferred_association do |name, listeners, inverse_association_name, dependent|
       if send(:"deferred_#{name}").nil?
-        update_deferred_association(name, listeners, inverse_association_name)
+        update_deferred_association(name, listeners, inverse_association_name, dependent)
       end
     end
   end

data/lib/deferring/deferred_association.rb

@@ -7,14 +7,19 @@ module Deferring
     # TODO: Write tests for enumerable.
     include Enumerable
 
-    attr_reader :load_state, :klass, :parent_record, :inverse_name
+    attr_reader :load_state,
+                :klass,
+                :parent_record,
+                :inverse_name,
+                :dependent
 
-    def initialize(original_association, klass, parent_record, inverse_name)
+    def initialize(original_association, klass, parent_record, inverse_name, dependent)
       super(original_association)
       @load_state    = :ghost
       @klass         = klass
       @parent_record = parent_record
       @inverse_name  = inverse_name
+      @dependent     = dependent
     end
     alias_method :original_association, :__getobj__
 
@@ -101,10 +106,10 @@ module Deferring
       objects.map(&:id)
     end
 
-    def <<(records)
+    def <<(*records)
       # TODO: Do we want to prevent including the same object twice? Not sure,
       # but it will probably be filtered after saving and retrieving as well.
-      Array(records).flatten.uniq.each do |record|
+      records.flatten.uniq.each do |record|
         run_deferring_callbacks(:link, record) do
           if inverse_name && record.class.reflect_on_association(inverse_name)
             record.send(:"#{inverse_name}=", parent_record)
@@ -119,13 +124,25 @@ module Deferring
     alias_method :concat, :<<
     alias_method :append, :<<
 
-    def delete(records)
-      Array(records).flatten.uniq.each do |record|
+    def delete(*records)
+      records.flatten.uniq.each do |record|
         run_deferring_callbacks(:unlink, record) { objects.delete(record) }
       end
       self
     end
 
+    def destroy(*records)
+      records.flatten.uniq.each do |record|
+        record = record.to_i if record.is_a? String
+        record = objects.detect { |o| o.id == record } if record.is_a? Fixnum
+
+        run_deferring_callbacks(:unlink, record) {
+          objects.delete(record)
+          record.mark_for_destruction if dependent && [:destroy, :delete_all].include?(dependent)
+        }
+      end
+    end
+
     def build(*args, &block)
       klass.new(*args, &block).tap do |record|
         run_deferring_callbacks(:link, record) do

data/lib/deferring/version.rb

@@ -1,5 +1,5 @@
 # encoding: UTF-8
 
 module Deferring
-  VERSION = '0.1.5'
+  VERSION = '0.2.0'
 end

data/spec/lib/deferring_habtm_spec.rb

@@ -447,14 +447,14 @@ RSpec.describe 'deferred has_and_belongs_to_many associations' do
       ])
     end
 
-    it 'only calls the rails callbacks when removing a record using destroy' do
+    it 'calls the unlink callbacks when removing a record using destroy' do
       bob = Person.where(name: 'Bob').first
-      bob.teams.destroy(3)
+      bob.teams.destroy(Team.find(3))
 
       expect(bob.audit_log.length).to eq(2)
       expect(bob.audit_log).to eq([
-        'Before removing team 3',
-        'After removing team 3'
+        'Before unlinking team 3',
+        'After unlinking team 3'
       ])
     end
 
@@ -467,14 +467,19 @@ RSpec.describe 'deferred has_and_belongs_to_many associations' do
       bob.teams.delete(Team.find(1))
       bob.teams << Team.find(2)
       bob.teams.build(name: 'Service Desk')
+      bob.teams.destroy(Team.find(3))
       bob.save!
 
-      expect(bob.audit_log.length).to eq(12)
+      expect(bob.audit_log.length).to eq(16)
       expect(bob.audit_log).to eq([
         'Before unlinking team 1', 'After unlinking team 1',
         'Before linking team 2',   'After linking team 2',
         'Before linking new team', 'After linking new team',
-        'Before removing team 1',  'After removing team 1',
+        'Before unlinking team 3', 'After unlinking team 3',
+        'Before removing team 3',
+        'Before removing team 1',
+        'After removing team 3',
+        'After removing team 1',
         'Before adding team 2',    'After adding team 2',
         'Before adding new team',  'After adding team 4'
       ])
@@ -607,6 +612,96 @@ RSpec.describe 'deferred has_and_belongs_to_many associations' do
 
     end
 
+    describe '#destroy' do
+      context 'when called on has_many association with dependent: :delete_all' do
+        it 'destroys the records supplied and removes them from the collection' do
+          printer = Issue.create!(subject: 'Printer PRT-001 jammed')
+          database = Issue.create!(subject: 'Database server DB-1337 down')
+          sandwich = Issue.create!(subject: 'Make me a sandwich!')
+
+          bob.issues << printer << database << sandwich
+          bob.save!
+
+          expect {
+            bob.issues.destroy(printer)
+            bob.save!
+          }.to change {
+            Person.find(bob.id).issues.size
+          }.from(3).to(2)
+          expect { Issue.find(printer.id) }.to raise_error(ActiveRecord::RecordNotFound)
+        end
+      end
+
+      context 'when called on has_many association without dependent: :delete_all' do
+        it 'removes the records supplied from the collection' do
+          printer = Issue.create!(subject: 'Printer PRT-001 jammed')
+          database = Issue.create!(subject: 'Database server DB-1337 down')
+          sandwich = Issue.create!(subject: 'Make me a sandwich!')
+
+          bob.other_issues << printer << database << sandwich
+          bob.save!
+
+          expect {
+            bob.other_issues.destroy(printer)
+            bob.save!
+          }.to change {
+            Person.find(bob.id).other_issues.size
+          }.from(3).to(2)
+          expect(Issue.find(printer.id)).to eq(printer)
+        end
+      end
+
+      context 'when called on has_and_belongs_to_many association' do
+        it 'removes the records supplied from the collection' do
+          bob.teams << dba << operations
+          bob.save!
+
+          expect {
+            bob.teams.destroy(dba)
+            bob.save!
+          }.to change {
+            Person.find(bob.id).teams.size
+          }.from(2).to(1)
+          expect(Team.find(dba.id)).to eq(dba)
+        end
+      end
+
+      it 'returns an array with the removed records' do
+        printer = Issue.create!(subject: 'Printer PRT-001 jammed')
+        database = Issue.create!(subject: 'Database server DB-1337 down')
+        sandwich = Issue.create!(subject: 'Make me a sandwich!')
+
+        bob.issues << printer << database << sandwich
+        bob.save!
+
+        expect(bob.issues.destroy(database)).to eq([database])
+      end
+
+      it 'accepts Fixnum values' do
+        bob.teams << dba << operations
+        bob.save!
+
+        expect {
+          bob.teams.destroy(dba.id)
+          bob.save!
+        }.to change {
+          Person.find(bob.id).teams.size
+        }.from(2).to(1)
+      end
+
+      it 'accepts String values' do
+        bob.teams << dba << operations
+        bob.save!
+
+        expect {
+          bob.teams.destroy("#{dba.id}", "#{operations.id}")
+          bob.save!
+        }.to change {
+          Person.find(bob.id).teams.size
+        }.from(2).to(0)
+      end
+    end
+
     it 'should allow ActiveRecord::QueryMethods' do
       p = Person.first
       p.teams << dba << operations

data/spec/support/models/person.rb

@@ -12,9 +12,16 @@ class Person < ActiveRecord::Base
   deferred_accepts_nested_attributes_for :teams, allow_destroy: true
 
   deferred_has_many :issues, before_remove: :remove_issue,
-                             after_remove: :removed_issue
+                             after_remove: :removed_issue,
+                             dependent: :delete_all
   deferred_accepts_nested_attributes_for :issues, allow_destroy: true
 
+  # has_many without dependent: :delete_all, calling destroy on this association
+  # will not destroy the the Issue record
+  deferred_has_many :other_issues, before_remove: :remove_issue,
+                                   after_remove: :removed_issue,
+                                   class_name: 'Issue'
+
   deferred_has_many :non_validated_issues, before_remove: :remove_issue,
                                   after_remove: :removed_issue,
                                   validate: false

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deferring
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.2.0
 platform: ruby
 authors:
 - Robin Roestenburg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-07 00:00:00.000000000 Z
+date: 2015-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord