alphabetical_paginate 1.1.0 → 1.2.0

data/README.md

@@ -1,10 +1,12 @@
 # AlphabeticalPaginate
 
-A lightweight and highly customizable pagination gem for Ruby on Rails that generates alphabetic pagination categories from collection arrays. It allows you to select the field you want to paginate on. 
+A lightweight and highly customizable pagination gem for Ruby on Rails that generates alphabetic pagination categories from Collections or Arrays. It allows you to select the field you want to paginate on. 
 
 By default, it works with [Bootstrap Pagination](http://twitter.github.io/bootstrap/components.html#pagination) CSS and it is also fully compatible with the [will_paginate](https://github.com/mislav/will_paginate) in case you want to use both. 
 
-AlphabeticalPaginate incorporates efficient partial page rerendering techniques and loading animations.
+AlphabeticalPaginate incorporates efficient javascript partial page rerendering techniques and loading animations but also is non-obtrusive and falls back to standard href links.
+
+It has two modes - if you're working with MySQL, it allows for low level database regex queries. Otherwise, it uses a buffered search to build an array. You should be able to easily modify the gem to work with other SQL databases (please make a pull-request if you do!).
 
 Some code was inspired by [will_paginate](https://github.com/mislav/will_paginate).
 
@@ -28,26 +30,33 @@ You simply need to call alpha_paginate on the desired table (i.e. `User.all.alph
 
 Also, it takes a block in which you can specify the field you wish to paginate by (it can even be in another table). It returns the paginated subset of the collection, sorted by the pagination field. The method returns two values (the paginated array subsection, and an options hash), both of which must be stored as class variables. 
 
+It has a :db_mode parameter which tells the gem to perform low level SQL queries, which are both faster, and take up less memory. This is only supported for MySQL databases at this point.
+
 *An example of its use is as such:*
+#### If you are using MySQL / MySQL2
 ```ruby
 #app/controllers/users_controllers.rb
 class UsersController < ApplicationController
 
   def index
-    @users, @alphaParams = User.all.alpha_paginate(params[:letter]){|user| user.name}
+    @users, @alphaParams = User.all.alpha_paginate(params[:letter], {db_mode: true, db_field: "name"})
   end
   
   ...
 end
 ```
 
-You may want to sort by the same field that you paginated by (cannot be done in gem due to technical limitaitons).
-
+#### If you are not using MySQL
 ```ruby
+#app/controllers/users_controllers.rb
+class UsersController < ApplicationController
+
   def index
     @users, @alphaParams = User.all.alpha_paginate(params[:letter]){|user| user.name}
-    @users.sort_by_name!
   end
+  
+  ...
+end
 ```
 
 ### View
@@ -95,10 +104,11 @@ Key | Value | Default |Description
 `:numbers` | `Boolean` | `true` | Whether you want numbers to be included in the pagination at all, either collapsed, or expanded (depending on `:enumerate`).
 `:others` | `Boolean` | `true` | Whether you want all other characters (non alphanumeric) to be included in the pagination at all.
 `:pagination_class` | `String` | `"pagination-centered"` | All the classes you would like to add to the rendered pagination selector div (for CSS purposes).
+`:js` | `Boolean` | `"true"` | If you want the javascript with page-rerendering to be enabled.
 
 ## Advanced Pagination
 
-You can select a complex field to paginate by. Be careful, as this may be slow in large data sets.
+You can select a complex field to paginate by. Be careful, as this may be slow in large data sets. This only works if db_mode is disabled.
 
 For instance, the following example paginates posts by the author's group's name (jumping across two tables).
 It still returns the Post objects despite whatever field you use to paginate / sort it by (It still auto-sorts by the pagination field).
@@ -117,6 +127,11 @@ class UsersController < ApplicationController
 end
 ```
 
+Also you can paginate by any array generally, it doesn't have to be a collection.
+```ruby
+  @friends, @params = friends.alpha_paginate(params[:letter]){|x| x}
+```
+
 ## Rails 3.0 and Lower
 
 The gem makes use of the Asset Pipeline, introduced in Rails 3.1. It still works with lower versions of Rails, however, you need to copy the assets over manually.
@@ -124,6 +139,13 @@ The gem makes use of the Asset Pipeline, introduced in Rails 3.1. It still works
 Copy the contents of `vendor/assets/javascripts` of this repo into the `public/javascripts` of your app
 and also copy the contents of `vendor/assets/images` of this repo into the `public/images` of your app.
 
+Also, there is one line in vendor/assets/javascripts that needs to be changed for Rails 3.0 support. That is, renaming the image path:
+```javascript
+  var img = "<img src='/assets/aloader.gif' class='loading'/>";
+  // RAILS 3.0 USERS -> Please delete the above line and uncomment the bottom line
+  //var img = "<img src='/images/aloader.gif' class='loading'/>";
+```
+
 # Support
 
 Please feel free to reach out and contact if you find the gem useful at all! Also, feel free to report / fix any bugs or add features.

data/lib/alphabetical_paginate/version.rb

@@ -1,3 +1,3 @@
 module AlphabeticalPaginate
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

data/lib/alphabetical_paginate/view_helpers.rb

@@ -1,9 +1,10 @@
 module AlphabeticalPaginate
   module ViewHelpers
     def alphabetical_paginate params
-
-      output = javascript_include_tag 'alphabetical_paginate' 
+      output = ""
       links = ""
+
+      output += javascript_include_tag 'alphabetical_paginate' if params[:js]
       
       if params[:paginate_all]
         range = ('a'..'z').to_a
@@ -21,7 +22,7 @@ module AlphabeticalPaginate
           elsif params[:db_mode] or params[:availableLetters].include? l
             links += '<li><a href="?letter=' + l + '" data-letter="' + l + '">' + l + "</a></li>"
           else
-            links += '<li class="disabled"><a href="?letter="' + l + ' data-letter="' + l + '">' + l + "</a></li>"
+            links += '<li class="disabled"><a href="?letter=' + l + '" data-letter="' + l + '">' + l + "</a></li>"
           end
         end
       else
@@ -32,7 +33,7 @@ module AlphabeticalPaginate
         
         params[:availableLetters].each do |l|
           if l == params[:currentField]
-            links += '<li class="active"><a href="?letter=" data-letter="' + l + '">' + l + "</a></li>"
+            links += '<li class="active"><a href="?letter=' + l + '" data-letter="' + l + '">' + l + "</a></li>'
           else
             links += '<li><a href="?letter=' + l + '" data-letter="' + l + '">' + l + "</a></li>"
           end
@@ -51,7 +52,8 @@ module AlphabeticalPaginate
         "</ul>" +
         "</div>"
 
-      output += pagination.html_safe
+      output += pagination
+      output.html_safe
     end
   end
 end

data/vendor/assets/javascripts/alphabetical_paginate.js

@@ -1,7 +1,9 @@
 $(function() {
   var once = false;
 
-  var img = "<img src='/images/aloader.gif' class='loading'/>";
+  var img = "<img src='/assets/aloader.gif' class='loading'/>";
+  // RAILS 3.0 USERS -> Please delete the above line and uncomment the bottom line
+  //var img = "<img src='/images/aloader.gif' class='loading'/>";
   
   $(document).on("click", ".pagination#alpha a", function(e) {
       var url = location.href,

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: alphabetical_paginate
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-22 00:00:00.000000000 Z
+date: 2013-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler