atomically 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 94187458ce758fe40e71ba068f03dad4e2d8cebb0757099b8cecad1f1a8da017
-  data.tar.gz: c79301b92a0436536feb4f850ba7e1b5f8fb8d589c17e50b9b6c20a38022826c
+  metadata.gz: 215319d576e714905af55fcb2ec48b1924c5971bf0e0bdaf3c61f75be3862a13
+  data.tar.gz: 6171664742f2758011c79058fc2fd13850e11bb61c28604f24625e4ed107026f
 SHA512:
-  metadata.gz: 5163ddf343c94d028e7ea2b6fadd62baccf65e49a9d57ef08ff0894a1a3113c14048af6a410c7129604292c5d9d39d3c81ff94a8293f24b0eb08c170039beb59
-  data.tar.gz: 5d02fedd2c17837517874714a23ffedd0a801a93cb12adf1217ed59cf8af483fd1793320f6fb7bbbf3aa35257ba9efda034245b194728949b8c526eaf07c07e2
+  metadata.gz: 117f29a0644c694a25bef5ebd0d5bf8219e1a9e2521e0fad95f8ee5180ebad418d2651b10d3259a06735b495d23ceb4de1a75d3e928fe4dc725203aece924306
+  data.tar.gz: 62482706f8a98ad1bc71041c323596a117e810330921b90e9395134c7d495c9c7e2b7f01378151178abd20b11dffad42678e9b2fdd0e851776d2de81537c10be

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+## Change Log
+
+### [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)
+
+### v1.0.1 2018/11/22
+- [#2](https://github.com/khiav223577/atomically/pull/2) Implement `pay_all` (@khiav223577)
+- [#1](https://github.com/khiav223577/atomically/pull/1) Implement `create_or_plus` (@khiav223577)

data/README.md

@@ -28,14 +28,17 @@ Or install it yourself as:
 
 ## Usage
 
-### create_or_plus
+### create_or_plus _(columns, values, on_duplicate_update_columns)_
 
 Import an array of records. When key is duplicate, plus the old value with new value.
 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.
+#### Parameters
 
-Example:
+  - First two args (`columns`, `values`) are the same with the [import](https://github.com/zdennis/activerecord-import#columns-and-arrays) method.
+  - `on_duplicate_update_columns` - The column that will be updated on duplicate.
+
+#### Example
 ```rb
 user = User.find(2)
 item1 = Item.find(1)
@@ -50,28 +53,81 @@ on_duplicate_update_columns = [:quantity]
 UserItem.atomically.create_or_plus(columns, values, on_duplicate_update_columns)
 ```
 
-#### before
+before
+
 ![before](https://user-images.githubusercontent.com/4011729/48998921-ff430600-f18f-11e8-8eeb-e8a71bbf5802.png)
 
-#### after
+after
+
 ![image](https://user-images.githubusercontent.com/4011729/48999092-8d1ef100-f190-11e8-8372-86e2e99cbe08.png)
 
 
-### pay_all
+### 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.
 Do nothing and return zero if any of them is not enough.
 
-Example:
+#### Parameters
+
+  - `hash` - A hash contains the id of the models as keys and the amount to update the field by as values.
+  - `update_columns` - The column that will be updated.
+  - `primary_key` - Specify the column that `id`(the key of hash) refer to.
+
+#### Example
+
 ```rb
 user.user_items.atomically.pay_all({ item1.id => 4, item2.id => 3 }, [:quantity], primary_key: :item_id)
 ```
 
-### update
+```sql
+# generated sql
+UPDATE `user_items` SET `quantity` = `quantity` + (@change := 
+  CASE `item_id`
+  WHEN 1 THEN -4
+  WHEN 2 THEN -3
+  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)
+) AND (
+  (
+    SELECT COUNT(*) FROM (
+      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)
+      )
+    ) subquery
+  ) = 2
+)
+```
+
+### 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.
+
+#### Parameters
+
+  - `expected_number` - The number of rows that you expect to be updated.
+  - `updates` - A string, array, or hash representing the SET part of an SQL statement.
+
+#### Examples
+```rb
+User.where(id: [1, 2]).atomically.update_all(2, name: '')
+# => 2
+
+User.where(id: [1, 2, 3]).atomically.update_all(2, name: '')
+# => 0
+```
+
+### 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.
 
-Example:
+#### 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.
+ 
+#### Example
 ```rb
 class Arena < ApplicationRecord
   def atomically_close!

data/lib/atomically/query_service.rb

@@ -35,8 +35,11 @@ class Atomically::QueryService
       next "#{column} = #{column} + #{value}"
     end
 
-    return query.where("(#{@klass.from(query).select('COUNT(*)').to_sql}) = ?", hash.size)
-                .update_all(update_sqls.join(', '))
+    return where_all_can_be_updated(query, hash.size).update_all(update_sqls.join(', '))
+  end
+
+  def update_all(expected_size, *args)
+    where_all_can_be_updated(@relation, expected_size).update_all(*args)
   end
 
   def update(attrs, from: :not_set)
@@ -59,6 +62,10 @@ class Atomically::QueryService
     @klass.connection.quote(value)
   end
 
+  def where_all_can_be_updated(query, expected_size)
+    query.where("(#{@klass.from(query.where('')).select('COUNT(*)').to_sql}) = ?", expected_size)
+  end
+
   def update_and_return_number_of_updated_rows(attrs, from)
     model = @model
     return open_update_all_scope do

data/lib/atomically/version.rb

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

metadata

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