acts_as_reactable 0.2.7 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8bfe9ba5656866d662b502fc6c04288c05e8b2ecde0a48a4812f5dc5c12607da
-  data.tar.gz: 1f16f5de5bb6fd29c7e9f2afee9b22d8d692d88d8a3103e208e4764124a30118
+  metadata.gz: 17ef23a371d7abdef4f6134dec6841468f1fe8ac720a4087179c7760f57088d3
+  data.tar.gz: c7da600b50dde0fc8d1c432993f667dd0b96c7f2b8d081d20113549fda784577
 SHA512:
-  metadata.gz: 372e7d0ab30345f4b5870338d4c7b8006041d50b84e25c93d853b0dd8ed961724fac9fb2b7005dbc2b0ad3de7c80469812bc16e14ac3520fdb3e4933bf14be58
-  data.tar.gz: 168c5407c7934db6b4ddd4a3b3d86684af2362e1a6818e90bcdbdfcac84aa68c6163d212e3c43fb84b99597fbb3579541f4956b191a6f39010cb5f623cab234a
+  metadata.gz: e573dd63f8e9e87bc7a35d28b0e0462992a2860bc4d88a482e96e6a884aa14e56fd1e63013bfa33726fef3acd96c32138b81acdb94398e6395edf45771aea592
+  data.tar.gz: '09a8c3d23913f425d3a7f100dfe70f57b5bef53a337a45684b5417e9b195198ec543af5de098512644a8f8ed9b203513a9e1d8bb51e5d8509b75a72bf5bfd46d'

data/CHANGELOG.md

@@ -1,5 +1,34 @@
 ## [Unreleased]
 
+## [0.4.0](https://github.com/public-reactions/acts_as_reactable/compare/v0.3.0...v0.4.0) (2022-04-30)
+
+
+### Features
+
+* reactable#add_reactions ([#18](https://github.com/public-reactions/acts_as_reactable/issues/18)) ([7320703](https://github.com/public-reactions/acts_as_reactable/commit/73207036cfd4879f620d30ef3777448163e291e7))
+* reactable#remove_reactions ([#20](https://github.com/public-reactions/acts_as_reactable/issues/20)) ([100e7bd](https://github.com/public-reactions/acts_as_reactable/commit/100e7bd8e82b0b33de5a9427f82f6e0de40a7d51))
+
+
+### Bug Fixes
+
+* enforce standard ([d7c252c](https://github.com/public-reactions/acts_as_reactable/commit/d7c252cd6b7fae40e4f652efb4a6d2149fae9fa9))
+* should add unique index for reactable/reactor/emoji ([050dd6c](https://github.com/public-reactions/acts_as_reactable/commit/050dd6ca5865afed80084fccdd237155967d601c))
+
+## [0.3.0](https://github.com/public-reactions/acts_as_reactable/compare/v0.2.8...v0.3.0) (2022-04-25)
+
+
+### Features
+
+* enable multiple reactions to single subject for each user ([ec32854](https://github.com/public-reactions/acts_as_reactable/commit/ec32854897249a53d2a17b41509d7c7ab69bb680))
+
+### [0.2.8](https://github.com/public-reactions/acts_as_reactable/compare/v0.2.7...v0.2.8) (2022-04-18)
+
+
+### Bug Fixes
+
+* remove needless validators ([2b6aef3](https://github.com/public-reactions/acts_as_reactable/commit/2b6aef3379da7d3aa9a969440720b04d005a78af))
+* **spec:** test spec for #destroy_reaction_from ([ef79759](https://github.com/public-reactions/acts_as_reactable/commit/ef79759ce20109299e8bffa78ad4b7f0784510e0))
+
 ### [0.2.7](https://github.com/public-reactions/acts_as_reactable/compare/v0.2.6...v0.2.7) (2022-04-14)
 
 

data/README.md

@@ -3,6 +3,7 @@
 ![build](https://github.com/public-reactions/acts_as_reactable/actions/workflows/main.yml/badge.svg)
 [![codecov](https://codecov.io/gh/public-reactions/acts_as_reactable/branch/main/graph/badge.svg?token=OVDCJIQAFN)](https://codecov.io/gh/public-reactions/acts_as_reactable)
 [![Gem Version](https://badge.fury.io/rb/acts_as_reactable.svg)](https://badge.fury.io/rb/acts_as_reactable)
+[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?logo=conventionalcommits&logoColor=white)](https://conventionalcommits.org)
 
 ## Installation
 
@@ -14,25 +15,83 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
     $ gem install acts_as_reactable
 
-## Usage
+## Preparations
 
 ### 1. create the Reaction model
 
+```ruby
+# rails g migration create_reactions
+
+# with default id type
+create_table :reactions do |t|
+  t.references :reactable, polymorphic: true, null: false
+  t.references :reactor, polymorphic: true, null: false
+  t.string :emoji, null: false, index: true
+  t.timestamps
+
+  t.index [:reactable_type, :reactable_id, :reactor_type, :reactor_id, :emoji], unique: true, name: 'index_reactions_on_reactable_and_reactor_and_emoji'
+end
+
+# with uuid id
+create_table :reactions, id: :uuid do |t|
+  t.references :reactable, polymorphic: true, type: :uuid, null: false
+  t.references :reactor, polymorphic: true, type: :uuid, null: false
+  ...
+end
+```
+
 ### 2. annotate reactable and reactor models
 
-### 3. creating/updating reactions
+```ruby
+# reactable
+class Post < ApplicationRecord
+  acts_as_reactable
+end
+
+# reactor
+class User < ApplicationRecord
+  acts_as_reactor
+end
+```
+
+## Usage
+
+### adding/updating reactions
+
+```ruby
+post.add_reactions(user, "😀")
+post.add_reactions(user, ["😞", "🙃"])
+```
+
+### removing reactions
+
+```ruby
+post.remove_reactions(user, "😀")
+post.remove_reactions(user, ["😞", "🙃"])
+```
+
+### private opinion on reactable from reactor
+
+```ruby
+reactions = ActsAsReactable::Reaction.where(reactable: post, reactor: user)
+```
+
+### group, count and sort to get a summary of public opinion
 
-### 4. deleting reactions
+```ruby
+ActsAsReactable::Reaction.where(reactable: reactor).group(:emoji).order('count_id DESC').count(:id)
 
-### 5. aggregate/summary of reactions
+# { "😀": 10, "😢": 5, "😣": 1 }
+```
 
 ## FAQ
 
-### Why saving the emoji character instead of "smily_face"
+### Why saving "😂" instead of "face_with_tears_of_joy"
 
-- Technically, there's no concrete name/key/id for emoji (and modifiers like skin tone). The [CLDR short names](https://unicode.org/emoji/format.html#col-name) "vary by language" and "may change".
-- It's easier to store since any modern database supports 
-- It's easier to validate with libs/regex (e.g. [unicode-emoji](https://github.com/janlelis/unicode-emoji))
+- Technically, there's no concrete name/key/id for emoji (and modifiers like skin tone). The [CLDR short names](https://unicode.org/emoji/format.html#col-name) "vary by language" and "may change", besides, are those names case sensitive? Should we use `-`, `_` or ` ` as divider? How to append tone variant? There are several error prone decisions to make.
+- It's easier to store since all modern database supports encodings (e.g. UTF-8) for unicode characters.
+- It's easy to validate with libs/regex (e.g. [unicode-emoji](https://github.com/janlelis/unicode-emoji)).
+- It takes less size on disk to store (and presumably less time to index/sort/match) one unicode character 😂 (4 bytes) than `face with tears of joy` (22 bytes). [This is a great article to explain how utf-8 works](https://sethmlarson.dev/blog/utf-8)
 
 ## Development
 
@@ -42,7 +101,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/acts_as_reactable. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/acts_as_reactable/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/public-reactions/acts_as_reactable. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/acts_as_reactable/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
 

data/lib/acts_as_reactable/reactable.rb

@@ -25,12 +25,47 @@ module ActsAsReactable
             return destroy_reaction_from(reactor)
           end
 
-          reaction = reactions.find_or_initialize_by(reactor: reactor)
-          reaction.emoji = emoji
-          reaction.save
-
+          reaction = reactions.where({reactor: reactor, emoji: emoji}).first_or_create
           reaction
         end
+
+        define_method :add_reactions do |reactor, emoji_or_list = nil|
+          return unless emoji_or_list
+
+          emojis = if emoji_or_list.is_a?(Array)
+            emoji_or_list
+          else
+            [emoji_or_list]
+          end
+
+          # TODO performance
+          # optimize by using a single query
+          emojis
+            .compact
+            .uniq
+            .each do |emoji|
+              reaction = reactions.find_or_create_by(reactor: reactor, emoji: emoji)
+              reaction.save unless reaction.persisted?
+            end
+
+          self
+        end
+
+        define_method :remove_reactions do |reactor, emoji_or_list = nil|
+          return unless emoji_or_list
+
+          emojis = if emoji_or_list.is_a?(Array)
+            emoji_or_list
+          else
+            [emoji_or_list]
+          end
+
+          reactions
+            .where(reactor: reactor, emoji: emojis.compact.uniq)
+            .destroy_all
+
+          self
+        end
       end
     end
   end

data/lib/acts_as_reactable/reaction.rb

@@ -5,8 +5,6 @@ module ActsAsReactable
     belongs_to :reactable, polymorphic: true
     belongs_to :reactor, polymorphic: true
 
-    validates_presence_of :reactable_id
-    validates_presence_of :reactor_id
     validates_format_of :emoji, with: Unicode::Emoji::REGEX
   end
 end

data/lib/acts_as_reactable/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActsAsReactable
-  VERSION = "0.2.7"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_reactable
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.4.0
 platform: ruby
 authors:
 - contact@public-reactions.com
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-04-14 00:00:00.000000000 Z
+date: 2022-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord