appengine-paginator 0.1.0

data/.document

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

data/.gitignore

@@ -0,0 +1,26 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+.gems
+WEB-INF/lib
+WEB-INF/appengine-generated
+config.ru
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/Gemfile

@@ -0,0 +1,9 @@
+# Critical default settings:
+disable_system_gems
+disable_rubygems
+bundle_path ".gems/bundler_gems"
+
+# List gems to bundle here:
+gem 'rspec'
+gem 'dm-appengine'
+gem 'dm-core'

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Josh Moore
+
+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 @@
+= appengine-paginator
+
+This is a gem that will help you to get pagination working on the Google AppEngine.  It uses the AppEngien Cursor so currently you can only get the next cursor, you cannot go in reverse and get previous records.  In order to do that you would need to have two queries.  
+
+== Installation
+
+gem install appengine-paginator
+
+then
+
+require 'appengine-paginator'
+
+== Usage
+
+Simply create a paginate object by passing it an AppEngine::Datastore::Query object, the limit, then an optional model and option cursor.
+
+i.e. p = Paginate.new(query, 10, :model => Post, :cursor => c)
+
+The query and the limit are pretty self explanitory.  The :model is an optional datamapper model that is used if you want the paginate object to return active record models.  The cursor is what tells the query where to start, thus giving it pagination.
+
+Once the paginate object is created you can access the results by either calling result or datamapper_result.  The result method returns the raw entities returned by the query.  The datastore_result method returns an array of Datamapper models that are instiances of the the model class (the class you passed in at creating time).  If a cursor is passed in then the result set will start with the record indicated by the cursor (i.e. if you passed in a limit of 10 and then created the cursor it would point to the 11th search result).
+
+In order to get the cursor simply call cursor on the paginate object.  This will return an instance of Cursor (a wrapper for com.google.appengine.api.datastore.Cursor) which points to the first row after the given limit.  Simple call to_s on the cursor object to get a string representation that can be stored in a session, the datastore, or on the rendered HTML page.  Calling Cursor.parse <string_representation_of_cursor> will convert the cursor string back into a cursor object that can be passed into a new Paginate object.
+
+== 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 Josh Moore. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "appengine-paginator"
+    gem.summary = %Q{A gem to assist in pagination for the Google AppEngine}
+    gem.description = %Q{Pagination on JRuby running on the Google AppEngine}
+    gem.email = "josh@codingforrent.com"
+    gem.homepage = "http://github.com/joshsmoore@gmail.com/appengine-paginator"
+    gem.authors = ["Josh Moore"]
+    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 = "appengine-paginator #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

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

data/WEB-INF/app.yaml

@@ -0,0 +1 @@
+public_root: public

data/bin/autospec

@@ -0,0 +1,3 @@
+#!/Users/jmoore/.rvm/rubies/ree-1.8.7-2010.02/bin/ruby
+require File.expand_path(File.join(File.dirname(__FILE__), "../.gems/bundler_gems/jruby/1.8/environment"))
+load File.expand_path(File.join(File.dirname(__FILE__), "../.gems/bundler_gems/jruby/1.8/gems/rspec-1.3.0/bin/autospec"))

data/bin/rackup

@@ -0,0 +1,3 @@
+#!/Users/jmoore/.rvm/rubies/ree-1.8.7-2010.02/bin/ruby
+require File.expand_path(File.join(File.dirname(__FILE__), "../.gems/bundler_gems/jruby/1.8/environment"))
+load File.expand_path(File.join(File.dirname(__FILE__), "../.gems/bundler_gems/jruby/1.8/gems/rack-1.2.1/bin/rackup"))

data/bin/spec

@@ -0,0 +1,3 @@
+#!/Users/jmoore/.rvm/rubies/ree-1.8.7-2010.02/bin/ruby
+require File.expand_path(File.join(File.dirname(__FILE__), "../.gems/bundler_gems/jruby/1.8/environment"))
+load File.expand_path(File.join(File.dirname(__FILE__), "../.gems/bundler_gems/jruby/1.8/gems/rspec-1.3.0/bin/spec"))

data/lib/appengine-paginator.rb

@@ -0,0 +1,3 @@
+require 'paginate'
+require 'cursor'
+

data/lib/cursor.rb

@@ -0,0 +1,19 @@
+class Cursor
+
+  def initialize(cursor)
+    @_cursor = cursor
+  end
+
+  def to_s
+    @_cursor.to_web_safe_string
+  end
+
+  def self.parse(cursor_string)
+    Cursor.new Java::comGoogleAppengineApiDatastore::Cursor.from_web_safe_string(cursor_string)
+  end
+
+
+  def to_java
+    @_cursor
+  end
+end

data/lib/paginate.rb

@@ -0,0 +1,55 @@
+class Paginate
+  attr_reader :query, :limit, :options
+  def initialize(query, limit, *options)
+    @query = query
+    @limit = limit
+    @options = options.first || {}
+  end
+
+  def result
+    if options[:cursor].nil?
+      @query.pquery.as_query_result_list(query.convert_options(:limit => limit)[1])
+    else
+      java_cursor = options[:cursor].instance_of?(Cursor) ? options[:cursor].to_java : options[:cursor]
+      @query.pquery.as_query_result_list(query.convert_options(:limit => limit)[1].cursor(java_cursor))
+    end
+  end
+
+  def datamapper_result
+    model = options[:model]
+    dm_query =Struct.new(:repository, :fields, :reload?).new(DataMapper::repository, model.properties, false)
+    result.collect {|e| model.load([Paginate.entity_to_hash(e, model.properties)], dm_query)}.flatten
+  end
+
+  def cursor
+    Cursor.new result.cursor
+  end
+
+  #This should be moved to the Adapter
+  def self.entity_to_hash(entity, properties)
+    return if entity.nil?
+    key = entity.get_key
+    hash = {}
+    properties.each do |property|
+      name = property.field
+      if property.key?
+        hash[name] = if property.kind_of? DataMapper::Property::Key
+          key
+        elsif property.serial?
+          key.get_id
+        elsif property.kind_of? DataMapper::Property::String
+          key.get_name
+        else
+          key
+        end
+      else
+        value = entity.get_property(name)
+        if property.kind_of?(DataMapper::Property::Decimal) && value
+          value = Lexidecimal.string_to_decimal(entity.get_property(name))
+        end
+        hash[name] = value
+      end
+    end
+    hash
+  end
+end

data/spec/appengine-paginator_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "AppenginePaginator" do
+  it "fails" do
+    fail "hey buddy, you should probably rename this file and start specing for real"
+  end
+end

data/spec/cursor_spec.rb

@@ -0,0 +1,31 @@
+require 'spec/spec_helper'
+
+describe Cursor do
+
+  before(:each) do
+    @cursor_string = 'E9oBJGofagR0ZXN0chcLEggKABoEUG9zdAwLEgRQb3N0GMEMDIIBAOABABQ'
+    java_cursor = Java::ComGoogleAppengineApiDatastore::Cursor.from_web_safe_string(@cursor_string)
+    @cursor = Cursor.new(java_cursor)
+  end
+
+  describe '#to_s' do
+    it 'should return the web safe string' do
+      @cursor.to_s.should == 'E9oBJGofagR0ZXN0chcLEggKABoEUG9zdAwLEgRQb3N0GMEMDIIBAOABABQ'
+    end
+  end
+
+  describe '.parse' do
+    it 'should return an object of class Cursor' do
+      Cursor.parse(@cursor_string).should be_instance_of Cursor
+    end
+  end
+
+
+  describe '#.to_java' do
+    it 'should return the java cursor' do
+      @cursor.to_java.should be_instance_of Java::ComGoogleAppengineApiDatastore::Cursor
+    end
+  end
+end
+
+

data/spec/paginate_spec.rb

@@ -0,0 +1,80 @@
+require 'spec/spec_helper'
+
+require 'spec/support/post'
+
+describe Paginate do
+  before(:all) do
+    Post.create(:title => "t1")
+    Post.create(:title => "t2")
+    Post.create(:title => "t3")
+    Post.create(:title => "t4")
+    Post.create(:title => "t5")
+    Post.create(:title => "t6")
+  end
+
+  after(:all) do
+    Post.destroy
+  end
+  describe '.initialize' do
+    it 'should create an instance of the Paginate class and take two required pareters' do
+      Paginate.new(1,2).should be_instance_of Paginate
+    end
+
+    it 'should accept more parameters as a hash' do
+      Paginate.new(1,2,:cursor => 4, :model => 4).should be_instance_of Paginate
+    end
+  end
+
+  describe '#result' do
+    it 'should return the results of the query' do
+      paginate = Paginate.new(AppEngine::Datastore::Query.new('Posts'), 7)
+      paginate.result.count.should == 6
+    end
+
+    it 'should limit the results based on the limit value' do
+      paginate = Paginate.new(AppEngine::Datastore::Query.new('Posts'), 2)
+      paginate.result.count.should == 2
+    end
+
+    it 'should start at the cursor when a cursor is provided' do
+      p = Paginate.new(AppEngine::Datastore::Query.new('Posts'), 2)
+      paginate = Paginate.new(AppEngine::Datastore::Query.new('Posts'), 2, :cursor => p.cursor)
+
+      paginate.result.first[:title].should == 't3'
+    end
+  end
+
+  describe '#datamapper_result' do
+    before(:each) do
+      @paginate = Paginate.new(AppEngine::Datastore::Query.new('Posts'), 2, :model => Post)
+    end
+
+    it 'should call the result method' do
+      @paginate.should_receive(:result).once.and_return([])
+      @paginate.datamapper_result
+    end
+
+    it 'should return an array' do
+      @paginate.datamapper_result.should be_instance_of Array
+    end
+
+    it 'should return the same number of items as the result method' do
+      @paginate.datamapper_result.size.should == @paginate.result.count
+    end
+
+    it 'each item should be an instance of the passed in model' do
+      @paginate.datamapper_result.each {|e| e.should be_instance_of Post}
+    end
+  end
+
+  describe '#cursor' do
+    it 'should return the cursor' do
+      paginate = Paginate.new(AppEngine::Datastore::Query.new('Post'), 2, :model => Post)
+      paginate.should respond_to :cursor
+    end
+    it 'should return the java cursor' do
+      paginate = Paginate.new(AppEngine::Datastore::Query.new('Post'), 2, :model => Post)
+      paginate.cursor.should be_instance_of Cursor
+    end
+  end
+end

data/spec/spec.opts

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

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'appengine-paginator'
+require 'spec'
+require 'spec/autorun'
+require 'dm-core'
+require 'dm-appengine-adapter'
+
+DataMapper.setup(:default, "app_engine://memory")
+Spec::Runner.configure do |config|
+  
+end

data/spec/support/post.rb

@@ -0,0 +1,6 @@
+class Post
+  include DataMapper::Resource
+  
+  property :id,            Serial
+  property :title,         String
+end

data/spec_runner

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+
+version = ">= 0"
+
+if ARGV.first =~ /^_(.*)_$/ and Gem::Version.correct? $1 then
+  version = $1
+  ARGV.shift
+end
+
+#gem 'rspec', version
+
+rspec_dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(rspec_dir) unless $LOAD_PATH.include?(rspec_dir)
+require 'spec/autorun'
+exit ::Spec::Runner::CommandLine.run

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification 
+name: appengine-paginator
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Josh Moore
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-09 00:00:00 +08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+description: Pagination on JRuby running on the Google AppEngine
+email: josh@codingforrent.com
+executables: 
+- autospec
+- rackup
+- spec
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- Gemfile
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- WEB-INF/app.yaml
+- bin/autospec
+- bin/rackup
+- bin/spec
+- config.ru
+- lib/appengine-paginator.rb
+- lib/cursor.rb
+- lib/paginate.rb
+- public/favicon.ico
+- public/robots.txt
+- spec/appengine-paginator_spec.rb
+- spec/cursor_spec.rb
+- spec/paginate_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/support/post.rb
+- spec_runner
+has_rdoc: true
+homepage: http://github.com/joshsmoore@gmail.com/appengine-paginator
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A gem to assist in pagination for the Google AppEngine
+test_files: 
+- spec/appengine-paginator_spec.rb
+- spec/cursor_spec.rb
+- spec/paginate_spec.rb
+- spec/spec_helper.rb
+- spec/support/post.rb