serial_translator 1.1.0 → 2.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 978f519c27807266eafae6bca4cb6b5ce25e4873
-  data.tar.gz: 0bc4da881ec6461d987357142d9e196dec5bab4f
+SHA256:
+  metadata.gz: e67a98e574e71655f1d1c1de15b35356db3bd0501e06c464d207591a2d8a4da6
+  data.tar.gz: c2ab2da70fdb53ab500912f5ec061e6a504765735a5a518be73869b0839eb2e4
 SHA512:
-  metadata.gz: f90077f42eb3affea9fb9cd1adbcd672236da372098f555edaf33d34785fdc1f28eec33eafd8ae4c0088603ee2b0a663cf796613d0092110fbb929aa9a190a1f
-  data.tar.gz: 97153aa7d77d5e22522afcbfb4e422ae113c923b99f44f5eac5ad82ea312f1eb137dfedc26067eb16dafa51d413c6bde64997a12310a755620397dd547aa940c
+  metadata.gz: c98bb5a850f094b31691f12165095187db6e5df31cc2a46624df1059136c9b58cd8fa3b9115b34d37f336d3ee06c80f90a5fe1b9067abe036029f65236f19458
+  data.tar.gz: a33d2d1793c60dfc441f4c7ced0397cc09bcddfba6904fedc49d63c2e74034d3adc260c9662eea9905c2f5a9e06ccf085395ef760080f711281a8be2466752d3

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+errors.lst

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.0.0

data/.travis.yml

@@ -1,11 +1,12 @@
-rvm:
-  - 2.3.2
+before_install:
+  - gem update --system
+  - gem update bundler
 
-script: "bundle exec rake"
+rvm:
+  - 2.7
+  - 3.0
 
 notifications:
   disabled: false
   recipients:
     - developers@betterplace.org
-
-sudo: false

data/.utilsrc

@@ -0,0 +1,26 @@
+# vim: set ft=ruby:
+
+search do
+  prune_dirs /\A(\.svn|\.git|CVS|tmp|tags|coverage|pkg)\z/
+  skip_files /(\A\.|\.sw[pon]\z|\.(log|fnm|jpg|jpeg|png|pdf|svg)\z|tags|~\z)/i
+end
+
+discover do
+  prune_dirs /\A(\.svn|\.git|CVS|tmp|tags|coverage|pkg)\z/
+  skip_files /(\A\.|\.sw[pon]\z|\.log\z|~\z)/
+  binary false
+end
+
+strip_spaces do
+  prune_dirs /\A(\..*|CVS|pkg)\z/
+  skip_files /(\A\.|\.sw[pon]\z|\.log\z|~\z)/
+end
+
+probe do
+  test_framework :rspec
+  #include_dirs 'features'
+end
+
+ssh_tunnel do
+  terminal_multiplexer :tmux
+end

data/README.md

@@ -6,6 +6,10 @@
 
 Translate ActiveRecord object attributes without the use of additional models.
 
+## Changes from 1.* to 2.*
+
+`serial_translator` will now store all translations in JSON format per default rather than in YAML. However, it is still able to read YAML serialized translations and will convert them in the background.
+
 ## Installation
 
 Add it to your Gemfile:

data/lib/serial_translator.rb

@@ -1,8 +1,11 @@
 require 'active_support'
 require 'active_model'
+require 'active_record'
 
 require 'serial_translator/serial_translator_length_validator'
 require 'serial_translator/serial_translator_presence_validator'
+require 'serial_translator/translation_type'
+require 'serial_translator/version'
 
 module SerialTranslator
   extend ActiveSupport::Concern
@@ -11,48 +14,54 @@ module SerialTranslator
     attr_writer :current_translation_locale, :translation_fallback
   end
 
+  class InvalidLocaleError < StandardError
+  end
+
   module ClassMethods
     attr_reader :serial_translator_attributes
 
     def serial_translator_for(*attributes)
       @serial_translator_attributes = attributes
 
-      attributes.each do |attribute|
-        serialize :"#{attribute}_translations", Hash
+      attributes.each do |attr_name|
+        attribute :"#{attr_name}_translations", SerialTranslator::TranslationType.new
 
         # Define the normal getter, that respects the
         # current translation locale
-        define_method attribute do |locale = current_translation_locale|
-          translations = translations_for(attribute)
+        define_method attr_name do |locale = current_translation_locale|
+          translations = translations_for(attr_name)
           result = translations[locale] if translations[locale].present?
           result ||= translations.values.detect(&:present?) if translation_fallback?
           result
         end
 
-        define_method :"#{attribute}?" do |locale = current_translation_locale|
-          __send__(attribute.to_sym, locale).present?
+        define_method :"#{attr_name}?" do |locale = current_translation_locale|
+          __send__(attr_name.to_sym, locale).present?
         end
 
         # Define the normal setter, that respects the
         # current translation locale
-        define_method "#{attribute}=" do |value|
-          __send__(:"#{attribute}_translations_will_change!")
-          translations = translations_for(attribute)
+        define_method "#{attr_name}=" do |value|
+          unless I18n.available_locales.include?(current_translation_locale)
+            raise InvalidLocaleError, "current_translation_locale #{current_translation_locale.inspect} is not a member of I18n.available_locales: #{I18n.available_locales.inspect}"
+          end
+          __send__(:"#{attr_name}_translations_will_change!")
+          translations = translations_for(attr_name)
           if value.present?
             translations[current_translation_locale] = value
           else
             translations.delete(current_translation_locale)
           end
-          __send__(:"#{attribute}_translations=", translations)
+          __send__(:"#{attr_name}_translations=", translations)
         end
 
         # Define getters for each specific available locale
         I18n.available_locales.each do |available_locale|
-          define_method "#{attribute}_#{available_locale.to_s.underscore}" do
+          define_method "#{attr_name}_#{available_locale.to_s.underscore}" do
             begin
               old_locale = I18n.locale
               I18n.locale = available_locale
-              __send__(attribute)
+              __send__(attr_name)
             ensure
               I18n.locale = old_locale
             end
@@ -61,11 +70,11 @@ module SerialTranslator
 
         # Define setters for each specific available locale
         I18n.available_locales.each do |available_locale|
-          define_method "#{attribute}_#{available_locale.to_s.underscore}=" do |value|
+          define_method "#{attr_name}_#{available_locale.to_s.underscore}=" do |value|
             begin
               old_locale = I18n.locale
               I18n.locale = available_locale
-              __send__(:"#{attribute}=", value)
+              __send__(:"#{attr_name}=", value)
             ensure
               I18n.locale = old_locale
             end

data/lib/serial_translator/serial_translator_length_validator.rb

@@ -29,7 +29,7 @@ module SerialTranslator
 
         default_message = options[MESSAGES[key]]
         error_options[:message] ||= default_message if default_message
-        record.errors.add(attribute, MESSAGES[key], error_options)
+        record.errors.add(attribute, MESSAGES[key], **error_options)
       end
     end
 

data/lib/serial_translator/serial_translator_presence_validator.rb

@@ -3,9 +3,13 @@ module SerialTranslator
     def validate_each(record, attribute, _value)
       translations = record.__send__("#{attribute}_translations") || {}
       return if translations.values.any?(&:present?)
-      record.errors.add_on_blank(attribute, options)
+      if record.send(attribute).blank?
+        record.errors.add(attribute, :blank, **options)
+      end
     end
 
-    def kind; :presence end
+    def kind
+      :presence
+    end
   end
 end

data/lib/serial_translator/translation_type.rb

@@ -0,0 +1,23 @@
+class SerialTranslator::TranslationType < ActiveRecord::Type::String
+  def cast(value)
+    case value
+    when nil
+      {}
+    when Hash
+      value
+    when /\A---/
+      YAML.load(value)
+    else
+      JSON.parse(value).symbolize_keys
+    end
+  end
+
+  def serialize(value)
+    case value
+    when String
+      super
+    else
+      JSON(value)
+    end
+  end
+end

data/lib/serial_translator/version.rb

@@ -1,3 +1,3 @@
 module SerialTranslator
-  VERSION = "1.1.0"
+  VERSION = "2.0.3"
 end

data/serial_translator.gemspec

@@ -1,4 +1,3 @@
-# coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'serial_translator/version'
@@ -18,11 +17,14 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'activemodel', '>= 4.0.0'
+  spec.add_dependency 'activemodel', '>= 5'
+  spec.add_dependency 'activerecord', '>= 5'
 
-  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'rspec-collection_matchers'
+  spec.add_development_dependency 'json', '~>2'
   spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'sqlite3'
 end

data/spec/lib/serial_translator/serial_translator_length_validator_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe SerialTranslator::SerialTranslatorLengthValidator do
-  let(:example) { FakeObject.new }
+  let(:example) { Fake.new }
 
   describe 'validation' do
     it 'validates min length correctly' do

data/spec/lib/serial_translator/serial_translator_presence_validator_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe SerialTranslator::SerialTranslatorPresenceValidator do
-  let(:example) { FakeObject.new }
+  let(:example) { Fake.new }
 
   describe 'validation' do
     it 'validates presence correctly if attribute is nil' do

data/spec/lib/serial_translator/translation_type_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe SerialTranslator::TranslationType do
+  let(:type) { SerialTranslator::TranslationType.new }
+
+  describe '#cast' do
+    it 'works for JSON' do
+      expect(type.cast('{"foo":"bar"}')).to eq(foo: 'bar')
+    end
+
+    it 'works for YAML' do
+      expect(type.cast("---\nfoo: bar")).to eq('foo' => 'bar')
+    end
+
+    it 'does nothing if already a Hash' do
+      expect(type.cast({foo: :bar})).to eq(foo: :bar)
+    end
+
+    it 'defaults to empty hash' do
+      expect(type.cast(nil)).to eq({})
+    end
+  end
+
+  describe '#serialize' do
+    it 'converts to JSON' do
+      expect(type.serialize({foo: :bar})).to eq('{"foo":"bar"}')
+    end
+
+    it 'leaves strings alone (to avoid double serialization)' do
+      expect(type.serialize('foo')).to eq 'foo'
+    end
+  end
+end

data/spec/lib/serial_translator_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe SerialTranslator do
-  let(:object) { FakeObject.new }
+  let(:object) { Fake.new }
 
   describe 'getting a translated value' do
     it 'returns the translated value in the requested locale' do
@@ -48,6 +48,12 @@ describe SerialTranslator do
       expect(object.title_translations).to eq({ de: 'Deutsch' })
     end
 
+    it 'raises an error if current translation is not an I18n locale' do
+      object.current_translation_locale = :foobar
+      expect { object.title = 'Deutsch' }.to raise_error(SerialTranslator::InvalidLocaleError)
+      expect(object.title_translations).to eq({})
+    end
+
     it 'nil removes the value for the current text locale' do
       object.title_translations = { de: 'Deutsch' }
       object.current_translation_locale = :de
@@ -136,4 +142,18 @@ describe SerialTranslator do
       expect(object).to_not be_translated_into :yml
     end
   end
+
+  context 'use active record methods' do
+    it 'works with where and LIKE' do
+      expect {
+        Fake.where('title_translations LIKE ?', '%foobar').count
+      }.not_to raise_error
+    end
+
+    it 'works with where and Hash syntax' do
+      expect {
+        Fake.where(title_translations: 'foobar').count
+      }.not_to raise_error
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -7,6 +7,6 @@ end
 SimpleCov.start 'gem'
 
 require 'serial_translator'
-require 'active_model'
-require 'support/fake_object'
 require 'rspec/collection_matchers'
+require 'support/fake_env'
+require 'active_record'

data/spec/support/{fake_object.rb → fake_env.rb}

@@ -1,27 +1,25 @@
-# This class is only used for testing purposes.
-class FakeObject
-  include ActiveModel::Validations
-  include SerialTranslator
-
-  def self.serialize(*); end
+ActiveRecord::Base.establish_connection adapter: 'sqlite3', database: ':memory:'
+
+ActiveRecord::Schema.define do
+  self.verbose = false
+
+  create_table :fakes, force: true do |t|
+    t.text :description_translations
+    t.text :title_translations
+    t.text :subtitle_translations
+    t.text :summary_translations
+    t.text :credits_translations
+    t.text :imprint_translations
+  end
+end
 
-  def self.before_save(*); end
+class Fake < ActiveRecord::Base
+  include SerialTranslator
 
   # Has to be set in this context to test it correctly
   I18n.available_locales = [:en, :de, :'en-GB']
 
-  TRANSLATED_ATTRIBUTES = %w(description title subtitle summary credits imprint)
-
-  serial_translator_for(*TRANSLATED_ATTRIBUTES)
-
-  TRANSLATED_ATTRIBUTES.map {|ta| "#{ta}_translations" }.each do |hash_name|
-    attr_accessor hash_name
-    define_method("#{hash_name}_will_change!") { changes << hash_name.to_sym }
-  end
-
-  def changes
-    @changes ||= []
-  end
+  serial_translator_for(*%w(description title subtitle summary credits imprint))
 
   validates :description, serial_translator_presence: true
   validates :title,       serial_translator_length: { within: 5..25 }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: serial_translator
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.3
 platform: ruby
 authors:
 - betterplace development team
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-12-08 00:00:00.000000000 Z
+date: 2021-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -16,28 +16,42 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +122,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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'
 description: Translate attribute values without additional models
 email:
 - developers@betterplace.org
@@ -103,7 +145,9 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".tool-versions"
 - ".travis.yml"
+- ".utilsrc"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -111,18 +155,20 @@ files:
 - lib/serial_translator.rb
 - lib/serial_translator/serial_translator_length_validator.rb
 - lib/serial_translator/serial_translator_presence_validator.rb
+- lib/serial_translator/translation_type.rb
 - lib/serial_translator/version.rb
 - serial_translator.gemspec
 - spec/lib/serial_translator/serial_translator_length_validator_spec.rb
 - spec/lib/serial_translator/serial_translator_presence_validator_spec.rb
+- spec/lib/serial_translator/translation_type_spec.rb
 - spec/lib/serial_translator_spec.rb
 - spec/spec_helper.rb
-- spec/support/fake_object.rb
+- spec/support/fake_env.rb
 homepage: http://www.betterplace.org
 licenses:
 - WTFPL
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -137,14 +183,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.8
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Translate attribute values without additional models
 test_files:
 - spec/lib/serial_translator/serial_translator_length_validator_spec.rb
 - spec/lib/serial_translator/serial_translator_presence_validator_spec.rb
+- spec/lib/serial_translator/translation_type_spec.rb
 - spec/lib/serial_translator_spec.rb
 - spec/spec_helper.rb
-- spec/support/fake_object.rb
+- spec/support/fake_env.rb