blueprinter_schema 1.4.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 820f85b8d22780549e1913cd8fa26f219c425c14746296b466b7966efc58bb2b
-  data.tar.gz: c013ef3d11fe9c214a21e0400ba2f0c66aa2ca2be0fb62e9feafe0fed0b55e46
+  metadata.gz: 9cfb85c67fa7ef32587a53be7c9a0af7fac5d7073355c104ad4e5463949ba846
+  data.tar.gz: 07161f373f93501eb0a053800549ebc39ce7012d58706fd2fcd6d998b69f3b5e
 SHA512:
-  metadata.gz: 6075da5a95d77f0f0c2142f7d1a9f94e067c863f4f1aa6c042945e5793367633147005824bbd12fff807e10568c653ebd734cebcb9b67d261710178053f61410
-  data.tar.gz: 7b89616467a6d82202bc2b105f4e948392a4c1fd841c56a6dcb4c66130897ad49d94b2140362576297ca59d615cb37b1eaf2f340eabf01b2702a05790f3808a2
+  metadata.gz: 3378f86662ed59bfa7b929d618b42e6507c61b10520797b738e0f1a8b79488b815d26f0ba64f5a3cdc7ede9071c03a00f93e3d2d56588c47cee457d5b9446486
+  data.tar.gz: c36d3d50ccc702382c2bdc55b77b30c53e048e340384b0d75119ec8bc2ab097d940a475809355a7107fe59389b47b35c18900813586891d403544a709bd6318b

data/README.md

@@ -177,6 +177,44 @@ BlueprinterSchema.generate(
 )
 ```
 
+### Active Model Support
+
+```rb
+class Restrictions
+  include ActiveModel::Model
+  include ActiveModel::Attributes
+
+  attribute :min_units, :integer
+  attribute :max_units, :integer
+
+  validates :min_units, presence: true
+end
+
+class RestrictionsSerializer < Blueprinter::Base
+  field :min_units
+  field :max_units
+end
+
+BlueprinterSchema.generate(serializer: RestrictionsSerializer, model: Restrictions)
+```
+
+```rb
+{
+  "type" => "object",
+  "title" => "Restrictions",
+  "properties" => {
+    "min_units" => {
+      "type" => "integer"
+    },
+    "max_units" => {
+      "type" => ["integer", "null"]
+    }
+  },
+  "required" => ["max_units", "min_units"],
+  "additionalProperties" => false
+}
+```
+
 ## Development
 
 Devcontainer / Codespaces / Native

data/lib/blueprinter_schema/generator.rb

@@ -81,13 +81,20 @@ 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)
+      type_to_json_schema(model_attributes.type(name), model_attributes.nullable?(name))
+    end
+
+    def model_attributes
+      @model_attributes ||= ModelAttributes.new(@model)
+    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]
@@ -108,22 +115,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/model_attributes.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module BlueprinterSchema
+  # Resolves an attribute's type and nullability from a model.
+  #
+  # ActiveRecord models (responding to +columns_hash+) infer both the type and
+  # nullability from the column. ActiveModel objects (responding to
+  # +type_for_attribute+) infer the type from the attribute; nullability is
+  # inferred from presence validations when available, otherwise assumed nullable.
+  class ModelAttributes
+    def initialize(model)
+      @model = model
+    end
+
+    def type(name)
+      if active_record?
+        @model.columns_hash[name]&.type
+      elsif active_model?
+        @model.type_for_attribute(name)&.type
+      end
+    end
+
+    def nullable?(name)
+      if active_record?
+        column = @model.columns_hash[name]
+        column ? column.null : false
+      elsif active_model?
+        active_model_nullable?(name)
+      else
+        false
+      end
+    end
+
+    private
+
+    def active_record?
+      @model.respond_to?(:columns_hash)
+    end
+
+    def active_model?
+      @model.respond_to?(:type_for_attribute)
+    end
+
+    def active_model_nullable?(name)
+      return true unless @model.respond_to?(:validators_on)
+
+      !presence_validated?(name)
+    end
+
+    def presence_validated?(name)
+      @model.validators_on(name).any? { |validator| validator.kind == :presence }
+    end
+  end
+end

data/lib/blueprinter_schema/version.rb

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

data/lib/blueprinter_schema.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative 'blueprinter_schema/version'
+require_relative 'blueprinter_schema/model_attributes'
 require_relative 'blueprinter_schema/generator'
 
 module BlueprinterSchema

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blueprinter_schema
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.6.0
 platform: ruby
 authors:
 - thisismydesign
@@ -27,6 +27,7 @@ files:
 - compose.yml
 - lib/blueprinter_schema.rb
 - lib/blueprinter_schema/generator.rb
+- lib/blueprinter_schema/model_attributes.rb
 - lib/blueprinter_schema/version.rb
 - sig/blueprinter_schema.rbs
 homepage: https://github.com/thisismydesign/blueprinter_schema