acts_as_reactable 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f98c270221c9290d14ccbf602d3c23d613081c140adb9d295868681cf87c8de
-  data.tar.gz: 51248db8027acf4a10dd8971365ba1eb8be09f7006a94b0d55148bd5f31c468e
+  metadata.gz: ef084116ccbe7e59160dfda29dd6fd2679a2f1d425c689b4ac4fbb764e309ff4
+  data.tar.gz: 4612e402698fee627577269f661ba646c33c5624d92a8a228c4d9c1f453b7483
 SHA512:
-  metadata.gz: 5d9f2925ed9204542f32b6e87548f78972106b4c2b7c9f31bdc1de44e156cda1cf85a1f162c12f3a5b9629190c2deae2d2a5851f80b2c5531377ba77b8b1ecdb
-  data.tar.gz: 1fbdecece42f4122db297712d6de6a0801bd8afade10b957f13047cc5d12af02a3c8d57dc2099d4e1b176f5ea1b1c3cd277806f3234f30bba2917822ad916fea
+  metadata.gz: e85624536581e31d3844f2b4ebc3a6d30443a998924bf3abf6999035e4f7cc1439de643e066ba161c34beb7e8c2bb62d156542a7f84686cfad1e54c906b57ba2
+  data.tar.gz: a1c03a4130d202328df9d83132c917dff7a467d71b07822efd4f62b88f690932b546b86022b5d6c433e0ee8bce3d48e3d30d036a8501498f57b375e6688a5a44

data/CHANGELOG.md

@@ -1,5 +1,38 @@
 ## [Unreleased]
 
+## [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)
+
+
+### Bug Fixes
+
+* reset version to 0.2.0 ([fcb818a](https://github.com/public-reactions/acts_as_reactable/commit/fcb818a535e2435f03c9bd9894e5f6016e5b9899))
+
+## [0.2.0](https://github.com/public-reactions/acts_as_reactable/compare/v0.1.0...v0.2.0) (2022-04-14)
+
+
+### ⚠ BREAKING CHANGES
+
+* #upgrade_reaction_from now returns the created reaction
+
+### Features
+
+* #upgrade_reaction_from now returns the created reaction ([31bacd8](https://github.com/public-reactions/acts_as_reactable/commit/31bacd8598bc250e3bc9b2c5352d155058091f42))
+
 ## [0.1.0] - 2022-04-06
 
 - Initial release

data/README.md

@@ -2,9 +2,8 @@
 
 ![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)
-
-TODO: Add badge for gem
-TODO: Add badge for coverage
+[![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
 
@@ -20,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"
+### 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
 
@@ -44,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,9 +25,8 @@ 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
       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.1.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_reactable
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
-- admin@public-reactions.com
-autorequire:
+- contact@public-reactions.com
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-04-09 00:00:00.000000000 Z
+date: 2022-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -39,47 +39,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.1'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.11'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.11'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: standard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '1.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '1.10'
 - !ruby/object:Gem::Dependency
-  name: standard
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '3.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '3.11'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -152,21 +152,18 @@ dependencies:
         version: '0'
 description: Emoji reactions for rails
 email:
-- admin@public-reactions.com
+- contact@public-reactions.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".rspec"
-- ".standard.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
-- acts_as_reactable.gemspec
 - lib/acts_as_reactable.rb
 - lib/acts_as_reactable/reactable.rb
 - lib/acts_as_reactable/reaction.rb
@@ -180,7 +177,7 @@ metadata:
   homepage_uri: https://github.com/public-reactions/acts_as_reactable
   source_code_uri: https://github.com/public-reactions/acts_as_reactable
   changelog_uri: https://github.com/public-reactions/acts_as_reactable
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -196,7 +193,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.3.7
-signing_key:
+signing_key: 
 specification_version: 4
 summary: Emoji reactions for rails
 test_files: []

data/.standard.yml

@@ -1,3 +0,0 @@
-# For available configuration options, see:
-#   https://github.com/testdouble/standard
-ruby_version: 2.6

data/Gemfile.lock

@@ -1,151 +0,0 @@
-PATH
-  remote: .
-  specs:
-    acts_as_reactable (0.1.0)
-      activerecord (>= 6.0)
-      unicode-emoji (~> 3.1)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    actionpack (7.0.2.2)
-      actionview (= 7.0.2.2)
-      activesupport (= 7.0.2.2)
-      rack (~> 2.0, >= 2.2.0)
-      rack-test (>= 0.6.3)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actionview (7.0.2.2)
-      activesupport (= 7.0.2.2)
-      builder (~> 3.1)
-      erubi (~> 1.4)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activemodel (7.0.2.2)
-      activesupport (= 7.0.2.2)
-    activerecord (7.0.2.2)
-      activemodel (= 7.0.2.2)
-      activesupport (= 7.0.2.2)
-    activesupport (7.0.2.2)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 1.6, < 2)
-      minitest (>= 5.1)
-      tzinfo (~> 2.0)
-    ast (2.4.2)
-    builder (3.2.4)
-    concurrent-ruby (1.1.10)
-    crass (1.0.6)
-    diff-lcs (1.5.0)
-    docile (1.4.0)
-    erubi (1.10.0)
-    factory_bot (6.2.1)
-      activesupport (>= 5.0.0)
-    i18n (1.10.0)
-      concurrent-ruby (~> 1.0)
-    loofah (2.14.0)
-      crass (~> 1.0.2)
-      nokogiri (>= 1.5.9)
-    method_source (1.0.0)
-    minitest (5.15.0)
-    nokogiri (1.13.3-x86_64-darwin)
-      racc (~> 1.4)
-    nokogiri (1.13.3-x86_64-linux)
-      racc (~> 1.4)
-    parallel (1.22.1)
-    parser (3.1.1.0)
-      ast (~> 2.4.1)
-    racc (1.6.0)
-    rack (2.2.3)
-    rack-test (1.1.0)
-      rack (>= 1.0, < 3)
-    rails-dom-testing (2.0.3)
-      activesupport (>= 4.2.0)
-      nokogiri (>= 1.6)
-    rails-html-sanitizer (1.4.2)
-      loofah (~> 2.3)
-    railties (7.0.2.2)
-      actionpack (= 7.0.2.2)
-      activesupport (= 7.0.2.2)
-      method_source
-      rake (>= 12.2)
-      thor (~> 1.0)
-      zeitwerk (~> 2.5)
-    rainbow (3.1.1)
-    rake (13.0.6)
-    regexp_parser (2.2.1)
-    rexml (3.2.5)
-    rspec (3.11.0)
-      rspec-core (~> 3.11.0)
-      rspec-expectations (~> 3.11.0)
-      rspec-mocks (~> 3.11.0)
-    rspec-core (3.11.0)
-      rspec-support (~> 3.11.0)
-    rspec-expectations (3.11.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-mocks (3.11.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-rails (5.1.0)
-      actionpack (>= 5.2)
-      activesupport (>= 5.2)
-      railties (>= 5.2)
-      rspec-core (~> 3.10)
-      rspec-expectations (~> 3.10)
-      rspec-mocks (~> 3.10)
-      rspec-support (~> 3.10)
-    rspec-support (3.11.0)
-    rubocop (1.26.1)
-      parallel (~> 1.10)
-      parser (>= 3.1.0.0)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.16.0, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.16.0)
-      parser (>= 3.1.1.0)
-    rubocop-performance (1.13.3)
-      rubocop (>= 1.7.0, < 2.0)
-      rubocop-ast (>= 0.4.0)
-    ruby-progressbar (1.11.0)
-    simplecov (0.21.2)
-      docile (~> 1.1)
-      simplecov-html (~> 0.11)
-      simplecov_json_formatter (~> 0.1)
-    simplecov-cobertura (2.1.0)
-      rexml
-      simplecov (~> 0.19)
-    simplecov-html (0.12.3)
-    simplecov_json_formatter (0.1.4)
-    sqlite3 (1.4.2)
-    standard (1.9.1)
-      rubocop (= 1.26.1)
-      rubocop-performance (= 1.13.3)
-    thor (1.2.1)
-    tzinfo (2.0.4)
-      concurrent-ruby (~> 1.0)
-    unicode-display_width (2.1.0)
-    unicode-emoji (3.1.0)
-      unicode-version (~> 1.0)
-    unicode-version (1.2.0)
-    zeitwerk (2.5.4)
-
-PLATFORMS
-  x86_64-darwin-21
-  x86_64-linux
-
-DEPENDENCIES
-  acts_as_reactable!
-  factory_bot (~> 6.0)
-  rake (~> 13.0)
-  rspec (~> 3.11)
-  rspec-rails (~> 5.0)
-  simplecov
-  simplecov-cobertura
-  sqlite3
-  standard (~> 1.3)
-
-BUNDLED WITH
-   2.3.10

data/acts_as_reactable.gemspec

@@ -1,48 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "lib/acts_as_reactable/version"
-
-Gem::Specification.new do |spec|
-  spec.name = "acts_as_reactable"
-  spec.version = ActsAsReactable::VERSION
-  spec.authors = ["admin@public-reactions.com"]
-  spec.email = ["admin@public-reactions.com"]
-
-  spec.summary = "Emoji reactions for rails"
-  spec.description = "Emoji reactions for rails"
-  spec.homepage = "https://github.com/public-reactions/acts_as_reactable"
-  spec.license = "MIT"
-  spec.required_ruby_version = ">= 2.6.0"
-
-  # spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
-
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/public-reactions/acts_as_reactable"
-  spec.metadata["changelog_uri"] = "https://github.com/public-reactions/acts_as_reactable"
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
-    end
-  end
-  spec.bindir = "exe"
-  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_runtime_dependency "activerecord", [">= 6.0"]
-  spec.add_runtime_dependency "unicode-emoji", "~> 3.1"
-
-  spec.add_development_dependency "rspec", "~> 3.11"
-  spec.add_development_dependency "rake", "~> 13.0"
-  spec.add_development_dependency "standard", "~> 1.3"
-  spec.add_development_dependency "rspec-rails", "~> 5.0"
-  spec.add_development_dependency "factory_bot", "~> 6.0"
-  spec.add_development_dependency "sqlite3"
-  spec.add_development_dependency "simplecov"
-  spec.add_development_dependency "simplecov-cobertura"
-
-  # For more information and examples about making a new gem, check out our
-  # guide at: https://bundler.io/guides/creating_gem.html
-end