blueprinter_schema 1.6.1 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b4bead8620839a075c510b0f243d4e8c3d8ee38a3f5025e493bf0c3f59d01519
-  data.tar.gz: 6ee11ed05b4b0337af6e4276e02cee4ce546eb47f7de4d36ff024c6af229b356
+  metadata.gz: 51982caa98d5ae3d364c33024d21cd2acbe0a9350ffc9696ef3ff42ba0177427
+  data.tar.gz: 671bab5263c4c03a5ece305359a457da839b1363b547679de678159938a87bc4
 SHA512:
-  metadata.gz: 807bc1360008eb60eaf2df3c55f1287dc90d11fc2d6bc71f4abe68153ab678fd267b14382b581adfbbd5e728f262183a6434901c50d4086de8f4b815248a558b
-  data.tar.gz: e18240976adffd74caff957b4be334c72acd88e0286f03fd20ff60f118b5e1e0e6a94be6dedc689216fa761f1a588e33c359eaa1ff3fd680a305aacf65fc0e35
+  metadata.gz: b7dc67b5ebbf4e3b6aca4d8ece274d96f66cda67caff677fbfa4352de73a3374c6485f2cf0a8ad48d879b46f43e92151ccf6ae6b836d72f90c3d4c6a18bf0a59
+  data.tar.gz: dc3b0317a497218a9d4047031426e7c89714a9d55d15c195c490a843e4fe16c22b4af17455477f28939b184cad32b8fb9a4a9756168481061e25da644ed68668

data/README.md

@@ -20,6 +20,7 @@ class UserSerializer < Blueprinter::Base
   field :email, type: :string, format: :email
   field :role, type: :string, enum: ["user", "admin"]
   field :tags, type: :array, items: { type: :string }
+  field :legacy_name, type: :string, deprecated: true
 end
 
 BlueprinterSchema.generate(serializer: UserSerializer)
@@ -50,9 +51,13 @@ BlueprinterSchema.generate(serializer: UserSerializer)
     "tags" => {
       "type" => "array",
       "items" => { "type" => "string" }
+    },
+    "legacy_name" => {
+      "type" => "string",
+      "deprecated" => true
     }
   },
-  "required" => ["first_name", "last_name", "full_name", "email", "role", "tags"],
+  "required" => ["first_name", "last_name", "full_name", "email", "role", "tags", "legacy_name"],
   "additionalProperties" => false
 }
 ```
@@ -195,22 +200,46 @@ class RestrictionsSerializer < Blueprinter::Base
   field :max_units
 end
 
-BlueprinterSchema.generate(serializer: RestrictionsSerializer, model: Restrictions)
+class Product
+  include ActiveModel::Model
+  include ActiveModel::Attributes
+
+  attribute :reference, :string
+  attribute :restrictions
+end
+
+class ProductSerializer < Blueprinter::Base
+  field :reference
+  association :restrictions, blueprint: RestrictionsSerializer, model: Restrictions
+end
+
+BlueprinterSchema.generate(serializer: ProductSerializer, model: Product)
 ```
 
 ```rb
 {
   "type" => "object",
-  "title" => "Restrictions",
+  "title" => "Product",
   "properties" => {
-    "min_units" => {
-      "type" => "integer"
+    "reference" => {
+      "type" => ["string", "null"]
     },
-    "max_units" => {
-      "type" => ["integer", "null"]
+    "restrictions" => {
+      "type" => "object",
+      "title" => "Restrictions",
+      "properties" => {
+        "min_units" => {
+          "type" => "integer"
+        },
+        "max_units" => {
+          "type" => ["integer", "null"]
+        }
+      },
+      "required" => ["max_units", "min_units"],
+      "additionalProperties" => false
     }
   },
-  "required" => ["max_units", "min_units"],
+  "required" => ["reference", "restrictions"],
   "additionalProperties" => false
 }
 ```

data/lib/blueprinter_schema/generator.rb

@@ -100,6 +100,7 @@ module BlueprinterSchema
       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['deprecated'] = true if options[:deprecated]
       type_definition
     end
 
@@ -150,13 +151,24 @@ module BlueprinterSchema
       return { 'type' => 'object' } unless blueprint_class
 
       ar_association = @model.try(:reflect_on_association, association.name)
-      is_collection = ar_association ? ar_association.collection? : association.options[:collection]
-
       view = association.options[:view] || :default
       type = association.options[:optional] ? %w[object null] : 'object'
-      associated_schema = recursive_generate(blueprint_class, ar_association&.klass, view, type:)
+      model = association_model(association, ar_association)
+      associated_schema = recursive_generate(blueprint_class, model, view, type:)
+
+      wrap_collection(associated_schema, association_collection?(association, ar_association))
+    end
+
+    def association_model(association, ar_association)
+      ar_association&.klass || association.options[:model]
+    end
+
+    def association_collection?(association, ar_association)
+      ar_association ? ar_association.collection? : association.options[:collection]
+    end
 
-      is_collection ? { 'type' => 'array', 'items' => associated_schema } : associated_schema
+    def wrap_collection(schema, is_collection)
+      is_collection ? { 'type' => 'array', 'items' => schema } : schema
     end
 
     def recursive_generate(serializer, model, view, type:)

data/lib/blueprinter_schema/version.rb

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

metadata

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