jmoses-couchbase-model 0.5.3

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+test/CouchbaseMock.jar

data/.travis.yml

@@ -0,0 +1,11 @@
+before_install:
+  - wget -O- http://packages.couchbase.com/ubuntu/couchbase.key | sudo apt-key add -
+  - echo deb http://packages.couchbase.com/preview/ubuntu lucid lucid/main | sudo tee /etc/apt/sources.list.d/couchbase.list
+  - sudo apt-get update
+  - sudo apt-get -y install libevent-dev libvbucket-dev libcouchbase-dev
+
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - ree

data/.yardopts

@@ -0,0 +1,5 @@
+--protected
+--no-private
+-
+README.markdown
+HISTORY.markdown

data/CONTRIBUTING.markdown

@@ -0,0 +1,75 @@
+We've decided to use "gerrit" for our code review system, making it
+easier for all of us to contribute with code and comments.
+
+  1. Visit http://review.couchbase.org and "Register" for an account
+  2. Review http://review.couchbase.org/static/individual_agreement.html
+  3. Agree to agreement by visiting http://review.couchbase.org/#/settings/agreements
+  4. If you do not receive an email, please contact us
+  5. Check out the `couchbase-ruby-model` area http://review.couchbase.org/#/q/status:open+project:couchbase-ruby-model,n,z
+  6. Join us on IRC at #libcouchbase on Freenode :-)
+
+We normally don't go looking for stuff in gerrit, so you should add at
+least me `"Sergey Avseyev" <sergey.avseyev@gmail.com>` as a reviewer
+for your patch (and I'll know who else to add and add them for you).
+
+## Contributing Using Repo Tool
+
+Follow ["Uploading Changes" guide][1] on the site if you have some code to contribute.
+
+All you should need to set up your development environment should be:
+
+    ~ % mkdir couchbase-ruby
+    ~ % cd couchbase-ruby
+    ~/couchbase-ruby % repo init -u git://github.com/trondn/manifests.git -m ruby.xml
+    ~/couchbase-ruby % repo sync
+    ~/couchbase-ruby % repo start my-branch-name --all
+    ~/couchbase-ruby % make
+
+This will build the latest version of `libcouchbase`,
+`couchbase-ruby-client` and `couchbase-ruby-model` libraries. You must
+have a C and C++ compiler installed, automake, autoconf.
+
+If you have to make any changes just commit them before you upload
+them to gerrit with the following command:
+
+    ~/couchbase-ruby/model % repo upload
+
+You might experience a problem trying to upload the patches if you've
+selected a different login name at http://review.couchbase.org than
+your login name. Don't worry, all you need to do is to add the
+following to your ~/.gitconfig file:
+
+    [review "review.couchbase.org"]
+        username = YOURNAME
+
+## Contributing Using Plain Git
+
+If you not so familiar with repo tool and its workflow there is
+alternative way to do the same job. Lets assume you have installed
+couchbase gem and libcouchbase from official packages and would you to
+contribute to couchbase-model gem only. Then you just need to complete
+gerrit registration steps above and clone the source repository
+(remember the repository on github.com is just a mirror):
+
+    ~ % git clone ssh://YOURNAME@review.couchbase.org:29418/couchbase-ruby-model.git
+
+Install [`commit-msg` hook][2]:
+
+    ~/couchbase-ruby-model % scp -p -P 29418 YOURNAME@review.couchbase.org:hooks/commit-msg .git/hooks/
+
+Make your changes and upload them for review:
+
+    ~/couchbase-ruby-model % git commit
+    ~/couchbase-ruby-model % git push origin HEAD:refs/for/master
+
+If you need to fix or add something to your patch, do it and re-upload
+the changes (all you need is to keep `Change-Id:` line the same to
+allow gerrit to track the patch.
+
+    ~/couchbase-ruby-model % git commit --amend
+    ~/couchbase-ruby-model % git push origin HEAD:refs/for/master
+
+Happy hacking!
+
+[1]: http://review.couchbase.org/Documentation/user-upload.html
+[2]: http://review.couchbase.org/Documentation/user-changeid.html

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in couchbase-model.gemspec
+gemspec

data/HISTORY.markdown

@@ -0,0 +1,112 @@
+## 0.5.3 / 2013-06-06
+
+* Prefer single-quoted strings (Andrey Koleshko)
+* Test for Model.design_document (Andrey Koleshko)
+* Support for batch finding multiple objects by id (Jon Moses)
+* Test for activemodel instead of rails for activemodel validations
+* Update couchbase dependency to 1.3.0
+
+## 0.5.2 / 2013-02-25
+
+* Fix attribute inheritance when subclassing (Mike Evans)
+* Added as_json method for rails JSON responses (Stephen von Takach)
+* Add contributing document
+* Fix test hiding
+* Remove comments from the javascript sources
+* Reduce development dependencies and update jar version
+
+## 0.5.1 / 2012-11-29
+
+* Introduce save! and create! methods and raise RecordInvalid only from them
+
+## 0.5.0 / 2012-11-21
+
+* Update template for map function
+* Use extended get for #find_by_id
+* Do not use HashWithIndifferentAccess class unless it defined
+* Pass options to #create method
+* Ensure validness on create
+* Fix storing raw data
+* Define read_attribute and write_attribute methods
+* Support couchbase 1.2.0.z.beta4
+
+## 0.4.4 / 2012-10-17
+
+* Make #to_param aware about keys
+
+## 0.4.2 / 2012-10-17
+
+* Update CAS value after mutation
+* Added ability to pass options to mutators. Thanks to @kierangraham
+* Always try to include Rails stuff into model
+* Use key if id is nil (makes sense for some view results)
+
+## 0.4.1 / 2012-09-26
+
+* Put support notes in README
+* Add note about validations in the README
+* Update repo URL
+* RCBC-85 Fix typo in `save' method
+
+## 0.4.0 / 2012-09-25
+
+* Add validation hooks for Rails application
+* Check meta presence as more robust indicator of key presence
+
+## 0.3.1 / 2012-09-22
+
+* Allow to specify default storage options
+
+## 0.3.0 / 2012-09-22
+
+* Implement belongs_to asscociation
+* Use ActiveModel naming and conversion
+* Define persisted? method
+* Allow optional CAS value for mutators
+* Use replace in save method. Thanks to @scalabl3
+* Add callbacks for :save, :create, :update and :delete methods
+
+## 0.2.0 / 2012-09-18
+
+* Add Rails 3 configuration possibilities, allow configuring
+  ensure_design_documents to disable/enable the auto view upgrade
+  (thanks to David Rice)
+* Ensure views directory is always set (thanks to David Rice)
+* Fix tests for ruby 1.8.7
+* Reword header in README
+* Merge pull request #3 from davidjrice/master
+* Use debugger gem
+* Update Model wrapper to match latest API changes
+* Strip contents of the JS file
+* Do not submit empty views
+* Allow to specify default view options
+* Display only non-nil values
+* Rename underscored methods
+* Load spatial views into design document
+
+## 0.1.0 / 2012-04-10
+
+* Allows to define several attributes at once
+* Allow to specify default value
+* Add missing @since and @return tags
+* Add railtie
+* Add config generator
+* Use verbose mode by default for GET operation
+* Add views generators
+* Update document wrapper
+* Add code to upgrade design docs automatically
+* Cache design document signature in memory
+* Use symbols for attribute hash
+* Skip connection errors during start up
+* Don't show config warning for config generator
+* Calculate mtime of the design document
+* Assign current_doc after creation
+* Update readme file
+* Use preview repository for travis
+* Do not make zipball
+* Show model attributes with model class
+* Update test. The couchbase gem is using new defaults
+
+## 0.0.1/ 2012-03-17
+
+* Initial version

data/README.markdown

@@ -0,0 +1,160 @@
+# Couchbase Model
+
+This library allows to declare models for [couchbase gem][1].
+
+## SUPPORT
+
+If you found an issue, please file it in our [JIRA][3]. Also you are
+always welcome on `#libcouchbase` channel at [freenode.net IRC servers][4].
+
+Documentation: [http://rdoc.info/gems/couchbase-model](http://rdoc.info/gems/couchbase-model)
+
+## Rails integration
+
+To generate config you can use `rails generate couchbase:config`:
+
+    $ rails generate couchbase:config
+    create  config/couchbase.yml
+
+It will generate this `config/couchbase.yml` for you:
+
+    common: &common
+      hostname: localhost
+      port: 8091
+      username:
+      password:
+      pool: default
+
+    development:
+      <<: *common
+      bucket: couchbase_tinyurl_development
+
+    test:
+      <<: *common
+      bucket: couchbase_tinyurl_test
+
+    # set these environment variables on your production server
+    production:
+      hostname: <%= ENV['COUCHBASE_HOST'] %>
+      port: <%= ENV['COUCHBASE_PORT'] %>
+      username: <%= ENV['COUCHBASE_USERNAME'] %>
+      password: <%= ENV['COUCHBASE_PASSWORD'] %>
+      pool: <%= ENV['COUCHBASE_POOL'] %>
+      bucket: <%= ENV['COUCHBASE_BUCKET'] %>
+
+## Examples
+
+    require 'couchbase/model'
+
+    class Post < Couchbase::Model
+      attribute :title
+      attribute :body
+      attribute :draft
+    end
+
+    p = Post.new(:id => 'hello-world',
+                 :title => 'Hello world',
+                 :draft => true)
+    p.save
+    p = Post.find('hello-world')
+    p.body = "Once upon the times...."
+    p.save
+    p.update(:draft => false)
+    Post.bucket.get('hello-world')  #=> {"title"=>"Hello world", "draft"=>false,
+                                    #    "body"=>"Once upon the times...."}
+
+You can also let the library generate the unique identifier for you:
+
+    p = Post.create(:title => 'How to generate ID',
+                    :body => 'Open up the editor...')
+    p.id        #=> "74f43c3116e788d09853226603000809"
+
+There are several algorithms available. By default it use `:sequential`
+algorithm, but you can change it to more suitable one for you:
+
+    class Post < Couchbase::Model
+      attribute :title
+      attribute :body
+      attribute :draft
+
+      uuid_algorithm :random
+    end
+
+You can define connection options on per model basis:
+
+    class Post < Couchbase::Model
+      attribute :title
+      attribute :body
+      attribute :draft
+
+      connect :port => 80, :bucket => 'blog'
+    end
+
+## Validations
+
+There are all methods from ActiveModel::Validations accessible in
+context of rails application:
+
+    class Comment < Couchbase::Model
+      attribute :author, :body
+
+      validates_presence_of :author, :body
+    end
+
+## Views (aka Map/Reduce indexes)
+
+Views are stored in models directory in subdirectory named after the
+model (to be precious `design_document` attribute of the model class).
+Here is an example of directory layout for `Link` model with three
+views.
+
+    .
+    └── app
+        └── models
+            ├── link
+            │   ├── total_count
+            │   │   ├── map.js
+            │   │   └── reduce.js
+            │   ├── by_created_at
+            │   │   └── map.js
+            │   └── by_view_count
+            │       └── map.js
+            └── link.rb
+
+To generate view you can use yet another generator `rails generate
+couchbase:view DESIGNDOCNAME VIEWNAME`. For example how `total_count`
+view could be generated:
+
+    $ rails generate couchbase:view link total_count
+
+The generated files contains useful info and links about how to write
+map and reduce functions, you can take a look at them in the [templates
+directory][2].
+
+In the model class you should declare accessible views:
+
+    class Post < Couchbase::Model
+      attribute :title
+      attribute :body
+      attribute :draft
+      attribute :view_count
+      attribute :created_at, :default => lambda { Time.now }
+
+      view :total_count, :by_created_at, :by_view_count
+    end
+
+And request them later:
+
+    Post.by_created_at(:include_docs => true).each do |post|
+      puts post.title
+    end
+
+    Post.by_view_count(:include_docs => true).group_by(&:view_count) do |count, posts|
+      p "#{count} -> #{posts.map{|pp| pp.inspect}.join(', ')}"
+    end
+
+
+[1]: https://github.com/couchbase/couchbase-ruby-client/
+[2]: https://github.com/couchbase/couchbase-ruby-model/blob/master/lib/rails/generators/couchbase/view/templates/
+[3]: http://couchbase.com/issues/browse/RCBC
+[4]: http://freenode.net/irc_servers.shtml

data/Rakefile

@@ -0,0 +1,22 @@
+# Author:: Couchbase <info@couchbase.com>
+# Copyright:: 2012 Couchbase, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'bundler/gem_tasks'
+
+Dir['tasks/*.rake'].sort.each { |f| load f }
+
+task :default => :test

data/couchbase-model.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'couchbase/model/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'jmoses-couchbase-model'
+  s.version     = Couchbase::Model::VERSION
+  s.author      = ['Couchbase', 'Jon Moses']
+  s.email       = ['support@couchbase.com', 'jon@burningbush.us']
+  s.homepage    = 'https://github.com/couchbase/couchbase-ruby-model'
+  s.summary     = %q{Declarative interface to Couchbase. (Fork for connection-pool 2.0)}
+  s.description = %q{ORM-like interface allows you to persist your models to Couchbase. This fork requires my forked couchbase client, which uses connection-pool 2.0 instead of 1.0}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.add_runtime_dependency 'jmoses-couchbase', '~> 1.3.0'
+
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'minitest'
+  s.add_development_dependency 'activesupport'
+end

data/lib/couchbase-model.rb

@@ -0,0 +1,23 @@
+# Author:: Couchbase <info@couchbase.com>
+# Copyright:: 2012 Couchbase, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'couchbase/model'
+
+# If we are using Rails then we will include the Couchbase railtie.
+if defined?(Rails)
+  require 'couchbase/railtie'
+end