Rename configuration options for clarity

  pagination_links => top_level_links_include_pagination
  record_count_in_meta => top_level_meta_include_record_count
  record_count_meta_key => top_level_meta_record_count_key

Author: lgebhardt

README.md

@@ -540,8 +540,8 @@ The operation callbacks have access to two meta data hashes, `@operations_meta`
 
 ##### Custom `OperationsProcessor` Example to Return total_count in Meta
 
-Note: this can also be accomplished with the `record_count_in_meta` option, and in most cases that will be the better
-option. 
+Note: this can also be accomplished with the `top_level_meta_include_record_count` option, and in most cases that will
+be the better option. 
 
 To return the total record count of a find operation in the meta data of a find operation you can create a custom
 OperationsProcessor. For example:
@@ -1201,14 +1201,14 @@ JSONAPI.configure do |config|
   config.default_paginator = :none
 
   # Output pagination links at top level
-  config.pagination_links = true
+  config.top_level_links_include_pagination = true
 
   config.default_page_size = 10
   config.maximum_page_size = 20
 
   # Output the record count in top level meta data for find operations
-  config.record_count_in_meta = false
-  config.record_count_meta_key = :record_count
+  config.top_level_meta_include_record_count = false
+  config.top_level_meta_record_count_key = :record_count
 
   config.use_text_errors = false
 end

lib/jsonapi/configuration.rb

@@ -14,9 +14,9 @@ class Configuration
                 :default_page_size,
                 :maximum_page_size,
                 :use_text_errors,
-                :pagination_links,
-                :record_count_in_meta,
-                :record_count_meta_key
+                :top_level_links_include_pagination,
+                :top_level_meta_include_record_count,
+                :top_level_meta_record_count_key
 
     def initialize
       #:underscored_key, :camelized_key, :dasherized_key, or custom
@@ -34,15 +34,15 @@ def initialize
       self.default_paginator = :none
 
       # Output pagination links at top level
-      self.pagination_links = true
+      self.top_level_links_include_pagination = true
 
       self.default_page_size = 10
       self.maximum_page_size = 20
 
       # Metadata
       # Output record count in top level meta for find operation
-      self.record_count_in_meta = false
-      self.record_count_meta_key = :record_count
+      self.top_level_meta_include_record_count = false
+      self.top_level_meta_record_count_key = :record_count
 
       self.use_text_errors = false
     end
@@ -82,16 +82,16 @@ def use_text_errors=(use_text_errors)
       @use_text_errors = use_text_errors
     end
 
-    def pagination_links=(pagination_links)
-      @pagination_links = pagination_links
+    def top_level_links_include_pagination=(top_level_links_include_pagination)
+      @top_level_links_include_pagination = top_level_links_include_pagination
     end
 
-    def record_count_in_meta=(record_count_in_meta)
-      @record_count_in_meta = record_count_in_meta
+    def top_level_meta_include_record_count=(top_level_meta_include_record_count)
+      @top_level_meta_include_record_count = top_level_meta_include_record_count
     end
 
-    def record_count_meta_key=(record_count_meta_key)
-      @record_count_meta_key = record_count_meta_key
+    def top_level_meta_record_count_key=(top_level_meta_record_count_key)
+      @top_level_meta_record_count_key = top_level_meta_record_count_key
     end
   end
 

lib/jsonapi/operation.rb

@@ -30,7 +30,7 @@ def record_count
     end
 
     def pagination_params
-      if @paginator && JSONAPI.configuration.pagination_links
+      if @paginator && JSONAPI.configuration.top_level_links_include_pagination
         options = {}
         options[:record_count] = record_count if @paginator.class.requires_record_count
         return @paginator.links_page_params(options)
@@ -47,8 +47,13 @@ def apply(context)
                                              paginator: @paginator)
 
       options = {}
-      options[:pagination_params] = pagination_params if JSONAPI.configuration.pagination_links
-      options[:record_count] = record_count if JSONAPI.configuration.record_count_in_meta
+      if JSONAPI.configuration.top_level_links_include_pagination
+        options[:pagination_params] = pagination_params
+      end
+
+      if JSONAPI.configuration.top_level_meta_include_record_count
+        options[:record_count] = record_count
+      end
 
       return JSONAPI::ResourcesOperationResult.new(:ok,
                                                    resource_records,

lib/jsonapi/response_document.rb

@@ -50,8 +50,8 @@ def top_level_meta
       @operation_results.results.each do |result|
         meta.merge!(result.meta)
 
-        if JSONAPI.configuration.record_count_in_meta
-          meta[JSONAPI.configuration.record_count_meta_key] = result.record_count
+        if JSONAPI.configuration.top_level_meta_include_record_count
+          meta[JSONAPI.configuration.top_level_meta_record_count_key] = result.record_count
         end
       end
 

test/controllers/controller_test.rb

@@ -2150,9 +2150,9 @@ def test_books_offset_pagination_no_params
 
   def test_books_record_count_in_meta
     Api::V2::BookResource.paginator :offset
-    JSONAPI.configuration.record_count_in_meta = true
+    JSONAPI.configuration.top_level_meta_include_record_count = true
     get :index, {include: 'book-comments'}
-    JSONAPI.configuration.record_count_in_meta = false
+    JSONAPI.configuration.top_level_meta_include_record_count = false
 
     assert_response :success
     assert_equal 1000, json_response['meta']['record-count']
@@ -2162,12 +2162,12 @@ def test_books_record_count_in_meta
 
   def test_books_record_count_in_meta_custom_name
     Api::V2::BookResource.paginator :offset
-    JSONAPI.configuration.record_count_in_meta = true
-    JSONAPI.configuration.record_count_meta_key = 'total_records'
+    JSONAPI.configuration.top_level_meta_include_record_count = true
+    JSONAPI.configuration.top_level_meta_record_count_key = 'total_records'
 
     get :index, {include: 'book-comments'}
-    JSONAPI.configuration.record_count_in_meta = false
-    JSONAPI.configuration.record_count_meta_key = :record_count
+    JSONAPI.configuration.top_level_meta_include_record_count = false
+    JSONAPI.configuration.top_level_meta_record_count_key = :record_count
 
     assert_response :success
     assert_equal 1000, json_response['meta']['total-records']