Rename "jsonapi_serialize" to "jsonapi_format"

Author: tiagopog

README.md

@@ -68,13 +68,15 @@ jsonapi_render json: { data: { id: 1, first_name: 'Tiago' } }, options: { model:
 jsonapi_render json: { data: [{ id: 1, first_name: 'Tiago' }, { id: 2, first_name: 'Doug' }] }, options: { model: User }
 ```
 
-### jsonapi_serialize
+### jsonapi_format
 
 In the backstage this is the method that actually parses ActiveRecord/Hash objects and builds a new Hash compliant with JSON API. It can be called anywhere in your controllers being very useful whenever you need to work with a JSON API "serialized" version of your object before rendering it. 
 
+Note: because of semantic reasons `JSONAPI::Utils#jsonapi_serialize` was renamed being now just an alias to `JSONAPI::Utils#jsonapi_format`.
+
 ```ruby
 def index
-  result = do_some_magic(jsonapi_serialize(User.all))
+  result = do_some_magic(jsonapi_format(User.all))
   render json: result
 end
 ```

lib/jsonapi/utils/response/formatters.rb

@@ -2,7 +2,7 @@ module JSONAPI
   module Utils
     module Response
       module Formatters
-        def jsonapi_serialize(records, options = {})
+        def jsonapi_format(records, options = {})
           if records.is_a?(Hash)
             hash    = records.with_indifferent_access
             records = hash_to_active_record(hash[:data], options[:model])
@@ -11,6 +11,10 @@ def jsonapi_serialize(records, options = {})
           build_response_document(records, options).contents
         end
 
+        alias_method :jsonapi_serialize, :jsonapi_format
+
+        module_function
+
         def build_response_document(records, options)
           results = JSONAPI::OperationResults.new
 

lib/jsonapi/utils/response/renders.rb

@@ -3,7 +3,7 @@ module Utils
     module Response
       module Renders
         def jsonapi_render(json:, status: nil, options: {})
-          body = jsonapi_serialize(json, options)
+          body = jsonapi_format(json, options)
           render json: body, status: status || @_response_document.status
         rescue => e
           handle_exceptions(e)