blueprinter_schema 1.2.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c3dd0981a3be1b7ee216a5b81d3ea24069cb937e291e2c2c7bb590d98db2e698
-  data.tar.gz: 00211a94280dd1dfd0f4cb5a93ef56d1ae77fc17e312cf7c5c11799a7fe4fc74
+  metadata.gz: 820f85b8d22780549e1913cd8fa26f219c425c14746296b466b7966efc58bb2b
+  data.tar.gz: c013ef3d11fe9c214a21e0400ba2f0c66aa2ca2be0fb62e9feafe0fed0b55e46
 SHA512:
-  metadata.gz: 16674fa11cdd54d134cdf32b2366e5c4be600fc0c455d2fa6f30ca2bb9c80daf6ea4e6008ab92ad6ae0fe29308da3aff739ff052bdeb6e1679d0604f5cc7cc69
-  data.tar.gz: fbe7899df7288fc0520f8103ec846439fd1cecf04ee36dd3387923cfd59879eee63c5c2bfec8e6cca4db313393829e369df5311adf0c5f2608cbcd39c8dee444
+  metadata.gz: 6075da5a95d77f0f0c2142f7d1a9f94e067c863f4f1aa6c042945e5793367633147005824bbd12fff807e10568c653ebd734cebcb9b67d261710178053f61410
+  data.tar.gz: 7b89616467a6d82202bc2b105f4e948392a4c1fd841c56a6dcb4c66130897ad49d94b2140362576297ca59d615cb37b1eaf2f340eabf01b2702a05790f3808a2

data/README.md

@@ -100,6 +100,7 @@ class UserSerializer < Blueprinter::Base
 
   association :addresses, blueprint: AddressSerializer, collection: true
   association :profile, blueprint: ProfileSerializer
+  association :account, blueprint: AccountSerializer, optional: true
 end
 
 class AddressSerializer < Blueprinter::Base
@@ -110,6 +111,10 @@ class ProfileSerializer < Blueprinter::Base
   field :public, type: :boolean
 end
 
+class AccountSerializer < Blueprinter::Base
+  field :name, type: :string
+end
+
 BlueprinterSchema.generate(serializer: UserSerializer)
 ```
 
@@ -142,9 +147,19 @@ BlueprinterSchema.generate(serializer: UserSerializer)
       },
       "required" => ["public"],
       "additionalProperties" => false
+    },
+    "account" => {
+      "type" => ["object", "null"],
+      "properties" => {
+        "name" => {
+          "type" => "string"
+        }
+      },
+      "required" => ["name"],
+      "additionalProperties" => false
     }
   },
-  "required" => ["email", "addresses", "profile"],
+  "required" => ["email", "addresses", "profile", "account"],
   "additionalProperties" => false
 }
 ```
@@ -156,8 +171,9 @@ BlueprinterSchema.generate(
   serializer:,
   model: nil,
   include_conditional_fields: true, # Whether or not to include conditional fields from the serializer
-  fallback_type: {}, # Type when no DB column or type definition is found. E.g. { 'type' => 'object' }
-  view: :default # The blueprint view to use
+  fallback_definition: {}, # Type when no DB column or type definition is found. E.g. { 'type' => 'object' }
+  view: :default, # The blueprint view to use
+  type: "object" # Root type
 )
 ```
 

data/lib/blueprinter_schema/generator.rb

@@ -5,17 +5,18 @@ module BlueprinterSchema
 
   # rubocop:disable Metrics/ClassLength
   class Generator
-    def initialize(serializer:, model:, skip_conditional_fields:, fallback_definition:, view:)
+    def initialize(serializer:, model:, skip_conditional_fields:, fallback_definition:, view:, type:) # rubocop:disable Metrics/ParameterLists
       @serializer = serializer
       @model = model
       @skip_conditional_fields = skip_conditional_fields
       @fallback_definition = fallback_definition
       @view = view
+      @type = type
     end
 
     def generate
       schema = {
-        'type' => 'object',
+        'type' => @type,
         'properties' => build_properties,
         'required' => build_required_fields,
         'additionalProperties' => false
@@ -57,10 +58,21 @@ module BlueprinterSchema
     end
 
     def build_required_fields
+      (required_field_names + required_association_names).map(&:to_s)
+    end
+
+    def required_field_names
       fields
         .reject { |_, field| field.options[:exclude_if_nil] }
         .reject { |_, field| skip_field?(field) }
-        .keys.map(&:to_s)
+        .keys
+    end
+
+    def required_association_names
+      associations
+        .reject { |_, association| association.options[:exclude_if_nil] }
+        .reject { |_, association| skip_field?(association) }
+        .keys
     end
 
     def field_to_json_schema(field)
@@ -123,7 +135,7 @@ module BlueprinterSchema
       type
     end
 
-    def association_to_json_schema(association)
+    def association_to_json_schema(association) # rubocop:disable Metrics/CyclomaticComplexity
       blueprint_class = association.options[:blueprint]
 
       return { 'type' => 'object' } unless blueprint_class
@@ -132,18 +144,20 @@ module BlueprinterSchema
       is_collection = ar_association ? ar_association.collection? : association.options[:collection]
 
       view = association.options[:view] || :default
-      associated_schema = recursive_generate(blueprint_class, ar_association&.klass, view)
+      type = association.options[:optional] ? %w[object null] : 'object'
+      associated_schema = recursive_generate(blueprint_class, ar_association&.klass, view, type:)
 
       is_collection ? { 'type' => 'array', 'items' => associated_schema } : associated_schema
     end
 
-    def recursive_generate(serializer, model, view)
+    def recursive_generate(serializer, model, view, type:)
       BlueprinterSchema.generate(
         serializer:,
         model:,
         skip_conditional_fields: @skip_conditional_fields,
         fallback_definition: @fallback_definition,
-        view:
+        view:,
+        type:
       )
     end
   end

data/lib/blueprinter_schema/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BlueprinterSchema
-  VERSION = '1.2.0'
+  VERSION = '1.4.0'
 end

data/lib/blueprinter_schema.rb

@@ -4,13 +4,14 @@ require_relative 'blueprinter_schema/version'
 require_relative 'blueprinter_schema/generator'
 
 module BlueprinterSchema
-  def self.generate(
+  def self.generate( # rubocop:disable Metrics/ParameterLists
     serializer:,
     model: nil,
     skip_conditional_fields: false,
     fallback_definition: {},
-    view: :default
+    view: :default,
+    type: 'object'
   )
-    Generator.new(serializer:, model:, skip_conditional_fields:, fallback_definition:, view:).generate
+    Generator.new(serializer:, model:, skip_conditional_fields:, fallback_definition:, view:, type:).generate
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blueprinter_schema
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.4.0
 platform: ruby
 authors:
 - thisismydesign