transilator 0.1.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e0f009b5dd9214e74a92e739c42ad3f32c35c3fd
+  data.tar.gz: 46227bcf9dcfeefd70f755311ea61d9e3af95e95
+SHA512:
+  metadata.gz: 792b88055096cb842a2bdffba5ec0932e2e4280c791ca1375589a08450c3746d2e6414ce8b8aa7ebc5c6ce055caae6c3d9eafa4b9cd1d0c82acacfd2b51dc069
+  data.tar.gz: 64b1226aa3d7a46af12d0f22525e0e18d61e51c7d787f66258db212ea91c32398dc87ec41261a78d837f7dc2c318d6bf1303edddd4e8148dce60120c6f708e6b

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in transilator.gemspec
+gemspec

data/README.md

@@ -0,0 +1,139 @@
+# Transilator
+
+[![Build Status](https://travis-ci.org/hendricius/transilator.svg?branch=master)](https://travis-ci.org/hendricius/transilator)
+
+Transilator makes storing translations for database records painless.
+
+Instead of storing translations in different database tables, translations for your attributes are stored in a JSON/JSONB or Hstore column directly in your table. Internally everything is stored as a hash with keys being locales and values the translations. Based on the locale whenever calling the attribute the translated value is retrieved internally.
+
+Everything has been developed with performance in mind, especially when dealing with millions of records.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'transilator'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install transilator
+
+## Usage
+
+This is a walkthrough with all steps you need to get you up and running.
+
+You may need to create migration for your model as usual. Assuming you have no
+table yet, create the table:
+
+```ruby
+  create_table :posts do |t|
+    t.hstore :title  # note for this to work you need to enable the hstore extension in your database.
+    t.jsonb :summary # this is the suggested way.
+    t.timestamps
+  end
+```
+
+Then adjust your model and integrate transilator:
+
+```ruby
+class Post < ActiveRecord::Base
+  transilator :title, :summary
+end
+```
+
+Thats it!
+
+Now you are able to translate values for the attributes :title and :description per locale:
+
+```ruby
+I18n.locale = :en
+post.title = 'Eel is a typical food in Hamburg'
+I18n.locale = :de
+post.title = 'Aal ist typisch für Hamburg'
+
+I18n.locale = :en
+post.title #=> Eel is a typical food in Hamburg
+I18n.locale = :de
+post.title #=> Aal ist typisch für Hamburg
+```
+
+If this is not enough, and sometimes you want to access one of the attributes directly you can also do:
+
+
+```ruby
+post.title_en = 'I have no idea what I am doing'
+post.title_en #=> I have no idea what I am doing
+```
+
+
+You may use initialization if needed:
+
+    Post.new(title: {en: 'The German', de: 'Serr German'})
+
+## Performance ##
+
+When developing I tested against against [bithavoc/multilang-hstore](https://github.com/bithavoc/multilang-hstore) as this has been my choice for years.
+
+**1,000,000 translation read operations**
+
+transilator:
+```
+  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**
+
+transilator:
+```
+  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**
+
+transilator:
+
+```
+  6.980000   0.020000   7.000000 (  7.000557)
+```
+
+multilang-hstore:
+
+```
+  7.620000   0.040000   7.660000 (  7.669240)
+```
+
+## Bugs and Feedback
+
+Use [http://github.com/hendricius/transilator/issues](http://github.com/hendricius/transilator/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/transilator
+
+## License(MIT)
+
+* Copyright (c) 2017 Hendrik Kleinwaechter and contributors

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "transilator"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/circle.yml

@@ -0,0 +1,15 @@
+machine:
+  ruby:
+    version: 2.4.1
+
+test:
+  override:
+    - bundle exec rake test
+
+database:
+  override:
+    - echo "Skipping database install..."
+
+dependencies:
+  override:
+    - gem install bundler && (bundle check --path=/home/ubuntu/.bundle || bundle install --path=/home/ubuntu/.bundle --jobs=2 --retry=5)

data/lib/transilator.rb

@@ -0,0 +1,5 @@
+require "transilator/version"
+require "transilator/active_record_extensions"
+
+module Transilator
+end

data/lib/transilator/active_record_extensions.rb

@@ -0,0 +1,69 @@
+module Transilator
+  module ActiveRecordExtensions
+
+    module ClassMethods
+
+      def transilator(*args)
+
+
+        args.each do |attribute|
+
+          # read the attribute from the hstore attribute and return it.
+          #
+          # returns the attribute or an empty string if the attribute is nil
+          define_method attribute do
+            (self[attribute] || {})[I18n.locale.to_s] || ""
+          end
+
+          # set the attribute on the model on the hstore hash
+          #
+          # returns the new value
+          define_method "#{attribute}=" do |value|
+            if value.is_a?(Hash)
+              write_attribute attribute, value
+            elsif self[attribute].present?
+              write_attribute attribute, self[attribute].merge({I18n.locale => value })
+              value
+            else
+              write_attribute attribute, {I18n.locale => value }
+              value
+            end
+          end
+
+          # returns the raw hstore directly
+          define_method "#{attribute}_before_type_cast" do
+            self[attribute] || {}
+          end
+
+          module_eval do
+            serialize "#{attribute}", ActiveRecord::Coders::Hstore
+          end if defined?(ActiveRecord::Coders::Hstore)
+
+
+          # for each locale add a getter and setter method in the type of
+          # title_de or title_en
+          I18n.available_locales.map(&:to_s).each do |locale|
+
+            define_method "#{attribute}_#{locale}" do
+              (self[attribute] || {})[locale] || ""
+            end
+
+            define_method "#{attribute}_#{locale}=" do |value|
+              if self[attribute].present?
+                write_attribute attribute, self[attribute].merge({locale => value })
+              else
+                write_attribute attribute, {locale => value }
+              end
+            end
+
+          end
+        end
+      end
+
+
+    end
+
+  end
+end
+
+ActiveRecord::Base.extend Transilator::ActiveRecordExtensions::ClassMethods

data/lib/transilator/version.rb

@@ -0,0 +1,3 @@
+module Transilator
+  VERSION = "0.1.5"
+end

data/transilator.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'transilator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "transilator"
+  spec.version       = Transilator::VERSION
+  spec.authors       = ['Hendrik Kleinwaechter']
+  spec.email         = ['hendrik.kleinwaechter@gmail.com']
+
+  spec.summary       = %q{Fast and efficient model translations in the database for PostgreSQL hstore and JSON}
+  spec.description   = %q{Fast and efficient model translations in the databse for PostgreSQL hstore and JSON.}
+  spec.homepage      = "https://github.com/hendricius/transilator"
+  spec.licenses      = ['MIT']
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'bundler', "~> 1.10"
+  spec.add_development_dependency 'rake', "~> 10.0"
+  spec.add_development_dependency 'minitest', "~> 5.0"
+  spec.add_development_dependency 'pry', "~> 0.1"
+
+  spec.add_dependency 'activerecord', '~> 5.0'
+  spec.add_dependency 'pg', '~> 0.19'
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: transilator
+version: !ruby/object:Gem::Version
+  version: 0.1.5
+platform: ruby
+authors:
+- Hendrik Kleinwaechter
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-01-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+description: Fast and efficient model translations in the databse for PostgreSQL hstore
+  and JSON.
+email:
+- hendrik.kleinwaechter@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- circle.yml
+- lib/transilator.rb
+- lib/transilator/active_record_extensions.rb
+- lib/transilator/version.rb
+- transilator.gemspec
+homepage: https://github.com/hendricius/transilator
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Fast and efficient model translations in the database for PostgreSQL hstore
+  and JSON
+test_files: []