action-store 0.3.3 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d3f20d025cda1c0724c4b9b053288efb85d714069d90fff728c59affc3a47da0
-  data.tar.gz: c94553d106707178ffd85c2c2e2aef41feaaa040441faf4fca96356ec46a5fc2
+  metadata.gz: e856a3c707a03c3b16ad3e5ab629ce80741c8a2ba929e70cec2b2b84c75187c9
+  data.tar.gz: df3ccb912b970c2e3b8512720382d09551880abb9f7b0c8e48c57e1b0d421318
 SHA512:
-  metadata.gz: cb20154fbc1dba325e3a40415d7940b37f7e52aa1dfc877da24ba6cdb5691f0f99788b7a737688f083ff37ee8659393496344febaf0d62b97e08db5f61b378fb
-  data.tar.gz: 3f925347dca40f57691af345af33e47fbd58d0b6b24deaabe0d89f3ebad3d24874d050783387d3dfc216fe500d3f31cf5d7682e99b5ac5935fc7760296ed7765
+  metadata.gz: bc193bc4b1a8f8a56b7a8c5ea4eee112e0a794e4b300d9abff91d3409f58976bea1312b84ba988c4a74e8e69934c312c3e0f648101738ac754f9d7a76998e4e5
+  data.tar.gz: 76daff55736babee4d1d58a80eeb28d624a585832b7e52f84f05235a30cc42c78a3290c241559486731ffce82e066b267d00d03e1109f0f14a1a1555d81b73c6

data/CHANGELOG.md

@@ -1,3 +1,23 @@
+0.4.2
+-----
+
+- Add `UNIQUE INDEX` on `:action_type, :target_type, :target_id, :user_type, :user_id` for makesure action uniqueness.
+  > NOTE! If you already have actions in database, the new migration may have issue on `db:migrate`,
+  > so you need fix them by remove duplicate.
+- Now `create_action` method use database to makesure unique.
+
+**Upgrade from 0.3.x:**
+
+You must use `rails g action_store:install` to generate the new migration file.
+
+```bash
+$ rails g action_store:install
+    conflict  config/initializers/action_store.rb
+Overwrite config/initializers/action_store.rb? (enter "h" for help) [Ynaqdhm] n
+        skip  config/initializers/action_store.rb
+Copied migration 20181121061544_add_unique_index_to_actions.action_store.rb from action_store
+````
+
 0.3.3
 -----
 

data/README.md

@@ -1,7 +1,7 @@
 ActionStore
 -----------
 
-[![Gem Version](https://badge.fury.io/rb/action-store.svg)](https://badge.fury.io/rb/action-store) [![Build Status](https://travis-ci.org/rails-engine/action-store.svg)](https://travis-ci.org/rails-engine/action-store) [![Code Climate](https://codeclimate.com/github/rails-engine/action-store/badges/gpa.svg)](https://codeclimate.com/github/rails-engine/action-store) [![codecov.io](https://codecov.io/github/rails-engine/action-store/coverage.svg?branch=master)](https://codecov.io/github/rails-engine/action-store?branch=master)
+[![Gem Version](https://badge.fury.io/rb/action-store.svg)](https://badge.fury.io/rb/action-store) [![Build Status](https://travis-ci.org/rails-engine/action-store.svg)](https://travis-ci.org/rails-engine/action-store) [![codecov.io](https://codecov.io/github/rails-engine/action-store/coverage.svg?branch=master)](https://codecov.io/github/rails-engine/action-store?branch=master)
 
 Store different kinds of actions (Like, Follow, Star, Block, etc.) in a single table via ActiveRecord Polymorphic Associations.
 
@@ -23,6 +23,12 @@ And more and more.
 | `action_option` | Secondary option for storing your custom status, or null if unneeded. |
 | `target_type`, `target_id` | Polymorphic Association for different `Target` models [User, Post, Comment] |
 
+### Uniqueness
+
+> version: ">= 0.4.0"
+
+The have database unique index on fields: `[action_type, target_type, target_id, user_type, user_id]` for keep uniqueness for same action from user to target.
+
 ## Usage
 
 ```rb
@@ -33,7 +39,7 @@ and run `bundle install`
 
 Generate Migrations:
 
-```
+```bash
 $ rails g action_store:install
 create  config/initializers/action_store.rb
 migration 20170208024704_create_actions.rb from action_store
@@ -47,7 +53,7 @@ Use `action_store` to define actions:
 
 app/models/user.rb
 
-```
+```rb
 class User < ActiveRecord::Base
   action_store <action_type>, <target>, opts
 end
@@ -124,21 +130,55 @@ irb> action.present?
 true
 ```
 
-Other following use cases:
+**Other following use cases:**
 
 ```rb
 # @user1 -> follow @user2
-@user1.create_action(:follow, target: @user2)
-@user1.reload.following_count => 1
-@user2.reload.followers_count_ => 1
-@user1.follow_user?(@user2) => true
+irb> @user1.create_action(:follow, target: @user2)
+irb> @user1.reload.following_count
+=> 1
+irb> @user2.reload.followers_count_
+=> 1
+irb> @user1.follow_user?(@user2)
+=> true
+
 # @user2 -> follow @user1
-@user2.create_action(:follow, target: @user1)
-@user2.follow_user?(@user1) => true
+irb> @user2.create_action(:follow, target: @user1)
+irb> @user2.follow_user?(@user1)
+=> true
+
 # @user1 -> follow @user3
-@user1.create_action(:follow, target: @user3)
+irb> @user1.create_action(:follow, target: @user3)
+
 # @user1 -> unfollow @user3
- @user1.destroy_action(:follow, target: @user3)
+irb> @user1.destroy_action(:follow, target: @user3)
+```
+
+**Subscribe cases:**
+
+Sometimes, you may need use `action_option` option.
+
+For example, user to subscribe a issue (like GitHub Issue) on issue create, and they wants keep in subscribe list on unsubscribe for makesure next comment will not subscribe this issue again.
+
+So, in this case, we should not use `@user.unsubscribe_issue` method to destroy action record, we need set a value on `action_option` to mark this subscribe is `ignore`.
+
+```rb
+irb> User.create_action(:subscribe, target: @issue, user: @user)
+irb> @user.subscribe_issue?(@issue)
+=> true
+
+irb> User.create_action(:subscribe, target: @issue, user: @user, action_option: "ignore")
+irb> @user.subscribe_issue?(@issue)
+=> true
+
+irb> action = User.find_action(:subscribe, target: @issue, user: @user)
+irb> action.action_option
+=> "ignore"
+
+irb> @issue.subscribe_by_user_actions.count
+=> 1
+irb> @issue.subscribe_by_user_actions.where(action_option: nil).count
+=> 0
 ```
 
 ## Built-in relations and methods

data/db/migrate/20181121052638_add_unique_index_to_actions.rb

@@ -0,0 +1,5 @@
+class AddUniqueIndexToActions < ActiveRecord::Migration[5.0]
+  def change
+    add_index :actions, [:action_type, :target_type, :target_id, :user_type, :user_id], unique: true, name: :uk_action_target_user
+  end
+end

data/lib/action_store/mixin.rb

@@ -81,10 +81,16 @@ module ActionStore
         defined_action = find_defined_action(opts[:action_type], opts[:target_type])
         return false if defined_action.nil?
 
-        action = Action.find_or_create_by(where_opts(opts))
-        if opts[:action_option]
-          action.update_attribute(:action_option, opts[:action_option])
+        # create! for raise RecordNotUnique
+        begin
+          action = Action.find_or_create_by!(where_opts(opts))
+          action.update(action_option: opts[:action_option]) if opts.key?(:action_option)
+        rescue ActiveRecord::RecordNotUnique
+          # update action_option on exist
+          action = Action.where(where_opts(opts)).take
+          action.update(action_option: opts[:action_option]) if opts.key?(:action_option)
         end
+
         reset_counter_cache(action, defined_action)
         true
       end

data/lib/action_store/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module ActionStore
-  VERSION = "0.3.3"
+  VERSION = "0.4.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: action-store
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.4.2
 platform: ruby
 authors:
 - Jason Lee
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: factory_girl
+  name: factory_bot
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -94,6 +94,7 @@ files:
 - app/models/action.rb
 - config/initializers/action_store.rb
 - db/migrate/20170204035500_create_actions.rb
+- db/migrate/20181121052638_add_unique_index_to_actions.rb
 - lib/action-store.rb
 - lib/action_store/configuration.rb
 - lib/action_store/engine.rb
@@ -121,7 +122,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.8
 signing_key: 
 specification_version: 4
 summary: Store difference kind of actions (Like, Follow, Star, Block ...) in one table.