save_queue 0.0.1 → 0.1.0

data/.travis.yml

@@ -0,0 +1,7 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - jruby
+  - ruby-head
+  - ree

data/README.md

@@ -6,6 +6,123 @@ Installation
 ------------
     gem install save_queue
 
+Usage
+-----
+
+How to start:
+
+1. include SavedQueue:
+
+        require 'saved_queue'
+        class Artice
+          include SavedQueue
+        end
+
+2. call \#mark_as_saved method when object gets dirty:
+
+        class Artice
+          def change_attribute attr, value
+            @attributes[attr] = value
+            mark_as_saved # call this and object will be marked for save
+          end
+        end
+
+3. point save method to your save logic or dont care if you use #save already:
+
+        class Artice
+          # @return [boolean]
+          def save
+            write
+          end
+        end
+
+4.  Save Queue forced you to use valid? method, this should be changes in future and extracted to a module:
+
+        class Artice
+          # @return [boolean]
+          def valid?
+            true
+          end
+        end
+
+5. add SavedQueue to some other classes:
+
+        require 'saved_queue'
+        class Tag
+          include SavedQueue
+        end
+
+        class Artice
+          def tags= tag_objects
+            @tags = tag_objects
+            saved_queue.add_all tag_objects
+          end
+
+          def add_tag tag
+            @tags ||= []
+            @tags << tag
+            saved_queue.add tag
+          end
+        end
+
+6. Use it:
+
+        article = Article.new
+        tag_objects = [Tag.new, Tag.new, Tag.new]
+        article.tags = tag_object
+        article.add_tag Tag.new
+
+        # 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
+        article.save
+
+7. Handle errors
+
+        begin
+          article.save
+        rescue SaveQueue::FailedSaveError => save_error
+
+          # @params [Hash] info
+          # @option info [Array<Object>] :saved
+          # @option info [Object]        :failed
+          # @option info [Array<Object>] :pending
+          save_error.context
+        end
+
+
+
+If you have custom logic for marking objects dirty then you may want to override
+\#has_unsaved_changes? method in you class like this:
+
+    def has_unsaved_changes?
+      dirty? # dirty is you custom method to determine has object unsaved_changes or not
+    end
+
+method \#mark_as_saved becomes useless in this case and you should mark objects by your self.
+
+
+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
+
+Compatibility
+-------------
+tested with Ruby
+
+* 1.8.7
+* 1.9.2
+* 1.9.3
+* jruby
+* ruby-head
+* ree
+
+see [build history](http://travis-ci.org/#!/AlexParamonov/save_queue/builds)
+
 Copyright
 ---------
 Copyright © 2011 Alexander N Paramonov. See LICENSE for details.

data/Rakefile

@@ -1,2 +1,5 @@
 require "bundler/gem_tasks"
+require 'rspec'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
 task :default => [:spec]

data/lib/save_queue/object.rb

@@ -0,0 +1,51 @@
+require "save_queue/queue"
+
+module 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 false if defined?(super) and false == super
+
+        super_saved = true
+        super_saved = super if defined?(super)
+        # object is saved here
+        mark_as_saved
+        return (super_saved and save_queue.save)
+
+      end
+    end
+
+
+    def initialize(*args)
+      super if defined?(super)
+      queue = Queue.new
+      instance_variable_set "@_save_queue", queue
+
+      # this will make RunAlwaysFirst methods triggered first in inheritance tree
+      extend RunAlwaysFirst
+    end
+
+    def mark_as_changed
+      instance_variable_set "@_changed_mark", true
+    end
+
+    def has_unsaved_changes?
+      status = instance_variable_get("@_changed_mark")
+      status.nil? ? false : status
+    end
+
+    def save_queue
+      instance_variable_get "@_save_queue"
+    end
+
+    private
+    def mark_as_saved
+      instance_variable_set "@_changed_mark", false
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+module SaveQueue
+  module Plugins
+    module Validation
+      module Object
+
+        # @return [Boolean]
+        def save(*args)
+          # are objects in queue valid?
+          return false unless valid?
+          return false unless save_queue.valid?
+        end
+      end
+    end
+  end
+end

data/lib/save_queue/queue.rb

@@ -0,0 +1,51 @@
+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
+
+    def valid?
+      @queue.all? do |object|
+        object.valid?
+      end
+    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/lib/save_queue/version.rb

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

data/lib/save_queue.rb

@@ -1,5 +1,10 @@
 require "save_queue/version"
+require "save_queue/object"
 
 module SaveQueue
-  # Your code goes here...
+  def self.included base
+    base.send :include, SaveQueue::Object
+  end
+
+
 end

data/save_queue.gemspec

@@ -20,5 +20,6 @@ Gem::Specification.new do |s|
 
   # specify any dependencies here; for example:
   s.add_development_dependency "rspec", ">= 2.6"
+  s.add_development_dependency "rake"
   # s.add_runtime_dependency "rest-client"
 end

data/spec/save_queue_usage_spec.rb

@@ -0,0 +1,292 @@
+require "save_queue"
+module Tests
+  class Object
+    include SaveQueue
+  end
+end
+
+# 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
+      Tests::Object.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
+
+    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
+      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
+
+  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)
+
+    bad_object
+  end
+
+  def new_object
+    object = Tests::Object.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.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-12 00:00:00.000000000Z
+date: 2011-11-15 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &18435660 !ruby/object:Gem::Requirement
+  requirement: &23937520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,18 @@ dependencies:
         version: '2.6'
   type: :development
   prerelease: false
-  version_requirements: *18435660
+  version_requirements: *23937520
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &23936900 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *23936900
 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.
@@ -33,14 +44,20 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .travis.yml
 - Gemfile
 - HISTORY.md
 - LICENSE
 - README.md
 - Rakefile
 - lib/save_queue.rb
+- lib/save_queue/object.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
 homepage: http://github.com/AlexParamonov/save_queue
 licenses: []
 post_install_message: 
@@ -61,8 +78,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: save_queue
-rubygems_version: 1.8.6
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Push related objects to a queue for delayed save
 test_files: []
+has_rdoc: