blueprinter_schema 1.1.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 79f76768380ae6cbe77da6ec153325e079ca2d5ee30df459378e0ebb90f674c2
-  data.tar.gz: 50a119f7dd0fb32789a24ed6ccddd05026a0bb8525f4c5c60f94f232edcc3e31
+  metadata.gz: 0cafd732029c0e4f3cd09d13dd6809e3e68f599c194a24247774e7d18f6233ca
+  data.tar.gz: 1bf4791a3812e9f16bd3c8d7f8ed0bc2a91095130b91286fa75d3b72954b1482
 SHA512:
-  metadata.gz: f057fdac75f35be16f955cbc083326ab32940ed5210ec8ed26922b4614741e0371e0e762371081d7afdf31dbee97d7fc14794650bde811ef636f3de64a2cb52f
-  data.tar.gz: e82e0011242c7838709c55c2d4d6ca8d2a43e620a6ff7c244c9fc70b816e6dd7c211a995ebea6fd57390744c0523d2b467168e9fc52e8bdec02ecebb10888811
+  metadata.gz: 02577f5a4da542def621be3544ff1c82d4509addfc2b8b7a1264a9a6e7d079943ae75c0574f160354f48ebf3c6b1481eeb09d899a35fb3ed83b169e25671a482
+  data.tar.gz: 6690022f62b1a2ad817a362ae2322300e0013c22494b1bb2efe195478c0a6036063c3c31ae422ab92b1745591cacdf4d6aba0356e386df32d1419f28c8ecb717

data/AGENTS.md

@@ -0,0 +1,23 @@
+# BlueprinterSchema
+
+A gem to create JSON Schemas from [Blueprinter](https://github.com/procore-oss/blueprinter) Serializers.
+
+## Instructions
+
+- Specs MUST assert the full expected schema, so that they serve as clear documentation of what is generated
+
+## Development Commands
+
+### Setup
+
+```sh
+mise install
+bin/setup
+```
+
+### Test, lint
+
+```sh
+bundle exec rspec
+bundle exec rubocop -A
+```

data/README.md

@@ -18,6 +18,8 @@ class UserSerializer < Blueprinter::Base
   field :last_name, type: [:string, :null]
   field :full_name, type: [:string, :null], description: "The concatendated first and last name."
   field :email, type: :string, format: :email
+  field :role, type: :string, enum: ["user", "admin"]
+  field :tags, type: :array, items: { type: :string }
 end
 
 BlueprinterSchema.generate(serializer: UserSerializer)
@@ -40,9 +42,17 @@ BlueprinterSchema.generate(serializer: UserSerializer)
     "email" => {
       "type" => "string",
       "format" => "email"
+    },
+    "role" => {
+      "type" => "string",
+      "enum" => ["user", "admin"]
+    },
+    "tags" => {
+      "type" => "array",
+      "items" => { "type" => "string" }
     }
   },
-  "required" => ["first_name", "last_name", "full_name", "email"],
+  "required" => ["first_name", "last_name", "full_name", "email", "role", "tags"],
   "additionalProperties" => false
 }
 ```
@@ -90,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
@@ -100,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)
 ```
 
@@ -132,6 +147,16 @@ BlueprinterSchema.generate(serializer: UserSerializer)
       },
       "required" => ["public"],
       "additionalProperties" => false
+    },
+    "account" => {
+      "type" => ["object", "null"],
+      "properties" => {
+        "name" => {
+          "type" => "string"
+        }
+      },
+      "required" => ["name"],
+      "additionalProperties" => false
     }
   },
   "required" => ["email", "addresses", "profile"],
@@ -146,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
@@ -63,7 +64,6 @@ module BlueprinterSchema
         .keys.map(&:to_s)
     end
 
-    # rubocop:disable Metrics/AbcSize
     def field_to_json_schema(field)
       type_definition = @fallback_definition.dup
 
@@ -74,12 +74,16 @@ module BlueprinterSchema
         type_definition = ar_column_to_json_schema(column)
       end
 
-      type_definition['items'] = field.options[:items].deep_stringify_keys if field.options[:items]
-      type_definition['format'] = field.options[:format] if field.options[:format]
-      type_definition['description'] = field.options[:description] if field.options[:description]
+      merge_field_options(type_definition, field.options)
+    end
+
+    def merge_field_options(type_definition, options)
+      type_definition['enum'] = options[:enum] if options[:enum]
+      type_definition['items'] = options[:items].deep_stringify_keys if options[:items]
+      type_definition['format'] = options[:format] if options[:format]
+      type_definition['description'] = options[:description] if options[:description]
       type_definition
     end
-    # rubocop:enable Metrics/AbcSize
 
     def ensure_valid_json_schema_types!(field)
       types = [field.options[:type]].flatten.map(&:to_s)
@@ -120,7 +124,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
@@ -129,18 +133,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.1.0'
+  VERSION = '1.3.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.1.0
+  version: 1.3.0
 platform: ruby
 authors:
 - thisismydesign
@@ -19,6 +19,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".tool-versions"
+- AGENTS.md
 - Dockerfile
 - LICENSE.txt
 - README.md