Class: JSON::Coder

Inherits:
Object
  • Object
show all
Defined in:
lib/json/common.rb

Overview

JSON::Coder holds a parser and generator configuration.

module MyApp
  JSONC_CODER = JSON::Coder.new(
    allow_trailing_comma: true
  )
end

MyApp::JSONC_CODER.load(document)

Instance Method Summary collapse

Constructor Details

#initialize(options = nil, &as_json) ⇒ Coder

:call-seq:

JSON.new(options = nil, &block)

Argument options, if given, contains a Hash of options for both parsing and generating. See Parsing Options, and Generating Options.

For generation, the strict: true option is always set. When a Ruby object with no native JSON counterpart is encoutered, the block provided to the initialize method is invoked, and must return a Ruby object that has a native JSON counterpart:

module MyApp
  API_JSON_CODER = JSON::Coder.new do |object|
    case object
    when Time
      object.iso8601(3)
    else
      object # Unknown type, will raise
    end
  end
end

puts MyApp::API_JSON_CODER.dump(Time.now.utc) # => "2025-01-21T08:41:44.286Z"



1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
 
# File 'lib/json/common.rb', line 1018

def initialize(options = nil, &as_json)
  if options.nil?
    options = { strict: true }
  else
    options = options.dup
    options[:strict] = true
  end
  options[:as_json] = as_json if as_json

  @state = State.new(options).freeze
  @parser_config = Ext::Parser::Config.new(ParserOptions.prepare(options))
end

Instance Method Details

#dump(object, io = nil) ⇒ Object Also known as: generate

call-seq:

dump(object) -> String
dump(object, io) -> io

Serialize the given object into a JSON document.



1036
1037
1038
 
# File 'lib/json/common.rb', line 1036

def dump(object, io = nil)
  @state.generate_new(object, io)
end

#load(source) ⇒ Object Also known as: parse

call-seq:

load(string) -> Object

Parse the given JSON document and return an equivalent Ruby object.



1045
1046
1047
 
# File 'lib/json/common.rb', line 1045

def load(source)
  @parser_config.parse(source)
end

#load_file(path) ⇒ Object

call-seq:

load(path) -> Object

Parse the given JSON document and return an equivalent Ruby object.



1054
1055
1056
 
# File 'lib/json/common.rb', line 1054

def load_file(path)
  load(File.read(path, encoding: Encoding::UTF_8))
end