schemable 1.0.1 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 75af2b99b8def68455dd086ca7d2b95dfbd5bcec8ccd16cca5a0695ef992c0f4
-  data.tar.gz: '058291928127918abf3d5a7f64f7d6c3c42a1e262c76c7d06b23060f534bda47'
+  metadata.gz: 76b5ccf66c28d0bcfc644321e370e1c4404518ee1a4ba056fe20bb72a22cc415
+  data.tar.gz: cd7ad60e43634159a2b845c15ef557a3a60b02cb5c465e63e5f90ff47807afe5
 SHA512:
-  metadata.gz: f56ed0334197fd366ca8881d95aed351efe847486be33fac94a122b0b0c19d8fb3c958ae3edc94ec020d38bc3757396aea8d7c8010b8130907b10468b71b392f
-  data.tar.gz: ea1b2cc748f66c9fdbc620a8914450debaddc2f468ce34bf2e11257d7aeb426d6bf52e72944ddfe9203ebfb9a305f3cf7de7510481c984ace3759e0b63b375cd
+  metadata.gz: 835b1048ab2efd7419b45e77d4733e769d9c657a5cd08e67a26584f3cf6f3ca23588d7875eb21353d9a283f422b50bb50bfc8a5ef0dd2edcad3dcf0c76cfda16
+  data.tar.gz: accc7a59d075dfc07437f7d2c6bfa8367336b3aafd8d04aca652c38a98cebdf3e7f80c614c1e90524091df6f32e7306ac4f2d183ab79157863f4014376a3b14a

data/CHANGELOG.md

@@ -1,6 +1,14 @@
 # Changelog
 This file is used to list changes made in each version of the Schemable gem.
 
+## Schemable 1.0.3 (2024-01-30)
+
+* Added configuration for preventing expansion for nested relationships. This can be done by setting the `expand_nested` to `true` when  invoking `ResponseSchemaGenerator`'s `generate` instance method (e.g. `ResponseSchemaGenerator.new(instance).generate(expand: true, expand_nested: true)`. Additionally, you could globally set the value of `expand_nested` to the same value as `expand` by setting the configuration `infer_expand_nested_from_expand` to `true` in the `/config/initializers/schemable.rb`.
+
+## 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

@@ -61,6 +61,7 @@ Please note that the configurations options below are defined in the `Schemable`
 | `enum_prefix_for_simple_enum`                | The prefix to be used for the enum values when `mongoid` is used.                                                                                                                                                                                                                                          | `nil`         |
 | `enum_suffix_for_simple_enum`                | The suffix to be used for the enum values when `mongoid` is used.                                                                                                                                                                                                                                          | `nil`         |
 | `infer_attributes_from_custom_method`        | The name of the custom method that is used to get the attributes to be generated in the schema. See [Annex 1.3 - Infer attributes from custom method](#annex-13---infer-attributes-from-custom-method) for more information.                                                                               | `nil`         |
+| `infer_expand_nested_from_expand`            | Configures `ResponseSchemaGenerator`'s `generate` method to prevent expansion for nested relationships. It globally set the value of `expand_nested` to the same value as `expand` by setting the configuration to `true`                                                                                  | `flase`       |
 | `infer_attributes_from_jsonapi_serializable` | Whether or not to infer the attributes from the `JSONAPI::Serializable::Resource` class. See the previous example [Annex 1.1 - Use serialized instance](#annex-11---use-serialized-instance) for more information.                                                                                         | `false`       |
 | `custom_meta_response_schema`                | A hash of custom meta response schema that can be used to override the default meta response schema. See [Annex 1.4 - Custom meta response schema](#annex-14---custom-meta-response-schema) for more information.                                                                                          | `nil`         |
 | `pagination_enabled`                         | Enable pagination schema generation in the `meta` section of the response schema.                                                                                                                                                                                                                          | `true`        |
@@ -86,6 +87,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.                                                                       |
@@ -399,7 +401,7 @@ module Swagger
           "#{schema_instance.model}CreateRequest": schema_instance.camelize_keys(Schemable::RequestSchemaGenerator.new(schema_instance).generate_for_create),
           "#{schema_instance.model}UpdateRequest": schema_instance.camelize_keys(Schemable::RequestSchemaGenerator.new(schema_instance).generate_for_update),
           "#{schema_instance.model}Response": schema_instance.camelize_keys(Schemable::ResponseSchemaGenerator.new(schema_instance).generate(expand: true, collection: true, relationships_to_exclude_from_expansion: %w[addresses stores attachments])),
-          "#{schema_instance.model}ResponseExpanded": schema_instance.camelize_keys(Schemable::ResponseSchemaGenerator.new(schema_instance).generate(expand: true))
+          "#{schema_instance.model}ResponseExpanded": schema_instance.camelize_keys(Schemable::ResponseSchemaGenerator.new(schema_instance).generate(expand: true, expand_nested: true))
         ]
       end
     end

data/lib/schemable/configuration.rb

@@ -16,6 +16,7 @@ module Schemable
       :enum_prefix_for_simple_enum,
       :enum_suffix_for_simple_enum,
       :custom_meta_response_schema,
+      :infer_expand_nested_from_expand,
       :infer_attributes_from_custom_method,
       :infer_attributes_from_jsonapi_serializable
     )
@@ -32,6 +33,7 @@ module Schemable
       @custom_meta_response_schema = nil
       @enum_prefix_for_simple_enum = nil
       @enum_suffix_for_simple_enum = nil
+      @infer_expand_nested_from_expand = false
       @infer_attributes_from_custom_method = nil
       @infer_attributes_from_jsonapi_serializable = false
     end

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/response_schema_generator.rb

@@ -27,12 +27,16 @@ module Schemable
     # @param expand [Boolean] Whether to include the included resources in the schema.
     # @param relationships_to_exclude_from_expansion [Array] The relationships to exclude from expansion in the schema.
     # @param collection [Boolean] Whether the response is for a collection of resources.
+    # @param expand_nested [Boolean] Whether to include the nested relationships in the schema.
     #
     # @example
-    #   schema = generator.generate(expand: true, relationships_to_exclude_from_expansion: ['some_relationship'], collection: true)
+    #   schema = generator.generate(expand: true, relationships_to_exclude_from_expansion: ['some_relationship'], collection: true, expand_nested: true)
     #
     # @return [Hash] The generated schema.
-    def generate(expand: false, relationships_to_exclude_from_expansion: [], collection: false)
+    def generate(expand: false, relationships_to_exclude_from_expansion: [], collection: false, expand_nested: false)
+      # Override expand_nested if infer_expand_nested_from_expand is true
+      expand_nested = expand if @configuration.infer_expand_nested_from_expand
+
       data = {
         type: :object,
         properties: {
@@ -51,7 +55,7 @@ module Schemable
       schema = collection ? { data: { type: :array, items: data } } : { data: }
 
       if expand
-        included_schema = IncludedSchemaGenerator.new(@model_definition).generate(expand:, relationships_to_exclude_from_expansion:)
+        included_schema = IncludedSchemaGenerator.new(@model_definition).generate(expand: expand_nested, relationships_to_exclude_from_expansion:)
         @schema_modifier.add_properties(schema, included_schema, '.')
       end
 

data/lib/schemable/version.rb

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

data/lib/templates/schemable.rb

@@ -41,6 +41,11 @@ Schemable.configure do |config|
   #
   # config.infer_attributes_from_custom_method = nil
 
+  # If you want to recursively expand the relationships in the response schema
+  # then set this option to true, otherwise set it to false (default).
+  #
+  # config.infer_expand_nested_from_expand = true
+
   # If you want to get the list of attributes from the jsonapi-rails gem's
   # JSONAPI::Serializable::Resource class, set this option to true.
   # It uses the attribute_blocks method to get the list of attributes.

data/sig/schemable/configuration.rbs

@@ -8,6 +8,7 @@ module Schemable
     attr_accessor custom_defined_enum_method: Symbol?
     attr_accessor enum_prefix_for_simple_enum: String?
     attr_accessor enum_suffix_for_simple_enum: String?
+    attr_accessor infer_expand_nested_from_expand: bool
     attr_accessor custom_type_mappers: Hash[Symbol, any]
     attr_accessor infer_attributes_from_custom_method: Symbol?
     attr_accessor custom_meta_response_schema: Hash[Symbol, any]?

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]

data/sig/schemable/response_schema_generator.rbs

@@ -8,6 +8,6 @@ module Schemable
     def initialize: (Definition) -> void
     def meta: -> Hash[Symbol, any]
     def jsonapi: -> Hash[Symbol, any]
-    def generate: (expand: bool, relationships_to_exclude_from_expansion: Array[Symbol], collection: bool) -> Hash[Symbol, any]
+    def generate: (expand: bool, relationships_to_exclude_from_expansion: Array[Symbol], collection: bool, expand_nested: bool) -> Hash[Symbol, any]
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: schemable
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.3
 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