flattery 0.0.4 → 0.1.0

data/README.md

@@ -98,6 +98,19 @@ The default mechanism for performing the update of cached values is with the sta
 
 This should be fine for modest applications, but if the update will affect many records - especially if there is a high likelihood of read/write contention - then it may need finessing. Flattery allows you to define your own update procedure for these cases - see the next section.
 
+### How to updating cached values with batched transactional update
+
+Use the <tt>:batch_size</tt> option to define the batch size:
+
+    class Category < ActiveRecord::Base
+      has_many :notes
+
+      include Flattery::ValueProvider
+      push_flattened_values_for :name => :notes, :as => 'cat_name', :batch_size => 100
+    end
+
+This will update of cached values in batches of the specified size - each wrapped in its own transaction.
+
 ### How to provide a custom method for updating cached values
 
 Use the <tt>:method</tt> option to declare the instance method to be used:
@@ -108,16 +121,19 @@ Use the <tt>:method</tt> option to declare the instance method to be used:
       include Flattery::ValueProvider
       push_flattened_values_for :name => :notes, :as => 'cat_name', :method => :my_custom_updater
 
-      # You custom update method definition. Parameters:
+      # Your custom update method definition. Parameters:
       # * +attribute+ is the attribute name that the value is coming from e.g. :name
       # * +new_value+ is the new value that has been set e.g. 'a value that was just set'
       # * +association_name+ is the association that updates need to be pushed to set e.g. :notes
-      # * +target_attribute+ is the attribute name that needs to be updated   e.g. :cat_name
-      def my_custom_updater(attribute,new_value,association_name,target_attribute)
+      # * +target_attribute+ is the attribute name that needs to be updated e.g. :cat_name
+      # * +batch_size+ is desired batch size to use for updates. 0 or nil implies no batch limits. e.g. 10
+      #
+      def my_custom_updater(attribute,new_value,association_name,target_attribute,batch_size)
         # implement your custom update algorithm here. It could do some funky batched SQL for example.
-        # For now here's just a simple update_all implementation:
+        # For now, here's just a simple update_all implementation:
         self.send(association_name).update_all(target_attribute => new_value)
       end
+
     end
 
 ### How can I get cached value updates pushed in the background?

data/lib/flattery/settings.rb

@@ -28,6 +28,7 @@ class Flattery::Settings
     as_setting = opt.delete(:as).try(:to_s)
     method_setting = opt.delete(:method).try(:to_sym)
     background_setting = opt.delete(:background_with).try(:to_sym)
+    batch_size_setting = opt.delete(:batch_size).try(:to_i)
 
     if from_entity = opt.keys.first
       cache_options[:from_entity] = from_entity
@@ -36,6 +37,7 @@ class Flattery::Settings
     cache_options[:as] = as_setting
     cache_options[:method] = method_setting if method_setting
     cache_options[:background_with] = background_setting if background_setting
+    cache_options[:batch_size] = batch_size_setting if batch_size_setting
 
     cache_options
   end

data/lib/flattery/value_provider/processor.rb

@@ -9,10 +9,11 @@ class Flattery::ValueProvider::Processor
           attribute = key.to_sym
           new_value = record.send(key)
           association_name = options[:to_entity]
+          batch_size = options[:batch_size]
           if options[:background_with] == :delayed_job && self.respond_to?(:delay)
-            self.delay.apply_push(record,method,attribute,new_value,association_name,target_attribute)
+            self.delay.apply_push(record,method,attribute,new_value,association_name,target_attribute,batch_size)
           else
-            apply_push(record,method,attribute,new_value,association_name,target_attribute)
+            apply_push(record,method,attribute,new_value,association_name,target_attribute,batch_size)
           end
         else
           raise Flattery::CacheColumnInflectionError.new("#{record.class.name} #{key}: #{options}")
@@ -23,12 +24,24 @@ class Flattery::ValueProvider::Processor
   end
 
   # Command: performs an update for a specific cache setting
-  def apply_push(record,method,attribute,new_value,association_name,target_attribute)
+  def apply_push(record,method,attribute,new_value,association_name,target_attribute,batch_size)
     case method
     when :update_all
-      record.send(association_name).update_all({target_attribute => new_value})
+      if batch_size > 0
+        total_rows_affected = 0
+        rows_affected = 0
+        begin
+          ActiveRecord::Base.connection.transaction do
+            rows_affected = record.send(association_name).where("NOT #{target_attribute} = ?",new_value).limit(batch_size).update_all(target_attribute => new_value)
+            total_rows_affected += rows_affected
+          end
+        end while rows_affected >= batch_size
+        total_rows_affected
+      else
+        record.send(association_name).update_all({target_attribute => new_value})
+      end
     else # it is a custom update method
-      record.send(method,attribute,new_value,association_name,target_attribute)
+      record.send(method,attribute,new_value,association_name,target_attribute,batch_size)
     end
   end
 

data/lib/flattery/value_provider/settings.rb

@@ -2,7 +2,7 @@ class Flattery::ValueProvider::Settings < Flattery::Settings
 
   # Returns the basic settings template
   def setting_template
-    {method: :update_all}
+    {method: :update_all, batch_size: 0}
   end
 
   # Command: sets resolved_settings. Returns true if resolution was success (which will set the resolution status)
@@ -27,6 +27,7 @@ class Flattery::ValueProvider::Settings < Flattery::Settings
 
       push_method = setting[:method]
       background_with = setting[:background_with]
+      batch_size = setting[:batch_size]
       attribute_name = "#{from_entity}"
 
       assoc = klass.reflect_on_association(to_entity)
@@ -52,7 +53,8 @@ class Flattery::ValueProvider::Settings < Flattery::Settings
           to_entity: to_entity,
           as: cached_attribute_name,
           method: push_method,
-          background_with: background_with
+          background_with: background_with,
+          batch_size: batch_size
         }
       end
 

data/lib/flattery/version.rb

@@ -1,3 +1,3 @@
 module Flattery
-  VERSION = "0.0.4"
+  VERSION = "0.1.0"
 end

data/spec/unit/settings_spec.rb

@@ -103,6 +103,27 @@ describe Flattery::Settings do
       ]) }
     end
 
+    describe ":batch_size option" do
+      context "when specified with Symbol keys" do
+        before { settings.add_setting({category: :name, batch_size: 10}) }
+        its(:raw_settings) { should eql([
+          { from_entity: :category, to_entity: :name, as: nil, batch_size: 10 }
+        ]) }
+      end
+      context "when specified with String keys" do
+        before { settings.add_setting({'category' => 'name', 'batch_size' => 10}) }
+        its(:raw_settings) { should eql([
+          { from_entity: :category, to_entity: :name, as: nil, batch_size: 10 }
+        ]) }
+      end
+      context "when not a valid integer" do
+        before { settings.add_setting({category: :name, batch_size: "abc"}) }
+        its(:raw_settings) { should eql([
+          { from_entity: :category, to_entity: :name, as: nil, batch_size: 0 }
+        ]) }
+      end
+    end
+
   end
 
   describe "#settings" do

data/spec/unit/value_provider/processor_spec.rb

@@ -35,6 +35,37 @@ describe Flattery::ValueProvider::Processor do
     end
   end
 
+  context "with a custom batch size" do
+    let(:provider_class) do
+      class ::ValueProviderHarness < Category
+        include Flattery::ValueProvider
+        push_flattened_values_for name: :notes, as: :category_name, batch_size: 10
+      end
+      ValueProviderHarness
+    end
+
+    let(:cache_class) do
+      class ::ValueCacheHarness < Note
+        include Flattery::ValueCache
+        flatten_value category: :name
+      end
+      ValueCacheHarness
+    end
+
+    let!(:resource)       { provider_class.create(name: 'category_a') }
+    let!(:target_a)       { cache_class.create(category_id: resource.id) }
+    let!(:target_other_a) { cache_class.create }
+    context "when cached value is updated" do
+      it "should push the new cache value" do
+        expect {
+          resource.update_attributes(name: 'new category name')
+        }.to change {
+          target_a.reload.category_name
+        }.from('category_a').to('new category name')
+      end
+    end
+  end
+
   context "with provider that cannot correctly infer the cache column name" do
     let(:provider_class) do
       class ::ValueProviderHarness < Category
@@ -133,7 +164,7 @@ describe Flattery::ValueProvider::Processor do
       class ::ValueProviderHarness < Category
         include Flattery::ValueProvider
         push_flattened_values_for name: :notes, as: :category_name, method: :my_updater_method
-        def my_updater_method(attribute,new_value,association_name,target_attribute)
+        def my_updater_method(attribute,new_value,association_name,target_attribute,batch_size)
           self.send(association_name).update_all(target_attribute => "#{new_value} (set by my_updater_method)")
         end
       end

data/spec/unit/value_provider/settings_spec.rb

@@ -17,7 +17,7 @@ describe Flattery::ValueProvider::Settings do
     context "before resolution" do
       it { should be_a(settings_class) }
       its(:raw_settings) { should eql([
-        {from_entity: :name, to_entity: :notes, as: 'category_name', method: :update_all}
+        {from_entity: :name, to_entity: :notes, as: 'category_name', method: :update_all, batch_size: 0}
       ]) }
       its(:resolved) { should be_false }
     end
@@ -25,7 +25,7 @@ describe Flattery::ValueProvider::Settings do
       before { settings.settings }
       its(:resolved) { should be_true }
       its(:settings) { should eql({
-        "name"=>{to_entity: :notes, as: :category_name, method: :update_all, background_with: nil}
+        "name"=>{to_entity: :notes, as: :category_name, method: :update_all, background_with: nil, batch_size: 0}
       }) }
     end
   end
@@ -48,14 +48,14 @@ describe Flattery::ValueProvider::Settings do
       describe "parent" do
         let(:settings) { parent_provider_class.value_provider_options }
         its(:raw_settings) { should eql([
-          {from_entity: :name, to_entity: :notes, as: 'category_name', method: :update_all}
+          {from_entity: :name, to_entity: :notes, as: 'category_name', method: :update_all, batch_size: 0}
         ]) }
       end
       describe "child" do
         let(:settings) { child_provider_class.value_provider_options }
         its(:raw_settings) { should eql([
-          {from_entity: :name, to_entity: :notes, as: 'category_name', method: :update_all},
-          {from_entity: :description, to_entity: :notes, as: 'category_description', method: :update_all}
+          {from_entity: :name, to_entity: :notes, as: 'category_name', method: :update_all, batch_size: 0},
+          {from_entity: :description, to_entity: :notes, as: 'category_description', method: :update_all, batch_size: 0}
         ]) }
       end
     end
@@ -65,15 +65,15 @@ describe Flattery::ValueProvider::Settings do
         let(:settings) { parent_provider_class.value_provider_options }
         its(:resolved) { should be_true }
         its(:settings) { should eql({
-          "name"=>{to_entity: :notes, as: :category_name, method: :update_all, background_with: nil}
+          "name"=>{to_entity: :notes, as: :category_name, method: :update_all, background_with: nil, batch_size: 0}
         }) }
       end
       describe "child" do
         let(:settings) { child_provider_class.value_provider_options }
         its(:resolved) { should be_true }
         its(:settings) { should eql({
-          "name"=>{to_entity: :notes, as: :category_name, method: :update_all, background_with: nil},
-          "description"=>{to_entity: :notes, as: :category_description, method: :update_all, background_with: nil}
+          "name"=>{to_entity: :notes, as: :category_name, method: :update_all, background_with: nil, batch_size: 0},
+          "description"=>{to_entity: :notes, as: :category_description, method: :update_all, background_with: nil, batch_size: 0}
         }) }
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flattery
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-11 00:00:00.000000000 Z
+date: 2013-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport