active_resource_pagination 0.0.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

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

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Dorren Chen
+
+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,17 @@
+= active_resource_pagination
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Dorren Chen. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "active_resource_pagination"
+    gem.summary = %Q{Adds pagination to Active Resource}
+    gem.description = %Q{Adds pagination to Active Resource}
+    gem.email = "dorrenchen@gmail.com"
+    gem.homepage = "http://github.com/dorren/active_resource_pagination"
+    gem.authors = ["Dorren Chen"]
+    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']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+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 = "active_resource_pagination #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

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

data/lib/active_resource_pagination.rb

@@ -0,0 +1,52 @@
+require 'active_resource'
+require 'will_paginate'
+
+module ActiveResource
+  # This adds pagination support to Active Resource. For example
+  #
+  #   Article.paginate
+  #   Article.paginate(:all, :page => 2, :per_page => 20)
+  #   Article.paginate(:all, :page => 2, :per_page => 20, :total_entries => 123)
+  #   Article.paginate(:all, :from => :most_popular,
+  #                    :params => {:year => 2010, :page => 1, :per_page => 20})
+  module Pagination
+    def self.included(base)
+      base.extend ClassMethods
+    end
+    
+    module ClassMethods
+      # can be overrided in subclass
+      def per_page
+        10
+      end
+      
+      # use same method signatures as find(), optional additional parameters: 
+      #   page - current page
+      #   per_pape - entries per page
+      #   total_entries - total entries count
+      #
+      # if resource backend doesn't paginate and retursn all result, then this method automatically
+      # sets the total_entry count from the result. Otherwise, you have to pass in the 
+      # :total_entries count value manually.
+      def paginate(*args)
+        options = args.last || {}
+        options = options[:params] || options
+        options = {:page => 1, :per_page => per_page}.merge(options)
+        page = options[:page]
+        per_page = options[:per_page]
+        
+        arr = find(*args)
+        total_entries = options[:total_entries] || arr.size 
+        WillPaginate::Collection.create(page, per_page, total_entries) do |pager|
+          if arr.size > per_page
+            pager.replace arr[pager.offset, pager.per_page]
+          else
+            pager.replace arr
+          end
+        end
+      end
+    end
+  end
+end
+
+ActiveResource::Base.send :include, ActiveResource::Pagination

data/spec/active_resource_pagination_spec.rb

@@ -0,0 +1,65 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe ActiveResource::Pagination do
+  describe "##paginate" do
+    before(:all) do
+      class Article < ActiveResource::Base
+        self.site = ''
+        
+        def self.per_page
+          2
+        end
+        
+        def self.from_xml(xml)
+          instantiate_collection(format.decode(xml))
+        end
+      end
+
+      # generate 5 articles, per_page is 2
+      xml = (1..5).collect{|x|  {:name => "article #{x}", :content => "blah blah #{x}"}}.to_xml(:root => "articles")
+      @articles = Article.from_xml(xml)
+    end
+    
+    it "should respond to paginate" do
+      ActiveResource::Base.should respond_to(:paginate)
+    end
+    
+    it "should override per_page" do
+      Article.per_page.should == 2
+    end
+
+    describe "when backend does not paginate" do  
+      before(:each) do
+        Article.should_receive(:find).and_return(@articles)      
+      end
+          
+      it "should paginate with no params" do
+        col = Article.paginate
+        col.current_page.should == 1
+        col.per_page.should == Article.per_page
+        col.total_entries.should == @articles.size
+        col.total_pages.should == 3  # (col.total_entries / col.per_page.to_f).ceil
+      end
+      
+      it "should paginate with params" do
+        col = Article.paginate(:page => 2)
+        col.current_page.should == 2
+        col.first.should == @articles[3]
+      end
+    end
+
+    describe "when backend do paginate" do
+      it "should paginate when backend returns paginated entries" do
+        @articles = @articles[2,2]  # returns 2nd page result
+        Article.should_receive(:find).and_return(@articles)
+        
+        col = Article.paginate(:page => 2, :total_entries => 5)
+        col.current_page.should == 2
+        col.per_page.should == Article.per_page
+        col.total_entries.should == 5
+        col.total_pages.should == 3  # (col.total_entries / col.per_page.to_f).ceil
+        col.first.should == @articles.first
+      end
+    end
+  end
+end

data/spec/spec.opts

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

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'active_resource_pagination'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification 
+name: active_resource_pagination
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Dorren Chen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-02 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+description: Adds pagination to Active Resource
+email: dorrenchen@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/active_resource_pagination.rb
+- spec/active_resource_pagination_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/dorren/active_resource_pagination
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Adds pagination to Active Resource
+test_files: 
+- spec/active_resource_pagination_spec.rb
+- spec/spec_helper.rb