add comments

Author: patodevilla

lib/rails_jsonapi.rb

@@ -12,6 +12,7 @@ module RailsJSONAPI
 
   @class_to_serializer_proc = ->(klass){ "#{klass.name}Serializer".constantize }
 
+  # deserializer must return [Hash{Symbol => *}]
   @type_to_deserializer_proc = ->(type){ "#{type.underscore.classify}Deserializer".constantize }
 
   class << self

lib/rails_jsonapi/controller.rb

@@ -54,7 +54,7 @@ def json_api_request?
       #
       # @example `GET /resource?fields[relationship]=id,created_at`
       #
-      # @return [Hash]
+      # @return [Hash|ActiveSupport::HashWithIndifferentAccess]
       def jsonapi_fields_param
         return {} unless params[:fields].respond_to?(:each_pair)
 
@@ -95,6 +95,10 @@ def self.included(base)
       end
 
       module ClassMethods
+        # @param resource [ActionController::Parameters]
+        # @param lid_key [String]
+        # @param lid_regex [Regexp]
+        # @return [Hash{Symbol => *}]
         def deep_deserialize_jsonapi(resource, lid_key, lid_regex)
           resource = resource.as_json if resource.is_a?(ActionController::Parameters)
           RailsJSONAPI::DeepDeserializer.new(resource, lid_key, lid_regex)

lib/rails_jsonapi/deep_deserializer.rb

@@ -1,7 +1,7 @@
 module RailsJSONAPI
   class DeepDeserializer
 
-    # @param [Hash] resource jsonapi payload
+    # @param [Hash{String => *}] resource jsonapi payload
     # @param [String] lid_key
     # @param [String] lid_regex
     def initialize(resource, lid_key, lid_regex)
@@ -10,12 +10,16 @@ def initialize(resource, lid_key, lid_regex)
       @lid_regex = lid_regex
     end
 
+    # @param [Hash{String => *}] resource jsonapi payload
+    # @return [Hash{Symbol => *}]
     def deep_deserialize(resource = @resource)
       data = resource.key?('data') ? resource['data'] : resource
       included = resource['included']
 
       normalize_resource(data)
       klass_deserializer = RailsJSONAPI.type_to_deserializer_proc.call(data['type'])
+
+      # Hash{Symbol => *}
       deserialized = klass_deserializer.call(data)
 
       # remove id if local
@@ -43,11 +47,11 @@ def deep_deserialize(resource = @resource)
 
     private
 
-    # Transforms *attributes* and *relationships* with underscore and sets the local-id into attributes
+    # Transforms *attributes* and *relationships* with underscore and sets the local id *lid* into attributes
     #
     # @todo is underscoring necessary? can this be handled by jsonapi-deserializable?
     #
-    # @param [Hash] data
+    # @param [Hash{String => *}] data
     # @return [void]
     def normalize_resource(data)
       data['attributes'] = data['attributes'].transform_keys{|k| k.underscore } if data['attributes'].present?

lib/rails_jsonapi/error_serializer/active_model.rb

@@ -8,6 +8,8 @@ module ErrorSerializer
     #   [...]
     # ]
     #
+    # @note requires record to respond to +lid_id+
+    #
     class ActiveModel < Base
       set_id :object_id
       set_type :error
@@ -40,7 +42,7 @@ class ActiveModel < Base
           attribute = path.pop
           record = get_record_from_errors_path(params[:record], path)
           if record
-             "(#{I18n.t("activerecord.models.#{record.class.name.underscore}.one")} #{(record.id || record.lid_id)}) " + record.errors.full_message(attribute, error_msg)
+             "(#{I18n.t("activerecord.models.#{record.class.name.underscore}.one")} #{record.id || record.try(:lid_id)}) " + record.errors.full_message(attribute, error_msg)
           else
             errors_object.full_message(error_key, error_msg)
           end