acts_as_paginable 0.1.0

data/.gitignore

@@ -0,0 +1,30 @@
+.idea
+.loadpath
+.project
+config/database.yml
+config/sunspot.yml
+*.log
+*.out
+tmp/*
+nbproject/*
+index/*
+config/ferret_server.yml
+config/erp.yml
+start_server.sh
+public/images/statistics/*
+.DS_Store
+*.DS_Store
+*/.DS_Store
+*/*/.DS_Store
+.DS_STORE
+*.DS_STORE
+*/.DS_STORE
+*/*/.DS_STORE
+gigit
+db/development.sqlite3
+db/_20090313_1033.sql
+db/schema.rb
+solr/
+solr/*
+sunspot-solr.pid
+rerun.txt

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Avarteq GmbH
+
+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/README.textile

@@ -0,0 +1,22 @@
+h1. acts_as_paginable
+
+h2. Motivation
+
+Use and chain scoped_by methods in conjunction with will_paginate to create a filterable and paginable record list.
+
+h2. Requirements
+
+* Ruby on Rails
+* will_paginate
+
+h2. Usage
+
+ acts_as_paginable(:scopes => [ :attribute1, :attribute2 ])
+
+ params = { "bills_id" => "10", "customer_id" => "3", :page => "4"}
+
+ MyModel.atq_paginate(params, 10)
+
+Results in
+
+ MyModel.scoped_by_bills_id("10").scoped_by_customer_id("3").paginate(:page => "4", :per_page => "10")

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "acts_as_paginable"
+    gem.summary = "A will_paginate enhancement to automatically receive a filterable pagination method."
+    gem.description = "Filter records by passing params to a controller. No need to modify the model anymore."
+    gem.email = "fischer@avarteq.de"
+    gem.homepage = "http://github.com/avarteq/acts_as_paginable"
+    gem.authors = ["Julian Fischer"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "acts_as_paginable #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/init.rb

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

data/lib/acts_as_paginable.rb

@@ -0,0 +1,37 @@
+module Avarteq
+  module Paginator
+
+    def self.included(base)      
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+
+      # +options[:scopes]+:: List with paginable scopes
+      def acts_as_paginable(options = {})
+
+        # Accessors for class (static) variables
+        cattr_accessor :paginable_scopes, :paginable_scope_prefix, :paginable_params_suffix
+
+        self.paginable_scopes         = options[:scopes] || []
+        self.paginable_scope_prefix   = options[:scope_prefix] || "scoped_by_"
+        self.paginable_params_suffix  = options[:params_suffix] || ""
+      end
+
+      def atq_paginate(params, per_page)
+        result = self
+        self.paginable_scopes.each do |scope_name|
+          param_name = scope_name.to_s + self.paginable_params_suffix.to_s          
+          if params[param_name] && !params[param_name].empty? then
+            args    = params[param_name]
+            scope   = (self.paginable_scope_prefix + scope_name.to_s ).to_sym
+            result  = result.send(scope, args)
+          end
+        end
+        result.paginate(:page => params[:page], :per_page => per_page)
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send :include, Avarteq::Paginator

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'acts_as_paginable'
+
+class Test::Unit::TestCase
+end

data/test/test_acts_as_paginable.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestActsAsPaginable < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: acts_as_paginable
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Julian Fischer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-20 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Filter records by passing params to a controller. No need to modify the model anymore.
+email: fischer@avarteq.de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.textile
+files: 
+- .gitignore
+- MIT-LICENSE
+- README.textile
+- Rakefile
+- VERSION
+- init.rb
+- lib/acts_as_paginable.rb
+- test/helper.rb
+- test/test_acts_as_paginable.rb
+has_rdoc: true
+homepage: http://github.com/avarteq/acts_as_paginable
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A will_paginate enhancement to automatically receive a filterable pagination method.
+test_files: 
+- test/helper.rb
+- test/test_acts_as_paginable.rb