mobility 1.0.0.beta1 → 1.0.2

data/lib/mobility/plugins/attribute_methods.rb

@@ -15,6 +15,7 @@ attributes only.
       extend Plugin
 
       default true
+      requires :attributes
 
       initialize_hook do |*names|
         include InstanceMethods

data/lib/mobility/plugins/attributes.rb

@@ -32,8 +32,15 @@ for aggregating attributes.
       end
 
       included_hook do |klass|
-        klass.extend ClassMethods
-        @names.each { |name| klass.register_mobility_attribute(name) }
+        names = @names
+
+        klass.class_eval do
+          extend ClassMethods
+          names.each { |name| mobility_attributes << name.to_s }
+          mobility_attributes.uniq!
+        rescue FrozenError
+          raise FrozenAttributesError, "Attempting to translate these attributes on #{klass}, which has already been subclassed: #{names.join(', ')}."
+        end
       end
 
       module ClassMethods
@@ -44,25 +51,20 @@ for aggregating attributes.
           mobility_attributes.include?(name.to_s)
         end
 
-        # Register a new attribute name. Public, but treat as internal.
-        # @param [String, Symbol] Attribute name
-        def register_mobility_attribute(name)
-          (self.mobility_attributes << name.to_s).uniq!
-        end
-
-        def inherited(klass)
-          super
-          mobility_attributes.each { |name| klass.register_mobility_attribute(name) }
-        end
-
-        protected
-
         # Return translated attribute names on this model.
         # @return [Array<String>] Attribute names
         def mobility_attributes
           @mobility_attributes ||= []
         end
+
+        def inherited(klass)
+          super
+          attrs = mobility_attributes.freeze # ensure attributes are not modified after being inherited
+          klass.class_eval { @mobility_attributes = attrs.dup }
+        end
       end
+
+      class FrozenAttributesError < Error; end
     end
 
     register_plugin(:attributes, Attributes)

data/lib/mobility/plugins/backend.rb

@@ -56,8 +56,11 @@ Defines:
 
           backend_class.setup_model(klass, names)
 
-          @names.each do |name|
-            klass.register_mobility_backend_class(name, @backend_class)
+          names = @names
+          backend_class = @backend_class
+
+          klass.class_eval do
+            names.each { |name| mobility_backend_classes[name.to_sym] = backend_class }
           end
 
           backend_class
@@ -137,12 +140,9 @@ Defines:
           raise KeyError, "No backend for: #{name}"
         end
 
-        def register_mobility_backend_class(name, backend_class)
-          mobility_backend_classes[name.to_sym] = backend_class
-        end
-
         def inherited(klass)
-          klass.mobility_backend_classes.merge!(@mobility_backend_classes)
+          parent_classes = mobility_backend_classes.freeze # ensure backend classes are not modified after being inherited
+          klass.class_eval { @mobility_backend_classes = parent_classes.dup }
           super
         end
 

data/lib/mobility/plugins/sequel/dirty.rb

@@ -51,7 +51,7 @@ Automatically includes dirty plugin in model class when enabled.
           # @!group Backend Accessors
           # @!macro backend_writer
           # @param [Hash] options
-          def write(locale, value, options = {})
+          def write(locale, value, **options)
             locale_accessor = Mobility.normalize_locale_accessor(attribute, locale).to_sym
             if model.column_changes.has_key?(locale_accessor) && model.initial_values[locale_accessor] == value
               super

data/lib/mobility/version.rb

@@ -8,8 +8,8 @@ module Mobility
   module VERSION
     MAJOR = 1
     MINOR = 0
-    TINY = 0
-    PRE = "beta1"
+    TINY = 2
+    PRE = nil
 
     STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".")
   end

data/lib/rails/generators/mobility/templates/create_string_translations.rb

@@ -1,5 +1,4 @@
 class CreateStringTranslations < <%= activerecord_migration_class %>
-
   def change
     create_table :mobility_string_translations do |t|
       t.string :locale, null: false

data/lib/rails/generators/mobility/templates/create_text_translations.rb

@@ -1,5 +1,4 @@
 class CreateTextTranslations < <%= activerecord_migration_class %>
-
   def change
     create_table :mobility_text_translations do |t|
       t.string :locale, null: false

data/lib/rails/generators/mobility/templates/initializer.rb

@@ -1,5 +1,4 @@
 Mobility.configure do
-
   # PLUGINS
   plugins do
     # Backend
@@ -104,5 +103,14 @@ Mobility.configure do
     #
     # Or define specific defaults by uncommenting line below
     # locale_accessors [:en, :ja]
+
+    # Attribute Methods
+    #
+    # Adds translated attributes to +attributes+ hash, and defines methods
+    # +translated_attributes+ and +untranslated_attributes+ which return hashes
+    # with translated and untranslated attributes, respectively. Be aware that
+    # this plugin can create conflicts with other gems.
+    #
+    # attribute_methods
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mobility
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta1
+  version: 1.0.2
 platform: ruby
 authors:
 - Chris Salzberg
@@ -34,7 +34,7 @@ cert_chain:
   gSQml7TqcC6dZRsZRwYqzD9kUwdAJoCqno2CBUKs2l0yQAjFT36lRrVJznb7uWwa
   xpPFnsrtyaZW6Dty8TSG3qzmeGpmpIotA8x1VA==
   -----END CERTIFICATE-----
-date: 2020-11-03 00:00:00.000000000 Z
+date: 2021-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: request_store
@@ -156,14 +156,6 @@ files:
 - README.md
 - Rakefile
 - lib/mobility.rb
-- lib/mobility/active_record/model_translation.rb
-- lib/mobility/active_record/string_translation.rb
-- lib/mobility/active_record/text_translation.rb
-- lib/mobility/active_record/translation.rb
-- lib/mobility/arel.rb
-- lib/mobility/arel/nodes.rb
-- lib/mobility/arel/nodes/pg_ops.rb
-- lib/mobility/arel/visitor.rb
 - lib/mobility/backend.rb
 - lib/mobility/backends.rb
 - lib/mobility/backends/active_record.rb
@@ -209,6 +201,9 @@ files:
 - lib/mobility/plugins/active_record/dirty.rb
 - lib/mobility/plugins/active_record/query.rb
 - lib/mobility/plugins/active_record/uniqueness_validation.rb
+- lib/mobility/plugins/arel.rb
+- lib/mobility/plugins/arel/nodes.rb
+- lib/mobility/plugins/arel/nodes/pg_ops.rb
 - lib/mobility/plugins/attribute_methods.rb
 - lib/mobility/plugins/attributes.rb
 - lib/mobility/plugins/backend.rb
@@ -228,13 +223,6 @@ files:
 - lib/mobility/plugins/sequel/dirty.rb
 - lib/mobility/plugins/sequel/query.rb
 - lib/mobility/plugins/writer.rb
-- lib/mobility/sequel/column_changes.rb
-- lib/mobility/sequel/hash_initializer.rb
-- lib/mobility/sequel/model_translation.rb
-- lib/mobility/sequel/sql.rb
-- lib/mobility/sequel/string_translation.rb
-- lib/mobility/sequel/text_translation.rb
-- lib/mobility/sequel/translation.rb
 - lib/mobility/translations.rb
 - lib/mobility/util.rb
 - lib/mobility/version.rb
@@ -259,7 +247,13 @@ metadata:
   homepage_uri: https://github.com/shioyama/mobility
   source_code_uri: https://github.com/shioyama/mobility
   changelog_uri: https://github.com/shioyama/mobility/blob/master/CHANGELOG.md
-post_install_message:
+post_install_message: |2
+
+  Warning: Mobility v1.0 includes backwards-incompatible changes (mostly around configuration).
+
+  If you are upgrading from an earlier version, please see:
+  - https://github.com/shioyama/mobility/releases/tag/v1.0.0
+  - https://github.com/shioyama/mobility/wiki/Introduction-to-Mobility-v1.0
 rdoc_options: []
 require_paths:
 - lib
@@ -270,9 +264,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.1.2
 signing_key:

data/lib/mobility/active_record/model_translation.rb

@@ -1,14 +0,0 @@
-module Mobility
-  module ActiveRecord
-=begin
-
-Subclassed dynamically to generate translation class in
-{Backends::ActiveRecord::Table} backend.
-
-=end
-    class ModelTranslation < ::ActiveRecord::Base
-      self.abstract_class = true
-      validates :locale, presence: true
-    end
-  end
-end

data/lib/mobility/active_record/string_translation.rb

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-require "mobility/active_record/translation"
-
-module Mobility
-  module ActiveRecord
-    class StringTranslation < Translation
-      self.table_name = "mobility_string_translations"
-    end
-  end
-end

data/lib/mobility/active_record/text_translation.rb

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-require "mobility/active_record/translation"
-
-module Mobility
-  module ActiveRecord
-    class TextTranslation < Translation
-      self.table_name = "mobility_text_translations"
-    end
-  end
-end

data/lib/mobility/active_record/translation.rb

@@ -1,14 +0,0 @@
-module Mobility
-  module ActiveRecord
-    # @abstract Subclass and set +table_name+ to implement for a particular column type.
-    class Translation < ::ActiveRecord::Base
-      self.abstract_class = true
-
-      belongs_to :translatable, polymorphic: true, touch: true
-
-      validates :key, presence: true, uniqueness: { scope: [:translatable_id, :translatable_type, :locale], case_sensitive: true }
-      validates :translatable, presence: true
-      validates :locale, presence: true
-    end
-  end
-end

data/lib/mobility/arel.rb

@@ -1,49 +0,0 @@
-# frozen-string-literal: true
-require "mobility/arel/nodes"
-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
-
-      def initialize(relation, column_name, locale, backend_class, attribute_name = nil)
-        @backend_class = backend_class
-        @locale = locale
-        @attribute_name = attribute_name || column_name
-        super(relation, column_name)
-      end
-    end
-  end
-end

data/lib/mobility/arel/nodes.rb

@@ -1,13 +0,0 @@
-# frozen-string-literal: true
-module Mobility
-  module Arel
-    module Nodes
-      class Binary < ::Arel::Nodes::Binary; end
-      class Grouping < ::Arel::Nodes::Grouping; end
-
-      ::Arel::Visitors::ToSql.class_eval do
-        alias :visit_Mobility_Arel_Nodes_Grouping :visit_Arel_Nodes_Grouping
-      end
-    end
-  end
-end

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

@@ -1,132 +0,0 @@
-# frozen-string-literal: true
-require "mobility/arel"
-
-module Mobility
-  module Arel
-    module Nodes
-      %w[
-        JsonDashArrow
-        JsonDashDoubleArrow
-        JsonbDashArrow
-        JsonbDashDoubleArrow
-        JsonbQuestion
-        HstoreDashArrow
-        HstoreQuestion
-      ].each do |name|
-        const_set name, (Class.new(Binary) do
-          include ::Arel::Predications
-          include ::Arel::OrderPredications
-          include ::Arel::AliasPredication
-          include ::Mobility::Arel::MobilityExpressions
-
-          def lower
-            super self
-          end
-        end)
-      end
-
-      # Needed for AR 4.2, can be removed when support is deprecated
-      if ::ActiveRecord::VERSION::STRING < '5.0'
-        [JsonbDashDoubleArrow, HstoreDashArrow].each do |klass|
-          klass.class_eval do
-            def quoted_node other
-              other && super
-            end
-          end
-        end
-      end
-
-      class Jsonb  < JsonbDashDoubleArrow
-        def to_dash_arrow
-          JsonbDashArrow.new left, right
-        end
-
-        def to_question
-          JsonbQuestion.new left, right
-        end
-
-        def eq other
-          case other
-          when NilClass
-            to_question.not
-          when Integer, Array, ::Hash
-            to_dash_arrow.eq other.to_json
-          when Jsonb
-            to_dash_arrow.eq other.to_dash_arrow
-          when JsonbDashArrow
-            to_dash_arrow.eq other
-          else
-            super
-          end
-        end
-      end
-
-      class Hstore < HstoreDashArrow
-        def to_question
-          HstoreQuestion.new left, right
-        end
-
-        def eq other
-          other.nil? ? to_question.not : super
-        end
-      end
-
-      class Json < JsonDashDoubleArrow; end
-
-      class JsonContainer < Json
-        def initialize column, locale, attr
-          super(Arel::Nodes::JsonDashArrow.new(column, locale), attr)
-        end
-      end
-
-      class JsonbContainer < Jsonb
-        def initialize column, locale, attr
-          @column, @locale = column, locale
-          super(JsonbDashArrow.new(column, locale), attr)
-        end
-
-        def eq other
-          other.nil? ? super.or(JsonbQuestion.new(@column, @locale).not) : super
-        end
-      end
-    end
-
-    module Visitors
-      def visit_Mobility_Arel_Nodes_JsonDashArrow o, a
-        json_infix o, a, '->'
-      end
-
-      def visit_Mobility_Arel_Nodes_JsonDashDoubleArrow o, a
-        json_infix o, a, '->>'
-      end
-
-      def visit_Mobility_Arel_Nodes_JsonbDashArrow o, a
-        json_infix o, a, '->'
-      end
-
-      def visit_Mobility_Arel_Nodes_JsonbDashDoubleArrow o, a
-        json_infix o, a, '->>'
-      end
-
-      def visit_Mobility_Arel_Nodes_JsonbQuestion o, a
-        json_infix o, a, '?'
-      end
-
-      def visit_Mobility_Arel_Nodes_HstoreDashArrow o, a
-        json_infix o, a, '->'
-      end
-
-      def visit_Mobility_Arel_Nodes_HstoreQuestion o, a
-        json_infix o, a, '?'
-      end
-
-      private
-
-      def json_infix o, a, opr
-        visit(Nodes::Grouping.new(::Arel::Nodes::InfixOperation.new(opr, o.left, o.right)), a)
-      end
-    end
-
-    ::Arel::Visitors::PostgreSQL.include Visitors
-  end
-end