acts_as_simple_translatable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fc2edabeeef11fc661d785b3f3b02f4415188102
+  data.tar.gz: d7ee7d21b707caff96c9f9ad2ce1a8039ce9821d
+SHA512:
+  metadata.gz: cd80ac0e02184eaf932af60455864a25fef46f79f5083a9e1c2cd827ced7dd37cbdc9286aff019933283944326f4e1de4a8cc491e795e6c6608cd10ab972055d
+  data.tar.gz: f2f6c18c88d352eb9529a1f909ee869915a0b647ab403cbce180a4bbc9aac35ed33f59964a0d859cc78518b6734ef3d91c64cd5012cd77ee8415d4bdbda351c5

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/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Stjepan Hadjic
+
+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,64 @@
+# ActsAsSimpleTranslatable
+
+Adds translation table, and helpers to work with model translations
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'acts_as_simple_translatable'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install acts_as_simple_translatable
+
+## Configuration
+
+This will create a translations table
+
+    $ rails generate acts_as_simple_translatable:install
+
+To add translation to your model just add to your model:
+
+    acts_as_simple_translatable_on :name, :description
+
+Add to application rb
+
+    I18n.avaliable_locales = ['en', 'de']
+
+## Usage
+
+    m = Model.create(name: 'name', descritpion: 'description' )
+    m.translations.create(locale: 'de', tanslatable_field: 'name', content: 'name_in_de')
+
+    I18n.locale = 'de'
+    m.name                    #=> 'name_in_de'
+    m.description             #=> ''
+
+Default locale content will be saved in original field in table (e.g. in table `Model`, attribute `name`) while for other locales content will be saved in `translations` table.
+
+You also have the access to list of translatable fields:
+
+    Model.locale_fields       #=> [:name, :description]
+
+You can access to original field by prepending `_original` to attribute name:
+
+    description_original
+
+Also, when you accessing to attribute and there is no translation for it, you can define custom message or default message will be returned.
+
+    my_model.name     # => 'NO TRANSLATION' <-- default message
+
+    my_model.name('You need translate this')    # => 'You need translate this' <-- custom message
+
+## Contributing
+
+1. Fork it ( http://github.com/d4be4st/acts_as_simple_translatable/fork )
+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/acts_as_simple_translatable.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'acts_as_simple_translatable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "acts_as_simple_translatable"
+  spec.version       = ActsAsSimpleTranslatable::VERSION
+  spec.authors       = ["Stjepan Hadjic"]
+  spec.email         = ["d4be4st@gmail.com"]
+  spec.summary       = %q{ acts as simple translatable}
+  spec.description   = %q{ Took acts_as_translatable and stripped it down}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+end

data/lib/acts_as_simple_translatable.rb

@@ -0,0 +1,5 @@
+require 'acts_as_simple_translatable/class_methods'
+require 'acts_as_simple_translatable/translation'
+require 'acts_as_simple_translatable/version'
+
+ActiveRecord::Base.extend ActsAsSimpleTranslatable::ClassMethods

data/lib/acts_as_simple_translatable/class_methods.rb

@@ -0,0 +1,43 @@
+module ActsAsSimpleTranslatable
+  module ClassMethods
+    def acts_as_simple_translatable_on(*fields)
+      # scope :with_translations, -> (locale) { joins(:translations).where(translations: {locale: locale}).preload(:translations) }
+      scope :with_translations, -> { includes(:translations) }
+      has_many :translations, as: :translatable, dependent: :destroy
+      accepts_nested_attributes_for :translations, reject_if: :all_blank, allow_destroy: :true
+
+      @locale_fields = fields
+      class << self
+        attr_accessor :locale_fields
+      end
+
+      # Loop through fields to define methods such as "name" and "description"
+      fields.each do |field|
+        define_method "#{field}" do |default_message = 'NO TRANSLATION'|
+          content = (I18n.locale == I18n.default_locale) ? super() : locale_translations[field]
+          content.present? ? content : default_message
+        end
+
+        define_method "#{field}_original" do
+          super()
+        end
+
+        define_method "#{field}?" do
+          !send("#{field}").blank?
+        end
+      end
+
+      define_method :locale_translations do
+        # load translations
+        unless @locale_translations
+          @locale_translations = {}
+          translations.select { |t| t.locale == I18n.locale.to_s }.each do |translation|
+            @locale_translations ||= {}
+            @locale_translations[translation.translatable_field.to_sym] = translation.content
+          end
+        end
+        @locale_translations
+      end
+    end
+  end
+end

data/lib/acts_as_simple_translatable/translation.rb

@@ -0,0 +1,7 @@
+class Translation < ActiveRecord::Base
+  belongs_to :translatable, polymorphic: true
+
+  scope :field, -> (field) { where(translatable_field: field) }
+  scope :ordered, -> { order(locale: :asc) }
+  scope :locale, -> (locale) { where(locale: locale) }
+end

data/lib/acts_as_simple_translatable/version.rb

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

data/lib/generators/acts_as_simple_translatable/USAGE

@@ -0,0 +1,9 @@
+Description:
+    Generates migration for acts_as_simple_translatable.
+
+Example:
+    rails generate acts_as_simple_translatable en category name description
+
+    This will create a migration to translate the name and description fields in the categories table.
+    It will insert the existing category and description values in the record_translations table using the 'en' (English) locale.
+    Note: You cannot roll back this migration.

data/lib/generators/acts_as_simple_translatable/install_generator.rb

@@ -0,0 +1,19 @@
+require 'rails/generators'
+
+module ActsAsSimpleTranslatable
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      source_root File.expand_path('../templates', __FILE__)
+
+      def install
+        migration_template "migration.rb", "db/migrate/create_translations.rb"
+      end
+
+      def self.next_migration_number(path)
+        @migration_number = Time.now.utc.strftime("%Y%m%d%H%M%S").to_i.to_s
+      end
+    end
+  end
+end

data/lib/generators/acts_as_simple_translatable/templates/migration.rb

@@ -0,0 +1,16 @@
+class CreateTranslations < ActiveRecord::Migration
+  def change
+    # create translations table if it doesn't exist
+    create_table :translations do |t|
+      t.integer :translatable_id, required: true
+      t.string :translatable_type, required: true
+      t.string :translatable_field, required: true
+      t.string :locale, length: 5, required: true
+      t.text :content
+      t.timestamps
+    end
+
+    # add index
+    add_index :translations, [:translatable_id, :translatable_type, :locale], name: 'record_translations_index'
+  end
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: acts_as_simple_translatable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Stjepan Hadjic
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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'
+description: " Took acts_as_translatable and stripped it down"
+email:
+- d4be4st@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- acts_as_simple_translatable.gemspec
+- lib/acts_as_simple_translatable.rb
+- lib/acts_as_simple_translatable/class_methods.rb
+- lib/acts_as_simple_translatable/translation.rb
+- lib/acts_as_simple_translatable/version.rb
+- lib/generators/acts_as_simple_translatable/USAGE
+- lib/generators/acts_as_simple_translatable/install_generator.rb
+- lib/generators/acts_as_simple_translatable/templates/migration.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.4.5
+signing_key: 
+specification_version: 4
+summary: acts as simple translatable
+test_files: []
+has_rdoc: