delta_attributes 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in delta_attributes.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 izbor
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,53 @@
+# DeltaAttributes
+
+    This gem makes updating specified number fields by ActiveRecord in unusual way.
+
+    Instead to generate sql script to update value in usual way like this:
+
+      UPDATE users
+      SET money = 10
+      WHERE id = 1;
+
+    It replaces it with
+
+      UPDATE users
+      SET money = money + d
+      WHERE id = 1;
+
+    where d is difference between old value and new value of that field.
+
+    This solves problem with simultaneous updating of same field by different threads
+    without locking record.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'delta_attributes'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install delta_attributes
+
+## Usage
+
+  To mark numeric field to be updated by "field = field + d" way you just need to add field
+  name to delta_attributes like this:
+
+  class User < ActiveRecord::Base
+
+    delta_attributes :money
+
+  end
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/delta_attributes.gemspec

@@ -0,0 +1,38 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'delta_attributes/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "delta_attributes"
+  gem.version       = DeltaAttributes::VERSION
+  gem.authors       = ["izbor"]
+  gem.email         = ["oleh.novosad@gmail.com"]
+  gem.description   = %q{
+    This gem makes updating specified number fields by ActiveRecord in unusual way.
+
+    Instead to generate sql script to update value in usual way like this:
+
+      UPDATE users
+      SET money = 10
+      WHERE id = 1;
+
+    It replaces it with
+
+      UPDATE users
+      SET money = money + d
+      WHERE id = 1;
+
+    where d is difference between old value and new value of that field.
+
+    This solves problem with simultaneous updating of same field.
+  }
+  gem.summary       = %q{ delta attributes }
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  gem.add_dependency "rails", "~> 3.2.8"
+end

data/lib/delta_attributes/crud.rb

@@ -0,0 +1,11 @@
+module Arel
+  module Crud
+
+    def compile_full_update values, changed_values
+      um = compile_update values
+      um.set_changes changed_values unless changed_values.empty?
+      um
+    end
+
+  end
+end

data/lib/delta_attributes/main.rb

@@ -0,0 +1,64 @@
+require 'set'
+require "delta_attributes/update_statement"
+require "delta_attributes/update_manager"
+require "delta_attributes/to_sql"
+require "delta_attributes/mysql"
+require "delta_attributes/crud"
+require "delta_attributes/visitor"
+
+module ActiveRecord
+  # = Active Record Persistence
+  module Persistence
+
+    def update(attribute_names = @attributes.keys)
+      return super(attribute_names) if self.new_record?
+
+      attributes_with_values = arel_attributes_values(false, false, attribute_names)
+      return 0 if attributes_with_values.empty?
+
+      attributes = { }
+      @changed_attributes.each do |attribute_name, value|
+        if self.class.delta_attributes.include?(attribute_name.intern) && !self.excluded_deltas.include?(attribute_name.intern)
+          attributes[attribute_name] = value
+        end
+      end
+
+      klass = self.class
+      stmt = klass.unscoped.where(klass.arel_table[klass.primary_key].eq(id)).arel.compile_full_update(attributes_with_values, attributes)
+      klass.connection.update stmt
+    end
+
+    def excluded_deltas
+      @_excluded_deltas ||= Set.new
+    end
+
+    def force_clobber(attr_name, value)
+      self.excluded_deltas.add(attr_name.to_s.intern)
+      send("#{attr_name}=", value)
+    end
+
+    class InvalidDeltaColumn < StandardError;
+    end
+
+    def self.included(base) #:nodoc:
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+
+      def delta_attributes(*args)
+        @_delta_attributes ||= Set.new
+
+        return @_delta_attributes if args.empty?
+
+        args.each do |attribute|
+          if self.columns_hash[attribute.to_s] && !self.columns_hash[attribute.to_s].number?
+            raise InvalidDeltaColumn.new("Delta attributes only work with number attributes, column `#{attribute}` is not a number.")
+          end
+          @_delta_attributes.add(attribute)
+        end
+      end
+    end
+  end
+
+end

data/lib/delta_attributes/mysql.rb

@@ -0,0 +1,30 @@
+module Arel
+  module Visitors
+    class MySQL < Arel::Visitors::ToSql
+
+      private
+
+      def visit_Arel_Nodes_UpdateStatement o
+        [
+            "UPDATE #{visit o.relation}",
+            ("SET #{o.values_changed.map { |value| visit value }.join ', '}" unless o.values.empty?),
+            ("WHERE #{o.wheres.map { |x| visit x }.join ' AND '}" unless o.wheres.empty?),
+            ("ORDER BY #{o.orders.map { |x| visit x }.join(', ')}" unless o.orders.empty?),
+            (visit(o.limit) if o.limit),
+        ].compact.join ' '
+      end
+
+      # original
+      #def visit_Arel_Nodes_UpdateStatement o
+      #  [
+      #    "UPDATE #{visit o.relation}",
+      #    ("SET #{o.values.map { |value| visit value }.join ', '}" unless o.values.empty?),
+      #    ("WHERE #{o.wheres.map { |x| visit x }.join ' AND '}" unless o.wheres.empty?),
+      #    ("ORDER BY #{o.orders.map { |x| visit x }.join(', ')}" unless o.orders.empty?),
+      #    (visit(o.limit) if o.limit),
+      #  ].compact.join ' '
+      #end
+    end
+  end
+end
+

data/lib/delta_attributes/railtie.rb

@@ -0,0 +1,8 @@
+
+class DeltaAttributesRailtie < Rails::Railtie
+
+  initializer "delta_attributes.configure_rails_initialization", {:after => 1} do
+     load "delta_attributes/main.rb"
+  end
+
+end

data/lib/delta_attributes/to_sql.rb

@@ -0,0 +1,25 @@
+module Arel
+  module Visitors
+    class ToSql < Arel::Visitors::Visitor
+
+      def visit_Arel_Nodes_Assignment_with_deltas o
+        return visit_Arel_Nodes_Assignment_without_deltas o unless o.is_a?(Arel::Nodes::DeltaAttribute)
+        return visit_Arel_Nodes_Assignment_without_deltas o.arel_node unless o.valid?
+
+        old_value = o.old_value
+        new_value = o.new_value
+
+        delta_string = "#{visit o.arel_node.left} "
+        delta_string << (old_value > new_value ? "-" : "+")
+        delta_string << " #{(old_value - new_value).abs}"
+
+        "#{visit o.arel_node.left} = #{delta_string}"
+      end
+
+      #alias_method_chain :visit_Arel_Nodes_Assignment, :deltas
+
+      alias_method :visit_Arel_Nodes_Assignment_without_deltas, :visit_Arel_Nodes_Assignment
+      alias_method :visit_Arel_Nodes_Assignment, :visit_Arel_Nodes_Assignment_with_deltas
+    end
+  end
+end

data/lib/delta_attributes/update_manager.rb

@@ -0,0 +1,13 @@
+module Arel
+
+  module UpdateManagerExt
+
+    def set_changes values
+      @ast.values_changed = values
+    end
+  end
+
+  class UpdateManager
+    include Arel::UpdateManagerExt
+  end
+end

data/lib/delta_attributes/update_statement.rb

@@ -0,0 +1,50 @@
+module Arel
+  module Nodes
+
+    class DeltaAttribute
+
+      attr_accessor :arel_node, :new_value, :old_value
+
+      def initialize(arel_node, new_value = nil, old_value = nil)
+        @arel_node = arel_node
+        @new_value = new_value
+        @old_value = old_value
+      end
+
+      def valid?
+        @arel_node && !new_value.nil? && !old_value.nil?
+      end
+
+    end
+
+    module UpdateStatementExt
+
+      def values_changed=(values)
+        instance_variable_set("@values_changed", values)
+      end
+
+      def values_changed
+        changed = instance_variable_get("@values_changed")
+        return @values unless changed
+
+        @values.map {|m|
+          attr_name = m.left.expr.name
+          new_value = m.right
+          if changed[attr_name]
+            Arel::Nodes::DeltaAttribute.new(m, new_value, changed[attr_name])
+          else
+            m
+          end
+        }
+      end
+
+    end
+
+    class UpdateStatement
+      include Arel::Nodes::UpdateStatementExt
+    end
+
+  end
+
+
+end

data/lib/delta_attributes/version.rb

@@ -0,0 +1,3 @@
+module DeltaAttributes
+  VERSION = "0.0.1"
+end

data/lib/delta_attributes/visitor.rb

@@ -0,0 +1,27 @@
+module Arel
+  module Visitors
+    class Visitor
+
+      def visit_with_delta_attribute obj
+        return visit_without_delta_attribute obj unless obj.is_a?(Arel::Nodes::DeltaAttribute)
+        return visit_without_delta_attribute obj.arel_node unless obj.valid?
+
+        object = obj.arel_node
+        send dispatch[object.class], obj
+      rescue NoMethodError => e
+        raise e if respond_to?(dispatch[object.class], true)
+        superklass = object.class.ancestors.find { |klass|
+          respond_to?(dispatch[klass], true)
+        }
+        raise(TypeError, "Cannot visit #{object.class}") unless superklass
+        dispatch[object.class] = dispatch[superklass]
+        retry
+      end
+
+      #alias_method_chain :visit, :delta_attribute
+
+      alias_method :visit_without_delta_attribute, :visit
+      alias_method :visit, :visit_with_delta_attribute
+    end
+  end
+end

data/lib/delta_attributes.rb

@@ -0,0 +1,2 @@
+require "delta_attributes/version"
+require 'delta_attributes/railtie' if defined?(Rails)

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: delta_attributes
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- izbor
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.8
+description: ! "\n    This gem makes updating specified number fields by ActiveRecord
+  in unusual way.\n\n    Instead to generate sql script to update value in usual way
+  like this:\n\n      UPDATE users\n      SET money = 10\n      WHERE id = 1;\n\n
+  \   It replaces it with\n\n      UPDATE users\n      SET money = money + d\n      WHERE
+  id = 1;\n\n    where d is difference between old value and new value of that field.\n\n
+  \   This solves problem with simultaneous updating of same field.\n  "
+email:
+- oleh.novosad@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- delta_attributes.gemspec
+- lib/delta_attributes.rb
+- lib/delta_attributes/crud.rb
+- lib/delta_attributes/main.rb
+- lib/delta_attributes/mysql.rb
+- lib/delta_attributes/railtie.rb
+- lib/delta_attributes/to_sql.rb
+- lib/delta_attributes/update_manager.rb
+- lib/delta_attributes/update_statement.rb
+- lib/delta_attributes/version.rb
+- lib/delta_attributes/visitor.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: delta attributes
+test_files: []