yap 1.0.1 → 1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fb8feec012229c542653414cb4cc9600dbd07fed
-  data.tar.gz: 468697c601588f97ff517788dc8e874df9c1d730
+  metadata.gz: 977481c7c3322da6e497d1d853a316cfa58e8322
+  data.tar.gz: e5aee06760c0f49d79539c3f1105eb30625291d1
 SHA512:
-  metadata.gz: cdfbeafd15a8e8e34df20875f7216f8af7b49a6e82cc86ad3808293bd18f1320479aaeeb8d288c6acabe1a7104542e2018b21925fac2742c652b7404ff3adcd8
-  data.tar.gz: d98c220c7ff8a117b9b6c07de144cd0a0d74305fd46f107b703a1805fa33fa5a5d4b6e66b0aa84148c0ef8f23165b0e1a4f7ea3b97e1a09e6e82a3a3e633124b
+  metadata.gz: 34b7c4a7a2b88477e0bb1578c807f94fbf2743ce7c582d6d12eb48acdc1e6401954b66c92fa217982d014f902f61b648f3f365639a021f08d6a2fcbb217cfe68
+  data.tar.gz: 522e1d53ba3134c86ce946b743a91e7abd3529b69f98094755dc6d2e237625d9ed809d800d4307474c968e614b31403070b4b30486c65d115f9a6882226bdefa

data/README.md

@@ -155,7 +155,12 @@ If an option cannot be parsed it will raise `Yap::PaginationError` or `Yap::Filt
 
 ## Changelog
 
-### 1.0.0
+### 1.1
+
+* changed default behavior for `range` to not include `total`; saves time when using `range`
+  * call `range(true)` to include total value
+
+### 1.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

data/lib/yap/active_record/relation.rb

@@ -35,20 +35,21 @@ module ActiveRecord
     end
 
     ##
-    # Returns a hash defining a range with :from, :to and :total values.
+    # Returns a hash defining a range with :from, :to and optionally :total. Note that querying the total count requires
+    # an extra query to be executed.
     #
+    # @param [Boolean] include_total Include total value
     # @return [Hash] Values defining the range of the current page.
     #
-    def range
+    def range(include_total = false)
       from = offset_value+1
       to = offset_value+limit_value
-      to = total if total < to
+      to = total if total < to && include_total
 
-      {
-          from: from,
-          to: to,
-          total: total
-      }
+      range = { from: from, to: to }
+      return range unless include_total
+
+      range.merge(total: total)
     end
   end
 end

data/lib/yap.rb

@@ -40,7 +40,7 @@ module Yap
     ##
     # The paginate scope takes a hash as parameter. All options are optional and can be combined arbitrarily.
     #
-    # @param [Hash] The parameters used for pagination (:page, :per_page, :sort, :direction)
+    # @param [Hash] params The parameters used for pagination (:page, :per_page, :sort, :direction)
     #
     scope :paginate, -> (params = {}) {
       page, per_page, order_by = extract_pagination_params(params)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yap
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: '1.1'
 platform: ruby
 authors:
 - Finn Glöe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-01 00:00:00.000000000 Z
+date: 2015-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord