blueprinter_schema 1.3.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0cafd732029c0e4f3cd09d13dd6809e3e68f599c194a24247774e7d18f6233ca
-  data.tar.gz: 1bf4791a3812e9f16bd3c8d7f8ed0bc2a91095130b91286fa75d3b72954b1482
+  metadata.gz: 392b3344dd71f597ca8c1bfc35e1e3e47c7d01417ba38cd5bf170d6f7e63f1cc
+  data.tar.gz: 7aadb18ef24453084f6f23fcb3b0e681c13b7d82b5e12c2d56572e3365f13e3f
 SHA512:
-  metadata.gz: 02577f5a4da542def621be3544ff1c82d4509addfc2b8b7a1264a9a6e7d079943ae75c0574f160354f48ebf3c6b1481eeb09d899a35fb3ed83b169e25671a482
-  data.tar.gz: 6690022f62b1a2ad817a362ae2322300e0013c22494b1bb2efe195478c0a6036063c3c31ae422ab92b1745591cacdf4d6aba0356e386df32d1419f28c8ecb717
+  metadata.gz: 96b8ebe6804c446804b240e1962f223e9130990144421217139e019c1db8e12a891100b1cdb37423e67bc27afd38eb85e1106103a02439032a527511f701d2f0
+  data.tar.gz: 0e244fdb17fac6bb6d1ac367f77d97511d5736625850f2a55189dd3da58cceb114dd485b8d7a8f25eab79fd4c79b85339e0128334681cc1100fb07124febe3c7

data/README.md

@@ -159,7 +159,7 @@ BlueprinterSchema.generate(serializer: UserSerializer)
       "additionalProperties" => false
     }
   },
-  "required" => ["email", "addresses", "profile"],
+  "required" => ["email", "addresses", "profile", "account"],
   "additionalProperties" => false
 }
 ```
@@ -177,6 +177,49 @@ BlueprinterSchema.generate(
 )
 ```
 
+### Active Model Support
+
+```rb
+class Restrictions
+  include ActiveModel::Model
+  include ActiveModel::Attributes
+
+  attribute :min_units, :integer
+  attribute :max_units, :integer
+  attribute :label, :string
+end
+
+class RestrictionsSerializer < Blueprinter::Base
+  field :min_units
+  field :max_units
+  field :label, type: [:string, :null]
+end
+
+BlueprinterSchema.generate(serializer: RestrictionsSerializer, model: Restrictions)
+```
+
+```rb
+{
+  "type" => "object",
+  "title" => "Restrictions",
+  "properties" => {
+    "min_units" => {
+      "type" => "integer"
+    },
+    "max_units" => {
+      "type" => "integer"
+    },
+    "label" => {
+      "type" => ["string", "null"]
+    }
+  },
+  "required" => ["max_units", "min_units", "label"],
+  "additionalProperties" => false
+}
+```
+
+Note: Attributes are assumed to be non-null. If an attribute is nullable, specify it explicitly in the serializer.
+
 ## Development
 
 Devcontainer / Codespaces / Native

data/lib/blueprinter_schema/generator.rb

@@ -58,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)
@@ -70,13 +81,23 @@ module BlueprinterSchema
       if field.options[:type]
         type_definition['type'] = ensure_valid_json_schema_types!(field)
       elsif @model
-        column = @model.columns_hash[field.name.to_s]
-        type_definition = ar_column_to_json_schema(column)
+        type_definition = model_attribute_to_json_schema(field.name.to_s)
       end
 
       merge_field_options(type_definition, field.options)
     end
 
+    def model_attribute_to_json_schema(name)
+      if @model.respond_to?(:columns_hash)
+        column = @model.columns_hash[name]
+        type_to_json_schema(column&.type, column&.null)
+      elsif @model.respond_to?(:type_for_attribute)
+        type_to_json_schema(@model.type_for_attribute(name)&.type, false)
+      else
+        @fallback_definition.dup
+      end
+    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]
@@ -97,22 +118,24 @@ module BlueprinterSchema
 
     # rubocop:disable Metrics/MethodLength
     # rubocop:disable Metrics/CyclomaticComplexity
-    def ar_column_to_json_schema(column)
-      case column&.type
+    def type_to_json_schema(type, null)
+      case type
       when :string, :text
-        build_json_schema_type('string', column.null)
+        build_json_schema_type('string', null)
       when :integer
-        build_json_schema_type('integer', column.null)
+        build_json_schema_type('integer', null)
       when :float, :decimal
-        build_json_schema_type('number', column.null)
+        build_json_schema_type('number', null)
       when :boolean
-        build_json_schema_type('boolean', column.null)
+        build_json_schema_type('boolean', null)
       when :date
-        build_json_schema_type('string', column.null, 'date')
+        build_json_schema_type('string', null, 'date')
       when :datetime, :timestamp
-        build_json_schema_type('string', column.null, 'date-time')
+        build_json_schema_type('string', null, 'date-time')
       when :uuid
-        build_json_schema_type('string', column.null, 'uuid')
+        build_json_schema_type('string', null, 'uuid')
+      else
+        @fallback_definition.dup
       end
     end
     # rubocop:enable Metrics/MethodLength

data/lib/blueprinter_schema/version.rb

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

metadata

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