acts_as_reactable 0.2.7 → 0.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8bfe9ba5656866d662b502fc6c04288c05e8b2ecde0a48a4812f5dc5c12607da
-  data.tar.gz: 1f16f5de5bb6fd29c7e9f2afee9b22d8d692d88d8a3103e208e4764124a30118
+  metadata.gz: cc0d2ddf2e316f3491c4fbf11f4bdc6d02186135f1377cfcb13e0f704ebbcd26
+  data.tar.gz: f251f43db52dc488e4c0ed8270e8b16c5c32e2f613633bf625e67cb2f76945c3
 SHA512:
-  metadata.gz: 372e7d0ab30345f4b5870338d4c7b8006041d50b84e25c93d853b0dd8ed961724fac9fb2b7005dbc2b0ad3de7c80469812bc16e14ac3520fdb3e4933bf14be58
-  data.tar.gz: 168c5407c7934db6b4ddd4a3b3d86684af2362e1a6818e90bcdbdfcac84aa68c6163d212e3c43fb84b99597fbb3579541f4956b191a6f39010cb5f623cab234a
+  metadata.gz: 4589911e039c80372bdc9ea82fc4be81a2505814781aa2a7da7030579d0a573463b91e70c996ea509bd53e183a60bf2c085088a67a7d738177e2c8a96ee58a9d
+  data.tar.gz: 8c7a482a922045884b89ff174d3f7012486cb815f86638dfed001270565f7edd1496dbd3cec7e9f79c5ded88b50fbc1e31155df5a0fa69ce7716f47b303d6183

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## [Unreleased]
 
+### [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
 
@@ -18,21 +19,79 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 ### 1. create the Reaction model
 
+```ruby
+# with default bigint id
+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
+end
+
+# with uuid id
+create_table :reactions do |t|
+  t.references :reactable, polymorphic: true, type: :uuid, null: false
+  t.references :reactor, polymorphic: true, type: :uuid, null: false
+
+  t.string :emoji, null: false, index: true
+
+  t.timestamps
+end
+```
+
 ### 2. annotate reactable and reactor models
 
+```ruby
+# reactable
+class Post < ApplicationRecord
+  acts_as_reactable
+end
+
+# reactor
+class User < ApplicationRecord
+  acts_as_reactor
+end
+```
+
 ### 3. creating/updating reactions
 
+```ruby
+reaction = post.update_reaction_from(user, "😀")
+```
+
 ### 4. deleting reactions
 
-### 5. aggregate/summary of reactions
+```ruby
+post.destroy_reaction_from(user) # returns value like #destroy in ActiveRecord
+
+# #update_reaction_from with a nil reaction also delete the reaction
+post.update_reaction_from(user)
+```
+
+### 5. private opinion from one reactor
+
+```ruby
+reaction = ActsAsReactable::Reaction.find_by(reactable: self, reactor: user)&.emoji
+```
+
+### 6. group, count and sort to get a summary of public opinion
+
+```ruby
+ActsAsReactable::Reaction.where(reactable: reactor).group(:emoji).order('count_id DESC').count(:id)
+
+# { "😀": 10, "😢": 5, "😣": 1 }
+```
 
 ## FAQ
 
 ### Why saving the emoji character instead of "smily_face"
 
-- 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
 

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.2.8"
 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.2.8
 platform: ruby
 authors:
 - contact@public-reactions.com
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-04-14 00:00:00.000000000 Z
+date: 2022-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord