hypostasis-object

Hypostasis::Object

Hypostasis::Object is an OODB-style layer for FoundationDB and is part of the broader Hypostasis project. The Hypostasis project aims to provide a collection of data models for Ruby, built on top of FoundationDB.

Installation

Add this line to your application's Gemfile:

gem 'hypostasis-object'

And then execute:

$ bundle

Or install it yourself as:

$ gem install hypostasis-object

Usage

require 'hypostasis/object'

class Employee
  include Hypostasis::Object

  attr_accessor :name, :title, :salary
end

john = Employee.new
john.name   = 'John Doe'
john.title  = 'Patent Clerk'
john.salary = 42000

john.persist

The above example is a simple demonstration of working with Hypostasis::Object. Hypostasis::Object adds two public methods for handling persistence: persist and persist!. The latter raises an error when certain kinds of things go wrong. Behind the scenes Hypostasis::Object gathers the state of the object and atomically commits it to FoundationDB. In the process, it will also generate a unique id for the object, accessible via the id attribute. This is the most basic example of working with Hypostasis::Object. Please refer to the Wiki for more detailed examples and other feature details.

Contributing

1. Fork it ( http://github.com//hypostasis-object/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request