Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/public-reactions/acts_as_reactable
emoji reactions in rails
https://github.com/public-reactions/acts_as_reactable
activerecord emoji rails reactions
Last synced: 12 days ago
JSON representation
emoji reactions in rails
- Host: GitHub
- URL: https://github.com/public-reactions/acts_as_reactable
- Owner: public-reactions
- License: mit
- Created: 2022-04-09T06:22:11.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-11-27T14:35:52.000Z (12 months ago)
- Last Synced: 2024-10-18T18:58:25.588Z (27 days ago)
- Topics: activerecord, emoji, rails, reactions
- Language: Ruby
- Homepage:
- Size: 94.7 KB
- Stars: 5
- Watchers: 1
- Forks: 3
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# ActsAsReactable
[](https://codecov.io/gh/public-reactions/acts_as_reactable)
[](https://badge.fury.io/rb/acts_as_reactable)
[](https://conventionalcommits.org)
## Installation
Install the gem and add to the application's Gemfile by executing:
$ bundle add acts_as_reactable
If bundler is not being used to manage dependencies, install the gem by executing:
$ gem install acts_as_reactable
## 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
```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
```ruby
ActsAsReactable::Reaction.where(reactable: reactor).group(:emoji).order('count_id DESC').count(:id)
# { "😀": 10, "😢": 5, "😣": 1 }
```
## FAQ
### 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", 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
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
### Commit & Release
We use [release-please](https://github.com/googleapis/release-please) and the [action](https://github.com/google-github-actions/release-please-action).
In order for the flow to work, commits need to follow the [convention](https://www.conventionalcommits.org/).
Typical workflow:
- commit (following the convention) and push to `main`
- release-please creates PR for release new version
- merge the PR
- automatically publish new release to rubygems by github action
## Contributing
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
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## Code of Conduct
Everyone interacting in the ActsAsReactable project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/acts_as_reactable/blob/main/CODE_OF_CONDUCT.md).