123456789_123456789_123456789_123456789_123456789_

Class: YAML::Store

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, PStore
Instance Chain:
self, PStore
Inherits: PStore
  • Object
Defined in: lib/yaml/store.rb

Overview

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

Class Method Summary

Instance Attribute Summary

Instance Method Summary

Constructor Details

.new(file_name, yaml_opts = {}) ⇒ Store .new(file_name, thread_safe = false, yaml_opts = {}) ⇒ Store

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

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().

[ GitHub ] 

  


# 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


  






  

  

    

      #new(file_name, yaml_opts = {})  ⇒ Store 
      #new(file_name, thread_safe = false, yaml_opts = {})  ⇒ Store 
    

  

  

    This method is for internal use only.
  



  

    

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



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().


  





  


  [ GitHub ]


  

  


# 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 Attribute Details



  

    #marshal_dump_supports_canonical_option?  ⇒ Boolean  (readonly)
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'lib/yaml/store.rb', line 88



def marshal_dump_supports_canonical_option?
  false
end


  







Instance Method Details



  

    #dump(table)  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'lib/yaml/store.rb', line 67



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


  








  

    #empty_marshal_checksum  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'lib/yaml/store.rb', line 95



def empty_marshal_checksum
  CHECKSUM_ALGO.digest(empty_marshal_data)
end


  








  

    #empty_marshal_data  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'lib/yaml/store.rb', line 92



def empty_marshal_data
  {}.to_yaml(@opt)
end


  








  

    #load(content)  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


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



def load(content)
  table =  if YAML.respond_to?(:safe_load)
    if Psych::VERSION >= "3.1"
      YAML.safe_load(content, permitted_classes: [Symbol])
    else
      YAML.safe_load(content, [Symbol])
    end
  else
    YAML.load(content)
  end
  if table == false || table == nil
    {}
  else
    table
  end
end