tolken 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b3982f597caf542d522bb931de37a824bfb4bfa7f07f79e018b49136e14dd8e3
-  data.tar.gz: 55ccc2f5ed3b4def93576e4433237ca3366d865d848b844ab4ce77bff4836b5a
+  metadata.gz: 9e3b810d92ead0e93a5131e336d22f2f66425549eb0df62a013b27506450d086
+  data.tar.gz: 8137c3c286daf8052cc07584d01ddffc3db1f5a2e1e2379f88bc2d73b032c081
 SHA512:
-  metadata.gz: 61ba31f2e6211d202b888924f7d193ca2ca1ccd5b8a6cca7f988484aea10b05f0764e6380dfc7884d95d8768901111778d38982b6256149d7fafb4c69ee0766a
-  data.tar.gz: 074a77eaaee80949ab13957dcd22aa19ee7a415bb5d124e01b878ad2100bb311f037552d805bad25c5952513d4396733f4f75c0b77523622cc42f1b5abf7d7e0
+  metadata.gz: 9578b5db99672f9c51af74dea5d88b8640c2420cd635a12dffcf95151af7d660be82ca7286119a1a50319029d51bdde0b8b63a71c1985bf4ea802b0736555413
+  data.tar.gz: c8d80d8c6a40691716920b95e5bd4dcb4f028edd9b9ddc76e9471df5a691be3a9dd3c061ff948673a424a61e054d584b9272de033d64badadaeb7e8b4053ef01

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    tolken (0.1.0)
+    tolken (0.3.0)
       rails (= 5.2.1)
 
 GEM

data/README.md

@@ -1,9 +1,7 @@
 # Tolken
 Tolken is a Ruby on Rails Gem that allows you to translate database fields using Postgres' jsob data type.
 
-Tolken's API is more verbose than most similar gems. The philosophy is that you should be aware of when you're dealing with translatable fields and what language you're interested in in any given moment. This comes from experience working with gems such as [Globalize](https://github.com/globalize/globalize), while it might fit some projects we've found that the magic that starts out as a convenience quickly becomes a liability.
-
-In Tolken a translatable field is just a Ruby hash which makes it easy to reason about. See *Usage* for details.
+Tolken's API is more verbose than most similar gems. The idea is that you should be aware of when you're dealing with translatable fields and what language you're interested in in any given moment.  In Tolken a translatable field is just a Ruby hash which makes it easy to reason about. See *Usage* for details.
 
 [![Build Status](https://travis-ci.org/varvet/tolken.svg?branch=master)](https://travis-ci.org/varvet/tolken)
 [![Maintainability](https://api.codeclimate.com/v1/badges/72c772179a8baa586f7f/maintainability)](https://codeclimate.com/github/varvet/tolken/maintainability)
@@ -68,7 +66,11 @@ post = Post.create(title: { en: "News", sv: "Nyheter" })
 post.title # => { en: "News", sv: "Nyheter" }
 post.title(:en) # => "News"
 post.title(:sv) # => "Nyheter"
+post.title("sv") # => "Nyheter"
+post.title[:en] # => "News"
+post.title["en"] # => "News"
 post.title(:dk) # ArgumentError, "Invalid locale dk"
+post.title[:dk] # => nil
 post.title(:de) # => nil
 
 post.title = { en: "News", sv: "Nyheter" }
@@ -91,10 +93,10 @@ post.errors.messages # => { name_sv: ["can't be blank"] }
 Tolken checks that all `I18n.available_locales` has present values.
 
 ### View Forms
-Tolken has opt-in support for integrating with [SimpleForm](https://github.com/plataformatec/simple_form). To opt-in update your Gemfile:
+While creating form inputs for your locale versions are as simple as adding `[<locale>]` to the html name attribute Tolken provides opt-in support for integrating with [SimpleForm](https://github.com/plataformatec/simple_form). To opt-in update your Gemfile:
 
 ```ruby
-gem "tolken", require: "tolken/simle_form"
+gem "tolken", require: "tolken/simple_form"
 ```
 
 Now if you add a simple_form field for a translatable field SimpleForm will generate an input per language version:
@@ -112,6 +114,19 @@ By default a text input field is generated. If you want another type you can ove
 <%= form.input :title, type: :text %>
 ```
 
+Without simple form your inputs might look something like:
+
+```html
+<input name="post[title][en]" id="post_title_en">
+<input name="post[title][sv]" id="post_title_sv">
+```
+
+Don't forget whitelist the nested locale params in your controller:
+
+```rb
+params.require(:post).permit(title: I18n.available_locales)
+```
+
 This will instead render one text area per language version.
 
 The specs for [translates](spec/tolken/translates_spec.rb) is a good resource of additional usage examples.
@@ -127,7 +142,11 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 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/varvet/tolken. 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. To create a pull request follow these steps:
+Bug reports and pull requests are welcome on GitHub at https://github.com/varvet/tolken. 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.
+
+If you use and like Tolken but find yourself adding features that you're missing in Tolken please consider submitting a pull request!
+
+To create a pull request follow these steps:
 
     $ git clone git@github.com:varvet/tolken.git
     $ cd tolken

data/lib/tolken/translates.rb

@@ -7,7 +7,10 @@ module Tolken
       serialize(field_name, HashSerializer)
 
       if options[:presence]
-        store_accessor(field_name, *I18n.available_locales.map { |locale| "#{field_name}_#{locale}" })
+        validation_names = I18n.available_locales.map { |locale| "#{field_name}_#{locale}" }
+        readers = store_accessor(field_name, *validation_names)
+        private(*(readers + readers.map { |name| "#{name}=" }))
+
         define_validator(field_name) if options[:presence]
       end
     end
@@ -16,10 +19,10 @@ module Tolken
 
     def define_getter(field_name)
       define_method(field_name) do |locale = nil|
-        return self[field_name.to_sym] unless locale
+        return self[field_name] unless locale
 
         begin
-          self[field_name.to_sym].fetch(locale.to_s)
+          self[field_name].fetch(locale.to_s)
         rescue IndexError
           raise ArgumentError, "Invalid locale #{locale}" unless I18n.available_locales.include?(locale.to_sym)
           nil

data/lib/tolken/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Tolken
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/tolken.gemspec

@@ -7,8 +7,8 @@ require "tolken/version"
 Gem::Specification.new do |spec|
   spec.name          = "tolken"
   spec.version       = Tolken::VERSION
-  spec.authors       = ["Nicklas Ramhöj, Julia Fridberg"]
-  spec.email         = ["nicklas.ramhoj@varvet.com, julia.fridberg@varvet.com"]
+  spec.authors       = ["Nicklas Ramhöj, Julia Friberg"]
+  spec.email         = ["nicklas.ramhoj@varvet.com, julia.friberg@varvet.com"]
 
   spec.summary       = "A down-to-earth database translation Gem for Rails using psql jsonb"
   spec.description   = """

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tolken
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
-- Nicklas Ramhöj, Julia Fridberg
+- Nicklas Ramhöj, Julia Friberg
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-09 00:00:00.000000000 Z
+date: 2018-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -173,7 +173,7 @@ description: "\n    A down-to-earth database translation Gem for Rails using psq
   a translatable field is just a Ruby hash which makes it easy to reason about.\n
   \ "
 email:
-- nicklas.ramhoj@varvet.com, julia.fridberg@varvet.com
+- nicklas.ramhoj@varvet.com, julia.friberg@varvet.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -191,7 +191,7 @@ files:
 - bin/setup
 - lib/tolken.rb
 - lib/tolken/hash_serializer.rb
-- lib/tolken/simle_form.rb
+- lib/tolken/simple_form.rb
 - lib/tolken/translates.rb
 - lib/tolken/version.rb
 - tolken.gemspec