save_queue 0.2.3 → 0.3.0

data/spec/validation/queue_spec.rb

@@ -0,0 +1,139 @@
+require "spec_helper"
+require "save_queue/plugins/validation/queue"
+
+class ValidQueue < SaveQueue::ObjectQueue
+  include SaveQueue::Plugins::Validation::Queue
+end
+
+
+describe ValidQueue do
+  let(:queue) { ValidQueue.new }
+
+  context "contains valid objects" do
+    let(:valid_objects) do
+      3.times.map do
+        new_velement(:valid => true)
+      end
+    end
+
+    before(:each) do
+      queue.add_all valid_objects
+    end
+
+    describe "#save" do
+      it "should save all of them" do
+        valid_objects.each{|o| o.should_receive(:save).once}
+        queue.save.should be_true
+      end
+
+      it "should not has any errors" do
+        queue.save.should be_true
+        queue.errors.should be_empty
+      end
+    end
+
+    describe "#save!" do
+      it "should save all of them" do
+        valid_objects.each{|o| o.should_receive(:save).once}
+        queue.save!
+      end
+
+      it "should not raise any exception" do
+        expect { queue.save! }.not_to raise_error
+      end
+
+      it "should not has any errors" do
+        queue.save!
+        queue.errors.should be_empty
+      end
+    end
+  end
+
+
+  describe "contains invalid objects" do
+    let(:invalid_objects) do
+      3.times.map do
+        new_velement(:valid => false)
+      end
+    end
+
+    before(:each) do
+      queue.add_all invalid_objects
+    end
+
+    describe "#save" do
+      it "should not saved them" do
+        invalid_objects.each{|o| o.should_not_receive(:save)}
+        queue.save.should be_false
+      end
+
+      it "should set errors" do
+        queue.save.should be_false
+        queue.errors[:validation].should_not be_empty
+      end
+    end
+
+    describe "#save!" do
+      it "should not saved them" do
+        invalid_objects.each do |o|
+          o.as_null_object
+          o.should_not_receive(:save)
+        end
+
+        expect {queue.save!}.to raise_error
+      end
+
+      it "should raise SaveQueue::FailedValidationError exception" do
+        expect { queue.save! }.to raise_error(SaveQueue::FailedValidationError)
+      end
+
+      it "should set errors" do
+        expect{queue.save!}.to raise_error
+        queue.errors[:validation].should_not be_empty
+      end
+    end
+  end
+
+
+  #before(:each) do
+  #  @invalid = new_object
+  #  @invalid.stub(:valid?).and_return(false)
+  #  @valid = new_object
+  #  @valid.stub(:valid?).and_return(true)
+  #end
+
+  #describe SaveQueue::Plugins::Validation::Queue do
+  #  before(:each) do
+  #    @save_queue = SaveQueue::Plugins::Validation::Queue.new
+  #  end
+  #
+  #  describe "#valid?" do
+  #    it "should set objects_with_errors" do
+  #      @save_queue.add @invalid
+  #      @save_queue.add @valid
+  #
+  #      @save_queue.valid?.should be_false
+  #
+  #      @save_queue.objects_with_errors.should include @invalid
+  #      @save_queue.objects_with_errors.should_not include @valid
+  #    end
+  #  end
+  #
+  #  describe "#validate!" do
+  #    it "should raise FailedValidationError if failed to save objects" do
+  #      @save_queue.add @invalid
+  #      @save_queue.add @valid
+  #
+  #      expect{ @save_queue.validate! }.to raise_error SaveQueue::Plugins::Validation::FailedValidationError
+  #    end
+  #
+  #    it "should return true if objects were valid" do
+  #      @save_queue.add @valid
+  #
+  #      expect{ @save_queue.validate! }.not_to raise_error SaveQueue::Plugins::Validation::FailedValidationError
+  #
+  #      @save_queue.validate!.should be_true
+  #    end
+  #  end
+  #end
+end

data/spec/validation/validation_spec.rb

@@ -0,0 +1,42 @@
+require "spec_helper"
+require "save_queue/plugins/validation"
+
+describe SaveQueue::Plugins::Validation do
+  describe "#integration" do
+    it "should mix Queue to object's save_queue" do
+      klass = new_class
+      klass.send :include, SaveQueue::Plugins::Validation
+
+      klass.queue_class.should include SaveQueue::Plugins::Validation::Queue
+    end
+
+    it "should not change original SaveQueue::*Queue class" do
+      klass = new_class
+      old_queue = klass.queue_class
+      klass.queue_class = Class.new(old_queue)
+      
+      klass.send :include, SaveQueue::Plugins::Validation
+      old_queue.should_not include SaveQueue::Plugins::Validation::Queue
+    end
+  end
+
+  describe "workflow" do
+    let(:object) do
+      klass = new_class
+      klass.send :include, SaveQueue::Plugins::Validation
+      klass.new
+    end
+
+    describe "#save" do
+      it "should not return false if save_queue was saved" do
+        object.save_queue << new_velement(:valid => true)
+        object.save.should_not be_false
+      end
+
+      it "should return false if save_queue was not saved" do
+        object.save_queue << new_velement(:valid => false)
+        object.save.should be_false
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: save_queue
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-19 00:00:00.000000000Z
+date: 2012-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &18192820 !ruby/object:Gem::Requirement
+  requirement: &7350280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '2.6'
   type: :development
   prerelease: false
-  version_requirements: *18192820
+  version_requirements: *7350280
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &18192160 !ruby/object:Gem::Requirement
+  requirement: &7366200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *18192160
+  version_requirements: *7366200
 - !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: &18190480 !ruby/object:Gem::Requirement
+  name: hooks
+  requirement: &7365720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,11 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *18190480
-description: Save Queue allows to push related objects to an object's queue for delayed
-  save, that will triggered on object#save. In this case object wil store all related
-  information on its save.
+  version_requirements: *7365720
+description: ! 'Save Queue allows to push objects to other object''s queue for a delayed
+  save.
+
+  Queue save will be triggered by object#save.'
 email:
 - alexander.n.paramonov@gmail.com
 executables: []
@@ -56,23 +57,38 @@ files:
 - .gitignore
 - .rspec
 - .travis.yml
+- CONTRIBUTING.md
 - Gemfile
 - HISTORY.md
 - LICENSE
 - README.md
 - Rakefile
 - lib/save_queue.rb
+- lib/save_queue/exceptions.rb
 - lib/save_queue/object.rb
+- lib/save_queue/object_queue.rb
+- lib/save_queue/plugins/notification.rb
+- lib/save_queue/plugins/notification/object.rb
+- lib/save_queue/plugins/notification/queue.rb
 - lib/save_queue/plugins/validation.rb
-- lib/save_queue/plugins/validation/object.rb
+- lib/save_queue/plugins/validation/exceptions.rb
 - lib/save_queue/plugins/validation/queue.rb
-- lib/save_queue/queue.rb
+- lib/save_queue/ruby1.9/observer.rb
+- lib/save_queue/uniq_queue.rb
 - lib/save_queue/version.rb
 - save_queue.gemspec
-- spec/save_queue_usage_spec.rb
+- spec/notification/notification_spec.rb
+- spec/notification/object_spec.rb
+- spec/notification/queue_spec.rb
+- spec/object_queue_spec.rb
+- spec/object_spec.rb
+- spec/save_queue_spec.rb
 - spec/spec_helper.rb
-- spec/support/mock_helpers.rb
-- spec/validation_spec.rb
+- spec/support/object_helpers.rb
+- spec/support/queue_helpers.rb
+- spec/uniq_queue_spec.rb
+- spec/validation/queue_spec.rb
+- spec/validation/validation_spec.rb
 homepage: http://github.com/AlexParamonov/save_queue
 licenses: []
 post_install_message: 
@@ -93,9 +109,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: save_queue
-rubygems_version: 1.8.11
+rubygems_version: 1.8.13
 signing_key: 
 specification_version: 3
-summary: Push related objects to a queue for delayed save
+summary: Push related objects to a queue for a delayed save
 test_files: []
-has_rdoc: 

data/lib/save_queue/plugins/validation/object.rb

@@ -1,25 +0,0 @@
-module SaveQueue
-  module Plugins
-    module Validation
-      # Should be included AFTER SaveQueue
-      module Object
-        module RunAlwaysFirst
-          # @return [Boolean]
-          def save(*args)
-            # are objects in queue valid?
-            return false unless valid?
-            return false unless save_queue.valid?
-
-            super
-          end
-        end
-
-        def initialize(*args)
-          super
-          # this will make RunAlwaysFirst methods triggered first in inheritance tree
-          extend RunAlwaysFirst
-        end
-      end
-    end
-  end
-end

data/lib/save_queue/queue.rb

@@ -1,45 +0,0 @@
-module SaveQueue
-  class Queue
-    def initialize
-      @queue = []
-    end
-
-    def add_all objects
-      Array(objects).each do |object|
-        add object
-      end
-    end
-
-    def add object
-      raise ArgumentError, "#{object.inspect} does not include SaveQueue::Object" unless object.class.include? SaveQueue::Object
-      @queue << object unless @queue.include? object
-    end
-
-    def save
-      saved = []
-      @queue.each do |object|
-        if object.has_unsaved_changes?
-
-          result = object.save
-          raise FailedSaveError, {:saved => saved, :failed => object, :pending => @queue - (saved + [object])} if false == result
-
-          saved << object
-        end
-      end
-      @queue = []
-
-      true
-    end
-  end
-
-  class FailedSaveError < RuntimeError
-    attr_reader :context
-    def initialize(context_hash)
-      @context = context_hash
-    end
-
-    def to_s # Some default way to display errors
-      "#{super}: " + @context.to_s
-    end
-  end
-end

data/spec/save_queue_usage_spec.rb

@@ -1,311 +0,0 @@
-require "spec_helper"
-
-# TODO split by Object and Queue
-describe "SaveQueue usage" do
-  before(:each) do
-    @base = new_object
-    @related_object = new_object
-  end
-
-  describe "#has_unsaved_changes?" do
-    it "should return true for changed object" do
-      @base.save
-      @base.should_not have_unsaved_changes
-      @base.mark_as_changed
-      @base.should have_unsaved_changes
-    end
-
-    it "should return false for saved object" do
-      @base.mark_as_changed
-      @base.should have_unsaved_changes
-      @base.save
-      @base.should_not have_unsaved_changes
-    end
-
-    it "should return false for new object" do
-      klass = Class.new
-      klass.send :include, SaveQueue
-
-      klass.new.should_not have_unsaved_changes
-    end
-  end
-
-  describe "#add" do
-    it "should ignore same objects in queue" do
-      @base.save_queue.add @related_object
-      @base.save_queue.add @related_object
-      @base.save_queue.add @related_object
-
-      @related_object.should_receive(:save).once.and_return(true)
-      @base.save.should be_true
-      @base.save.should be_true
-    end
-
-    it "should raise ArgumentError if object does not include SavedQueue" do
-      object = new_mock_object :without_include
-      object.stub_chain(:class, :include?).with(SaveQueue::Object).and_return(false)
-
-      expect{ @base.save_queue.add object }.to raise_error ArgumentError, "#{object.inspect} does not include SaveQueue::Object"
-    end
-
-    it "should not raise ArgumentError if object includes SavedQueue" do
-      object = new_mock_object :with_include
-      object.stub_chain(:class, :include?).with(SaveQueue::Object).and_return(true)
-
-      expect{ @base.save_queue.add object }.to_not raise_error ArgumentError, "#{object.inspect} does not include SaveQueue::Object"
-    end
-  end
-
-  describe "#add_all" do
-    it "should delegate to #add" do
-      @base.save_queue.should_receive(:add).exactly(3).times
-      @base.save_queue.add_all [1,2,3]
-    end
-  end
-
-  describe "#save" do
-    it "should raise SaveQueue::FailedSaveError if at least one object in queue is not saved" do
-      @base.save_queue.add @related_object
-      bad_object = new_mock_object :bad_object
-      bad_object.stub(:save).and_return(false)
-
-      @base.save_queue.add bad_object
-
-
-      expect{ @base.save_queue.save }.to raise_error SaveQueue::FailedSaveError
-      #, {:saved   => [@related_object],
-      #                                                                            :failed  => bad_object,
-      #                                                                            :pending => []}
-    end
-
-    it "should save assigned object" do
-      @base.save_queue.add @related_object
-
-      @related_object.should_receive(:save).once.and_return(true)
-      @base.save.should be_true
-    end
-
-    it "only 1st save will save the queue" do
-      @base.save_queue.add @related_object
-
-      @related_object.should_receive(:save).once.and_return(true)
-      @base.save.should be_true
-      @base.save.should be_true
-    end
-
-    it "should not circle" do
-      object = new_object
-
-      @base.mark_as_changed
-
-      object.save_queue.add @base
-      @base.save_queue.add object
-
-      $object_counter = mock :counter
-      $object_counter.should_receive(:increment).once
-
-      def object.save
-        result = super
-        $object_counter.increment
-
-        result
-      end
-
-      $base_counter = mock :counter
-      $base_counter.should_receive(:increment).once
-
-      def @base.save
-        result = super
-        $base_counter.increment
-
-        result
-      end
-
-
-
-      #object.should_receive(:save).once.and_return(true)
-      #@base.should_receive(:save).once.and_return(true)
-      @base.save.should be_true
-    end
-
-    it "should save only unsaved objects" do
-      object = new_object
-
-      @base.save_queue.add object
-      object.save
-
-      object.should_not_receive(:save)
-      @base.save_queue.save.should be_true
-    end
-
-    it "should save and object if it had changed state" do
-      object = new_object
-
-      @base.save_queue.add object
-      object.save
-      object.mark_as_changed
-
-      object.should_receive(:save).once.and_return(true)
-      @base.save.should be_true
-    end
-
-    describe "multiple callers" do
-      before(:each) do
-        @base2 = new_object
-      end
-
-      it "should save assigned object only once" do
-        object = new_object
-
-        @base.save_queue.add object
-        @base2.save_queue.add object
-
-        $counter = mock :counter
-        $counter.should_receive(:increment).once
-
-        def object.save
-          result = super
-          $counter.increment
-
-          result
-        end
-
-        #object.should_receive(:save).once.and_return(true)
-        @base.save.should be_true
-        @base2.save.should be_true
-      end
-
-      it "should correctly save all objects once" do
-
-        $base_counters = []
-        3.times do |index|
-          object = new_object
-          $base_counters[index] = mock :counter
-          $base_counters[index].should_receive(:increment).once
-          eval %{
-            def object.save
-              result = super
-              $base_counters[#{index}].increment
-
-              result
-            end
-          }
-
-          @base.save_queue.add object
-        end
-
-        $base2_counters = []
-        2.times do |index|
-          object = new_object
-          $base2_counters[index] = mock :counter
-          $base2_counters[index].should_receive(:increment).once
-          eval %{
-            def object.save
-              result = super
-              $base2_counters[#{index}].increment
-
-              result
-            end
-          }
-
-          @base2.save_queue.add object
-        end
-
-        $shared_counters = []
-        2.times do |index|
-          object = new_object
-          $shared_counters[index] = mock :counter
-          $shared_counters[index].should_receive(:increment).once
-          eval %{
-            def object.save
-              result = super
-              $shared_counters[#{index}].increment
-
-              result
-            end
-          }
-
-          @base.save_queue.add object
-          @base2.save_queue.add object
-        end
-
-        @base.save.should be_true
-        @base2.save.should be_true
-      end
-    end
-  end
-
-  describe "queue changes" do
-    it "should be able to change queue class before initialization" do
-      klass = Class.new
-      klass.send :include, SaveQueue
-      object = klass.new
-      object.save_queue.should be_a SaveQueue::Queue
-
-      other = Class.new(SaveQueue::Queue)
-      klass.queue_class = other
-      klass.new.save_queue.should be_kind_of other
-
-      object.class.queue_class = other
-      object.save_queue.should_not be_kind_of other
-      object.save_queue.should be_a SaveQueue::Queue
-    end
-
-    describe "inheritance" do
-      it "should inherit settings of parent class" do
-        klass = Class.new
-        klass.send :include, SaveQueue
-
-        klass.queue_class.should == SaveQueue::Queue
-
-        child = Class.new(klass)
-        child.queue_class.should == SaveQueue::Queue
-      end
-
-      it "should not override settings of parent class" do
-        klass = Class.new
-        klass.send :include, SaveQueue
-        klass.queue_class.should == SaveQueue::Queue
-
-        child = Class.new(klass)
-        child.queue_class = Integer
-        child.queue_class.should == Integer
-
-        klass.queue_class.should == SaveQueue::Queue
-      end
-
-
-      it "include SaveQueue should not override settings of parent class" do
-        klass = Class.new
-        klass.send :include, SaveQueue
-        klass.queue_class = Integer
-
-        klass.queue_class.should == Integer
-
-        child = Class.new(klass)
-        child.send :include, SaveQueue
-        child.queue_class.should == Integer
-      end
-    end
-  end
-
-  private
-  def new_mock_object name
-    bad_object = mock name
-    bad_object.stub_chain(:class, :include?).with(SaveQueue::Object).and_return(true)
-    bad_object.stub(:save).and_return(true)
-    bad_object.stub(:has_unsaved_changes?).and_return(true)
-
-    bad_object
-  end
-
-  def new_object
-    klass = Class.new
-    klass.send :include, SaveQueue
-
-    object = klass.new
-    object.mark_as_changed
-
-    object
-  end
-end

data/spec/support/mock_helpers.rb

@@ -1,17 +0,0 @@
-#def new_mock_object name
-#  bad_object = mock name
-#  bad_object.stub_chain(:class, :include?).with(SaveQueue::Object).and_return(true)
-#  bad_object.stub(:valid?).and_return(true)
-#  bad_object.stub(:save).and_return(true)
-#  bad_object.stub(:has_unsaved_changes?).and_return(true)
-#
-#  bad_object
-#end
-#
-#def new_object
-#  object = Tests::Object.new
-#  object.stub(:valid?).and_return(true)
-#  object.mark_as_changed
-#
-#  object
-#end