Class: Object

Inherits:

BasicObject

Defined in:

lib/pleasant_path/json/object.rb,
lib/pleasant_path/yaml/object.rb

Instance Method Summary

• #write_to_json(file, options = {}) ⇒ self

  Writes the Object serialized as JSON to the specified file, overwriting the file if it exists.

• #write_to_yaml(file, options = {}) ⇒ self

  Writes the Object serialized as YAML to the specified file, overwriting the file if it exists.

Instance Method Details

#write_to_json(file, options = {}) ⇒ self

Writes the Object serialized as JSON to the specified file, overwriting the file if it exists. Creates the file if it does not exist, including any necessary parent directories. Returns the Object, unmodified.

For information about options see JSON.generate. By default, this method uses JSON.dump_default_options.

Examples:

{ "key" => "value" }.write_to_json("file.json")  # == { "key" => "value" }
File.read("file.json")                           # == '{"key":"value"}'

Parameters:

• file (String, Pathname)
• options (Hash{Symbol => Object}) (defaults to: {})

Returns:

• (self)

# File 'lib/pleasant_path/json/object.rb', line 21

def write_to_json(file, options = {})
  options = JSON.dump_default_options.merge(options)
  file.to_pathname.write_text(self.to_json(options))
  self
end

#write_to_yaml(file, options = {}) ⇒ self

Writes the Object serialized as YAML to the specified file, overwriting the file if it exists. Creates the file if it does not exist, including any necessary parent directories. Returns the Object, unmodified.

For information about options see YAML.dump.

Examples:

{ "key" => "value" }.write_to_yaml("file.yaml")  # == { "key" => "value" }
File.read("file.yaml")                           # == "---\nkey: value\n"

Parameters:

• file (String, Pathname)
• options (Hash{Symbol => Object}) (defaults to: {})

Returns:

• (self)

# File 'lib/pleasant_path/yaml/object.rb', line 21

def write_to_yaml(file, options = {})
  file.to_pathname.make_dirname.open("w") do |f|
    YAML.dump(self, f, options)
  end
  self
end