mobility 0.8.1 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 379c09aba475fbc7b7491e64cbbbd7eb6fa3ac46b546c318ca645345f2a548cf
-  data.tar.gz: 5359a8a04ea4db2e30d43e14f79ba2c962555362e4a8e5f1d5412d481b101c9f
+  metadata.gz: 68b8f21d39ab133839062c63ed91f6cf225464b1780525ff3e96b33937c98c0c
+  data.tar.gz: 66f0db0183fc1568c290fdddb52edce9dfbb85536dcf1ebd8921e6fa3b1bbd36
 SHA512:
-  metadata.gz: fe6c5ade9de6a5f35ef84c5daa8c822e397e608f60c9f3d34451b1091a89f2eed5c9c58801afd1603c0ad1ceb2c58d26865a3b0297b4f2fa5f8ac3886712788c
-  data.tar.gz: 8b6fbbf4c0833d6921c002136ec10ce6baec7dd0b20886b9c4dece81099cd4444e1bbd6dd5067d0392ec8a7b538ae1a170340107d6aa60325437e9859cb507ee
+  metadata.gz: 21902f555813178915a0f265e3ecde8a777907e654d40d733761c95898e0cf70764457441233d0591b9591bb22ff74741c48d47aac3ebc914a4400c03d232136
+  data.tar.gz: 5a8c377f1161de9bf533315094c31e5c40fa722ff06d14006086eb389acacad228303a98c3872b39adc09e2de684e0959df90a4c63bc4a52dd7d2ab22ecf56af

data/CHANGELOG.md

@@ -2,6 +2,11 @@
 
 ## 0.8
 
+### 0.8.2 (September 28, 2018)
+* Support pluck, select and group methods on translated attributes
+  ([#284](https://github.com/shioyama/mobility/pull/284),
+  [#285](https://github.com/shioyama/mobility/pull/285))
+
 ### 0.8.1 (September 25, 2018)
 * Default ActiveRecord Table/KeyValue backends to OUTER JOIN
   ([#277](https://github.com/shioyama/mobility/pull/277))

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mobility (0.8.0)
+    mobility (0.8.1)
       i18n (>= 0.6.10, < 2)
       request_store (~> 1.0)
 
@@ -42,7 +42,7 @@ GEM
     database_cleaner (1.7.0)
     diff-lcs (1.3)
     erubi (1.7.1)
-    ffi (1.9.24)
+    ffi (1.9.25)
     formatador (0.2.5)
     generator_spec (0.9.4)
       activesupport (>= 3.0.0)
@@ -108,19 +108,19 @@ GEM
       ffi (>= 0.5.0, < 2)
     request_store (1.4.1)
       rack (>= 1.4)
-    rspec (3.7.0)
-      rspec-core (~> 3.7.0)
-      rspec-expectations (~> 3.7.0)
-      rspec-mocks (~> 3.7.0)
-    rspec-core (3.7.1)
-      rspec-support (~> 3.7.0)
-    rspec-expectations (3.7.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-mocks (3.7.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-support (3.7.1)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
     ruby_dep (1.5.0)
     shellany (0.0.1)
     sqlite3 (1.3.13)
@@ -128,7 +128,7 @@ GEM
     thread_safe (0.3.6)
     tzinfo (1.2.5)
       thread_safe (~> 0.1)
-    yard (0.9.14)
+    yard (0.9.16)
 
 PLATFORMS
   ruby

data/README.md

@@ -51,7 +51,7 @@ Installation
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'mobility', '~> 0.8.1'
+gem 'mobility', '~> 0.8.2'
 ```
 
 Mobility is cryptographically signed. To be sure the gem you install hasn't
@@ -716,6 +716,15 @@ locale(s) and value(s) passed in to the query. Details of how this is done can
 be found in the [Wiki page for the KeyValue
 backend](https://github.com/shioyama/mobility/wiki/KeyValue-Backend#querying).
 
+You can also use methods like `order`, `select`, `pluck` and `group` on
+translated attributes just as you would with normal attributes, and Mobility
+will handle generating the appropriate SQL:
+
+```ruby
+Post.i18n.pluck(:title)
+#=> ["foo", "bar", ...]
+```
+
 If you would prefer to avoid the `i18n` scope everywhere, you can define it as
 a default scope on your model:
 

data/lib/mobility/arel.rb

@@ -4,7 +4,36 @@ require "mobility/arel/visitor"
 
 module Mobility
   module Arel
+    module MobilityExpressions
+      include ::Arel::Expressions
+
+      # @note This is necessary in order to ensure that when a translated
+      #   attribute is selected with an alias using +AS+, the resulting
+      #   expression can still be counted without blowing up.
+      #
+      #   Extending +::Arel::Expressions+ is necessary to convince ActiveRecord
+      #   that this node should not be stringified, which otherwise would
+      #   result in garbage SQL.
+      #
+      # @see https://github.com/rails/rails/blob/847342c25c61acaea988430dc3ab66a82e3ed486/activerecord/lib/active_record/relation/calculations.rb#L261
+      def as(*)
+        super
+          .extend(::Arel::Expressions)
+          .extend(Countable)
+      end
+
+      module Countable
+        # @note This allows expressions with selected translated attributes to
+        #   be counted.
+        def count(*args)
+          left.count(*args)
+        end
+      end
+    end
+
     class Attribute < ::Arel::Attributes::Attribute
+      include MobilityExpressions
+
       attr_reader :backend_class
       attr_reader :locale
       attr_reader :attribute_name

data/lib/mobility/arel/nodes/pg_ops.rb

@@ -14,10 +14,10 @@ module Mobility
         HstoreQuestion
       ].each do |name|
         const_set name, (Class.new(Binary) do
-          include ::Arel::Expressions
           include ::Arel::Predications
           include ::Arel::OrderPredications
           include ::Arel::AliasPredication
+          include ::Mobility::Arel::MobilityExpressions
 
           def lower
             super self

data/lib/mobility/backends/active_record/column.rb

@@ -57,6 +57,7 @@ can be run again to add new attributes or locales.)
       #   on model table
       def self.build_node(attr, locale)
         model_class.arel_table[Column.column_name_for(attr, locale)]
+          .extend(::Mobility::Arel::MobilityExpressions)
       end
 
       private

data/lib/mobility/plugins/active_record/query.rb

@@ -22,7 +22,35 @@ enabled for any one attribute on the model.
               extend FindByMethods.new(*attributes.names)
               singleton_class.send :alias_method, Mobility.query_method, :__mobility_query_scope__
             end
+            attributes.backend_class.include self
           end
+
+          def attribute_alias(attribute, locale = Mobility.locale)
+            "__mobility_%s_%s__"  % [attribute, ::Mobility.normalize_locale(locale)]
+          end
+        end
+
+        # @note We use +instance_variable_get+ here to get the +AttributeSet+
+        #   rather than the hash of attributes. Getting the full hash of
+        #   attributes is a performance hit and better to avoid if unnecessary.
+        # TODO: Improve this.
+        def read(locale, **)
+          if (model_attributes_defined? &&
+              model_attributes.key?(alias_ = Query.attribute_alias(attribute, locale)))
+            model_attributes[alias_].value
+          else
+            super
+          end
+        end
+
+        private
+
+        def model_attributes_defined?
+          model.instance_variable_defined?(:@attributes)
+        end
+
+        def model_attributes
+          model.instance_variable_get(:@attributes)
         end
 
         module QueryMethod
@@ -109,6 +137,28 @@ enabled for any one attribute on the model.
             end
           end
 
+          if ::ActiveRecord::VERSION::STRING >= '5.0'
+            %w[pluck group select].each do |method_name|
+              define_method method_name do |*attrs|
+                return super(*attrs) unless attrs.any?(&@klass.method(:mobility_attribute?))
+
+                keys = attrs.dup
+
+                base = keys.each_with_index.inject(self) do |query, (key, index)|
+                  next query unless @klass.mobility_attribute?(key)
+                  keys[index] = backend_node(key)
+                  if method_name == "select"
+                    keys[index] = keys[index]
+                      .as(::Mobility::Plugins::ActiveRecord::Query.attribute_alias(key.to_s))
+                  end
+                  @klass.mobility_backend_class(key).apply_scope(query, backend_node(key))
+                end
+
+                base.public_send(method_name, *keys)
+              end
+            end
+          end
+
           # Return backend node for attribute name.
           # @param [Symbol,String] name Name of attribute
           # @param [Symbol] locale Locale

data/lib/mobility/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Mobility
-  VERSION = "0.8.1"
+  VERSION = "0.8.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mobility
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.8.2
 platform: ruby
 authors:
 - Chris Salzberg
@@ -35,7 +35,7 @@ cert_chain:
   m46ezJjnr4uXgSNuTs+RdM6DtrKaFG2HuziSP+dzmWqZiUgj1eTACYsPwfF/Z1Z6
   2DiDkec/SK4qJBMlNYPo/PTZuh5m1jROtf/hyS0VXJmm+uWc
   -----END CERTIFICATE-----
-date: 2018-09-25 00:00:00.000000000 Z
+date: 2018-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: request_store