deferring 0.0.10 → 0.1.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    M2Q5NGQyOGY3MTViMzE1ODA4ODgwNzdjZTRmNDhjMjMyYWI4MDc3OA==
-  data.tar.gz: !binary |-
-    MDQ5ZTg4NTUyYmM3ZjgyNDM0NzI5ZTdhY2ZiMzMwMzkxM2M4NmM0Yw==
+SHA1:
+  metadata.gz: 425c85b43ca58b47075b81fd98800f7ca2cb530e
+  data.tar.gz: 17649b71b066711330887c6a1170c2070baca519
 SHA512:
-  metadata.gz: !binary |-
-    ZmI0YTk4ZDIwOGZhNjFlMWViOTc3NGRmODhmYmE0YmI0NzgxZWM3ODI1ZGZl
-    YmEwODQ3YjRlN2JlYzJmODY2MTI3Y2FhZjM5MTlkMjBjNWI4YjYwNDkxZTBh
-    MTdhM2QxYzdhMjk1MGViM2JkOTQ0N2ZjZWRmYTlkYjAxNjVhOTU=
-  data.tar.gz: !binary |-
-    ZGE0NGE5ODhiYmQwMzMzMjg0ZmZmOTc0YTVlMjJmMjQxZGZkMjExYTJlNGI2
-    ZmEzZmZhMmM0MGFmNjk4OTk2NmVkNzM0ZmUwMmUwMTEyZjc4ODhhZTM3MzRk
-    MjU4NDdhNTE1OTIzYTVmMjE2NmNjYWFkOTIzOTNjMDQ4YWIyMTk=
+  metadata.gz: 4be333a99bf094965edf5f1636f84d039525d873844d4ba62ca75645676893d73ee1106948acd12b3f6302d231e441a323464663f2927e1b02a90fa1bc5bc709
+  data.tar.gz: 2c5d2de74c766c08956095a851a4f7405596327a5bc98e2ce9ad9e8b0d5b7b98f1b3040ec412423afe729e6f000c123293d36abe3e7a663bd5446d2c61c6bdef

data/README.md

@@ -389,12 +389,9 @@ bundle exec appraisal rake
 
 ## TODO
 
-* add support for more Rubies
 * check out what is going on with uniq: true
 * collection(true) (same as reload)
 * collection.replace
-* validations!
-* validate: false does not work
 
 ## Contributing
 

data/gemfiles/rails_30.gemfile.lock

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

data/gemfiles/rails_32.gemfile.lock

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

data/gemfiles/rails_40.gemfile.lock

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

data/gemfiles/rails_41.gemfile.lock

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

data/lib/deferring.rb

@@ -13,9 +13,15 @@ module Deferring
   def deferred_has_and_belongs_to_many(*args)
     options = args.extract_options!
     listeners = create_callback_listeners!(options)
+    autosave = options.fetch(:autosave, true)
+    validate = options.fetch(:validate, true)
 
     has_and_belongs_to_many(*args, options)
-    generate_deferred_association_methods(args.first.to_s, listeners)
+    generate_deferred_association_methods(
+      args.first.to_s,
+      listeners,
+      autosave: autosave,
+      validate: validate)
   end
 
   # Creates a wrapper around `has_many`. A normal has many association is
@@ -26,9 +32,17 @@ module Deferring
     options = args.extract_options!
     listeners = create_callback_listeners!(options)
     inverse_association_name = options.fetch(:as, self.name.underscore.to_sym)
+    autosave = options.fetch(:autosave, true)
+    validate = options.fetch(:validate, true)
 
     has_many(*args, options)
-    generate_deferred_association_methods(args.first.to_s, listeners, inverse_association_name)
+    generate_deferred_association_methods(
+      args.first.to_s,
+      listeners,
+      inverse_association_name: inverse_association_name,
+      autosave: autosave,
+      type: :has_many,
+      validate: validate)
   end
 
   def deferred_accepts_nested_attributes_for(*args)
@@ -122,7 +136,12 @@ module Deferring
 
   private
 
-  def generate_deferred_association_methods(association_name, listeners, inverse_association_name = nil)
+  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)
+    validate = options.fetch(:validate, true)
+
     # Store the original accessor methods of the association.
     alias_method :"original_#{association_name}", :"#{association_name}"
     alias_method :"original_#{association_name}=", :"#{association_name}="
@@ -176,6 +195,40 @@ module Deferring
       send(:"#{association_name.singularize}_ids=", ids.split(','))
     end
 
+    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)
+
+      # Do not perform validations for HABTM associations as they are always
+      # validated by Rails upon saving.
+      return true if type == :habtm
+
+      # Do not perform validation when the association has not been loaded
+      # (performance improvement).
+      return true unless send(:"deferred_#{association_name}").loaded?
+
+      # Do not perform validations when validate: false.
+      return true if validate == false
+
+      all_records_valid = send(:"deferred_#{association_name}").objects.all? do |record|
+        unless valid = record.valid?
+          if autosave
+            record.errors.each do |attribute, message|
+              attribute = "#{association_name}.#{attribute}"
+              errors[attribute] << message
+              errors[attribute].uniq!
+            end
+          else
+            errors.add(association_name)
+          end
+        end
+        valid
+      end
+      return false unless all_records_valid
+
+      true
+    end
+
     #  the save after the parent object has been saved
     after_save :"perform_deferred_#{association_name}_save!"
     define_method :"perform_deferred_#{association_name}_save!" do

data/lib/deferring/deferred_association.rb

@@ -44,7 +44,8 @@ module Deferring
     # Delegates methods from Ruby's Array module to the object in the deferred
     # association.
     delegate :[]=, :[], :clear, :select!, :reject!, :flatten, :flatten!, :sort!,
-             :sort_by!, :empty?, :size, :length, to: :objects
+             :keep_if, :delete_if, :sort_by!, :empty?, :size, :length,
+             to: :objects
 
     # Delegates Ruby's Enumerable#find method to the original association.
     #

data/lib/deferring/version.rb

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

data/spec/lib/deferring_has_many_spec.rb

@@ -35,8 +35,6 @@ RSpec.describe 'deferred has_many associations' do
       expect{ bob.save }.to change{ Person.find(bob.id).issues.size }.from(3).to(1)
     end
 
-    xit 'does not create a link when parent is not valid'
-
     it 'replaces existing records when assigning a new set of records' do
       bob.issues = [db_issue]
 
@@ -51,6 +49,104 @@ RSpec.describe 'deferred has_many associations' do
       expect(bob.issues.first.person).to eq bob
     end
 
+    describe 'validations' do
+      xit 'does not create a link when parent is not valid'
+
+      context 'with invalid child and validate: true' do
+        it 'returns false when validating' do
+          bob.issues = [Issue.new]
+          expect(bob.valid?).to eq(false)
+        end
+
+        it 'returns false when saving' do
+          bob.issues = [Issue.new]
+          expect(bob.save).to eq(false)
+        end
+
+        it 'does not create a link' do
+          bob.issues = [Issue.new]
+          expect{ bob.save }.to_not change{ Person.find(bob.id).issues.size }
+        end
+      end
+
+      context 'with valid child and validate: true' do
+        it 'returns true when validating' do
+          bob.issues = [Issue.new(subject: 'Valid!')]
+          expect(bob.valid?).to eq(true)
+        end
+
+        it 'validates the child' do
+          bob.issues = [Issue.new]
+          bob.valid?
+          expect(bob.issues.first.validation_log).to eq([
+            'Validating new issue'
+          ])
+        end
+
+        it 'returns true when saving' do
+          bob.issues = [Issue.new(subject: 'Valid!')]
+          expect(bob.save).to eq(true)
+        end
+
+        it 'creates a link' do
+          bob.issues = [Issue.new(subject: 'Valid!')]
+          expect{ bob.save }.to change{ Person.find(bob.id).issues.size }.from(0).to(1)
+        end
+      end
+
+      context 'with invalid child and validate: false' do
+        it 'returns true when validating' do
+          bob.non_validated_issues = [NonValidatedIssue.new]
+          expect(bob.valid?).to eq(true)
+        end
+
+        it 'does not validate the child' do
+          bob.non_validated_issues = [NonValidatedIssue.new]
+          bob.valid?
+          expect(bob.non_validated_issues.first.validation_log).to eq([])
+        end
+
+        unless rails30 # rails 3.0 does not return a error
+          it 'fails when trying to save the parent' do
+            bob.non_validated_issues = [NonValidatedIssue.new]
+
+            # Rails will raise the following error:
+            # - ActiveRecord::RecordNotSaved:
+            #     Failed to replace non_validated_issues because one or more of the new records could not be saved.
+            #
+            # This behaviour is different from the default Rails behaviour.
+            # Rails will normally just save the parent and not save the
+            # association.
+            #
+            # Two ways to avoid this error (using the Deferring gem):
+            # - always use validate: true when user input is involved (e.g.
+            #   using nested attributes to update the association),
+            # - add validations to the parent to check validness of the
+            #   children when a child record can be valid on itself but invalid
+            #   when added to the parent
+            expect{ bob.save }.to raise_error
+          end
+        end
+      end
+
+      context 'with valid child and validate: false' do
+        it 'returns true when validating' do
+          bob.non_validated_issues = [NonValidatedIssue.new(subject: 'Valid!')]
+          expect(bob.valid?).to eq(true)
+        end
+
+        it 'returns true when saving' do
+          bob.non_validated_issues = [NonValidatedIssue.new(subject: 'Valid!')]
+          expect(bob.save).to eq(true)
+        end
+
+        it 'creates a link' do
+          bob.non_validated_issues = [NonValidatedIssue.new(subject: 'Valid!')]
+          expect{ bob.save }.to change{ Person.find(bob.id).non_validated_issues.size }.from(0).to(1)
+        end
+      end
+    end
+
     describe '#collection_singular_ids' do
       it 'returns ids of saved & unsaved associated records' do
         bob.issues = [printer_issue, db_issue]

data/spec/spec_helper.rb

@@ -1,6 +1,9 @@
 require 'support/active_record'
 require 'deferring'
-require 'support/models'
+require 'support/models/person'
+require 'support/models/team'
+require 'support/models/issue'
+require 'support/models/non_validated_issue'
 require 'support/rails_versions'
 
 RSpec.configure do |config|

data/spec/support/active_record.rb

@@ -24,5 +24,11 @@ ActiveRecord::Schema.define version: 0 do
     t.integer :person_id
     t.timestamps
   end
+
+  create_table :non_validated_issues do |t|
+    t.string :subject
+    t.integer :person_id
+    t.timestamps
+  end
 end
 ActiveRecord::Base.logger = Logger.new(File.dirname(__FILE__) + '/debug.log')

data/spec/support/models/issue.rb

@@ -0,0 +1,24 @@
+class Issue < ActiveRecord::Base
+  belongs_to :person
+
+  validates_presence_of :subject
+  validate :dummy_validation
+
+  def validation_log
+    @validation_log ||= []
+  end
+
+  def log(validation_line)
+    validation_log << validation_line
+    validation_log
+  end
+
+  def dummy_validation
+    if new_record?
+      log("Validating new issue")
+    else
+      log("Validating issue #{id}")
+    end
+  end
+end
+

data/spec/support/models/non_validated_issue.rb

@@ -0,0 +1,24 @@
+class NonValidatedIssue < ActiveRecord::Base
+  belongs_to :person
+
+  validates_presence_of :subject
+  validate :dummy_validation
+
+  def validation_log
+    @validation_log ||= []
+  end
+
+  def log(validation_line)
+    validation_log << validation_line
+    validation_log
+  end
+
+  def dummy_validation
+    if new_record?
+      log("Validating new non validated issue")
+    else
+      log("Validating non validated issue #{id}")
+    end
+  end
+
+end

data/spec/support/{models.rb → models/person.rb}

@@ -1,5 +1,3 @@
-# encoding: UTF-8
-
 class Person < ActiveRecord::Base
 
   deferred_has_and_belongs_to_many :teams, before_link: :link_team,
@@ -17,6 +15,11 @@ class Person < ActiveRecord::Base
                              after_remove: :removed_issue
   deferred_accepts_nested_attributes_for :issues, allow_destroy: true
 
+  deferred_has_many :non_validated_issues, before_remove: :remove_issue,
+                                  after_remove: :removed_issue,
+                                  validate: false
+
+
   validates_presence_of :name
 
   def audit_log
@@ -80,20 +83,3 @@ class Person < ActiveRecord::Base
     log("After removing issue #{issue.id}")
   end
 end
-
-class Team < ActiveRecord::Base
-  has_and_belongs_to_many :people
-
-  validates :name, presence: true
-  validate :no_more_than_two_people_per_team
-
-  def no_more_than_two_people_per_team
-    if people.length > 2
-      errors.add(:people, "A maximum of two persons per team is allowed")
-    end
-  end
-end
-
-class Issue < ActiveRecord::Base
-  belongs_to :person
-end

data/spec/support/models/team.rb

@@ -0,0 +1,12 @@
+class Team < ActiveRecord::Base
+  has_and_belongs_to_many :people
+
+  validates :name, presence: true
+  validate :no_more_than_two_people_per_team
+
+  def no_more_than_two_people_per_team
+    if people.length > 2
+      errors.add(:people, "A maximum of two persons per team is allowed")
+    end
+  end
+end

metadata

@@ -1,100 +1,100 @@
 --- !ruby/object:Gem::Specification
 name: deferring
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.1.0
 platform: ruby
 authors:
 - Robin Roestenburg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-10 00:00:00.000000000 Z
+date: 2014-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>'
+    - - ">"
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>'
+    - - ">"
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: ! "\n    The Deferring gem makes it possible to defer saving ActiveRecord\n
+description: "\n    The Deferring gem makes it possible to defer saving ActiveRecord\n
   \   associations until the parent object is saved.\n  "
 email:
 - robin@roestenburg.io
@@ -102,9 +102,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Appraisals
 - Gemfile
 - LICENSE.txt
@@ -128,7 +128,10 @@ files:
 - spec/lib/deferring_nested_attributes_spec.rb
 - spec/spec_helper.rb
 - spec/support/active_record.rb
-- spec/support/models.rb
+- spec/support/models/issue.rb
+- spec/support/models/non_validated_issue.rb
+- spec/support/models/person.rb
+- spec/support/models/team.rb
 - spec/support/rails_versions.rb
 homepage: http://github.com/robinroestenburg/deferring
 licenses:
@@ -140,17 +143,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.1
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Defer saving ActiveRecord associations until parent is saved
@@ -160,6 +163,9 @@ test_files:
 - spec/lib/deferring_nested_attributes_spec.rb
 - spec/spec_helper.rb
 - spec/support/active_record.rb
-- spec/support/models.rb
+- spec/support/models/issue.rb
+- spec/support/models/non_validated_issue.rb
+- spec/support/models/person.rb
+- spec/support/models/team.rb
 - spec/support/rails_versions.rb
 has_rdoc: