tallty_duck_record 1.0.0

data/lib/duck_record/attribute_methods/dirty.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+require "active_support/core_ext/module/attribute_accessors"
+require "duck_record/attribute_mutation_tracker"
+
+module DuckRecord
+  module AttributeMethods
+    module Dirty # :nodoc:
+      extend ActiveSupport::Concern
+
+      include ActiveModel::Dirty
+
+      def initialize_dup(other) # :nodoc:
+        super
+        @attributes = self.class._default_attributes.map do |attr|
+          attr.with_value_from_user(@attributes.fetch_value(attr.name))
+        end
+        @mutation_tracker = nil
+      end
+
+      def changes_applied
+        @previous_mutation_tracker = mutation_tracker
+        @changed_attributes = HashWithIndifferentAccess.new
+        store_original_attributes
+      end
+
+      def clear_changes_information
+        @previous_mutation_tracker = nil
+        @changed_attributes = HashWithIndifferentAccess.new
+        store_original_attributes
+      end
+
+      def raw_write_attribute(attr_name, *)
+        result = super
+        clear_attribute_change(attr_name)
+        result
+      end
+
+      def clear_attribute_changes(attr_names)
+        super
+        attr_names.each do |attr_name|
+          clear_attribute_change(attr_name)
+        end
+      end
+
+      def changed_attributes
+        # This should only be set by methods which will call changed_attributes
+        # multiple times when it is known that the computed value cannot change.
+        if defined?(@cached_changed_attributes)
+          @cached_changed_attributes
+        else
+          super.reverse_merge(mutation_tracker.changed_values).freeze
+        end
+      end
+
+      def changes
+        cache_changed_attributes do
+          super
+        end
+      end
+
+      def previous_changes
+        previous_mutation_tracker.changes
+      end
+
+      def attribute_changed_in_place?(attr_name)
+        mutation_tracker.changed_in_place?(attr_name)
+      end
+
+      private
+
+        def mutation_tracker
+          unless defined?(@mutation_tracker)
+            @mutation_tracker = nil
+          end
+          @mutation_tracker ||= AttributeMutationTracker.new(@attributes)
+        end
+
+        def changes_include?(attr_name)
+          super || mutation_tracker.changed?(attr_name)
+        end
+
+        def clear_attribute_change(attr_name)
+          mutation_tracker.forget_change(attr_name)
+        end
+
+        def store_original_attributes
+          @attributes = @attributes.map(&:forgetting_assignment)
+          @mutation_tracker = nil
+        end
+
+        def previous_mutation_tracker
+          @previous_mutation_tracker ||= NullMutationTracker.instance
+        end
+
+        def cache_changed_attributes
+          @cached_changed_attributes = changed_attributes
+          yield
+        ensure
+          clear_changed_attributes_cache
+        end
+
+        def clear_changed_attributes_cache
+          remove_instance_variable(:@cached_changed_attributes) if defined?(@cached_changed_attributes)
+        end
+    end
+  end
+end

data/lib/duck_record/attribute_methods/read.rb

@@ -0,0 +1,78 @@
+module DuckRecord
+  module AttributeMethods
+    module Read
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+        private
+
+          # We want to generate the methods via module_eval rather than
+          # define_method, because define_method is slower on dispatch.
+          # Evaluating many similar methods may use more memory as the instruction
+          # sequences are duplicated and cached (in MRI).  define_method may
+          # be slower on dispatch, but if you're careful about the closure
+          # created, then define_method will consume much less memory.
+          #
+          # But sometimes the database might return columns with
+          # characters that are not allowed in normal method names (like
+          # 'my_column(omg)'. So to work around this we first define with
+          # the __temp__ identifier, and then use alias method to rename
+          # it to what we want.
+          #
+          # We are also defining a constant to hold the frozen string of
+          # the attribute name. Using a constant means that we do not have
+          # to allocate an object on each call to the attribute method.
+          # Making it frozen means that it doesn't get duped when used to
+          # key the @attributes in read_attribute.
+          def define_method_attribute(name)
+            safe_name = name.unpack("h*".freeze).first
+            temp_method = "__temp__#{safe_name}"
+
+            DuckRecord::AttributeMethods::AttrNames.set_name_cache safe_name, name
+
+            generated_attribute_methods.module_eval <<-STR, __FILE__, __LINE__ + 1
+            def #{temp_method}
+              name = ::DuckRecord::AttributeMethods::AttrNames::ATTR_#{safe_name}
+              _read_attribute(name) { |n| missing_attribute(n, caller) }
+            end
+          STR
+
+            generated_attribute_methods.module_eval do
+              alias_method name, temp_method
+              undef_method temp_method
+            end
+          end
+      end
+
+      # Returns the value of the attribute identified by <tt>attr_name</tt> after
+      # it has been typecast (for example, "2004-12-12" in a date column is cast
+      # to a date object, like Date.new(2004, 12, 12)).
+      def read_attribute(attr_name, &block)
+        name = if self.class.attribute_alias?(attr_name)
+          self.class.attribute_alias(attr_name).to_s
+        else
+          attr_name.to_s
+        end
+
+        _read_attribute(name, &block)
+      end
+
+      # This method exists to avoid the expensive primary_key check internally, without
+      # breaking compatibility with the read_attribute API
+      if defined?(JRUBY_VERSION)
+        # This form is significantly faster on JRuby, and this is one of our biggest hotspots.
+        # https://github.com/jruby/jruby/pull/2562
+        def _read_attribute(attr_name, &block) # :nodoc
+          @attributes.fetch_value(attr_name.to_s, &block)
+        end
+      else
+        def _read_attribute(attr_name) # :nodoc:
+          @attributes.fetch_value(attr_name.to_s) { |n| yield n if block_given? }
+        end
+      end
+
+      alias :attribute :_read_attribute
+      private :attribute
+    end
+  end
+end

data/lib/duck_record/attribute_methods/serialization.rb

@@ -0,0 +1,66 @@
+module DuckRecord
+  module AttributeMethods
+    module Serialization
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+        # If you have an attribute that needs to be saved to the database as an
+        # object, and retrieved as the same object, then specify the name of that
+        # attribute using this method and it will be handled automatically. The
+        # serialization is done through YAML. If +class_name+ is specified, the
+        # serialized object must be of that class on assignment and retrieval.
+        # Otherwise SerializationTypeMismatch will be raised.
+        #
+        # Empty objects as <tt>{}</tt>, in the case of +Hash+, or <tt>[]</tt>, in the case of
+        # +Array+, will always be persisted as null.
+        #
+        # Keep in mind that database adapters handle certain serialization tasks
+        # for you. For instance: +json+ and +jsonb+ types in PostgreSQL will be
+        # converted between JSON object/array syntax and Ruby +Hash+ or +Array+
+        # objects transparently. There is no need to use #serialize in this
+        # case.
+        #
+        # For more complex cases, such as conversion to or from your application
+        # domain objects, consider using the ActiveRecord::Attributes API.
+        #
+        # ==== Parameters
+        #
+        # * +attr_name+ - The field name that should be serialized.
+        # * +class_name_or_coder+ - Optional, a coder object, which responds to +.load+ and +.dump+
+        #   or a class name that the object type should be equal to.
+        #
+        # ==== Example
+        #
+        #   # Serialize a preferences attribute.
+        #   class User < ActiveRecord::Base
+        #     serialize :preferences
+        #   end
+        #
+        #   # Serialize preferences using JSON as coder.
+        #   class User < ActiveRecord::Base
+        #     serialize :preferences, JSON
+        #   end
+        #
+        #   # Serialize preferences as Hash using YAML coder.
+        #   class User < ActiveRecord::Base
+        #     serialize :preferences, Hash
+        #   end
+        def serialize(attr_name, class_name_or_coder = Object)
+          # When ::JSON is used, force it to go through the Active Support JSON encoder
+          # to ensure special objects (e.g. Active Record models) are dumped correctly
+          # using the #as_json hook.
+          coder = if class_name_or_coder == ::JSON
+            Coders::JSON
+          elsif [:load, :dump].all? { |x| class_name_or_coder.respond_to?(x) }
+            class_name_or_coder
+          else
+            Coders::YAMLColumn.new(attr_name, class_name_or_coder)
+          end
+          decorate_attribute_type(attr_name, :serialize) do |type|
+            Type::Serialized.new(type, coder)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/duck_record/attribute_methods/write.rb

@@ -0,0 +1,70 @@
+module DuckRecord
+  module AttributeMethods
+    module Write
+      extend ActiveSupport::Concern
+
+      included do
+        attribute_method_suffix "="
+      end
+
+      module ClassMethods
+        private
+
+          def define_method_attribute=(name)
+            safe_name = name.unpack("h*".freeze).first
+            DuckRecord::AttributeMethods::AttrNames.set_name_cache safe_name, name
+
+            generated_attribute_methods.module_eval <<-STR, __FILE__, __LINE__ + 1
+            def __temp__#{safe_name}=(value)
+              name = ::DuckRecord::AttributeMethods::AttrNames::ATTR_#{safe_name}
+              write_attribute(name, value)
+            end
+            alias_method #{(name + '=').inspect}, :__temp__#{safe_name}=
+            undef_method :__temp__#{safe_name}=
+          STR
+          end
+      end
+
+      # Updates the attribute identified by <tt>attr_name</tt> with the
+      # specified +value+. Empty strings for Integer and Float columns are
+      # turned into +nil+.
+      def write_attribute(attr_name, value)
+        name =
+          if self.class.attribute_alias?(attr_name)
+            self.class.attribute_alias(attr_name).to_s
+          else
+            attr_name.to_s
+          end
+
+        if self.class.readonly_attributes.include?(name) && attr_readonly_enabled?
+          return
+        end
+
+        write_attribute_with_type_cast(name, value, true)
+      end
+
+      def raw_write_attribute(attr_name, value) # :nodoc:
+        write_attribute_with_type_cast(attr_name, value, false)
+      end
+
+      private
+
+        # Handle *= for method_missing.
+        def attribute=(attribute_name, value)
+          write_attribute(attribute_name, value)
+        end
+
+        def write_attribute_with_type_cast(attr_name, value, should_type_cast)
+          attr_name = attr_name.to_s
+
+          if should_type_cast
+            @attributes.write_from_user(attr_name, value)
+          else
+            @attributes.write_cast_value(attr_name, value)
+          end
+
+          value
+        end
+    end
+  end
+end

data/lib/duck_record/attribute_mutation_tracker.rb

@@ -0,0 +1,108 @@
+module DuckRecord
+  class AttributeMutationTracker # :nodoc:
+    OPTION_NOT_GIVEN = Object.new
+
+    def initialize(attributes)
+      @attributes = attributes
+      @forced_changes = Set.new
+    end
+
+    def changed_values
+      attr_names.each_with_object({}.with_indifferent_access) do |attr_name, result|
+        if changed?(attr_name)
+          result[attr_name] = attributes[attr_name].original_value
+        end
+      end
+    end
+
+    def changes
+      attr_names.each_with_object({}.with_indifferent_access) do |attr_name, result|
+        change = change_to_attribute(attr_name)
+        if change
+          result[attr_name] = change
+        end
+      end
+    end
+
+    def change_to_attribute(attr_name)
+      if changed?(attr_name)
+        [attributes[attr_name].original_value, attributes.fetch_value(attr_name)]
+      end
+    end
+
+    def any_changes?
+      attr_names.any? { |attr| changed?(attr) }
+    end
+
+    def changed?(attr_name, from: OPTION_NOT_GIVEN, to: OPTION_NOT_GIVEN)
+      attr_name = attr_name.to_s
+      forced_changes.include?(attr_name) ||
+        attributes[attr_name].changed? &&
+        (OPTION_NOT_GIVEN == from || attributes[attr_name].original_value == from) &&
+        (OPTION_NOT_GIVEN == to || attributes[attr_name].value == to)
+    end
+
+    def changed_in_place?(attr_name)
+      attributes[attr_name].changed_in_place?
+    end
+
+    def forget_change(attr_name)
+      attr_name = attr_name.to_s
+      attributes[attr_name] = attributes[attr_name].forgetting_assignment
+      forced_changes.delete(attr_name)
+    end
+
+    def original_value(attr_name)
+      attributes[attr_name].original_value
+    end
+
+    def force_change(attr_name)
+      forced_changes << attr_name.to_s
+    end
+
+    # TODO Change this to private once we've dropped Ruby 2.2 support.
+    # Workaround for Ruby 2.2 "private attribute?" warning.
+    protected
+
+      attr_reader :attributes, :forced_changes
+
+    private
+
+      def attr_names
+        attributes.keys
+      end
+  end
+
+  class NullMutationTracker # :nodoc:
+    include Singleton
+
+    def changed_values(*)
+      {}
+    end
+
+    def changes(*)
+      {}
+    end
+
+    def change_to_attribute(_)
+    end
+
+    def any_changes?(*)
+      false
+    end
+
+    def changed?(*)
+      false
+    end
+
+    def changed_in_place?(*)
+      false
+    end
+
+    def forget_change(*)
+    end
+
+    def original_value(*)
+    end
+  end
+end

data/lib/duck_record/attribute_set.rb

@@ -0,0 +1,98 @@
+require "duck_record/attribute_set/yaml_encoder"
+
+module DuckRecord
+  class AttributeSet # :nodoc:
+    delegate :each_value, :fetch, to: :attributes
+
+    def initialize(attributes)
+      @attributes = attributes
+    end
+
+    def [](name)
+      attributes[name] || Attribute.null(name)
+    end
+
+    def []=(name, value)
+      attributes[name] = value
+    end
+
+    def values_before_type_cast
+      attributes.transform_values(&:value_before_type_cast)
+    end
+
+    def to_hash
+      initialized_attributes.transform_values(&:value)
+    end
+    alias_method :to_h, :to_hash
+
+    def key?(name)
+      attributes.key?(name) && self[name].initialized?
+    end
+
+    def keys
+      attributes.each_key.select { |name| self[name].initialized? }
+    end
+
+    if defined?(JRUBY_VERSION)
+      # This form is significantly faster on JRuby, and this is one of our biggest hotspots.
+      # https://github.com/jruby/jruby/pull/2562
+      def fetch_value(name, &block)
+        self[name].value(&block)
+      end
+    else
+      def fetch_value(name)
+        self[name].value { |n| yield n if block_given? }
+      end
+    end
+
+    def write_from_user(name, value)
+      attributes[name] = self[name].with_value_from_user(value)
+    end
+
+    def write_cast_value(name, value)
+      attributes[name] = self[name].with_cast_value(value)
+    end
+
+    def freeze
+      @attributes.freeze
+      super
+    end
+
+    def deep_dup
+      dup.tap do |copy|
+        copy.instance_variable_set(:@attributes, attributes.deep_dup)
+      end
+    end
+
+    def initialize_dup(_)
+      @attributes = attributes.dup
+      super
+    end
+
+    def initialize_clone(_)
+      @attributes = attributes.clone
+      super
+    end
+
+    def map(&block)
+      new_attributes = attributes.transform_values(&block)
+      AttributeSet.new(new_attributes)
+    end
+
+    def ==(other)
+      attributes == other.attributes
+    end
+
+    # TODO Change this to private once we've dropped Ruby 2.2 support.
+    # Workaround for Ruby 2.2 "private attribute?" warning.
+    protected
+
+      attr_reader :attributes
+
+    private
+
+      def initialized_attributes
+        attributes.select { |_, attr| attr.initialized? }
+      end
+  end
+end