Class: Mobility::Backends::ActiveRecord::KeyValue

Inherits:
Object
  • Object
show all
Includes:
Mobility::Backends::ActiveRecord, KeyValue
Defined in:
lib/mobility/backends/active_record/key_value.rb

Overview

Implements the KeyValue backend for ActiveRecord models.

Examples:

class Post < ApplicationRecord
  extend Mobility
  translates :title, backend: :key_value, association_name: :translations, type: :string
end

post = Post.create(title: "foo")
post.translations
#=> #<ActiveRecord::Associations::CollectionProxy ... >
post.translations.first.value
#=> "foo"
post.translations.first.class
#=> Mobility::ActiveRercord::StringTranslation

Defined Under Namespace

Modules: DestroyKeyValueTranslations Classes: StringTranslation, TextTranslation, Translation, Visitor

Backend Configuration collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from KeyValue

#association_name, #class_name, #each_locale, #read, #write

Methods included from Mobility::Backends::ActiveRecord

included

Class Method Details

.apply_scope(relation, predicate, locale = Mobility.locale, invert: false) ⇒ ActiveRecord::Relation

Joins translations using either INNER/OUTER join appropriate to the query.

Parameters:

  • relation (ActiveRecord::Relation) —

    Relation to scope

  • predicate (Object) —

    Arel predicate

  • locale (Symbol) (defaults to: Mobility.locale) —

    (Mobility.locale) Locale

  • [Boolean] (Hash) —

    a customizable set of options

Returns:

  • (ActiveRecord::Relation) —

    relation Relation with joins applied (if needed)


61
62
63
64
65
66
67
 
# File 'lib/mobility/backends/active_record/key_value.rb', line 61

def apply_scope(relation, predicate, locale = Mobility.locale, invert: false)
  visitor = Visitor.new(self, locale)
  visitor.accept(predicate).inject(relation) do |rel, (attr, join_type)|
    join_type &&= ::Arel::Nodes::InnerJoin if invert
    join_translations(rel, attr, locale, join_type)
  end
end

.build_node(attr, locale) ⇒ Mobility::Plugins::Arel::Attribute

Returns Arel attribute for aliased translation table value column.

Parameters:

  • attr (String) —

    Attribute name

  • _locale (Symbol) —

    Locale

Returns:


50
51
52
53
 
# File 'lib/mobility/backends/active_record/key_value.rb', line 50

def build_node(attr, locale)
  aliased_table = class_name.arel_table.alias(table_alias(attr, locale))
  Plugins::Arel::Attribute.new(aliased_table, :value, locale, self, attr.to_sym)
end

.configure(options) ⇒ Object

Parameters:

  • options (Hash) —

    a customizable set of options

Options Hash (options):

  • type (Symbol, String) —

    Column type to use

  • association_name (Symbol) — default: :<type>_translations —

    Name of association method, defaults to <type>_translations

  • class_name (Symbol) —

    Translation class, defaults to Mobility::<ORM>::<type>Translation

Raises:

  • (ArgumentError) —

    if type is not set, and both class_name and association_name are also not set


34
35
36
37
38
39
40
41
42
43
 
# File 'lib/mobility/backends/active_record/key_value.rb', line 34

def configure(options)
  super
  if type = options[:type]
    options[:association_name] ||= :"#{options[:type]}_translations"
    options[:class_name]       ||= const_get("#{type.capitalize}Translation")
  end
  options[:table_alias_affix] = "#{model_class}_%s_#{options[:association_name]}"
rescue NameError
  raise ArgumentError, "You must define a Mobility::Backends::ActiveRecord::KeyValue::#{type.capitalize}Translation class."
end

Instance Method Details

#translation_for(locale) ⇒ Mobility::Backends::ActiveRecord::KeyValue::TextTranslation, Mobility::Backends::ActiveRecord::KeyValue::StringTranslation

Returns translation for a given locale, or builds one if none is present.

Parameters:

  • locale (Symbol)

Returns:


196
197
198
199
200
 
# File 'lib/mobility/backends/active_record/key_value.rb', line 196

def translation_for(locale, **)
  translation = translations.find { |t| t.key == attribute && t.locale == locale.to_s }
  translation ||= translations.build(locale: locale, key: attribute)
  translation
end