innetra-flow_pagination 1.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Innetra Consultancy Services, S.C.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Manifest

@@ -0,0 +1,7 @@
+Manifest
+flow_pagination.gemspec
+README.rdoc
+Rakefile
+init.rb
+lib/flow_pagination.rb
+MIT-LICENSE

data/README.rdoc

@@ -0,0 +1,167 @@
+= FlowPagination
+
+FlowPagination link renderer plugin for Mislav's
+{WillPaginate}[http://github.com/mislav/will_paginate/tree/master]
+plugin (Twitter like pagination).
+
+Instead of showing page links, this plugin/gem change the rendering of
+WillPaginate to display, at the bottom of the page's records, the "More" button.
+And when clicked it will add the next set of records (next page) right below
+the previous ones.
+
+== Requirements
+
+* Mislav's {WillPaginate}[http://github.com/mislav/will_paginate/tree/master]
+plugin/gem.
+
+== Installation
+
+I've created a category listing (index action) to give a basic example.
+
+Configure +WillPaginate+ and +FlowPagination+ gems (config/environment.rb):
+
+  Rails::Initializer.run do |config|
+    [...]
+    config.gem 'mislav-will_paginate', :lib => 'will_paginate',
+        :source => 'http://gems.github.com'
+
+    config.gem 'innetra-flow_pagination', :lib => 'flow_pagination',
+        :source => 'http://gems.github.com'
+    [...]
+  end
+
+To install these gems type the following rake task:
+
+  rake gems:install
+
+=== Install It as a Plugin
+
+  script/plugin install git://github.com/mislav/will_paginate.git
+  script/plugin install git://github.com/innetra/flow_pagination.git
+
+== Usage
+
+Let's create category listing page as a sample.
+
+=== Categories Controller
+
+controllers/categories_controller.rb:
+
+  class CategoriesController < ApplicationController
+    def index
+      @categories = Category.paginate :page => params[:page], :order => 'name'
+    end
+  end
+
+=== Categories Index View
+
+app/views/cateogories/index.html.haml:
+
+  = javascript_include_tag :all
+  %h1 Categories
+  %ul#categories= render @categories
+  = will_paginate @categories, :renderer => FlowPagination::FlowPaginationRenderer
+
+==== Important Note
+
+If you're using Prototype (Rails default javascript library) you have to
+surround the +will_paginate+ method with a form. Cause Prototype requires a
+form to submit.
+
+Another option is to override +FlowPagination::LinkRenderer.to_html+ method
+so it uses the +ActionView::Helpers::UrlHelper.link_to+ method instead of
++ActionView::Helpers::PrototypeHelper.submit_to_remote+,
+
+=== Category Partial
+
+app/views/categories/_category.html.haml:
+
+  %li{ :id => "category_#{category.id}" }=category.name
+
+=== RJS Template
+
+app/views/categories/index.js.rjs:
+
+  page.insert_html :bottom, :categories, :partial => @categories
+  page.replace :flow_pagination, will_paginate(@categories)
+
+=== Populate Database
+
+To test this solution I've created a rake task to populate the database
+(lib/tasks/populate.rake):
+
+  namespace :db do
+    desc 'Erase and fill database'
+    task :populate => :environment do
+
+      require 'populator'
+      require 'faker'
+
+      Category.delete_all
+
+      Category.populate 100 do |category|
+        category.name = Populator.words(1..3).titleize
+      end
+
+    end
+  end
+
+==== Important
+
+You'll need Populator and Faker gems to run this rake task.
+
+=== Enjoy
+
+Run your application, browse your category listing
+(http://localhost:3000/categories). Go to the end of the page and, if you have
+more than 30 categories (or more than the number specified in the +per_page+
+parameter), you should see the "More" button. Click it and the next records will
+be added next to the previous ones.
+
+== Changing the Button's Legend
+
++FlowPagination+ supports internationalization (Rails +i18n+), thus you can
+change the label like this:
+
+  I18n.backend.store_translations :en, 'flow_pagination.button' => {  :default => 'Next Records' }
+
+Another way to accomplish the same is to add the following in your locales
+(config/locales/en.application.yml):
+
+  en:
+    flow_pagination:
+      button: Next Records
+
+== Setting FlowPagination as Default LinkRenderer
+
+If you wan't to use +FlowPagination::LinkRenderer+ as default, instead of
+specify the +renderer+ parameter each call to +WillPaginate+ helper, you can
+specify it on Application Helper (app/helpers/application_helper.rb):
+
+  module ApplicationHelper
+    WillPaginate::ViewHelpers.pagination_options[:renderer] =
+      FlowPagination::LinkRenderer
+  end
+
+== License
+
+Copyright (c) 2008 Innetra Consultancy Services, S.C.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,10 @@
+require 'echoe'
+
+Echoe.new('flow_pagination', '1.1') do |e|
+  e.description    = "FlowPagination link renderer plugin for Mislav's WillPaginate plugin (Twitter like pagination)."
+  e.url            = "http://github.com/innetra/flow_pagination"
+  e.author         = "Ivan Torres"
+  e.email          = "mexpolk@gmail.com"
+  e.ignore_pattern = ["tmp/*", "script/*"]
+  e.development_dependencies = []
+end

data/flow_pagination.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{flow_pagination}
+  s.version = "1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ivan Torres"]
+  s.date = %q{2009-05-17}
+  s.description = %q{FlowPagination link renderer plugin for Mislav's WillPaginate plugin (Twitter like pagination).}
+  s.email = %q{mexpolk@gmail.com}
+  s.extra_rdoc_files = ["README.rdoc", "lib/flow_pagination.rb"]
+  s.files = ["Manifest", "flow_pagination.gemspec", "README.rdoc", "Rakefile", "init.rb", "lib/flow_pagination.rb", "MIT-LICENSE"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/innetra/flow_pagination}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Flow_pagination", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{flow_pagination}
+  s.rubygems_version = %q{1.3.2}
+  s.summary = %q{FlowPagination link renderer plugin for Mislav's WillPaginate plugin (Twitter like pagination).}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/init.rb

@@ -0,0 +1 @@
+require 'flow_pagination'

data/lib/flow_pagination.rb

@@ -0,0 +1,37 @@
+module FlowPagination
+
+  # FlowPagination renderer for (Mislav) WillPaginate Plugin
+  class LinkRenderer < WillPaginate::LinkRenderer
+
+    # Render flow navigation
+    def to_html
+      if self.current_page < self.last_page
+        @template.content_tag :div, :id => 'flow_pagination' do
+          @template.submit_to_remote 'flow_pagination_button',
+            @template.t('flow_pagination.button', :default => 'More'),
+            :url => { :action => @template.action_name,
+            :page => self.next_page }, :method => :get
+        end
+      end
+    end
+
+    protected
+
+      # Get current page number
+      def current_page
+        @collection.current_page
+      end
+
+      # Get last page number
+      def last_page
+        @last_page ||= WillPaginate::ViewHelpers.total_pages_for_collection(@collection)
+      end
+
+      # Get next page number
+      def next_page
+        @collection.next_page
+      end
+
+  end
+
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification 
+name: innetra-flow_pagination
+version: !ruby/object:Gem::Version 
+  version: "1.1"
+platform: ruby
+authors: 
+- Ivan Torres
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-17 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: FlowPagination link renderer plugin for Mislav's WillPaginate plugin (Twitter like pagination).
+email: mexpolk@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- lib/flow_pagination.rb
+files: 
+- Manifest
+- flow_pagination.gemspec
+- README.rdoc
+- Rakefile
+- init.rb
+- lib/flow_pagination.rb
+- MIT-LICENSE
+has_rdoc: true
+homepage: http://github.com/innetra/flow_pagination
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Flow_pagination
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: flow_pagination
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 3
+summary: FlowPagination link renderer plugin for Mislav's WillPaginate plugin (Twitter like pagination).
+test_files: []
+