blueprinter_schema 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc07f2ba27532688748d728cfdb6ee4ae6d0c92a66b17d753519384ee8538f5b
-  data.tar.gz: 2add634f63f55305245acb2fb7d64438f7017d8ce6bdce9bb7626f59f186b66a
+  metadata.gz: 850dc505e2b9f65b160a2521a93c42147a68b0feaf41ff15b8c238c29c3dbccb
+  data.tar.gz: 4c8d1b9baa93c8d937a597ecd37deb2101753063c8509efa618fbd39a06ef41e
 SHA512:
-  metadata.gz: 592881730764b7873f8ae95bc4de43942f3f8345c37327157b528b9b740706544c206b1ea84b3c41d430d8e6f389cd6699cf0a535797c07e4f2e82aa06c8aa33
-  data.tar.gz: 88163ad100fa9e310cb42c8b1dc9240b3aa09831b048e6215ddc6636cfea57ade49d452290ca01cd91a13f001e902fe8291ff17d8da63ad85a32d1abe470e7c4
+  metadata.gz: cc611517dfab3eda9215428780ed18b68b83d75a706421681181fea05f4a2b50d93c5ca080e39471400767df618b09724b1296507b03ad4310e5f572cc060ec7
+  data.tar.gz: 993043647ef3b2efdf803f97e97057512b2d60296d952b39cb2289fce6dda042899cf1bc1e0d35872010e1bf4316e16ff382515a022444d045189be03a50b176

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.0'
 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,7 +12,7 @@ module BlueprinterSchema
       {
         'type' => 'object',
         'title' => model.name,
-        'properties' => build_properties(fields, associations, model),
+        'properties' => build_properties(fields, associations, model, options),
         'required' => build_required_fields(fields),
         'additionalProperties' => false
       }
@@ -20,11 +20,13 @@ module BlueprinterSchema
 
     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 skip_field?(field, options)
+      !options[:include_conditional_fields] && (field.options[:if] || field.options[:unless])
+    end
+
     def build_required_fields(fields)
       fields.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.0
 platform: ruby
 authors:
 - thisismydesign