yap 0.3.3 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 25cfbc9977c71d10fc1a33ab813eff876c633401
-  data.tar.gz: ab538d4945cd053de7db5072e5238a6e9655cf48
+  metadata.gz: fb8feec012229c542653414cb4cc9600dbd07fed
+  data.tar.gz: 468697c601588f97ff517788dc8e874df9c1d730
 SHA512:
-  metadata.gz: 94eb394ae4b57e7fd28adcc819501095337be522cec96b9982f909c6c1d79e30cfe538e8b134cf0fb90ee6e8eab366a23df3010222a7ed57a16bb27ed2ac0661
-  data.tar.gz: 0f6a6fe7afd9e646253809a99de8b926804f2550c40ee4236631dbcc2bafc4560866f8ca87c481323029b643b9a69046fbe38a505d762aceadfe689e6457200a
+  metadata.gz: cdfbeafd15a8e8e34df20875f7216f8af7b49a6e82cc86ad3808293bd18f1320479aaeeb8d288c6acabe1a7104542e2018b21925fac2742c652b7404ff3adcd8
+  data.tar.gz: d98c220c7ff8a117b9b6c07de144cd0a0d74305fd46f107b703a1805fa33fa5a5d4b6e66b0aa84148c0ef8f23165b0e1a4f7ea3b97e1a09e6e82a3a3e633124b

data/README.md

@@ -1,5 +1,3 @@
-# yap v0.3.3
-
 Yet another paginator for Ruby on Rails, which adds a `paginate` scope to your ActiveRecords.
 
 ## Setup
@@ -45,36 +43,64 @@ internal naming from users and to make sorting by associations possible (more on
 
 Assuming you included `Yap` into `User`, you can now do something like this:
 
-    User.paginate                       # => Page 1 with default order and size
+    User.paginate
+    # => Page 1 with default order and size
+
     User.paginate(
         page:       1,
         per_page:   10,
         sort:       'id',
         direction:  'ASC'
-    )                                   # => Invocation with custom options.
+    )
+    # => Invocation with custom options.
+
+    User.paginate(params).last_page
+    # => Last page as a number for the previously paginated query
+    User.paginate(params).range
+    # => E.g. { from: 1, to: 10, total: 100 }
+    User.paginate(params).total
+    # => total number of results for this filters
+
+    User.paginate(params).without_pagination do |rel|
+      # access rel without limit and offset; filters still apply
+      rel.count
+    end
+    # => total number of results
 
-    User.last_page                      # => Last page as a number for defaults
-    User.last_page(params)              # => Last page for given params. Works the same way as paginate.
+    User.filter('gender' => 'f')
+    # => All female users
 
-    User.filter('gender' => 'f')        # => All female users
     User.filter(
         'team_id' => '1,2',
         'gender' => 'm'
-    )                                   # => All males of teams 1 and 2
+    )
+    # => All males of teams 1 and 2
+
     User.filter(
-        'date_of_birth' => '1990-01-01..1991-01-01'
-    )                                   # => All users born in 1990
-    User.filter('team_id' => '!null')   # => All users with any team
+        # Note that '0...3' means [0,1,2] while '0..3' means [0,1,2,3]
+        'date_of_birth' => '1990-01-01...1991-01-01'
+    )
+    # => All users born in 1990
+
+    User.filter('team_id' => '!null')
+    # => All users with any team
+
     User.paginate(
         page:   1,
         filter: { 'team' => 'null' }
-    )                                   # => Combining filter and pagination
+    )
+    # => Combining filter and pagination
 
-    User.paginate(params)               # => Passing parameters in controller (http://localhost/users?filter[gender]=f)
+    User.paginate(params)
+    # => Passing parameters in controller (http://localhost/users?filter[gender]=f)
 
 Yap will convert strings to symbols or numbers and vice versa where necessary. This make the last one a really powerful
 method of offering the pagination API directly to the user.
 
+### Chaining
+
+The `paginate` scope can be chained with other `ActiveRecord` methods like `joins`, `where` etc..
+
 ### Advanced
 
 The "team" alias defined in the column map above allows us to sort the results by the name of the team a user belongs
@@ -125,6 +151,15 @@ If an option cannot be parsed it will raise `Yap::PaginationError` or `Yap::Filt
 
 ## ToDos
 
-* Methods for generating next, previous and last page links
-* Maximum for per_page
-* Rescue from sql errors
+* Make gathering total/range optional
+
+## Changelog
+
+### 1.0.0
+
+* changed `last_page` to base on the actual query not only the parameters
+    * this now produces correct results if there are custom `where` conditions
+* added `range` method which can be used like `last_page`
+    * provides a hash containing the limits of the latest queried page
+* added `total` method to get the total number of results
+* added `without_pagination` which takes a block an serves an `Activerecord::Relation` which is not paginated

data/lib/yap/active_record/relation.rb

@@ -0,0 +1,54 @@
+module ActiveRecord
+  class Relation
+    ##
+    # Access the relation without pagination in a block. Limit and offset values are removed, filters still apply.
+    #
+    # @return [Object] Return value of the block
+    #
+    def without_pagination
+      rel = dup
+      rel.limit! nil
+      rel.offset! nil
+
+      yield rel
+    end
+
+    ##
+    # Returns the total number of results without pagination. This is used for generating range and last_page values.
+    # The result for a relation is cached because count can be quite expensive.
+    #
+    # @return [Integer] Total number of results
+    #
+    def total
+      @total ||= without_pagination { |rel| rel.count }
+    end
+
+    ##
+    # Calculates the last page for paginated results.
+    #
+    # @return [Integer] Last page as a number
+    #
+    def last_page
+      page = (total / limit_value.to_f).ceil
+
+      page == 0 ? 1 : page
+    end
+
+    ##
+    # Returns a hash defining a range with :from, :to and :total values.
+    #
+    # @return [Hash] Values defining the range of the current page.
+    #
+    def range
+      from = offset_value+1
+      to = offset_value+limit_value
+      to = total if total < to
+
+      {
+          from: from,
+          to: to,
+          total: total
+      }
+    end
+  end
+end

data/lib/yap.rb

@@ -1,7 +1,8 @@
 require 'active_support/concern'
-require 'yap/exceptions'
+require 'yap/active_record/relation'
 require 'yap/column_mapper'
 require 'yap/filterable'
+require 'yap/exceptions'
 
 ##
 # Support for Active Record pagination. All options can be safely accessed by the user through url query parameters. To
@@ -25,23 +26,15 @@ module Yap
   extend ActiveSupport::Concern
   include Filterable
 
-  DEFAULTS = Struct.new(:page, :per_page, :sort, :direction, :disable_warnings)
-                 .new(1, 10, :id, :asc, false)
+  DEFAULTS = Struct.new(:page, :per_page, :hard_limit, :sort, :direction, :disable_warnings)
+                 .new(1, 10, nil, :id, :asc, false)
 
   def self.configure
     raise ArgumentError, 'No block given.' unless block_given?
     yield(DEFAULTS)
   end
 
-  module ClassMethods
-    def last_page(params)
-      per_page = extract_number(params[:per_page], DEFAULTS.per_page)
-      (filter(params[:filter]).count / per_page.to_f).ceil
-    end
-  end
-
   included do
-    extend ClassMethods
     extend ColumnMapper
 
     ##
@@ -59,6 +52,9 @@ module Yap
     def self.extract_pagination_params(params)
       page = extract_number(params[:page], DEFAULTS.page)
       per_page = extract_number(params[:per_page], DEFAULTS.per_page)
+      if DEFAULTS.hard_limit && per_page > DEFAULTS.hard_limit
+        raise PaginationError.new("Not more than #{DEFAULTS.hard_limit} items per page accepted.")
+      end
       sort = extract_column(params[:sort])
       direction = extract_direction(params[:direction])
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yap
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 1.0.1
 platform: ruby
 authors:
 - Finn Glöe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-24 00:00:00.000000000 Z
+date: 2015-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.1.0
+        version: '4.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.1.0
+        version: '4.1'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -48,6 +48,7 @@ files:
 - LICENSE
 - README.md
 - lib/yap.rb
+- lib/yap/active_record/relation.rb
 - lib/yap/column_mapper.rb
 - lib/yap/exceptions.rb
 - lib/yap/filter.rb
@@ -62,9 +63,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: 2.1.0
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="