Class: Struct

Inherits:
Object show all
Defined in:
lib/pp.rb,
ext/json/lib/json/add/struct.rb

Overview

:nodoc:

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.json_create(object) ⇒ Object

See #as_json.



9
10
11
# File 'ext/json/lib/json/add/struct.rb', line 9

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

Instance Method Details

#as_jsonObject

Methods Struct#as_json and Struct.json_create may be used to serialize and deserialize a Struct object; see Marshal.

Method Struct#as_json 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>


30
31
32
33
34
35
36
37
# File 'ext/json/lib/json/add/struct.rb', line 30

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

#pretty_print(q) ⇒ Object

:nodoc:



404
405
406
407
408
409
410
411
412
413
414
415
416
# File 'lib/pp.rb', line 404

def pretty_print(q) # :nodoc:
  q.group(1, sprintf("#<struct %s", PP.mcall(self, Kernel, :class).name), '>') {
    q.seplist(PP.mcall(self, Struct, :members), lambda { q.text "," }) {|member|
      q.breakable
      q.text member.to_s
      q.text '='
      q.group(1) {
        q.breakable ''
        q.pp self[member]
      }
    }
  }
end

#pretty_print_cycle(q) ⇒ Object

:nodoc:



418
419
420
# File 'lib/pp.rb', line 418

def pretty_print_cycle(q) # :nodoc:
  q.text sprintf("#<struct %s:...>", PP.mcall(self, Kernel, :class).name)
end

#to_json(*args) ⇒ Object

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}}


49
50
51
# File 'ext/json/lib/json/add/struct.rb', line 49

def to_json(*args)
  as_json.to_json(*args)
end