trasto 0.0.1

data/.gitignore

@@ -0,0 +1,26 @@
+*.sassc
+.sass-cache
+capybara-*.html
+.rspec
+**.orig
+rerun.txt
+pickle-email-*.html
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+spec/tmp
+coverage
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Morton Jonuschat
+
+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,84 @@
+# Trasto
+
+[![Build Status](https://secure.travis-ci.org/yabawock/trasto.png)](http://travis-ci.org/yabawock/trasto)
+
+Translatable columns for Rails 3, directly stored in a postgres hstore in the model table.
+
+Inspired by Barsoom's [traco](https://github.com/barsoom/traco/).
+
+To store translations outside the model, see Sven Fuchs' [globalize3](https://github.com/svenfuchs/globalize3).
+
+## Usage
+
+Say you want `Post#title` and `Post#body` to support both English and Swedish values.
+
+Write a migration to get hstore database columns with i18n suffixes, e.g. `title_i18n` and `body_i18n`, like:
+
+    class CreatePosts < ActiveRecord::Migration
+      def change
+        create_table :posts do |t|
+          t.hstore :title_i18n
+          t.hstore :body_i18n
+
+          t.timestamps
+        end
+      end
+    end
+
+Don't create `title` or `body` columns without the `_i18n` suffix, Trasto will define a method with that name.
+
+Declare these columns in the model:
+
+    class Post < ActiveRecord::Base
+      translates :title, :body
+    end
+
+You can still use your accessors for `title_i18n` and `title_i18=` in forms, validations and other code, but you also get:
+
+`#title`:  Shows the title in the current locale. If blank, falls back to default locale, then to any locale.
+
+`#title=`: Assigns the title to the column for the current locale, if present.
+
+`.locales_for_column(:title)`: Returns an array like `[:de, :en]` sorted with default locale first and then all currently available locals sorted alphabetically.
+
+## Installation
+
+Add this to your `Gemfile` if you use Bundler 1.1+:
+
+    gem 'traco'
+
+Then run
+
+    bundle install
+
+to install it.
+
+
+## Running the tests
+
+    bundle
+    rake
+
+## Credits and license
+
+By [Morton Jonuschat](https://github.com/yabawock) under the MIT license:
+
+>  Copyright (c) 2012 Morton Jonuschat
+>
+>  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/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/trasto.rb

@@ -0,0 +1,4 @@
+require "trasto/version"
+require "trasto/translates"
+require "trasto/class_methods"
+require "trasto/instance_methods"

data/lib/trasto/class_methods.rb

@@ -0,0 +1,15 @@
+module Trasto
+  module ClassMethods
+
+    private
+
+    def translates?(column)
+      translatable_columns.include?(column.to_sym)
+    end
+
+    def locale_name(locale)
+      I18n.t(locale, :scope => :"i18n.languages", :default => locale.to_s.upcase)
+    end
+
+  end
+end

data/lib/trasto/instance_methods.rb

@@ -0,0 +1,30 @@
+module Trasto
+  module InstanceMethods
+
+    private
+
+    def read_localized_value(column)
+      locales_for_reading_column(column).each do |locale|
+        value = send("#{column}_i18n")[locale]
+        return value if value.present?
+      end
+      nil
+    end
+
+    def write_localized_value(column, value)
+      translations = send("#{column}_i18n") || {}
+      send("#{column}_i18n=", translations.merge({I18n.locale => value}))
+    end
+
+    def locales_for_reading_column(column)
+      send("#{column}_i18n").keys.sort_by { |locale|
+        case locale
+        when I18n.locale then "0"
+        when I18n.default_locale then "1"
+        else locale.to_s
+        end
+      }
+    end
+
+  end
+end

data/lib/trasto/translates.rb

@@ -0,0 +1,32 @@
+module Trasto
+  module Translates
+    def translates(*columns)
+
+      extend Trasto::ClassMethods
+      include Trasto::InstanceMethods
+
+      # Don't overwrite values if running multiple times in the same class
+      # or in different classes of an inheritance chain.
+      unless respond_to?(:translatable_columns)
+        class_attribute :translatable_columns
+        self.translatable_columns = []
+      end
+
+      self.translatable_columns |= columns.map(&:to_sym)
+
+      columns.each do |column|
+
+        define_method(column) do
+          read_localized_value(column)
+        end
+
+        define_method("#{column}=") do |value|
+          write_localized_value(column, value)
+        end
+
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send :extend, Trasto::Translates

data/lib/trasto/version.rb

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

data/spec/app/de.yml

@@ -0,0 +1,7 @@
+de:
+  attributes:
+    title: "Titel"
+  i18n:
+    languages:
+      en: "English"
+      de: "Deutsch"

data/spec/app/post.rb

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

data/spec/spec_helper.rb

@@ -0,0 +1,32 @@
+RSpec.configure do |config|
+  # Clear class state before each spec.
+  config.before(:each) do
+    Object.send(:remove_const, 'Post')
+    Object.send(:remove_const, 'SubPost')
+    load 'app/post.rb'
+  end
+end
+
+# Test against real ActiveRecord models.
+# Very much based on the test setup in
+# https://github.com/iain/translatable_columns/
+
+require "active_record"
+require "activerecord-postgres-hstore"
+require "activerecord-postgres-hstore/activerecord"
+require "app/post.rb"
+
+ActiveRecord::Base.establish_connection :adapter => "postgresql", :database => "test"
+
+silence_stream(STDOUT) do
+  ActiveRecord::Schema.define(:version => 0) do
+    execute "CREATE EXTENSION IF NOT EXISTS hstore"
+
+    create_table :posts, :force => true do |t|
+      t.hstore :title_i18n
+      t.hstore :body_i18n
+    end
+  end
+end
+
+I18n.load_path << "spec/app/de.yml"

data/spec/trasto_spec.rb

@@ -0,0 +1,99 @@
+require "spec_helper"
+require "trasto"
+
+describe ActiveRecord::Base, ".translates" do
+
+  it "should be available" do
+    Post.should respond_to :translates
+  end
+
+  it "should add functionality" do
+    Post.new.should_not respond_to :title
+    Post.translates :title
+    Post.new.should respond_to :title
+  end
+
+  it "should be possible to run more than once" do
+    Post.new.should_not respond_to :title, :body
+    Post.translates :title
+    Post.translates :body
+    Post.new.should respond_to :title, :body
+  end
+
+  it "inherits columns from the superclass" do
+    Post.translates :title
+    SubPost.translates :body
+    SubPost.new.should respond_to :title, :body
+    Post.new.should respond_to :title
+    Post.new.should_not respond_to :body
+  end
+
+end
+
+describe Post, ".translatable_columns" do
+
+  before do
+    Post.translates :title
+  end
+
+  it "should list the translatable columns" do
+    Post.translatable_columns.should == [ :title ]
+  end
+
+end
+
+describe Post, "#title" do
+
+  let(:post) { Post.new(:title_i18n => { :de => "Hallo", :en => "Hello", :sv => "Hej"} ) }
+
+  before do
+    Post.translates :title
+    I18n.locale = :en
+    I18n.default_locale = :de
+  end
+
+  it "should give the title in the current locale" do
+    post.title.should == "Hello"
+  end
+
+  it "should fall back to the default locale if locale has entry" do
+    I18n.locale = :ru
+    post.title.should == "Hallo"
+  end
+
+  it "should fall back to the default locale if blank" do
+    post.title_i18n[:en] = " "
+    post.title.should == "Hallo"
+  end
+
+  it "should fall back to any other locale if default locale is blank" do
+    post.title_i18n[:en] = " "
+    post.title_i18n[:de] = ""
+    post.title.should == "Hej"
+  end
+
+  it "should return nil if all are blank" do
+    post.title_i18n[:en] = " "
+    post.title_i18n[:de] = ""
+    post.title_i18n[:sv] = nil
+    post.title.should be_nil
+  end
+
+end
+
+describe Post, "#title=" do
+
+  before do
+    Post.translates :title
+    I18n.locale = :de
+  end
+
+  let(:post) { Post.new }
+
+  it "should assign in the current locale" do
+    post.title = "Hallo"
+    post.title.should == "Hallo"
+    post.title_i18n[:de].should == "Hallo"
+  end
+
+end

data/trasto.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'trasto/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "trasto"
+  gem.version       = Trasto::VERSION
+  gem.authors       = ["Morton Jonuschat"]
+  gem.email         = ["yabawock@gmail.com"]
+  gem.description   = %q{Translatable columns for Rails 3, directly stored in a postgres hstore in the model table.}
+  gem.summary       = %q{Make use of PostgreSQL hstore extension to store all column translations directly in the model table without adding tons of tables or columns}
+  gem.homepage      = "https://github.com/yabawock/trasto"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency              "pg",                           "~> 0.10"
+  gem.add_dependency              "activerecord-postgres-hstore", ">= 0.4.0"
+
+  gem.add_development_dependency  "rake",                         "~> 0.9.2"
+  gem.add_development_dependency  "rspec",                        "~> 2.11.0"
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: trasto
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Morton Jonuschat
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: activerecord-postgres-hstore
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+description: Translatable columns for Rails 3, directly stored in a postgres hstore
+  in the model table.
+email:
+- yabawock@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/trasto.rb
+- lib/trasto/class_methods.rb
+- lib/trasto/instance_methods.rb
+- lib/trasto/translates.rb
+- lib/trasto/version.rb
+- spec/app/de.yml
+- spec/app/post.rb
+- spec/spec_helper.rb
+- spec/trasto_spec.rb
+- trasto.gemspec
+homepage: https://github.com/yabawock/trasto
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Make use of PostgreSQL hstore extension to store all column translations
+  directly in the model table without adding tons of tables or columns
+test_files:
+- spec/app/de.yml
+- spec/app/post.rb
+- spec/spec_helper.rb
+- spec/trasto_spec.rb