i18n-postgres_json 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e059f727a22aee6aa72273561be945a2a1994b9b4026e16bf45112ce53c7def4
+  data.tar.gz: 6e605e2377bb4807f1636c64498f3af6895aa59142ad4b0abfa88874f1f84675
+SHA512:
+  metadata.gz: b352b46ba2e40b2521ea58f8fe291b239d5b08a81b02192285311e5914a9c05497761503ec90484c495837bc465c28d81164a07caecf5b57a5c01e4dc159e9bc
+  data.tar.gz: 3d1f476c82482a1566fa858e6e58171c994d5e3960371e1c5ba35c2c0669120657677fdecfec8dea133abcbca8db2d44d2dac2b9e1d3f947305e97b1a95628e5

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2020 Sean Doyle
+
+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,237 @@
+# I18n::PostgresJson
+
+Internationalization backed by Postgres JSON columns
+
+## Usage
+
+[PostgreSQL's][pg] support for storing objects as [JSON and JSONB
+columns][pg-json], integrated with [`ActiveRecord` column-aware
+models][activerecord-pg-json] makes it an ideal candidate to store dynamic,
+editable application translation text.
+
+This gem's inspiration comes from the [Rails Internationalization (<abbr
+title="Internationalization">i18n</abbr>) Guides][i18n-guides] mention of
+[`i18n-active_record`][i18n-ar].
+
+[Cascading translations][i18n-chain] by combining a dynamic, database driven
+translation source ahead of the default `I18n::Backend::Simple` enable dynamic
+copy editing, with an in-code foundational source.
+
+[pg]: https://www.postgresql.org/about/
+[pg-json]: https://www.postgresql.org/docs/9.4/datatype-json.html#DATATYPE-JSON
+[activerecord-pg-json]: https://guides.rubyonrails.org/active_record_postgresql.html#json-and-json
+[i18n-ar]: https://github.com/svenfuchs/i18n-active_record
+[i18n-guides]: https://guides.rubyonrails.org/i18n.html#using-different-backends
+[i18n-chain]: https://www.rubydoc.info/github/ruby-i18n/i18n/master/I18n/Backend/Chain
+
+## Installation
+
+Add this line to your application's `Gemfile`:
+
+```ruby
+gem 'i18n-postgres_json'
+```
+
+And then execute:
+
+```bash
+bundle
+```
+
+### I18n::PostgresJson::KeyValue::Store
+
+The `I18n::PostgresJson::KeyValue::Store` class serves as a `store` for the
+[`I18n::Backend::KeyValue` backend][i18n-key-value].
+
+The `I18n::PostgresJson::KeyValue::Store` interacts with a Postgres table
+consisting of:
+
+```
+                                         Table "public.i18n_postgres_json_key_value_store_translations"
+    Column    |            Type             | Collation | Nullable |                                   Default
+--------------+-----------------------------+-----------+----------+-----------------------------------------------------------------------------
+ id           | integer                     |           | not null | nextval('i18n_postgres_json_key_value_store_translations_id_seq'::regclass)
+ translations | json                        |           | not null | '{}'::json
+ created_at   | timestamp without time zone |           | not null |
+ updated_at   | timestamp without time zone |           | not null |
+Indexes:
+    "i18n_postgres_json_key_value_store_translations_pkey" PRIMARY KEY, btree (id)
+```
+
+This style of backend store _all_ translations, regardless of locale, within the
+same `translations` column, backed by [JSON][pg-json].
+
+**This table is only ever intended to store a single row.**
+
+To generate this table, install the necessary migrations:
+
+```bash
+rails i18n_postgres_json:install:key_value
+```
+
+Then execute them:
+
+```bash
+rails db:migrate
+```
+
+Next, configure your `I18n.backend` (either in a Rails environment configuration
+block, or an initializer of its own):
+
+```ruby
+# config/initializers/i18n.rb
+I18n.backend = I18n::Backend::Chain.new(
+  I18n::Backend::KeyValue.new(I18n::PostgresJson::KeyValue::Store.new),
+  I18n.backend, # typically defaults to I18n::Backend::Simple
+)
+```
+
+**Caveat:** It's worth noting that according to the [`I18n::Backend::KeyValue`
+documentation][i18n-key-value], this backend cannot store serialized [Ruby
+`Proc` instances][proc]:
+
+> Since these stores only supports string, all values are converted to JSON
+> before being stored, allowing it to also store booleans, hashes and arrays.
+> **However, this store does not support Procs.**
+
+[i18n-key-value]: https://www.rubydoc.info/github/ruby-i18n/i18n/master/I18n/Backend/KeyValue
+[proc]: https://ruby-doc.org/core-2.7.1/Proc.html
+
+### I18n::PostgresJson::Backend
+
+The `I18n::PostgresJson::Backend` class serves as an `I18n::Backend`
+implementation of its own.
+
+The `I18n::PostgresJson::Backend` interacts with a Postgres table
+consisting of:
+
+```
+                                         Table "public.i18n_postgres_json_backend_translations"
+    Column    |            Type             | Collation | Nullable |                               Default
+--------------+-----------------------------+-----------+----------+---------------------------------------------------------------------
+ id           | integer                     |           | not null | nextval('i18n_postgres_json_backend_translations_id_seq'::regclass)
+ locale       | character varying           |           | not null |
+ translations | json                        |           | not null | '{}'::json
+ created_at   | timestamp without time zone |           | not null |
+ updated_at   | timestamp without time zone |           | not null |
+Indexes:
+    "i18n_postgres_json_backend_translations_pkey" PRIMARY KEY, btree (id)
+    "index_i18n_postgres_json_backend_translations_on_locale" UNIQUE, btree (locale)
+```
+
+This style of backend splits each `locale` into its own row, separating out
+translations into one lookup table per-locale. The `translations` column is
+backed by [JSON][pg-json].
+
+To generate this table, install the necessary migrations:
+
+```bash
+rails i18n_postgres_json:install:backend
+```
+
+Then execute them:
+
+```bash
+rails db:migrate
+```
+
+Next, configure your `I18n.backend` (either in a Rails environment configuration
+block, or an initializer of its own):
+
+```ruby
+# config/initializers/i18n.rb
+I18n.backend = I18n::Backend::Chain.new(
+  I18n::PostgresJson::Backend.new,
+  I18n.backend, # typically defaults to I18n::Backend::Simple
+)
+```
+
+**Caveat**: It's worth noting that the `I18n::PostgresJson::Backend` does not
+currently support translation linking.
+
+### Writing to the tables
+
+Regardless of whether your application integrates with
+`I18n::PostgresJson::KeyValue::Store`, or `I18n::PostgresJson::Backend`, the
+implementation for updating existing translations will be the same: use
+[`I18n::Backend::Base.store_translations`][store_translations].
+
+If you were to edit a translation through an HTML `<form>` element that
+submitted to a Rails controller, it might look something like this:
+
+```html
+<!-- app/views/posts/index.html.erb -->
+<form action="/translations" method="post">
+  <input type="hidden" name="translation[locale]" value="en">
+  <input type="hidden" name="translation[key]" value="posts.index.title">
+
+  <label for="translation_value">
+    Translation for posts.index.title
+  </label>
+  <input type="text" id="translation_value" name="translation[value]">
+
+  <button>
+    Save Translation
+  </button>
+</form>
+```
+
+When that `<form>` element is submitted, the resulting controller action (in
+this example, `translations#create`) would pass along the submitted translation
+to `store_translations`:
+
+```ruby
+class TranslationsController < ApplicationController
+  def create
+    I18n.backend.store_translation(
+      translation_params.fetch(:locale),
+      translation_params.fetch(:key) => translation_params.fetch(:value),
+    )
+
+    redirect_to posts_url
+  end
+
+  private
+
+  def translation_params
+    params.require(:translation).permit(
+      :key,
+      :locale,
+      :value,
+    )
+  end
+end
+```
+
+**Caveat:** This is a potentially disruptive (and destructive!) action, so the
+application would want to limit control to authenticated content editors. This
+example omits those details for the sake of brevity.
+
+[store_translations]: https://www.rubydoc.info/github/ruby-i18n/i18n/I18n/Backend/Base#store_translations-instance_method
+
+## Testing
+
+In addition to being exercised by a test harness specific to this gem, each
+backend is covered by the [`i18n-ruby`-provided API Tests][interface-tests].
+
+These test cover a range of behavior, including:
+
+* [The Basics of translating text](https://github.com/ruby-i18n/i18n/blob/v1.8.2/lib/i18n/tests/basics.rb)
+* [Translation lookup](https://github.com/ruby-i18n/i18n/blob/v1.8.2/lib/i18n/tests/lookup.rb)
+* [Falling back to provided defaults](https://github.com/ruby-i18n/i18n/blob/v1.8.2/lib/i18n/tests/defaults.rb)
+* [Interpolation](https://github.com/ruby-i18n/i18n/blob/v1.8.2/lib/i18n/tests/interpolation.rb)
+* [Translation key linking](https://github.com/ruby-i18n/i18n/blob/v1.8.2/lib/i18n/tests/link.rb)
+* [Localizing Dates and Times](https://github.com/ruby-i18n/i18n/blob/v1.8.2/lib/i18n/tests/localization.rb)
+* [Pluralizing text](https://github.com/ruby-i18n/i18n/blob/v1.8.2/lib/i18n/tests/pluralization.rb)
+* [Storing Ruby Procs](https://github.com/ruby-i18n/i18n/blob/v1.8.2/lib/i18n/tests/procs.rb)
+
+[interface-tests]: https://github.com/ruby-i18n/i18n/blob/v1.8.2/lib/i18n/tests/basics.rb
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md).
+
+## 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,32 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'I18n::PostgresJson'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/db/migrate/backend/20200409133306_create_i18n_postgres_json_backend_translations.rb

@@ -0,0 +1,11 @@
+class CreateI18nPostgresJsonBackendTranslations < ActiveRecord::Migration[4.2]
+  def change
+    create_table :i18n_postgres_json_backend_translations do |t|
+      t.string :locale, null: false
+      t.json :translations, null: false, default: {}
+      t.timestamps null: false
+
+      t.index :locale, unique: true
+    end
+  end
+end

data/db/migrate/key_value/20200410160009_create_i18n_postgres_json_key_value_store_translations.rb

@@ -0,0 +1,9 @@
+class CreateI18nPostgresJsonKeyValueStoreTranslations < ActiveRecord::Migration[4.2]
+  def change
+    create_table :i18n_postgres_json_key_value_store_translations do |t|
+      t.json :translations, null: false, default: {}
+
+      t.timestamps null: false
+    end
+  end
+end

data/lib/i18n/postgres_json.rb

@@ -0,0 +1,7 @@
+require "i18n/postgres_json/engine"
+
+module I18n
+  module PostgresJson
+    # Your code goes here...
+  end
+end

data/lib/i18n/postgres_json/backend.rb

@@ -0,0 +1,25 @@
+module I18n
+  module PostgresJson
+    class Backend
+      include I18n::Backend::Base
+
+      def available_locales=(available_locales)
+        @available_locales = Array(available_locales).map(&:to_sym).presence
+      end
+
+      def available_locales
+        @available_locales || Translation.available_locales
+      end
+
+      def store_translations(locale, data, **options)
+        Translation.store_translations(locale, data)
+      end
+
+      protected
+
+      def lookup(locale, key, scope = [], separator: I18n.default_separator, **options)
+        Translation.locale(locale).lookup(key, scope, separator: separator)
+      end
+    end
+  end
+end

data/lib/i18n/postgres_json/engine.rb

@@ -0,0 +1,10 @@
+module I18n
+  module PostgresJson
+    class Engine < ::Rails::Engine
+      ActiveSupport.on_load(:active_record) do
+        require "i18n/postgres_json/translation"
+        require "i18n/postgres_json/key_value/translation"
+      end
+    end
+  end
+end

data/lib/i18n/postgres_json/key_value/store.rb

@@ -0,0 +1,32 @@
+module I18n
+  module PostgresJson
+    module KeyValue
+      class Store
+        def [](key)
+          record[escape(key)]
+        end
+
+        def []=(key, value)
+          record[escape(key)] = value
+        end
+
+        def keys
+          record.keys
+        end
+
+        private
+
+        def escape(key)
+          key.gsub(
+            I18n::Backend::Flatten::SEPARATOR_ESCAPE_CHAR,
+            I18n.default_separator
+          )
+        end
+
+        def record
+          Translation.first_or_initialize
+        end
+      end
+    end
+  end
+end

data/lib/i18n/postgres_json/key_value/translation.rb

@@ -0,0 +1,23 @@
+module I18n
+  module PostgresJson
+    module KeyValue
+      class Translation < ActiveRecord::Base
+        self.table_name = "i18n_postgres_json_key_value_store_translations"
+
+        def [](key)
+          translations[key]
+        end
+
+        def []=(key, value)
+          translations[key] = value
+
+          save!
+        end
+
+        def keys
+          translations.keys
+        end
+      end
+    end
+  end
+end

data/lib/i18n/postgres_json/translation.rb

@@ -0,0 +1,53 @@
+module I18n
+  module PostgresJson
+    class Translation < ActiveRecord::Base
+      self.table_name = "i18n_postgres_json_backend_translations"
+
+      def self.available_locales
+        (
+          distinct.order(locale: :asc).pluck(:locale) + [I18n.default_locale]
+        ).map(&:to_sym).uniq
+      end
+
+      def self.store_translations(locale, data)
+        record = self.locale(locale)
+
+        record.translations.deep_merge!(data.deep_stringify_keys)
+
+        record.save!
+      end
+
+      def self.locale(locale)
+        find_or_initialize_by(locale: locale)
+      end
+
+      def dig(*keys)
+        keys = Array(keys)
+
+        translations.with_indifferent_access.dig(*keys)
+      end
+
+      def lookup(key, scope = [], separator:)
+        _, *keys = I18n.normalize_keys(locale, key, scope, separator)
+
+        translated = keys.each_with_index.reduce(nil) { |translation, (_, index)|
+          if translation.present?
+            translation
+          else
+            leading = keys.take(index)
+            trailing = keys.drop(index)
+
+            dig(*([leading.join(separator)] + keys - leading)) ||
+              dig(*(keys - trailing + [trailing.join(separator)]))
+          end
+        }
+
+        if translated.respond_to?(:deep_symbolize_keys)
+          translated.deep_symbolize_keys
+        else
+          translated
+        end
+      end
+    end
+  end
+end

data/lib/i18n/postgres_json/version.rb

@@ -0,0 +1,5 @@
+module I18n
+  module PostgresJson
+    VERSION = '0.1.0'
+  end
+end

data/lib/tasks/i18n/postgres_json_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :i18n_postgres_json do
+#   # Task goes here
+# end

data/lib/tasks/i18n_postgres_jsonb_tasks.rake

@@ -0,0 +1,27 @@
+namespace :i18n_postgres_json do
+  namespace :install do
+    Rake::Task["i18n_postgres_json_engine:install:migrations"].clear_comments
+
+    desc "Copy over the migrations needed for I18n::PostgresJson::Backend integration"
+    task backend: :environment do
+      ENV["MIGRATIONS_PATH"] = "db/migrate/backend"
+
+      if Rake::Task.task_defined?("i18n_postgres_json_engine:install:migrations")
+        Rake::Task["i18n_postgres_json_engine:install:migrations"].invoke
+      else
+        Rake::Task["app:i18n_postgres_json_engine:install:migrations"].invoke
+      end
+    end
+
+    desc "Copy over the migrations needed for I18n::PostgresJson::KeyValue::Store integration"
+    task key_value: :environment do
+      ENV["MIGRATIONS_PATH"] = "db/migrate/key_value"
+
+      if Rake::Task.task_defined?("i18n_postgres_json_engine:install:migrations")
+        Rake::Task["i18n_postgres_json_engine:install:migrations"].invoke
+      else
+        Rake::Task["app:i18n_postgres_json_engine:install:migrations"].invoke
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: i18n-postgres_json
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sean Doyle
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-04-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+- !ruby/object:Gem::Dependency
+  name: minitest-around
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+description: Store I18n values in PostgreSQL JSON columns
+email:
+- sean.p.doyle24@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- db/migrate/backend/20200409133306_create_i18n_postgres_json_backend_translations.rb
+- db/migrate/key_value/20200410160009_create_i18n_postgres_json_key_value_store_translations.rb
+- lib/i18n/postgres_json.rb
+- lib/i18n/postgres_json/backend.rb
+- lib/i18n/postgres_json/engine.rb
+- lib/i18n/postgres_json/key_value/store.rb
+- lib/i18n/postgres_json/key_value/translation.rb
+- lib/i18n/postgres_json/translation.rb
+- lib/i18n/postgres_json/version.rb
+- lib/tasks/i18n/postgres_json_tasks.rake
+- lib/tasks/i18n_postgres_jsonb_tasks.rake
+homepage: https://github.com/seanpdoyle/i18n-postgres_json
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Internationalization backed by Postgres JSON columns
+test_files: []