rails_atomic_increment 0.2

data/.gitignore

@@ -0,0 +1 @@
+pkg

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+## 0.2 (November 22, 2011)
+
+Features:
+
+  - Atomic Increment of ActiveRecord models
+  - Optimize table for ActiveRecord classes

data/Gemfile

@@ -0,0 +1 @@
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Gonçalo Silva
+
+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,25 @@
+Atomic increments allow you to avoid problems with a concurrent access to a counter:
+http://www.alfreddd.com/2011/01/atomic-increment-in-rails.html
+
+Install:
+
+	gem install rails_atomic_increment
+
+
+Usage:
+
+	user = User.first
+	user.account_balance # => 100
+	user.atomic_increment!(:account_balance, 2)
+	user.account_balance # => 102
+
+	user.atomic_increment!('account_balance', 2, :reload) # reloads from DB
+	user.account_balance # could be > 104 if it was updated by another process
+
+	user.login_attempts # => 7
+	user.page_views # => 1000
+	user.increment_counters!([:login_attempts, :page_views]
+	user.login_attempts # => 8
+	user.page_views # => 1001
+	
+Copyright (c) 2011 Josh Shupack

data/Rakefile

@@ -0,0 +1,31 @@
+begin
+  require "bundler"
+  Bundler.setup
+rescue LoadError
+  $stderr.puts "You need to have Bundler installed to be able build this gem."
+end
+
+gemspec = eval(File.read(Dir["*.gemspec"].first))
+
+
+desc "Validate the gemspec"
+task :gemspec do
+  gemspec.validate
+end
+
+desc "Build gem locally"
+task :build => :gemspec do
+  system "gem build #{gemspec.name}.gemspec"
+  FileUtils.mkdir_p "pkg"
+  FileUtils.mv "#{gemspec.name}-#{gemspec.version}.gem", "pkg"
+end
+
+desc "Install gem locally"
+task :install => :build do
+  system "gem install pkg/#{gemspec.name}-#{gemspec.version}"
+end
+
+desc "Clean automatically generated files"
+task :clean do
+  FileUtils.rm_rf "pkg"
+end

data/lib/rails_atomic_increment.rb

@@ -0,0 +1,44 @@
+class ActiveRecord::Base
+  
+  # These methods are to update counters atomically so we don't have any issues with counters being off because of concurrent increment or decriment requests
+  
+  def atomic_increment!(attribute, by = 1, reload = false)
+    self.update_counters!({attribute => by}, reload)
+  end
+  
+  def atomic_decrement!(attribute, by = 1, reload = false)
+    by = -by #invert the sign so we're subtracting the passed in value from the current value
+    self.update_counters!({attribute => by}, reload)
+  end
+  
+  # this expects an array of counter attributes to update and turns it into a hash to pass to update_counters
+  def increment_counters!(counters, reload = false)
+    self.update_counters!(counters.inject({}) {|h,c| h.merge(c => 1)}, reload)
+  end
+  
+  # this expects an array of counter attributes to update and turns it into a hash to pass to update_counters
+  def decrement_counters!(counters, reload = false)
+    self.update_counters!(counters.inject({}) {|h,c| h.merge(c => -1)}, reload)
+  end
+  
+  def update_counters!(counters, reload = false)
+    counters.each do |attribute, value|
+      raise "attribute '#{attribute}' can NOT be incremented because it was already changed and that change will be lost." if !new_record? && changed_attributes[attribute.to_s]
+      self[attribute] ||= 0
+      self[attribute] += value
+      @changed_attributes.delete(attribute.to_s) unless new_record? # mark this column as unchanged so it won't get updated in the DB if a save is performed on the object!
+    end
+    if new_record?
+      self.save
+    else
+      self.class.update_counters(self.id, counters)
+    end
+    self.reload if reload # if we care about the new numbers in the db after the update
+  end
+  
+  # this is for database table maintenance - May only work on MySQL? Vacuum for Postgres
+  def self.optimize_table
+    connection.execute("OPTIMIZE TABLE #{quoted_table_name}")
+  end
+  
+end

data/rails_atomic_increment.gemspec

@@ -0,0 +1,26 @@
+Gem::Specification.new do |s|
+  s.name              = "rails_atomic_increment"
+  s.version           = "0.2"
+  s.platform          = Gem::Platform::RUBY
+  s.authors           = ["Josh Shupack"]
+  s.email             = ["yNaught@gmail.com"]
+  s.homepage          = "http://github.com/imme5150/rails_atomic_increment"
+  s.summary           = "Adds atomic_increment! and atomic_decrement! to ActiveRecord models"
+  s.description       = "Allows you to use atomic inrement and decriment from the model instead of having to call the class.  Much more object oriented"
+  s.rubyforge_project = s.name
+
+  s.required_rubygems_version = ">= 1.3.6"
+  
+  # If you have runtime dependencies, add them here
+  s.add_runtime_dependency "rails", "> 2"
+  
+  # If you have development dependencies, add them here
+  # s.add_development_dependency "another", "= 0.9"
+
+  # The list of files to be contained in the gem
+  s.files         = `git ls-files`.split("\n")
+  # s.executables   = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact
+  # s.extensions    = `git ls-files ext/extconf.rb`.split("\n")
+  
+  s.require_path = 'lib'
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification 
+name: rails_atomic_increment
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  version: "0.2"
+platform: ruby
+authors: 
+- Josh Shupack
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-11-22 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        version: "2"
+  type: :runtime
+  version_requirements: *id001
+description: Allows you to use atomic inrement and decriment from the model instead of having to call the class.  Much more object oriented
+email: 
+- yNaught@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/rails_atomic_increment.rb
+- rails_atomic_increment.gemspec
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/imme5150/rails_atomic_increment
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: rails_atomic_increment
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Adds atomic_increment! and atomic_decrement! to ActiveRecord models
+test_files: []
+