couchpack

This gem is a tools to help packing couch documents for mobile devices. See github.com/kmalakoff/phonegap-couchbase-xplatform for an example use.

Install:
  gem install couchpack

Usage:
  couchpack document [DOCUMENT_URL] [OUTFILE] --auto
  Note: the optional --auto flag watches the couchdb document for changes and automatically repacks when changes are detected.

What it does is strip out the “_id” and “_rev” fields so the document can be uploaded in place without being modified and generates a document.JSON file.

It also strips out the “_rev” field and puts it in a document.VERSION file which can be used to check for modifications to avoid reloading unmodified documents on the target mobile device.

Contributing to couchpack

  • Check out the latest master to make sure the feature hasn’t been implemented or the bug hasn’t been fixed yet

  • Check out the issue tracker to make sure someone already hasn’t requested it and/or contributed it

  • Fork the project

  • Start a feature/bugfix branch

  • Commit and push until you are happy with your contribution

  • Make sure to add tests for it. This is important so I don’t break it in a future version unintentionally.

  • Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.

Copyright © 2011 Kevin Malakoff. See LICENSE.txt for further details.