all_futures 1.0.2 → 2.0.0

data/lib/vendor/active_entity/store.rb

@@ -0,0 +1,291 @@
+# frozen_string_literal: true
+
+require "active_support/core_ext/hash/indifferent_access"
+
+module ActiveEntity
+  # Store gives you a thin wrapper around serialize for the purpose of storing hashes in a single column.
+  # It's like a simple key/value store baked into your record when you don't care about being able to
+  # query that store outside the context of a single record.
+  #
+  # You can then declare accessors to this store that are then accessible just like any other attribute
+  # of the model. This is very helpful for easily exposing store keys to a form or elsewhere that's
+  # already built around just accessing attributes on the model.
+  #
+  # Every accessor comes with dirty tracking methods (+key_changed?+, +key_was+ and +key_change+) and
+  # methods to access the changes made during the last save (+saved_change_to_key?+, +saved_change_to_key+ and
+  # +key_before_last_save+).
+  #
+  # NOTE: There is no +key_will_change!+ method for accessors, use +store_will_change!+ instead.
+  #
+  # Make sure that you declare the database column used for the serialized store as a text, so there's
+  # plenty of room.
+  #
+  # You can set custom coder to encode/decode your serialized attributes to/from different formats.
+  # JSON, YAML, Marshal are supported out of the box. Generally it can be any wrapper that provides +load+ and +dump+.
+  #
+  # NOTE: If you are using structured database data types (e.g. PostgreSQL +hstore+/+json+, or MySQL 5.7+
+  # +json+) there is no need for the serialization provided by {.store}[rdoc-ref:rdoc-ref:ClassMethods#store].
+  # Simply use {.store_accessor}[rdoc-ref:ClassMethods#store_accessor] instead to generate
+  # the accessor methods. Be aware that these columns use a string keyed hash and do not allow access
+  # using a symbol.
+  #
+  # NOTE: The default validations with the exception of +uniqueness+ will work.
+  # For example, if you want to check for +uniqueness+ with +hstore+ you will
+  # need to use a custom validation to handle it.
+  #
+  # Examples:
+  #
+  #   class User < ActiveEntity::Base
+  #     store :settings, accessors: [ :color, :homepage ], coder: JSON
+  #     store :parent, accessors: [ :name ], coder: JSON, prefix: true
+  #     store :spouse, accessors: [ :name ], coder: JSON, prefix: :partner
+  #     store :settings, accessors: [ :two_factor_auth ], suffix: true
+  #     store :settings, accessors: [ :login_retry ], suffix: :config
+  #   end
+  #
+  #   u = User.new(color: 'black', homepage: '37signals.com', parent_name: 'Mary', partner_name: 'Lily')
+  #   u.color                          # Accessor stored attribute
+  #   u.parent_name                    # Accessor stored attribute with prefix
+  #   u.partner_name                   # Accessor stored attribute with custom prefix
+  #   u.two_factor_auth_settings       # Accessor stored attribute with suffix
+  #   u.login_retry_config             # Accessor stored attribute with custom suffix
+  #   u.settings[:country] = 'Denmark' # Any attribute, even if not specified with an accessor
+  #
+  #   # There is no difference between strings and symbols for accessing custom attributes
+  #   u.settings[:country]  # => 'Denmark'
+  #   u.settings['country'] # => 'Denmark'
+  #
+  #   # Dirty tracking
+  #   u.color = 'green'
+  #   u.color_changed? # => true
+  #   u.color_was # => 'black'
+  #   u.color_change # => ['black', 'red']
+  #
+  #   # Add additional accessors to an existing store through store_accessor
+  #   class SuperUser < User
+  #     store_accessor :settings, :privileges, :servants
+  #     store_accessor :parent, :birthday, prefix: true
+  #     store_accessor :settings, :secret_question, suffix: :config
+  #   end
+  #
+  # The stored attribute names can be retrieved using {.stored_attributes}[rdoc-ref:rdoc-ref:ClassMethods#stored_attributes].
+  #
+  #   User.stored_attributes[:settings] # [:color, :homepage, :two_factor_auth, :login_retry]
+  #
+  # == Overwriting default accessors
+  #
+  # All stored values are automatically available through accessors on the Active Entity
+  # object, but sometimes you want to specialize this behavior. This can be done by overwriting
+  # the default accessors (using the same name as the attribute) and calling <tt>super</tt>
+  # to actually change things.
+  #
+  #   class Song < ActiveEntity::Base
+  #     # Uses a stored integer to hold the volume adjustment of the song
+  #     store :settings, accessors: [:volume_adjustment]
+  #
+  #     def volume_adjustment=(decibels)
+  #       super(decibels.to_i)
+  #     end
+  #
+  #     def volume_adjustment
+  #       super.to_i
+  #     end
+  #   end
+  module Store
+    extend ActiveSupport::Concern
+
+    included do
+      class << self
+        attr_accessor :local_stored_attributes
+      end
+    end
+
+    module ClassMethods
+      def store(store_attribute, options = {})
+        serialize store_attribute, IndifferentCoder.new(store_attribute, options[:coder])
+        store_accessor(store_attribute, options[:accessors], **options.slice(:prefix, :suffix)) if options.has_key? :accessors
+      end
+
+      def store_accessor(store_attribute, *keys, prefix: nil, suffix: nil)
+        keys = keys.flatten
+
+        accessor_prefix =
+          case prefix
+          when String, Symbol
+            "#{prefix}_"
+          when TrueClass
+            "#{store_attribute}_"
+          else
+            ""
+          end
+        accessor_suffix =
+          case suffix
+          when String, Symbol
+            "_#{suffix}"
+          when TrueClass
+            "_#{store_attribute}"
+          else
+            ""
+          end
+
+        _store_accessors_module.module_eval do
+          keys.each do |key|
+            accessor_key = "#{accessor_prefix}#{key}#{accessor_suffix}"
+
+            define_method("#{accessor_key}=") do |value|
+              write_store_attribute(store_attribute, key, value)
+            end
+
+            define_method(accessor_key) do
+              read_store_attribute(store_attribute, key)
+            end
+
+            define_method("#{accessor_key}_changed?") do
+              return false unless attribute_changed?(store_attribute)
+              prev_store, new_store = changes[store_attribute]
+              prev_store&.dig(key) != new_store&.dig(key)
+            end
+
+            define_method("#{accessor_key}_change") do
+              return unless attribute_changed?(store_attribute)
+              prev_store, new_store = changes[store_attribute]
+              [prev_store&.dig(key), new_store&.dig(key)]
+            end
+
+            define_method("#{accessor_key}_was") do
+              return unless attribute_changed?(store_attribute)
+              prev_store, _new_store = changes[store_attribute]
+              prev_store&.dig(key)
+            end
+
+            define_method("saved_change_to_#{accessor_key}?") do
+              return false unless saved_change_to_attribute?(store_attribute)
+              prev_store, new_store = saved_change_to_attribute(store_attribute)
+              prev_store&.dig(key) != new_store&.dig(key)
+            end
+
+            define_method("saved_change_to_#{accessor_key}") do
+              return unless saved_change_to_attribute?(store_attribute)
+              prev_store, new_store = saved_change_to_attribute(store_attribute)
+              [prev_store&.dig(key), new_store&.dig(key)]
+            end
+
+            define_method("#{accessor_key}_before_last_save") do
+              return unless saved_change_to_attribute?(store_attribute)
+              prev_store, _new_store = saved_change_to_attribute(store_attribute)
+              prev_store&.dig(key)
+            end
+          end
+        end
+
+        # assign new store attribute and create new hash to ensure that each class in the hierarchy
+        # has its own hash of stored attributes.
+        self.local_stored_attributes ||= {}
+        self.local_stored_attributes[store_attribute] ||= []
+        self.local_stored_attributes[store_attribute] |= keys
+      end
+
+      def _store_accessors_module # :nodoc:
+        @_store_accessors_module ||= begin
+          mod = Module.new
+          include mod
+          mod
+        end
+      end
+
+      def stored_attributes
+        parent = superclass.respond_to?(:stored_attributes) ? superclass.stored_attributes : {}
+        if local_stored_attributes
+          parent.merge!(local_stored_attributes) { |k, a, b| a | b }
+        end
+        parent
+      end
+    end
+
+    private
+
+      def read_store_attribute(store_attribute, key) # :doc:
+        accessor = store_accessor_for(store_attribute)
+        accessor.read(self, store_attribute, key)
+      end
+
+      def write_store_attribute(store_attribute, key, value) # :doc:
+        accessor = store_accessor_for(store_attribute)
+        accessor.write(self, store_attribute, key, value)
+      end
+
+      def store_accessor_for(store_attribute)
+        type_for_attribute(store_attribute).accessor
+      end
+
+      class HashAccessor # :nodoc:
+        def self.read(object, attribute, key)
+          prepare(object, attribute)
+          object.public_send(attribute)[key]
+        end
+
+        def self.write(object, attribute, key, value)
+          prepare(object, attribute)
+          if value != read(object, attribute, key)
+            object.public_send :"#{attribute}_will_change!"
+            object.public_send(attribute)[key] = value
+          end
+        end
+
+        def self.prepare(object, attribute)
+          object.public_send :"#{attribute}=", {} unless object.send(attribute)
+        end
+      end
+
+      class StringKeyedHashAccessor < HashAccessor # :nodoc:
+        def self.read(object, attribute, key)
+          super object, attribute, key.to_s
+        end
+
+        def self.write(object, attribute, key, value)
+          super object, attribute, key.to_s, value
+        end
+      end
+
+      class IndifferentHashAccessor < ActiveEntity::Store::HashAccessor # :nodoc:
+        def self.prepare(object, store_attribute)
+          attribute = object.send(store_attribute)
+          unless attribute.is_a?(ActiveSupport::HashWithIndifferentAccess)
+            attribute = IndifferentCoder.as_indifferent_hash(attribute)
+            object.send :"#{store_attribute}=", attribute
+          end
+          attribute
+        end
+      end
+
+      class IndifferentCoder # :nodoc:
+        def initialize(attr_name, coder_or_class_name)
+          @coder =
+            if coder_or_class_name.respond_to?(:load) && coder_or_class_name.respond_to?(:dump)
+              coder_or_class_name
+            else
+              ActiveEntity::Coders::YAMLColumn.new(attr_name, coder_or_class_name || Object)
+            end
+        end
+
+        def dump(obj)
+          @coder.dump self.class.as_indifferent_hash(obj)
+        end
+
+        def load(yaml)
+          self.class.as_indifferent_hash(@coder.load(yaml || ""))
+        end
+
+        def self.as_indifferent_hash(obj)
+          case obj
+          when ActiveSupport::HashWithIndifferentAccess
+            obj
+          when Hash
+            obj.with_indifferent_access
+          else
+            ActiveSupport::HashWithIndifferentAccess.new
+          end
+        end
+      end
+  end
+end

data/lib/vendor/active_entity/translation.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module ActiveEntity
+  module Translation
+    include ActiveModel::Translation
+
+    # Set the lookup ancestors for ActiveModel.
+    def lookup_ancestors #:nodoc:
+      klass = self
+      classes = [klass]
+      return classes if klass == ActiveEntity::Base
+
+      while !klass.base_class?
+        classes << klass = klass.superclass
+      end
+      classes
+    end
+
+    # Set the i18n scope to overwrite ActiveModel.
+    def i18n_scope #:nodoc:
+      :active_entity
+    end
+  end
+end

data/lib/vendor/active_entity/type/date.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module ActiveEntity
+  module Type
+    class Date < ActiveModel::Type::Date
+      include Internal::Timezone
+    end
+  end
+end

data/lib/vendor/active_entity/type/date_time.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module ActiveEntity
+  module Type
+    class DateTime < ActiveModel::Type::DateTime
+      include Internal::Timezone
+    end
+  end
+end

data/lib/vendor/active_entity/type/internal/timezone.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module ActiveEntity
+  module Type
+    module Internal
+      module Timezone
+        def is_utc?
+          ActiveEntity::Base.default_timezone == :utc
+        end
+
+        def default_timezone
+          ActiveEntity::Base.default_timezone
+        end
+      end
+    end
+  end
+end

data/lib/vendor/active_entity/type/json.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module ActiveEntity
+  module Type
+    class Json < ActiveModel::Type::Value
+      include ActiveModel::Type::Helpers::Mutable
+
+      def type
+        :json
+      end
+
+      def deserialize(value)
+        return value unless value.is_a?(::String)
+        ActiveSupport::JSON.decode(value) rescue nil
+      end
+
+      def serialize(value)
+        ActiveSupport::JSON.encode(value) unless value.nil?
+      end
+
+      def changed_in_place?(raw_old_value, new_value)
+        deserialize(raw_old_value) != new_value
+      end
+
+      def accessor
+        ActiveEntity::Store::StringKeyedHashAccessor
+      end
+    end
+  end
+end

data/lib/vendor/active_entity/type/modifiers/array.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module ActiveEntity
+  module Type
+    module Modifiers
+      class Array < ActiveModel::Type::Value # :nodoc:
+        include ActiveModel::Type::Helpers::Mutable
+
+        attr_reader :subtype, :delimiter
+        delegate :type, :user_input_in_time_zone, :limit, :precision, :scale, to: :subtype
+
+        def initialize(subtype, delimiter = ",")
+          @subtype = subtype
+          @delimiter = delimiter
+        end
+
+        def deserialize(value)
+          case value
+          when ::String
+            type_cast_array(value.split(@delimiter), :deserialize)
+          else
+            super
+          end
+        end
+
+        def cast(value)
+          if value.is_a?(::String)
+            value = value.split(@delimiter)
+          end
+          type_cast_array(value, :cast)
+        end
+
+        def serialize(value)
+          if value.is_a?(::Array)
+            casted_values = type_cast_array(value, :serialize)
+            casted_values.join(@delimiter)
+          else
+            super
+          end
+        end
+
+        def ==(other)
+          other.is_a?(Array) &&
+            subtype == other.subtype &&
+            delimiter == other.delimiter
+        end
+
+        def map(value, &block)
+          value.map(&block)
+        end
+
+        def changed_in_place?(raw_old_value, new_value)
+          deserialize(raw_old_value) != new_value
+        end
+
+        def force_equality?(value)
+          value.is_a?(::Array)
+        end
+
+        private
+
+          def type_cast_array(value, method)
+            if value.is_a?(::Array)
+              value.map { |item| type_cast_array(item, method) }
+            else
+              @subtype.public_send(method, value)
+            end
+          end
+      end
+    end
+  end
+end

data/lib/vendor/active_entity/type/modifiers/array_without_blank.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module ActiveEntity
+  module Type
+    module Modifiers
+      class ArrayWithoutBlank < Array # :nodoc:
+        private
+
+          def type_cast_array(value, method)
+            if value.is_a?(::Array)
+              ::ArrayWithoutBlank.new value.map { |item| type_cast_array(item, method) }
+            else
+              @subtype.public_send(method, value)
+            end
+          end
+      end
+    end
+  end
+end

data/lib/vendor/active_entity/type/registry.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+module ActiveEntity
+  # :stopdoc:
+  module Type
+    class Registry # :nodoc:
+      def initialize
+        @registrations = []
+      end
+
+      def initialize_copy(_other)
+        @registrations = @registrations.dup
+      end
+
+      def add_modifier(options, klass, **_args)
+        registrations << DecorationRegistration.new(options, klass)
+      end
+
+      def register(type_name, klass = nil, **options, &block)
+        unless block_given?
+          block = proc { |_, *args| klass.new(*args) }
+          block.ruby2_keywords if block.respond_to?(:ruby2_keywords)
+        end
+        registrations << Registration.new(type_name, block, **options)
+      end
+
+      def lookup(symbol, *args, **kwargs)
+        registration = find_registration(symbol, *args, **kwargs)
+
+        if registration
+          registration.call(self, symbol, *args, **kwargs)
+        else
+          raise ArgumentError, "Unknown type #{symbol.inspect}"
+        end
+      end
+
+      private
+
+        attr_reader :registrations
+
+        def find_registration(symbol, *args, **kwargs)
+          registrations
+            .select { |registration| registration.matches?(symbol, *args, **kwargs) }
+            .max
+        end
+    end
+
+    class Registration # :nodoc:
+      def initialize(name, block, override: nil)
+        @name = name
+        @block = block
+        @override = override
+      end
+
+      def call(_registry, *args, **kwargs)
+        if kwargs.any? # https://bugs.ruby-lang.org/issues/10856
+          block.call(*args, **kwargs)
+        else
+          block.call(*args)
+        end
+      end
+
+      def matches?(type_name, *args, **kwargs)
+        type_name == name
+      end
+
+      def <=>(other)
+        priority <=> other.priority
+      end
+
+      protected
+
+        attr_reader :name, :block, :override
+
+        def priority
+          override ? 1 : 0
+        end
+    end
+
+    class DecorationRegistration < Registration # :nodoc:
+      def initialize(options, klass, **)
+        @options = options
+        @klass = klass
+      end
+
+      def call(registry, *args, **kwargs)
+        subtype = registry.lookup(*args, **kwargs.except(*options.keys))
+        klass.new(subtype)
+      end
+
+      def matches?(*args, **kwargs)
+        matches_options?(**kwargs)
+      end
+
+      def priority
+        super | 4
+      end
+
+      private
+
+        attr_reader :options, :klass
+
+        def matches_options?(**kwargs)
+          options.all? do |key, value|
+            kwargs[key] == value
+          end
+        end
+    end
+  end
+
+  # :startdoc:
+end

data/lib/vendor/active_entity/type/serialized.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module ActiveEntity
+  module Type
+    class Serialized < DelegateClass(ActiveModel::Type::Value) # :nodoc:
+      undef to_yaml if method_defined?(:to_yaml)
+
+      include ActiveModel::Type::Helpers::Mutable
+
+      attr_reader :subtype, :coder
+
+      def initialize(subtype, coder)
+        @subtype = subtype
+        @coder = coder
+        super(subtype)
+      end
+
+      def deserialize(value)
+        if default_value?(value)
+          value
+        else
+          coder.load(super)
+        end
+      end
+
+      def serialize(value)
+        return if value.nil?
+        unless default_value?(value)
+          super coder.dump(value)
+        end
+      end
+
+      def inspect
+        Kernel.instance_method(:inspect).bind(self).call
+      end
+
+      def changed_in_place?(raw_old_value, value)
+        return false if value.nil?
+        raw_new_value = encoded(value)
+        raw_old_value.nil? != raw_new_value.nil? ||
+          subtype.changed_in_place?(raw_old_value, raw_new_value)
+      end
+
+      def accessor
+        ActiveEntity::Store::IndifferentHashAccessor
+      end
+
+      def assert_valid_value(value)
+        if coder.respond_to?(:assert_valid_value)
+          coder.assert_valid_value(value, action: "serialize")
+        end
+      end
+
+      def force_equality?(value)
+        coder.respond_to?(:object_class) && value.is_a?(coder.object_class)
+      end
+
+      private
+
+        def default_value?(value)
+          value == coder.load(nil)
+        end
+
+        def encoded(value)
+          unless default_value?(value)
+            coder.dump(value)
+          end
+        end
+    end
+  end
+end

data/lib/vendor/active_entity/type/text.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module ActiveEntity
+  module Type
+    class Text < ActiveModel::Type::String # :nodoc:
+      def type
+        :text
+      end
+    end
+  end
+end

data/lib/vendor/active_entity/type/time.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module ActiveEntity
+  module Type
+    class Time < ActiveModel::Type::Time
+      include Internal::Timezone
+
+      class Value < DelegateClass(::Time) # :nodoc:
+      end
+
+      def serialize(value)
+        case value = super
+        when ::Time
+          Value.new(value)
+        else
+          value
+        end
+      end
+    end
+  end
+end