will_paginate_couchrest 0.1.0

data/.gitignore

@@ -0,0 +1,22 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+*.gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 alex
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,37 @@
+= Will Paginate for Couchrest
+
+Adds support for the will_paginate gem by mislav to {couchrest}[http://github.com/couchrest/couchrest].
+
+Inspired by Kenneth Kalmer's post:
+
+http://www.opensourcery.co.za/2010/02/08/paginating-documents-with-couchrest-and-will_paginate/
+
+Automatically generate views with an extra reduce method used to generate the total number of documents.
+
+== Install
+
+  gem install will_paginate_couchrest
+  
+== Usage
+
+  require 'rubygems'
+  require 'couchrest'
+  require 'will_paginate'
+  require 'will_paginate_couchrest'
+
+  class User < CouchRest::ExtendedDocument
+    
+    property :nickname
+
+    paginated_view_by :nickname
+
+  end
+
+  @users = User.paginate_by_nickname :page => 1, :per_page => 10, :key => 'Fred'
+
+  will_paginate @users
+
+
+== Copyright
+
+Copyright (c) 2010 Sam Lown @ autofiscal S.L. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "will_paginate_couchrest"
+    gem.summary = %Q{adds will-paginate support to CouchRest}
+    gem.description = %Q{generate views specifically with support for using will_paginate with them}
+    gem.email = "me@samlown.com"
+    gem.homepage = "http://github.com/samlown/will_paginate_couchrest"
+    gem.authors = ["samlown"]
+    gem.add_dependency("couchrest", ">= 0.35")
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+  spec.spec_opts = ['--options', "\"spec/spec.opts\""]
+end
+
+namespace :spec do
+  desc "Print Specdoc for all specs"
+  Spec::Rake::SpecTask.new(:doc) do |t|
+    t.spec_opts = ["--format", "specdoc", "--dry-run"]
+    t.spec_files = FileList['spec/**/*_spec.rb']
+  end
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+  spec.rcov_opts = ['--exclude "spec/*,gems/*"']
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "will_paginate_couchrest #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/will_paginate_couchrest.rb

@@ -0,0 +1,145 @@
+# Based on original validators in CouchRest::Validation
+require 'couchrest/mixins/validation'
+
+module CouchRest
+  module Mixins 
+    module WillPaginate
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+        # Define a CouchDB paginate view. The name of the view will be the concatenation
+        # of <tt>paginate_by</tt> and the keys joined by <tt>_and_</tt>
+        #  
+        # ==== Example views:
+        #  
+        #   class Post
+        #     # view with default options
+        #     # query with Post.paginate_by_date
+        #     paginated_view_by :date, :descending => true
+        #  
+        #     # view with compound sort-keys
+        #     # query with Post.by_user_id_and_date
+        #     paginated_view_by :user_id, :date
+        #  
+        #     # view with custom map/reduce functions
+        #     # query with Post.by_tags :reduce => true
+        #     paginated_view_by :tags,                                                
+        #       :map =>                                                     
+        #         "function(doc) {                                          
+        #           if (doc['couchrest-type'] == 'Post' && doc.tags) {                   
+        #             doc.tags.forEach(function(tag){                       
+        #               emit(doc.tag, 1);                                   
+        #             });                                                   
+        #           }                                                       
+        #         }",                                                       
+        #       :reduce =>                                                  
+        #         "function(keys, values, rereduce) {                       
+        #           return sum(values);                                     
+        #         }"                                                        
+        #   end
+        #  
+        # <tt>paginated_view_by :date</tt> will create a view defined by this Javascript
+        # function:
+        #  
+        #   function(doc) {
+        #     if (doc['couchrest-type'] == 'Post' && doc.date) {
+        #       emit(doc.date, 1);
+        #     }
+        #   }
+        #
+        # And a standard summing reduce function like the following:
+        #  
+        #   function(keys, values, rereduce) {                       
+        #     return sum(values);
+        #   } 
+        #
+        # It can be queried by calling <tt>Post.paginate_by_date</tt> which accepts all
+        # valid options for CouchRest::Database#view. In addition, calling with
+        # the <tt>:raw => true</tt> option will return the view rows
+        # themselves. By default <tt>Post.by_date</tt> will return the
+        # documents included in the generated view.
+        #  
+        # For further details on <tt>view_by</tt>'s other options, please see the
+        # standard documentation.
+        
+        def paginated_view_by(*keys)
+
+          # Prepare the Traditional view
+          opts = keys.last.is_a?(Hash) ? keys.pop : {}
+          view_name = "by_#{keys.join('_and_')}"
+          method_name = "paginate_#{view_name}"
+
+          doc_keys = keys.collect{|k| "doc['#{k}']"}
+          key_emit = doc_keys.length == 1 ? "#{doc_keys.first}" : "[#{doc_keys.join(', ')}]"
+          guards = opts.delete(:guards) || []
+          guards.push("(doc['couchrest-type'] == '#{self.to_s}')")
+          guards.concat doc_keys
+
+          opts.reverse_merge!(
+            :map => "
+              function( doc ) {
+                if (#{guards.join(' && ')}) {
+                  emit(#{key_emit}, 1 );
+                }
+              }
+            ",
+            :reduce => "
+              function(keys, values, rereduce) {                       
+                return sum(values);
+              }
+            "
+          )
+
+          # View prepared, send to traditional view_by
+          view_by keys, opts
+
+          instance_eval <<-RUBY_EVAL, __FILE__, __LINE__ + 1
+            def #{method_name}(options = {})
+              paginated_view('#{view_name}', options)
+            end
+          RUBY_EVAL
+
+        end
+
+
+        protected
+
+          ##
+          # Return a WillPaginate collection suitable for usage
+          # 
+          def paginated_view(view_name, options = {})
+            raise "Missing per_page parameter" if options[:per_page].nil?
+
+            options[:page] ||= 1
+
+            ::WillPaginate::Collection.create( options[:page], options[:per_page] ) do |pager|
+              # perform view count first (should create designs if missing)
+              total = view( view_name, options.update(:reduce => true) )['rows'].pop
+              pager.total_entries = total ? total['value'] : 0
+              results = paginate(
+                options.merge(
+                  :design_doc => self.to_s, :view_name => view_name,
+                  :include_docs => true, :reduce => false
+                )
+              )
+              pager.replace( results )
+            end
+          end
+      end
+      
+    end
+  end # module mixins 
+end # module CouchRest
+
+
+# Take the liberty of adding ourself to the couchrest library
+
+module CouchRest
+  class ExtendedDocument < Document
+    include CouchRest::Mixins::WillPaginate
+  end
+end
+

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,31 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'rubygems'
+require 'couchrest'
+require 'will_paginate'
+require 'will_paginate_couchrest'
+require 'spec'
+require 'spec/autorun'
+
+unless defined?(SPEC_COUCH)
+  COUCH_URL = "http://127.0.0.1:5984"
+  COUCH_NAME = 'couchrest-test'
+
+  SPEC_COUCH = CouchRest.database!("#{COUCH_URL}/#{COUCH_NAME}")
+end
+
+def reset_test_db!
+  SPEC_COUCH.recreate! rescue nil 
+  SPEC_COUCH
+end
+
+Spec::Runner.configure do |config|
+  config.before(:all) {
+    reset_test_db!
+  }
+  
+  config.after(:all) do
+    SPEC_COUCH.delete! rescue nil
+  end
+end

data/spec/will_paginate_couchrest_spec.rb

@@ -0,0 +1,60 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe CouchRest::Mixins::WillPaginate do
+  
+  class SomeDoc < CouchRest::ExtendedDocument
+    use_database SPEC_COUCH
+
+    property :name
+
+    paginated_view_by :name
+  end
+
+  it "should respond to paginated_view_by class method" do
+    SomeDoc.should respond_to :paginated_view_by
+  end
+
+  it "should call view_by method when paginated view_by included" do
+    SomeDoc.should_receive(:view_by)
+    class SomeDoc
+      paginated_view_by :name
+    end
+  end
+  
+  it "should respond to the view and paginated method" do
+    SomeDoc.should respond_to :paginate_by_name
+    # @some_doc.stub(:id).and_return(123)
+  end
+
+  describe "performing pagination with lots of documents" do
+
+    before(:each) do
+      reset_test_db!
+      20.times do |i|
+        txt = "%02d" % i
+        SomeDoc.new(:name => "document #{txt}").save
+      end
+    end
+
+    it "should produce a will paginate collection" do
+      docs = SomeDoc.paginate_by_name( :page => 1, :per_page => 5 )
+      docs.class.should eql(::WillPaginate::Collection)
+      docs.total_pages.should eql(4)
+      docs.first.name.should eql('document 00')
+      docs.length.should eql(5)
+      docs.last.name.should eql('document 04')
+    end
+
+    it "should produce second page from paginate collection" do
+      docs = SomeDoc.paginate_by_name( :page => 2, :per_page => 5 )
+      docs.first.name.should eql('document 05')
+      docs.length.should eql(5)
+      docs.last.name.should eql('document 09')
+    end
+
+
+  
+
+  end
+end
+

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification 
+name: will_paginate_couchrest
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- samlown
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-04 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: couchrest
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0.35"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+    version: 
+description: generate views specifically with support for using will_paginate with them
+email: me@samlown.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/will_paginate_couchrest.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/will_paginate_couchrest_spec.rb
+has_rdoc: true
+homepage: http://github.com/samlown/will_paginate_couchrest
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: adds will-paginate support to CouchRest
+test_files: 
+- spec/will_paginate_couchrest_spec.rb
+- spec/spec_helper.rb