appengine-paginator 0.1.1 → 0.1.2

data/Rakefile

@@ -8,7 +8,7 @@ begin
     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.homepage = "http://github.com/joshsmoore/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

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

data/appengine-paginator.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{appengine-paginator}
-  s.version = "0.1.1"
+  s.version = "0.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Josh Moore"]
-  s.date = %q{2010-10-09}
+  s.date = %q{2010-10-15}
   s.description = %q{Pagination on JRuby running on the Google AppEngine}
   s.email = %q{josh@codingforrent.com}
   s.executables = ["autospec", "rackup", "spec"]
@@ -44,7 +44,7 @@ Gem::Specification.new do |s|
      "spec/support/post.rb",
      "spec_runner"
   ]
-  s.homepage = %q{http://github.com/joshsmoore@gmail.com/appengine-paginator}
+  s.homepage = %q{http://github.com/joshsmoore/appengine-paginator}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.7}

data/lib/appengine-paginator.rb

@@ -1,3 +1,4 @@
+raise StandardError.new
 require 'appengine-paginator/paginate'
 require 'appengine-paginator/cursor'
 

data/lib/appengine-paginator/cursor.rb

@@ -4,15 +4,20 @@ class Cursor
     @_cursor = cursor
   end
 
+  # Converts the cursor to a string encoded in base64.
   def to_s
     @_cursor.to_web_safe_string
   end
 
+
+  # Converts the cursor from a base 64 encoded string and returns the cursor object
+  #
+  # * must be a base 64 encoded cursor
   def self.parse(cursor_string)
     Cursor.new Java::comGoogleAppengineApiDatastore::Cursor.from_web_safe_string(cursor_string)
   end
 
-
+  # returns the actual Java cursor (instance of com.google.appengine.api.datastore.Cursor 
   def to_java
     @_cursor
   end

data/lib/appengine-paginator/paginate.rb

@@ -1,11 +1,19 @@
 class Paginate
   attr_reader :query, :limit, :options
+
+  # creates a paginate object
+  # * query - an instance of AppEngine::Datastore::Query
+  # * limit - number of items per page
+  # * :model => DataMapperObject - used to cast the datamapper_result (optional)
+  # * :cursor => instance of Cursor - used to skip to the next page in the query (optional)
   def initialize(query, limit, *options)
     @query = query
     @limit = limit
     @options = options.first || {}
   end
 
+  # Returns an array of entities.  This array is the current page based on the
+  # position of the cursor (or the first page if no cursor is passed in).
   def result
     if options[:cursor].nil?
       @query.pquery.as_query_result_list(query.convert_options(:limit => limit)[1])
@@ -15,12 +23,16 @@ class Paginate
     end
   end
 
+  # Returns an array of DataMapper objects.  This array is the current page based on the
+  # position of the cursor (or the first page if no cursor is passed in).  In order for the
+  # DataMapper objects to be loaded the paginate object must be crated with the :model option
   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
 
+  # returns the cursor (the starting position for the next page)
   def cursor
     Cursor.new result.cursor
   end

data/spec/paginate_spec.rb

@@ -15,7 +15,7 @@ describe Paginate do
   after(:all) do
     Post.destroy
   end
-  describe '.initialize' do
+  define '.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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: appengine-paginator
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 31
   prerelease: false
   segments: 
   - 0
   - 1
-  - 1
-  version: 0.1.1
+  - 2
+  version: 0.1.2
 platform: ruby
 authors: 
 - Josh Moore
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-09 00:00:00 +08:00
+date: 2010-10-15 00:00:00 +08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -72,7 +72,7 @@ files:
 - spec/support/post.rb
 - spec_runner
 has_rdoc: true
-homepage: http://github.com/joshsmoore@gmail.com/appengine-paginator
+homepage: http://github.com/joshsmoore/appengine-paginator
 licenses: []
 
 post_install_message: