serial_translator 0.0.9 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9e4f4ceb0a81d11f416db203565703539668e9a2
-  data.tar.gz: 51c01f7015a9492680270e25efadefb0689ea12f
+  metadata.gz: ddceed208a6817aa8b7484c890d2340ec50ba391
+  data.tar.gz: f68db01cd4a2e5c0c4a9fadaae0990830a3d6c52
 SHA512:
-  metadata.gz: 939aeec909cd13e19d67f2b50a88520370e2802a0812b3eb040e7196ebfcc44ca6e8f7df9bb51935c6d73509f8c4f4188eb05f996a5c27e15cf4f2e1261079bc
-  data.tar.gz: 88a8921c319fb5daa24e6ec4dea64a235dc42dd8eba1b3ef5291222656884f5e3eead03f298b3b8edbf0e44ebe594852c1fd9e77f21e895af84eacae59c4d56f
+  metadata.gz: a7412fbf5664d5808690344dd63c58de0633490738e74a2f52cf83a578fc889ce73aa3fb00c15868f10fdccb86feac7f3272998d65ed8e2e56e1476de7b54e4a
+  data.tar.gz: ccae43bae3f7da4aad8daf684bb2639a5a2fb463201ba17fe9e37e432f15258c711c4667484712573206814a44ee88b5bd2359024d9b7f83846170a0963522ec

data/.travis.yml

@@ -1,8 +1,5 @@
 rvm:
-  - 2.0.0
-  - 2.1
-  - 2.2
-  - 2.3.0
+  - 2.3.2
 
 script: "bundle exec rake"
 

data/README.md

@@ -1,24 +1,70 @@
 # SerialTranslator
 
-Translate active record object attributes without the use of additional models.
+[![Gem Version](https://badge.fury.io/rb/serial_translator.svg)](http://badge.fury.io/rb/serial_translator)
+[![Build Status](https://travis-ci.org/betterplace/serial_translator.svg)](https://travis-ci.org/betterplace/serial_translator)
+[![Dependency Status](https://gemnasium.com/betterplace/serial_translator.svg)](https://gemnasium.com/betterplace/serial_translator)
 
-## Build status
-
-[![Build Status](https://travis-ci.org/betterplace/serial_translator.png)](https://travis-ci.org/betterplace/serial_translator)
+Translate ActiveRecord object attributes without the use of additional models.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add it to your Gemfile:
 
     gem 'serial_translator'
 
-And then execute:
+## Usage
+
+Add a `*_translations` column to your table, e.g. `title_translations`.
+
+```ruby
+class AddTitleTranslationsToBlogPosts < ActiveRecord::Migration
+  def change
+    add_column :blog_posts, :title_translations, :text
+  end
+end
+```
+
+In your model, call `#serial_translator_for`.
+
+```ruby
+class BlogPost < ActiveRecord::Base
+  serial_translator_for :title
+  # [...]
+end
+```
+
+Now you can read and write `title_translations` or `title_#{locale}` or `title(locale)`.
+
+```ruby
+blog_post = BlogPost.new
+blog_post.title_translations = { de: 'Hallo Welt', en: 'Hello world' }
+blog_post.title_en # => "Hello world"
+blog_post.title(:en) # => "Hello world"
+blog_post.translated_locales # => [:de, :en]
+```
+
+Setting or getting the field name without specifying a locale defaults to the current locale.
+
+```ruby
+I18n.locale = :de
+blog_post.title # => "Hallo Welt"
+blog_post.title = 'Hey'
+blog_post.title_translations # => { de: 'Hey', en: 'Hello world' }
+```
+
+So if you add a `title` field to a BlogPost form it will work on the title in the user’s locale by default. You can override this by setting the record’s `#current_translation_locale`.
+
+Add length or presence validations if you want. They will use the same localization keys for error messages as the standard length and presence validations.
+
+```ruby
+class BlogPost < ActiveRecord::Base
+  validates :title, serial_translator_presence: true
+  validates :text,  serial_translator_length: { minimum: 100 }
+end
+```
 
-    $ bundle
 
-## Usage
 
-To be written.
 
 ## Contributing
 

data/lib/serial_translator.rb

@@ -1,7 +1,6 @@
 require 'active_support'
 require 'active_model'
-require 'serial_translator/version'
-require 'serial_translator/serial_translator_validator'
+Dir[File.join(__dir__, '**', '*.rb')].each { |file| require file }
 
 module SerialTranslator
   extend ActiveSupport::Concern

data/lib/serial_translator/serial_translator_length_validator.rb

@@ -0,0 +1,36 @@
+class SerialTranslator::SerialTranslatorLengthValidator < ActiveModel::Validations::LengthValidator
+  def validate_each(record, attribute, _value)
+    translations = record.__send__("#{attribute}_translations")&.values || []
+    translations = [nil] if translations.empty?
+    translations.each do |value|
+      next if options[:allow_blank] && value.to_s == '' ||
+              options[:allow_nil]   && value.nil?
+      validate_translation(record, attribute, value)
+    end
+  end
+
+  # this is ActiveModel::Validations::LengthValidator#validate_each,
+  # only extended with more interpolation args in error_options
+  def validate_translation(record, attribute, value)
+    value_length = value.respond_to?(:length) ? value.length : value.to_s.length
+    error_options = options.except(*RESERVED_OPTIONS)
+
+    CHECKS.each do |key, validity_check|
+      next unless check_value = options[key]
+
+      if !value.nil? || skip_nil_check?(key)
+        next if value_length.send(validity_check, check_value)
+      end
+
+      error_options.merge!(count: check_value, actual_length: value_length)
+      key == :minimum && error_options[:difference] = check_value - value_length
+      key == :maximum && error_options[:difference] = value_length - check_value
+
+      default_message = options[MESSAGES[key]]
+      error_options[:message] ||= default_message if default_message
+      record.errors.add(attribute, MESSAGES[key], error_options)
+    end
+  end
+
+  def kind; :length end
+end

data/lib/serial_translator/serial_translator_presence_validator.rb

@@ -0,0 +1,9 @@
+class SerialTranslator::SerialTranslatorPresenceValidator < ActiveModel::Validations::PresenceValidator
+  def validate_each(record, attribute, _value)
+    translations = record.__send__("#{attribute}_translations") || {}
+    return if translations.values.any?(&:present?)
+    record.errors.add_on_blank(attribute, options)
+  end
+
+  def kind; :presence end
+end

data/lib/serial_translator/version.rb

@@ -1,3 +1,3 @@
 module SerialTranslator
-  VERSION = "0.0.9"
+  VERSION = "1.0.0"
 end

data/serial_translator.gemspec

@@ -18,11 +18,12 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'activemodel', '>= 3.0.0'
-  spec.add_dependency 'activeresource', '>= 3.0.0'
+  spec.add_dependency 'activemodel', '>= 4.0.0'
+  spec.add_dependency 'activeresource', '>= 4.0.0'
 
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rspec-collection_matchers'
   spec.add_development_dependency 'simplecov'
 end

data/spec/lib/serial_translator/serial_translator_length_validator_spec.rb

@@ -0,0 +1,99 @@
+require 'spec_helper'
+
+describe SerialTranslator::SerialTranslatorLengthValidator do
+  let(:example) { FakeObject.new }
+
+  describe 'validation' do
+    it 'validates min length correctly' do
+      example.title = '123'
+      expect(example).to have(1).error_on(:title)
+    end
+
+    it 'validates max length correctly' do
+      example.title = 'f' * 26
+      expect(example).to have(1).error_on(:title)
+    end
+
+    it 'validates correctly if only a minimum is given' do
+      example.credits = 'f' * 99
+      expect(example).to have(1).error_on(:credits)
+      example.credits = 'f' * 100
+      expect(example).to have(:no).errors_on(:credits)
+    end
+
+    it 'validates correctly if only a maximum is given' do
+      example.imprint = 'f' * 101
+      expect(example).to have(1).error_on(:imprint)
+      example.imprint = 'f' * 100
+      expect(example).to have(:no).errors_on(:imprint)
+    end
+
+    it 'validates correctly if a specific value is given' do
+      example.subtitle = 'f' * 8
+      expect(example).to have(1).error_on(:subtitle)
+      example.subtitle = 'f' * 9
+      expect(example).to have(:no).errors_on(:subtitle)
+      example.subtitle = 'f' * 10
+      expect(example).to have(1).error_on(:subtitle)
+    end
+
+    it 'validates all translation values' do
+      example.title_translations = { en: '123', de: '123' }
+      expect(example).to have(2).errors_on(:title)
+
+      example.title_translations = { en: '123456', de: '123' }
+      expect(example).to have(1).error_on(:title)
+
+      example.title_translations = { en: '123', de: '123456' }
+      expect(example).to have(1).error_on(:title)
+
+      example.title_translations = { en: '123456', de: '123456' }
+      expect(example).to have(:no).errors_on(:title)
+    end
+
+    it 'validates correctly on language change as well' do
+      I18n.locale = :de
+      example.title = 'Valid foo'
+      expect(example).to have(:no).errors_on(:title)
+
+      I18n.locale = :en
+      example.title = ''
+      expect(example).to have(:no).errors_on(:title)
+    end
+
+    it 'ignores blank fields if allow_blank is true' do
+      example.summary_translations = { de: '' }
+      expect(example).to have(:no).errors_on(:summary)
+    end
+
+    it 'ignores blank fields if only a maximum is given' do
+      example.credits_translations = { de: '' }
+      expect(example).to have(:no).errors_on(:imprint)
+    end
+
+    it 'does not ignore blank fields otherwise' do
+      example.title_translations = { de: '' }
+      expect(example).to have(1).error_on(:title)
+    end
+
+    it 'ignores nil if allow_nil is true' do
+      example.subtitle_translations = { de: nil }
+      expect(example).to have(:no).errors_on(:subtitle)
+    end
+
+    it 'ignores nil if only a maximum is given' do
+      example.credits_translations = { de: nil }
+      expect(example).to have(:no).errors_on(:imprint)
+    end
+
+    it 'does not ignore nil otherwise' do
+      example.title_translations = { de: nil }
+      expect(example).to have(1).error_on(:title)
+    end
+  end
+
+  it 'is of kind "length"' do
+    expect(described_class.new(attributes: %i(foo), in: 1..2).kind)
+      .to eq :length
+  end
+end

data/spec/lib/serial_translator/serial_translator_presence_validator_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe SerialTranslator::SerialTranslatorPresenceValidator do
+  let(:example) { FakeObject.new }
+
+  describe 'validation' do
+    it 'validates presence correctly if attribute is nil' do
+      example.description = nil
+      expect(example).to have(1).error_on(:description)
+    end
+
+    it 'validates presence correctly if attribute is empty' do
+      example.description = ''
+      expect(example).to have(1).error_on(:description)
+    end
+
+    it 'has no error if everything is fine' do
+      example.description = 'This is a nice foo thing'
+      expect(example).to have(:no).errors_on(:description)
+    end
+
+    it 'is valid if any language has a value' do
+      example.description_translations = { en: '', de: '' }
+      expect(example).to have(1).error_on(:description)
+
+      example.description_translations = { en: '', de: 'foobar' }
+      expect(example).to have(:no).errors_on(:description)
+
+      example.description_translations = { en: 'foobar', de: nil }
+      expect(example).to have(:no).errors_on(:description)
+    end
+  end
+
+  it 'is of kind "presence"' do
+    expect(described_class.new(attributes: %i(foo)).kind)
+      .to eq :presence
+  end
+end

data/spec/lib/serial_translator_spec.rb

@@ -1,7 +1,6 @@
 require 'spec_helper'
 
 describe SerialTranslator do
-
   let(:object) { FakeObject.new }
 
   describe 'getting a translated value' do
@@ -84,12 +83,12 @@ describe SerialTranslator do
   describe 'writing an attribute with for a specific locale' do
     it 'sets the value for the correct locale' do
       object.title_de = 'Deutsch'
-      expect(object.title_translations).to eq({ de: 'Deutsch' })
+      expect(object.title_translations).to eq(de: 'Deutsch')
     end
 
     it 'works for complex locales as well' do
       object.title_en_gb = 'Arrr'
-      expect(object.title_translations).to eq({ :'en-GB' => 'Arrr' })
+      expect(object.title_translations).to eq('en-GB': 'Arrr')
     end
   end
 

data/spec/spec_helper.rb

@@ -1,6 +1,6 @@
 require 'simplecov'
 
-SimpleCov.adapters.define 'gem' do
+SimpleCov.profiles.define 'gem' do
   add_filter '/spec/'
   add_group 'Libraries', '/lib/'
 end
@@ -9,5 +9,5 @@ SimpleCov.start 'gem'
 require 'serial_translator'
 require 'active_model'
 require 'active_resource'
-require 'support/validations_matcher'
 require 'support/fake_object'
+require 'rspec/collection_matchers'

data/spec/support/fake_object.rb

@@ -1,37 +1,32 @@
 # This class is only used for testing purposes.
 class FakeObject
   include ActiveModel::Validations
+  include SerialTranslator
 
-  def self.serialize(*) ; end
-  def self.before_save(*) ; end
+  def self.serialize(*); end
 
-  attr_accessor :title_translations, :description_translations, :summary_translations
+  def self.before_save(*); end
 
   # Has to be set in this context to test it correctly
   I18n.available_locales = [:en, :de, :'en-GB']
 
-  def changes
-    @changes ||= []
-  end
-
-  def mark_change(attribute)
-    changes << attribute
-  end
+  TRANSLATED_ATTRIBUTES = %w(description title subtitle summary credits imprint)
 
-  def description_translations_will_change!
-    mark_change :description_translations
-  end
+  serial_translator_for(*TRANSLATED_ATTRIBUTES)
 
-  def title_translations_will_change!
-    mark_change :title_translations
+  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 summary_translations_will_change!
-    mark_change :summary_translations
+  def changes
+    @changes ||= []
   end
 
-  include SerialTranslator
-  serial_translator_for :title, :description, :summary
-  validates :title,       serial_translator: { length: 5..25 }
-  validates :description, serial_translator: { presence: true }
+  validates :description, serial_translator_presence: true
+  validates :title,       serial_translator_length: { within: 5..25 }
+  validates :subtitle,    serial_translator_length: { is: 9,     allow_nil:   true }
+  validates :summary,     serial_translator_length: { in: 5..25, allow_blank: true }
+  validates :credits,     serial_translator_length: { minimum: 100 }
+  validates :imprint,     serial_translator_length: { maximum: 100 }
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: serial_translator
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 1.0.0
 platform: ruby
 authors:
 - betterplace development team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-26 00:00:00.000000000 Z
+date: 2016-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 4.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 4.0.0
 - !ruby/object:Gem::Dependency
   name: activeresource
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 4.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 4.0.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-collection_matchers
+  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: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -109,14 +123,15 @@ files:
 - README.md
 - Rakefile
 - lib/serial_translator.rb
-- lib/serial_translator/serial_translator_validator.rb
+- lib/serial_translator/serial_translator_length_validator.rb
+- lib/serial_translator/serial_translator_presence_validator.rb
 - lib/serial_translator/version.rb
 - serial_translator.gemspec
-- spec/lib/serial_translator/serial_translator_validator_spec.rb
+- spec/lib/serial_translator/serial_translator_length_validator_spec.rb
+- spec/lib/serial_translator/serial_translator_presence_validator_spec.rb
 - spec/lib/serial_translator_spec.rb
 - spec/spec_helper.rb
 - spec/support/fake_object.rb
-- spec/support/validations_matcher.rb
 homepage: http://www.betterplace.org
 licenses:
 - WTFPL
@@ -137,13 +152,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Translate attribute values without additional models
 test_files:
-- spec/lib/serial_translator/serial_translator_validator_spec.rb
+- spec/lib/serial_translator/serial_translator_length_validator_spec.rb
+- spec/lib/serial_translator/serial_translator_presence_validator_spec.rb
 - spec/lib/serial_translator_spec.rb
 - spec/spec_helper.rb
 - spec/support/fake_object.rb
-- spec/support/validations_matcher.rb

data/lib/serial_translator/serial_translator_validator.rb

@@ -1,48 +0,0 @@
-class SerialTranslator::SerialTranslatorValidator < ActiveModel::EachValidator
-
-  # SimpleForm inspects validators to find out how long
-  # a field may be.
-  def kind
-    options[:length].present? ? :length : :presence
-  end
-
-  # SimpleForm expects the options :maximum and :minimum to be present
-  # for length validations. This is why we inspect our range and set them
-  # if possible.
-  def initialize(options)
-    if length = options[:length]
-      length.is_a?(Range) or raise "Only range values are allowed for length"
-      options[:maximum] = length.max
-      options[:minimum] = length.min
-    end
-    super options
-  end
-
-  def validate_each(record, attribute, value)
-    options[:presence] and validate_presence(record, attribute)
-    options[:length]   and validate_translation_lengths(record, attribute)
-  end
-
-  def validate_presence(record, attribute)
-    translations = record.__send__(:"#{attribute}_translations") || {}
-    translations.values.any?(&:present?) or record.errors.add_on_blank(attribute, options)
-  end
-
-  def validate_translation_lengths(record, attribute)
-    translations = record.__send__(:"#{attribute}_translations") || {}
-
-    translations.each do |locale, value|
-      validate_length(record, attribute, value)
-    end
-  end
-
-  def validate_length(record, attribute, value)
-    return if value.blank?
-    length = options[:length]
-
-    value_length = value.respond_to?(:length) ? value.length : value.to_s.length
-
-    value_length < length.min and record.errors.add(attribute, :too_short, count: length.min)
-    value_length > length.max and record.errors.add(attribute, :too_long, count: length.max)
-  end
-end

data/spec/lib/serial_translator/serial_translator_validator_spec.rb

@@ -1,100 +0,0 @@
-require 'spec_helper'
-
-describe SerialTranslator::SerialTranslatorValidator do
-  let(:example) { FakeObject.new }
-
-  describe 'presence validation' do
-    it 'validates presence correctly if attribute is nil' do
-      example.valid?
-      expect(example.errors[:description].size).to eq 1
-    end
-
-    it 'validates presence correctly if attribute is empty' do
-      example.description = ''
-      example.valid?
-      expect(example.errors[:description].size).to eq 1
-    end
-
-    it 'has no error if everything is fine' do
-      example.description = 'This is a nice foo thing'
-      example.valid?
-      expect(example.errors[:description].size).to eq 0
-    end
-
-    it 'is valid if any language has a value' do
-      example.description_translations = { en: '', de: '' }
-      example.valid?
-      expect(example.errors[:description].size).to eq 1
-
-      example.description_translations = { en: '', de: 'foobar' }
-      example.valid?
-      expect(example.errors[:description].size).to eq 0
-
-      example.description_translations = { en: 'foobar', de: nil }
-      example.valid?
-      expect(example.errors[:description].size).to eq 0
-    end
-  end
-
-  describe 'length validation' do
-    it 'validates min length correctly' do
-      example.title = '123'
-      example.valid?
-      expect(example.errors[:title].size).to eq 1
-    end
-
-    it 'validates max length correctly' do
-      example.title = 'f' * 26
-      example.valid?
-      expect(example.errors[:title].size).to eq 1
-    end
-
-    it 'ignores blank fields' do
-      example.title = ''
-      example.valid?
-      expect(example.errors[:title].size).to eq 0
-    end
-
-    it 'validates all translation values' do
-      example.title_translations = { en: '123', de: '123' }
-      example.valid?
-      expect(example.errors[:title].size).to eq 2
-
-      example.title_translations = { en: '123456', de: '123' }
-      example.valid?
-      expect(example.errors[:title].size).to eq 1
-
-      example.title_translations = { en: '123', de: '123456' }
-      example.valid?
-      expect(example.errors[:title].size).to eq 1
-
-      example.title_translations = { en: '123456', de: '123456' }
-      example.valid?
-      expect(example.errors[:title].size).to eq 0
-    end
-
-    it 'validates correctly on language change as well' do
-      I18n.locale = :de
-      example.description = :something_to_make_it_pass_valid
-      example.title = 'Valid foo'
-      expect(example).to be_valid
-
-      I18n.locale = :en
-      example.title = ''
-      expect(example).to be_valid
-    end
-  end
-
-  describe '#kind' do
-    it 'returns length if length validation is set' do
-      validator = SerialTranslator::SerialTranslatorValidator.new(attributes: :foo, length: 1..2)
-      expect(validator.kind).to eq :length
-    end
-
-    it 'returns presence if it is no length validation' do
-      validator = SerialTranslator::SerialTranslatorValidator.new(attributes: :foo)
-      expect(validator.kind).to eq :presence
-    end
-  end
-end
-

data/spec/support/validations_matcher.rb

@@ -1,11 +0,0 @@
-# Monkey patch errors_on matcher
-module ::ActiveModel::Validations
-  def errors_on(attribute, options = {})
-    valid_args = [options[:context]].compact
-    self.valid?(*valid_args)
-
-    [self.errors[attribute]].flatten.compact
-  end
-
-  alias :error_on :errors_on
-end