blueprinter_schema 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 79f76768380ae6cbe77da6ec153325e079ca2d5ee30df459378e0ebb90f674c2
-  data.tar.gz: 50a119f7dd0fb32789a24ed6ccddd05026a0bb8525f4c5c60f94f232edcc3e31
+  metadata.gz: c3dd0981a3be1b7ee216a5b81d3ea24069cb937e291e2c2c7bb590d98db2e698
+  data.tar.gz: 00211a94280dd1dfd0f4cb5a93ef56d1ae77fc17e312cf7c5c11799a7fe4fc74
 SHA512:
-  metadata.gz: f057fdac75f35be16f955cbc083326ab32940ed5210ec8ed26922b4614741e0371e0e762371081d7afdf31dbee97d7fc14794650bde811ef636f3de64a2cb52f
-  data.tar.gz: e82e0011242c7838709c55c2d4d6ca8d2a43e620a6ff7c244c9fc70b816e6dd7c211a995ebea6fd57390744c0523d2b467168e9fc52e8bdec02ecebb10888811
+  metadata.gz: 16674fa11cdd54d134cdf32b2366e5c4be600fc0c455d2fa6f30ca2bb9c80daf6ea4e6008ab92ad6ae0fe29308da3aff739ff052bdeb6e1679d0604f5cc7cc69
+  data.tar.gz: fbe7899df7288fc0520f8103ec846439fd1cecf04ee36dd3387923cfd59879eee63c5c2bfec8e6cca4db313393829e369df5311adf0c5f2608cbcd39c8dee444

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
 }
 ```

data/lib/blueprinter_schema/generator.rb

@@ -63,7 +63,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 +73,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)

data/lib/blueprinter_schema/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blueprinter_schema
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - thisismydesign
@@ -19,6 +19,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".tool-versions"
+- AGENTS.md
 - Dockerfile
 - LICENSE.txt
 - README.md