ajax_pagination 0.0.1

data/COPYING.LESSER

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in ajax_pagination.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+    Copyright © 2012 Ronald Ping Man Chan
+    If you want to use this program under a different license, please contact me.
+    All pull requests on GitHub will be assumed to assign non-exclusive rights for perpertual usage for any use whatsoever for those modifications to Ronald Ping Man Chan. If you do not have the power to assign that right, do not submit a pull request. This allows me to release the software under a more permissible license in the future, if I so wish.
+    Ronald
+
+    The software is released under LGPL. The LGPL License on this software means that this Gem can be used in any software (proprietary or otherwise), by using the gem command. However, the gem cannot be included directly in proprietary software (eg. as a plugin), without distributions of the software being under LGPL. Distribution of this Gem must be released under the LGPL as well.
+
+    This file is part of AJAX Pagination.
+
+    AJAX Pagination is free software: you can redistribute it and/or modify
+    it under the terms of the GNU Lesser General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU Lesser General Public License for more details.
+
+    You should have received a copy of the GNU Lesser General Public License
+    along with this program.  If not, see <http://www.gnu.org/licenses/>.

data/README.md

@@ -0,0 +1,124 @@
+# AJAX Pagination
+**TO BE RELEASED**
+
+Handles AJAX pagination for you, by hooking up the links you want to load content with javascript in designated page containers. Each webpage can have multiple page containers, each with a different set of pagination links. The page containers can be nested. Degrades gracefully when javascript is disabled.
+
+## Introduction
+This gem can ajaxify any pagination solution. Links wrapped in containers with specific classes will be ajaxified. This means that clicking it will instead send an AJAX request for the page in javascript format. The result will replace the content in a container for the content. this gem is tested to work for will_paginate, but should work for other pagination solutions, as well as navigation level links or tabbed interfaces. The ajax call will load new content into the designated content container.
+
+## Background
+This gem depends on Rails 3.1+, jQuery and jquery-historyjs. The gem was extracted from http://github.com/xrymbos/nztrain-v2/, and further development will be tied to the needs of the application. Therefore, some dependencies are because the application uses a particular version of these other gems. If you need to use this in other versions/javascript frameworks, I would welcome any pull requests. They are not currently supported because I do not need to use this gem in those other frameworks.
+
+The original AJAX pagination functionality was inspired by the RailsCasts on pagination with AJAX. However, other functionality was added to the pagination, add more modular code was desired, especially when many different controllers need pagination.
+
+Because the code became more modular, it also made it suitable to turn into a Ruby Gem, so that others can create AJAX pagination without fiddling with the details.
+
+Rails 3.1+ is required only because the javascript is placed into the assets pipeline.
+
+## Installation
+Add to your Gemfile:
+
+    gem 'ajax_pagination'
+
+and run the bundle install command.
+
+Then add to your assets/javascripts/application.js,
+
+```javascript
+//= require ajax_pagination
+```
+
+## Getting started
+
+The pagination needs a name (in case you have multiple sets of AJAX pagination on the same webpage). By default, the name is "page". If you only intend to use a single set of pagination links, then leave it as "page".
+
+Move the content to be paginated into a partial. If you are using the will_paginate gem (or similar), there is only one set of content to put into a partial. If you are using this to paginate between distinct views or even different controllers, you will need to move each set of content into a different partial.
+
+By default, AJAX Pagination looks for the pagination content in the partial with filename matching the name of the pagination (by default "page"), so it is a good idea to use this name. If multiple views have pagination content in the same controller (especially if for the same pagination set), you will need to use different filenames for them.
+
+Then, instead of the paginated content, put the following in your view:
+
+```erb
+<%= ajax_pagination %>
+```
+
+If the pagination name is not "page", pass the new pagination name in.
+
+```erb
+<%= ajax_pagination :pagination => "page" %>
+```
+
+If the partial is not named the same, pass it the new name as an option:
+
+```erb
+<%= ajax_pagination :partial => "mypartial" %>
+```
+
+This will case it to display content in the _mypartial.* view.
+
+If you are using will_paginate, and the links are wrapped in a div with class="pagination", the links will be ajaxified automatically.
+
+Otherwise, you should wrap the links with a container. We recommend that the class given is "ajaxpagination". For example:
+
+```html
+<div class="ajaxpagination"><a href="#">My ajaxified link</a></div>
+```
+
+If you are using will_paginate, you can simply put this in the partial (so that the new links get reloaded when the page changes):
+
+```erb
+<%= will_paginate @objects, :params => { :pagination => nil } %>
+```
+
+Note: It is recommended to set the pagination parameter to nil. When AJAX pagination calls the controller with a request for the partial, it appends ?pagination=NAMEOFPAGINATION. If the parameter is not set, AJAX Pagination will not respond to the AJAX call. will_paginate by default keeps any parameters in the query string. However, because this parameter is for internal use only, setting it to nil will keep the parameter from showing up in the url, making it look nicer (also better for caching).
+
+Now, AJAX pagination will automatically call the controller for new content when an ajaxified link is clicked.
+
+However, the controller needs to be told how to respond. Add a call to ajax_pagination(format) in the controller action, which will return javascript containing the partial.
+
+```ruby
+respond_to do |format|
+  format.html # index.html.erb
+  ajax_pagination(format)
+end
+```
+
+If either the pagination name or the partial filename is not the default, you will need to pass these in as options.
+
+```ruby
+ajax_pagination format, :pagination => "page", :partial => "mypartial"
+```
+
+The pagination should now work.
+
+AJAX Pagination can also add a loading image and partially blanking out of the paginated content. To do this, wrap all the content you want to cover with ajax_pagination_loadzone. For example, in the partial, you might have:
+
+```erb
+<%= will_paginate @objects, :params => { :pagination => nil } %>
+<%= ajax_pagination_loadzone do %>
+  All content here is covered by a semi-transparent white rectangle.
+  A loading image is displayed on top, and any links here are unclickable
+<% end %>
+```
+
+Links outside are still clickable (such as the will_paginate links).
+
+The loading image is currently an image asset at "ajax-loader.gif", so put your loading image there. (TODO: add default loader image, and make the location changeable)
+
+## Javascript Dependency
+As well as the included ajax_pagination.js file, this gem uses jquery.ba-bbq.js, a jquery plugin. This is included in the gem as an asset already to simplify installation. ajax_pagination.js will automatically require jquery.ba-bbq.js.
+
+However, if you are already using this (especially a different version of this), simply ensure that your file is named jquery.ba-bbq.js as well, so that it overrides the file in the gem.
+
+## Development
+You are welcome to submit pull requests on GitHub at https://github.com/ronalchn/ajax_pagination, however, please be aware that submitting a pull request is assumed to grant non-exclusive, perpetual rights to the use of the software for any use whatsoever. This allows me to release the software under a more permissible license in the future if I want.
+
+If you do not submit a pull request, your modifications will not be merged into the codebase.
+
+## License
+Copyright © 2012 Ronald Ping Man Chan
+If you want to use this program under a different license, please contact me.
+All pull requests to my repository will be assumed to assign non-exclusive rights for perpertual usage for any use whatsoever for those modifications to Ronald Ping Man Chan. If you do not have the power to assign that right, do not submit a pull request. This allows me to release the software under a more permissible license in the future if I want.
+Ronald
+
+The software is released under LGPL. The LGPL License on this software means that this Gem can be used in any software (proprietary or otherwise), by using the gem command. However, the gem cannot be included directly in proprietary software (eg. as a plugin), without distributions of the software being under LGPL. Distribution of this Gem must be released under the LGPL as well.

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+

data/ajax_pagination.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "ajax_pagination/version"
+
+Gem::Specification.new do |s|
+  s.name        = "ajax_pagination"
+  s.version     = AjaxPagination::VERSION
+  s.authors     = ["Ronald Ping Man Chan"]
+  s.email       = ["ronalchn@gmail.com"]
+  s.homepage    = "https://github.com/ronalchn/ajax_pagination"
+  s.summary     = %q{Handles AJAX pagination, changing the content when certain links are followed.}
+  s.description = %q{Handles AJAX pagination for you, by hooking up the links you want to load content with javascript in designated page containers. Each webpage can have multiple page containers, each with a different set of pagination links. The page containers can be nested. Degrades gracefully when javascript is disabled.}
+
+  s.rubyforge_project = "ajax_pagination"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  s.add_development_dependency "rspec"
+  # s.add_runtime_dependency "rest-client"
+
+  s.add_runtime_dependency "rails", '>= 3.1'
+  s.add_runtime_dependency "jquery-rails", '>= 1.0'
+  s.add_runtime_dependency "jquery-historyjs"
+
+end

data/lib/ajax_pagination.rb

@@ -0,0 +1,7 @@
+require "ajax_pagination/version"
+require "ajax_pagination/controller_additions"
+require "ajax_pagination/helper_additions"
+require "ajax_pagination/rails"
+
+module AjaxPagination
+end

data/lib/ajax_pagination/controller_additions.rb

@@ -0,0 +1,19 @@
+module AjaxPagination
+  module ControllerAdditions
+    def ajax_pagination(format,options = {})
+      if params[:pagination] == (options[:pagination] || 'page')
+        partial = options[:partial] || params[:pagination]
+        format.js { render :inline => "ajaxPagination.display_pagination_content(\"#{params[:pagination]}\",\"#{request.url}\",\"<%= raw escape_javascript(render(\"#{partial}\")) %>\");" }
+        return true
+      else
+        return false
+      end
+    end
+  end
+end
+if defined? ActionController
+  ActionController::Base.class_eval do
+    include AjaxPagination::ControllerAdditions
+  end
+end
+

data/lib/ajax_pagination/helper_additions.rb

@@ -0,0 +1,30 @@
+module AjaxPagination
+  module HelperAdditions
+    def ajax_pagination(options = {})
+      pagination = options[:pagination] || 'page' # by default the name of the pagination is 'page'
+      partial = options[:partial] || pagination # default partial rendered is the name of the pagination
+      reload = options[:reload]
+      divoptions = { :id => "#{pagination}_paginated_section", :class => "paginated_section" }
+      case reload.class.to_s
+      when "String"
+        divoptions["data-reload"] = reload
+      when "Hash", "Array"
+        divoptions["data-reload"] = reload.to_json
+      end
+      content_tag :div, divoptions do
+        render partial
+      end
+    end
+    def ajax_pagination_loadzone()
+      content_tag :div, :class => "paginated_content", :style => "position: relative" do
+        yield
+      end
+    end
+  end
+end
+if defined? ActionView
+  ActionView::Base.class_eval do
+    include AjaxPagination::HelperAdditions
+  end
+end
+

data/lib/ajax_pagination/rails.rb

@@ -0,0 +1,4 @@
+module AjaxPagination
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/ajax_pagination/version.rb

@@ -0,0 +1,3 @@
+module AjaxPagination
+  VERSION = "0.0.1"
+end

data/lib/assets/javascripts/ajax_pagination.js.erb

@@ -0,0 +1,100 @@
+//= require jquery.ba-bbq
+
+if (History && History.enabled) {
+  var ajaxPagination;
+  $(document).ready(function () {
+    ajaxPagination = new function() {
+      this.pagination_loader_state = new Array(); // the page we are waiting for
+      //this.pagination_stack = new Array(); // stack of request urls in history (to get state of url we came from)
+      this.pagination_url = location.href; // url we came from, so we can see transitions of the url
+
+      function display_pagination_loader(pagination_name) {
+        if (this.pagination_loader_state[pagination_name] != undefined) return; // if already loading, don't reshow loader
+        var paginated_section = $('#' + pagination_name + '_paginated_section');
+        var paginated_content = paginated_section.children(".paginated_content").first(); // don't want to support multiple loader images
+        var height = paginated_content.height();
+        // setup loading look
+        var img = document.createElement("IMG");
+        img.src = "<%= asset_path "ajax-loader.gif" %>";
+        var margin = Math.round(height>400?100:(height/4));
+        $(img).css({'margin': margin + 'px', 'max-height': (height/2) + 'px'});
+        var div = document.createElement("DIV");
+        $(div).append(img);
+        $(div).css({'position': 'absolute', 'left': 0, 'top': 0, 'width': '100%', 'height': '100%', 'background-color': 'rgba(255,255,255,0.7)', 'text-align': 'center', 'opacity': 0.9});
+        paginated_content.append(div);
+
+        // scroll to top of paginated_section if it is not visible
+        if ($('body').scrollTop() > paginated_section.offset().top) {
+          $('body').scrollTop(paginated_section.offset().top);
+        }
+      }
+
+      this.display_pagination_content = function(pagination_name,requesturl,content) {
+        if (this.pagination_loader_state[pagination_name] == requesturl) {
+          //pagination_content_state[pagination_name] = pagination_loader_state[pagination_name];
+          delete this.pagination_loader_state[pagination_name]; // not waiting for page anymore
+          $("#" + pagination_name + "_paginated_section").html(content);
+        }
+        // else content is stale
+      };
+
+      function swapPage(pagination_name,requesturl) { // swaps the page at pagination_name to that from requesturl
+        display_pagination_loader.call(this,pagination_name);
+        this.pagination_loader_state[pagination_name] = requesturl; // remember which page number we are waiting for
+        $.ajax(requesturl,{dataType:'script',cache:true});
+      }
+      $('body').on("click", ".pagination a, .ajaxpagination a", function() {
+        var pagination_name = /^(.*)_paginated_section$/.exec($(this).closest(".paginated_section").attr("id"))[1];
+        if (pagination_name == null) return; // pagination not set up properly
+        var requesturl = $.param.querystring(this.href,{pagination:pagination_name}); // by default, adds ?pagination=page
+        swapPage.call(ajaxPagination,pagination_name,requesturl);
+        ajaxPagination.pagination_url = this.href;
+        History.pushState(null,document.title,this.href);
+        return false;
+      });
+
+      History.Adapter.bind(window,'popstate',function(){ // popstate, but can work with hash changes as well
+        var from = ajaxPagination.pagination_url, to = location.href; // from what state to what other state
+
+        $(".paginated_section").each(function(){
+          var pagination_name = /^(.*)_paginated_section$/.exec($(this).attr("id"))[1];
+          if (pagination_name == null) return; // pagination not set up properly
+
+          // if data-reload is not defined, the use default reload test
+          if ($(this).data('reload') === undefined) {
+            // if ?pagination_name=ABC, where ABC is the same for both urls, then don't need to reload
+            if ($.deparam.querystring(from)[pagination_name] === $.deparam.querystring(to)[pagination_name]) return;
+          }
+          else { // otherwise parse json and perform tests
+            var reload = $(this).data('reload');
+            if (!(reload instanceof Array)) reload = new Array(reload);
+            var changed = false;
+            for (i=0;i<reload.length;i++) {
+              if (reload[i].query !== undefined) {
+                if ($.deparam.querystring(from)[reload[i].query] !== $.deparam.querystring(to)[reload[i].query]) changed = true;
+              }
+              if (reload[i].urlregex !== undefined) {
+                var index = 0;
+                if (reload[i].regexindex !== undefined) index = reload[i].regexindex;
+                var regex = new RegExp(reload[i].urlregex);
+                var frommatch = regex.exec(from), tomatch = regex.exec(to);
+                if (frommatch != null && frommatch.length>=index) frommatch = frommatch[index];
+                if (tomatch != null && tomatch.length>=index) tomatch = tomatch[index];
+                if (frommatch !== tomatch) changed = true;
+              }
+              if (changed) break;
+            }
+            if (!changed) return; // otherwise it has changed, and we must reload
+          }
+          var requesturl = $.param.querystring(location.href,{pagination:pagination_name}); // by default, adds ?pagination=page
+          swapPage.call(ajaxPagination,pagination_name,requesturl);
+        });
+
+        ajaxPagination.pagination_url = location.href; // update url (new url recognised)
+      });
+
+      //History.Adapter.trigger(window,"popstate"); // update stuff on page load
+    };
+  });
+}
+