mobility 0.1.20 → 0.2.0

data/lib/mobility/backend/sequel.rb

@@ -1,29 +0,0 @@
-module Mobility
-  module Backend
-    module Sequel
-      autoload :Column,       'mobility/backend/sequel/column'
-      autoload :Dirty,        'mobility/backend/sequel/dirty'
-      autoload :Hstore,       'mobility/backend/sequel/hstore'
-      autoload :Jsonb,        'mobility/backend/sequel/jsonb'
-      autoload :KeyValue,     'mobility/backend/sequel/key_value'
-      autoload :Serialized,   'mobility/backend/sequel/serialized'
-      autoload :Table,        'mobility/backend/sequel/table'
-      autoload :QueryMethods, 'mobility/backend/sequel/query_methods'
-
-      def setup_query_methods(query_methods)
-        setup do |attributes, options|
-          extend(Module.new do
-            define_method ::Mobility.query_method do
-              super().with_extend(query_methods.new(attributes, options))
-            end
-          end)
-        end
-      end
-
-      def self.included(backend_class)
-        backend_class.include(Backend)
-        backend_class.extend(self)
-      end
-    end
-  end
-end

data/lib/mobility/backend/sequel/column.rb

@@ -1,39 +0,0 @@
-module Mobility
-  module Backend
-=begin
-
-Implements the {Mobility::Backend::Column} backend for Sequel models.
-
-@note This backend disables the +locale_accessors+ option, which would
-  otherwise interfere with column methods.
-=end
-    class Sequel::Column
-      include Sequel
-      include Column
-
-      require 'mobility/backend/sequel/column/query_methods'
-
-      # @!group Backend Accessors
-      # @!macro backend_reader
-      def read(locale, **_)
-        column = column(locale)
-        model.send(column) if model.columns.include?(column)
-      end
-
-      # @!group Backend Accessors
-      # @!macro backend_writer
-      def write(locale, value, **_)
-        column = column(locale)
-        model.send("#{column}=", value) if model.columns.include?(column)
-      end
-
-      # @!group Backend Configuration
-      def self.configure(options)
-        options[:locale_accessors] = false
-      end
-      # @!endgroup
-
-      setup_query_methods(QueryMethods)
-    end
-  end
-end

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

@@ -1,57 +0,0 @@
-module Mobility
-  module Backend
-=begin
-
-Dirty tracking for Sequel models which use the +Sequel::Plugins::Dirty+ plugin.
-Automatically includes dirty plugin in model class when enabled.
-
-@see http://sequel.jeremyevans.net/rdoc-plugins/index.html Sequel dirty plugin
-
-=end
-    module Sequel::Dirty
-      # @!group Backend Accessors
-      # @!macro backend_writer
-      # @param [Hash] 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
-          [model.changed_columns, model.initial_values].each { |h| h.delete(locale_accessor) }
-        elsif read(locale, options.merge(fallback: false)) != value
-          model.will_change_column(locale_accessor)
-          super
-        end
-      end
-      # @!endgroup
-
-      # @param [Class] backend_class Class of backend
-      def self.included(backend_class)
-        backend_class.extend(ClassMethods)
-      end
-
-      # Adds hook after {Backend::Setup#setup_model} to add dirty-tracking
-      # methods for translated attributes onto model class.
-      module ClassMethods
-        # (see Mobility::Backend::Setup#setup_model)
-        def setup_model(model_class, attributes, **options)
-          super
-          model_class.plugin :dirty
-          model_class.class_eval do
-            mod = Module.new do
-              %w[initial_value column_change column_changed? reset_column].each do |method_name|
-                define_method method_name do |column|
-                  if attributes.map(&:to_sym).include?(column)
-                    super(Mobility.normalize_locale_accessor(column).to_sym)
-                  else
-                    super(column)
-                  end
-                end
-              end
-            end
-            include mod
-          end
-        end
-      end
-    end
-  end
-end

data/lib/mobility/backend/sequel/hash_valued.rb

@@ -1,51 +0,0 @@
-module Mobility
-  module Backend
-=begin
-
-Internal class used by Sequel backends that store values as a hash.
-
-=end
-    class Sequel::HashValued
-      include Sequel
-
-      # @!macro backend_reader
-      def read(locale, **_)
-        translations[locale.to_s]
-      end
-
-      # @!macro backend_writer
-      def write(locale, value, **_)
-        translations[locale.to_s] = value
-      end
-
-      # @!group Cache Methods
-      def translations
-        model.send("#{attribute}_before_mobility")
-      end
-      alias_method :new_cache, :translations
-
-      # @return [Boolean]
-      def write_to_cache?
-        true
-      end
-      # @!endgroup
-
-      setup do |attributes, options|
-        method_overrides = Module.new do
-          define_method :initialize_set do |values|
-            attributes.each { |attribute| send(:"#{attribute}_before_mobility=", {}) }
-            super(values)
-          end
-          define_method :before_validation do
-            attributes.each do |attribute|
-              send("#{attribute}_before_mobility").delete_if { |_, v| v.blank? }
-            end
-            super()
-          end
-        end
-        include method_overrides
-        include Mobility::Sequel::ColumnChanges.new(attributes)
-      end
-    end
-  end
-end

data/lib/mobility/backend/sequel/hstore.rb

@@ -1,29 +0,0 @@
-require 'mobility/backend/sequel/hash_valued'
-
-module Mobility
-  module Backend
-=begin
-
-Implements the {Mobility::Backend::Hstore} backend for Sequel models.
-
-@see Mobility::Backend::Sequel::HashValued
-
-=end
-    class Sequel::Hstore < Sequel::HashValued
-      require 'mobility/backend/sequel/hstore/query_methods'
-
-      # @!group Backend Accessors
-      # @!macro backend_reader
-      # @!method read(locale, **options)
-
-      # @!group Backend Accessors
-      # @!macro backend_writer
-      def write(locale, value, **_)
-        translations[locale.to_s] = value && value.to_s
-      end
-      # @!endgroup
-
-      setup_query_methods(QueryMethods)
-    end
-  end
-end

data/lib/mobility/backend/sequel/serialized/query_methods.rb

@@ -1,20 +0,0 @@
-module Mobility
-  module Backend
-    class Sequel::Serialized::QueryMethods < Sequel::QueryMethods
-      def initialize(attributes, **)
-        super
-        attributes_extractor = @attributes_extractor
-        cond_checker = @cond_checker = lambda do |cond|
-          if i18n_keys = attributes_extractor.call(cond)
-            raise ArgumentError,
-              "You cannot query on mobility attributes translated with the Serialized backend (#{i18n_keys.join(", ")})."
-          end
-        end
-
-        define_method :where do |*cond, &block|
-          cond_checker.call(cond.first) || super(*cond, &block)
-        end
-      end
-    end
-  end
-end

data/lib/mobility/core_ext/object.rb

@@ -1,30 +0,0 @@
-=begin
-
-Add +blank?+, +present?+ and +presence+ methods to +Object+ class if
-activesupport cannot be loaded.
-
-=end
-class Object
-  def blank?
-    respond_to?(:empty?) ? !!empty? : !self
-  end
-
-  def present?
-    !blank?
-  end
-
-  def presence
-    self if present?
-  end
-end
-
-=begin
-
-Add +blank?+ method to +NilClass+ in case activesupport cannot be loaded.
-
-=end
-class NilClass
-  def blank?
-    true
-  end
-end

data/lib/mobility/core_ext/string.rb

@@ -1,16 +0,0 @@
-=begin
-
-Add String methods +camelize+ and +present?+ to +String+ if activesupport
-cannot be loaded.
-
-=end
-class String
-  # paraphrased from activesupport
-  def camelize
-    sub(/^[a-z\d]*/) { $&.capitalize }.gsub(/(?:_|(\/))([a-z\d]*)/) { "#{$1}#{$2.capitalize}" }.gsub('/', '::')
-  end
-
-  def present?
-    !blank?
-  end
-end

data/lib/mobility/fallthrough_accessors.rb

@@ -1,57 +0,0 @@
-# frozen-string-literal: true
-
-module Mobility
-=begin
-
-Defines +method_missing+ and +respond_to_missing?+ methods for a set of
-attributes such that a method call using a locale accessor, like:
-
-  article.title_pt_br
-
-will return the value of +article.title+ with the locale set to +pt-BR+ around
-the method call. The class is called "FallthroughAccessors" because when
-included in a model class, locale-specific methods will be available even if
-not explicitly defined with the +locale_accessors+ option.
-
-This is a less efficient (but more open-ended) implementation of locale
-accessors, for use in cases where the locales to be used are not known when the
-model class is generated.
-
-@example Using fallthrough locales on a plain old ruby class
-  class Post
-    def title
-      "title in #{Mobility.locale}"
-    end
-    include Mobility::FallthroughAccessors.new("title")
-  end
-
-  Mobility.locale = :en
-  post = Post.new
-  post.title
-  #=> "title in en"
-  post.title_fr
-  #=> "title in fr"
-
-=end
-  class FallthroughAccessors < Module
-    # @param [String] One or more attributes
-    def initialize(*attributes)
-      method_name_regex = /\A(#{attributes.join('|'.freeze)})_([a-z]{2}(_[a-z]{2})?)(=?|\??)\z/.freeze
-
-      define_method :method_missing do |method_name, *arguments, &block|
-        if method_name =~ method_name_regex
-          attribute = $1.to_sym
-          locale, suffix = $2.split('_'.freeze)
-          locale = "#{locale}-#{suffix.upcase}".freeze if suffix
-          Mobility.with_locale(locale) { public_send("#{attribute}#{$4}".freeze, *arguments) }
-        else
-          super(method_name, *arguments, &block)
-        end
-      end
-
-      define_method :respond_to_missing? do |method_name, include_private = false|
-        (method_name =~ method_name_regex) || super(method_name, include_private)
-      end
-    end
-  end
-end

data/lib/mobility/locale_accessors.rb

@@ -1,55 +0,0 @@
-# frozen-string-literal: true
-
-module Mobility
-=begin
-
-Defines methods for a set of locales to access translated attributes in those
-locales directly with a method call, using a suffix including the locale:
-
-  article.title_pt_br
-
-If no locales are passed as an option to the initializer,
-+I18n.available_locales+ will be used by default.
-
-@example
-  class Post
-    def title
-      "title in #{Mobility.locale}"
-    end
-    include Mobility::LocaleAccessors.new("title", locales: [:en, :fr])
-  end
-
-  Mobility.locale = :en
-  post = Post.new
-  post.title
-  #=> "title in en"
-  post.title_fr
-  #=> "title in fr"
-
-=end
-  class LocaleAccessors < Module
-    # @param [String] One or more attributes
-    # @param [Array<Symbol>] Locales
-    def initialize(*attributes, locales: I18n.available_locales)
-      warning_message = "locale passed as option to locale accessor will be ignored".freeze
-
-      attributes.each do |attribute|
-        locales.each do |locale|
-          normalized_locale = Mobility.normalize_locale(locale)
-          define_method "#{attribute}_#{normalized_locale}" do |**options|
-            warn warning_message if options.delete(:locale)
-            Mobility.with_locale(locale) { send(attribute, options) }
-          end
-          define_method "#{attribute}_#{normalized_locale}?" do |**options|
-            warn warning_message if options.delete(:locale)
-            Mobility.with_locale(locale) { send("#{attribute}?", options) }
-          end
-          define_method "#{attribute}_#{normalized_locale}=" do |value, **options|
-            warn warning_message if options.delete(:locale)
-            Mobility.with_locale(locale) { send("#{attribute}=", value, options) }
-          end
-        end
-      end
-    end
-  end
-end