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

Instance Method Summary collapse

Constructor Details

#initialize(*o) ⇒ Store

:call-seq:

initialize( file_name, yaml_opts = {} )
initialize( file_name, thread_safe = false, 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.

YAML::Store objects are always reentrant. But if thread_safe is set to true, then it will become thread-safe at the cost of a minor performance hit.

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


53
54
55
56
57
58
59
# File 'lib/yaml/store.rb', line 53

def initialize( *o )
  @opt = {}
  if o.last.is_a? Hash
    @opt.update(o.pop)
  end
  super(*o)
end

Instance Method Details

#dump(table) ⇒ Object

:stopdoc:


63
64
65
# File 'lib/yaml/store.rb', line 63

def dump(table)
  table.to_yaml(@opt)
end

#empty_marshal_checksumObject


83
84
85
# File 'lib/yaml/store.rb', line 83

def empty_marshal_checksum
  CHECKSUM_ALGO.digest(empty_marshal_data)
end

#empty_marshal_dataObject


80
81
82
# File 'lib/yaml/store.rb', line 80

def empty_marshal_data
  {}.to_yaml(@opt)
end

#load(content) ⇒ Object


67
68
69
70
71
72
73
74
# File 'lib/yaml/store.rb', line 67

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

#marshal_dump_supports_canonical_option?Boolean

Returns:

  • (Boolean)

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

def marshal_dump_supports_canonical_option?
  false
end