[Rails 常用插件简介]ajax_paginate

这个并不是一个完整的插件,仅供娱乐:)

其实这也是个简单的插件制作过程，本插件依赖will_paginate

一：新建Project

rails ajax_paginate_demo

地球人都知道这个是干嘛的，不说了

二：安装will_paginate插件
http://mmm.iteye.com/blog/116931


三：制作我们的ajax_paginate插件

ruby script/generate plugin ajax_paginate

并且在lib下新建ajax_paginate目录，目录如下图


修改init.rb

require 'ajax_paginate/view_helpers'

ActionView::Base.send :include, AjaxPaginate::ViewHelpers

如果你看过插件的源码，那么这个就不用说了。（就是让View中可以直接使用我们的AjaxPaginate::ViewHelpers中的方法）

will_paginate默认已经实现了分页的功能，我们要做的仅仅是增加ajax显示的效果，AjaxPaginate::ViewHelpers 从WillPaginate::ViewHelpers copy 过来的，
首先修改原来的will_paginate，我们从新命名为ajax_paginate

稍作修改

 def ajax_paginate(entries = @entries, options = {})
            total_pages = entries.page_count

            if total_pages > 1
               #保持原有的WillPaginate的options参数
                options = WillPaginate::ViewHelpers.pagination_options.merge options.symbolize_keys
                #....                      
                #修改为remote_page_link_or_span,下同                       
                        links << remote_page_link_or_span((n != page ? n : nil), 'current', n, param)
                    
                #...............
                # next and previous buttons
                links.unshift remote_page_link_or_span(entries.previous_page, 'disabled', options.delete(:prev_label), param)
                links.push    remote_page_link_or_span(entries.next_page,     'disabled', options.delete(:next_label), param)               
                #...............
            end
        end

增加remote_page_link_or_span

        def remote_page_link_or_span(page, span_class, text, param)
            unless page
                content_tag :span, text, :class => span_class
            else
                # page links should preserve GET parameters, so we merge params
                link_to_remote text, :url=>params.merge(param.to_sym => (page !=1 ? page : nil)), :method=>:get, :update=>''
            end
        end

注
update为什么写死在这里，因为我偷懒，你可以跟WillPaginate::ViewHelpers一样做成options，这个最后再讨论

OK,可以使用了:)
在View中直接使用

<%=ajax_paginate @users%>

即可看到效果了.

================================== 华丽的分割线=================================================
来个简单的应用来演示我们的插件是否生效，刚才我们已经新建了ajax_paginate_demo项目
1：修改database.yml

development:
  adapter: mysql
  database: ajax_paginate_demo
  username: root
  password: 
  host: localhost

2:建立数据库

create database ajax_paginate_demo

3：创建例子中的model，我们选用User

ruby script\generate scaffold_resource user name:string

仅仅包括一个字段，将附件中的001_create_users.rb覆盖你的数据，执行

rake db:migrate

将会导入千八条的数据（这些数据来源于互联网，我随手检索了Authors List 发现这个网页的,我只是整理了下，做测试数据： http://www.classicreader.com/allauthor.htm ）

4：修改users_controller.rb

class UsersController < ApplicationController
    # GET /users
    # GET /users.xml
    def index
        @users = User.paginate :all, :page=>params[:page]||1
        respond_to do |format|
            format.html do
                unless params[:page].nil?
                    render :update do |page|
                        page.replace_html :page, :partial=>'list'
                    end
                end
            end
            format.xml  do
                render :xml => @users.to_xml
            end
        end
    end
end

注意：
我们这里指定了更新的div id为 page,你可以将这个参数一并加到我们的更一步考虑中

5：修改index.html

<h1>Listing users</h1>
<div id="spinner_div" style="float:right">
    <%= image_tag 'spinner.gif', :id => 'spinner', :style => 'display: none' %>
</div>
<div id="page">
    <%=render :partial=>'list'%>
</div>

新增_list.rhtml

<table>
  <tr>
    <th>Name</th>
  </tr>

<% for user in @users %>
  <tr>
    <td><%=h user.name %></td>
  </tr>
<% end %>
</table>
<%=ajax_paginate @users%>

6：Ajax需要导入js,修改/app/views/layouts/users.rhtml导入js

  <%= javascript_include_tag :defaults%>

7：增加点ajax的经典效果
修改remote_page_link_or_span 使之一直有效 （俺偷懒，这个一并和上面的update加入更进一步考虑中实现之）

link_to_remote text, :url=>params.merge(param.to_sym => (page !=1 ? page : nil)), :method=>:get, :update=>'', :before => %(Element.show('spinner')), :success => %(Element.hide('spinner'))

8：
还有什么呢？
........

没了，真的没了，测试一下看看结果如何:)满意不？ 


任务还没完成，同志尚需努力!
================================== 华丽的分割线=================================================
更进一步讨论：
1：增加更多的可选参数，让他真正同link_to_remote一样,我们看下rails源码中的AJAX_OPTIONS

CALLBACKS = Set.new([ :uninitialized, :loading, :loaded, :interactive, :complete, :failure, :success ] + (100..599).to_a) 
AJAX_OPTIONS = Set.new([ :before, :after, :condition, :url, :asynchronous, :method, :insertion, :position, :form, :with, :update, :script ]).merge(CALLBACKS) 

代码见这里
http://ajaxpaginate.googlecode.com/svn/trunk/ajax_paginate/

演示代码见这里：
http://ajaxpaginate.googlecode.com/svn/trunk/ajax_paginate_demo/

你可以使用svn checkout。