schemable 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 75af2b99b8def68455dd086ca7d2b95dfbd5bcec8ccd16cca5a0695ef992c0f4
-  data.tar.gz: '058291928127918abf3d5a7f64f7d6c3c42a1e262c76c7d06b23060f534bda47'
+  metadata.gz: 7d63ce1b1c91d8f6344b5800d9e793bb33a3b9694f91f646546a0e59f470a675
+  data.tar.gz: 04c750e85b0095266a86b5e74ccf64212af0c7669476b23229b3d0874af4a287
 SHA512:
-  metadata.gz: f56ed0334197fd366ca8881d95aed351efe847486be33fac94a122b0b0c19d8fb3c958ae3edc94ec020d38bc3757396aea8d7c8010b8130907b10468b71b392f
-  data.tar.gz: ea1b2cc748f66c9fdbc620a8914450debaddc2f468ce34bf2e11257d7aeb426d6bf52e72944ddfe9203ebfb9a305f3cf7de7510481c984ace3759e0b63b375cd
+  metadata.gz: 182e79396d00e3eb16d2344467cde65f9a8a0841b152f38c9fccafe4f3dfbaf47febdeb1a00063206090eb1fed37942f00788ee7530a936bda983a9c67944d34
+  data.tar.gz: 188035d9d158f7f28b2b79b98c1b9dea08df8482344c287eebac12116fddd5758637871917b8c79194537ad8af80ea72676f17f0e8cb5df2d811f5605240909e

data/CHANGELOG.md

@@ -1,6 +1,10 @@
 # Changelog
 This file is used to list changes made in each version of the Schemable gem.
 
+## Schemable 1.0.2 (2024-01-30)
+
+* Added configuration for making certain associations nullable in the response's relationship. This can be done by adding the name of the relation in the `nullable_relationships` method's array of strings.
+
 ## Schemable 1.0.1 (2024-01-29)
 
 * Added configuration for changing the default value of enums. By default first key is used, or alternatively default can be set manually by the method `default_value_for_enum_attributes` from the definition.

data/README.md

@@ -86,6 +86,7 @@ The following is a list of the methods that can be overridden. (See the example
 | `optional_create_request_attributes`   | Returns the attributes that are not required in the create request.                                                                                    |
 | `optional_update_request_attributes`   | Returns the attributes that are not required in the update request.                                                                                    |
 | `nullable_attributes`                  | Returns the attributes that are nullable in the request/response body.                                                                                 |
+| `nullable_relationships`               | Returns the relationships that are nullable in the response body.                                                                                      |
 | `additional_create_request_attributes` | Returns the additional create request attributes that are not automatically generated.                                                                 |
 | `additional_update_request_attributes` | Returns the additional update request attributes that are not automatically generated.                                                                 |
 | `additional_response_attributes`       | Returns the additional response attributes that are not automatically generated.                                                                       |

data/lib/schemable/definition.rb

@@ -125,6 +125,18 @@ module Schemable
       %i[]
     end
 
+    # Returns the relationships that are nullable in the response body.
+    # This means that they can be present in the response body but they can be null.
+    # They are not required to be present in the request body.
+    #
+    # @example
+    #  ['users', 'applicant']
+    #
+    # @return [Array<String>] The attributes that are nullable in the response body.
+    def nullable_relationships
+      %w[]
+    end
+
     # Returns the additional create request attributes that are not automatically generated.
     # These attributes are appended to the create request schema.
     #

data/lib/schemable/relationship_schema_generator.rb

@@ -84,36 +84,43 @@ module Schemable
     #
     # @return [Hash] The generated schema for the relationship.
     def generate_schema(type_name, collection: false)
-      if collection
-        {
-          type: :object,
-          properties: {
-            data: {
-              type: :array,
-              items: {
-                type: :object,
-                properties: {
-                  id: { type: :string },
-                  type: { type: :string, default: type_name }
-                }
-              }
-            }
-          }
-        }
-      else
-        {
-          type: :object,
-          properties: {
-            data: {
-              type: :object,
-              properties: {
-                id: { type: :string },
-                type: { type: :string, default: type_name }
-              }
-            }
-          }
-        }
-      end
+      schema = if collection
+                 {
+                   type: :object,
+                   properties: {
+                     data: {
+                       type: :array,
+                       items: {
+                         type: :object,
+                         properties: {
+                           id: { type: :string },
+                           type: { type: :string, default: type_name }
+                         }
+                       }
+                     }
+                   }
+                 }
+               else
+                 {
+                   type: :object,
+                   properties: {
+                     data: {
+                       type: :object,
+                       properties: {
+                         id: { type: :string },
+                         type: { type: :string, default: type_name }
+                       }
+                     }
+                   }
+                 }
+               end
+
+      # Modify the schema to nullable if the relationship is in nullable
+      is_relation_nullable = @model_definition.nullable_relationships.include?(type_name)
+
+      return schema unless is_relation_nullable
+
+      @schema_modifier.add_properties(schema, { nullable: true }, 'properties.data')
     end
   end
 end

data/lib/schemable/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Schemable
-  VERSION = '1.0.1'
+  VERSION = '1.0.2'
 end

data/sig/schemable/definition.rbs

@@ -13,6 +13,7 @@ module Schemable
     def array_types: -> Hash[Symbol, any]
     def relationships: -> Hash[Symbol, any]
     def nullable_attributes: -> Array[Symbol]
+    def nullable_relationships: -> Array[String]
     def serialized_instance: -> Hash[Symbol, any]
     def self.generate: -> Array[Hash[Symbol, any]]
     def excluded_response_included: -> Array[Symbol]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: schemable
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Muhammad Nawzad
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-29 00:00:00.000000000 Z
+date: 2024-01-30 00:00:00.000000000 Z
 dependencies: []
 description: The schemable gem is an opinionated Gem for Rails applications to auto
   generate schema for models in JSONAPI format. It is designed to work with rswag's