couchrest_casted 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+Gemfile.lock
+html/
+*.gem
+*.swp
+*.swo

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+gemspec
+

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,90 @@
+# CouchRest Casted: Enable polymorphic CouchDB queries
+
+Pull properly-casted documents from a CouchDB/CouchBase database, directly from
+CouchRest queries. Uses CouchRest::Model as a modelling framework.
+
+## Installation
+
+(depends on `couchrest` and `couchrest_model` gems)
+
+### Gem
+
+    $ gem install couchrest_casted
+
+### Bundler
+
+Bundler users can add this line to their Gemfile:
+
+    gem 'couchrest_casted'
+
+## Usage
+
+The following is a simple example of using a CouchDB view to load documents
+of different CouchRest::Model classes, casted automatically:
+
+    require 'rubygems'
+    require 'couchrest_casted'
+
+    # connect to the CouchDB server
+    cr = CouchRest.new('http://localhost:5984')
+    DB = cr.database('casted_test')
+    # create the database
+    DB.recreate!
+
+    # define a couple of similar document models
+    class Service < CouchRest::Model::Base
+      use_database DB
+      property :name
+    end
+
+    class Person < CouchRest::Model::Base
+      use_database DB
+      property :name
+    end
+
+    # create some documents (services and users)
+    ['Socialiting', 'Window Washing',
+     'Keynoting', 'Table Architecture'].each do |name|
+      Service.new(:name => name).save!
+    end
+
+    ['Zark Muckerberg', 'Gill Bates',
+     'Jeve Stobs', 'Ellarry Lison'].each do |name|
+      Person.new(:name => name).save!
+    end
+
+    # a simple view that splits the 'name' field
+    # into words and emits one row per word
+    DB.save_doc({
+      "_id" => "_design/generic",
+      :views => {
+        :by_word => {
+          :map => <<-JS
+            function(doc) {
+              if (doc.name && doc.name.length > 0) {
+                var words = doc.name.split(/\\W/);
+                words.forEach(function(word){
+                  if (word.length > 0) emit(word, 1);
+                });
+              }
+            }
+          JS
+        } } })
+
+    # query the generic view
+    rows = DB.casted_view('generic/by_word')['rows']
+
+    # each returned document should be casted as the
+    # correct CouchRest::Model class
+    rows.each do |row|
+      doc = row['doc']
+      key = row['key']
+      value = row['value']
+      puts [doc.id, doc.class.to_s, doc.name, key, value].join(', ')
+    end
+
+## Contact
+
+Bugs, suggestions, and such can be posted to [https://github.com/m104/couchrest_casted/issues](https://github.com/m104/couchrest_casted/issues).
+
+

data/Rakefile

@@ -0,0 +1,38 @@
+require 'rubygems'
+require 'bundler'
+require 'rdoc/task'
+require 'rspec/core/rake_task'
+
+Bundler::GemHelper.install_tasks
+
+desc "Run all specs"
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.rspec_opts = ["--color"]
+  spec.pattern = 'spec/*_spec.rb'
+end
+
+desc "Print specdocs"
+RSpec::Core::RakeTask.new(:doc) do |spec|
+  spec.rspec_opts = ["--format", "specdoc"]
+  spec.pattern = 'spec/*_spec.rb'
+end
+
+desc "Generate the rdoc"
+RDoc::Task.new do |rdoc|
+  files = ["README.md", "LICENSE", "lib/**/*.rb"]
+  rdoc.rdoc_files.add(files)
+  rdoc.main = "README.md"
+  rdoc.title = ""
+end
+
+desc "Run the rspec"
+task :default => :spec
+
+module Rake
+  def self.remove_task(task_name)
+    Rake.application.instance_variable_get('@tasks').delete(task_name.to_s)
+  end
+end
+
+Rake.remove_task('release')
+

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/couchrest_casted.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name     = 'couchrest_casted'
+  s.version  = `cat VERSION`.strip
+  s.date     = '2012-01-10'
+  s.authors  = ['Adam Collins']
+  s.email    = 'adam@m104.us'
+  s.homepage = 'https://github.com/m104/couchrest_casted'
+
+  s.summary     = %q{Provides model casting methods for CouchRest::Database}
+  s.description = %q{Adds methods to CouchRest::Database that automatically cast document JSON data as CouchRest::Model objects}
+
+  s.require_paths = ['lib']
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.extra_rdoc_files = [
+    'LICENSE',
+    'VERSION',
+    'README.md'
+  ]
+
+  s.required_rubygems_version = Gem::Requirement.new('> 1.3.1') if s.respond_to? :required_rubygems_version=
+
+  s.add_dependency(%q<couchrest_model>, '~> 1.1')
+  s.add_development_dependency(%q<rake>, '~> 0.9')
+  s.add_development_dependency(%q<rspec>, '~> 2.8')
+  s.add_development_dependency(%q<rdoc>, '~> 3.12')
+end
+

data/lib/couchrest/database/casted_queries.rb

@@ -0,0 +1,44 @@
+module CouchRest
+  class Database
+    # Just like +view+, but automatically includes the documents
+    # in the response and casts each document as a CouchRest::Model
+    # class, if possible.
+    #
+    # Currently, +casted_view+ doesn't support given blocks.
+    def casted_view(name, params = {})
+      # force the DB response to include documents
+      params[:include_docs] = true
+      response = view(name, params)
+      rows = response['rows']
+      return response unless rows
+
+      response['rows'] = rows.map do |row|
+        doc = row['doc']
+        type = doc['couchrest-type'] || doc['type']
+        if type
+          klass = type.constantize
+          if klass.respond_to? :build_from_database
+            row['doc'] = klass.build_from_database(doc)
+          end
+        end
+        row
+      end
+
+      response
+    end
+
+    # Just like +get+, but casts the returned document as a
+    # CouchRest::Model, if there is a matching class available
+    #
+    # Currently, +casted_get+ doesn't support given blocks.
+    def casted_get(id, params = {})
+      doc = get(id, params)
+      return nil unless doc
+      return doc unless type = doc['couchrest-type'] || doc['type']
+      klass = type.constantize
+      return doc unless klass.respond_to? :build_from_database
+      klass.build_from_database(doc)
+    end
+
+  end
+end

data/lib/couchrest_casted.rb

@@ -0,0 +1,6 @@
+# external requirements
+require 'couchrest_model'
+
+# gem requirements
+require 'couchrest/database/casted_queries'
+

data/spec/casted_spec.rb

@@ -0,0 +1,155 @@
+require File.expand_path("spec_helper", File.dirname(__FILE__))
+require File.expand_path('models/service', FIXTURE_PATH)
+require File.expand_path('models/user', FIXTURE_PATH)
+
+describe 'Multi-class queries' do
+  before(:all) do
+    reset_test_db!
+
+    # load the test cases
+
+    ['Lawncare', 'Elephant Training', 'Cheese Tasting',
+     'Acrobatic Training', 'Firehydrant Painting',
+     'Clock Winding', 'Remote Finding', 'Chocolate Tasting',
+     'Rabbit Training', 'Propeller Winding'].each_with_index do |name, index|
+      Service.new(:id => "service-#{index}",:name => name).save!
+    end
+
+    ['Brenda Pardone', 'Wendel Covington', 'Bradly P. Buttersby',
+     'Frox', 'Jenny Hammersmithe', 'Shu Lao Chun', 'Waldo',
+     'Michael Pardone', 'Bradly Hammersmithe',
+     'The Other Frox'].each_with_index do |name, index|
+      User.new(:id => "user-#{index}", :name => name).save!
+    end
+
+    # a simple view that splits the 'name' field
+    # into words and emits one row per word
+    DB.save_doc({
+      "_id" => "_design/generic",
+      :views => {
+        :by_word => {
+          :map => <<-JS
+            function(doc) {
+              if (doc.name && doc.name.length > 0) {
+                var words = doc.name.split(/\\W/);
+                words.forEach(function(word){
+                  if (word.length > 0) emit(word, 1);
+                });
+              }
+            }
+          JS
+        }
+      }
+    })
+  end
+
+  describe 'from reference #get' do
+    it 'should return nil when document is not found' do
+      doc = nil
+      expect { 
+        doc = DB.get('not-a-doc')
+      }.to raise_error(RestClient::ResourceNotFound)
+      doc.should be_nil
+    end
+
+    it 'should return a CouchRest::Document object to represent a document' do
+      doc = DB.get('service-4')
+      doc.should be_an_instance_of(CouchRest::Document)
+    end
+  end
+
+  describe 'from #casted_get' do
+    it 'should return nil when document is not found' do
+      doc = nil
+      expect {
+        doc = DB.casted_get('not-a-doc')
+      }.to raise_error(RestClient::ResourceNotFound)
+      doc.should be_nil
+    end
+
+    it 'should return a casted CouchRest::Model object to represent a document' do
+      doc = DB.casted_get('service-4')
+      doc.should be_an_instance_of(Service)
+      doc.should be_a_kind_of(CouchRest::Model::Base)
+    end
+  end
+
+  describe 'from reference #view' do
+    before(:all) do
+      @all_rows = DB.view('generic/by_word', :include_docs => true)['rows']
+
+      @no_rows  = DB.view('generic/by_word',
+                           :include_docs => true,
+                           :startkey => 'Zanzibar',
+                           :endkey => 'Zapfino')['rows']
+    end
+
+    it 'should return an Array' do
+      @all_rows.should be_an_instance_of(Array)
+    end
+
+    it 'should return all of the documents' do
+      @all_rows.size.should eq(40)
+    end
+
+    it 'should return documents as Hashes' do
+      @all_rows.each do |row|
+        doc = row['doc']
+        doc.should be_an_instance_of(Hash)
+      end
+    end
+
+    it 'should work even when no documents are returned' do
+      @no_rows.should be_an_instance_of(Array)
+      @no_rows.size.should eq(0)
+    end
+  end
+
+
+  describe 'from #casted_view' do
+    before(:all) do
+      @all_rows = DB.casted_view('generic/by_word')['rows']
+
+      @no_rows  = DB.casted_view('generic/by_word',
+                                  :startkey => 'Zanzibar',
+                                  :endkey => 'Zapfino')['rows']
+    end
+
+    it 'should return an Array' do
+      @all_rows.should be_an_instance_of(Array)
+    end
+
+    it 'should see all documents' do
+      @all_rows.size.should eq(40)
+    end
+
+    it 'should properly cast documents into CouchRest::Model objects' do
+      @all_rows.each do |row|
+        doc = row['doc']
+        doc.should be_an_instance_of(doc['type'].constantize)
+      end
+    end
+
+    it 'should work even when no documents are returned' do
+      @no_rows.should be_an_instance_of(Array)
+      @no_rows.size.should eq(0)
+    end
+
+    it "should keep non-CouchRest::Model documents cast as Hashes" do
+      DB.save_doc({
+        '_id' => 'other-fbenvolio',
+        'name' => 'Francis Benvolio'
+      })
+
+      rows = DB.casted_view('generic/by_word',
+                            :startkey => 'Francis',
+                            :endkey => 'Francis')['rows']
+      rows.size.should eq(1)
+      doc = rows.first['doc']
+      doc['name'].should eq('Francis Benvolio')
+      doc['_id'].should eq('other-fbenvolio')
+      doc.should be_an_instance_of(Hash)
+    end
+  end
+
+end

data/spec/fixtures/models/service.rb

@@ -0,0 +1,6 @@
+class Service < CouchRest::Model::Base
+  use_database DB
+
+  property :name
+  validates_length_of :name, :minimum => 4, :maximum => 20
+end

data/spec/fixtures/models/user.rb

@@ -0,0 +1,7 @@
+class User < CouchRest::Model::Base
+  use_database DB
+
+  property :name, :accessible => true
+  validates_length_of :name, :minimum => 4, :maximum => 20
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,39 @@
+SPEC_PATH = File.expand_path(File.dirname(__FILE__))
+$:.unshift File.expand_path('../lib', SPEC_PATH) # ensure local lib/ is loaded
+
+require "bundler/setup"
+require "rubygems"
+require "couchrest_casted"
+
+FIXTURE_PATH = File.expand_path('fixtures', SPEC_PATH)
+
+COUCHHOST = "http://127.0.0.1:5984"
+TESTDB    = 'couchrest_casted-test'
+
+TEST_SERVER = CouchRest.new(COUCHHOST)
+TEST_SERVER.default_database = TESTDB
+DB = TEST_SERVER.database(TESTDB)
+
+
+def reset_test_db!
+  DB.recreate! rescue nil
+  DB
+end
+
+
+# set up the before and after testing hooks
+RSpec.configure do |config|
+  # start with a fresh database
+  config.before(:all) do
+    reset_test_db!
+  end
+
+  # delete all testing databases
+  config.after(:all) do
+    test_dbs = TEST_SERVER.databases.select { |db| db =~ /^#{TESTDB}/ }
+    test_dbs.each do |db|
+      TEST_SERVER.database(db).delete! rescue nil
+    end
+  end
+end
+

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: couchrest_casted
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Adam Collins
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: couchrest_model
+  requirement: &70356626901180 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70356626901180
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70356626899680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: *70356626899680
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70356626897240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :development
+  prerelease: false
+  version_requirements: *70356626897240
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &70356627720640 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: *70356627720640
+description: Adds methods to CouchRest::Database that automatically cast document
+  JSON data as CouchRest::Model objects
+email: adam@m104.us
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- VERSION
+- README.md
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- couchrest_casted.gemspec
+- lib/couchrest/database/casted_queries.rb
+- lib/couchrest_casted.rb
+- spec/casted_spec.rb
+- spec/fixtures/models/service.rb
+- spec/fixtures/models/user.rb
+- spec/spec_helper.rb
+homepage: https://github.com/m104/couchrest_casted
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Provides model casting methods for CouchRest::Database
+test_files:
+- spec/casted_spec.rb
+- spec/fixtures/models/service.rb
+- spec/fixtures/models/user.rb
+- spec/spec_helper.rb