atomically 1.0.4 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec69d82cbee452fb2b61bd973aa1a885e5cffd5cdd8c5b5e6bb96ea066c8f7b1
-  data.tar.gz: be3720c0644d7c8228ea3b8ae88fd05c1850c66f629819977cc4758b8ec0d3d9
+  metadata.gz: b4cd43d76a8ee02e70abdfe675dd3bf47047749d076f392ae117ceb28d52c270
+  data.tar.gz: 503c635e9e29701623b2a46615ac19b3da0b61e601f604e14f5ba9e498e5ebff
 SHA512:
-  metadata.gz: 1b88cc95978a5c3cf4913d812e99e32aa4ef6b2bee12572e7e9eccea51edeadae8c78cdd42ad2f436ea9f3749832c1cacec0dd380a64900b0caa1936446b9a7a
-  data.tar.gz: ea519708c2c2d24b7876f810095adf0a9b599d713b3e7cb4091981d567886ce9c28644d42bca688790ada4d0e9e5b153bc3f9c6149fc060818768ec12493d437
+  metadata.gz: 8cecca409c00e5495b0d406795cb414a4a9eb57babf630c7dadd918119f92a3ea45cec32b916b224a4b48da4b1a92bb6464bf8782db39c24608c142451ef9506
+  data.tar.gz: 3b109442240656564ee4b10a699e180613c76ce9d6006e8667f57c42f811ab4c9e918601bd59bad80c042ef1830a8bb8cdede0db66bf1fe96f02166b64574249

data/.rubocop.yml

@@ -386,6 +386,7 @@ Layout/AlignHash:
   Description: >-
                  Align the elements of a hash literal if they span more than
                  one line.
+  EnforcedHashRocketStyle: table
   Enabled: true
 
 Layout/AlignParameters:
@@ -787,7 +788,8 @@ Style/Next:
 Style/NilComparison:
   Description: 'Prefer x.nil? to x == nil.'
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#predicate-methods'
-  Enabled: false
+  EnforcedStyle: comparison
+  Enabled: true
 
 Style/NonNilCheck:
   # With `IncludeSemanticChanges` set to `true`, this cop reports offenses for
@@ -799,7 +801,7 @@ Style/NonNilCheck:
   Description: 'Checks for redundant nil checks.'
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-non-nil-checks'
   IncludeSemanticChanges: true
-  Enabled: true
+  Enabled: false
 
 Style/Not:
   Description: 'Use ! instead of not.'
@@ -903,7 +905,7 @@ Style/RegexpLiteral:
   Description: 'Use / or %r around regular expressions.'
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#percent-r'
   EnforcedStyle: slashes
-  AllowInnerSlashes: true
+  AllowInnerSlashes: false
   Enabled: true
 
 Layout/RescueEnsureAlignment:

data/.travis.yml

@@ -1,13 +1,13 @@
 sudo: false
-env:
-  global:
-    - CC_TEST_REPORTER_ID=12e1facab2e8910c9b9d6b9e6870c5544a5c44a1bef25cc6638fd132aa4af6b4
 language: ruby
 rvm:
   - 2.2
   - 2.5
 env:
-  - DB=mysql
+  global:
+    - CC_TEST_REPORTER_ID=12e1facab2e8910c9b9d6b9e6870c5544a5c44a1bef25cc6638fd132aa4af6b4
+  matrix:
+    - DB=mysql
 gemfile:
   - gemfiles/3.2.gemfile
   - gemfiles/4.2.gemfile
@@ -20,7 +20,7 @@ matrix:
       rvm: 2.5
 before_install:
   - gem i rubygems-update -v '<3' && update_rubygems
-  - gem install bundler
+  - gem install bundler -v 1.17.3
   - gem --version
   - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
   - chmod +x ./cc-test-reporter

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## Change Log
 
+### [v1.0.4](https://github.com/khiav223577/atomically/compare/v1.0.3...v1.0.4) 2018/12/21
+- [#7](https://github.com/khiav223577/atomically/pull/7) Implement `update_all_and_get_ids` (@khiav223577)
+- [#6](https://github.com/khiav223577/atomically/pull/6) Add warning (@kakas)
+- [#5](https://github.com/khiav223577/atomically/pull/5) fix README `pay_all` description (@kakas)
+
+### [v1.0.3](https://github.com/khiav223577/atomically/compare/v1.0.2...v1.0.3) 2018/11/28
+- [#4](https://github.com/khiav223577/atomically/pull/4) Implement `update_all` (@khiav223577)
+
 ### [v1.0.2](https://github.com/khiav223577/atomically/compare/v1.0.1...v1.0.2) 2018/11/27
 - [#3](https://github.com/khiav223577/atomically/pull/3) Implement `update` (@khiav223577)
 

data/README.md

@@ -14,11 +14,14 @@ Supports Rails 3.2, 4.2, 5.0, 5.1, 5.2.
 
 1. [Installation](#installation)
 2. [Methods](#methods)
-   - [create_or_plus](#create_or_plus-columns-values-on_duplicate_update_columns)
-   - [pay_all](#pay_all-hash-update_columns-primary_key-id)
-   - [update_all](#update_all-expected_number-updates)
-   - [update](#update-attrs-from-not_set)
-   - [update_all_and_get_ids](#update_all_and_get_ids-updates)
+   - Relation Methods
+     - [create_or_plus](#create_or_plus-columns-values-on_duplicate_update_columns)
+     - [pay_all](#pay_all-hash-update_columns-primary_key-id)
+     - [update_all](#update_all-expected_number-updates)
+     - [update_all_and_get_ids](#update_all_and_get_ids-updates)
+   - Model Methods
+     - [update](#update-attrs-from-not_set)
+     - [decrement_unsigned_counters](#decrement_unsigned_counters-counters)
 3. [Development](#development)
 4. [Contributing](#contributing)
 5. [License](#license)
@@ -158,6 +161,33 @@ UPDATE `users` SET `users`.`name` = '' WHERE `users`.`id` IN (1, 2, 3) AND (
 )
 ```
 
+---
+### update_all_and_get_ids _(updates)_
+
+Behaves like [ActiveRecord::Relation#update_all](https://apidock.com/rails/ActiveRecord/Relation/update_all), but return the ids array of updated records instead of the number of updated records.
+
+
+#### Parameters
+
+  - `updates` - A string, array, or hash representing the SET part of an SQL statement.
+
+#### Example
+
+```rb
+User.where(account: ['moon', 'wolf']).atomically.update_all_and_get_ids('money = money + 1')
+# => [254, 371]
+```
+
+#### SQL queries
+
+```sql
+BEGIN
+  SET @ids := NULL
+  UPDATE `users` SET money = money + 1 WHERE `users`.`account` IN ('moon', 'wolf') AND ((SELECT @ids := CONCAT_WS(',', `users`.`id`, @ids)))
+  SELECT @ids FROM DUAL
+COMMIT
+```
+
 ---
 ### update _(attrs, from: :not_set)_
 
@@ -166,7 +196,7 @@ Updates the attributes of the model from the passed-in hash and saves the record
 #### Parameters
 
   - `attrs` - Same with the first parameter of [ActiveRecord#update](https://apidock.com/rails/ActiveRecord/Persistence/update)
-  - `from` - The value before update. If not set, use the attriutes of the model.
+  - `from` - The value before update. If not set, use the current attriutes of the model.
 
 #### Example
 
@@ -186,6 +216,7 @@ end
 
 ```sql
 # arena.atomically_close!
+# (let arena.closed_at to be nil)
 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
 
@@ -195,30 +226,37 @@ WHERE `arenas`.`id` = 1752
 ```
 
 ---
-### update_all_and_get_ids _(updates)_
+### decrement_unsigned_counters _(counters)_
 
-Behaves like [ActiveRecord::Relation#update_all](https://apidock.com/rails/ActiveRecord/Relation/update_all), but return the ids array of updated records instead of the number of updated records.
+Decrement numeric fields via a direct SQL update, and make sure that it will not become negative.
 
 
 #### Parameters
 
-  - `updates` - A string, array, or hash representing the SET part of an SQL statement.
+  - `counters` - A Hash containing the names of the fields to update as keys and the amount to update the field by as values.
 
 #### Example
 
 ```rb
-User.where(account: ['moon', 'wolf']).atomically.update_all_and_get_ids('money = money + 1')
-# => [254, 371]
+user.money
+# => 100
+
+user.atomically.decrement_unsigned_counters(money: 10)
+# => true
+user.reload.money
+# => 90
+
+user.atomically.decrement_unsigned_counters(money: 999)
+# => false
+user.reload.money
+# => 90
 ```
 
 #### SQL queries
 
 ```sql
-BEGIN
-  SET @ids := NULL
-  UPDATE `users` SET money = money + 1 WHERE `users`.`account` IN ('moon', 'wolf') AND ((SELECT @ids := CONCAT_WS(',', `users`.`id`, @ids)))
-  SELECT @ids FROM DUAL
-COMMIT
+# user.atomically.decrement_unsigned_counters(money: 140)
+UPDATE `users` SET money = money - 140 WHERE `users`.`id` = 1 AND (money > 140)
 ```
 
 ## Development

data/atomically.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ['khiav reoy']
   spec.email         = ['mrtmrt15xn@yahoo.com.tw']
 
-  spec.summary       = ''
-  spec.description   = ''
+  spec.summary       = 'Adds commonly useful atomic SQL statements to ActiveRecord to avoid race condition.'
+  spec.description   = 'Adds commonly useful atomic SQL statements to ActiveRecord to avoid race condition.'
   spec.homepage      = 'https://github.com/khiav223577/atomically'
   spec.license       = 'MIT'
 
@@ -27,7 +27,7 @@ Gem::Specification.new do |spec|
   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 'bundler', '>= 1.17', '< 3.x'
   spec.add_development_dependency 'rake', '~> 12.0'
   spec.add_development_dependency 'sqlite3', '~> 1.3'
   spec.add_development_dependency 'minitest', '~> 5.0'

data/lib/atomically/query_service.rb

@@ -48,6 +48,19 @@ class Atomically::QueryService
     return success
   end
 
+  # ==== Parameters
+  #
+  # * +counters+ - A Hash containing the names of the fields
+  #   to update as keys and the amount to update the field by as values.
+  def decrement_unsigned_counters(counters)
+    result = open_update_all_scope do
+      counters.each do |field, amount|
+        where("#{field} > ?", amount).update("#{field} = #{field} - ?", amount) if amount > 0
+      end
+    end
+    return (result == 1)
+  end
+
   def update_all_and_get_ids(*args)
     ids = nil
     id_column = "#{@klass.quoted_table_name}.#{quote_column(:id)}"

data/lib/atomically/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Atomically
-  VERSION = '1.0.4'
+  VERSION = '1.0.5'
 end

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: atomically
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
 platform: ruby
 authors:
 - khiav reoy
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-12-21 00:00:00.000000000 Z
+date: 2019-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.17'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: 3.x
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.17'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: 3.x
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -150,7 +156,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.1.8
-description: ''
+description: Adds commonly useful atomic SQL statements to ActiveRecord to avoid race
+  condition.
 email:
 - mrtmrt15xn@yahoo.com.tw
 executables: []
@@ -206,5 +213,6 @@ rubyforge_project:
 rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
-summary: ''
+summary: Adds commonly useful atomic SQL statements to ActiveRecord to avoid race
+  condition.
 test_files: []