save_queue 0.1.0 → 0.2.0

data/README.md

@@ -11,11 +11,11 @@ Usage
 
 How to start:
 
-1. include SavedQueue:
+1. include SaveQueue:
 
-        require 'saved_queue'
+        require 'save_queue'
         class Artice
-          include SavedQueue
+          include SaveQueue
         end
 
 2. call \#mark_as_saved method when object gets dirty:
@@ -36,20 +36,22 @@ How to start:
           end
         end
 
-4.  Save Queue forced you to use valid? method, this should be changes in future and extracted to a module:
+4.  If you want to use validation, include SaveQueue::Plugins::Validation and implement #valid? method. You may got failed objects by save_queue.objects_with_errors
 
         class Artice
+          include SaveQueue::Plugins::Validation
+
           # @return [boolean]
           def valid?
             true
           end
         end
 
-5. add SavedQueue to some other classes:
+5. add SaveQueue to some other classes:
 
-        require 'saved_queue'
+        require 'save_queue'
         class Tag
-          include SavedQueue
+          include SaveQueue
         end
 
         class Artice
@@ -78,6 +80,8 @@ How to start:
 
 7. Handle errors
 
+  7.1. You did not include SaveQueue::Plugins::Validation:
+
         begin
           article.save
         rescue SaveQueue::FailedSaveError => save_error
@@ -89,6 +93,13 @@ How to start:
           save_error.context
         end
 
+  7.2. You've included SaveQueue::Plugins::Validation:
+
+        # Note nothing was actually saved. You dont need to do a cleanup
+        unless article.save then
+          failed_objects = article.saved_query.objects_with_errors
+        end
+
 
 
 If you have custom logic for marking objects dirty then you may want to override
@@ -103,9 +114,6 @@ method \#mark_as_saved becomes useless in this case and you should mark objects
 
 Note: Today Save Queue use only #save method to perform save actions on an objects, but later this should be changed to custom option.
 
-Note: Save Queue forced you to use valid? method, this should be changes in future and extracted to a module
-
-
 Requirements
 ------------
 none, rspec2 for testing

data/lib/save_queue/object.rb

@@ -2,13 +2,20 @@ require "save_queue/queue"
 
 module SaveQueue
   module Object
+    #class_inheritable_accessor :queue_class
+    def self.included base
+      base.class_eval do
+        class<<self
+          attr_accessor :queue_class
+        end
+
+        self.queue_class = Queue
+      end
+    end
 
     module RunAlwaysFirst
       # @return [Boolean]
       def save(*args)
-        # are objects in queue valid?
-        return false unless valid?
-        return false unless save_queue.valid?
         #return false if defined?(super) and false == super
 
         super_saved = true
@@ -23,7 +30,7 @@ module SaveQueue
 
     def initialize(*args)
       super if defined?(super)
-      queue = Queue.new
+      queue = self.class.queue_class.new
       instance_variable_set "@_save_queue", queue
 
       # this will make RunAlwaysFirst methods triggered first in inheritance tree

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

@@ -1,13 +1,23 @@
 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?
 
-        # @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

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

@@ -0,0 +1,34 @@
+require "save_queue/queue"
+module SaveQueue
+  module Plugins
+    module Validation
+      class Queue < ::SaveQueue::Queue
+        attr_reader :objects_with_errors
+
+        def initialize(*args)
+          @objects_with_errors = []
+          super
+        end
+
+        def valid?
+          @objects_with_errors = []
+          @queue.each do |object|
+            @objects_with_errors << object unless object.valid?
+          end
+
+          @objects_with_errors.empty?
+        end
+
+        def validate!
+          raise FailedValidationError, @objects_with_errors unless valid?
+
+          true
+        end
+
+        def errors
+          @objects_with_errors.map(&:errors).reduce(:+)
+        end
+      end
+    end
+  end
+end

data/lib/save_queue/plugins/validation.rb

@@ -0,0 +1,28 @@
+require "save_queue/queue"
+
+require "save_queue/plugins/validation/object"
+require "save_queue/plugins/validation/queue"
+
+
+module SaveQueue
+  module Plugins
+    module Validation
+      def self.included base
+        # must be included after SaveQueue::Object
+        base.send :include, Validation::Object
+        base.queue_class = Validation::Queue
+      end
+
+      class FailedValidationError < RuntimeError
+        attr_reader :failed_objects
+        def initialize(failed_objects)
+          @failed_objects = Array(failed_objects)
+        end
+
+        def to_s # Some default way to display errors
+          "#{super}: " + @failed_objects.map{|object| "\"#{object.to_s}\": " + object.errors.full_messages.join(', ')}.join("\n")
+        end
+      end
+    end
+  end
+end

data/lib/save_queue/queue.rb

@@ -30,12 +30,6 @@ module SaveQueue
 
       true
     end
-
-    def valid?
-      @queue.all? do |object|
-        object.valid?
-      end
-    end
   end
 
   class FailedSaveError < RuntimeError

data/lib/save_queue/version.rb

@@ -1,3 +1,3 @@
 module SaveQueue
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/save_queue.rb

@@ -5,6 +5,4 @@ module SaveQueue
   def self.included base
     base.send :include, SaveQueue::Object
   end
-
-
 end

data/spec/save_queue_usage_spec.rb

@@ -1,9 +1,4 @@
-require "save_queue"
-module Tests
-  class Object
-    include SaveQueue
-  end
-end
+require "spec_helper"
 
 # TODO split by Object and Queue
 describe "SaveQueue usage" do
@@ -28,7 +23,10 @@ describe "SaveQueue usage" do
     end
 
     it "should return false for new object" do
-      Tests::Object.new.should_not have_unsaved_changes
+      klass = Class.new
+      klass.send :include, SaveQueue
+
+      klass.new.should_not have_unsaved_changes
     end
   end
 
@@ -58,7 +56,7 @@ describe "SaveQueue usage" do
     end
   end
 
-  describe "add_all" do
+  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]
@@ -151,38 +149,6 @@ describe "SaveQueue usage" do
       @base.save.should be_true
     end
 
-    context "invalid caller" do
-      it "should not save queue" do
-        @base.save_queue.add @related_object
-
-        @base.stub(:valid?).and_return(false)
-
-        @related_object.should_not_receive(:save)
-        @base.save.should be_false
-
-        #@base.stub(:valid?).and_return(true)
-        #@related_object.should_receive(:save).once.and_return(true)
-        #@base.save.should be_true
-      end
-    end
-
-    describe "invalid object in queue" do
-      it "should not save queue and caller" do
-        invalid = new_mock_object :invalid
-        invalid.stub(:valid?).and_return(false)
-
-        valid = new_mock_object :valid
-        valid.stub(:valid?).and_return(true)
-
-        @base.save_queue.add invalid
-        @base.save_queue.add valid
-
-        invalid.should_not_receive(:save)
-        valid.should_not_receive(:save)
-        @base.save.should be_false
-      end
-    end
-
     describe "multiple callers" do
       before(:each) do
         @base2 = new_object
@@ -269,11 +235,27 @@ describe "SaveQueue usage" do
     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
+  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(:valid?).and_return(true)
     bad_object.stub(:save).and_return(true)
     bad_object.stub(:has_unsaved_changes?).and_return(true)
 
@@ -281,12 +263,12 @@ describe "SaveQueue usage" do
   end
 
   def new_object
-    object = Tests::Object.new
-    object.stub(:valid?).and_return(true)
+    klass = Class.new
+    klass.send :include, SaveQueue
+
+    object = klass.new
     object.mark_as_changed
 
     object
   end
-
-
 end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require "save_queue"
+Dir[File.dirname(File.expand_path(__FILE__)) + "/support/**/*.rb"].each {|f| require f}

data/spec/support/mock_helpers.rb

@@ -0,0 +1,17 @@
+#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

data/spec/validation_spec.rb

@@ -0,0 +1,126 @@
+require "spec_helper"
+require "save_queue/plugins/validation"
+
+describe SaveQueue::Plugins::Validation do
+  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::Object do
+    before(:each) do
+      @base = new_object
+    end
+
+    context "valid object and caller" do
+      before(:each) do
+        @base.save_queue.add @valid
+        @base.stub(:valid?).and_return(true)
+      end
+
+      it "should save caller" do
+        @base.save.should be_true
+      end
+
+      it "should save queue" do
+        @valid.should_receive(:save)
+
+        @base.save
+      end
+    end
+
+    context "invalid caller" do
+      it "should not save queue" do
+        @base.save_queue.add @valid
+
+        @base.stub(:valid?).and_return(false)
+
+        @valid.should_not_receive(:save)
+        @base.save.should be_false
+      end
+    end
+
+    context "invalid object in queue" do
+      before(:each) do
+        @base.save_queue.add @valid
+        @base.save_queue.add @invalid
+      end
+
+      it "should not save caller" do
+        @base.save.should be_false
+      end
+
+      it "should not save queue" do
+        @invalid.should_not_receive(:save)
+        @valid.should_not_receive(:save)
+
+        @base.save
+      end
+    end
+  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! }.to_not raise_error SaveQueue::Plugins::Validation::FailedValidationError
+
+        @save_queue.validate!.should be_true
+      end
+    end
+  end
+
+  describe "#integration" do
+    before(:each) do
+      @klass = Class.new
+      @klass.send :include, SaveQueue
+      @klass.send :include, SaveQueue::Plugins::Validation
+    end
+    it "should set query_class to SaveQueue::Plugins::Validation::Queue" do
+      @klass.queue_class.should == SaveQueue::Plugins::Validation::Queue
+    end
+
+    it "should mix SaveQueue::Plugins::Validation::Object" do
+      @klass.should include SaveQueue::Plugins::Validation::Object
+    end
+  end
+
+  private
+  def new_object
+    klass = Class.new
+    klass.send :include, SaveQueue
+    klass.send :include, SaveQueue::Plugins::Validation
+
+    object = klass.new
+    object.stub(:valid?).and_return(true)
+    object.mark_as_changed
+
+    object
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: save_queue
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-15 00:00:00.000000000Z
+date: 2011-11-16 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &23937520 !ruby/object:Gem::Requirement
+  requirement: &5065560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '2.6'
   type: :development
   prerelease: false
-  version_requirements: *23937520
+  version_requirements: *5065560
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &23936900 !ruby/object:Gem::Requirement
+  requirement: &5059980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *23936900
+  version_requirements: *5059980
 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.
@@ -52,12 +52,16 @@ files:
 - Rakefile
 - lib/save_queue.rb
 - lib/save_queue/object.rb
+- lib/save_queue/plugins/validation.rb
 - lib/save_queue/plugins/validation/object.rb
 - lib/save_queue/plugins/validation/queue.rb
 - lib/save_queue/queue.rb
 - lib/save_queue/version.rb
 - save_queue.gemspec
 - spec/save_queue_usage_spec.rb
+- spec/spec_helper.rb
+- spec/support/mock_helpers.rb
+- spec/validation_spec.rb
 homepage: http://github.com/AlexParamonov/save_queue
 licenses: []
 post_install_message: 
@@ -78,7 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: save_queue
-rubygems_version: 1.8.10
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: Push related objects to a queue for delayed save