serial_translator 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 597ebe3f2c16e2d5c2253570aa6e2bc3fb2743f4
+  data.tar.gz: 4f54a88c540d09761c79663f7ba20bdca089fad7
+SHA512:
+  metadata.gz: 971fdbcbf302aa42934d7b859c1d42ea5abe848597891979249f298f51fd97e0c07ed434dba5326cfb1874b6ca1001b01b9f7de2714fdaff0b8bd68e51b96733
+  data.tar.gz: aea5ed5d8467ad104d25f0fcc0492724936e15c322dff460f63488bb160d4720f9fb90495461216e36dbbdb2ec1c7a1aa46ccc61b8a561ea0bb1f79ac7b9a5d2

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.ruby-gemset

@@ -0,0 +1 @@
+serial_translator

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0

data/.travis.yml

@@ -0,0 +1,9 @@
+rvm:
+  - 2.0.0
+
+script: "bundle exec rspec"
+
+notifications:
+  disabled: false
+  recipients:
+    - developers@betterplace.org

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in serial_translator.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,13 @@
+            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+                    Version 2, December 2004
+
+ Copyright (C) 2013 betterplace development team <developers@betterplace.org>
+
+ Everyone is permitted to copy and distribute verbatim or modified
+ copies of this license document, and changing it is allowed as long
+ as the name is changed.
+
+            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. You just DO WHAT THE FUCK YOU WANT TO.

data/README.md

@@ -0,0 +1,29 @@
+# SerialTranslator
+
+Translate active record object attributes without the use of additional models.
+
+## Build status
+
+[![Build Status](https://travis-ci.org/betterplace/serial_translator.png)](https://travis-ci.org/betterplace/serial_translator)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'serial_translator'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+To be written.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/serial_translator.rb

@@ -0,0 +1,58 @@
+require 'active_support'
+require 'active_model'
+require 'serial_translator/version'
+require 'serial_translator/serial_translator_validator'
+
+module SerialTranslator
+  extend ActiveSupport::Concern
+
+  included do
+    attr_writer :current_translation_locale, :translation_fallback
+  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
+
+        define_method attribute do |locale = current_translation_locale|
+          translations = translations_for(attribute)
+          result = translations[locale] if translations[locale].present?
+          result ||= translations.values.detect(&:present?) if translation_fallback?
+          result
+        end
+
+        define_method "#{attribute}=" do |value|
+          translations = translations_for(attribute)
+          translations[current_translation_locale] = value
+          __send__(:"#{attribute}_translations=", translations)
+        end
+      end
+    end
+  end
+
+  def current_translation_locale
+    (@current_translation_locale || I18n.locale).to_sym
+  end
+
+  def translation_fallback?
+    @translation_fallback != false
+  end
+
+  def translated_locales
+    result = []
+    self.class.serial_translator_attributes.each do |attribute|
+      translations = translations_for(attribute).select { |_, value| value.present? }
+      result += translations.keys
+    end
+    result.uniq
+  end
+
+  def translations_for(attribute)
+    __send__(:"#{attribute}_translations") || {}
+  end
+end

data/lib/serial_translator/serial_translator_validator.rb

@@ -0,0 +1,48 @@
+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/lib/serial_translator/version.rb

@@ -0,0 +1,3 @@
+module SerialTranslator
+  VERSION = "0.0.1"
+end

data/serial_translator.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'serial_translator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "serial_translator"
+  spec.version       = SerialTranslator::VERSION
+  spec.authors       = ["betterplace development team"]
+  spec.email         = ["developers@betterplace.org"]
+  spec.description   = %q{Translate attribute values without additional models}
+  spec.summary       = %q{Translate attribute values without additional models}
+  spec.homepage      = "http://www.betterplace.org"
+  spec.license       = "WTFPL"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  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_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'simplecov'
+end

data/spec/lib/serial_translator/serial_translator_validator_spec.rb

@@ -0,0 +1,86 @@
+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?
+      example.should have(1).error_on(:description)
+    end
+
+    it 'validates presence correctly if attribute is empty' do
+      example.description = ''
+      example.should have(1).error_on(:description)
+    end
+
+    it 'has no error if everything is fine' do
+      example.description = 'This is a nice foo thing'
+      example.should have(0).errors_on(:description)
+    end
+
+    it 'is valid if any language has a value' do
+      example.description_translations = { en: '', de: '' }
+      example.should have(1).errors_on(:description)
+      example.description_translations = { en: '', de: 'foobar' }
+      example.should have(0).errors_on(:description)
+      example.description_translations = { en: 'foobar', de: nil }
+      example.should have(0).errors_on(:description)
+    end
+  end
+
+  describe 'length validation' do
+    it 'validates min length correctly' do
+      example.title = '123'
+      example.should have(1).error_on(:title)
+    end
+
+    it 'validates max length correctly' do
+      example.title = 'f' * 26
+      example.should have(1).error_on(:title)
+    end
+
+    it 'ignores blank fields' do
+      example.title = ''
+      example.should have(0).errors_on(:title)
+    end
+
+    it 'validates all translation values' do
+      example.title_translations = { en: '123', de: '123' }
+      example.should have(2).errors_on(:title)
+
+      example.title_translations = { en: '123456', de: '123' }
+      example.should have(1).errors_on(:title)
+
+      example.title_translations = { en: '123', de: '123456' }
+      example.should have(1).errors_on(:title)
+
+      example.title_translations = { en: '123456', de: '123456' }
+      example.should have(0).errors_on(:title)
+    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'
+      example.should be_valid
+
+      I18n.locale = :en
+      example.title = ''
+      example.should 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)
+      validator.kind.should eq :length
+    end
+
+    it 'returns presence if it is no length validation' do
+      validator = SerialTranslator::SerialTranslatorValidator.new(attributes: :foo)
+      validator.kind.should eq :presence
+    end
+  end
+end
+

data/spec/lib/serial_translator_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+
+describe SerialTranslator do
+
+  let(:object) { FakeObject.new }
+
+  describe 'getting a translated value' do
+    it 'returns the translated value in the requested locale' do
+      object.title_translations = { de: 'German translation', en: 'English translation' }
+      object.title(:de).should eq 'German translation'
+    end
+
+    it 'returns the origin locale value if no translation is present' do
+      object.title_translations = { en: 'English translation' }
+      object.title(:de).should eq 'English translation'
+    end
+
+    it 'returns the origin locale value if the translation is empty' do
+      object.title_translations = { de: '', en: 'English translation' }
+      object.title(:de).should eq 'English translation'
+    end
+
+    it 'returns nil if no translations are there at all' do
+      object.title_translations = {}
+      object.title(:de).should be_nil
+    end
+
+    it 'uses the given text locale' do
+      object.title_translations = { de: 'Deutsch', en: 'English' }
+      object.current_translation_locale = :en
+      object.title.should eq 'English'
+    end
+
+    it 'does not fail even if translations were not initialized before' do
+      object.title.should be_blank
+    end
+  end
+
+  describe 'writing an attribute' do
+    it 'sets the value for the current text locale' do
+      object.current_translation_locale = :de
+      object.title = 'Deutsch'
+      object.title_translations.should eq({ de: 'Deutsch' })
+    end
+  end
+
+  describe '#current_translation_locale' do
+    it 'returns the value that was given' do
+      object.current_translation_locale = 'de'
+      object.current_translation_locale.should eq :de
+    end
+
+    it 'must not return nil' do
+      object.current_translation_locale = nil
+      object.current_translation_locale.should eq I18n.locale.to_sym
+    end
+  end
+
+  describe '#translated_locales' do
+    it 'returns an empty array if nothing was translated' do
+      object.translated_locales.should eq []
+    end
+
+    it 'includes all locales where something is present' do
+      object.title_translations = { en: 'Foo', de: 'Foo' }
+      object.summary_translations = { nb: 'Foo' }
+      object.translated_locales.should eq [:en, :de, :nb]
+    end
+
+    it 'does not include locales where all translations are blank' do
+      object.title_translations = { en: 'Foo', de: '' }
+      object.translated_locales.should eq [:en]
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+require 'simplecov'
+
+SimpleCov.adapters.define 'gem' do
+  add_filter '/spec/'
+  add_group 'Libraries', '/lib/'
+end
+SimpleCov.start 'gem'
+
+require 'serial_translator'
+require 'active_model'
+require 'active_resource'
+require 'support/validations_matcher'
+require 'support/fake_object'
+
+RSpec.configure do |config|
+  config.color_enabled = true
+end

data/spec/support/fake_object.rb

@@ -0,0 +1,12 @@
+# This class is only used for testing purposes.
+class FakeObject
+  include ActiveModel::Validations
+  def self.serialize(*) ; end
+  def self.before_save(*) ; end
+  attr_accessor :title_translations, :description_translations, :summary_translations
+
+  include SerialTranslator
+  serial_translator_for :title, :description, :summary
+  validates :title,       serial_translator: { length: 5..25 }
+  validates :description, serial_translator: { presence: true }
+end

data/spec/support/validations_matcher.rb

@@ -0,0 +1,11 @@
+# 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

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: serial_translator
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- betterplace development team
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: activeresource
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  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
+    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
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-gemset
+- .ruby-version
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/serial_translator.rb
+- lib/serial_translator/serial_translator_validator.rb
+- lib/serial_translator/version.rb
+- serial_translator.gemspec
+- spec/lib/serial_translator/serial_translator_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
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+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_spec.rb
+- spec/spec_helper.rb
+- spec/support/fake_object.rb
+- spec/support/validations_matcher.rb