123456789_123456789_123456789_123456789_123456789_

Class: JSON::Coder

Relationships & Source Files
Inherits: Object
Defined in: ext/json/lib/json/common.rb

Overview

Coder holds a parser and generator configuration.

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

MyApp::JSONC_CODER.load(document)

Constant Summary

Class Method Summary

Constructor Details

.new(**options, &block) (private)

Keyword arguments options, if given, are 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 encountered, 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"

[ GitHub ] 

  


# File 'ext/json/lib/json/common.rb', line 838



def initialize(object_class: nil, array_class: nil, on_load: nil, **options, &as_json)
  if object_class || array_class
    on_load = ParserOptions.on_load(on_load, object_class, array_class)
  end
  parser_options = options.slice(*PARSER_OPTIONS)
  parser_options[:on_load] = on_load if on_load
  @parser_config = Ext::Parser::Config.new(parser_options).freeze

  generator_options = options.reject { |k, _| EXCLUDED_GENERATOR_OPTIONS.include?(k) }
  @state = State.new(
    **generator_options,
    strict: true,
    as_json: as_json,
  ).freeze
end


  







Class Method Details



  

    

      .dump(object)  ⇒ String  (mod_func)
      .dump(object, io)  ⇒ IO 
    

    Also known as: .generate
  



  

    
Serialize the given object into a JSON document.

  





  


  [ GitHub ]


  

  


# File 'ext/json/lib/json/common.rb', line 859



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


  








  

    .generate(object, io = nil)   (mod_func)
  



  

    
Alias for #dump.

  



  [ GitHub ]


  

  


# File 'ext/json/lib/json/common.rb', line 862



alias_method :generate, :dump


  








  

    .new(**options, &block)   (mod_func)  



  

    
Keyword arguments options, if given, are 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
encountered, 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"

  



  [ GitHub ]


  

  


# File 'ext/json/lib/json/common.rb', line 838



def initialize(object_class: nil, array_class: nil, on_load: nil, **options, &as_json)
  if object_class || array_class
    on_load = ParserOptions.on_load(on_load, object_class, array_class)
  end
  parser_options = options.slice(*PARSER_OPTIONS)
  parser_options[:on_load] = on_load if on_load
  @parser_config = Ext::Parser::Config.new(parser_options).freeze

  generator_options = options.reject { |k, _| EXCLUDED_GENERATOR_OPTIONS.include?(k) }
  @state = State.new(
    **generator_options,
    strict: true,
    as_json: as_json,
  ).freeze
end


  








  

    .load(string)  ⇒ Object  (mod_func)    Also known as: .parse
  



  

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

  



  [ GitHub ]


  

  


# File 'ext/json/lib/json/common.rb', line 868



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


  








  

    .load(path)  ⇒ Object  (mod_func)  



  

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

  



  [ GitHub ]


  

  


# File 'ext/json/lib/json/common.rb', line 877



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


  








  

    .parse(source)   (mod_func)
  



  

    
Alias for #load.

  



  [ GitHub ]


  

  


# File 'ext/json/lib/json/common.rb', line 871



alias_method :parse, :load