localizable_model 0.6.4 → 0.6.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d820cd209d050722f33ec1575127da0cf52e2d50c2ed997d4233efee2bb57108
-  data.tar.gz: 11bd8974fea7210004fe059769a3fac42a366485722cebdf78122b3f2991e2dd
+  metadata.gz: aa4b3cecd47009c23bced97ef733cb34a052d0f066dabf8bbcae2c5a4283dc15
+  data.tar.gz: 1899ba6b4ff4806f92b4939098c8ae69f004da8e1a06ee8a1779e141f60dcbbd
 SHA512:
-  metadata.gz: d14acab4ab549a03d4e7cbe081be7391d8d0ba9ff68c26b8aa8aca7344ef22d56e93945f5e8a59d4f9c2c112b0bbfed7b7368e0c006646e89bd28848de8e925c
-  data.tar.gz: d5442deb98026971a1cccc432a333480145aa6e44a8a869ef39952ac275d5249b8864d67830e199cc9c4e8a9d064e55eb8bc3c707185571f561614c0e77a224f
+  metadata.gz: 5bf37f75cdbb03226737be1fc26fc5b137b8e2cc7167d4d353e9d936a25a18594be731dbd8993eb52658661ed683cfd9123f2e2b7037593e485b710475f290d9
+  data.tar.gz: 601c0947961bf37ba06702443027b9b817ad9f954ea6d70523752c30830f647f9a0d3e03d111b6a75919dcb84afe78826e95a7ff7f545d0f36d75490df85237f

data/README.md

@@ -1,9 +1,5 @@
 [![Version](https://img.shields.io/gem/v/localizable_model.svg?style=flat)](https://rubygems.org/gems/localizable_model)
-[![Build Status](https://travis-ci.org/anyone-oslo/localizable_model.svg?branch=master)](https://travis-ci.org/anyone-oslo/localizable_model)
-[![Code Climate](https://codeclimate.com/github/anyone-oslo/localizable_model/badges/gpa.svg)](https://codeclimate.com/github/anyone-oslo/localizable_model)
-[![Test Coverage](https://codeclimate.com/github/anyone-oslo/localizable_model/badges/coverage.svg)](https://codeclimate.com/github/anyone-oslo/localizable_model)
-[![Inline docs](http://inch-ci.org/github/anyone-oslo/localizable_model.svg)](http://inch-ci.org/github/anyone-oslo/localizable_model)
-[![Security](https://hakiri.io/github/anyone-oslo/localizable_model/master.svg)](https://hakiri.io/github/anyone-oslo/localizable_model/master)
+[![Build](https://github.com/anyone-oslo/localizable_model/actions/workflows/build.yml/badge.svg)](https://github.com/anyone-oslo/localizable_model/actions/workflows/build.yml)
 
 # LocalizableModel
 

data/Rakefile

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
-APP_RAKEFILE = "spec/internal/Rakefile".freeze
+APP_RAKEFILE = "spec/internal/Rakefile"
 load "rails/tasks/engine.rake"
 
 RSpec::Core::RakeTask.new

data/app/models/localization.rb

@@ -1,15 +1,15 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 class Localization < ActiveRecord::Base
   belongs_to :localizable, polymorphic: true, optional: true, touch: true
 
   class << self
     def locales
-      order("locale ASC").pluck(Arel.sql("DISTINCT locale"))
+      order(:locale).pluck(Arel.sql("DISTINCT locale"))
     end
 
     def names
-      order("name ASC").pluck(Arel.sql("DISTINCT name"))
+      order(:name).pluck(Arel.sql("DISTINCT name"))
     end
   end
 
@@ -20,6 +20,6 @@ class Localization < ActiveRecord::Base
   delegate :empty?, to: :to_s
 
   def translate(locale)
-    localizable.localizations.find_by(name: name, locale: locale)
+    localizable.localizations.find_by(name:, locale:)
   end
 end

data/lib/localizable_model/active_record_extension.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module LocalizableModel
   # = LocalizableModel::ActiveRecordExtension
@@ -19,20 +19,26 @@ module LocalizableModel
     #    end
     #  end
     #
-    def localizable(&block)
-      unless is_a?(LocalizableModel::ClassMethods)
-        send :extend,  LocalizableModel::ClassMethods
-        send :include, LocalizableModel::InstanceMethods
-        has_many(:localizations,
-                 as: :localizable,
-                 dependent: :destroy,
-                 autosave: true)
-        before_save :cleanup_localizations!
-      end
-      localizable_configuration.instance_eval(&block) if block_given?
+    def localizable(&)
+      extend_with_localizable_model!
+      localizable_configuration.instance_eval(&) if block_given?
       define_localizable_methods!
     end
+
+    def extend_with_localizable_model!
+      return if is_a?(LocalizableModel::ClassMethods)
+
+      send :extend,  LocalizableModel::ClassMethods
+      send :include, LocalizableModel::InstanceMethods
+      has_many(:localizations,
+               as: :localizable,
+               dependent: :destroy,
+               autosave: true)
+      before_save :cleanup_localizations!
+    end
   end
 end
 
-ActiveRecord::Base.send(:extend, LocalizableModel::ActiveRecordExtension)
+ActiveSupport.on_load(:active_record) do
+  extend LocalizableModel::ActiveRecordExtension
+end

data/lib/localizable_model/any_localizer.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module LocalizableModel
   class AnyLocalizer
@@ -30,15 +30,15 @@ module LocalizableModel
     end
 
     def localized?(attribute)
-      !localized(attribute).blank?
+      localized(attribute).present?
     end
 
     def localized(attribute)
       localized = locales.inject(nil) do |str, l|
-        str ||= -> {
+        str || lambda {
           value = record.localize(l).send(attribute)
-          value.blank? ? nil : value
-        }.call()
+          value.presence
+        }.call
       end
       localized || ""
     end

data/lib/localizable_model/class_methods.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module LocalizableModel
   # = LocalizableModel::ClassMethods
@@ -21,7 +21,7 @@ module LocalizableModel
     #
     def localized(locale)
       in_locale(locale)
-        .where("localizations.locale = ?", locale)
+        .where(localizations: { locale: })
         .references(:localizations)
     end
 
@@ -37,16 +37,10 @@ module LocalizableModel
     private
 
     def define_localizable_methods!
-      localizable_configuration.attributes.keys.each do |name|
-        define_method name do
-          localizer.get(name).to_s
-        end
-        define_method "#{name}?" do
-          localizer.value_for?(name)
-        end
-        define_method "#{name}=" do |value|
-          localizer.set(name, value)
-        end
+      localizable_configuration.attributes.each_key do |name|
+        define_method(name)       { localizer.get(name).to_s }
+        define_method("#{name}?") { localizer.value_for?(name) }
+        define_method("#{name}=") { |value| localizer.set(name, value) }
       end
     end
 

data/lib/localizable_model/configuration.rb

@@ -1,9 +1,9 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module LocalizableModel
   class Configuration
     def initialize(attributes = nil)
-      @attributes = attributes
+      @attribute_table = attributes
     end
 
     def attribute(attribute_name, options = {})
@@ -36,13 +36,14 @@ module LocalizableModel
 
     def hashify(list)
       return list if list.is_a?(Hash)
-      list.each_with_object({}) do |e, a|
-        a[e] = {}
+
+      list.index_with do |_e|
+        {}
       end
     end
 
     def attribute_table
-      @attributes ||= {}
+      @attribute_table ||= {}
     end
   end
 end

data/lib/localizable_model/engine.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module LocalizableModel
   class Engine < ::Rails::Engine

data/lib/localizable_model/instance_methods.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module LocalizableModel
   # = LocalizableModel::InstanceMethods
@@ -19,9 +19,10 @@ module LocalizableModel
 
     # Returns an AnyLocalizer for the model.
     #
-    def any_locale
+    def any_localizer
       @any_localizer ||= AnyLocalizer.new(self)
     end
+    alias any_locale any_localizer
 
     # Setter for locale
     #
@@ -89,8 +90,8 @@ module LocalizableModel
     # A localized model responds to :foo, :foo= and :foo?
     #
     def respond_to?(method_name, *args)
-      requested_attribute, = method_name.to_s.match(/(.*?)([\?=]?)$/)[1..2]
-      localizer.attribute?(requested_attribute.to_sym) ? true : super
+      requested_attribute, = method_name.to_s.match(/(.*?)([?=]?)$/)[1..2]
+      localizer.attribute?(requested_attribute.to_sym) || super
     end
 
     alias translate localize
@@ -113,9 +114,13 @@ module LocalizableModel
       localizer.cleanup_localizations!
     end
 
+    def respond_to_missing?(method_name, include_private = false)
+      localizer.attribute?(method_to_attr(method_name)) || super
+    end
+
     def method_missing(method_name, *args)
       attr = method_to_attr(method_name)
-      super unless localizer.attribute?(attr)
+      return super unless localizer.attribute?(attr)
 
       case method_name.to_s
       when /\?$/
@@ -128,7 +133,7 @@ module LocalizableModel
     end
 
     def method_to_attr(method_name)
-      method_name.to_s.match(/(.*?)([\?=]?)$/)[1].to_sym
+      method_name.to_s.match(/(.*?)([?=]?)$/)[1].to_sym
     end
   end
 end

data/lib/localizable_model/localizer.rb

@@ -1,16 +1,15 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module LocalizableModel
   class Localizer
     attr_accessor :locale
+
     def initialize(model)
       @model         = model
       @configuration = model.class.localizable_configuration
     end
 
-    def attribute?(attribute)
-      @configuration.attribute?(attribute)
-    end
+    delegate :attribute?, to: :@configuration
 
     def locales
       @model.localizations.map(&:locale).uniq
@@ -28,7 +27,7 @@ module LocalizableModel
     end
 
     def get(attribute, options = {})
-      get_options = { locale: locale }.merge(options)
+      get_options = { locale: }.merge(options)
       find_localizations(
         attribute.to_s,
         get_options[:locale].to_s
@@ -40,7 +39,7 @@ module LocalizableModel
     end
 
     def set(attribute, value, options = {})
-      set_options = { locale: locale }.merge(options)
+      set_options = { locale: }.merge(options)
       if value.is_a?(Hash) || value.is_a?(ActionController::Parameters)
         value.each { |loc, val| set(attribute, val, locale: loc) }
       else
@@ -72,11 +71,12 @@ module LocalizableModel
 
     def get_value(attribute, locale)
       localization = find_localizations(attribute, locale).try(&:first)
-      localization.value if localization
+      localization&.value
     end
 
     def require_locale!(attribute, locale)
       return if locale
+
       raise(ArgumentError,
             "Tried to set :#{attribute}, but no locale has been set")
     end

data/lib/localizable_model/scope_extension.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module LocalizableModel
   # = LocalizableModel::ScopeExtension
@@ -20,10 +20,51 @@ module LocalizableModel
       self
     end
 
+    # Orders results by localized attribute values.
+    #
+    #   Product.in_locale(:nb).order_by_localization(:name)
+    #   Product.in_locale(:en).order_by_localization(:name, :description)
+    #
+    def order_by_localization(*attributes)
+      attributes = attributes.flatten.map(&:to_s)
+
+      require_localized_attributes!(attributes)
+      order(*attributes.map { |attr| order_by_localization_clause(attr) })
+    end
+
     protected
 
     def localize_records
       @records.each { |r| r.localize!(@locale) }
     end
+
+    private
+
+    def localization_values
+      Localization
+        .arel_table
+        .project(Localization.arel_table[:value])
+        .where(Localization.arel_table[:localizable_id].eq(arel_table[:id]))
+        .where(Localization.arel_table[:localizable_type].eq(name))
+    end
+
+    def order_by_localization_clause(attribute)
+      Arel::Nodes::Ascending.new(
+        localization_values
+          .where(Localization.arel_table[:name].eq(attribute))
+          .where(Localization.arel_table[:locale].eq(@locale.to_s))
+      ).nulls_last
+    end
+
+    def require_localized_attributes!(attributes)
+      raise ArgumentError, "No attributes specified" if attributes.empty?
+
+      invalid = attributes.reject do |attr|
+        klass.localized_attributes.include?(attr.to_sym)
+      end
+      return if invalid.empty?
+
+      raise ArgumentError, "#{invalid.join(', ')} are not localized attributes"
+    end
   end
 end

data/lib/localizable_model/version.rb

@@ -1,5 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module LocalizableModel
-  VERSION = "0.6.4".freeze unless LocalizableModel.const_defined?("VERSION")
+  VERSION = "0.6.5" unless LocalizableModel.const_defined?("VERSION")
 end

data/lib/localizable_model.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 load "localizable_model/active_record_extension.rb"
 load "localizable_model/any_localizer.rb"

data/lib/rails/generators/localizable_model/migration/migration_generator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "rails/generators/active_record/migration"
 
 module LocalizableModel
@@ -6,7 +8,7 @@ module LocalizableModel
       include ActiveRecord::Generators::Migration
 
       desc "Creates the LocalizableModel migration"
-      source_root File.expand_path("../templates", __FILE__)
+      source_root File.expand_path("templates", __dir__)
 
       def copy_files
         migration_template(

data/lib/rails/generators/localizable_model/migration/templates/create_localizations.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class CreateLocalizations < ActiveRecord::Migration
   def change
     create_table :localizations do |t|
@@ -6,9 +8,9 @@ class CreateLocalizations < ActiveRecord::Migration
       t.string :locale
       t.text :value, limit: 16_777_215
       t.timestamps null: false
-      t.index([:localizable_id, :localizable_type, :name, :locale],
+      t.index(%i[localizable_id localizable_type name locale],
               name: "index_localizations_on_locale")
-      t.index [:localizable_id, :localizable_type]
+      t.index %i[localizable_id localizable_type]
     end
   end
 end

metadata

@@ -1,85 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: localizable_model
 version: !ruby/object:Gem::Version
-  version: 0.6.4
+  version: 0.6.5
 platform: ruby
 authors:
 - Inge Jørgensen
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-17 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: mysql2
-  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: pg
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.18.3
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.18.3
-- !ruby/object:Gem::Dependency
-  name: rspec-rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.5.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.5.1
-- !ruby/object:Gem::Dependency
-  name: factory_girl
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 4.8.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 4.8.0
-- !ruby/object:Gem::Dependency
-  name: shoulda-matchers
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.1.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.1.0
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -118,8 +47,8 @@ files:
 - lib/rails/generators/localizable_model/migration/templates/create_localizations.rb
 homepage: ''
 licenses: []
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -127,15 +56,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.2
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
-signing_key: 
+rubygems_version: 3.7.1
 specification_version: 4
 summary: Localization support for ActiveRecord objects
 test_files: []