embedded_localization 1.3.1 → 1.4.0

data/lib/embedded_localization/storage/hstore.rb

@@ -0,0 +1,61 @@
+module EmbeddedLocalization
+  module Storage
+    # ActiveRecord attribute type for a PostgreSQL hstore `i18n` column.
+    #
+    # hstore is a flat String => String map, so each translation is stored under the key "<locale>.<attribute>",
+    # e.g. "de.name" => "Science-Fiction". In Ruby the gem works with the nested Hash {de: {name: "Science-Fiction"}}.
+    # Reading and writing the hstore text format is delegated to ActiveRecord's own hstore type.
+    class Hstore < ::ActiveRecord::Type::Value
+      include ::ActiveModel::Type::Helpers::Mutable
+
+      SEPARATOR = '.'.freeze
+
+      def type
+        :hstore
+      end
+
+      def deserialize(value)
+        nest(hstore.deserialize(value))
+      end
+
+      def serialize(value)
+        hstore.serialize(flatten(value))
+      end
+
+      def changed_in_place?(raw_old_value, new_value)
+        deserialize(raw_old_value) != new_value
+      end
+
+      private
+
+      # ActiveRecord registers the hstore type when the PostgreSQL adapter is loaded, i.e. when the connection is
+      # established; it is looked up on first use, so a model can be defined before the connection exists.
+      def hstore
+        @hstore ||= ::ActiveRecord::Type.lookup(:hstore, adapter: :postgresql)
+      end
+
+      # {de: {name: "x"}} => {"de.name" => "x"}
+      def flatten(translations)
+        return translations unless translations.is_a?(::Hash)
+
+        translations.each_with_object({}) do |(locale, attributes), flat|
+          next unless attributes.is_a?(::Hash)
+
+          attributes.each { |attr_name, value| flat["#{locale}#{SEPARATOR}#{attr_name}"] = value }
+        end
+      end
+
+      # {"de.name" => "x"} => {de: {name: "x"}} ; keys without a separator are ignored
+      def nest(flat)
+        return flat unless flat.is_a?(::Hash)
+
+        flat.each_with_object({}) do |(key, value), translations|
+          locale, attr_name = key.split(SEPARATOR, 2)
+          next unless attr_name
+
+          (translations[locale.to_sym] ||= {})[attr_name.to_sym] = value
+        end
+      end
+    end
+  end
+end

data/lib/embedded_localization/storage/json.rb

@@ -0,0 +1,25 @@
+module EmbeddedLocalization
+  module Storage
+    # ActiveRecord attribute type for a json or jsonb `i18n` column.
+    #
+    # The column holds {"en" => {"name" => "..."}, "de" => {...}}; in Ruby the gem works with Symbol keys on both
+    # levels, so this type converts the keys whenever a value comes from the database. Assignment goes through the
+    # same conversion: ActiveRecord::Type::Json includes ActiveModel::Type::Helpers::Mutable, whose cast(value) is
+    # deserialize(serialize(value)).
+    class Json < ::ActiveRecord::Type::Json
+      def deserialize(value)
+        symbolize_keys(super)
+      end
+
+      private
+
+      def symbolize_keys(translations)
+        return translations unless translations.is_a?(::Hash)
+
+        translations.each_with_object({}) do |(locale, attributes), result|
+          result[locale.to_sym] = attributes.is_a?(::Hash) ? attributes.transform_keys(&:to_sym) : attributes
+        end
+      end
+    end
+  end
+end

data/lib/embedded_localization/version.rb

@@ -1,3 +1,3 @@
 module EmbeddedLocalization
-  VERSION = '1.3.1'
+  VERSION = '1.4.0'
 end

data/lib/embedded_localization.rb

@@ -1,12 +1,16 @@
 require "active_record"
 require "embedded_localization/version"
-require 'extensions/hash'
 
 module EmbeddedLocalization
   autoload :ActiveRecord, 'embedded_localization/active_record'
+
+  # ActiveRecord attribute types for the `i18n` column when it is not a YAML text column
+  module Storage
+    autoload :Json,   'embedded_localization/storage/json'
+    autoload :Hstore, 'embedded_localization/storage/hstore'
+  end
 end
 
-# we're assuming for now only to be used with ActiveRecord 3, which is auto-required above
 ActiveRecord::Base.extend(EmbeddedLocalization::ActiveRecord::ActMacro)
 
 #-
@@ -30,4 +34,3 @@ ActiveRecord::Base.extend(EmbeddedLocalization::ActiveRecord::ActMacro)
 
 # not as general:
 # I18n::Backend::Simple.send(:include, I18n::Backend::Fallbacks)
-

metadata

@@ -1,17 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: embedded_localization
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.4.0
 platform: ruby
 authors:
 - Tilo Sloboda
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-26 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: codecov
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -25,7 +24,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -82,18 +81,14 @@ dependencies:
         version: '0'
 description: 'Rails I18n: a very lightweight tool to allow you to transparently store
   multiple translations of attributes directly inside each DB record -- no extra database
-  tables needed to store the localization data!'
+  tables needed to store the localization data! All translations of a record live
+  in one column: a YAML text column, a json/jsonb column, or a PostgreSQL hstore column.'
 email:
 - tilo.sloboda@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/dependabot.yml"
-- ".github/workflows/codeql-analysis.yml"
-- ".github/workflows/ruby.yml"
-- ".gitignore"
-- ".rspec"
 - CHANGELOG.md
 - Gemfile
 - README.md
@@ -104,14 +99,9 @@ files:
 - lib/embedded_localization/active_record/act_macro.rb
 - lib/embedded_localization/active_record/class_methods.rb
 - lib/embedded_localization/active_record/instance_methods.rb
+- lib/embedded_localization/storage/hstore.rb
+- lib/embedded_localization/storage/json.rb
 - lib/embedded_localization/version.rb
-- lib/extensions/hash.rb
-- spec/embedded_localization/native_column_spec.rb
-- spec/embedded_localization/simple_model_spec.rb
-- spec/models.rb
-- spec/schema.rb
-- spec/spec.opts
-- spec/spec_helper.rb
 homepage: https://github.com/tilo/embedded_localization
 licenses:
 - MIT
@@ -119,7 +109,7 @@ metadata:
   homepage_uri: https://github.com/tilo/embedded_localization
   source_code_uri: https://github.com/tilo/embedded_localization
   changelog_uri: https://github.com/tilo/embedded_localization/blob/main/CHANGELOG.md
-post_install_message:
+  bug_tracker_uri: https://github.com/tilo/embedded_localization/issues
 rdoc_options: []
 require_paths:
 - lib
@@ -134,14 +124,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.4
-signing_key:
+rubygems_version: 4.0.17
 specification_version: 4
 summary: 'Rails I18n: library for embedded ActiveRecord model/data translation'
-test_files:
-- spec/embedded_localization/native_column_spec.rb
-- spec/embedded_localization/simple_model_spec.rb
-- spec/models.rb
-- spec/schema.rb
-- spec/spec.opts
-- spec/spec_helper.rb
+test_files: []

data/.github/dependabot.yml

@@ -1,8 +0,0 @@
-version: 2
-updates:
-  - package-ecosystem: "github-actions"
-    directory: "/"
-    schedule:
-      interval: "weekly"
-      day: "friday"
-      time: "01:00" # UTC

data/.github/workflows/codeql-analysis.yml

@@ -1,72 +0,0 @@
-# For most projects, this workflow file will not need changing; you simply need
-# to commit it to your repository.
-#
-# You may wish to alter this file to override the set of languages analyzed,
-# or to provide custom queries or build logic.
-#
-# ******** NOTE ********
-# We have attempted to detect the languages in your repository. Please check
-# the `language` matrix defined below to confirm you have the correct set of
-# supported CodeQL languages.
-#
-name: "CodeQL"
-
-on:
-  push:
-    branches: [ "main" ]
-  pull_request:
-    # The branches below must be a subset of the branches above
-    branches: [ "main" ]
-  schedule:
-    - cron: '39 11 * * 2'
-
-jobs:
-  analyze:
-    name: Analyze
-    runs-on: ubuntu-latest
-    permissions:
-      actions: read
-      contents: read
-      security-events: write
-
-    strategy:
-      fail-fast: false
-      matrix:
-        language: [ 'ruby' ]
-        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
-        # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
-
-    steps:
-    - name: Checkout repository
-      uses: actions/checkout@v4
-
-    # Initializes the CodeQL tools for scanning.
-    - name: Initialize CodeQL
-      uses: github/codeql-action/init@v3
-      with:
-        languages: ${{ matrix.language }}
-        # If you wish to specify custom queries, you can do so here or in a config file.
-        # By default, queries listed here will override any specified in a config file.
-        # Prefix the list here with "+" to use these queries and those in the config file.
-        
-        # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
-        # queries: security-extended,security-and-quality
-
-        
-    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
-    # If this step fails, then you should remove it and run the build manually (see below)
-    - name: Autobuild
-      uses: github/codeql-action/autobuild@v3
-
-    # ℹ️ Command-line programs to run using the OS shell.
-    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
-
-    #   If the Autobuild fails above, remove it and uncomment the following three lines. 
-    #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
-
-    # - run: |
-    #   echo "Run, Build Application using script"
-    #   ./location_of_script_within_repo/buildscript.sh
-
-    - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v3

data/.github/workflows/ruby.yml

@@ -1,64 +0,0 @@
-# install dependencies and run tests
-# https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
-
-name: Ruby
-
-on:
-  push:
-    branches:
-      - main
-
-  pull_request:
-
-jobs:
-  test_matrix:
-
-    strategy:
-      fail-fast: false
-      matrix:
-        os:
-          - ubuntu
-          - macos
-        ruby:
-          - 2.5
-          - 2.6
-          - 2.7
-          - "3.0"
-          - 3.1
-          - 3.2
-          - 3.3
-          - head
-          - truffleruby
-          - truffleruby-head
-          - mingw
-          - jruby
-          - jruby-head
-        exclude:
-          - { os: ubuntu,  ruby: mingw }
-          - { os: macos,   ruby: mingw }
-          - { os: windows, ruby: truffleruby }
-          - { os: windows, ruby: truffleruby-head }
-
-    runs-on: ${{ matrix.os }}-latest
-
-    steps:
-      - name: clone ${{ github.repository }}
-        uses: actions/checkout@v4
-      - name: setup Ruby ${{ matrix.ruby }}
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby }}
-          bundler-cache: true
-        env:
-          JAVA_OPTS: -Djdk.io.File.enableADS=true
-      - name: Run tests
-        run: bundle exec rake
-        env:
-          JAVA_OPTS: -Djdk.io.File.enableADS=true
-
-  finish:
-    runs-on: ubuntu-latest
-    needs: [ test_matrix ]
-    steps:
-      - name: Wait for status checks
-        run: echo "All Green!"

data/.gitignore

@@ -1,7 +0,0 @@
-#*#
-*~
-*.bak
-*.gem
-.bundle
-Gemfile.lock
-pkg/*

data/.rspec

@@ -1 +0,0 @@
---require spec_helper

data/lib/extensions/hash.rb

@@ -1,7 +0,0 @@
-class Hash
-  def self.zip(keys,values) # from Facets of Ruby library, CREDIT: Trans, Ara T. Howard
-    h = {}
-    keys.size.times{ |i| h[ keys[i] ] = values[i] }
-    h
-  end
-end

data/spec/embedded_localization/native_column_spec.rb

@@ -1,191 +0,0 @@
-# encoding: utf-8
-require 'spec_helper'
-
-I18n.locale = :en
-
-# e.g. the model "Movie" has :title as a translated field,
-#      but also has :title as a native attribute for the model.
-
-describe 'model has translated field with attribute of that same name' do
-  let(:movie){ Movie.new }
-
-  describe "basic things that need to work" do
-
-    it 'reports it translates' do
-      Movie.translates?.should be_truthy
-    end
-
-    it 'correctly reports the list of translated_attributes' do
-      Movie.translated_attributes.sort.should eq [:description, :title]
-    end
-
-    it 'correctly reports the list of translated_attribute_names' do
-      Movie.translated_attribute_names.sort.should eq [:description, :title]
-    end
-
-    it 'correcty shows the translated attribute as translated' do
-      Movie.translated?(:title).should be_truthy
-      Movie.translated?(:description).should be_truthy
-    end
-
-    it 'correcty shows not translated attribute' do
-      Movie.translated?(:other).should be_falsy
-    end
-  end
-
-  describe "new DB records" do
-
-    it 'correctly reports translated_locales for new record' do
-      movie.translated_locales.should eq [I18n.default_locale]
-    end
-
-    it 'correctly reports translation_missing for new record' do
-      movie.translation_missing.should be_truthy
-    end
-
-    it 'creates the accessor methods' do
-      movie.methods.should include(:title)
-      movie.methods.should include(:title=)
-      movie.methods.should include(:description)
-      movie.methods.should include(:description=)
-    end
-
-    it 'correctly reports translated field for new record for default locale' do
-      movie.title.should be_nil
-      movie.description.should be_nil
-      movie.description( I18n.default_locale ).should be_nil
-    end
-
-    it 'correctly reports translated field for new record for other locale' do
-      movie.title(:ko).should be_nil
-      movie.description(:de).should be_nil
-    end
-
-    it 'correctly reports translation_coverage for new record' do
-      movie.translation_coverage.should eq Hash.new
-    end
-
-    it 'correctly reports translation_goverate for attributes of new record' do
-      movie.translation_coverage(:title).should eq []
-      movie.translation_coverage(:description).should eq []
-    end
-
-    it 'translated_coverage returns nil for not-translated attributes' do
-      movie.translation_coverage(:other).should be_nil
-    end
-
-    it 'correctly reports translation_missing for new record' do
-      movie.translation_missing.should == {:description=>[:en], :title=>[:en]}
-      movie.translation_missing(:title).should eq [:en]
-      movie.translation_missing(:description).should eq [:en]
-    end
-  end
-
-
-  describe "DB record with pre-set fields" do
-    let(:title_en){ "Blade Runner" }
-    let(:blade_runner){ Movie.new(:title => title_en) }
-
-    it 'correctly shows the attribute for new record' do
-      blade_runner.title.should eq title_en
-    end
-  end
-
-
-  describe "updated DB record" do
-    let(:title_en){ "Blade Runner" }
-    let(:title_ru){'аЕЦСЫХИ ОН КЕГБХЧ'}
-    let(:title_tr){"Ölüm takibi"}
-    let(:title_de){"Der Blade Runner"}
-    let(:blade_runner){ Movie.new(:title => title_en) }
-
-    describe 'updating just default locale' do
-
-      before :each do
-        movie.title = title_en
-        movie.description = "an awesome movie"
-        movie.save
-        movie.reload
-      end
-
-      it 'correctly reports the translated_locales' do
-        movie.translated_locales.should eq [:en]
-      end
-
-      # when setting all fields in the default locale's languange:
-      it 'correctly reports translation_missing for updated record' do
-        movie.translation_missing.should eq Hash.new
-      end
-
-      it 'correctly reports translation_missing for attributes' do
-        movie.translation_missing(:title).should eq nil
-        movie.translation_missing(:description).should eq nil
-      end
-
-      it 'correctly reports translated_coverage for updated record' do
-        movie.translation_coverage.should == {:title=>[:en], :description=>[:en]}
-      end
-
-      it 'correctly reports translated_coverage for attributes' do
-        movie.translation_coverage(:title).should eq [:en]
-        movie.translation_coverage(:description).should eq [:en]
-      end
-    end
-
-    describe 'updating other locales' do
-      before :each do
-        movie.title = title_en
-        movie.description = "an awesome movie"
-        I18n.locale = :ru
-        movie.title = title_ru
-        movie.set_localized_attribute(:title , :tr, title_tr)
-        I18n.locale = :de
-        movie.description = "ein grossartiger Film"
-        I18n.locale = I18n.default_locale   # MAKE SURE you switch back to your default loale if you tweak it
-        movie.save
-        movie.reload
-      end
-
-      it 'correctly reports the translated_locales' do
-        movie.translated_locales.should eq [:en, :ru, :tr, :de]
-      end
-
-      it 'can assign the translated field' do
-        movie.title = title_en
-        movie.save.should be_truthy
-        movie.title.should eq  title_en
-        movie.title(:en).should eq  title_en
-      end
-
-      # when setting all fields in additional languanges:
-      it 'correctly reports values for updated record via attr(:locale)' do
-        movie.title(:tr).should eq title_tr
-      end
-
-      it 'correctly reports values for updated record via getter' do
-        movie.get_localized_attribute(:title, :ru).should eq title_ru
-      end
-
-      it 'correctly reports translation_coverage for updated record' do
-        # what values are actually present
-        movie.translation_coverage.should == {:title=>[:en, :ru, :tr], :description=>[:en, :de]}
-      end
-
-      it 'correctly reports translation_coverage for attributes' do
-        movie.translation_coverage(:title).should eq [:en,:ru,:tr]
-        movie.translation_coverage(:description).should eq [:en,:de]
-      end
-
-      it 'correctly reports translation_missing for updated record' do
-        # what values are missing
-        movie.translation_missing.should == {:description=>[:ru, :tr], :title=>[:de]}
-      end
-
-      it 'correctly reports translation_missing for attributes' do
-        movie.translation_missing(:title).should eq [:de]
-        movie.translation_missing(:description).should eq [:ru,:tr]
-      end
-    end
-
-  end
-end