acts_as_paginable 0.1.0 → 0.3.0

data/.gitignore

@@ -28,3 +28,4 @@ solr/
 solr/*
 sunspot-solr.pid
 rerun.txt
+pkg/*

data/CHANGELOG.textile

@@ -0,0 +1,23 @@
+h1. 0.3.0
+
+Separated scope chaining from invokation of paginate. This allows you to invoke further methods on the chained scope such as:
+
+bc. Bill.chain_scopes(params, per_page).sum("billing_positions.amount")
+
+So
+
+bc. Bill.atq_paginate(params, per_page).paginate
+
+is now defined as:
+
+bc. chain_scopes(:page => params[:page], :per_page => per_page).paginate(:page => params[:page], :per_page => per_page)
+
+h1. 0.2.1
+
+* Now supports params[:order] passed to the corresponding named_scope
+
+h1. 0.2.0
+
+* named_scope "order" to be able to order records like this:
+
+bc. MyClass.scoped_by_attr.order("id DESC")

data/README.textile

@@ -11,12 +11,10 @@ h2. Requirements
 
 h2. Usage
 
- acts_as_paginable(:scopes => [ :attribute1, :attribute2 ])
-
- params = { "bills_id" => "10", "customer_id" => "3", :page => "4"}
-
- MyModel.atq_paginate(params, 10)
+bc. 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")
+bc. MyModel.scoped_by_bills_id("10").scoped_by_customer_id("3").paginate(:page => "4", :per_page => "10")

data/Rakefile

@@ -10,6 +10,7 @@ begin
     gem.email = "fischer@avarteq.de"
     gem.homepage = "http://github.com/avarteq/acts_as_paginable"
     gem.authors = ["Julian Fischer"]
+    gem.add_dependency "will_paginate"
     gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.3.0

data/acts_as_paginable.gemspec

@@ -0,0 +1,57 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{acts_as_paginable}
+  s.version = "0.3.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Julian Fischer"]
+  s.date = %q{2010-05-17}
+  s.description = %q{Filter records by passing params to a controller. No need to modify the model anymore.}
+  s.email = %q{fischer@avarteq.de}
+  s.extra_rdoc_files = [
+    "README.textile"
+  ]
+  s.files = [
+    ".gitignore",
+     "CHANGELOG.textile",
+     "MIT-LICENSE",
+     "README.textile",
+     "Rakefile",
+     "VERSION",
+     "acts_as_paginable.gemspec",
+     "init.rb",
+     "lib/acts_as_paginable.rb",
+     "test/helper.rb",
+     "test/test_acts_as_paginable.rb"
+  ]
+  s.homepage = %q{http://github.com/avarteq/acts_as_paginable}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{A will_paginate enhancement to automatically receive a filterable pagination method.}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_acts_as_paginable.rb"
+  ]
+
+  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
+      s.add_runtime_dependency(%q<will_paginate>, [">= 0"])
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<will_paginate>, [">= 0"])
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<will_paginate>, [">= 0"])
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+  end
+end
+

data/lib/acts_as_paginable.rb

@@ -3,6 +3,9 @@ module Avarteq
 
     def self.included(base)      
       base.extend(ClassMethods)
+      
+      # Named scope so that records can be ordered like this: MyClass.scoped_by_attr.order("id DESC")
+      base.send(:named_scope, :order, lambda {|order| { :order => order } })
     end
 
     module ClassMethods
@@ -16,9 +19,16 @@ module Avarteq
         self.paginable_scopes         = options[:scopes] || []
         self.paginable_scope_prefix   = options[:scope_prefix] || "scoped_by_"
         self.paginable_params_suffix  = options[:params_suffix] || ""
-      end
+      end      
 
+      # Chains scopes as given by params and returns the paginated result.
       def atq_paginate(params, per_page)
+        result = chain_scopes(params, per_page)
+        result.paginate(:page => params[:page], :per_page => per_page)
+      end
+      
+      # Chains scopes as given by params but does not invoke paginate.
+      def chain_scopes(params, per_page)
         result = self
         self.paginable_scopes.each do |scope_name|
           param_name = scope_name.to_s + self.paginable_params_suffix.to_s          
@@ -28,7 +38,8 @@ module Avarteq
             result  = result.send(scope, args)
           end
         end
-        result.paginate(:page => params[:page], :per_page => per_page)
+        result = result.order(params[:order]) if params[:order] && !params[:order].empty?
+        result
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: acts_as_paginable
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Julian Fischer
@@ -9,9 +9,19 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-20 00:00:00 +02:00
+date: 2010-05-17 00:00:00 +02:00
 default_executable: 
 dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: will_paginate
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
 - !ruby/object:Gem::Dependency 
   name: thoughtbot-shoulda
   type: :development
@@ -32,10 +42,12 @@ extra_rdoc_files:
 - README.textile
 files: 
 - .gitignore
+- CHANGELOG.textile
 - MIT-LICENSE
 - README.textile
 - Rakefile
 - VERSION
+- acts_as_paginable.gemspec
 - init.rb
 - lib/acts_as_paginable.rb
 - test/helper.rb