rails-translator 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 YOURNAME
+
+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.rdoc

@@ -0,0 +1,54 @@
+= Translator
+{<img src="https://travis-ci.org/hzamani/translator.png" />}[https://travis-ci.org/hzamani/translator]
+
+This is a rails plugin to translate models data.
+
+== Requirements
+
+This plugin uses postgres hstore, so postgres is a must.
+
+== How to Install
+
+Install the gem
+  gem install rails-translator
+add
+  gem 'activerecord-postgres-hstore'
+  gem 'rails-translator'
+to your Gemfile and run bundler
+  bundle install
+
+== How to Use
+
+First be sure to install postgres hstore extension, by
+
+  rails g hstore:setup
+  rake db:migrate
+
+Generate your models but use +hstore+ for translatable string and text fields.
+
+  rails g model Post title:hstore content:hstore published_at:datatime
+
+optionally add hstore_index for hstore columns:
+
+  # migration file
+  add_hstore_index :posts, :title
+  add_hstore_index :posts, :content
+
+tell which fields do you want to have translations:
+
+  class Post < ActiveRecord::Base
+    translates :title, :content
+    # ...
+  end
+
+now post has locale based attribute accessors:
+
+  I18n.locale = :en
+  p = Post.create title: 'first post', content: 'This is my first post.'
+  I18n.locale = :fa
+  p.title = ''
+
+
+
+  
+

data/Rakefile

@@ -0,0 +1,27 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Translator'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+

data/lib/rails-translator.rb

@@ -0,0 +1,4 @@
+require 'translator/translates'
+
+module Translator
+end

data/lib/tasks/translator_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :translator do
+#   # Task goes here
+# end

data/lib/translator/translates.rb

@@ -0,0 +1,90 @@
+module Translator
+  class << self
+    def fallback_locale  ()        @fallback_locale  ||= nil         end
+    def fallback_locale= (locale)  @fallback_locale    = locale.to_s end
+    def prefixed_locales ()        @prefixed_locales ||= []          end
+    def prefixed_locales=(locales) @prefixed_locales   = locales     end
+
+    def prefixed name
+      if prefixed_locales.empty?
+        name.to_sym
+      else
+        prefixed_locales.map do |locale|
+          "#{locale}_#{name}".to_sym
+        end
+      end
+    end
+  end
+
+  module Translates
+    extend ActiveSupport::Concern
+
+    included do
+      def translate name, translations
+        data = read_attribute name
+        raise ArgumentError.new "translations should be a hash" unless translations.is_a?(Hash)
+        data.update Hash[translations.map { |k,v| [k.to_s, v] }]
+        write_attribute name, data
+        data
+      end
+
+      def translated name, locale
+        data = read_attribute name
+        if data.is_a? Hash
+          data[locale.to_s] || data[Translator.fallback_locale]
+        else
+          data
+        end
+      end
+    end
+
+    module ClassMethods
+      def translates *args
+        self.translated_attributes = args
+        self.translated_attributes.each do |name|
+          translated_attr_accessor name
+          translations_attr_accessor name
+        end
+      end
+
+      def translates? name
+        self.translated_attributes.include? name
+      end
+
+      def translated_attributes
+        @translated_attributes ||= []
+      end
+
+      def prefixed_attributes
+        @prefixed_attributes ||= translated_attributes.map{ |a| Translator.prefixed(a) }.flatten
+      end
+
+      protected
+
+      def translated_attributes= value
+        @translated_attributes = value
+      end
+
+      def translated_attr_accessor name
+        serialize name, ActiveRecord::Coders::Hstore
+
+        attr_accessible *prefixed_attributes
+
+        define_method("#{name}")  { |locale=nil| translated name, locale || I18n.locale }
+        define_method("#{name}=") { |value|      translate  name, I18n.locale => value }
+
+        Translator.prefixed_locales.each do |locale|
+          define_method("#{locale}_#{name}")  { translated name, locale }
+          define_method("#{locale}_#{name}=") { |value| translate name, locale => value }
+        end
+      end
+
+      def translations_attr_accessor name
+        define_method("#{name}_translations")  { read_attribute name }
+        define_method("#{name}_translations=") { |value| write_attribute name, value }
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send :include, Translator::Translates

data/lib/translator/version.rb

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

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: rails-translator
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Hassan Zamani
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: activerecord-postgres-hstore
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Translator uses postgres hstore to keep model translations in your database.
+email:
+- hsn.zamani@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/translator/translates.rb
+- lib/translator/version.rb
+- lib/tasks/translator_tasks.rake
+- lib/rails-translator.rb
+- MIT-LICENSE
+- Rakefile
+- README.rdoc
+homepage: https://github.com/hzamani/translator
+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.25
+signing_key: 
+specification_version: 3
+summary: Rails plugin for model translation.
+test_files: []