atomically 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 215319d576e714905af55fcb2ec48b1924c5971bf0e0bdaf3c61f75be3862a13
-  data.tar.gz: 6171664742f2758011c79058fc2fd13850e11bb61c28604f24625e4ed107026f
+  metadata.gz: ec69d82cbee452fb2b61bd973aa1a885e5cffd5cdd8c5b5e6bb96ea066c8f7b1
+  data.tar.gz: be3720c0644d7c8228ea3b8ae88fd05c1850c66f629819977cc4758b8ec0d3d9
 SHA512:
-  metadata.gz: 117f29a0644c694a25bef5ebd0d5bf8219e1a9e2521e0fad95f8ee5180ebad418d2651b10d3259a06735b495d23ceb4de1a75d3e928fe4dc725203aece924306
-  data.tar.gz: 62482706f8a98ad1bc71041c323596a117e810330921b90e9395134c7d495c9c7e2b7f01378151178abd20b11dffad42678e9b2fdd0e851776d2de81537c10be
+  metadata.gz: 1b88cc95978a5c3cf4913d812e99e32aa4ef6b2bee12572e7e9eccea51edeadae8c78cdd42ad2f436ea9f3749832c1cacec0dd380a64900b0caa1936446b9a7a
+  data.tar.gz: ea519708c2c2d24b7876f810095adf0a9b599d713b3e7cb4091981d567886ce9c28644d42bca688790ada4d0e9e5b153bc3f9c6149fc060818768ec12493d437

data/.travis.yml

@@ -19,8 +19,8 @@ matrix:
     - gemfile: gemfiles/3.2.gemfile
       rvm: 2.5
 before_install:
+  - gem i rubygems-update -v '<3' && update_rubygems
   - gem install bundler
-  - gem update --system
   - gem --version
   - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
   - chmod +x ./cc-test-reporter

data/README.md

@@ -10,6 +10,19 @@
 
 Supports Rails 3.2, 4.2, 5.0, 5.1, 5.2.
 
+## Table of contents
+
+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)
+3. [Development](#development)
+4. [Contributing](#contributing)
+5. [License](#license)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -26,7 +39,9 @@ Or install it yourself as:
 
     $ gem install atomically
 
-## Usage
+## Methods
+
+Note: ActiveRecord validations and callbacks will **NOT** be triggered when calling below methods.
 
 ### create_or_plus _(columns, values, on_duplicate_update_columns)_
 
@@ -39,6 +54,7 @@ It is useful to add `items` to `user` when `user_items` may not exist.
   - `on_duplicate_update_columns` - The column that will be updated on duplicate.
 
 #### Example
+
 ```rb
 user = User.find(2)
 item1 = Item.find(1)
@@ -61,7 +77,16 @@ after
 
 ![image](https://user-images.githubusercontent.com/4011729/48999092-8d1ef100-f190-11e8-8372-86e2e99cbe08.png)
 
+#### SQL queries
 
+```sql
+INSERT INTO `user_items` (`user_id`,`item_id`,`quantity`,`created_at`,`updated_at`) VALUES
+  (2,1,3,'2018-11-27 03:44:25','2018-11-27 03:44:25'),
+  (2,2,2,'2018-11-27 03:44:25','2018-11-27 03:44:25')
+ON DUPLICATE KEY UPDATE `quantity` = `quantity` + VALUES(`quantity`)
+```
+
+---
 ### pay_all _(hash, update_columns, primary_key: :id)_
 
 Reduce the quantity of items and return how many rows and updated if all of them is enough.
@@ -79,19 +104,20 @@ Do nothing and return zero if any of them is not enough.
 user.user_items.atomically.pay_all({ item1.id => 4, item2.id => 3 }, [:quantity], primary_key: :item_id)
 ```
 
+#### SQL queries
+
 ```sql
-# generated sql
-UPDATE `user_items` SET `quantity` = `quantity` + (@change := 
+UPDATE `user_items` SET `quantity` = `quantity` + (@change :=
   CASE `item_id`
   WHEN 1 THEN -4
   WHEN 2 THEN -3
-  END) 
+  END)
 WHERE `user_items`.`user_id` = 1 AND (
-  `user_items`.`item_id` = 1 AND (`quantity` >= 4) OR `user_items`.`item_id` = -2 AND (`quantity` >= 3)
+  `user_items`.`item_id` = 1 AND (`quantity` >= 4) OR `user_items`.`item_id` = 2 AND (`quantity` >= 3)
 ) AND (
   (
     SELECT COUNT(*) FROM (
-      SELECT `user_items`.* FROM `user_items` 
+      SELECT `user_items`.* FROM `user_items`
       WHERE `user_items`.`user_id` = 1 AND (
         `user_items`.`item_id` = 1 AND (`quantity` >= 4) OR `user_items`.`item_id` = 2 AND (`quantity` >= 3)
       )
@@ -100,6 +126,7 @@ WHERE `user_items`.`user_id` = 1 AND (
 )
 ```
 
+---
 ### update_all _(expected_number, updates)_
 
 Behaves like [ActiveRecord::Relation#update_all](https://apidock.com/rails/ActiveRecord/Relation/update_all) but add an additional constrain that the number of affected rows equals to what you specify.
@@ -118,6 +145,20 @@ User.where(id: [1, 2, 3]).atomically.update_all(2, name: '')
 # => 0
 ```
 
+#### SQL queries
+
+```sql
+# User.where(id: [1, 2, 3]).atomically.update_all(2, name: '')
+UPDATE `users` SET `users`.`name` = '' WHERE `users`.`id` IN (1, 2, 3) AND (
+  (
+    SELECT COUNT(*) FROM (
+      SELECT `users`.* FROM `users` WHERE `users`.`id` IN (1, 2, 3)
+    ) subquery
+  ) = 2
+)
+```
+
+---
 ### update _(attrs, from: :not_set)_
 
 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.
@@ -126,8 +167,9 @@ Updates the attributes of the model from the passed-in hash and saves the record
 
   - `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.
- 
+
 #### Example
+
 ```rb
 class Arena < ApplicationRecord
   def atomically_close!
@@ -139,6 +181,9 @@ class Arena < ApplicationRecord
   end
 end
 ```
+
+#### SQL queries
+
 ```sql
 # arena.atomically_close!
 UPDATE `arenas` SET `arenas`.`closed_at` = '2018-11-27 03:44:25', `updated_at` = '2018-11-27 03:44:25'
@@ -149,6 +194,33 @@ UPDATE `arenas` SET `arenas`.`closed_at` = '2018-11-27 03:44:25', `updated_at` =
 WHERE `arenas`.`id` = 1752
 ```
 
+---
+### 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
+```
+
 ## 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/lib/atomically/query_service.rb

@@ -48,6 +48,17 @@ class Atomically::QueryService
     return success
   end
 
+  def update_all_and_get_ids(*args)
+    ids = nil
+    id_column = "#{@klass.quoted_table_name}.#{quote_column(:id)}"
+    @klass.transaction do
+      @relation.connection.execute('SET @ids := NULL')
+      @relation.where("(SELECT @ids := CONCAT_WS(',', #{id_column}, @ids))").update_all(*args) # 撈出有真的被更新的 id，用逗號串在一起
+      ids = @klass.from(nil).pluck('@ids').first
+    end
+    return ids.try{|s| s.split(',').map(&:to_i).uniq.sort } || [] # 將 id 從字串取出來 @id 的格式範例: '1,4,12'
+  end
+
   private
 
   def on_duplicate_key_plus_sql(columns)

data/lib/atomically/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: atomically
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - khiav reoy
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-11-28 00:00:00.000000000 Z
+date: 2018-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler