save_queue 0.3.0 → 0.4.0

data/lib/save_queue/object_queue.rb

@@ -14,21 +14,22 @@ module SaveQueue
     define_hook :before_add
     define_hook :after_add
 
+    before_add :check_requirements
+
     # @return [Hash] save
-    # @option save [Array<Object>] :processed
     # @option save [Array<Object>] :saved
     # @option save [Object]        :failed
     # @option save [Array<Object>] :pending
     attr_reader :errors
+
     def initialize(*args)
       super
       @errors = {}
     end
 
     def add object
-      run_hook :before_add
+      run_hook :before_add, object
 
-      check_requirements_for object
       result = super object
 
       run_hook :after_add, result, object
@@ -36,13 +37,6 @@ module SaveQueue
       result
     end
 
-    def << object
-      add object
-      self
-    end
-
-    alias_method :push, :add
-
     def save
       save!
       true
@@ -52,34 +46,28 @@ module SaveQueue
 
     def save!
       run_hook :before_save
+
       @errors = {}
       saved     = []
-      processed = []
 
       @queue.each do |object|
-        if object.has_unsaved_changes?
-
-          result = object.save
-          if false == result
-            @errors[:save] = {:processed => processed, :saved => saved, :failed => object, :pending => @queue - (saved + [object])}
-            raise FailedSaveError, errors[:save]
-          end
-
-          saved << object
+        if false == object.save
+          @errors[:save] = {:saved => saved, :failed => object, :pending => @queue - (saved + [object])}
+          raise FailedSaveError, errors[:save]
         end
-        processed << object
-      end
 
-      @queue.clear
+        saved << object
+      end
+      clear
 
       run_hook :after_save
+
       true
     end
 
-
     private
-    def check_requirements_for object
-      [:save, :has_unsaved_changes?].each do |method|
+    def check_requirements(object)
+      [:save].each do |method|
         raise ArgumentError, "#{object.inspect} does not respond to ##{method}" unless object.respond_to? method
       end
     end

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

@@ -0,0 +1,31 @@
+module SaveQueue
+  module Plugins
+    module Dirty
+      module Object
+        def mark_as_changed
+          @_changed_mark = true
+        end
+
+        def mark_as_saved
+          @_changed_mark = false
+        end
+
+        # @returns [Boolean] true if object has been modified
+        def has_unsaved_changes?
+          @_changed_mark ||= false
+        end
+
+        private
+        def _sq_around_original_save
+          result = nil
+          if has_unsaved_changes?
+            result = yield
+            mark_as_saved
+          end
+
+          result
+        end
+      end
+    end
+  end
+end

data/lib/save_queue/plugins/dirty.rb

@@ -0,0 +1,11 @@
+require "save_queue/plugins/dirty/object"
+
+module SaveQueue
+  module Plugins
+    module Dirty
+      def self.included base
+        base.send :include, Dirty::Object unless base.include? Dirty::Object
+      end
+    end
+  end
+end

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

@@ -2,32 +2,14 @@ module SaveQueue
   module Plugins
     module Notification
       module Object
-        module AddObserverToQueue
-          def create_queue
-            super
-            queue = instance_variable_get("@_save_queue")
-            raise "save queue should respond to add_observer in order to work correctly" unless queue.respond_to? :add_observer
-            queue.add_observer(self, :queue_changed_event)
-          end
-        end
-        
-        def self.included base
-
-          #queue_creator = Module.new do
-          #  def create_queue
-          #    super
-          #    queue = instance_variable_get("@_save_queue")
-          #    raise "save queue should respond to add_observer in order to work correctly" unless queue.respond_to? :add_observer
-          #    queue.add_observer(self, :queue_changed_event)
-          #  end
-          #end
+        def queue_changed_event(result, object, *args); end
 
-          #base.send :include, queue_creator
-          base.send :include, AddObserverToQueue unless base.include?(AddObserverToQueue)
-        end
+        def create_queue
+          super
 
-        def queue_changed_event(result, object)
-          mark_as_changed if result
+          queue = instance_variable_get("@_save_queue")
+          raise "save queue should respond to add_observer in order to work correctly" unless queue.respond_to? :add_observer
+          queue.add_observer(self, :queue_changed_event)
         end
       end
     end

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

@@ -9,8 +9,8 @@ module SaveQueue
     module Notification
       module Queue
         def self.included base
-          base.send :include, Observable unless base.include? Observable
-          base.after_add :change_and_notify # if base.respond_to? :after_add
+          base.send :include, Observable
+          base.after_add :change_and_notify
         end
 
         private
@@ -18,7 +18,6 @@ module SaveQueue
           changed
           notify_observers(*args)
         end
-
       end
     end
   end

data/lib/save_queue/plugins/notification.rb

@@ -6,8 +6,8 @@ module SaveQueue
     module Notification
       def self.included base
         klass = Class.new(base.queue_class)
-        klass.send :include, Notification::Queue unless klass.include? Notification::Queue
-        base.send :include, Notification::Object unless base.include? Notification::Object
+        klass.send :include, Notification::Queue  unless klass.include? Notification::Queue
+        base.send  :include, Notification::Object unless base.include?  Notification::Object
         base.queue_class = klass
       end
     end

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

@@ -1,12 +1,20 @@
 module SaveQueue
   class FailedValidationError < Error
     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")
+
+    # Overwrite to your needs
+    def to_s
+      "#{super}: " + @failed_objects.join("\n")
     end
+
+    # danger if object not respond to errors or full_messages
+    #def to_s
+    #  "#{super}: " + @failed_objects.map{|object| "\"#{object.to_s}\": " + object.errors.full_messages.join(', ')}.join("\n")
+    #end
   end
 end

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

@@ -5,7 +5,7 @@ module SaveQueue
     module Validation
       module Queue
         def self.included base
-          base.before_save :validate! if base.respond_to? :before_save
+          base.before_save :validate!
         end
 
         def valid?

data/lib/save_queue/plugins/validation.rb

@@ -7,7 +7,7 @@ module SaveQueue
     module Validation
       def self.included base
         klass = Class.new(base.queue_class)
-        klass.send :include, Validation::Queue
+        klass.send :include, Validation::Queue unless klass.include? Validation::Queue
         base.queue_class = klass
       end
     end

data/lib/save_queue/uniq_queue.rb

@@ -32,7 +32,15 @@ module SaveQueue
 
       true
     end
-    alias_method :push, :add
-    alias_method :<<,   :add
+
+    #alias_method :push, :add # Not working as expected: does not save inheritance
+    def push(*args)
+      add *args
+    end
+    
+    def << *args
+      add *args
+      self
+    end
   end
 end

data/lib/save_queue/version.rb

@@ -1,3 +1,3 @@
 module SaveQueue
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/spec/dirty/dirty_spec.rb

@@ -0,0 +1,74 @@
+require "spec_helper"
+require "save_queue/plugins/dirty"
+
+describe SaveQueue::Plugins::Dirty do
+  describe "#integration" do
+    it "should mix Object to object class" do
+      klass = new_class
+      klass.send :include, SaveQueue::Plugins::Dirty
+
+      klass.should include SaveQueue::Plugins::Dirty::Object
+    end
+    describe "functional" do
+      it "README example should work" do
+        article = Article.new
+
+        tag_objects = []
+        3.times do
+          tag = Tag.new
+          tag.change_attribute :title, "new tag"
+          tag.should_receive(:save).once
+          tag_objects << tag
+        end
+        article.tags = tag_objects
+
+        tag = Tag.new
+        tag.change_attribute :title, "single tag"
+        tag.should_receive(:save).once
+        article.add_tag tag
+
+        # that will save article and all tags in this article if article
+        # and tags are valid, and if article.save and all tag.save returns true
+        # You may also use #save! method, that will trigger save_queue.save! and
+        # raise SaveQueue::FailedSaveError on fail
+        article.save.should be_true
+      end
+    end
+  end
+end
+
+require 'save_queue'
+class Article
+  include SaveQueue
+  include SaveQueue::Plugins::Dirty
+
+  def change_attribute attr, value
+    @attributes ||= {}
+    @attributes[attr] = value
+    mark_as_changed # call this and object will be marked for save
+  end
+
+  def tags= tag_objects
+    @tags = tag_objects
+    mark_as_changed
+    save_queue.add_all tag_objects
+  end
+
+  def add_tag tag
+    @tags ||= []
+    @tags << tag
+    save_queue.add tag # or use <<, push methods
+  end
+end
+
+
+class Tag
+  include SaveQueue
+  include SaveQueue::Plugins::Dirty
+
+  def change_attribute attr, value
+    @attributes ||= {}
+    @attributes[attr] = value
+    mark_as_changed # call this and object will be marked for save
+  end
+end

data/spec/dirty/object_spec.rb

@@ -0,0 +1,200 @@
+require "spec_helper"
+require "save_queue/plugins/dirty/object"
+
+class DirtyObject
+  include SaveQueue
+  include SaveQueue::Plugins::Dirty::Object
+end
+
+describe SaveQueue::Plugins::Dirty::Object do
+  let(:object) { DirtyObject.new }
+
+  describe "#has_unsaved_changes?" do
+    it "should return true for changed object" do
+      object.mark_as_changed
+      object.has_unsaved_changes?.should eq true
+    end
+
+    it "should return false for unchanged object" do
+      object.mark_as_saved
+      object.has_unsaved_changes?.should eq false
+    end
+
+    it "should return false for new object" do
+      object.has_unsaved_changes?.should eq false
+    end
+  end
+
+  describe "marks" do
+    it "should change state of an object" do
+      object.mark_as_saved
+      object.should_not have_unsaved_changes
+      object.mark_as_changed
+      object.should have_unsaved_changes
+      object.mark_as_saved
+      object.should_not have_unsaved_changes
+    end
+  end
+
+  describe "#save!" do
+    context "changed object" do
+      let(:changed_object) {object.mark_as_changed; object}
+
+      it "should call #save! on queue" do
+        changed_object.save_queue.should_receive(:save!).once
+        changed_object.save!
+      end
+
+      it "should mark object as saved" do
+        changed_object.should_receive(:mark_as_saved).once
+        changed_object.save!
+      end
+
+      context "original class has #save! method defined" do
+        it "should call that method" do
+          changed_object =
+            Class.new(DirtyObject) do
+              attr_reader :save_called
+              def save!
+                @save_called = true
+              end
+            end.new
+
+          changed_object.mark_as_changed
+          expect{ changed_object.save! }.to change { changed_object.save_called }.from(nil).to(true)
+        end
+      end
+    end
+
+    context "not changed object" do
+      let(:not_changed_object) {object.mark_as_saved;   object}
+
+      it "should not mark object as saved" do
+        not_changed_object.should_not_receive(:mark_as_saved)
+        not_changed_object.save!
+      end
+
+      it "should call #save! on queue" do
+        not_changed_object.save_queue.should_receive(:save!).once
+        not_changed_object.save!
+      end
+
+      context "original class has #save! method defined" do
+        it "should not call that method" do
+          not_changed_object =
+            Class.new(DirtyObject) do
+              attr_reader :save_called
+              def save!
+                @save_called = true
+              end
+            end.new
+
+          not_changed_object.mark_as_saved
+          expect{ not_changed_object.save! }.to_not change { not_changed_object.save_called }
+        end
+
+        context "multiple save with changing state" do
+          it "should call that method if state was changed after 1st save" do
+            not_changed_object =
+              Class.new(DirtyObject) do
+                attr_reader :save_called
+                def save!
+                  @save_called = true
+                end
+              end.new
+            not_changed_object.save!
+            not_changed_object.mark_as_changed
+            changed_object = not_changed_object
+
+            expect{ changed_object.save! }.to change { changed_object.save_called }.from(nil).to(true)
+          end
+        end
+      end
+    end
+  end
+
+  describe "#save" do
+    context "changed object" do
+      let(:changed_object) {object.mark_as_changed; object}
+
+      it "should save queue" do
+        changed_object.save_queue.should_receive(:save).once
+        changed_object.save
+      end
+
+      context "original class has #save method defined" do
+        it "should call that method (save object)" do
+          changed_object =
+            Class.new(DirtyObject) do
+              attr_reader :save_called
+              def save
+                @save_called = true
+              end
+            end.new
+
+          changed_object.mark_as_changed
+          expect{ changed_object.save }.to change { changed_object.save_called }.from(nil).to(true)
+        end
+
+        #it "should save object only once in multiple queues" do
+        #  other_object = new_object
+        #  target = new_count_object
+        #
+        #  object      .save_queue.add target
+        #  other_object.save_queue.add target
+        #
+        #  other_object.save.should be_true
+        #        object.save.should be_true
+        #
+        #  target.save_call_count.should == 1
+        #end
+      end
+    end
+
+    context "not changed object" do
+      let(:not_changed_object) {object.mark_as_saved;   object}
+
+      it "should not mark object as saved" do
+        not_changed_object.should_not_receive(:mark_as_saved)
+        not_changed_object.save
+      end
+
+      it "should save queue" do
+        not_changed_object.save_queue.should_receive(:save).once
+        not_changed_object.save
+      end
+
+      context "original class has #save method defined" do
+        it "should not call that method (dont save an object)" do
+          not_changed_object =
+            Class.new(DirtyObject) do
+              attr_reader :save_called
+              def save
+                @save_called = true
+              end
+            end.new
+
+          not_changed_object.mark_as_saved
+          expect{ not_changed_object.save }.to_not change { not_changed_object.save_called }
+        end
+
+        context "multiple save with changing state" do
+          it "should call that method if state was changed after 1st save" do
+            not_changed_object =
+              Class.new(DirtyObject) do
+                attr_reader :save_called
+                def save
+                  @save_called = true
+                end
+              end.new
+            not_changed_object.save
+            not_changed_object.mark_as_changed
+            changed_object = not_changed_object
+
+            expect{ changed_object.save }.to change { changed_object.save_called }.from(nil).to(true)
+          end
+        end
+      end
+    end
+  end
+end

data/spec/notification/notification_spec.rb

@@ -34,11 +34,10 @@ describe SaveQueue::Plugins::Notification do
       klass.new
     end
 
-    [:add, :<<, :push].each do |method|
-      it "should mark object as changed if save_queue was changed by ##{method}" do
-        object.mark_as_saved
+    ADD_METHODS.each do |method|
+      it "should call queue_changed_event if save_queue was changed by ##{method} method" do
+        object.should_receive(:queue_changed_event)
         object.save_queue.send method, new_object
-        object.should have_unsaved_changes
       end
     end
   end

data/spec/notification/object_spec.rb

@@ -34,21 +34,4 @@ describe SaveQueue::Plugins::Notification::Object do
     NotifyObject.queue_class = queue
     expect { NotifyObject.new }.to_not raise_error
   end
-  
-  describe "#queue_changed_event" do
-    let(:object) do
-      NotifyObject.any_instance.stub(:create_queue)
-      NotifyObject.new
-    end
-
-    it "should mark self as changed" do
-      object.should_receive(:mark_as_changed)
-      object.send :queue_changed_event, true, stub(:some_object)
-    end
-    
-    it "should not mark self as changed if result of adding element to a queue was false" do
-      object.should_not_receive(:mark_as_changed)
-      object.send :queue_changed_event, false, stub(:some_object)
-    end
-  end
 end

data/spec/notification/queue_spec.rb

@@ -1,14 +1,14 @@
 require "spec_helper"
 require "save_queue/plugins/notification/queue"
 
-class NotifyQueue < SaveQueue::ObjectQueue
+class QueueWithNotification < SaveQueue::ObjectQueue
   include SaveQueue::Plugins::Notification::Queue
 end
 
 describe SaveQueue::Plugins::Notification::Queue do
-  let(:queue) { NotifyQueue.new }
+  let(:queue) { QueueWithNotification.new }
 
-  [:add, :<<, :push].each do |method|
+  ADD_METHODS.each do |method|
     describe "##{method}" do
       let(:element) { new_element }
       
@@ -18,7 +18,7 @@ describe SaveQueue::Plugins::Notification::Queue do
         queue.send method, element
       end
 
-      it "should notify observer, provided result of a method call and input object" do
+      it "should provide input params and result of ##{method} method call to observers" do
         queue.should_receive(:changed)
         queue.should_receive(:notify_observers).with(true, element)
         queue.send method, element

data/spec/object/queue_class_management_spec.rb

@@ -0,0 +1,53 @@
+require 'save_queue/object/queue_class_management'
+
+describe SaveQueue::Object::QueueClassManagement do
+  let(:klass) do
+    Class.new do
+      extend SaveQueue::Object::QueueClassManagement
+    end
+  end
+  let(:default_queue_class) { SaveQueue::ObjectQueue         }
+  let(:first_queue_class)   { Class.new(default_queue_class) }
+  let(:second_queue_class)  { Class.new(default_queue_class) }
+
+  it "should map to SaveQueue::ObjectQueue by default" do
+    klass.queue_class.should == default_queue_class
+  end
+
+  describe "changing" do
+    it "should be possible" do
+      klass.queue_class = second_queue_class
+      klass.queue_class.should eq second_queue_class
+    end
+
+    it "should check inclusion of Hooks module" do
+      expect{ klass.queue_class = Class.new }.to raise_error(RuntimeError, /Hooks/)
+    end
+  end
+
+  it "inclusion of SaveQueue::Object should not override settings" do
+    klass.queue_class = second_queue_class
+    expect { klass.send :include, SaveQueue::Object }.to_not change { klass.queue_class }
+  end
+
+  describe "inheritance" do
+    let(:parent) { klass         }
+    let(:child)  { Class.new(parent) }
+    before(:each) do
+      parent.queue_class = first_queue_class
+    end
+
+    it "should inherit settings of parent class" do
+      child.queue_class.should == first_queue_class
+    end
+
+    it "should not override settings of parent class" do
+      expect { child.queue_class = second_queue_class }.to_not change { parent.queue_class }
+    end
+
+    it "inclusion of SaveQueue::Object should not override settings of child class" do
+      child.queue_class = second_queue_class
+      expect { child.send :include, SaveQueue::Object }.to_not change { child.queue_class }
+    end
+  end
+end