# = PStore -- Transactional File Storage for Ruby Objects
# documentation by Kev Jackson and James Edward Gray II
# See PStore for documentation.
# PStore implements a file based persistence mechanism based on a Hash. User
# code can store hierarchies of Ruby objects (values) into the data store file
# by name (keys). An object hierarchy may be just a single object. User code
# may later read values back from the data store or even update data, as needed.
# The transactional behavior ensures that any changes succeed or fail together.
# This can be used to ensure that the data store is not left in a transitory
# state, where some values were updated but others were not.
# Behind the scenes, Ruby objects are stored to the data store file with
# Marshal. That carries the usual limitations. Proc objects cannot be
# marshalled, for example.
# # a mock wiki object...
# def initialize( page_name, author, contents )
# add_revision(author, contents)
# def add_revision( author, contents )
# @revisions << { :created => Time.now,
# :contents => contents }
# def wiki_page_references
# [@page_name] + @revisions.last[:contents].scan(/\b(?:[A-Z]+[a-z]+){2,}/)
# home_page = WikiPage.new( "HomePage", "James Edward Gray II",
# "A page about the JoysOfDocumentation..." )
# # then we want to update page data and the index together, or not at all...
# wiki = PStore.new("wiki_pages.pstore")
# wiki.transaction do # begin transaction; do all of this or none of it
# wiki[home_page.page_name] = home_page
# # ensure that an index has been created...
# wiki[:wiki_index] ||= Array.new
# wiki[:wiki_index].push(*home_page.wiki_page_references)
# end # commit changes to wiki data store file
# ### Some time later... ###
# wiki.transaction(true) do # begin read-only transaction, no changes allowed
# wiki.roots.each do |data_root_name|
binmode = defined?(File::BINARY) ? File::BINARY : 0
RDWR_ACCESS = File::RDWR | File::CREAT | binmode
RD_ACCESS = File::RDONLY | binmode
WR_ACCESS = File::WRONLY | File::CREAT | File::TRUNC | binmode
# The error type thrown by all PStore methods.
class Error < StandardError
# To construct a PStore object, pass in the _file_ path where you would like
dir = File::dirname(file)
unless File::directory? dir
raise PStore::Error, format("directory %s does not exist", dir)
if File::exist? file and not File::readable? file
raise PStore::Error, format("file %s not readable", file)
# Raises PStore::Error if the calling code is not in a PStore#transaction.
raise PStore::Error, "not in transaction" unless @transaction
# Raises PStore::Error if the calling code is not in a PStore#transaction or
# if the code is in a read-only PStore#transaction.
raise PStore::Error, "in read-only transaction" if @rdonly
private :in_transaction, :in_transaction_wr
# Retrieves a value from the PStore file data, by _name_. The hierarchy of
# Ruby objects stored under that root _name_ will be returned.
# *WARNING*: This method is only valid in a PStore#transaction. It will
# raise PStore::Error if called at any other time.
# This method is just like PStore#[], save that you may also provide a
# _default_ value for the object. In the event the specified _name_ is not
# found in the data store, your _default_ will be returned instead. If you do
# not specify a default, PStore::Error will be raised if the object is not
# *WARNING*: This method is only valid in a PStore#transaction. It will
# raise PStore::Error if called at any other time.
def fetch(name, default=PStore::Error)
if default==PStore::Error
raise PStore::Error, format("undefined root name `%s'", name)
# Stores an individual Ruby object or a hierarchy of Ruby objects in the data
# store file under the root _name_. Assigning to a _name_ already in the data
# store clobbers the old data.
# store = PStore.new("data_file.pstore")
# store.transaction do # begin transaction
# # load some data into the store...
# store[:single_object] = "My data..."
# store[:obj_heirarchy] = { "Kev Jackson" => ["rational.rb", "pstore.rb"],
# "James Gray" => ["erb.rb", "pstore.rb"] }
# end # commit changes to data store file
# *WARNING*: This method is only valid in a PStore#transaction and it cannot
# be read-only. It will raise PStore::Error if called at any other time.
# Removes an object hierarchy from the data store, by _name_.
# *WARNING*: This method is only valid in a PStore#transaction and it cannot
# be read-only. It will raise PStore::Error if called at any other time.
# Returns the names of all object hierarchies currently in the store.
# *WARNING*: This method is only valid in a PStore#transaction. It will
# raise PStore::Error if called at any other time.
# Returns true if the supplied _name_ is currently in the data store.
# *WARNING*: This method is only valid in a PStore#transaction. It will
# raise PStore::Error if called at any other time.
# Returns the path to the data store file.
# Ends the current PStore#transaction, committing any changes to the data
# store = PStore.new("data_file.pstore")
# store.transaction do # begin transaction
# # load some data into the store...
# store.commit # end transaction here, committing changes
# store[:three] = 3 # this change is never reached
# *WARNING*: This method is only valid in a PStore#transaction. It will
# raise PStore::Error if called at any other time.
throw :pstore_abort_transaction
# Ends the current PStore#transaction, discarding any changes to the data
# store = PStore.new("data_file.pstore")
# store.transaction do # begin transaction
# store[:one] = 1 # this change is not applied, see below...
# store[:two] = 2 # this change is not applied, see below...
# store.abort # end transaction here, discard all changes
# store[:three] = 3 # this change is never reached
# *WARNING*: This method is only valid in a PStore#transaction. It will
# raise PStore::Error if called at any other time.
throw :pstore_abort_transaction
# Opens a new transaction for the data store. Code executed inside a block
# passed to this method may read and write data to and from the data store
# At the end of the block, changes are committed to the data store
# automatically. You may exit the transaction early with a call to either
# PStore#commit or PStore#abort. See those methods for details about how
# changes are handled. Raising an uncaught Exception in the block is
# equivalent to calling PStore#abort.
# If _read_only_ is set to +true+, you will only be allowed to read from the
# data store during the transaction and any attempts to change the data will
# Note that PStore does not support nested transactions.
def transaction(read_only=false) # :yields: pstore
raise PStore::Error, "nested transaction" if @transaction
new_file = @filename + ".new"
file = File.open(@filename, RDWR_ACCESS)
file.flock(File::LOCK_EX)
commit_new(file) if FileTest.exist?(new_file)
file = File.open(@filename, RD_ACCESS)
file.flock(File::LOCK_SH)
content = (File.open(new_file, RD_ACCESS) {|n| n.read} rescue file.read())
md5 = Digest::MD5.digest(content)
content = nil # unreference huge data
catch(:pstore_abort_transaction) do
if !read_only and !@abort
tmp_file = @filename + ".tmp"
if !md5 || size != content.size || md5 != Digest::MD5.digest(content)
File.open(tmp_file, WR_ACCESS) {|t| t.write(content)}
File.rename(tmp_file, new_file)
content = nil # unreference huge data
# This method is just a wrapped around Marshal.dump.
def dump(table) # :nodoc:
# This method is just a wrapped around Marshal.load.
def load(content) # :nodoc:
# This method is just a wrapped around Marshal.load.
def load_file(file) # :nodoc:
# Commits changes to the data store file.
new_file = @filename + ".new"
File.open(new_file, RD_ACCESS) do |nf|
FileUtils.copy_stream(nf, f)
db = PStore.new("/tmp/foo")
ary = db["root"] = [1,2,3,4]
It is recommended that you Edit text format, this type of Fix handles quite a lot in one request
