mobility 0.8.8 → 1.0.0.alpha

data/lib/mobility/configuration.rb

@@ -1,138 +0,0 @@
-# frozen_string_literal: true
-
-module Mobility
-=begin
-
-Stores shared Mobility configuration referenced by all backends.
-
-=end
-  class Configuration
-    RESERVED_OPTION_KEYS = %i[backend model_class].freeze
-
-    # Alias for mobility_accessor (defaults to +translates+)
-    # @return [Symbol]
-    attr_accessor :accessor_method
-
-    # Name of query scope/dataset method (defaults to +i18n+)
-    # @return [Symbol]
-    attr_accessor :query_method
-
-    # Default set of options. These will be merged with any backend options
-    # when defining translated attributes (with +translates+). Default options
-    # may not include the keys 'backend' or 'model_class'.
-    # @return [Hash]
-    attr_reader :default_options
-
-    # @deprecated The default_options= setter has been deprecated. Set each
-    #   option on the default_options hash instead.
-    def default_options=(options)
-      warn %{
-WARNING: The default_options= setter has been deprecated.
-Set each option on the default_options hash instead, like this:
-
-  config.default_options[:fallbacks] = { ... }
-  config.default_options[:dirty] = true
-}
-      if (keys = options.keys & RESERVED_OPTION_KEYS).present?
-        raise ReservedOptionKey,
-          "Default options may not contain the following reserved keys: #{keys.join(', ')}"
-      else
-        @default_options = options
-      end
-    end
-
-    # Plugins to apply. Order of plugins is important, as this becomes the
-    # order in which plugins modules are included into the backend class or
-    # attributes instance.
-    # @return [Array<Symbol>]
-    attr_accessor :plugins
-
-    # Generate new fallbacks instance
-    # @note This method will call the proc defined in the variable set by the
-    # +fallbacks_generator=+ setter, passing the first argument to its `call`
-    # method. By default the generator returns an instance of
-    # +I18n::Locale::Fallbacks+.
-    # @param fallbacks [Hash] Fallbacks hash passed to generator
-    # @return [I18n::Locale::Fallbacks]
-    def new_fallbacks(fallbacks = {})
-      @fallbacks_generator.call(fallbacks)
-    end
-
-    # Assign proc which, passed a set of fallbacks, returns a default fallbacks
-    # instance. By default this is a proc which takes fallbacks and returns an
-    # instance of +I18n::Locale::Fallbacks+.
-    # @param [Proc] fallbacks generator
-    attr_writer :fallbacks_generator
-
-    # @deprecated Use {#new_fallbacks} instead.
-    def default_fallbacks(fallbacks = {})
-      warn %{
-WARNING: The default_fallbacks configuration getter has been renamed
-new_fallbacks to avoid confusion. The original method default_fallbacks will be
-removed in the next major version of Mobility.
-}
-      new_fallbacks(fallbacks)
-    end
-
-    # @deprecated Use {#fallbacks_generator=} instead.
-    def default_fallbacks=(fallbacks)
-      warn %{
-WARNING: The default_fallbacks= configuration setter has been renamed
-fallbacks_generator= to avoid confusion. The original method
-default_fallbacks= will be removed in the next major version of Mobility.
-}
-      self.fallbacks_generator = fallbacks
-    end
-
-    # Default backend to use (can be symbol or actual backend class)
-    # @return [Symbol,Class]
-    attr_accessor :default_backend
-
-    # Returns set of default accessor locles to use (defaults to
-    # +I18n.available_locales+)
-    # @return [Array<Symbol>]
-    def default_accessor_locales
-      if @default_accessor_locales.is_a?(Proc)
-        @default_accessor_locales.call
-      else
-        @default_accessor_locales
-      end
-    end
-    attr_writer :default_accessor_locales
-
-    def initialize
-      @accessor_method = :translates
-      @query_method = :i18n
-      @fallbacks_generator = lambda { |fallbacks| Mobility::Fallbacks.build(fallbacks) }
-      @default_accessor_locales = lambda { Mobility.available_locales }
-      @default_options = Options[{
-        cache:    true,
-        presence: true,
-        query:    true,
-        default:  Plugins::OPTION_UNSET
-      }]
-      @plugins = %i[
-        query
-        cache
-        dirty
-        fallbacks
-        presence
-        default
-        attribute_methods
-        fallthrough_accessors
-        locale_accessors
-      ]
-    end
-
-    class ReservedOptionKey < Exception; end
-
-    class Options < Hash
-      def []=(key, _)
-        if RESERVED_OPTION_KEYS.include?(key)
-          raise Configuration::ReservedOptionKey, "Default options may not contain the following reserved key: #{key}"
-        end
-        super
-      end
-    end
-  end
-end

data/lib/mobility/fallbacks.rb

@@ -1,28 +0,0 @@
-module Mobility
-=begin
-
-Subclasses +I18n::Locale::Fallbacks+ such that instances of this class
-fall through to fallbacks defined in +I18n.fallbacks+. This allows models to
-customize fallbacks while still falling through to any fallbacks defined
-globally.
-
-=end
-  class Fallbacks < ::I18n::Locale::Fallbacks
-    # @param [Symbol] locale
-    # @return [Array] locales
-    def [](locale)
-      super | I18n.fallbacks[locale]
-    end
-
-    # For this set of fallbacks, return a new fallbacks hash.
-    # @param [Hash] fallbacks
-    # @return [I18n::Locale::Fallbacks,Mobility::Fallbacks] fallbacks hash
-    def self.build(fallbacks)
-      if I18n.respond_to?(:fallbacks)
-        new(fallbacks)
-      else
-        I18n::Locale::Fallbacks.new(fallbacks)
-      end
-    end
-  end
-end

data/lib/mobility/loaded.rb

@@ -1,4 +0,0 @@
-module Mobility
-  module Loaded
-  end
-end

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

@@ -1,38 +0,0 @@
-module Mobility
-  module Plugins
-    module ActiveRecord
-      module TranslatedAttributes
-        def translated_attributes
-          {}
-        end
-
-        def attributes
-          super.merge(translated_attributes)
-        end
-      end
-
-=begin
-
-Module builder adding translated attributes to #attributes hash on model
-instance. See {Mobility::Plugins::AttributeMethods} for further details.
-
-=end
-      class AttributeMethods < Module
-        def initialize(*attribute_names)
-          include TranslatedAttributes
-          define_method :translated_attributes do
-            super().merge(attribute_names.inject({}) do |attributes, name|
-              attributes.merge(name.to_s => send(name))
-            end)
-          end
-        end
-
-        def included(model_class)
-          model_class.class_eval do
-            define_method :untranslated_attributes, ::ActiveRecord::Base.instance_method(:attributes)
-          end
-        end
-      end
-    end
-  end
-end

data/lib/mobility/plugins/cache/translation_cacher.rb

@@ -1,40 +0,0 @@
-module Mobility
-  module Plugins
-    module Cache
-=begin
-
-Creates a module to cache a given translation fetch method. The cacher defines
-private methods +cache+ and +clear_cache+ to access and clear, respectively, a
-translations hash.
-
-This cacher is used to cache translation values in {Mobility::Plugins::Cache},
-and also to cache translation *records* in {Mobility::Backends::Table} and
-{Mobility::Backends::KeyValue}.
-
-=end
-      class TranslationCacher < Module
-        # @param [Symbol] fetch_method Name of translation fetch method to cache
-        def initialize(fetch_method)
-          class_eval <<-EOM, __FILE__, __LINE__ + 1
-            def #{fetch_method} locale, **options
-              return super(locale, options) if options.delete(:cache) == false
-              if cache.has_key?(locale)
-                cache[locale]
-              else
-                cache[locale] = super(locale, options)
-              end
-            end
-          EOM
-
-          include CacheMethods
-        end
-
-        module CacheMethods
-          private
-          def cache;       @cache ||= {}; end
-          def clear_cache; @cache = {};   end
-        end
-      end
-    end
-  end
-end

data/lib/mobility/sequel.rb

@@ -1,9 +0,0 @@
-module Mobility
-=begin
-
-Module loading Sequel-specific classes for Mobility models.
-
-=end
-  module Sequel
-  end
-end

data/lib/mobility/sequel/backend_resetter.rb

@@ -1,23 +0,0 @@
-module Mobility
-  module Sequel
-=begin
-
-Backend resetter for Sequel models. Triggers backend reset when +refresh+
-method is called.
-
-=end
-    class BackendResetter < Mobility::BackendResetter
-
-      # (see Mobility::BackendResetter#initialize)
-      def initialize(attribute_names, &block)
-        super
-
-        model_reset_method = @model_reset_method
-
-        define_method :refresh do
-          super().tap { instance_eval(&model_reset_method) }
-        end
-      end
-    end
-  end
-end

data/lib/mobility/translates.rb

@@ -1,73 +0,0 @@
-# frozen_string_literal: true
-
-module Mobility
-=begin
-
-Defines methods for attaching backends to a class. A block can optionally be
-passed to accessors to configure backend (see example below).
-
-@example Defining backend on a class
-  class MyClass
-    extend Translates
-    mobility_accessor :foo, option: :value
-  end
-
-@example Passing backend to a block
-  class MyClass
-    extend Translates
-    mobility_accessor :foo, option: :value do
-      # add custom code to backend class for this attribute only
-    end
-  end
-
-@example Defining only a backend reader and presence method
-  class MyClass
-    extend Translates
-    mobility_reader :foo
-  end
-
-  instance = MyClass.new
-  instance.foo         #=> (some value)
-  instance.foo?        #=> true
-  instance.foo = "foo" #=> NoMethodError
-
-@example Defining only a backend writer
-  class MyClass
-    extend Translates
-    mobility_writer :foo
-  end
-
-  instance = MyClass.new
-  instance.foo         #=> NoMethodError
-  instance.foo?        #=> NoMethodError
-  instance.foo = "foo" #=> (sets attribute to value "foo")
-=end
-  module Translates
-    # Defines mobility accessor on model class.
-    # @!method mobility_accessor(*attributes, **options)
-    #   @param [Array<String>] attributes
-    #   @param [Hash] options
-    #   @yield Yields to block with backend as context
-
-    # Defines mobility reader and presence method on model class.
-    # @!method mobility_reader(*attributes, **options)
-    #   @param [Array<String>] attributes
-    #   @param [Hash] options
-    #   @yield Yields to block with backend as context
-
-    # Defines mobility writer on model class.
-    # @!method mobility_writer(*attributes, **options)
-    #   @param [Array<String>] attributes
-    #   @param [Hash] options
-    #   @yield Yields to block with backend as context
-    %w[accessor reader writer].each do |method|
-      class_eval <<-EOM, __FILE__, __LINE__ + 1
-        def mobility_#{method}(*args, **options, &block)
-          attributes = Attributes.new(*args, method: :#{method}, **options)
-          attributes.backend.instance_eval(&block) if block_given?
-          include attributes
-        end
-      EOM
-    end
-  end
-end