serial_translator 1.1.3 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7c55960014980f7c9b652a0ce5d334db9de1852b
-  data.tar.gz: 7e0266c4063b9fd242da9e4f5b479998b36d83b3
+  metadata.gz: 62f5df8cb8d27b7661c49e1b23e15b2b87c6d66d
+  data.tar.gz: f5d879126f11013dba1f1a2832116a2a593d913e
 SHA512:
-  metadata.gz: ee08e6b646d4e37b9598b15dc97dc4465c6ce7f6d72ce06da808ef6280a37069a74b1218b67631edca48fb318c1bc60cd730ebdedab9a842033779c5fafc5c38
-  data.tar.gz: a4dc41421eda27887a2e4450b6add0d68d4dfe667deadf263e1045e311531d684763f727988fc152f50414dc5e70e91425531ef3d5655a8edcb72cae40819a24
+  metadata.gz: a6d142dde2b763be22b547c5eb765dc7f5214a977a9416940516763d955c45aa7abf6a834b8781fbe941bb71391522b622ba6bd47398edf7eaf11bc4549ec5ca
+  data.tar.gz: 6c0c04b1764fcfa8b9f5161169001429ad877310741abf40c057a42e8eb975961eca9026131ca202cf8a8b57d85f60f473e200b13bfaae879180e62fabf21c78

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
@@ -17,42 +20,42 @@ module SerialTranslator
     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|
+          __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 +64,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/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)
+    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.3"
+  VERSION = "2.0.0"
 end

data/serial_translator.gemspec

@@ -18,7 +18,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'activemodel', '>= 4'
+  spec.add_dependency 'activemodel', '>= 5'
+  spec.add_dependency 'activerecord', '>= 5'
 
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rake'
@@ -26,4 +27,5 @@ Gem::Specification.new do |spec|
   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
@@ -136,4 +136,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.3
+  version: 2.0.0
 platform: ruby
 authors:
 - betterplace development team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-11 00:00:00.000000000 Z
+date: 2017-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -16,14 +16,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4'
+        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
@@ -108,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
@@ -126,13 +154,15 @@ 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
@@ -160,6 +190,7 @@ 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