embedded_localization 1.3.0 → 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.0'
+  VERSION = '1.4.0'
 end

data/lib/embedded_localization.rb

@@ -1,11 +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)
 
 #-
@@ -29,4 +34,3 @@ ActiveRecord::Base.extend(EmbeddedLocalization::ActiveRecord::ActMacro)
 
 # not as general:
 # I18n::Backend::Simple.send(:include, I18n::Backend::Fallbacks)
-

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: embedded_localization
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Tilo Sloboda
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-13 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -24,6 +23,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -66,17 +79,16 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 'Rails I18n: Embedded_Localization for ActiveRecord is very lightweight,
-  and allows you to transparently store translations of attributes right inside each
-  record -- no extra database tables needed to store the localization data!'
+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! 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:
-- ".gitignore"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - README.md
@@ -87,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
@@ -102,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
@@ -117,14 +124,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
-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/.gitignore

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

data/.travis.yml

@@ -1,32 +0,0 @@
-language: ruby
-bundler_args: --without development
-before_install:
-  - gem install bundler
-  - gem update --system
-
-matrix:
-  include:
-    - rvm: 2.2.10
-    - rvm: 2.3.8
-    - rvm: 2.4.10
-    - rvm: 2.5.8
-    - rvm: 2.6.9
-    - rvm: 2.7.5
-    - rvm: 3.0.3
-    - rvm: 3.1.0
-    - rvm: 3.2.0
-    - rvm: 3.3.0
-    - rvm: jruby-9.2.19.0
-    - rvm: jruby-9.3.3.0
-    - jruby-head
-    - mruby
-    - rubinius
-    - ree
-
-      env:
-        - JRUBY_OPTS="--server -Xcompile.invokedynamic=false -J-XX:+TieredCompilation -J-XX:TieredStopAtLevel=1 -J-noverify -J-Xms512m -J-Xmx1024m"
-    - rvm: ruby-head
-
-branches:
-  only:
-    - master

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

data/spec/embedded_localization/simple_model_spec.rb

@@ -1,190 +0,0 @@
-# encoding: utf-8
-require 'spec_helper'
-
-I18n.locale = :en
-
-# e.g. the model "Genre" has :name as a translated field,
-#      but does not have :name as a native attribute for the model.
-#      It is only defined as a virtual attribute in the :i18n hash.
-
-describe 'model has translated field without attribute of that same name' do
-  let(:genre){ Genre.new }
-
-  describe "basic things that need to work" do
-
-    it 'reports it translates' do
-      Genre.translates?.should be_truthy
-    end
-
-    it 'correctly reports the list of translated_attributes' do
-      Genre.translated_attributes.sort.should eq [:description, :name]
-    end
-
-    it 'correctly reports the list of translated_attribute_names' do
-      Genre.translated_attribute_names.sort.should eq [:description, :name]
-    end
-
-    it 'correcty shows the translated attribute as translated' do
-      Genre.translated?(:name).should be_truthy
-      Genre.translated?(:description).should be_truthy
-    end
-
-    it 'correcty shows not translated attribute' do
-      Genre.translated?(:other).should be_falsy
-    end
-  end
-
-  describe "new DB records" do
-
-    it 'correctly reports translated_locales for new record' do
-      genre.translated_locales.should eq [I18n.default_locale]
-    end
-
-    it 'correctly reports translation_missing for new record' do
-      genre.translation_missing.should be_truthy
-    end
-
-    it 'creates the accessor methods' do
-      genre.methods.should include(:name)
-      genre.methods.should include(:name=)
-      genre.methods.should include(:description)
-      genre.methods.should include(:description=)
-    end
-
-    it 'correctly reports translated field for new record for default locale' do
-      genre.name.should be_nil
-      genre.description.should be_nil
-      genre.description( I18n.default_locale ).should be_nil
-    end
-
-    it 'correctly reports translated field for new record for other locale' do
-      genre.name(:ko).should be_nil
-      genre.description(:de).should be_nil
-    end
-
-    it 'correctly reports translation_coverage for new record' do
-      genre.translation_coverage.should eq Hash.new
-    end
-
-    it 'correctly reports translation_goverate for attributes of new record' do
-      genre.translation_coverage(:name).should eq []
-      genre.translation_coverage(:description).should eq []
-    end
-
-    it 'translated_coverage returns nil for not-translated attributes' do
-      genre.translation_coverage(:other).should be_nil
-    end
-
-    it 'correctly reports translation_missing for new record' do
-      genre.translation_missing.should == {:description=>[:en], :name=>[:en]}
-      genre.translation_missing(:name).should eq [:en]
-      genre.translation_missing(:description).should eq [:en]
-    end
-  end
-
-  describe "DB record with pre-set fields" do
-    let(:genre_name_en){"Science Fiction"}
-    let(:scifi){ Genre.new(:name => genre_name_en) }
-
-    it 'correctly shows the attribute for new record' do
-      scifi.name.should eq genre_name_en
-    end
-  end
-
-  describe "updated DB record" do
-    let(:genre_name_en){"Science Fiction"}
-    let(:genre_name_jp){"サイエンスフィクション"}
-    let(:genre_name_ko){"공상 과학 소설"}
-    let(:scifi){ Genre.new(:name => genre_name_en) }
-
-    describe 'updating just default locale' do
-
-      before :each do
-        genre.name = genre_name_en
-        genre.description = "an awesome genre"
-        genre.save
-        genre.reload
-      end
-
-      it 'correctly reports the translated_locales' do
-        genre.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
-        genre.translation_missing.should eq Hash.new
-      end
-
-      it 'correctly reports translation_missing for attributes' do
-        genre.translation_missing(:name).should eq nil
-        genre.translation_missing(:description).should eq nil
-      end
-
-      it 'correctly reports translated_coverage for updated record' do
-        genre.translation_coverage.should == {:name=>[:en], :description=>[:en]}
-      end
-
-      it 'correctly reports translated_coverage for attributes' do
-        genre.translation_coverage(:name).should eq [:en]
-        genre.translation_coverage(:description).should eq [:en]
-      end
-    end
-
-
-    describe 'updating other locales' do
-      before :each do
-        genre.name = genre_name_en
-        genre.description = "an awesome genre"
-        I18n.locale = :jp
-        genre.name = genre_name_jp
-        genre.set_localized_attribute(:name, :ko, genre_name_ko)
-        I18n.locale = :de
-        genre.description = "ein grossartiges Genre"
-        I18n.locale = I18n.default_locale   # MAKE SURE you switch back to your default locale if you tweak it
-        genre.save
-        genre.reload
-      end
-
-      it 'correctly reports the translated_locales' do
-        genre.translated_locales.should eq [:en, :jp, :ko, :de]
-      end
-
-      it 'can assign the translated field' do
-        genre.name = genre_name_en
-        genre.save.should be_truthy
-        genre.name.should eq  genre_name_en
-        genre.name(:en).should eq genre_name_en
-      end
-
-      # when setting all fields in additional languanges:
-      it 'correctly reports values for updated record via attr(:locale)' do
-        genre.name(:ko).should eq genre_name_ko
-      end
-
-      it 'correctly reports values for updated record via getter' do
-        genre.get_localized_attribute(:name, :jp).should eq genre_name_jp
-      end
-
-      it 'correctly reports translation_coverage for updated record' do
-          # what values are actually present
-        genre.translation_coverage.should == {:name=>[:en, :jp, :ko], :description=>[:en, :de]}
-      end
-
-      it 'correctly reports translation_coverage for attributes' do
-        genre.translation_coverage(:name).should eq [:en, :jp, :ko]
-        genre.translation_coverage(:description).should eq [:en,:de]
-      end
-
-      it 'correctly reports translation_missing for updated record' do
-         # what values are missing
-        genre.translation_missing.should == {:description=>[:jp, :ko], :name=>[:de]}
-      end
-
-      it 'correctly reports translation_missing for attributes' do
-        genre.translation_missing(:name).should eq [:de]
-        genre.translation_missing(:description).should eq [:jp, :ko]
-      end
-    end
-
-  end
-end

data/spec/models.rb

@@ -1,7 +0,0 @@
-class Genre < ActiveRecord::Base
-   translates :name, :description
-end
-
-class Movie < ActiveRecord::Base
-   translates :title, :description
-end

data/spec/schema.rb

@@ -1,18 +0,0 @@
-ActiveRecord::Schema.define do
-  self.verbose = false
-
-  create_table :genres, :force => true do |t|
-    t.text :i18n
-
-    t.string :other
-    t.timestamps
-  end
-
-  create_table :movies, :force => true do |t|
-    t.string :title
-    t.text   :i18n
-
-    t.string :other
-    t.timestamps
-  end
-end

data/spec/spec.opts

@@ -1,2 +0,0 @@
---color
---backtrace