blueprinter_schema 0.3.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc07f2ba27532688748d728cfdb6ee4ae6d0c92a66b17d753519384ee8538f5b
-  data.tar.gz: 2add634f63f55305245acb2fb7d64438f7017d8ce6bdce9bb7626f59f186b66a
+  metadata.gz: 64488524dcc942abdab6c3f96841d1619dc40abade8d3006c73c55ef035c29e1
+  data.tar.gz: 7a49a1189f126209721e032e5e752f1fbd7e15a4c5c0f442293627d6525afa2c
 SHA512:
-  metadata.gz: 592881730764b7873f8ae95bc4de43942f3f8345c37327157b528b9b740706544c206b1ea84b3c41d430d8e6f389cd6699cf0a535797c07e4f2e82aa06c8aa33
-  data.tar.gz: 88163ad100fa9e310cb42c8b1dc9240b3aa09831b048e6215ddc6636cfea57ade49d452290ca01cd91a13f001e902fe8291ff17d8da63ad85a32d1abe470e7c4
+  metadata.gz: '0654209ac2820114fb2807295a690787fee47b41671ddfc9ff4740939f59ef84bcb05b92d3277e553a44d99652b32d318371e00eedcd9995c9be265d49ddbb60'
+  data.tar.gz: bc4c26c5039d90cb5950f697cc7b242092fc92d194dc16cbfe3d075292b240bf439573645920f1b462591c5ad5f4661adc407965ebac9f181d6ea4fb838c7b2f

data/README.md

@@ -1,6 +1,8 @@
 # BlueprinterSchema
 
-### Create JSON Schema from Blueprinter Serializers and ActiveRecord Models.
+### Create JSON Schema from [Blueprinter](https://github.com/procore-oss/blueprinter) Serializers and ActiveRecord Models.
+
+Serializers define which fields are used. Models know the database field types. Put these together and you get a JSON Schema.
 
 ## Installation
 
@@ -81,6 +83,19 @@ BlueprinterSchema.generate(UserSerializer, User)
 }
 ```
 
+### Options and defaults
+
+```rb
+BlueprinterSchema.generate(
+  serializer,
+  model,
+  {
+    include_conditional_fields: true, # Whether or not to include conditional fields from the serializer
+    fallback_type: {} # Type when no DB column is found or type is unknown. E.g. { 'type' => 'object' }
+  }
+)
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/blueprinter_schema/version.rb

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

data/lib/blueprinter_schema.rb

@@ -4,7 +4,7 @@ require_relative 'blueprinter_schema/version'
 
 module BlueprinterSchema
   class << self
-    def generate(serializer, model)
+    def generate(serializer, model, options = { include_conditional_fields: true, fallback_type: {} })
       views = serializer.reflections
       fields = views[:default].fields
       associations = views[:default].associations
@@ -12,19 +12,21 @@ module BlueprinterSchema
       {
         'type' => 'object',
         'title' => model.name,
-        'properties' => build_properties(fields, associations, model),
-        'required' => build_required_fields(fields),
+        'properties' => build_properties(fields, associations, model, options),
+        'required' => build_required_fields(fields, options),
         'additionalProperties' => false
       }
     end
 
     private
 
-    def build_properties(fields, associations, model)
+    def build_properties(fields, associations, model, options)
       properties = {}
 
       fields.each_value do |field|
-        properties[field.display_name.to_s] = field_to_json_schema(field, model)
+        next if skip_field?(field, options)
+
+        properties[field.display_name.to_s] = field_to_json_schema(field, model, options)
       end
 
       associations.each_value do |association|
@@ -34,25 +36,24 @@ module BlueprinterSchema
       properties
     end
 
-    def build_required_fields(fields)
-      fields.keys.map(&:to_s)
+    def skip_field?(field, options)
+      !options[:include_conditional_fields] && (field.options[:if] || field.options[:unless])
+    end
+
+    def build_required_fields(fields, options)
+      fields.reject { |_, field| skip_field?(field, options) }.keys.map(&:to_s)
     end
 
-    def field_to_json_schema(field, model)
+    def field_to_json_schema(field, model, options)
       column = model.columns_hash[field.name.to_s]
 
-      if column
-        ar_column_to_json_schema(column)
-      else
-        # Non-database (e.g. computed) field, we don't know the schema type
-        {}
-      end
+      ar_column_to_json_schema(column) || options[:fallback_type]
     end
 
     # rubocop:disable Metrics/MethodLength
     # rubocop:disable Metrics/CyclomaticComplexity
     def ar_column_to_json_schema(column)
-      case column.type
+      case column&.type
       when :string, :text
         build_json_schema_type('string', column.null)
       when :integer
@@ -67,9 +68,6 @@ module BlueprinterSchema
         build_json_schema_type('string', column.null, 'date-time')
       when :uuid
         build_json_schema_type('string', column.null, 'uuid')
-      else
-        # Unknown column type, we don't know the schema type
-        {}
       end
     end
     # rubocop:enable Metrics/MethodLength

metadata

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