Contents

require "yaml"

module PaperTrail
  module Serializers
    # The default serializer for, e.g. `versions.object`.
    module YAML
      E_WHERE_OBJ_CHANGES = <<-STR.squish.freeze
        where_object_changes has a known issue. When reading YAML from a text
        column, it may return more records than expected. Instead of a warning,
        this method may raise an error in the future. Please join the discussion
        at https://github.com/airblade/paper_trail/pull/997
      STR

      extend self # makes all instance methods become module methods as well

      def load(string)
        ::YAML.load string
      end

      def dump(object)
        ::YAML.dump object
      end

      # Returns a SQL LIKE condition to be used to match the given field and
      # value in the serialized object.
      def where_object_condition(arel_field, field, value)
        arel_field.matches("%\n#{field}: #{value}\n%")
      end

      # Returns a SQL LIKE condition to be used to match the given field and
      # value in the serialized `object_changes`.
      def where_object_changes_condition(arel_field, field, value)
        ::ActiveSupport::Deprecation.warn(E_WHERE_OBJ_CHANGES)

        # Need to check first (before) and secondary (after) fields
        m1 = "%\n#{field}:\n- #{value}\n%"
        m2 = "%\n#{field}:\n-%\n- #{value}\n%"
        arel_field.matches(m1).or(arel_field.matches(m2))
      end
    end
  end
end

Version data entries

4 entries across 4 versions & 1 rubygems

Version	Path
paper_trail-8.1.2	lib/paper_trail/serializers/yaml.rb
paper_trail-8.1.1	lib/paper_trail/serializers/yaml.rb
paper_trail-8.1.0	lib/paper_trail/serializers/yaml.rb
paper_trail-8.0.1	lib/paper_trail/serializers/yaml.rb