ar-deltas 0.6

data/MIT-LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2009 Arya Asemanfar
+
+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/Manifest

@@ -0,0 +1,4 @@
+lib/ar-deltas.rb
+MIT-LICENSE
+Rakefile
+Manifest

data/Rakefile

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('ar-deltas', '0.6') do |p|
+  p.description    = "ActiveRecord extension to allow for updating numerical attributes using deltas."
+  p.url            = "https://github.com/arya/ar-deltas/"
+  p.author         = "Arya Asemanfar"
+  p.email          = "aryaasemanfar@gmail.com"
+  p.ignore_pattern = ["tmp/*", "script/*", 'test/*']
+  p.runtime_dependencies = ["activerecord"]
+  p.development_dependencies = ["shoulda"]
+end
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }

data/ar-deltas.gemspec

@@ -0,0 +1,37 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{ar-deltas}
+  s.version = "0.6"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Arya Asemanfar"]
+  s.date = %q{2009-09-30}
+  s.description = %q{ActiveRecord extension to allow for updating numerical attributes using deltas.}
+  s.email = %q{aryaasemanfar@gmail.com}
+  s.extra_rdoc_files = ["lib/ar-deltas.rb"]
+  s.files = ["lib/ar-deltas.rb", "MIT-LICENSE", "Rakefile", "Manifest", "ar-deltas.gemspec", "test/deltas_test.rb", "test/test_helper.rb"]
+  s.homepage = %q{https://github.com/arya/ar-deltas/}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Ar-deltas", "--main", "README.markdown"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{ar-deltas}
+  s.rubygems_version = %q{1.3.4}
+  s.summary = %q{ActiveRecord extension to allow for updating numerical attributes using deltas.}
+  s.test_files = ["test/deltas_test.rb", "test/test_helper.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activerecord>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<activerecord>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<activerecord>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+  end
+end

data/lib/ar-deltas.rb

@@ -0,0 +1,48 @@
+require 'set'
+
+module ActiveRecord::Deltas
+  def self.included(klass)
+    klass.class_eval do
+      alias_method_chain :attributes_with_quotes, :deltas
+    end
+  end
+  
+  def attributes_with_quotes_with_deltas(*args)
+    with_deltas = attributes_with_quotes_without_deltas(*args)
+    return with_deltas if self.new_record?
+    with_deltas.keys.each do |attribute_name|
+      if self.class.delta_attributes.include?(attribute_name.intern) && !self.excluded_deltas.include?(attribute_name.intern)
+        delta_string = "#{self.connection.quote_column_name(attribute_name)} "
+        old_value, new_value = self.changes[attribute_name]
+        delta_string << (old_value > new_value ? "-" : "+")
+        delta_string << " #{(old_value - new_value).abs}"
+        with_deltas[attribute_name] = delta_string
+      end
+    end
+    with_deltas
+  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
+end
+
+class ActiveRecord::Base
+  include ActiveRecord::Deltas
+  class InvalidDeltaColumn < StandardError; end
+  def self.delta_attributes(*args)
+    @_delta_attributes ||= Set.new
+    
+    return @_delta_attributes if args.empty?
+    
+    args.each do |attribute|
+      raise InvalidDeltaColumn.new("Delta attributes only work with number attributes, column `#{attribute}` is not a number.") unless self.columns_hash[attribute.to_s].number?
+      @_delta_attributes.add(attribute)
+    end
+  end  
+end

data/test/deltas_test.rb

@@ -0,0 +1,67 @@
+require 'test_helper'
+puts ActiveRecord::VERSION::STRING
+
+class DeltasTest < Test::Unit::TestCase
+  include TestHelper
+  context "with an blank AR class" do
+    setup do
+      conn = connection_specification # because it changes context in the block
+      @klass = Class.new(ActiveRecord::Base) do
+        self.table_name = "widgets"
+        establish_connection(conn)
+      end
+    end
+    
+    should "should throw exception for deltaing non-number fields" do
+      assert_raises(ActiveRecord::Base::InvalidDeltaColumn) do
+        @klass.class_eval { delta_attributes :name }
+      end
+    end
+    
+    should "override values with latest update" do
+      original = @klass.create
+      one, two = @klass.find(original.id), @klass.find(original.id)
+      one.counter += 2
+      two.counter += 3
+      one.save
+      two.save
+      assert_equal 3, original.reload.counter
+    end
+    
+    context "with a delta attribute" do
+      setup do
+        @klass.class_eval { delta_attributes :counter }
+      end
+      
+      should "update value using delta (additions)" do
+        original = @klass.create
+        one, two = @klass.find(original.id), @klass.find(original.id)
+        one.counter += 2
+        two.counter += 3
+        one.save
+        two.save
+        assert_equal 5, original.reload.counter
+      end
+      
+      should "update value using delta (subtractions)" do
+        original = @klass.create
+        one, two = @klass.find(original.id), @klass.find(original.id)
+        one.counter -= 6
+        two.counter -= 7
+        one.save
+        two.save
+        assert_equal -13, original.reload.counter
+      end
+      
+      should "exclude delta attribute if explictly specified" do
+        original = @klass.create
+        one, two = @klass.find(original.id), @klass.find(original.id)
+        one.force_clobber(:counter, 100)
+        two.force_clobber(:counter, 3000)
+        one.save
+        two.save
+        assert_equal 3000, original.reload.counter
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,20 @@
+TEST_DIR = File.dirname(__FILE__)
+%w(lib test).each do |dir|
+  $LOAD_PATH.unshift File.join(TEST_DIR, "..", dir)
+end
+
+require 'test/unit'
+require 'rubygems'
+require 'shoulda'
+
+require 'activerecord'
+require 'ar-deltas'
+
+# To run the tests, you need a MySQL database as described below.
+# create table widgets (id int auto_increment primary key, counter int default 0, name varchar(255));
+
+module TestHelper
+  def connection_specification
+    {:username => "root", :password => "", :database => "ar_deltas", :adapter => "mysql"}
+  end
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification 
+name: ar-deltas
+version: !ruby/object:Gem::Version 
+  version: "0.6"
+platform: ruby
+authors: 
+- Arya Asemanfar
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-09-30 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: ActiveRecord extension to allow for updating numerical attributes using deltas.
+email: aryaasemanfar@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- lib/ar-deltas.rb
+files: 
+- lib/ar-deltas.rb
+- MIT-LICENSE
+- Rakefile
+- Manifest
+- ar-deltas.gemspec
+- test/deltas_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: https://github.com/arya/ar-deltas/
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Ar-deltas
+- --main
+- README.markdown
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: ar-deltas
+rubygems_version: 1.3.4
+signing_key: 
+specification_version: 3
+summary: ActiveRecord extension to allow for updating numerical attributes using deltas.
+test_files: 
+- test/deltas_test.rb
+- test/test_helper.rb