jsonapi-utils 0.7.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fa0fb8cc338bd774c92dce69ce09c955e50449c0
-  data.tar.gz: 661f6402c7943d0ab6ce6ea6fc6c5f67260c2828
+  metadata.gz: 67e5ec59fd75caee715c6e6cac80336259a4cb91
+  data.tar.gz: d138871fc7ea80fb1c4f2277f7716aaf27615760
 SHA512:
-  metadata.gz: f7813a7385d284f6aba51027410645fae4b38563ca611482cde9fd5f4dde80fce225b8ccf82c34b9a43fcbcf2a825c757fbdbe1607c1dc62b1b715f2672f447e
-  data.tar.gz: cde1ac2b6cc5a5f43b0d7da7e8cac598d527821dde18dcbc9ee633acbece6411e5cefafbf81d5c4cc791af78abdf72e0f371e67c945aec4611fe8e91bb888d9a
+  metadata.gz: 7bc928e3037b6e4483f54238c081e969bf62a51845e243f039240b449af8b5f1867a2c9889381bc6b7d334e482cd580fd914c77bb40215c1d36d74875af6d358
+  data.tar.gz: c2616c4ee9bb69e292ca6b0625322ba3b1add51ab9a8f7698fe6877e6911efa4c7a4e4c7eb4afce6abe0e876ba2c46da73175d2551abd742fe3f16dacffe70a8

data/lib/jsonapi/utils/response/formatters.rb

@@ -171,7 +171,7 @@ module JSONAPI
           end
         end
 
-        # Apply some result options like pagination params and count to a collection response.
+        # Apply some result options like pagination params and record count to collection responses.
         #
         # @param records [ActiveRecord::Relation, Hash, Array<Hash>]
         #   Object to be formatted into JSON
@@ -192,7 +192,7 @@ module JSONAPI
             end
 
             if JSONAPI.configuration.top_level_meta_include_record_count
-              data[:record_count] = count_records(records, options)
+              data[:record_count] = record_count_for(records, options)
             end
           end
         end

data/lib/jsonapi/utils/support/pagination.rb

@@ -2,6 +2,8 @@ module JSONAPI
   module Utils
     module Support
       module Pagination
+        RecordCountError = Class.new(ArgumentError)
+
         # Apply proper pagination to the records.
         #
         # @param records [ActiveRecord::Relation, Array] collection of records
@@ -33,7 +35,23 @@ module JSONAPI
         # @api public
         def pagination_params(records, options)
           return {} unless JSONAPI.configuration.top_level_links_include_pagination
-          paginator.links_page_params(record_count: count_records(records, options))
+          paginator.links_page_params(record_count: record_count_for(records, options))
+        end
+
+        # Apply memoization to the record count result avoiding duplicate counts.
+        #
+        # @param records [ActiveRecord::Relation, Array] collection of records
+        #   e.g.: User.all or [{ id: 1, name: 'Tiago' }, { id: 2, name: 'Doug' }]
+        #
+        # @param options [Hash] JU's options
+        #   e.g.: { resource: V2::UserResource, count: 100 }
+        #
+        # @return [Integer]
+        #   e.g.: 42
+        #
+        # @api public
+        def record_count_for(records, options)
+          @record_count ||= count_records(records, options)
         end
 
         private
@@ -130,14 +148,49 @@ module JSONAPI
         #
         # @api private
         def count_records(records, options)
-          if options[:count].present?
-            options[:count]
-          elsif records.is_a?(Array)
-            records.length
-          else
-            records = apply_filter(records, options) if params[:filter].present?
-            records.except(:group, :order).count("DISTINCT #{records.table.name}.id")
+          return options[:count].to_i if options[:count].is_a?(Numeric)
+
+          case records
+          when ActiveRecord::Relation then count_records_from_database(records, options)
+          when Array                  then records.length
+          else raise RecordCountError, "Can't count records with the given options"
+          end
+        end
+
+        # Count records from the datatase applying the given request filters
+        # and skipping things like eager loading, grouping and sorting.
+        #
+        # @param records [ActiveRecord::Relation, Array] collection of records
+        #   e.g.: User.all or [{ id: 1, name: 'Tiago' }, { id: 2, name: 'Doug' }]
+        #
+        # @param options [Hash] JU's options
+        #   e.g.: { resource: V2::UserResource, count: 100 }
+        #
+        # @return [Integer]
+        #   e.g.: 42
+        #
+        # @api private
+        def count_records_from_database(records, options)
+          records = apply_filter(records, options) if params[:filter].present?
+          count   = -> (records, except:) do
+            records.except(*except).count(distinct_count_sql(records))
           end
+          count.(records, except: %i(includes group order))
+        rescue ActiveRecord::StatementInvalid
+          count.(records, except: %i(group order))
+        end
+
+        # Build the SQL distinct count with some reflection on the "records" object.
+        #
+        # @param records [ActiveRecord::Relation] collection of records
+        #   e.g.: User.all
+        #
+        # @return [String]
+        #   e.g.: "DISTINCT users.id"
+        #
+        # @api private
+        def distinct_count_sql(records)
+          "DISTINCT #{records.table_name}.#{records.primary_key}"
         end
       end
     end

data/lib/jsonapi/utils/version.rb

@@ -1,5 +1,5 @@
 module JSONAPI
   module Utils
-    VERSION = '0.7.0'.freeze
+    VERSION = '0.7.1'.freeze
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi-utils
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Tiago Guedes
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-07-16 00:00:00.000000000 Z
+date: 2018-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jsonapi-resources
@@ -151,8 +151,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: A Rails way to get your API's data serialized through JSON API's specs
-  (http://jsosapi.org)
+description: Build JSON API-compliant APIs on Rails with no (or less) learning curve.
 email:
 - tiagopog@gmail.com
 - douglas@beautydate.com.br
@@ -200,9 +199,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
-summary: JSON::Utils is a simple way to get a full-featured JSON API serialization
-  for your controller's responses.
+summary: JSON::Utils is a simple way to get a full-featured JSON API on your Rails
+  application.
 test_files: []