Class: YAML::Store
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
Constants inherited from PStore
PStore::RDWR_ACCESS, PStore::RD_ACCESS, PStore::VERSION, PStore::WR_ACCESS
Instance Attribute Summary
Attributes inherited from PStore
Instance Method Summary collapse
-
#dump(table) ⇒ Object
:stopdoc:.
- #empty_marshal_checksum ⇒ Object
- #empty_marshal_data ⇒ Object
-
#initialize(*o) ⇒ Store
constructor
:call-seq: initialize( file_name, yaml_opts = {} ) initialize( file_name, thread_safe = false, yaml_opts = {} ).
- #load(content) ⇒ Object
- #marshal_dump_supports_canonical_option? ⇒ Boolean
Methods inherited from PStore
#[], #[]=, #abort, #commit, #delete, #fetch, #key?, #keys, #path, #transaction
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().
57 58 59 60 61 62 63 |
# File 'lib/yaml/store.rb', line 57 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:
67 68 69 |
# File 'lib/yaml/store.rb', line 67 def dump(table) table.to_yaml(@opt) end |
#empty_marshal_checksum ⇒ Object
87 88 89 |
# File 'lib/yaml/store.rb', line 87 def empty_marshal_checksum CHECKSUM_ALGO.digest(empty_marshal_data) end |
#empty_marshal_data ⇒ Object
84 85 86 |
# File 'lib/yaml/store.rb', line 84 def empty_marshal_data {}.to_yaml(@opt) end |
#load(content) ⇒ Object
71 72 73 74 75 76 77 78 |
# File 'lib/yaml/store.rb', line 71 def load(content) table = YAML.respond_to?(:unsafe_load) ? YAML.unsafe_load(content) : YAML.load(content) if table == false {} else table end end |
#marshal_dump_supports_canonical_option? ⇒ Boolean
80 81 82 |
# File 'lib/yaml/store.rb', line 80 def marshal_dump_supports_canonical_option? false end |