couch_surfer 0.3.2

data/CHANGELOG.md

@@ -0,0 +1,27 @@
+0.1.0 (2009-03-23)
+------------------
+ - `inline` associations are now correctly serialised when saving
+
+0.0.5 (2009-02-06)
+------------------
+ - BUGFIX: `belongs_to` now takes `:class_name` (see Employer class in Association spec)
+
+0.0.4 (2009-02-04)
+------------------
+ - `has_many :through`
+ - `has_many :inline`
+ - `create` was in 0.0.2 but forgot to mention it :)
+ - `all` now emits (id, null) so you can use `:keys => [1,2,3,4]` in your query
+ - `format_utc_offset` helper (zdzolton)
+ - Syntax change: 
+   - OLD: `:view => {:name => :by_this_and_that, :query => lambda { {:key => [this_id, id]} }}`
+   - NEW: `:view => :by_this_and_that, :query => lambda { {:key => [this_id, id]} }`
+
+0.0.2 (2009-01-24)
+------------------
+ - `timestamps!` class method now adds instance methods
+ - `created_at` and `updated_at` always return an instance of `Time`
+
+0.0.1 (2009-01-21)
+------------------
+ - Initial Release

data/LICENSE

@@ -0,0 +1,176 @@
+                              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

data/README.md

@@ -0,0 +1,168 @@
+CouchSurfer - CouchDB ORM
+=========================
+---
+Description
+-----------
+CouchSurfer is an extraction of CouchRest::Model from the excellent [CouchRest](http://github.com/jchris/couchrest/ "CouchRest") gem by J. Chris Anderson. In addition, it provides association and validation methods.
+
+Associations
+------------
+CouchSurfer provides the following 4 association kinds:
+
+ - `belongs_to`
+ - `has_many`
+ - `has_many :inline`; and
+ - `has_many :through`
+
+All association kinds take an optional `:class_name` option should you want your association to be named differently to the associated model.
+
+    class Page
+      …
+      belongs_to :owner, :class_name => :user
+      …
+    end
+    
+    page = Page.create(…)
+    page.owner # returns an instance of user
+    
+The `belongs_to` associations accept two additional options - `:view` and `query`, enabling you to customise your associations to fit your needs. You must explicitly declare the view on the child model for associations to work
+
+**Example 1: basic**
+
+    class User
+      …
+      has_many :pages
+      …
+    end
+    
+    class Page
+      …
+      view_by :user_id
+      …
+    end
+    
+    user = User.create(…)
+    10.times {Page.create(…, :user_id => user.id)}
+    user.pages
+    
+
+**Example 2: with options**
+
+    class Account
+      …
+      has_many :employees,
+          :class_name, :user,
+          :view  => :by_account_id_and_email,
+          :query => lambda { {:startkey => [account_id, nil], :endkey => [account_id, {}]}   }
+      …
+    end
+
+    class User
+      …
+      view_by :account_id, :email # see validation examples below
+      …
+    end
+
+    account = Acccount.create(…)
+    10.times {User.create(…, :account_id => acount.id)}
+    account.employees
+
+
+**Example 3: :inline**
+
+    class User
+      …
+      has_many :tasks, :inline => true
+      …
+    end
+
+    class Task
+      …
+      view_by :user_id
+      …
+    end
+
+    user = User.create(…)
+    10.times {user.tasks << Task.new(…)}
+    user.save
+    user.tasks
+
+    
+**Example 4: :through**
+
+    class Account
+      …
+      has_many :projects,
+          :through => :memberships
+      …
+    end
+
+    class Membership
+      …
+      view_by :account_id
+      …
+    end
+    
+    class Project
+      …
+      view_by :account_id, :email # see validation examples below
+      …
+    end
+
+    account = Acccount.create(…)
+    10.times do
+      p = Project.create(…)
+      Membership.create(…, :account_id => account.id, :project_id => p.id)
+    end
+    account.projects
+    
+**Note on HasManyThrough**
+
+With reference to the above example, HasManyThrough works by retrieving all memberships associated with the account, collecting their ids and running a [bulk retrieval](http://wiki.apache.org/couchdb/HTTP_view_API "Query Options") on the Project.all view, which is implicitly created for all models and, as of 0.0.4, emits it's id (see CHANGELOG).
+
+*Caveats*
+
+  - Sorting needs to be done client side
+  - The results do not contain any extra information that may be present on the ':through' model.
+
+Validations
+-----------
+Validations, with the exception of `validates_uniqueness_of`, have been implemented using the [Validatable](http://github.com/jrun/validatable/ "Validatable") gem.
+
+**Example**
+
+    class Employee
+      include CouchSurfer::Model
+      include CouchSurfer::Associations
+      include CouchSurfer::Validations
+  
+      key_accessor :email, :account_id
+      belongs_to :account
+  
+      view_by :account_id, :email
+      view_by :name
+
+      validates_presence_of :name
+      validates_format_of   :email, 
+        :with => /\A([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})\Z/i
+      validates_length_of :postcode, :is => 7, :message => "not the correct length"
+      
+      # Will use the Employee.by_name view with {:key => employee_instance.name}
+      validates_uniqueness_of :name
+      
+      # Uses a custom view and key for uniqueness within a specific scope
+      validates_uniqueness_of :email,
+          :view => :by_account_id_and_email,
+          :query => lambda{ {:key => [account_id, email]} },
+          :message => "The email address for this account is taken"
+  
+    end
+
+
+Please check out the specs as well :)
+
+Next
+----
+  - Error handling
+  - association methods with arguments:
+    `@account.projects(:limit => 2, :offset => 1)`

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rake'
+require File.join(File.expand_path(File.dirname(__FILE__)),'lib','couch_surfer')
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "couch_surfer"
+    s.date = "2009-01-22"
+    s.summary = "ORM based on CouchRest::Model"
+    s.email = "adam.groves@gmail.com"
+    s.homepage = "http://github.com/addywaddy/couchsurfer"
+    s.description = "CouchSurfer provides an ORM for CouchDB, as well as supporting association and validation declarations."
+    s.has_rdoc = true
+    s.authors = ["Adam Groves"]
+    s.files = %w( LICENSE README.md Rakefile ) + 
+      Dir["{lib,spec}/**/*"] - 
+      Dir["spec/tmp"]
+    s.extra_rdoc_files = %w( README.md LICENSE CHANGELOG.md )
+    s.require_path = "lib"
+    s.add_dependency("json", ">= 1.1.2")
+    s.add_dependency("rest-client", ">= 0.8.2")
+    s.add_dependency('couchrest', ">= 0.33")
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = 'the-perfect-gem'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.libs << 'lib' << 'spec'
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |t|
+  t.libs << 'lib' << 'spec'
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.rcov = true
+end
+
+begin
+  require 'cucumber/rake/task'
+  Cucumber::Rake::Task.new(:features)
+rescue LoadError
+  puts "Cucumber is not available. In order to run features, you must: sudo gem install cucumber"
+end
+
+task :default => :spec

data/lib/couch_surfer.rb

@@ -0,0 +1,18 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'rubygems'
+require 'extlib'
+require 'couchrest'
+require 'couchrest/extensions'
+
+module CouchSurfer
+  autoload :Extensions,    'couch_surfer/attachments'
+  autoload :Configuration,       'couch_surfer/configuration'
+  autoload :Database,       'couch_surfer/database'
+  autoload :Model,          'couch_surfer/model'
+  autoload :Validations,    'couch_surfer/validations'
+  autoload :Associations,   'couch_surfer/associations'
+  autoload :Query,          'couch_surfer/query'
+  autoload :Attachments,    'couch_surfer/attachments'
+end