pg_translatable 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 195ffcc2dac4d8869cebed29bf078e351251813a
-  data.tar.gz: 6b3445128fb029069c4aa3067e6249f87be7b4e2
+  metadata.gz: 317b37f935e62b8f70c47ec8f3af4f51ab446738
+  data.tar.gz: c311d1fd8384550f9be3d2eea0789416af0692ea
 SHA512:
-  metadata.gz: 20425efa82a9a5f0402db52a64e3bbfd7a9b62cf6255de8fd64ef99ddcd88ca1d6dd5e560cbc066a7fbe66183cc8a7d3760dbfbb381413cfc0c0867a7481716e
-  data.tar.gz: 19c3363943b76ede4cd2933b7b5fb3016fa0a9dd8f2b56919372f8f76222b39918d5d508408dbbf2049e3988d3f2d30bbcd50f239fd209a78a660c85f43266c9
+  metadata.gz: a6b0f1475a56e965d101c77fb7880ef4bb8083f5ca96e556714d75224d029436b20841de4b3d1396154f69700334ab5752cb821e23b68fbf87a51643c22042ea
+  data.tar.gz: 6a7d99f280a8c0b3a0993065aa8ebb44000f1a2b56a9f9ada82000b807e7af24e1a87b5e1c1f531632a09d2fb18019a28fb838b7c7075b0982a9ef5635ffbf9f

data/.gitignore

@@ -8,3 +8,4 @@
 /spec/reports/
 /tmp/
 /spec/test_app/log
+*.gem

data/README.md

@@ -1,3 +1,4 @@
+[![Gem Version](https://badge.fury.io/rb/pg_translatable.svg)](http://badge.fury.io/rb/pg_translatable)
 [![Build Status](https://travis-ci.org/Stankec/pg_translatable.svg?branch=master)](https://travis-ci.org/Stankec/pg_translatable)
 [![Code Climate](https://codeclimate.com/github/Stankec/pg_translatable/badges/gpa.svg)](https://codeclimate.com/github/Stankec/pg_translatable)
 [![Test Coverage](https://codeclimate.com/github/Stankec/pg_translatable/badges/coverage.svg)](https://codeclimate.com/github/Stankec/pg_translatable/coverage)
@@ -14,6 +15,118 @@ To use this gem in your rails app simply add the following to your `Gemfile`:
 gem 'pg_translatable'
 ```
 
+# Usage
+
+To translate your model's fields you must call the `translate` method:
+
+```Ruby
+# app/models/post.rb
+
+class Post < ActiveRecord::Base
+  translate :title, :content
+
+  ...
+
+end
+```
+
+These fields will be translated to all locales that you have defined in
+`config.i18n.available_locales`.
+
+E.g. the following configuration would store translations for english, german,
+french and spanish:
+
+```Ruby
+# config/application.rb
+
+module TestApp
+  class Application < Rails::Application
+    config.i18n.default_locale = :en
+    config.i18n.available_locales = [:en, :de, :fr, :es]
+  end
+end
+```
+
+## Getters and setters
+
+When you call the field's name in singular it will return the value for the
+current locale, that is the locale defined in `I18n.locale`. So for the above
+example, if my current locale was set to `:fr` calling `title` would return the
+title in french.
+
+When you call the field's name in plural it will return a hash containing all
+translations. For the above example, calling `titles` would return a hash
+containing all translations.
+
+Additionally a per locale getter and setter will be defined for each field.
+For the above example the following getters and setters would be generated:
+`title_en`, `title_de`, `title_fr`, `title_es`,
+`content_en`, `content_de`, `content_fr`, `content_es`
+
+__NOTE:__ If it happens that the singular and plural of a given field are the
+same then the plural will get suffixed with `_translations`.
+
+E.g. If there was a field called `news` it's getters and setters would be
+`news` for the current translation and `news_translations` for the
+translations hash.
+
+## Formatters
+
+If you want to format the output of a getter method then you can just redefine
+the formatter method for any field.
+
+E.g. if you wanted your content's translations to be returned in reverse:
+
+```Ruby
+# app/models/post.rb
+
+class Post < ActiveRecord::Base
+  translate :title, :content, :price
+
+  private
+
+  def content_formatter(value)
+    value.to_s.reverse
+  end
+end
+```
+
+__NOTE:__ Only getters pass data through formatters, setters save data given to
+them as is.
+
+## Strong params
+
+To better integrate translations with strong parameters a convenience method
+will be defined for each field, it will just be suffixed with `_fields`.
+
+For the above example you could do the following:
+
+```Ruby
+# app/controllers/posts_controller.rb
+
+class PostsController < ApplicationController
+
+  ...
+
+  private
+
+  def post_params
+    params.require(:post).permit(
+      *Post.title_fields,
+      *Post.content_fields
+    )
+  end
+
+  ...
+
+end
+```
+
+## Validation
+
+There is no practical solution for validating this kind of data.
+My suggestion is to write custom validator classes.
+
 # Development
 
 After checking out the repo, make sure you have a Postgres database server
@@ -27,6 +140,9 @@ rake db:migrate
 
 # Contributing
 
+Open an issue [here](https://github.com/Stankec/pg_translatable/issues) or do
+the following:
+
 1. [Fork it]( https://github.com/Stankec/pg_translatable/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)

data/lib/pg_translatable/translatable/methods/class_methods.rb

@@ -11,7 +11,7 @@ module PgTranslatable
         def define_strong_params_fields
           languages_list = @languages.map { |locale| ":#{@column}_#{locale}" }
           @object.class_eval <<-RUBY
-            define_singleton_method("#{@column}_fields") do
+            define_singleton_method("#{@column_name}_fields") do
               [#{languages_list.join(', ')}]
             end
           RUBY

data/lib/pg_translatable/translatable/methods/instance_methods.rb

@@ -22,7 +22,7 @@ module PgTranslatable
         def define_getter
           @object.class_eval <<-RUBY
             define_method("#{@column_name}") do
-              send("#{@column_name}_#{I18n.locale}")
+              send("#{@column_name}_\#{I18n.locale}")
             end
           RUBY
         end

data/lib/pg_translatable/version.rb

@@ -2,7 +2,7 @@ module PgTranslatable
   module Version
     MAJOR = 0
     MINOR = 0
-    TINY  = 1
+    TINY  = 2
     PRE   = nil
 
     STRING = [MAJOR, MINOR, TINY, PRE].compact.join('.')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pg_translatable
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Stanko Krtalić Rusendić
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-08-30 00:00:00.000000000 Z
+date: 2015-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails