tolken 0.1.0

data/.travis.yml

@@ -0,0 +1,19 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.0
+env:
+  global:
+    - CC_TEST_REPORTER_ID=38cf6fe42113efd6306798c2189499f6ff9da87a92dd548e8339a1bd98d2a7e6
+addons:
+  postgresql: "9.6"
+before_install: gem install bundler -v 1.16.1
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+  - psql -c 'create database travis_ci_test;' -U postgres
+script:
+  - bundle exec rspec
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in tolken.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,181 @@
+PATH
+  remote: .
+  specs:
+    tolken (0.1.0)
+      rails (= 5.2.0.rc2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (5.2.0.rc2)
+      actionpack (= 5.2.0.rc2)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailer (5.2.0.rc2)
+      actionpack (= 5.2.0.rc2)
+      actionview (= 5.2.0.rc2)
+      activejob (= 5.2.0.rc2)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.2.0.rc2)
+      actionview (= 5.2.0.rc2)
+      activesupport (= 5.2.0.rc2)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.2.0.rc2)
+      activesupport (= 5.2.0.rc2)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activejob (5.2.0.rc2)
+      activesupport (= 5.2.0.rc2)
+      globalid (>= 0.3.6)
+    activemodel (5.2.0.rc2)
+      activesupport (= 5.2.0.rc2)
+    activerecord (5.2.0.rc2)
+      activemodel (= 5.2.0.rc2)
+      activesupport (= 5.2.0.rc2)
+      arel (>= 9.0)
+    activestorage (5.2.0.rc2)
+      actionpack (= 5.2.0.rc2)
+      activerecord (= 5.2.0.rc2)
+      marcel (~> 0.3.1)
+    activesupport (5.2.0.rc2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (9.0.0)
+    ast (2.4.0)
+    builder (3.2.3)
+    coderay (1.1.2)
+    concurrent-ruby (1.0.5)
+    crass (1.0.4)
+    diff-lcs (1.3)
+    docile (1.3.1)
+    erubi (1.7.1)
+    globalid (0.4.1)
+      activesupport (>= 4.2.0)
+    i18n (1.1.0)
+      concurrent-ruby (~> 1.0)
+    json (2.1.0)
+    loofah (2.2.2)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.0)
+      mini_mime (>= 0.1.1)
+    marcel (0.3.2)
+      mimemagic (~> 0.3.2)
+    method_source (0.9.0)
+    mimemagic (0.3.2)
+    mini_mime (1.0.0)
+    mini_portile2 (2.3.0)
+    minitest (5.11.3)
+    nio4r (2.3.1)
+    nokogiri (1.8.4)
+      mini_portile2 (~> 2.3.0)
+    parallel (1.12.1)
+    parser (2.5.1.2)
+      ast (~> 2.4.0)
+    pg (1.0.0)
+    powerpack (0.1.2)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rack (2.0.5)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (5.2.0.rc2)
+      actioncable (= 5.2.0.rc2)
+      actionmailer (= 5.2.0.rc2)
+      actionpack (= 5.2.0.rc2)
+      actionview (= 5.2.0.rc2)
+      activejob (= 5.2.0.rc2)
+      activemodel (= 5.2.0.rc2)
+      activerecord (= 5.2.0.rc2)
+      activestorage (= 5.2.0.rc2)
+      activesupport (= 5.2.0.rc2)
+      bundler (>= 1.3.0)
+      railties (= 5.2.0.rc2)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.4)
+      loofah (~> 2.2, >= 2.2.2)
+    railties (5.2.0.rc2)
+      actionpack (= 5.2.0.rc2)
+      activesupport (= 5.2.0.rc2)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubocop (0.52.1)
+      parallel (~> 1.10)
+      parser (>= 2.4.0.2, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    rubocop-rspec (1.23.0)
+      rubocop (>= 0.52.1)
+    ruby-progressbar (1.10.0)
+    simple_form (1.4.1)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    sprockets (3.7.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    thor (0.20.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.4.0)
+    websocket-driver (0.7.0)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.3)
+    with_model (2.0.0)
+      activerecord (>= 4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  pg
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop (= 0.52.1)
+  rubocop-rspec
+  simple_form
+  simplecov
+  tolken!
+  with_model
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Nicklas Ramhöj
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,147 @@
+# 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.
+
+[![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)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/72c772179a8baa586f7f/test_coverage)](https://codeclimate.com/github/varvet/tolken/test_coverage)
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "tolken"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tolken
+
+## Usage
+Make sure you're running Postgres and that the column you want to translate is of the `jsonb` type:
+
+### Setup
+```rb
+class CreatePosts < ActiveRecord::Migration[5.2]
+  def change
+    create_table :posts do |t|
+      t.jsonb :title, :jsonb, null: false
+      t.timestamps
+    end
+
+    execute "CREATE INDEX posts_title_index ON posts USING gin (title)"
+  end
+end
+```
+
+Next you need to configure `I18n` if you haven't already (usually in *config/initializers/locale.rb*):
+
+```rb
+I18n.available_locales = %i[en sv de]
+```
+
+Tolken expects you to only use translations for the locales in `I18n.available_locales`.
+
+### Persistence
+Extend your model with `Tolken` and tell it what column(s) you want to translate:
+
+```rb
+class Post < ApplicationRecord
+  extend Tolken
+  translates :title
+end
+```
+
+You can now work with `title` as follows:
+
+```rb
+post = Post.create(title: { en: "News", sv: "Nyheter" })
+
+post.title # => { en: "News", sv: "Nyheter" }
+post.title(:en) # => "News"
+post.title(:sv) # => "Nyheter"
+post.title(:dk) # ArgumentError, "Invalid locale dk"
+post.title(:de) # => nil
+
+post.title = { en: "News", sv: "Nyheter" }
+post.title[:en] = "News"
+```
+
+### Validation
+Tolken comes with support for the *presence* validator:
+
+```rb
+class Post < ApplicationRecord
+  extend Tolken
+  translates :title, presence: true
+end
+
+post = Post.create(title: { en: "News", sv: "" })
+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:
+
+```ruby
+gem "tolken", require: "tolken/simle_form"
+```
+
+Now if you add a simple_form field for a translatable field SimpleForm will generate an input per language version:
+
+```erb
+<%= simple_form_for(@post) do |form| %>
+  <%= form.input :title %>
+  <%= form.submit %>
+<% end %>
+```
+
+By default a text input field is generated. If you want another type you can override with:
+
+```erb
+<%= form.input :title, type: :text %>
+```
+
+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.
+
+## Development
+
+### Native dependencies
+You need to have Postgres installed on your system. This can be done on Mac OS with `brew install postgres`.
+
+### Ruby setup
+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/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:
+
+    $ git clone git@github.com:varvet/tolken.git
+    $ cd tolken
+    $ git checkout my-feature-branch
+    Make changes and commits, consider squashing commits that doesn't add anything by themselves
+    $ rubocop
+    $ rspec
+    $ open coverage/index.html
+    If test coverage is missing address it or add a description to your PR why it is lacking.
+    Commit, if possible squash in original locations, changes required by rubocop and or failing tests.
+    $ git checkout master
+    $ git pull --rebase
+    $ git checkout my-feature-branch
+    $ git rebase master
+    $ git push
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "tolken"
+
+# 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(__FILE__)

data/bin/setup

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

data/lib/tolken.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "i18n"
+
+require "tolken/version"
+require "tolken/hash_serializer"
+require "tolken/translates"
+
+module Tolken
+  include Tolken::Translates
+end

data/lib/tolken/hash_serializer.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Tolken
+  class HashSerializer
+    class << self
+      def dump(hash)
+        hash # ActiveRecord handles formatting this from a Ruby hash to psql jsonb
+      end
+
+      def load(hash)
+        hash = JSON.parse(hash) if hash.is_a?(String)
+        (hash || {}).with_indifferent_access
+      end
+    end
+  end
+end

data/lib/tolken/simle_form.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "rails"
+require "simple_form"
+require_relative "../tolken"
+
+module Tolken
+  module SimpleForm
+    class JsonbInput < ::SimpleForm::Inputs::StringInput
+      include ActionView::Helpers::OutputSafetyHelper
+
+      def input(_wrapper_options = {})
+        safe_join(
+          I18n.available_locales.map do |locale|
+            options = {
+              input_html: {
+                name: "#{object.class.to_s.downcase}[#{attribute_name}][#{locale}]",
+                value: object.public_send(attribute_name)[locale]
+              },
+              as: input_options[:type].presence || :string
+            }
+
+            @builder.input(:"#{attribute_name}_#{locale}", options)
+          end
+        )
+      end
+
+      def label(_wrapper_options = {})
+        # label is rendered per translatable field
+      end
+    end
+  end
+end
+
+JsonbInput = Tolken::SimpleForm::JsonbInput