attr_translate 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7d9a44a5c74b80f11fc6c36cc4153bec6f019bb3
+  data.tar.gz: 4716ef9f800a4786ed938a84432ad1c729aba82e
+SHA512:
+  metadata.gz: c3a9a0bb4c6b23f8e8571de91eeeb416f5df2b059b5147f617d94f8d0a07cb113b007d78853fbd0a268d51f1ca1a34b4e74e9d82974df639a6b9b3352c1c9d19
+  data.tar.gz: daf05ddcc2a0d73f6e7161b851b9e071a2f88a982cffeb3e5cd81dc9ce401401dd4c4f9be13468763bcde5cbaab12f3b686fbb31be35d62c2011b73ecb491d24

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+# Change Log
+
+## v1.0.0
+- Initial release.

data/README.md

@@ -0,0 +1,83 @@
+# AttrTranslate
+
+Rails concern for ActiveRecord attribute translation using PostgreSQL's JSONB datatype.
+
+AttrTranslate is extracted from the Brightcommerce platform and is used in a number of other software projects.
+
+## Installation
+
+To install add the line to your Gemfile:
+
+``` ruby
+gem 'attr_translate'
+```
+
+And `bundle install`.
+
+## How To Use
+
+To add AttrTranslate to a model, include the concern and class method:
+
+``` ruby
+class Post < ActiveRecord::Base
+  include AttrTranslate
+
+  attr_translate :title, :body
+end
+```
+
+For convenience the `attr_translate` class method is aliased internally as `attr_translates`.
+
+To autoload AttrTranslate for all models, add the following to an initializer:
+
+``` ruby
+require 'attr_translate/active_record'
+```
+
+You then don't need to `include AttrTranslate` in any model, but you still need to add the `attr_translate` class method.
+
+### Setup
+
+Each attribute that will have translations will need to be setup appropriately in your model's migration. Append `_translations` to the column name, and set the column type to `:jsonb`. To aid in search, setup an index using the `gin` index type. Each translation will be stored using the locale as a key in a hash and converted to JSON.
+
+``` ruby
+class CreatePosts < ActiveRecord::Migration[5.2]
+  def change
+    create_table :posts do |table|
+      table.column :title_translations, :jsonb, default: {}, index: {using: 'gin'}
+      table.column :body_translations, :jsonb, default: {}, index: {using: 'gin'}
+      table.timestamps
+    end
+  end
+end
+```
+
+## Dependencies
+
+AttrTranslate gem has the following runtime dependencies:
+- activerecord >= 5.1.4
+- activesupport >= 5.1.4
+
+## Compatibility
+
+Tested with MRI 2.4.2 against Rails 5.2.2.
+
+## 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
+
+## Credit
+
+This gem was written and is maintained by [Jurgen Jocubeit](https://github.com/JurgenJocubeit), CEO and President Brightcommerce, Inc.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Copyright
+
+Copyright 2018 Brightcommerce, Inc.

data/lib/attr_translate.rb

@@ -0,0 +1,2 @@
+require 'attr_translate/attr_translate'
+require 'attr_translate/version'

data/lib/attr_translate/active_record.rb

@@ -0,0 +1 @@
+ActiveRecord::Base.send :include, AttrTranslate

data/lib/attr_translate/attr_translate.rb

@@ -0,0 +1,145 @@
+require 'active_support/concern'
+require_relative './translation_attribute'
+
+module AttrTranslate
+  extend ActiveSupport::Concern
+
+  class_methods do
+    def attr_translate(*attrs)
+      class_attribute :translated_attribute_names, :permitted_translated_attributes
+
+      self.translated_attribute_names = attrs
+      self.permitted_translated_attributes = [
+        *self.ancestors
+          .select { |klass| klass.respond_to?(:permitted_translated_attributes) }
+          .map(&:permitted_translated_attributes),
+        *attrs.product(I18n.available_locales)
+          .map { |attribute, locale| :"#{attribute}_#{locale}" }
+      ].flatten.compact
+
+      attrs.each do |attr_name|
+        define_method attr_name do |**params|
+          read_json_translation(attr_name, params)
+        end
+
+        define_method "#{attr_name}=" do |value|
+          write_json_translation(attr_name, value)
+        end
+
+        define_singleton_method "with_#{attr_name}_translation" do |value, locale = I18n.locale|
+          quoted_translation_store = connection.quote_column_name("#{attr_name}_translations")
+          translation_hash = { "#{locale}" => value }
+          where("#{quoted_translation_store} @> :translation::jsonb", translation: translation_hash.to_json)
+        end
+      end
+
+      send(:prepend, TranslationAttribute)
+    end
+    alias_method :attr_translates, :attr_translate
+
+    def translates?
+      true
+    end
+
+  end
+
+  def disable_fallback
+    toggle_fallback(false)
+  end
+
+  def enable_fallback
+    toggle_fallback(true)
+  end
+
+  protected
+
+  attr_reader :enabled_fallback
+
+  def json_translate_fallback_locales(locale)
+    return locale if enabled_fallback == false || !::I18n.respond_to?(:fallbacks)
+    ::I18n.fallbacks[locale]
+  end
+
+  def read_json_translation(attr_name, locale = I18n.locale, **params)
+    translations = public_send("#{attr_name}_translations") || {}
+
+    available = Array(json_translate_fallback_locales(locale)).detect do |available_locale|
+      translations[available_locale.to_s].present?
+    end
+
+    translation = translations[available.to_s]
+    # Rescue from MissingInterpolationArgument
+    # so the default behaviour doesn't change.
+    begin
+      ::I18n.interpolate(translation, params) if translation
+    rescue ::I18n::MissingInterpolationArgument
+      translation
+    end
+  end
+
+  def write_json_translation(attr_name, value, locale = I18n.locale)
+    translation_store = "#{attr_name}_translations"
+    translations = public_send(translation_store) || {}
+    public_send("#{translation_store}_will_change!") unless translations[locale.to_s] == value
+    translations[locale.to_s] = value
+    public_send("#{translation_store}=", translations)
+    value
+  end
+
+  def respond_to_with_translates?(symbol, include_all = false)
+    return true if parse_translated_attribute_accessor(symbol)
+    respond_to_without_translates?(symbol, include_all)
+  end
+
+  def method_missing_with_translates(method_name, *args)
+    translated_attr_name, locale, assigning = parse_translated_attribute_accessor(method_name)
+
+    return method_missing_without_translates(method_name, *args) unless translated_attr_name
+
+    if assigning
+      write_json_translation(translated_attr_name, args.first, locale)
+    else
+      read_json_translation(translated_attr_name, locale)
+    end
+  end
+
+  # Internal: Parse a translated convenience accessor name.
+  #
+  # method_name - The accessor name.
+  #
+  # Examples
+  #
+  #   parse_translated_attribute_accessor("title_en=")
+  #   # => [:title, :en, true]
+  #
+  #   parse_translated_attribute_accessor("title_fr")
+  #   # => [:title, :fr, false]
+  #
+  # Returns the attribute name Symbol, locale Symbol, and a Boolean
+  # indicating whether or not the caller is attempting to assign a value.
+  def parse_translated_attribute_accessor(method_name)
+    return unless /\A(?<attribute>[a-z0-9_]+)_(?<locale>[a-z]{2})(?<assignment>=?)\z/ =~ method_name
+
+    translated_attr_name = attribute.to_sym
+    return unless translated_attribute_names.include?(translated_attr_name)
+
+    locale = locale.to_sym
+    assigning = assignment.present?
+
+    [translated_attr_name, locale, assigning]
+  end
+
+  def toggle_fallback(enabled)
+    if block_given?
+      old_value = @enabled_fallback
+      begin
+        @enabled_fallback = enabled
+        yield
+      ensure
+        @enabled_fallback = old_value
+      end
+    else
+      @enabled_fallback = enabled
+    end
+  end
+end

data/lib/attr_translate/translation_attribute.rb

@@ -0,0 +1,18 @@
+module TranslationAttribute
+  def respond_to?(symbol, include_all = false)
+    return true if parse_translated_attribute_accessor(symbol)
+    super(symbol, include_all)
+  end
+
+  def method_missing(method_name, *args, **params)
+    translated_attr_name, locale, assigning = parse_translated_attribute_accessor(method_name)
+
+    return super(method_name, *args, **params) unless translated_attr_name
+
+    if assigning
+      write_json_translation(translated_attr_name, args.first, locale)
+    else
+      read_json_translation(translated_attr_name, locale, **params)
+    end
+  end
+end

data/lib/attr_translate/version.rb

@@ -0,0 +1,16 @@
+module AttrTranslate
+  module Version
+    Major       = 1
+    Minor       = 0
+    Revision    = 0
+    Prerelease  = nil
+    Compact     = [Major, Minor, Revision, Prerelease].compact.join('.')
+    Summary     = "AttrTranslate v#{Compact}"
+    Description = "Provides scopes for finding published, unpublished and returning recent or upcoming items."
+    Author      = "Jurgen Jocubeit"
+    Email       = "support@brightcommerce.com"
+    Homepage    = "https://github.com/brightcommerce/attr_translate"
+    Metadata    = {'copyright' => 'Copyright 2018 Brightcommerce, Inc. All Rights Reserved.'}
+    License     = "MIT"
+  end
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: attr_translate
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jurgen Jocubeit
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-12-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.4
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.4
+description: Provides scopes for finding published, unpublished and returning recent
+  or upcoming items.
+email: support@brightcommerce.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- README.md
+- lib/attr_translate.rb
+- lib/attr_translate/active_record.rb
+- lib/attr_translate/attr_translate.rb
+- lib/attr_translate/translation_attribute.rb
+- lib/attr_translate/version.rb
+homepage: https://github.com/brightcommerce/attr_translate
+licenses:
+- MIT
+metadata:
+  copyright: Copyright 2018 Brightcommerce, Inc. All Rights Reserved.
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: AttrTranslate v1.0.0
+test_files: []