Relaxo Model

Relaxo Model provides a framework for business logic on top of Relaxo/CouchDB. While it supports some traditional ORM style patterns, it is primary focus is to model business processes and logic.

Basic Usage

Here is a simple example of a traditional ORM style model:

require 'relaxo'
require 'relaxo/model'

database = Relaxo.connect("http://localhost:5984/test")

trees = [
    {:name => 'Hinoki', :planted => Date.parse("1948/4/2")},
    {:name => 'Rimu', :planted => Date.parse("1962/8/7")}
]

class Tree
    include Relaxo::Model

    property :name
    property :planted, Attribute[Date]

    # Ensure you've loaded an appropriate design document:
    view :all, 'catalog/tree', Tree
end

trees.each do |doc|
    tree = Tree.create(database, doc)

    tree.save
end

Tree.all(database).each do |tree|
    puts "A #{tree.name} was planted on #{tree.planted.to_s}."

    # Expected output:
    # => A Rimu was planted on 1962-08-07.
    # => A Hinoki was planted on 1948-04-02.

    tree.delete
end

Here is the design document:

-   _id: "_design/catalog"
    language: javascript
    views:
        tree:
            map: |
                function(doc) {
                    if (doc.type == 'tree') {
                        emit(doc._id, doc._rev);
                    }
                }

If the design document was saved as catalog.yaml, you could load it using relaxo into the test database as follows:

relaxo test catalog.yaml 

Contributing

1. Fork it
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

License

Released under the MIT license.

Copyright, 2010-2013, by Samuel G. D. Williams.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.