Class: YAML::Store

Inherits:
PStore
  • Object
show all
Defined in:
lib/yaml/store.rb

Overview

YAML::Store provides the same functionality as PStore, except it uses YAML to dump objects instead of Marshal.

Example

require 'yaml/store'

Person = Struct.new :first_name, :last_name

people = [Person.new("Bob", "Smith"), Person.new("Mary", "Johnson")]

store = YAML::Store.new "test.store"

store.transaction do
  store["people"] = people
  store["greeting"] = { "hello" => "world" }
end

After running the above code, the contents of “test.store” will be:

---
people:
- !ruby/struct:Person
  first_name: Bob
  last_name: Smith
- !ruby/struct:Person
  first_name: Mary
  last_name: Johnson
greeting:
  hello: world

Constant Summary collapse

EMPTY_MARSHAL_DATA = 
YAML.dump({})
EMPTY_MARSHAL_CHECKSUM = 
Digest::MD5.digest(EMPTY_MARSHAL_DATA)

Instance Method Summary collapse

Constructor Details

#initialize(file_name, yaml_opts = {}) ⇒ Store

:call-seq:

initialize( file_name, yaml_opts = {} )

Creates a new YAML::Store object, which will store data in file_name. If the file does not already exist, it will be created.

Options passed in through yaml_opts will be used when converting the store to YAML via Hash#to_yaml().



49
50
51
52
 
# File 'lib/yaml/store.rb', line 49

def initialize file_name, yaml_opts = {}
  @opt = yaml_opts
  super
end

Instance Method Details

#dump(table) ⇒ Object

:stopdoc:



56
57
58
 
# File 'lib/yaml/store.rb', line 56

def dump(table)
  YAML.dump @table
end

#empty_marshal_checksum ⇒ Object 



78
79
80
 
# File 'lib/yaml/store.rb', line 78

def empty_marshal_checksum
  EMPTY_MARSHAL_CHECKSUM
end

#empty_marshal_data ⇒ Object 



75
76
77
 
# File 'lib/yaml/store.rb', line 75

def empty_marshal_data
  EMPTY_MARSHAL_DATA
end

#load(content) ⇒ Object 



60
61
62
63
64
65
66
67
 
# File 'lib/yaml/store.rb', line 60

def load(content)
  table = YAML.load(content)
  if table == false
    {}
  else
    table
  end
end

#marshal_dump_supports_canonical_option? ⇒ Boolean

Returns:

  • (Boolean) 


69
70
71
 
# File 'lib/yaml/store.rb', line 69

def marshal_dump_supports_canonical_option?
  false
end