deferring 0.0.1

data/gemfiles/rails_4.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "4.1.0"
+
+gemspec :path => "../"

data/gemfiles/rails_4.gemfile.lock

@@ -0,0 +1,58 @@
+PATH
+  remote: ..
+  specs:
+    raincheck (0.0.1)
+      activerecord (> 3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (4.1.0)
+      activesupport (= 4.1.0)
+      builder (~> 3.1)
+    activerecord (4.1.0)
+      activemodel (= 4.1.0)
+      activesupport (= 4.1.0)
+      arel (~> 5.0.0)
+    activesupport (4.1.0)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    appraisal (1.0.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    arel (5.0.1.20140414130214)
+    builder (3.2.2)
+    diff-lcs (1.2.5)
+    i18n (0.6.9)
+    json (1.8.1)
+    minitest (5.3.3)
+    rake (10.3.1)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.8)
+    rspec-expectations (2.14.5)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.6)
+    sqlite3 (1.3.9)
+    thor (0.19.1)
+    thread_safe (0.3.3)
+    tzinfo (1.1.0)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (= 4.1.0)
+  appraisal
+  bundler (~> 1.3)
+  raincheck!
+  rake
+  rspec
+  sqlite3

data/gemfiles/rails_40.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "4.0.4"
+
+gemspec :path => "../"

data/gemfiles/rails_40.gemfile.lock

@@ -0,0 +1,59 @@
+PATH
+  remote: ../
+  specs:
+    deferring (0.0.1)
+      activerecord (> 3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (4.0.4)
+      activesupport (= 4.0.4)
+      builder (~> 3.1.0)
+    activerecord (4.0.4)
+      activemodel (= 4.0.4)
+      activerecord-deprecated_finders (~> 1.0.2)
+      activesupport (= 4.0.4)
+      arel (~> 4.0.0)
+    activerecord-deprecated_finders (1.0.3)
+    activesupport (4.0.4)
+      i18n (~> 0.6, >= 0.6.9)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    appraisal (1.0.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    arel (4.0.2)
+    builder (3.1.4)
+    diff-lcs (1.2.5)
+    i18n (0.6.9)
+    minitest (4.7.5)
+    multi_json (1.9.2)
+    rake (10.3.1)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.8)
+    rspec-expectations (2.14.5)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.6)
+    sqlite3 (1.3.9)
+    thor (0.19.1)
+    thread_safe (0.3.3)
+    tzinfo (0.3.39)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (= 4.0.4)
+  appraisal
+  bundler (~> 1.3)
+  deferring!
+  rake
+  rspec
+  sqlite3

data/gemfiles/rails_41.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "4.1.0"
+
+gemspec :path => "../"

data/gemfiles/rails_41.gemfile.lock

@@ -0,0 +1,58 @@
+PATH
+  remote: ../
+  specs:
+    deferring (0.0.1)
+      activerecord (> 3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (4.1.0)
+      activesupport (= 4.1.0)
+      builder (~> 3.1)
+    activerecord (4.1.0)
+      activemodel (= 4.1.0)
+      activesupport (= 4.1.0)
+      arel (~> 5.0.0)
+    activesupport (4.1.0)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    appraisal (1.0.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    arel (5.0.1.20140414130214)
+    builder (3.2.2)
+    diff-lcs (1.2.5)
+    i18n (0.6.9)
+    json (1.8.1)
+    minitest (5.3.3)
+    rake (10.3.1)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.8)
+    rspec-expectations (2.14.5)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.6)
+    sqlite3 (1.3.9)
+    thor (0.19.1)
+    thread_safe (0.3.3)
+    tzinfo (1.1.0)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (= 4.1.0)
+  appraisal
+  bundler (~> 1.3)
+  deferring!
+  rake
+  rspec
+  sqlite3

data/lib/deferring.rb

@@ -0,0 +1,150 @@
+# encoding: UTF-8
+
+require 'deferring/version'
+require 'deferring/deferred_association'
+
+module Deferring
+  # Creates a wrapper around `has_and_belongs_to_many`. A normal habtm
+  # association is created, but this association is wrapped in a
+  # DeferredAssociation. The accessor methods of the original association are
+  # replaced with ones that will defer saving the association until the parent
+  # object has been saved.
+  def deferred_has_and_belongs_to_many(*args)
+    has_and_belongs_to_many(*args)
+    generate_deferred_association_methods(args.first.to_s)
+  end
+
+  # Creates a wrapper around `has_many`. A normal has many association is
+  # created, but this association is wrapped in a DeferredAssociation. The
+  # accessor methods of the original association are replaced with ones that
+  # will defer saving the association until the parent object has been saved.
+  def deferred_has_many(*args)
+    has_many(*args)
+    generate_deferred_association_methods(args.first.to_s)
+  end
+
+  def deferred_accepts_nested_attributes_for(*args)
+    accepts_nested_attributes_for(*args)
+    association_name = args.first.to_s
+
+    # teams_attributes=
+    define_method :"#{association_name}_attributes=" do |records|
+      find_or_create_deferred_association(association_name)
+
+      # Remove the records that are to be destroyed from the ids that are to be
+      # assigned to the DeferredAssociation instance.
+      records.reject! { |record| record[:_destroy] }
+
+      klass = self.class.reflect_on_association(:"#{association_name}").klass
+      objects = klass.find(records.map { |record| record[:id] })
+      send(:"deferred_#{association_name}").objects = objects
+    end
+
+    generate_find_or_create_deferred_association_method
+  end
+
+  def generate_deferred_association_methods(association_name)
+    # Store the original accessor methods of the association.
+    alias_method :"original_#{association_name}", :"#{association_name}"
+    alias_method :"original_#{association_name}=", :"#{association_name}="
+
+    # Accessor for our own association.
+    attr_accessor :"deferred_#{association_name}"
+
+    # before/afer remove callbacks
+    define_callbacks :"deferred_#{association_name}_save", scope: [:kind, :name]
+    define_callbacks :"deferred_#{association_name.singularize}_remove", scope: [:kind, :name]
+    define_callbacks :"deferred_#{association_name.singularize}_add", scope: [:kind, :name]
+
+    # collection
+    #
+    # Returns an array of all the associated objects. An empty array is returned
+    # if none are found.
+    # TODO: add force_reload argument?
+    define_method :"#{association_name}" do
+      find_or_create_deferred_association(association_name)
+      send(:"deferred_#{association_name}")
+    end
+
+    # collection=objects
+    #
+    # 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)
+      send(:"deferred_#{association_name}").objects = objects
+    end
+
+    # collection_singular_ids=
+    #
+    # 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)
+
+      klass = self.class.reflect_on_association(:"#{association_name}").klass
+      objects = klass.find(ids.reject(&:blank?))
+      send(:"deferred_#{association_name}").objects = objects
+    end
+
+    # collection_singular_ids
+    #
+    # Returns an array of the associated objects' ids.
+    define_method :"#{association_name.singularize}_ids" do
+      find_or_create_deferred_association(association_name)
+      send(:"deferred_#{association_name}").ids
+    end
+
+    # collection_singalur_checked
+    attr_accessor :"#{association_name}_checked"
+    # collection_singalur_checked=
+    define_method(:"#{association_name}_checked=") do |ids|
+      send(:"#{association_name.singularize}_ids=", ids.split(','))
+    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
+      run_callbacks :"deferred_#{association_name}_save" do
+        find_or_create_deferred_association(association_name)
+
+        # Send the objects of our delegated association to the original
+        # association and store the result.
+        send(:"original_#{association_name}=", send(:"deferred_#{association_name}").objects)
+        send(:"deferred_#{association_name}").objects.each do |record|
+          record.run_callbacks :commit
+        end
+
+        # Store the new value of the association into our delegated association.
+        send(
+          :"deferred_#{association_name}=",
+          DeferredAssociation.new(send(:"original_#{association_name}"), self, association_name))
+      end
+    end
+
+    define_method :"reload_with_deferred_#{association_name}" do |*args|
+      find_or_create_deferred_association(association_name)
+
+      send(:"reload_without_deferred_#{association_name}", *args).tap do
+        send(
+          :"deferred_#{association_name}=",
+          DeferredAssociation.new(send(:"original_#{association_name}"), self, association_name))
+      end
+    end
+    alias_method_chain :reload, :"deferred_#{association_name}"
+
+    generate_find_or_create_deferred_association_method
+  end
+
+  def generate_find_or_create_deferred_association_method
+    define_method :find_or_create_deferred_association do |name|
+      if send(:"deferred_#{name}").nil?
+        send(
+          :"deferred_#{name}=",
+          DeferredAssociation.new(send(:"original_#{name}"), self, name))
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send(:extend, Deferring)

data/lib/deferring/deferred_association.rb

@@ -0,0 +1,187 @@
+# encoding: UTF-8
+
+require 'delegate'
+
+module Deferring
+  class DeferredAssociation < SimpleDelegator
+    # TODO: Write tests for enumerable.
+    include Enumerable
+
+    attr_reader :load_state
+
+    def initialize(original_association, obj, name)
+      super(original_association)
+      @name = name
+      @obj = obj
+      @load_state = :ghost
+    end
+
+    alias_method :original_association, :__getobj__
+
+    delegate :to_s, :to_a, :inspect, :==, # methods undefined by SimpleDelegator
+             :is_a?, :as_json,
+
+             :[], :clear, :reject, :reject!, :flatten, :flatten!, :sort!,
+             :empty?, :size, :length, # methods on Array
+
+             to: :objects
+
+    def each(&block)
+      objects.each(&block)
+    end
+
+    # TODO: Add explanation about :first/:last loaded? problem.
+    [:first, :last].each do |method|
+      define_method method do
+        unless objects_loaded?
+          original_association.send(method)
+        else
+          objects.send(method)
+        end
+      end
+    end
+
+    def find(*args)
+      original_association.find(*args)
+    end
+
+    def select(value = Proc.new)
+      if block_given?
+        objects.select { |*block_args| value.call(*block_args) }
+      else
+        original_association.select(value)
+      end
+    end
+
+    # Rails 3.0 specific, not needed anymore for Rails 3.0+
+    def set_inverse_instance(associated_record, parent_record)
+      original_association.__send__(:set_inverse_instance, associated_record, parent_record)
+    end
+
+    def association
+      load_objects
+      original_association
+    end
+
+    def objects
+      load_objects
+      @objects
+    end
+
+    def original_objects
+      load_objects
+      @original_objects
+    end
+
+    def objects=(records)
+      @objects = records
+      @original_objects = original_association.to_a.clone
+      objects_loaded!
+
+      pending_deletes.each do |record|
+        # TODO: I don't like the fact that we know something about @obj in here.
+        #       Refactor to remove that (some kind of notification), it looks
+        #       terrible this way ;(
+        @obj.instance_variable_set(:"@deferred_#{@name.singularize}_remove", record)
+        @obj.run_callbacks :"deferred_#{@name.singularize}_remove"
+        @obj.send(:remove_instance_variable, :"@deferred_#{@name.singularize}_remove")
+      end
+
+      pending_creates.each do |record|
+        @obj.instance_variable_set(:"@deferred_#{@name.singularize}_add", record)
+        @obj.run_callbacks :"deferred_#{@name.singularize}_add"
+        @obj.send(:remove_instance_variable, :"@deferred_#{@name.singularize}_add")
+      end
+
+      @objects
+    end
+
+    def ids
+      objects.map(&:id)
+    end
+
+    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|
+        @obj.instance_variable_set(:"@deferred_#{@name.singularize}_add", record)
+        @obj.run_callbacks :"deferred_#{@name.singularize}_add" do
+          objects << record
+        end
+        @obj.send(:remove_instance_variable, :"@deferred_#{@name.singularize}_add")
+      end
+      objects
+    end
+    alias_method :push, :<<
+    alias_method :concat, :<<
+    alias_method :append, :<<
+
+    def delete(records)
+      Array(records).flatten.uniq.each do |record|
+        @obj.instance_variable_set(:"@deferred_#{@name.singularize}_remove", record)
+        @obj.run_callbacks :"deferred_#{@name.singularize}_remove" do
+          objects.delete(record)
+        end
+        @obj.send(:remove_instance_variable, :"@deferred_#{@name.singularize}_remove")
+      end
+      self
+    end
+
+    def build(*args, &block)
+      association.build(*args, &block).tap do |result|
+        objects.push(result)
+        association.reload
+      end
+    end
+
+    def create!(*args, &block)
+      association.create!(*args, &block).tap do |result|
+        @load_state = :ghost
+        load_objects
+      end
+    end
+
+    def reload
+      original_association.reload
+      @load_state = :ghost
+      self
+    end
+    alias_method :reset, :reload
+
+    # Returns the associated records to which links will be created after saving
+    # the parent of the association.
+    def pending_creates
+      return [] unless objects_loaded?
+      objects - original_objects
+    end
+    alias_method :links, :pending_creates
+
+    # Returns the associated records to which the links will be deleted after
+    # saving the parent of the assocation.
+    def pending_deletes
+      # TODO: Write test for it.
+      return [] unless objects_loaded?
+      original_objects - objects
+    end
+    alias_method :unlinks, :pending_deletes
+
+    private
+
+    def load_objects
+      return if objects_loaded?
+
+      @objects = original_association.to_a.clone
+      @original_objects = @objects.clone.freeze
+      objects_loaded!
+    end
+
+    def objects_loaded?
+      @load_state == :loaded
+    end
+
+    def objects_loaded!
+      @load_state = :loaded
+    end
+
+  end
+end