couchbase-jruby-model 0.1.0-java

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8593657f00069e9c81f94cee9e61f5c0042a2feb
+  data.tar.gz: a07ff9ff2b95fa68862932a82c909779d6c330fc
+SHA512:
+  metadata.gz: a266fbd9fd7e762f7ce3a86ba4cae0fa793e50d13024d5b78060093f5ac6299407010deb9f06d8039f7668faa8932ae1e12dc691a82c8185fe7d26d0392b7930
+  data.tar.gz: a250ab271e7f162b5bcd73e467636383a4a9b51d57c22c69fc7ffea19c5dade0fbe39e38a8bdfad4f0090fd77e579dca2d5fc3c8200b1d9fc03c8c7cac3eda02

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.ruby-version

@@ -0,0 +1 @@
+jruby-1.7.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,203 @@
+Copyright (c) 2013 Mike Evans
+
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+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.

data/README.md

@@ -0,0 +1,155 @@
+# Couchbase JRuby Model
+
+Unofficial port of [Couchbase Ruby Model](https://github.com/couchbase/couchbase-ruby-model)
+to JRuby.  The only changes in this gem over the original is to load the (also)
+unnoficial [Couchbase JRuby Client](https://github.com/mje113/couchbase-jruby-client).
+
+## 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-jruby-model.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'couchbase/model/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'couchbase-jruby-model'
+  s.version     = Couchbase::Model::VERSION
+  s.author      = ['Couchbase', 'Mike Evans']
+  s.email       = ['mike@urlgonomics.com']
+  s.homepage    = 'https://github.com/mje113/couchbase-jruby-model'
+  s.summary     = %q{Declarative interface to Couchbase (unofficial--targeting JRuby)}
+  s.description = %q{ORM-like interface allows you to persist your models to Couchbase}
+  s.license     = 'Apache'
+  s.platform    = 'java'
+
+  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 'couchbase-jruby-client', '~> 0.1.4'
+
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'minitest'
+  s.add_development_dependency 'activesupport'
+  s.add_development_dependency 'activemodel'
+end