https://github.com/hendricius/hstorly
hstore translations in your Ruby on Rails models. Super fast and efficient. Uses the hstore datatype in the database.
https://github.com/hendricius/hstorly
Last synced: about 2 months ago
JSON representation
hstore translations in your Ruby on Rails models. Super fast and efficient. Uses the hstore datatype in the database.
- Host: GitHub
- URL: https://github.com/hendricius/hstorly
- Owner: hendricius
- Created: 2015-10-28T23:55:50.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2018-01-10T08:30:20.000Z (over 7 years ago)
- Last Synced: 2024-04-24T14:37:30.940Z (about 1 year ago)
- Language: Ruby
- Homepage: https://github.com/hendricius/hstorly
- Size: 22.5 KB
- Stars: 3
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Hstorly
DEPRECATED. Please use the [transilator library](https://github.com/hendricius/transilator) instead which also added JSON support.
[](https://circleci.com/gh/hendricius/hstorly)
Hstorly is a small translation library for translating database values for Active Support/Rails 4 using the Hstore datatype of your Postgres database.
This project is a fork of the amazing [bithavoc/multilang-hstore](https://github.com/bithavoc/multilang-hstore) with some remarkable differences.
* Focus on performance. Especially when dealing with millions of records,
every operation counts.
* Remove a lot of features, focus on the core features.
* Due to focus on core features, better thread safety.
## Performance ##
**1,000,000 translation read operations**
hstorly:
```
1.310000 0.020000 1.330000 ( 1.342136)
```
multilang-hstore:
```
3.350000 0.040000 3.390000 ( 3.383317)
```
**Setting a new translation entry, 100,000 times**
hstorly:
```
6.650000 0.030000 6.680000 ( 6.681483)
```
multilang-hstore:
```
6.860000 0.030000 6.890000 ( 6.892723)
```
**Setting a completely new object with translations 100,000 times**
hstorly:
```
6.980000 0.020000 7.000000 ( 7.000557)
```
multilang-hstore:
```
7.620000 0.040000 7.660000 ( 7.669240)
```
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'hstorly'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install hstorly
## Usage
This is a walkthrough with all steps you need to setup multilang translated attributes, including model and migration.
We're assuming here you want a Post model with some multilang attributes, as outlined below:
class Post < ActiveRecord::Base
hstore_translate :title
end
The multilang translations are stored in the same model attributes (eg. title):
You may need to create migration for Post as usual, but multilang attributes should be in hstore type:
create_table(:posts) do |t|
t.hstore :title
t.timestamps
end
Thats it!
Now you are able to translate values for the attributes :title and :description per locale:
I18n.locale = :en
post.title = 'Hstorly rocks!'
I18n.locale = :de
post.title = 'Hstorly pferdefleisch!'
I18n.locale = :en
post.title #=> Hstorly rocks!
I18n.locale = :de
post.title #=> Hstorly pferdefleisch!
If this is not enough, and sometimes you want to access one of the attributes directly you can also do:
post.title_en = 'Hulk > Time punch'
post.title_en #=> Hulk > Time punch
You may use initialization if needed:
Post.new(title: {en: 'Cows rock', de: 'Kühe rocken'})
## Bugs and Feedback
Use [http://github.com/hendricius/hstorly/issues](http://github.com/hendricius/hstorly/issues)
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/hendricius/hstorly.
## License(MIT)
* Copyright (c) 2015 Hendrik Kleinwaechter and Contributors