Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Marshal Ruby classes into and out of multiple formats (yaml, json, csv, tsv)
Ruby

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
bin
lib
try
CHANGES.txt
LICENSE.txt
README.rdoc
Rakefile
storable.gemspec

README.rdoc

Storable - v0.7

Marshal Ruby classes into and out of multiple formats (yaml, json, csv, tsv)

Example

require 'storable'

class Machine < Storable
  field :environment            # Define field names for Machine. The
  field :role                   # default type is String, but you can
  field :position => Integer    # specify a type using a hash syntax.
end

mac1 = Machine.new              # Instances of Machine have accessors
mac1.environment = "stage"      # just like regular attributes. 
mac1.role = "app"
mac1.position = 1

puts "# YAML", mac1.to_yaml     # Note: the field order is maintained     
puts "# CSV", mac1.to_csv       # => stage,app,1
puts "# JSON", mac1.to_json     # Note: field order not maintained.

mac2 = Machine.from_yaml(mac1.to_yaml)
puts mac2.environment           # => "stage"
puts mac2.position.class        # => Fixnum

Storing Procs

Storable can also marshal Proc objects to and from their actual source code.

require 'storable'

class Maths < Storable
  field :x         => Float
  field :y         => Float
  field :calculate => Proc
end

mat1 = Maths.new 2.0, 3.0
mat1.calculate = Proc.new { @x * @y }

mat1.calculate.source            # => "{ @x * @y }"
mat1.call :calculate             # => 6.0

dump = mat1.to_json

mat2 = Maths.from_json dump
mat2.call :calculate             # => 6.0

Anything is possible when you keep your mind open and you use Ruby.

Installation

Via Rubygems, one of:

$ sudo gem install storable
$ sudo gem install delano-storable --source http://gems.github.com/

or via download:

Prerequisites

  • Ruby 1.8, Ruby 1.9, or JRuby 1.2+

Thanks

  • Pierre Riteau (priteau) for bug fixes.

Credits

  • Delano Mandelbaum (delano@solutious.com)

  • OrderedHash implementation by Jan Molic

License

See: LICENSE.txt

Something went wrong with that request. Please try again.