paginate_me 0.0.4 → 0.0.5

data/README.markdown

@@ -1,68 +1,70 @@
-<h1>Paginate Me</h1>
+# Paginate Me 0.0.5  
 
-**Adam Rensel's Code**
+**Adam Rensel's Code**  
 
-<p>Paginate me is a Ruby Gem that adds simple pagination functionality to views.</p>
+Paginate me is a Ruby Gem that adds simple pagination functionality to views.  
 
+## Usage:
+### Controller Code (users_controller.rb)
 
+```ruby
+class UsersController < ApplicationController
+  def index
+    @title = "All Users"
+    paginate_me :users
+  end
+end
+```
 
-<h2>Usage:</h2>
-<p>users_controller.rb</p>
-
-<pre>class UsersController &lt; ApplicationController
-	def index
-		@title = "All Users"
-
-	 paginate_me :users
-	end
-end</pre>
-
-<p>index.haml</p>
-
-<pre>= paginate_for :users do |p|
+### View code (index.haml)  
+ 
+```haml
+= paginate_for :users do |p|
   = p.link_to_first
 	= p.link_to_next
 	= p.page_out_of_total
 	= p.link_to_previous
-	= p.link_to_last</pre>
-<p>Results in: </p>
+	= p.link_to_last
+```
+### HTML output
+
+```html
     <div class="paginate_me users"> 
-      <a href="/users/page/10" class="first" title="first">First</a> 
-              
-      <a href="/users/page/10" class="next" title="next">Next</a> 
-              
+      <a href="/users/page/1" class="first" title="first">First</a>              
+      <a href="/users/page/3" class="next" title="next">Next</a> 
       <span>2 of 10</span> 
-              
-      <a href="/users/page/10" class="previous" title="previous">Previous</a> 
-              
+      <a href="/users/page/1" class="previous" title="previous">Previous</a> 
       <a href="/users/page/10" class="last" title="last">Last</a> 
     </div>
-
-<h2>Options for paginate_me(item, options ={})</h2>
-* :url - The plugin builds it's base path from the item passed in according to standard rails routing resource format. A different base url can be passed in instead. /users/page/:page_number (/users is the base_url)
-* :per_page - results per page, defaults to 10
-* :params_var - variable set in routes that will hold the current page number ex: <code>match "/users/page/:page", :to => "users#index"</code> :page is the :params_var , defaults to :page
-
-
-<h2>Options for paginate_for(item, options = {}, &block)</h2>
-* :class - add classes to div container tag
-* :slug - slug used for url, defaults to 'page', the controller will use the slug in the 'params' variable by default as well.
-
-
-<h2>Paginate Links</h2>
-* link_to_first(options={}) - label for first button, goes to page 1 
-* link_to_next(options={}) - label for next button, increments page by +1
-* link_to_previous(options={}) - label for previous button subtracts pages by -1
-* link_to_last(options={}) - goes to the last page available, based on total count
-  <p> **options** </p>
-    * :name - name of link
-    * :class - classes for link pass an array for multiple classes
-    * :title - title for link
-
-<h2>Information Output</h2>
-* page_out_of_total - formats pagination info '1 of 10' standard rails 'content_tag' options apply
-
-<h2>Additional Information</h2>
+```  
+## Options for paginate_me(item, options ={})  
+* `:base_url` – The plugin builds it's base path from the item passed in according to standard rails routing resource format. A different base url can be passed in instead. /users/page/:page_number (/users is the base_url)  
+* `:per_page` – results per page, defaults to 10  
+* `:params_var` – variable set in routes that will hold the current page number ex: ` match "/users/page/:page", :to => "users#index" ` :page is the :params_var , defaults to :page  
+* `:where` - Sets a where clause in the query, accepts a normal active record where object ex: `{comments: {post_id: 2}}`
+* `:includes` - sets the include clause in the query, uses standard active record syntax
+* `:order` - changes the order for the query, accepts the same string as an active record query ex: `"created_at DESC"`
+
+
+## Options for paginate_for(item, options = {}, &block)  
+* `:class` – add classes to div container tag  
+* `:slug` – slug used for url, defaults to 'page', the controller will use the slug in the 'params' variable by default as well.  
+
+
+## Paginate Links  
+* `link_to_first(options={})` – label for first button, goes to page 1  
+* `link_to_next(options={})` – label for next button, increments page by +1  
+* `link_to_previous(options={})` – label for previous button subtracts pages by -1  
+* `link_to_last(options={})` – goes to the last page available, based on total count  
+   **options**  
+    * `:name` – name of link  
+    * `:class` – classes for link pass an array for multiple classes  
+    * `:title` – title for link  
+
+## Information Output  
+* `page_out_of_total` – formats pagination info '1 of 10' standard rails 'content_tag' options apply  
+
+## Additional Information  
 * If multiple pagination is needed on one page, for example at the top and bottom of the list, the block of paginate links only needs to be passed to the first 'paginate_for' The additional 'paginate_for' will use the same block, or new blocks can be passed if a different look is required
-* Make sure you add the correct routes to your routes.rb. For example if your passing in :users and are using a standard resource routing setup, you will need:<code>match "/users/page/:page", :to => "users#index"</code>
+* Make sure you add the correct routes to your routes.rb. For example if your passing in :users and are using a standard resource routing setup, you will need: ` match "/users/page/:page", :to => "users#index" `  
 

data/lib/paginate_me/paginate.rb

@@ -1,29 +1,40 @@
 module PaginateMe
   module PMController
     def paginate_me(item, options = {})
-        model_name = item.to_s
-        model = model_name.singularize.camelize.constantize
-
-        @options = options
-        @options[:params_var] ||= :page 
-        @options[:base_url] ||= method("#{model_name}_path").call
-        @options[:per_page] ||= 10
-        @options[:page_total] = (model.count / @options[:per_page].to_f).ceil
-        @options[:current_page] = self.params[@options[:params_var]].to_i || 1
-  
-        current_page = @options[:current_page]
-        page_total = @options[:page_total]
-
-        if current_page <= 0
-          current_page = 1
-        elsif current_page > page_total
-          current_page = page_total - 1
-        end
-        
-        instance_variable_set("@#{model_name}", 
-          model.limit(@options[:per_page]).offset((current_page-1) * @options[:per_page]))
+      # TODO this entire method needs to be cleaned up
+      #set generic param defaults
+      @options = options
+      @options[:params_var] ||= :page
+      @options[:per_page] ||= 10
+      @options[:current_page] = self.params[@options[:params_var]].to_i || 1
+      @options[:order] ||= "#{item.to_s}.created_at ASC"
+
+      current_page = @options[:current_page] <= 0 ? 1 : @options[:current_page]
+      
+      model_name = item.to_s
+      model = model_name.singularize.camelize.constantize
+
+      @options[:base_url] ||= method("#{model_name}_path").call
+
+      instance_variable_set("@#{model_name}", 
+      model
+        .includes(@options[:includes])
+        .where(@options[:where])
+        .order(@options[:order])
+        .limit(@options[:per_page])
+        .offset((current_page-1) * @options[:per_page]) )
+      
+      @options[:page_total] = (model.includes(@options[:includes]).where(@options[:where]).count / @options[:per_page].to_f).ceil
+
+      # set bounds for the current page, this makes sure the current_page variable stays within
+      # the max and min number of items
+      if @options[:current_page] <= 0
+        @options[:current_page] = 1
+      elsif @options[:current_page] > @options[:page_total]
+        @options[:current_page] = @options[:page_total] - 1
       end
     end
+  end
 
   module PMView
     def paginate_for(item,options = {},&block)
@@ -45,8 +56,7 @@ module PaginateMe
       content_tag(:div,content, :class => "paginate_me #{paginate_classes}")
     end
     
-  end
-  class PaginateMeBuilder
+    class PaginateMeBuilder
       include ActionView::Helpers
 
       def initialize(options)
@@ -67,6 +77,12 @@ module PaginateMe
         add_to_template paginate_link_to @next_page, options if @current_page < @page_total
       end
 
+      def link_to_last(options = {})
+        options[:name] ||= "Last"
+        
+        add_to_template paginate_link_to @page_total, options if @current_page < @page_total 
+      end
+
       def link_to_previous(options = {})
         options[:name] ||= "Previous"
 
@@ -76,13 +92,7 @@ module PaginateMe
       def link_to_first(options = {})
         options[:name] ||= "First"
 
-        add_to_template paginate_link_to 1, options if @current_page < @page_total
-      end
-
-      def link_to_last(options = {})
-        options[:name] ||= "Last"
-        
-        add_to_template paginate_link_to @page_total, options if @current_page > 1
+        add_to_template paginate_link_to 1, options if @current_page > 1
       end
 
       def page_out_of_total(options = {})
@@ -104,5 +114,6 @@ module PaginateMe
           template.html_safe
         end
     end
+  end
 end
 

data/lib/paginate_me/version.rb

@@ -1,3 +1,3 @@
 module PaginateMe
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

metadata

@@ -1,33 +1,24 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: paginate_me
-version: !ruby/object:Gem::Version 
-  hash: 23
+version: !ruby/object:Gem::Version
+  version: 0.0.5
   prerelease: 
-  segments: 
-  - 0
-  - 0
-  - 4
-  version: 0.0.4
 platform: ruby
-authors: 
+authors:
 - Adam Rensel
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-09-17 00:00:00 Z
+date: 2011-10-10 00:00:00.000000000Z
 dependencies: []
-
-description: for more information, please visit the homepage or https://github.com/renz45/paginate_me for a full README
-email: 
+description: for more information, please visit the homepage or https://github.com/renz45/paginate_me
+  for a full README
+email:
 - adamrensel@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - Gemfile
 - README.markdown
@@ -39,36 +30,26 @@ files:
 - paginate_me.gemspec
 homepage: https://github.com/renz45/paginate_me
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+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 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: paginate_me
 rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: paginate_me is a simple pagination gem for Rails 3.1
 test_files: []
-