aboutsummaryrefslogtreecommitdiffstats
path: root/activejob/lib/active_job/serializers/hash_serializer.rb
blob: 2bbb31946d4b8454c4f77c2d8817541c61ec794c (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
# frozen_string_literal: true

module ActiveJob
  module Serializers
    # Provides methods to serialize and deserialize `Hash` (`{key: field, ...}`)
    # Only `String` or `Symbol` can be used as a key. Values will be serialized by known serializers
    class HashSerializer < BaseSerializer
      class << self
        def serialize(hash)
          symbol_keys = hash.each_key.grep(Symbol).map(&:to_s)
          result = serialize_hash(hash)
          result[key] = symbol_keys
          result
        end

        def deserialize?(argument)
          argument.is_a?(Hash) && argument[key]
        end

        def deserialize(hash)
          result = hash.transform_values { |v| Serializers::deserialize(v) }
          symbol_keys = result.delete(key)
          transform_symbol_keys(result, symbol_keys)
        end

        private

        def key
          SYMBOL_KEYS_KEY
        end

        def serialize_hash(hash)
          hash.each_with_object({}) do |(key, value), result|
            result[serialize_hash_key(key)] = Serializers.serialize(value)
          end
        end

        def serialize_hash_key(key)
          raise SerializationError.new("Only string and symbol hash keys may be serialized as job arguments, but #{key.inspect} is a #{key.class}") unless [String, Symbol].include?(key.class)

          raise SerializationError.new("Can't serialize a Hash with reserved key #{key.inspect}") if ActiveJob::Serializers.reserved_serializers_keys.include?(key.to_s)

          key.to_s
        end

        def transform_symbol_keys(hash, symbol_keys)
          hash.transform_keys do |key|
            if symbol_keys.include?(key)
              key.to_sym
            else
              key
            end
          end
        end

        def klass
          Hash
        end
      end
    end
  end
end