pageboy 0.1

data/lib/pageboy.rb

@@ -0,0 +1,39 @@
+require 'pageboy/config'
+require 'pageboy/collator'
+require 'pageboy/page'
+require 'pageboy/page_turner/array'
+require 'pageboy/page_turner/link_header'
+
+module Pageboy
+  def self.paginate(target, opts={})
+    Pageboy::Config.turners.each_pair do |page_turner_class, matchers|
+      matchers.each do |matcher|
+        return page_turner_class.new(target, opts) if matcher.call(target)
+      end
+    end
+    raise "could not find suitable PageTurner for #{target}"
+  end
+
+  def self.each(target, opts={}, &block)
+    page_turner = paginate(target, opts)
+    Pageboy::Collator(page_turner).each(&block)
+  end
+
+  def self.map(target, opts={}, &block)
+    page_turner = paginate(target, opts)
+    Pageboy::Collator(page_turner).map(&block)
+  end
+
+  def self.register_page_turner(klass, &block)
+    Pageboy::Config.turners[klass] ||= []
+    Pageboy::Config.turners[klass] << block
+  end
+end
+
+Pageboy.register_page_turner(Pageboy::PageTurner::Array) do |object|
+  object.respond_to?(:[]) && object.respond_to?(:size)
+end
+
+Pageboy.register_page_turner(Pageboy::PageTurner::LinkHeader) do |object|
+  object.is_a?(String) && object.include?('/api/')
+end

data/lib/pageboy/collator.rb

@@ -0,0 +1,19 @@
+module Pageboy
+  class Collator
+    include Enumerable
+
+    def initialize(page_turner)
+      @page_turner = page_turner
+    end
+
+    def each(&block)
+      page = @page_turner.first
+      while page
+        page.items.each(&block)
+        page = page.next
+      end
+    end
+  end
+end
+
+# Pageboy::Collator.new(page_turner).each { |item| }

data/lib/pageboy/config.rb

@@ -0,0 +1,18 @@
+require 'active_support/configurable'
+
+module Pageboy
+  module Config
+    include ActiveSupport::Configurable
+    config_accessor :per_page
+    config_accessor :turners
+
+    def configure
+      yield self
+    end
+  end
+end
+
+Pageboy::Config.configure do |config|
+  config.per_page = 25
+  config.turners = {}
+end

data/lib/pageboy/page.rb

@@ -0,0 +1,28 @@
+module Pageboy
+  class Page
+    attr_reader :items
+
+    def initialize(turner, items, prev_page_id, next_page_id)
+      @turner = turner
+      @items = items
+      @prev_page_id = prev_page_id
+      @next_page_id = next_page_id
+    end
+
+    def prev
+      @turner.page(@prev_page_id) if @prev_page_id
+    end
+
+    def next
+      @turner.page(@next_page_id) if @next_page_id
+    end
+
+    def to_a
+      @items
+    end
+
+    def each(&block)
+      @items.each(&block)
+    end
+  end
+end

data/lib/pageboy/page_turner/array.rb

@@ -0,0 +1,24 @@
+require 'pageboy/page_turner/base'
+
+module Pageboy
+  module PageTurner
+    class Array < Base
+
+      def page(page_id, opts={})
+        with_merged_options(opts) do |o|
+          per_page = Integer(o[:per_page])
+          i = Integer(page_id)
+          max_page = (resource.size.to_f / per_page).ceil
+          prev_page_id = i - 1 < 1 ? nil : i - 1
+          next_page_id = i + 1 > max_page ? nil : i + 1
+
+          first_item_index = (i-1) * per_page
+          last_item_index = i * per_page - 1
+          slice = resource[first_item_index..last_item_index]
+          Page.new(self, slice, prev_page_id, next_page_id)
+        end
+      end
+
+    end
+  end
+end

data/lib/pageboy/page_turner/base.rb

@@ -0,0 +1,36 @@
+require 'pageboy/page'
+require 'pageboy/config'
+
+module Pageboy
+  module PageTurner
+    class Base
+      attr_accessor :resource
+
+      def initialize(resource, opts={})
+        @resource = resource
+        @opts = opts
+      end
+
+      # Can be overridden in subclasses
+      def first_page_id
+        # Some PageTurners use integers, others use GUIDs etc., 
+        # but page numbers are most common, so default to 1.
+        1
+      end
+
+      # Should return a Pageboy::Page object
+      def page(page_id, opts={})
+        raise NotImplementedError,
+              "'page' should be implemented in subclasses"
+      end
+
+      def first(opts={})
+        page(first_page_id, opts)
+      end
+
+      def with_merged_options(opts={})
+        yield Pageboy::Config.config.merge(@opts).merge(opts)
+      end
+    end
+  end
+end

data/lib/pageboy/page_turner/link_header.rb

@@ -0,0 +1,39 @@
+require "link_header"
+require "pageboy/page_turner/base"
+
+module Pageboy
+  module PageTurner
+    class LinkHeader < Base
+
+      def initialize(url, opts={})
+        super
+        @url = url
+        @connection = opts.delete(:connection) or
+          fail("LinkHeader page turner requires :connection")
+        @first_page_id = url.dup
+      end
+
+      def first_page_id
+        @first_page_id
+      end
+
+      def find_link(header, rel)
+        link = ::LinkHeader.parse(header).links.find{ |link| link['rel'] == rel }
+        link.to_a.first if link
+      end
+
+      def page(url, opts={})
+        with_merged_options(opts) do |o|
+          response = @connection.get(url)
+          header = response.headers[:link]
+          # require 'debugger';debugger
+          next_page = find_link(header, 'next')
+          slice = response.body
+
+          Page.new(self, slice, nil, next_page)
+        end
+      end
+
+    end
+  end
+end

data/lib/pageboy/version.rb

@@ -0,0 +1,3 @@
+module Pageboy
+  VERSION = '0.1'
+end

data/pageboy.gemspec

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pageboy/version'
+
+Gem::Specification.new do |gem|
+  gem.authors =       ["Duane Johnson"]
+  gem.email =         ["duane@instructure.com"]
+  gem.description =   %q{Paginator}
+  gem.summary =       %q{Paginator for collections of unknown size}
+
+  gem.files = %w[pageboy.gemspec]
+  gem.files += Dir.glob("lib/**/*.rb")
+  gem.files += Dir.glob("spec/**/*")
+  gem.test_files    = Dir.glob("spec/**/*")
+  gem.name          = "pageboy"
+  gem.require_paths = ["lib"]
+  gem.version       = Pageboy::VERSION
+
+  gem.add_development_dependency "bundler", ">= 1.0.0"
+  gem.add_development_dependency "rspec", "~> 2.6"
+  gem.add_development_dependency "webmock"
+  gem.add_development_dependency "debugger"
+
+  # Used for configuration on modules and classes
+  gem.add_dependency "activesupport", ">= 3.0.0"
+
+  # HTTP library
+  gem.add_dependency "faraday", "~> 0.8.8"
+
+  # Parses Link headers formatted according to RFC 5988 draft spec
+  gem.add_dependency "link_header", ">= 0.0.7"
+end

data/spec/collator_spec.rb

@@ -0,0 +1,21 @@
+require 'pageboy/page_turner/array'
+require 'pageboy/collator'
+
+describe Pageboy::Collator do
+  let(:array) { %w(some words to paginate) }
+  let(:page_turner) { Pageboy::PageTurner::Array.new(array, :per_page => 3) }
+  let(:collator) { Pageboy::Collator.new(page_turner) }
+
+  it "collates with each" do
+    items = []
+    collator.each do |item|
+      items << item
+    end
+    items.should == %w(some words to paginate)
+  end
+
+  it "collates with map" do
+    collator.map { |item| item + '.' }.
+      should == %w(some. words. to. paginate.)
+  end
+end

data/spec/link_header_spec.rb

@@ -0,0 +1,41 @@
+require 'webmock/rspec'
+require 'faraday'
+require 'pageboy/page_turner/link_header'
+
+describe Pageboy do
+  context "for an API with link headers" do
+    let(:connection) { Faraday.new }
+    let(:url) { 'http://canvas.dev/api/v1/thing' }
+    let(:link_header) do
+      Pageboy::PageTurner::LinkHeader.new(url,
+        :connection => connection, :per_page => 3)
+    end
+
+    it "paginates a Link header based API" do
+      next_link = %{<http://canvas.dev/api/v1/thing?page=2>; rel="next"}
+
+      # First page
+      stub_request(:get, "http://canvas.dev/api/v1/thing").
+        to_return(
+          :status => 200,
+          :body => [{"name" => "test1"}],
+          :headers => {"Link" => next_link})
+      page = link_header.first
+      page.items.should == [{"name" => "test1"}]
+
+      # Second page
+      stub_request(:get, "http://canvas.dev/api/v1/thing?page=2").
+        to_return(
+          :status => 200,
+          :body => [{"name" => "test2"}],
+          :headers => {})
+      page = page.next
+      page.items.should == [{"name" => "test2"}]
+
+      # No more pages
+      page = page.next
+      page.should be_nil
+
+    end
+  end
+end

data/spec/pageboy_spec.rb

@@ -0,0 +1,27 @@
+require_relative '../lib/pageboy'
+
+describe Pageboy do
+  context "for an array" do
+    let(:array) { %w(this is an array with words in it) }
+    let(:turner) { Pageboy::PageTurner::Array.new(array, :per_page => 3) }
+
+    it "paginates an array" do
+      turner.first.prev.should be_nil
+      turner.first.to_a.should == %w(this is an)
+      turner.first.next.to_a.should == %w(array with words)
+      turner.first.next.next.to_a.should == %w(in it)
+      turner.first.next.next.next.should be_nil
+    end
+
+    it "can turn to any page" do
+      turner.page(2).to_a.should == %w(array with words)
+    end
+  end
+
+  context "matching for page turners" do
+    it "chooses PageTurner::Array for arrays" do
+      turner = Pageboy.paginate([])
+      turner.should be_a(Pageboy::PageTurner::Array)
+    end
+  end
+end

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification
+name: pageboy
+version: !ruby/object:Gem::Version
+  version: '0.1'
+  prerelease: 
+platform: ruby
+authors:
+- Duane Johnson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: debugger
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.8
+- !ruby/object:Gem::Dependency
+  name: link_header
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.7
+description: Paginator
+email:
+- duane@instructure.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- pageboy.gemspec
+- lib/pageboy/collator.rb
+- lib/pageboy/config.rb
+- lib/pageboy/page.rb
+- lib/pageboy/page_turner/array.rb
+- lib/pageboy/page_turner/base.rb
+- lib/pageboy/page_turner/link_header.rb
+- lib/pageboy/version.rb
+- lib/pageboy.rb
+- spec/collator_spec.rb
+- spec/link_header_spec.rb
+- spec/pageboy_spec.rb
+homepage: 
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Paginator for collections of unknown size
+test_files:
+- spec/collator_spec.rb
+- spec/link_header_spec.rb
+- spec/pageboy_spec.rb
+has_rdoc: