Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tanakaworld/rumojinize
🐶ActiveRecord plugin that makes you easily store emoji to DB.
https://github.com/tanakaworld/rumojinize
emoji gem mysql rails
Last synced: 8 days ago
JSON representation
🐶ActiveRecord plugin that makes you easily store emoji to DB.
- Host: GitHub
- URL: https://github.com/tanakaworld/rumojinize
- Owner: tanakaworld
- Created: 2018-06-09T16:15:05.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-03-24T15:39:39.000Z (over 5 years ago)
- Last Synced: 2024-04-26T11:20:13.011Z (6 months ago)
- Topics: emoji, gem, mysql, rails
- Language: Ruby
- Homepage: https://rubygems.org/gems/rumojinize
- Size: 48.8 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🐶Rumojinize
[](https://circleci.com/gh/tanakaworld/rumojinize/tree/master)
[](https://badge.fury.io/rb/rumojinize)
This is an ActiveRecord plugin make you easily store emoji to DB.
Supporting:
- Encode emoji to UTF8 text before save. `🐶`->`:dog:`
- Decode encoded emoji in the instance of model. `:dog:`->`🐶`
## Concept
In order to store the emoji to your Database, we need following steps.
- Change the charset from `utf8` to `utf8mb4`.
- Upgrade MySQL version greater than `5.5`.
But "Rumojinize" make it simple!!
## Usage
**Install gem:**
```
gem 'rumojinize'
```
```
bundle install
```
**Set up by `rumojinize`.**
```
class Article < ApplicationRecord
rumojinize :body
end
```
Also you can rumojinize multiple fields.
```
class Article < ApplicationRecord
rumojinize :body, :title
end
```
## Example
**For example, Rumojinize will encode `🐶` to `:dog:` before save to DB, and decode in the instance.**
## Dependencies
- [rumoji](https://github.com/mwunsch/rumoji)
## 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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/tanakaworld/rumojinize. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
## License
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
## Code of Conduct
Everyone interacting in the Rumojinize project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/tanakaworld/rumojinize/blob/master/CODE_OF_CONDUCT.md).