with_lock_version 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 61345b1c79f51bf6ec291af01d7faebd5a7c957b
+  data.tar.gz: 815cb84a73de817896f3b42fffe9b91e637a598c
+SHA512:
+  metadata.gz: 87e2ec27a7b63455c18a9f5851e0a2e033cb266bea42585d115d6a6ae24ffe9217e20983950d9ed97457499212feabb74b53e8a30f24c4ec7c83e9a29a73a116
+  data.tar.gz: d099b269b4db2d8909a656dbc09bd78ea3e2b679a069fcdef6159efaaacd41a1654c809fb61814a0d069a80a1d14ff8af744d5816c0f7b1f8fa607738f7153a4

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+log/*.log
+spec/database.yml

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,24 @@
+language: ruby
+cache: bundler
+sudo: false
+services:
+  - mysql
+rvm:
+  - 2.2.4
+  - 2.3.0
+  - ruby-head
+gemfile:
+  - gemfiles/rails_4_1.gemfile
+  - gemfiles/rails_4_2.gemfile
+  - gemfiles/rails_5_2.gemfile
+before_install: gem install bundler -v 1.11.2
+before_script:
+  - cp spec/database.yml.travis spec/database.yml
+  - mysql -e 'create database with_lock_version_test;'
+script:
+  - bundle exec rspec
+matrix:
+  allow_failures:
+  # NOTE: There are unstable versions
+  - rvm: ruby-head
+  - gemfile: gemfiles/rails_5_2.gemfile

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Akira Kusumoto
+
+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,65 @@
+# WithLockVersion
+
+[![Build Status](https://travis-ci.org/bluerabbit/with_lock_version.svg?branch=master)](https://travis-ci.org/bluerabbit/with_lock_version)
+
+ActiveRecordでlock_versionカラムを使った楽観的ロックをする際に楽になるhelper methodを提供するgemです。
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'with_lock_version'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install with_lock_version
+
+## Usage
+
+```ruby
+  create_table :orders do |t|
+    t.integer :lock_version, default: 0, null: false
+    t.timestamps
+  end
+```
+
+```ruby
+class Order < ActiveRecord::Base
+  with_lock_versionable # required lock_version and timestamp columns 
+end
+```
+
+
+```ruby
+order = Order.find(id)
+order.with_lock_version(params[:lock_version]) do
+  # something
+end
+```
+
+lock_versionが一致しない場合はActiveRecord::StaleObjectErrorをraiseします。
+
+## Development
+
+```
+%cp spec/database.yml.sample spec/database.yml
+```
+
+```
+%bundle exec rspec
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/bluerabbit/with_lock_version.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "with_lock_version"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/gemfiles/rails_4_1.gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+gem "rails", "~> 4.1.0"
+
+# NOTE: mysql2 v0.4.x will not work with Rails 4.1
+gem "mysql2", "~> 0.3.20"
+
+gemspec path: '../'

data/gemfiles/rails_4_2.gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem "rails", "~> 4.2.0"
+
+gemspec path: '../'

data/gemfiles/rails_5_2.gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem "rails", "~> 5.2.0.beta1"
+
+gemspec path: '../'

data/lib/with_lock_version.rb

@@ -0,0 +1,10 @@
+require "active_record"
+require "with_lock_version/version"
+require "with_lock_version/active_record_ext"
+
+module WithLockVersion
+end
+
+ActiveSupport.on_load :active_record do
+  ActiveRecord::Base.include(WithLockVersion::ActiveRecordExt)
+end

data/lib/with_lock_version/active_record_ext.rb

@@ -0,0 +1,45 @@
+module WithLockVersion
+  module ActiveRecordExt
+    def self.included(model)
+      model.extend ClassMethods
+    end
+
+    module ClassMethods
+      def with_lock_versionable
+        include WithLockVersion::ActiveRecordExt::Core
+      end
+    end
+
+    module Core
+      def self.included(model)
+        model.extend ClassMethods
+      end
+
+      def with_lock_version(target_lock_version)
+        unless lock_version.to_i == target_lock_version.to_i
+          raise_error
+        end
+
+        with_lock do
+          unless lock_version.to_i == target_lock_version.to_i
+            raise_error
+          end
+
+          touch # Update lock_version + 1
+
+          yield
+        end
+      end
+
+      private
+
+      def raise_error
+        if ActiveRecord::StaleObjectError.method(:new).arity == 0
+          raise ActiveRecord::StaleObjectError
+        else
+          raise ActiveRecord::StaleObjectError.new(self, "with_lock_version mismatch")
+        end
+      end
+    end
+  end
+end

data/lib/with_lock_version/version.rb

@@ -0,0 +1,3 @@
+module WithLockVersion
+  VERSION = "0.1.0"
+end

data/with_lock_version.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'with_lock_version/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "with_lock_version"
+  spec.version       = WithLockVersion::VERSION
+  spec.authors       = ["Akira Kusumoto"]
+  spec.email         = ["akirakusumo10@gmail.com"]
+
+  spec.summary       = "Optimistic lock helper on ActiveRecord."
+  spec.description   = "Optimistic lock helper on ActiveRecord."
+  spec.homepage      = "https://github.com/bluerabbit/with_lock_version"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject {|f| f.match(%r{^(test|spec|features)/})}
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) {|f| File.basename(f)}
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "rails"
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "mysql2"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: with_lock_version
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Akira Kusumoto
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-11-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Optimistic lock helper on ActiveRecord.
+email:
+- akirakusumo10@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- gemfiles/rails_4_1.gemfile
+- gemfiles/rails_4_2.gemfile
+- gemfiles/rails_5_2.gemfile
+- lib/with_lock_version.rb
+- lib/with_lock_version/active_record_ext.rb
+- lib/with_lock_version/version.rb
+- with_lock_version.gemspec
+homepage: https://github.com/bluerabbit/with_lock_version
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Optimistic lock helper on ActiveRecord.
+test_files: []