hstore_translations 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f8d5248b78e634c9887040589d24b67f7868c314
+  data.tar.gz: d3e96e929ab59b2eca0372015f35a5b3cd7ffa45
+SHA512:
+  metadata.gz: 94da578c51984fc472806d573bf4733db73bfadfaf99e071dc8b10c7f35ada57ee9fb645021a719ea2317bad691631c6a1873a18db23a5424dd5043bec830142
+  data.tar.gz: 79d325668efadb4b8c4373d19627a2eb9d4b6a03f778ab19f886028d77d3b4aeb85e67ced5a023aea8522e4ec1824f261092aa8934e5f8d22eaf2a67ef0f460c

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Aleksey Demidov
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,27 @@
+# HstoreTranslations
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'hstore_translations'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hstore_translations
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/hstore_translations.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hstore_translations/version'
+
+Gem::Specification.new do |s|
+  s.name          = "hstore_translations"
+  s.version       = HstoreTranslations::VERSION
+  s.authors       = ["Aleksey Demidov"]
+  s.email         = ["aleksey.dem@gmail.com"]
+  s.summary       = 'Translations for Rails 4 model columns, stored in hstore'
+  s.homepage      = ""
+  s.license       = "MIT"
+
+  s.files         = `git ls-files`.split($/)
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ["lib"]
+
+  s.add_dependency "activerecord", "4.0.0.rc1"
+
+  s.add_development_dependency "bundler", "~> 1.3"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "pg"
+end

data/lib/hstore_translations.rb

@@ -0,0 +1,22 @@
+require 'hstore_translations/version'
+require 'hstore_translations/macro'
+require 'hstore_translations/access_methods'
+require 'hstore_translations/translations_lookup'
+
+module HstoreTranslations
+  class << self
+    delegate :locale, :default_locale, :available_locales, to: :I18n
+
+    def fallbacks(for_locale = locale)
+      I18n.respond_to?(:fallbacks) ? I18n.fallbacks[for_locale] : default_fallbacks(for_locale)
+    end
+
+    private
+
+    def default_fallbacks(for_locale)
+      [for_locale.to_sym, default_locale].uniq
+    end
+  end
+end
+
+ActiveRecord::Base.send :extend, HstoreTranslations::Macro

data/lib/hstore_translations/access_methods.rb

@@ -0,0 +1,31 @@
+module HstoreTranslations
+  module AccessMethods
+    extend ActiveSupport::Concern
+
+    def read_translated_attribute(name, locale)
+      read_store_attribute("#{name}_translations", locale)
+    end
+
+    def write_translated_attribute(name, locale, value)
+      write_store_attribute("#{name}_translations", locale, value)
+    end
+
+    module ClassMethods
+      def with_translated(name, value, locales = HstoreTranslations.fallbacks)
+        hstore_query_parts = Array(locales).map do |locale|
+          "#{table_name}.#{name}_translations @> '#{locale}=>#{value}'"
+        end
+        where(hstore_query_parts.join(' OR '))
+      end
+
+      def order_by_translated(arg, locale = HstoreTranslations.locale)
+        name, mode = if arg.is_a?(Hash)
+          [arg.keys.first, arg.values.first]
+        else
+          [arg, :asc]
+        end
+        order("#{table_name}.#{name}_translations->'#{locale}' #{mode}")
+      end
+    end
+  end
+end

data/lib/hstore_translations/macro.rb

@@ -0,0 +1,58 @@
+module HstoreTranslations
+  module Macro
+
+    def translates(*attributes)
+      setup_hstore_translations
+      self.translatable_attributes |= attributes.map(&:to_sym)
+
+      attributes.each do |attribute|
+        define_translations_reader(attribute)
+        define_translations_writer(attribute)
+
+        HstoreTranslations.available_locales.each do |locale|
+          define_translations_reader(attribute, locale)
+          define_translations_writer(attribute, locale)
+        end
+      end
+    end
+
+    private
+
+    def setup_hstore_translations
+      return if respond_to?(:translatable_attributes)
+
+      class_attribute :translatable_attributes
+      class_attribute :translations_methods
+
+      self.translatable_attributes = []
+      self.translations_methods = Module.new
+      translations_methods.define_singleton_method :inspect do
+        "HstoreTranslations::TranslationsMethods"
+      end
+
+      include translations_methods
+      include AccessMethods
+    end
+
+    def define_translations_reader(attribute, locale = nil)
+      name = locale ? "#{attribute}_#{locale}" : attribute
+      translations_methods.module_eval do
+        define_method(name) do
+          @translations_readers ||= {}
+          @translations_readers[name] ||= TranslationsLookup.new(self, attribute, locale)
+          @translations_readers[name].value
+        end
+      end
+    end
+
+    def define_translations_writer(attribute, locale = nil)
+      name = locale ? "#{attribute}_#{locale}=" : "#{attribute}="
+      translations_methods.module_eval do
+        define_method(name) do |value|
+          write_locale = locale || HstoreTranslations.locale
+          write_translated_attribute(attribute, write_locale, value)
+        end
+      end
+    end
+  end
+end

data/lib/hstore_translations/translations_lookup.rb

@@ -0,0 +1,28 @@
+module HstoreTranslations
+  class TranslationsLookup
+    attr_reader :model, :attribute
+
+    def initialize(model, attribute, locale = nil)
+      @model, @attribute, @locale = model, attribute, locale
+      @locale = locale || HstoreTranslations.locale
+    end
+
+    def value
+      fallbacks.each do |locale|
+        value = try_locale(locale)
+        return value if value.present?
+      end
+      nil
+    end
+
+    private
+
+    def fallbacks
+      HstoreTranslations.fallbacks(@locale)
+    end
+
+    def try_locale(locale)
+      model.read_translated_attribute(attribute, locale)
+    end
+  end
+end

data/lib/hstore_translations/version.rb

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

data/spec/hstore_translations/access_methods_spec.rb

@@ -0,0 +1,85 @@
+# coding: utf-8
+require 'spec_helper'
+
+describe HstoreTranslations::AccessMethods do
+  before { Post.send :include, HstoreTranslations::AccessMethods }
+  let(:post) { Post.new }
+
+  before do
+    configure_i18n locale: :ru,
+                   default_locale: :en,
+                   available_locales: [:ru, :en, :es]
+    Post.translates :title
+  end
+
+  describe '#write_translated_attribute' do
+    it 'writes value to hstore' do
+      post.write_translated_attribute(:title, :en, 'hello')
+      post.save!
+      post.reload.title_translations.should eq 'en' => 'hello'
+    end
+  end
+
+  describe '#read_translated_attribute' do
+    it 'reads value from hstore' do
+      post.title_translations = { :en => 'hello' }
+      post.save!
+      post.reload.read_translated_attribute(:title, :en).should eq 'hello'
+    end
+  end
+
+  describe '.with_translated' do
+    let!(:post_1) { Post.create!(title_ru: 'hello') }
+    let!(:post_2) { Post.create!(title_en: 'hello') }
+    let!(:post_3) { Post.create!(title_es: 'hello') }
+    let!(:post_4) { Post.create!(title_ru: 'привет') }
+
+    subject { Post.with_translated(:title, 'hello') }
+
+    context 'without locales given' do
+      it 'includes records with translated attribute from current locale' do
+        should include(post_1)
+      end
+      it 'includes records with translated attribute from default locale' do
+        should include(post_2)
+      end
+      it 'does not include records with another locales' do
+        should_not include(post_3)
+      end
+      it 'does not include records with another value' do
+        should_not include(post_4)
+      end
+    end
+    context 'with locale' do
+      subject { Post.with_translated(:title, 'hello', :ru) }
+
+      it 'includes matches from that locale' do
+        should include(post_1)
+      end
+      it 'does not include matches from another locales' do
+        should_not include(post_2, post_3, post_4)
+      end
+    end
+  end
+
+  describe '.order_by_translated' do
+    let!(:post_1) { Post.create!(title_ru: 'a', title_en: 'c') }
+    let!(:post_2) { Post.create!(title_ru: 'b', title_en: 'b') }
+    let!(:post_3) { Post.create!(title_ru: 'c', title_en: 'a') }
+
+    def ordered(*a)
+      Post.order_by_translated(*a).select { |p| [post_1, post_2, post_3].include?(p) }
+    end
+
+    it 'accepts hash' do
+      ordered(title: :desc).should eq [post_3, post_2, post_1]
+    end
+    it 'accepts symbol' do
+      ordered(:title).should eq [post_1, post_2, post_3]
+    end
+    it 'accepts locale' do
+      ordered(:title, :en).should eq [post_3, post_2, post_1]
+    end
+  end
+end
+

data/spec/hstore_translations/macro_spec.rb

@@ -0,0 +1,103 @@
+# coding: utf-8
+require 'spec_helper'
+
+describe HstoreTranslations::Macro, '.translates' do
+  before do
+    Post.new.should_not respond_to :title, :body
+  end
+
+  it 'is available' do
+    Post.should respond_to :translates
+  end
+  it 'adds getters' do
+    Post.translates :title
+    Post.new.should respond_to :title
+  end
+  it 'adds setters' do
+    Post.translates :title
+    Post.new.should respond_to :title=
+  end
+  it 'adds locale-accessors' do
+    methods = [:title_en, :title_ru, :title_en=, :title_ru=]
+    Post.new.should_not respond_to *methods
+    Post.translates :title
+    Post.new.should respond_to *methods
+  end
+  it 'can be called multiple times' do
+    Post.translates :title
+    Post.new.should respond_to :title
+    Post.new.should_not respond_to :body
+
+    Post.translates :title, :body
+    Post.new.should respond_to :title, :body
+  end
+  it 'can be called with multiple attributes' do
+    Post.translates :title, :body
+    Post.new.should respond_to :title, :body
+  end
+  it 'adds attributes to list' do
+    Post.translates :title
+    Post.translatable_attributes.should eq [:title]
+    Post.translates :body
+    Post.translatable_attributes.should eq [:title, :body]
+  end
+end
+
+describe HstoreTranslations::Macro, 'generated accessors' do
+  before { Post.translates :title }
+
+  describe '#title=' do
+    let(:post) { Post.new }
+    before do
+      I18n.locale = :en
+      post.title = 'hello'
+    end
+
+    it 'assigns new value to current locale' do
+      post.title.should eq 'hello'
+      post.title_en.should eq 'hello'
+    end
+    it 'does not touch other locales' do
+      post.title_ru.should be_nil
+    end
+  end
+
+  describe '#title' do
+    let(:post) { Post.new(title_en: 'hello', title_ru: 'привет', title_es: 'hola') }
+
+    before do
+      I18n.locale = :en
+      I18n.default_locale = :ru
+    end
+
+    it 'is a title in current locale' do
+      post.title.should eq 'hello'
+    end
+
+    it 'returns nil when there is no translations' do
+      Post.new.title.should be_nil
+    end
+
+    context 'when title from current locale is empty' do
+      before { post.title_en = nil }
+
+      context 'and i18n fallbacks not enabled' do
+        it 'tries to load defaut locale' do
+          post.title.should eq 'привет'
+        end
+      end
+      context 'and i18n fallbacks enabled' do
+        before do
+          configure_i18n fallbacks: { en: [:es, :ru] }
+        end
+        after { I18n.fallbacks = false }
+
+        it 'looks for translation in fallback chain' do
+          post.title.should eq 'hola'
+          post.title_es = nil
+          post.title.should eq 'привет'
+        end
+      end
+    end
+  end
+end

data/spec/hstore_translations_spec.rb

@@ -0,0 +1,2 @@
+require 'spec_helper'
+

data/spec/spec_helper.rb

@@ -0,0 +1,33 @@
+require 'active_record'
+require 'hstore_translations'
+require 'i18n/backend/fallbacks'
+
+db_config = YAML.load_file(File.expand_path('../support/database.yml', __FILE__))['test']
+ActiveRecord::Base.establish_connection(db_config)
+require 'support/schema'
+require 'support/models'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  config.order = 'random'
+
+  config.before :each do
+    Object.send(:remove_const, :Post)
+    load 'support/models.rb'
+  end
+  config.after :each do
+    configure_i18n available_locales: [:ru, :en, :es],
+                   default_locale: :ru,
+                   locale: :ru,
+                   fallbacks: false
+  end
+end
+
+def configure_i18n(options)
+  options.each do |key, value|
+    I18n.send("#{key}=", value)
+  end
+end

data/spec/support/database.yml.example

@@ -0,0 +1,7 @@
+test:
+  adapter: postgresql
+  host: localhost
+  username: postgres
+  encoding: utf8
+  database: hstore_translations_test
+  min_messages: warning

data/spec/support/models.rb

@@ -0,0 +1,2 @@
+class Post < ActiveRecord::Base
+end

data/spec/support/schema.rb

@@ -0,0 +1,8 @@
+ActiveRecord::Schema.define(:version => 0) do
+  enable_extension 'hstore'
+
+  create_table :posts, :force => true do |t|
+    t.hstore :title_translations
+    t.hstore :body_translations
+  end
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: hstore_translations
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Aleksey Demidov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.0.0.rc1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.0.0.rc1
+- !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: pg
+  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: 
+email:
+- aleksey.dem@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- hstore_translations.gemspec
+- lib/hstore_translations.rb
+- lib/hstore_translations/access_methods.rb
+- lib/hstore_translations/macro.rb
+- lib/hstore_translations/translations_lookup.rb
+- lib/hstore_translations/version.rb
+- spec/hstore_translations/access_methods_spec.rb
+- spec/hstore_translations/macro_spec.rb
+- spec/hstore_translations_spec.rb
+- spec/spec_helper.rb
+- spec/support/database.yml.example
+- spec/support/models.rb
+- spec/support/schema.rb
+homepage: ''
+licenses:
+- MIT
+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.0
+signing_key: 
+specification_version: 4
+summary: Translations for Rails 4 model columns, stored in hstore
+test_files:
+- spec/hstore_translations/access_methods_spec.rb
+- spec/hstore_translations/macro_spec.rb
+- spec/hstore_translations_spec.rb
+- spec/spec_helper.rb
+- spec/support/database.yml.example
+- spec/support/models.rb
+- spec/support/schema.rb
+has_rdoc: