= secretary
* http://secretary.rubyforge.org
== DESCRIPTION:
Secretary is a gem who makes managing simple preference files in Ruby easier
and more painless.
== FEATURES:
* She encapsulates preference files in a single, easily manageable object
* She's smooth and simple: just import and initialize
* She's easily extensible--subclass Secretary::Gopher to be able to load any
kind of file you wish
== SYNOPSIS:
import 'secretary'
secretary = Secretary.new 'preferences.yaml', :defaults => '', 'port': 80
# The first argument is the path to the file that she will sync to.
# The second argument is a option hash.
# Passing in a :defaults option gives the Hash that contains her defaults.
secretary['url'] = 'http://samantha.name'
secretary['name'] # <- 'Samantha'
secretary['url'] = 'http://samantha.name'
secretary['port'] # <- 80
secretary.save # Saves to a YAML file called 'preferences.yaml'.
== REQUIREMENTS:
* At least Ruby 1.8.0
* The standard forwarable.rb
* The standard yaml.rb
* At least RSpec 1.1 (but only if you want to use the included specs)
== INSTALL:
The recommended way to install Secretary is to use rubygems to download and
install it automatically:
gem install secretary
== NOTES:
Throughout this library's documentation, Secretaries will be referred to as
"she"s, and Gophers will be referred to as "he"s.
I'm planning to add support for for more formats such as JSON and (gulp) XML.
I'd be very happy to hear your comments and bugs on Rubyforge.
* http://secretary.rubyforge.org
== DESCRIPTION:
Secretary is a gem who makes managing simple preference files in Ruby easier
and more painless.
== FEATURES:
* She encapsulates preference files in a single, easily manageable object
* She's smooth and simple: just import and initialize
* She's easily extensible--subclass Secretary::Gopher to be able to load any
kind of file you wish
== SYNOPSIS:
import 'secretary'
secretary = Secretary.new 'preferences.yaml', :defaults => '', 'port': 80
# The first argument is the path to the file that she will sync to.
# The second argument is a option hash.
# Passing in a :defaults option gives the Hash that contains her defaults.
secretary['url'] = 'http://samantha.name'
secretary['name'] # <- 'Samantha'
secretary['url'] = 'http://samantha.name'
secretary['port'] # <- 80
secretary.save # Saves to a YAML file called 'preferences.yaml'.
== REQUIREMENTS:
* At least Ruby 1.8.0
* The standard forwarable.rb
* The standard yaml.rb
* At least RSpec 1.1 (but only if you want to use the included specs)
== INSTALL:
The recommended way to install Secretary is to use rubygems to download and
install it automatically:
gem install secretary
== NOTES:
Throughout this library's documentation, Secretaries will be referred to as
"she"s, and Gophers will be referred to as "he"s.
I'm planning to add support for for more formats such as JSON and (gulp) XML.
I'd be very happy to hear your comments and bugs on Rubyforge.