atomically 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d38cf83ab4f1e792cfefbb2c01ac897377fb7af2a81da6f09f932df4d5fa76f2
-  data.tar.gz: 88640837b4c69ef162d036b2a3e6ad61087e94a6baa79cde026fb748f09b58f1
+  metadata.gz: 94187458ce758fe40e71ba068f03dad4e2d8cebb0757099b8cecad1f1a8da017
+  data.tar.gz: c79301b92a0436536feb4f850ba7e1b5f8fb8d589c17e50b9b6c20a38022826c
 SHA512:
-  metadata.gz: cd968dcc060705bc3d0174daf532fa4c80b8dfadc5845a7406bcf68d930744c6ce78e2f04b97091eb4cea27818ed44df1e4b3c47eefac5e0643ab492b9bed21b
-  data.tar.gz: 7577dd5ef6f32a4d3753c71637d218358d48aeac8b7c675c9b780d906af56f08bd9cf5cb14d7b98fd12a9275d28f6d45ec8a5baaccb3b177257e300a04c0c890
+  metadata.gz: 5163ddf343c94d028e7ea2b6fadd62baccf65e49a9d57ef08ff0894a1a3113c14048af6a410c7129604292c5d9d39d3c81ff94a8293f24b0eb08c170039beb59
+  data.tar.gz: 5d02fedd2c17837517874714a23ffedd0a801a93cb12adf1217ed59cf8af483fd1793320f6fb7bbbf3aa35257ba9efda034245b194728949b8c526eaf07c07e2

data/.rubocop.yml

@@ -1013,7 +1013,8 @@ Layout/SpaceInsideBlockBraces:
                  Checks that block braces have or don't have surrounding space.
                  For blocks taking parameters, checks that the left brace has
                  or doesn't have trailing space.
-  Enabled: false
+  SpaceBeforeBlockParameters: false
+  Enabled: true
 
 Layout/SpaceAroundBlockParameters:
   Description: 'Checks the spacing inside and after block parameters pipes.'

data/README.md

@@ -1,7 +1,7 @@
 # Atomically
 
 [![Gem Version](https://img.shields.io/gem/v/atomically.svg?style=flat)](https://rubygems.org/gems/atomically)
-[![Build Status](https://travis-ci.org/khiav223577/atomically.svg?branch=master)](https://travis-ci.org/khiav223577/atomically)
+[![Build Status](https://api.travis-ci.com/khiav223577/atomically.svg?branch=master)](https://travis-ci.com/khiav223577/atomically)
 [![RubyGems](http://img.shields.io/gem/dt/atomically.svg?style=flat)](https://rubygems.org/gems/atomically)
 [![Code Climate](https://codeclimate.com/github/khiav223577/atomically/badges/gpa.svg)](https://codeclimate.com/github/khiav223577/atomically)
 [![Test Coverage](https://codeclimate.com/github/khiav223577/atomically/badges/coverage.svg)](https://codeclimate.com/github/khiav223577/atomically/coverage)
@@ -36,6 +36,12 @@ It is useful to add `items` to `user` when `user_items` may not exist.
 First two args (columns, values) are the same with the [import](https://github.com/zdennis/activerecord-import#columns-and-arrays) method.
 
 Example:
+```rb
+user = User.find(2)
+item1 = Item.find(1)
+item2 = Item.find(2)
+```
+
 ```rb
 columns = [:user_id, :item_id, :quantity]
 values = [[user.id, item1.id, 3], [user.id, item2.id, 2]]
@@ -44,7 +50,15 @@ on_duplicate_update_columns = [:quantity]
 UserItem.atomically.create_or_plus(columns, values, on_duplicate_update_columns)
 ```
 
+#### before
+![before](https://user-images.githubusercontent.com/4011729/48998921-ff430600-f18f-11e8-8eeb-e8a71bbf5802.png)
+
+#### after
+![image](https://user-images.githubusercontent.com/4011729/48999092-8d1ef100-f190-11e8-8372-86e2e99cbe08.png)
+
+
 ### pay_all
+
 Reduce the quantity of items and return how many rows and updated if all of them is enough.
 Do nothing and return zero if any of them is not enough.
 
@@ -53,6 +67,32 @@ Example:
 user.user_items.atomically.pay_all({ item1.id => 4, item2.id => 3 }, [:quantity], primary_key: :item_id)
 ```
 
+### update
+
+Updates the attributes of the model from the passed-in hash and saves the record. The difference between this method and [ActiveRecord#update](https://apidock.com/rails/ActiveRecord/Persistence/update) is that it will add extra WHERE conditions to prevent race condition.
+
+Example:
+```rb
+class Arena < ApplicationRecord
+  def atomically_close!
+    atomically.update(closed_at: Time.now)
+  end
+
+  def close!
+    update(closed_at: Time.now)
+  end
+end
+```
+```sql
+# arena.atomically_close!
+UPDATE `arenas` SET `arenas`.`closed_at` = '2018-11-27 03:44:25', `updated_at` = '2018-11-27 03:44:25'
+WHERE `arenas`.`id` = 1752 AND `arenas`.`closed_at` IS NULL
+
+# arena.close!
+UPDATE `arenas` SET `arenas`.`closed_at` = '2018-11-27 03:44:25', `updated_at` = '2018-11-27 03:44:25'
+WHERE `arenas`.`id` = 1752
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test DB=mysql` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/Rakefile

@@ -1,10 +1,10 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
+require 'bundler/gem_tasks'
+require 'rake/testtask'
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
+  t.libs << 'test'
+  t.libs << 'lib'
   t.test_files = FileList['test/**/*_test.rb']
 end
 
-task :default => :test
+task default: :test

data/atomically.gemspec

@@ -4,37 +4,38 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'atomically/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "atomically"
+  spec.name          = 'atomically'
   spec.version       = Atomically::VERSION
-  spec.authors       = ["khiav reoy"]
-  spec.email         = ["mrtmrt15xn@yahoo.com.tw"]
+  spec.authors       = ['khiav reoy']
+  spec.email         = ['mrtmrt15xn@yahoo.com.tw']
 
-  spec.summary       = %q{}
-  spec.description   = %q{}
-  spec.homepage      = "https://github.com/khiav223577/atomically"
-  spec.license       = "MIT"
+  spec.summary       = ''
+  spec.description   = ''
+  spec.homepage      = 'https://github.com/khiav223577/atomically'
+  spec.license       = 'MIT'
 
   # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
   # delete this section to allow pushing this gem to any host.
-  #if spec.respond_to?(:metadata)
-  #  spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
-  #else
-  #  raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
-  #end
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  # end
 
-  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.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_development_dependency "bundler", "~> 1.11"
-  spec.add_development_dependency "rake", "~> 12.0"
-  spec.add_development_dependency "sqlite3", "~> 1.3"
-  spec.add_development_dependency "minitest", "~> 5.0"
-  spec.add_development_dependency "mysql2", ">= 0.3"
-  spec.add_development_dependency "pluck_all", ">= 2.0.3"
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'sqlite3', '~> 1.3'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'mysql2', '>= 0.3'
+  spec.add_development_dependency 'pluck_all', '>= 2.0.3'
+  spec.add_development_dependency 'timecop', '~> 0.9.1'
 
-  spec.add_dependency "activerecord", ">= 3"
-  spec.add_dependency "activerecord-import", ">= 0.27.0"
-  spec.add_dependency "rails_or", ">= 1.1.8"
+  spec.add_dependency 'activerecord', '>= 3'
+  spec.add_dependency 'activerecord-import', '>= 0.27.0'
+  spec.add_dependency 'rails_or', '>= 1.1.8'
 end

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "atomically"
+require 'bundler/setup'
+require 'atomically'
 
 # 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.
@@ -10,5 +10,5 @@ require "atomically"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start

data/gemfiles/3.2.gemfile

@@ -1,15 +1,16 @@
 source 'https://rubygems.org'
 
-gem "activerecord", "~> 3.2.0"
+gem 'activerecord', '~> 3.2.0'
 
 group :test do
   case ENV['DB']
-  when "mysql"    ; gem 'mysql2' , '0.3.21'
-  when "postgres" ; gem 'pg', '~> 0.18'
+  when 'mysql'    ; gem 'mysql2', '0.3.21'
+  when 'postgres' ; gem 'pg', '~> 0.18'
   end
-  gem "simplecov"
-  gem "codeclimate-test-reporter", "~> 1.0.0"
+  gem 'simplecov'
+  gem 'codeclimate-test-reporter', '~> 1.0.0'
+  gem 'pluck_all', '>= 2.0.3'
+  gem 'timecop', '~> 0.9.1'
 end
 
-gemspec :path => "../"
-
+gemspec path: '../'

data/gemfiles/4.2.gemfile

@@ -1,15 +1,16 @@
 source 'https://rubygems.org'
 
-gem "activerecord", "~> 4.2.0"
+gem 'activerecord', '~> 4.2.0'
 
 group :test do
   case ENV['DB']
-  when "mysql"    ; gem 'mysql2' , '0.3.21'
-  when "postgres" ; gem 'pg', '~> 0.18'
+  when 'mysql'    ; gem 'mysql2', '0.3.21'
+  when 'postgres' ; gem 'pg', '~> 0.18'
   end
-  gem "simplecov"
-  gem "codeclimate-test-reporter", "~> 1.0.0"
+  gem 'simplecov'
+  gem 'codeclimate-test-reporter', '~> 1.0.0'
+  gem 'pluck_all', '>= 2.0.3'
+  gem 'timecop', '~> 0.9.1'
 end
 
-gemspec :path => "../"
-
+gemspec path: '../'

data/gemfiles/5.0.gemfile

@@ -1,15 +1,16 @@
 source 'https://rubygems.org'
 
-gem "activerecord", "~> 5.0.0"
+gem 'activerecord', '~> 5.0.0'
 
 group :test do
   case ENV['DB']
-  when "mysql"    ; gem 'mysql2' , '0.3.21'
-  when "postgres" ; gem 'pg', '~> 0.18'
+  when 'mysql'    ; gem 'mysql2', '0.3.21'
+  when 'postgres' ; gem 'pg', '~> 0.18'
   end
-  gem "simplecov"
-  gem "codeclimate-test-reporter", "~> 1.0.0"
+  gem 'simplecov'
+  gem 'codeclimate-test-reporter', '~> 1.0.0'
+  gem 'pluck_all', '>= 2.0.3'
+  gem 'timecop', '~> 0.9.1'
 end
 
-gemspec :path => "../"
-
+gemspec path: '../'

data/gemfiles/5.1.gemfile

@@ -1,15 +1,16 @@
 source 'https://rubygems.org'
 
-gem "activerecord", "~> 5.1.0"
+gem 'activerecord', '~> 5.1.0'
 
 group :test do
   case ENV['DB']
-  when "mysql"    ; gem 'mysql2' , '0.3.21'
-  when "postgres" ; gem 'pg', '~> 0.18'
+  when 'mysql'    ; gem 'mysql2', '0.3.21'
+  when 'postgres' ; gem 'pg', '~> 0.18'
   end
-  gem "simplecov"
-  gem "codeclimate-test-reporter", "~> 1.0.0"
+  gem 'simplecov'
+  gem 'codeclimate-test-reporter', '~> 1.0.0'
+  gem 'pluck_all', '>= 2.0.3'
+  gem 'timecop', '~> 0.9.1'
 end
 
-gemspec :path => "../"
-
+gemspec path: '../'

data/gemfiles/5.2.gemfile

@@ -1,15 +1,16 @@
 source 'https://rubygems.org'
 
-gem "activerecord", "~> 5.2.0"
+gem 'activerecord', '~> 5.2.0'
 
 group :test do
   case ENV['DB']
-  when "mysql"    ; gem 'mysql2' , '0.5.1'
-  when "postgres" ; gem 'pg', '~> 0.18'
+  when 'mysql'    ; gem 'mysql2', '0.5.1'
+  when 'postgres' ; gem 'pg', '~> 0.18'
   end
-  gem "simplecov"
-  gem "codeclimate-test-reporter", "~> 1.0.0"
+  gem 'simplecov'
+  gem 'codeclimate-test-reporter', '~> 1.0.0'
+  gem 'pluck_all', '>= 2.0.3'
+  gem 'timecop', '~> 0.9.1'
 end
 
-gemspec :path => "../"
-
+gemspec path: '../'

data/lib/atomically.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'atomically/version'
 require 'atomically/active_record/extension'
 

data/lib/atomically/active_record/extension.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_record'
 require 'atomically/query_service'
 
@@ -11,4 +13,8 @@ class ActiveRecord::Base
   def self.atomically
     Atomically::QueryService.new(self)
   end
+
+  def atomically
+    Atomically::QueryService.new(self.class, model: self)
+  end
 end

data/lib/atomically/patches/clear_attribute_changes.rb

@@ -0,0 +1,17 @@
+module ActiveModel
+  module Dirty
+    private
+
+    alias attributes_changed_by_setter changed_attributes # :nodoc:
+
+    # Force an attribute to have a particular "before" value
+    def set_attribute_was(attr, old_value)
+      attributes_changed_by_setter[attr] = old_value
+    end
+
+    # Remove changes information for the provided attributes.
+    def clear_attribute_changes(attributes) # :doc:
+      attributes_changed_by_setter.except!(*attributes)
+    end
+  end
+end

data/lib/atomically/patches/from.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 require 'active_record'
 
 class << ActiveRecord::Base
   def from(value) # For Rails 3
-    value = "(#{value.to_sql}) subquery" if value.is_a?( ActiveRecord::Relation )
+    value = "(#{value.to_sql}) subquery" if value.is_a?(ActiveRecord::Relation)
     return super
   end
 end

data/lib/atomically/patches/none.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_record'
 
 class << ActiveRecord::Base

data/lib/atomically/query_service.rb

@@ -2,13 +2,16 @@
 
 require 'activerecord-import'
 require 'rails_or'
+require 'atomically/update_all_scope'
+require 'atomically/patches/clear_attribute_changes' if not ActiveModel::Dirty.method_defined?(:clear_attribute_changes) and not ActiveModel::Dirty.private_method_defined?(:clear_attribute_changes)
 require 'atomically/patches/none' if not ActiveRecord::Base.respond_to?(:none)
 require 'atomically/patches/from' if Gem::Version.new(ActiveRecord::VERSION::STRING) < Gem::Version.new('4.0.0')
 
 class Atomically::QueryService
-  def initialize(klass, relation: nil)
+  def initialize(klass, relation: nil, model: nil)
     @klass = klass
     @relation = relation || @klass
+    @model = model
   end
 
   def create_or_plus(columns, data, update_columns)
@@ -36,9 +39,15 @@ class Atomically::QueryService
                 .update_all(update_sqls.join(', '))
   end
 
+  def update(attrs, from: :not_set)
+    success = update_and_return_number_of_updated_rows(attrs, from) == 1
+    assign_without_changes(attrs) if success
+    return success
+  end
+
   private
 
-  def on_duplicate_key_plus_sql( columns)
+  def on_duplicate_key_plus_sql(columns)
     columns.lazy.map(&method(:quote_column)).map{|s| "#{s} = #{s} + VALUES(#{s})" }.force.join(', ')
   end
 
@@ -49,4 +58,27 @@ class Atomically::QueryService
   def sanitize(value)
     @klass.connection.quote(value)
   end
+
+  def update_and_return_number_of_updated_rows(attrs, from)
+    model = @model
+    return open_update_all_scope do
+      update(updated_at: Time.now)
+      attrs.each do |column, value|
+        old_value = (from == :not_set ? model[column] : from)
+        where(column => old_value).update(column => value) if old_value != value
+      end
+    end
+  end
+
+  def open_update_all_scope(&block)
+    return 0 if @model == nil
+    scope = UpdateAllScope.new(model: @model)
+    scope.instance_exec(&block)
+    return scope.do_query!
+  end
+
+  def assign_without_changes(attributes)
+    @model.assign_attributes(attributes)
+    @model.send(:clear_attribute_changes, attributes.keys)
+  end
 end

data/lib/atomically/update_all_scope.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+class UpdateAllScope
+  def initialize(model: nil, relation: nil)
+    @queries = []
+    @relation = relation || model.class.where(id: model.id)
+  end
+
+  def where(*args)
+    @relation = @relation.where(*args)
+    return self
+  end
+
+  def update(query, *binding_values)
+    args = binding_values.size > 0 ? [[query, *binding_values]] : [query]
+    @queries << klass.send(:sanitize_sql_for_assignment, *args)
+    return self
+  end
+
+  def do_query!
+    return 0 if @queries.empty?
+    return @relation.update_all(@queries.join(','))
+  end
+
+  def klass
+    @relation.klass
+  end
+end

data/lib/atomically/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Atomically
-  VERSION = '1.0.1'
+  VERSION = '1.0.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: atomically
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - khiav reoy
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-11-22 00:00:00.000000000 Z
+date: 2018-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.0.3
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -163,9 +177,11 @@ files:
 - gemfiles/5.2.gemfile
 - lib/atomically.rb
 - lib/atomically/active_record/extension.rb
+- lib/atomically/patches/clear_attribute_changes.rb
 - lib/atomically/patches/from.rb
 - lib/atomically/patches/none.rb
 - lib/atomically/query_service.rb
+- lib/atomically/update_all_scope.rb
 - lib/atomically/version.rb
 homepage: https://github.com/khiav223577/atomically
 licenses: