Added Collection mixin.
The Collection mixin adds support for executing a view, and passing back the view results as an Array of the given ExtendedDocument instance. It also supports will_paginate like pagination methods (paginate, paginated_each), which will only fetch the given set of documents from CouchDB.
This commit is contained in:
John Wood
Matt Aimonetti
parent
3e2b3ece46
commit
cf76466795
|
|
@ -10,7 +10,7 @@ Gem::Specification.new do |s|
|
||||||
s.description = %q{CouchRest provides a simple interface on top of CouchDB's RESTful HTTP API, as well as including some utility scripts for managing views and attachments.}
|
s.description = %q{CouchRest provides a simple interface on top of CouchDB's RESTful HTTP API, as well as including some utility scripts for managing views and attachments.}
|
||||||
s.email = %q{jchris@apache.org}
|
s.email = %q{jchris@apache.org}
|
||||||
s.extra_rdoc_files = ["README.md", "LICENSE", "THANKS.md"]
|
s.extra_rdoc_files = ["README.md", "LICENSE", "THANKS.md"]
|
||||||
s.files = ["LICENSE", "README.md", "Rakefile", "THANKS.md", "examples/model", "examples/model/example.rb", "examples/word_count", "examples/word_count/markov", "examples/word_count/views", "examples/word_count/views/books", "examples/word_count/views/books/chunked-map.js", "examples/word_count/views/books/united-map.js", "examples/word_count/views/markov", "examples/word_count/views/markov/chain-map.js", "examples/word_count/views/markov/chain-reduce.js", "examples/word_count/views/word_count", "examples/word_count/views/word_count/count-map.js", "examples/word_count/views/word_count/count-reduce.js", "examples/word_count/word_count.rb", "examples/word_count/word_count_query.rb", "examples/word_count/word_count_views.rb", "lib/couchrest", "lib/couchrest/commands", "lib/couchrest/commands/generate.rb", "lib/couchrest/commands/push.rb", "lib/couchrest/core", "lib/couchrest/core/database.rb", "lib/couchrest/core/design.rb", "lib/couchrest/core/document.rb", "lib/couchrest/core/response.rb", "lib/couchrest/core/server.rb", "lib/couchrest/core/view.rb", "lib/couchrest/helper", "lib/couchrest/helper/pager.rb", "lib/couchrest/helper/streamer.rb", "lib/couchrest/helper/upgrade.rb", "lib/couchrest/mixins", "lib/couchrest/mixins/attachments.rb", "lib/couchrest/mixins/callbacks.rb", "lib/couchrest/mixins/class_proxy.rb", "lib/couchrest/mixins/design_doc.rb", "lib/couchrest/mixins/document_queries.rb", "lib/couchrest/mixins/extended_attachments.rb", "lib/couchrest/mixins/extended_document_mixins.rb", "lib/couchrest/mixins/properties.rb", "lib/couchrest/mixins/validation.rb", "lib/couchrest/mixins/views.rb", "lib/couchrest/mixins.rb", "lib/couchrest/monkeypatches.rb", "lib/couchrest/more", "lib/couchrest/more/casted_model.rb", "lib/couchrest/more/extended_document.rb", "lib/couchrest/more/property.rb", "lib/couchrest/support", "lib/couchrest/support/blank.rb", "lib/couchrest/support/class.rb", "lib/couchrest/support/rails.rb", "lib/couchrest/validation", "lib/couchrest/validation/auto_validate.rb", "lib/couchrest/validation/contextual_validators.rb", "lib/couchrest/validation/validation_errors.rb", "lib/couchrest/validation/validators", "lib/couchrest/validation/validators/absent_field_validator.rb", "lib/couchrest/validation/validators/confirmation_validator.rb", "lib/couchrest/validation/validators/format_validator.rb", "lib/couchrest/validation/validators/formats", "lib/couchrest/validation/validators/formats/email.rb", "lib/couchrest/validation/validators/formats/url.rb", "lib/couchrest/validation/validators/generic_validator.rb", "lib/couchrest/validation/validators/length_validator.rb", "lib/couchrest/validation/validators/method_validator.rb", "lib/couchrest/validation/validators/numeric_validator.rb", "lib/couchrest/validation/validators/required_field_validator.rb", "lib/couchrest.rb", "spec/couchrest", "spec/couchrest/core", "spec/couchrest/core/couchrest_spec.rb", "spec/couchrest/core/database_spec.rb", "spec/couchrest/core/design_spec.rb", "spec/couchrest/core/document_spec.rb", "spec/couchrest/core/server_spec.rb", "spec/couchrest/helpers", "spec/couchrest/helpers/pager_spec.rb", "spec/couchrest/helpers/streamer_spec.rb", "spec/couchrest/more", "spec/couchrest/more/casted_extended_doc_spec.rb", "spec/couchrest/more/casted_model_spec.rb", "spec/couchrest/more/extended_doc_attachment_spec.rb", "spec/couchrest/more/extended_doc_spec.rb", "spec/couchrest/more/extended_doc_subclass_spec.rb", "spec/couchrest/more/extended_doc_view_spec.rb", "spec/couchrest/more/property_spec.rb", "spec/fixtures", "spec/fixtures/attachments", "spec/fixtures/attachments/couchdb.png", "spec/fixtures/attachments/README", "spec/fixtures/attachments/test.html", "spec/fixtures/more", "spec/fixtures/more/article.rb", "spec/fixtures/more/card.rb", "spec/fixtures/more/cat.rb", "spec/fixtures/more/course.rb", "spec/fixtures/more/event.rb", "spec/fixtures/more/invoice.rb", "spec/fixtures/more/person.rb", "spec/fixtures/more/question.rb", "spec/fixtures/more/service.rb", "spec/fixtures/views", "spec/fixtures/views/lib.js", "spec/fixtures/views/test_view", "spec/fixtures/views/test_view/lib.js", "spec/fixtures/views/test_view/only-map.js", "spec/fixtures/views/test_view/test-map.js", "spec/fixtures/views/test_view/test-reduce.js", "spec/spec.opts", "spec/spec_helper.rb", "utils/remap.rb", "utils/subset.rb"]
|
s.files = ["LICENSE", "README.md", "Rakefile", "THANKS.md", "examples/model", "examples/model/example.rb", "examples/word_count", "examples/word_count/markov", "examples/word_count/views", "examples/word_count/views/books", "examples/word_count/views/books/chunked-map.js", "examples/word_count/views/books/united-map.js", "examples/word_count/views/markov", "examples/word_count/views/markov/chain-map.js", "examples/word_count/views/markov/chain-reduce.js", "examples/word_count/views/word_count", "examples/word_count/views/word_count/count-map.js", "examples/word_count/views/word_count/count-reduce.js", "examples/word_count/word_count.rb", "examples/word_count/word_count_query.rb", "examples/word_count/word_count_views.rb", "lib/couchrest", "lib/couchrest/commands", "lib/couchrest/commands/generate.rb", "lib/couchrest/commands/push.rb", "lib/couchrest/core", "lib/couchrest/core/database.rb", "lib/couchrest/core/design.rb", "lib/couchrest/core/document.rb", "lib/couchrest/core/response.rb", "lib/couchrest/core/server.rb", "lib/couchrest/core/view.rb", "lib/couchrest/helper", "lib/couchrest/helper/pager.rb", "lib/couchrest/helper/streamer.rb", "lib/couchrest/helper/upgrade.rb", "lib/couchrest/mixins", "lib/couchrest/mixins/attachments.rb", "lib/couchrest/mixins/callbacks.rb", "lib/couchrest/mixins/class_proxy.rb", "lib/couchrest/mixins/collection.rb", "lib/couchrest/mixins/design_doc.rb", "lib/couchrest/mixins/document_queries.rb", "lib/couchrest/mixins/extended_attachments.rb", "lib/couchrest/mixins/extended_document_mixins.rb", "lib/couchrest/mixins/properties.rb", "lib/couchrest/mixins/validation.rb", "lib/couchrest/mixins/views.rb", "lib/couchrest/mixins.rb", "lib/couchrest/monkeypatches.rb", "lib/couchrest/more", "lib/couchrest/more/casted_model.rb", "lib/couchrest/more/extended_document.rb", "lib/couchrest/more/property.rb", "lib/couchrest/support", "lib/couchrest/support/blank.rb", "lib/couchrest/support/class.rb", "lib/couchrest/support/rails.rb", "lib/couchrest/validation", "lib/couchrest/validation/auto_validate.rb", "lib/couchrest/validation/contextual_validators.rb", "lib/couchrest/validation/validation_errors.rb", "lib/couchrest/validation/validators", "lib/couchrest/validation/validators/absent_field_validator.rb", "lib/couchrest/validation/validators/confirmation_validator.rb", "lib/couchrest/validation/validators/format_validator.rb", "lib/couchrest/validation/validators/formats", "lib/couchrest/validation/validators/formats/email.rb", "lib/couchrest/validation/validators/formats/url.rb", "lib/couchrest/validation/validators/generic_validator.rb", "lib/couchrest/validation/validators/length_validator.rb", "lib/couchrest/validation/validators/method_validator.rb", "lib/couchrest/validation/validators/numeric_validator.rb", "lib/couchrest/validation/validators/required_field_validator.rb", "lib/couchrest.rb", "spec/couchrest", "spec/couchrest/core", "spec/couchrest/core/couchrest_spec.rb", "spec/couchrest/core/database_spec.rb", "spec/couchrest/core/design_spec.rb", "spec/couchrest/core/document_spec.rb", "spec/couchrest/core/server_spec.rb", "spec/couchrest/helpers", "spec/couchrest/helpers/pager_spec.rb", "spec/couchrest/helpers/streamer_spec.rb", "spec/couchrest/more", "spec/couchrest/more/casted_extended_doc_spec.rb", "spec/couchrest/more/casted_model_spec.rb", "spec/couchrest/more/extended_doc_attachment_spec.rb", "spec/couchrest/more/extended_doc_spec.rb", "spec/couchrest/more/extended_doc_subclass_spec.rb", "spec/couchrest/more/extended_doc_view_spec.rb", "spec/couchrest/more/property_spec.rb", "spec/fixtures", "spec/fixtures/attachments", "spec/fixtures/attachments/couchdb.png", "spec/fixtures/attachments/README", "spec/fixtures/attachments/test.html", "spec/fixtures/more", "spec/fixtures/more/article.rb", "spec/fixtures/more/card.rb", "spec/fixtures/more/cat.rb", "spec/fixtures/more/course.rb", "spec/fixtures/more/event.rb", "spec/fixtures/more/invoice.rb", "spec/fixtures/more/person.rb", "spec/fixtures/more/question.rb", "spec/fixtures/more/service.rb", "spec/fixtures/views", "spec/fixtures/views/lib.js", "spec/fixtures/views/test_view", "spec/fixtures/views/test_view/lib.js", "spec/fixtures/views/test_view/only-map.js", "spec/fixtures/views/test_view/test-map.js", "spec/fixtures/views/test_view/test-reduce.js", "spec/spec.opts", "spec/spec_helper.rb", "utils/remap.rb", "utils/subset.rb"]
|
||||||
s.has_rdoc = true
|
s.has_rdoc = true
|
||||||
s.homepage = %q{http://github.com/jchris/couchrest}
|
s.homepage = %q{http://github.com/jchris/couchrest}
|
||||||
s.require_paths = ["lib"]
|
s.require_paths = ["lib"]
|
||||||
|
|
|
||||||
153
lib/couchrest/mixins/collection.rb
Normal file
153
lib/couchrest/mixins/collection.rb
Normal file
|
|
@ -0,0 +1,153 @@
|
||||||
|
module CouchRest
|
||||||
|
module Mixins
|
||||||
|
module Collection
|
||||||
|
|
||||||
|
def self.included(base)
|
||||||
|
base.extend(ClassMethods)
|
||||||
|
end
|
||||||
|
|
||||||
|
module ClassMethods
|
||||||
|
def provides_collection(collection_name, collection_options)
|
||||||
|
class_eval <<-END, __FILE__, __LINE__ + 1
|
||||||
|
def self.find_all_#{collection_name}(options = {})
|
||||||
|
view_name = "#{collection_options[:through][:view_name]}"
|
||||||
|
view_options = #{collection_options[:through][:view_options].inspect} || {}
|
||||||
|
CollectionProxy.new(@database, view_name, view_options.merge(options), Kernel.const_get('#{self}'))
|
||||||
|
end
|
||||||
|
END
|
||||||
|
end
|
||||||
|
|
||||||
|
def paginate(options)
|
||||||
|
proxy = create_collection_proxy(options)
|
||||||
|
proxy.paginate(options)
|
||||||
|
end
|
||||||
|
|
||||||
|
def paginated_each(options, &block)
|
||||||
|
proxy = create_collection_proxy(options)
|
||||||
|
proxy.paginated_each(options, &block)
|
||||||
|
end
|
||||||
|
|
||||||
|
private
|
||||||
|
|
||||||
|
def create_collection_proxy(options)
|
||||||
|
view_name, view_options = parse_view_options(options)
|
||||||
|
CollectionProxy.new(@database, view_name, view_options, self)
|
||||||
|
end
|
||||||
|
|
||||||
|
def parse_view_options(options)
|
||||||
|
raise ArgumentError, 'parameter hash expected' unless options.respond_to? :symbolize_keys
|
||||||
|
options = options.symbolize_keys
|
||||||
|
|
||||||
|
view_name = options.delete(:view_name)
|
||||||
|
raise ArgumentError, 'view_name is required' if view_name.nil?
|
||||||
|
|
||||||
|
view_options = options.delete(:view_options) || {}
|
||||||
|
|
||||||
|
[view_name, view_options]
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
class CollectionProxy
|
||||||
|
alias_method :proxy_respond_to?, :respond_to?
|
||||||
|
instance_methods.each { |m| undef_method m unless m =~ /(^__|^nil\?$|^send$|proxy_|^object_id$)/ }
|
||||||
|
|
||||||
|
def initialize(database, view_name, view_options = {}, container_class = nil)
|
||||||
|
@container_class = container_class
|
||||||
|
@database = database
|
||||||
|
@view_name = view_name
|
||||||
|
@view_options = view_options
|
||||||
|
end
|
||||||
|
|
||||||
|
def paginate(options = {})
|
||||||
|
page, per_page = parse_options(options)
|
||||||
|
rows = @database.view(@view_name, @view_options.merge(pagination_options(page, per_page)))['rows']
|
||||||
|
convert_to_container_array(rows)
|
||||||
|
end
|
||||||
|
|
||||||
|
def paginated_each(options = {}, &block)
|
||||||
|
page, per_page = parse_options(options)
|
||||||
|
|
||||||
|
begin
|
||||||
|
collection = paginate({:page => page, :per_page => per_page})
|
||||||
|
collection.each(&block)
|
||||||
|
page += 1
|
||||||
|
end until collection.size < per_page
|
||||||
|
end
|
||||||
|
|
||||||
|
def respond_to?(*args)
|
||||||
|
proxy_respond_to?(*args) || (load_target && @target.respond_to?(*args))
|
||||||
|
end
|
||||||
|
|
||||||
|
# Explicitly proxy === because the instance method removal above
|
||||||
|
# doesn't catch it.
|
||||||
|
def ===(other)
|
||||||
|
load_target
|
||||||
|
other === @target
|
||||||
|
end
|
||||||
|
|
||||||
|
private
|
||||||
|
|
||||||
|
def method_missing(method, *args)
|
||||||
|
if load_target
|
||||||
|
if block_given?
|
||||||
|
@target.send(method, *args) { |*block_args| yield(*block_args) }
|
||||||
|
else
|
||||||
|
@target.send(method, *args)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
def load_target
|
||||||
|
unless loaded?
|
||||||
|
rows = @database.view(@view_name, @view_options)['rows']
|
||||||
|
@target = convert_to_container_array(rows)
|
||||||
|
end
|
||||||
|
@loaded = true
|
||||||
|
@target
|
||||||
|
end
|
||||||
|
|
||||||
|
def loaded?
|
||||||
|
@loaded
|
||||||
|
end
|
||||||
|
|
||||||
|
def reload
|
||||||
|
reset
|
||||||
|
load_target
|
||||||
|
self unless @target.nil?
|
||||||
|
end
|
||||||
|
|
||||||
|
def reset
|
||||||
|
@loaded = false
|
||||||
|
@target = nil
|
||||||
|
end
|
||||||
|
|
||||||
|
def inspect
|
||||||
|
load_target
|
||||||
|
@target.inspect
|
||||||
|
end
|
||||||
|
|
||||||
|
def convert_to_container_array(rows)
|
||||||
|
return rows if @container_class.nil?
|
||||||
|
|
||||||
|
container = []
|
||||||
|
rows.each { |row| container << @container_class.new(row['value']) } unless rows.nil?
|
||||||
|
container
|
||||||
|
end
|
||||||
|
|
||||||
|
def pagination_options(page, per_page)
|
||||||
|
{ :limit => per_page, :skip => per_page * (page - 1) }
|
||||||
|
end
|
||||||
|
|
||||||
|
def parse_options(options)
|
||||||
|
raise ArgumentError, 'parameter hash expected' unless options.respond_to? :symbolize_keys
|
||||||
|
options = options.symbolize_keys
|
||||||
|
|
||||||
|
page = options[:page] || 1
|
||||||
|
per_page = options[:per_page] || 30
|
||||||
|
[page, per_page]
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
@ -5,3 +5,4 @@ require File.join(File.dirname(__FILE__), 'design_doc')
|
||||||
require File.join(File.dirname(__FILE__), 'validation')
|
require File.join(File.dirname(__FILE__), 'validation')
|
||||||
require File.join(File.dirname(__FILE__), 'extended_attachments')
|
require File.join(File.dirname(__FILE__), 'extended_attachments')
|
||||||
require File.join(File.dirname(__FILE__), 'class_proxy')
|
require File.join(File.dirname(__FILE__), 'class_proxy')
|
||||||
|
require File.join(File.dirname(__FILE__), 'collection')
|
||||||
|
|
|
||||||
|
|
@ -13,6 +13,7 @@ module CouchRest
|
||||||
include CouchRest::Mixins::DesignDoc
|
include CouchRest::Mixins::DesignDoc
|
||||||
include CouchRest::Mixins::ExtendedAttachments
|
include CouchRest::Mixins::ExtendedAttachments
|
||||||
include CouchRest::Mixins::ClassProxy
|
include CouchRest::Mixins::ClassProxy
|
||||||
|
include CouchRest::Mixins::Collection
|
||||||
|
|
||||||
def self.subclasses
|
def self.subclasses
|
||||||
@subclasses ||= []
|
@subclasses ||= []
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue