ar_translate 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e8666d7846ba61edb998c0d30aef7dd695b5c10e
+  data.tar.gz: 7647b7eef464793712146ecb9d4f231d97797b69
+SHA512:
+  metadata.gz: fc7bf2b4429dca5dd301cb3d4c6a39d6b8ca2e4c01efb0acf707ec0ce186678483cd2176da308ea0e0cc1c8e296d2a2553497665ee6852a3c9b04ddaff269b9d
+  data.tar.gz: 9739ca357a7cac1db0b61b54fc4729e37d9b284597d65597a24fe8408eb5736e48469efc254c6ba0fe644906ee4348b97b7fd852d3303e6be537755fcc1c939e

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.ruby-version

@@ -0,0 +1 @@
+2.2.2

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rubocop-ci', github: 'ad2games/rubocop-ci'
+gem 'codeclimate-test-reporter', group: :test, require: nil

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 ad2games GmbH
+
+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,77 @@
+# ArTranslate
+
+[![Circle CI](https://circleci.com/gh/ad2games/ar_translate.svg?style=svg)](https://circleci.com/gh/ad2games/ar_translate)
+[![Code Climate](https://codeclimate.com/github/ad2games/ar_translate/badges/gpa.svg)](https://codeclimate.com/github/ad2games/ar_translate)
+[![Test Coverage](https://codeclimate.com/github/ad2games/ar_translate/badges/coverage.svg)](https://codeclimate.com/github/ad2games/ar_translate/coverage)
+
+Store values for multiple languages in an ActiveRecord attribute using PostgreSQL's hstore.
+
+## Installation
+
+Add the gem to your application's Gemfile:
+
+```ruby
+gem 'ar_translate'
+```
+
+## Usage
+
+Create a hstore column of the pluralized attribute name:
+```ruby
+add_column :posts, :descriptions, :hstore
+```
+
+Add the following to your model:
+```ruby
+class Post < ActiveRecord::Base
+  extend ArTranslate
+
+  translates :descriptions, languages: %w(de en)
+end
+```
+
+Now you have access to the following methods:
+
+```ruby
+post = Post.new
+
+post.description_de = 'Hallo wie geht es dir?'
+post.description_en = 'Whats up?'
+
+post.descriptions
+# => { 'de' => 'Hallo wie geht es dir?', 'en' => 'Whats up?' }
+
+post.description_de
+# => 'Hallo wie geht es dir?'
+
+post.description_languages
+# => ['de', 'en']
+
+post.description_attributes
+# => [:description_de, :description_en]
+```
+
+This makes it really easy to use forms with translated attributes:
+```ruby
+= form_for @post do |f|
+  = f.text_field :name
+  - @post.description_attributes.each do |attr|
+    = f.text_field attr
+```
+
+## License
+
+MIT, see LICENSE.txt
+
+## Contributing
+
+Feel free to fork and submit pull requests!
+
+You need to set the `DATABASE_URL` environment variable
+to a valid PostgreSQL database for testing.
+
+```
+$ createdb ar_translate_test
+$ export DATABASE_URL="postgres://localhost/ar_translate_test"
+$ bundle exec rspec
+```

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler/gem_tasks'
+require 'rubocop-ci'

data/ar_translate.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ar_translate/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'ar_translate'
+  spec.version = ArTranslate::VERSION
+  spec.authors = ['Niko Dziemba']
+  spec.email = ['niko@dziemba.com']
+
+  spec.summary = 'Store translations in AR models with hstore'
+  spec.description =
+    'Store values for multiple languages in an ActiveRecord attribute using PostgreSQL\'s hstore.'
+  spec.homepage = 'https://github.com/ad2games/ar_translate'
+
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activerecord', '>= 4.0.0'
+  spec.add_dependency 'activesupport', '>= 4.0.0'
+  spec.add_dependency 'pg'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+end

data/circle.yml

@@ -0,0 +1,9 @@
+machine:
+  environment:
+    DATABASE_URL: postgres://ubuntu:@127.0.0.1:5432/circle_test
+database:
+  override:
+    - echo Skipped.
+test:
+  pre:
+    - bundle exec rake rubocop

data/lib/ar_translate.rb

@@ -0,0 +1,11 @@
+require 'active_record'
+require 'active_support/inflector'
+require 'ar_translate/version'
+require 'ar_translate/error'
+require 'ar_translate/translated_column'
+
+module ArTranslate
+  def translates(column, opts = {})
+    TranslatedColumn.new(self, column, opts).inject
+  end
+end

data/lib/ar_translate/error.rb

@@ -0,0 +1,4 @@
+module ArTranslate
+  class Error < RuntimeError
+  end
+end

data/lib/ar_translate/translated_column.rb

@@ -0,0 +1,93 @@
+module ArTranslate
+  class TranslatedColumn
+    KEYWORDS = %w(attributes languages)
+
+    attr_reader :model, :column, :langs
+
+    def initialize(model, column, opts)
+      @model = model
+      @column = column.to_s
+      @langs = opts.delete(:languages)
+
+      check_plural_name!
+      check_languages!
+    end
+
+    def inject
+      define_attributes
+      define_languages
+
+      langs.each do |lang|
+        define_reader(lang)
+        define_writer(lang)
+      end
+    end
+
+    private
+
+    def prefix
+      column.singularize
+    end
+
+    def attributes
+      langs.map { |lang| :"#{prefix}_#{lang}" }
+    end
+
+    def check_plural_name!
+      return if column.pluralize == column
+      return if column.singularize != column
+
+      fail Error, "Column name #{column} is not pluralized"
+    end
+
+    def check_languages!
+      if !langs.is_a?(Array) || langs.empty?
+        fail Error, "No languages specified for column #{column}"
+      end
+
+      langs.each do |lang|
+        next if lang =~ /^[a-z]+$/ && !KEYWORDS.include?(lang)
+        fail Error, "Invalid language '#{lang}' (should be lowercase only)"
+      end
+    end
+
+    def model_method(name, &block)
+      method_name = "#{prefix}_#{name}"
+      c_column = column
+
+      model.instance_eval do
+        define_method(method_name) do |*args|
+          column_info = self.class.columns_hash[c_column]
+          fail Error, "Invalid column #{c_column}" if column_info.nil?
+          fail Error, "Column type for #{c_column} is not hstore" unless column_info.type == :hstore
+
+          instance_exec(*args, &block)
+        end
+      end
+    end
+
+    def define_reader(lang)
+      c_column = column
+      model_method(lang) do
+        self[c_column][lang]
+      end
+    end
+
+    def define_writer(lang)
+      c_column = column
+      model_method("#{lang}=") do |val|
+        self[c_column][lang] = val
+      end
+    end
+
+    def define_attributes
+      c_attributes = attributes
+      model_method(:attributes) { c_attributes }
+    end
+
+    def define_languages
+      c_langs = langs
+      model_method(:languages) { c_langs }
+    end
+  end
+end

data/lib/ar_translate/version.rb

@@ -0,0 +1,3 @@
+module ArTranslate
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: ar_translate
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Niko Dziemba
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-19 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
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: 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'
+description: Store values for multiple languages in an ActiveRecord attribute using
+  PostgreSQL's hstore.
+email:
+- niko@dziemba.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- ar_translate.gemspec
+- circle.yml
+- lib/ar_translate.rb
+- lib/ar_translate/error.rb
+- lib/ar_translate/translated_column.rb
+- lib/ar_translate/version.rb
+homepage: https://github.com/ad2games/ar_translate
+licenses: []
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Store translations in AR models with hstore
+test_files: []