summaryrefslogtreecommitdiff
path: root/ext/json/lib/json/add/struct.rb
blob: 86847762ac88e4c554342d752e2b1c5e6672541c (plain)
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
#frozen_string_literal: false
unless defined?(::JSON::JSON_LOADED) and ::JSON::JSON_LOADED
  require 'json'
end

class Struct

  # See #as_json.
  def self.json_create(object)
    new(*object['v'])
  end

  # Methods <tt>Struct#as_json</tt> and +Struct.json_create+ may be used
  # to serialize and deserialize a \Struct object;
  # see Marshal[rdoc-ref:Marshal].
  #
  # \Method <tt>Struct#as_json</tt> serializes +self+,
  # returning a 2-element hash representing +self+:
  #
  #   require 'json/add/struct'
  #   Customer = Struct.new('Customer', :name, :address, :zip)
  #   x = Struct::Customer.new.as_json
  #   # => {"json_class"=>"Struct::Customer", "v"=>[nil, nil, nil]}
  #
  # \Method +JSON.create+ deserializes such a hash, returning a \Struct object:
  #
  #   Struct::Customer.json_create(x)
  #   # => #<struct Struct::Customer name=nil, address=nil, zip=nil>
  #
  def as_json(*)
    klass = self.class.name
    klass.to_s.empty? and raise JSON::JSONError, "Only named structs are supported!"
    {
      JSON.create_id => klass,
      'v'            => values,
    }
  end

  # Returns a JSON string representing +self+:
  #
  #   require 'json/add/struct'
  #   Customer = Struct.new('Customer', :name, :address, :zip)
  #   puts Struct::Customer.new.to_json
  #
  # Output:
  #
  #   {"json_class":"Struct","t":{'name':'Rowdy',"age":null}}
  #
  def to_json(*args)
    as_json.to_json(*args)
  end
end