active-record-atomic 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d47216327709a5093e8b577ba123a903fbe4f99e
+  data.tar.gz: 14dc6addbad5fe40bb8dbf09e6566ec5d9675d8c
+SHA512:
+  metadata.gz: 7227668d02bb75669956c66f12f547fb50ca96594bf69514d33025493f783ef8c9758ca245e3f8d44d77b92f17f0e821e3265b60ddbd50c26da633e7730591e3
+  data.tar.gz: 29dee1330d0edba6f1801b3e5f7a768c2f47650a1080de218a2b1774421567caad7228231d88390478e5099aae478a7fe01f13b9f256eb649ff0bd938fab044f

data/.editorconfig

@@ -0,0 +1,9 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.4
+  - 2.2.2

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,61 @@
+PATH
+  remote: .
+  specs:
+    active-record-atomic (0.2.0)
+      activerecord (>= 4.2, < 5.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (4.2.4)
+      activesupport (= 4.2.4)
+      builder (~> 3.1)
+    activerecord (4.2.4)
+      activemodel (= 4.2.4)
+      activesupport (= 4.2.4)
+      arel (~> 6.0)
+    activesupport (4.2.4)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    arel (6.0.3)
+    builder (3.2.2)
+    database_cleaner (1.5.0)
+    diff-lcs (1.2.5)
+    i18n (0.7.0)
+    json (1.8.3)
+    minitest (5.8.1)
+    rake (10.4.2)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.2)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+    sqlite3 (1.3.10)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  active-record-atomic!
+  bundler
+  database_cleaner
+  rake
+  rspec
+  sqlite3
+
+BUNDLED WITH
+   1.10.6

data/README.md

@@ -0,0 +1,44 @@
+# ActiveRecord Atomic
+
+Convenience methods for updating your ActiveRecord resources atomically, using pessimistic locking.
+
+## Usage
+
+Install via gem:
+
+```shell
+$ gem install active-record-atomic
+```
+
+Use it:
+
+```ruby
+Post.save_atomically(1) do |post|
+  post.title = "new title"
+end
+```
+
+## Licence
+
+```
+Copyright (c) 2015 Black Square Media
+
+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/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/active-record-atomic.gemspec

@@ -0,0 +1,26 @@
+# encoding: utf-8
+
+Gem::Specification.new do |s|
+  s.name          = 'active-record-atomic'
+  s.version       = '0.2.0'
+  s.authors       = ['Black Square Media Ltd']
+  s.email         = ['info@blacksquaremedia.com']
+  s.summary       = %{Atomic updates to ActiveRecord models}
+  s.description   = %{}
+  s.homepage      = 'https://github.com/bsm/active-record-atomic'
+  s.license       = 'MIT'
+
+  s.files         = `git ls-files -z`.split("\x0").reject {|f| f.match(%r{^spec/}) }
+  s.test_files    = `git ls-files -z -- spec/*`.split("\x0")
+  s.require_paths = ['lib']
+  s.required_ruby_version = '>= 1.9.3'
+
+  s.add_dependency 'activerecord', '>= 4.2', '< 5.0'
+  s.add_development_dependency 'bundler'
+  s.add_development_dependency 'sqlite3'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'database_cleaner'
+
+end
+

data/lib/active-record-atomic.rb

@@ -0,0 +1 @@
+require 'active_record_atomic'

data/lib/active_record/locking/pessimistic/convenience_methods.rb

@@ -0,0 +1,48 @@
+require 'active_record'
+
+module ActiveRecord
+  module Locking
+    module Pessimistic
+      module ConvenienceMethods
+
+        # Finds a records with the given ID, applies the block, then calls save. Returns the record.
+        #
+        # All options are passed to #save, except for:
+        #   <tt>lock:</tt> - pass an SQL locking clause to append the end of the SELECT statement, defaults to "FOR UPDATE"
+        #
+        # Example:
+        #
+        #   Post.find_and_save_atomically(1, validate: false, lock: "FOR SHARE") {|post| post.title = "new title" s}
+        #
+        def find_and_save_atomically(id, opts = {}, &block)
+          _find_and_apply_atomically(:save, id, opts, &block)
+        end
+
+        # Same as find_and_save_atomically, just calls #save! on the model
+        def find_and_save_atomically!(id, opts = {}, &block)
+          _find_and_apply_atomically(:save!, id, opts, &block)
+        end
+
+        # Find and update attributes, but atomically
+        def find_and_update_atomically(id, attrs, opts = {})
+          find_and_save_atomically(id, opts) {|r| r.assign_attributes attrs }
+        end
+
+        private
+
+          def _find_and_apply_atomically(method, id, opts = {}, &block)
+            kind = opts.delete(:lock) || true
+            transaction do
+              record = lock(kind).find(id)
+              block.call(record)
+              record.send(method, opts)
+              record
+            end
+          end
+
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.extend ActiveRecord::Locking::Pessimistic::ConvenienceMethods

data/lib/active_record_atomic.rb

@@ -0,0 +1 @@
+require 'active_record/locking/pessimistic/convenience_methods'

data/spec/lib/active_record_atomic_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+RSpec.describe ActiveRecord::Locking::Pessimistic::ConvenienceMethods do
+
+  let!(:subject) { Post.create(title: "big news") }
+
+  it 'should save atomically' do
+    update = Proc.new do |id|
+      Post.connection.reconnect!
+      Post.find_and_save_atomically!(id) {|post| post.views += 1 }
+    end
+
+    (1..20).map do |_|
+      Thread.new(subject.id, &update)
+    end.each(&:join)
+
+    expect(subject.reload.views).to eq(20)
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+ENV['RACK_ENV'] ||= "test"
+
+require 'active-record-atomic'
+require 'rspec'
+require 'database_cleaner'
+
+DatabaseCleaner.strategy = :truncation
+
+RSpec.configure do |c|
+  c.after :each do
+    DatabaseCleaner.clean
+  end
+end
+
+tempfile = Tempfile.new ["atomic", "test"]
+
+ActiveRecord::Base.configurations["test"] = { 'adapter' => 'sqlite3', 'database' => tempfile.path, 'pool' => 20 }
+ActiveRecord::Base.establish_connection(:test)
+ActiveRecord::Base.connection.create_table :posts do |t|
+  t.string :title
+  t.integer :views, :null => false, :default => 0
+end
+
+class Post < ActiveRecord::Base
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: active-record-atomic
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Black Square Media Ltd
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email:
+- info@blacksquaremedia.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- active-record-atomic.gemspec
+- lib/active-record-atomic.rb
+- lib/active_record/locking/pessimistic/convenience_methods.rb
+- lib/active_record_atomic.rb
+- spec/lib/active_record_atomic_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/bsm/active-record-atomic
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.7
+signing_key: 
+specification_version: 4
+summary: Atomic updates to ActiveRecord models
+test_files:
+- spec/lib/active_record_atomic_spec.rb
+- spec/spec_helper.rb