blueprinter_schema 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64488524dcc942abdab6c3f96841d1619dc40abade8d3006c73c55ef035c29e1
-  data.tar.gz: 7a49a1189f126209721e032e5e752f1fbd7e15a4c5c0f442293627d6525afa2c
+  metadata.gz: 03c37dc53060c99e65e98088279e4e635bcedd8b495c9c9d4b31c624c7b56488
+  data.tar.gz: 5c82b98494016b536ed9e9f360353834c5daaf28e692a4a16fa8c5e466924733
 SHA512:
-  metadata.gz: '0654209ac2820114fb2807295a690787fee47b41671ddfc9ff4740939f59ef84bcb05b92d3277e553a44d99652b32d318371e00eedcd9995c9be265d49ddbb60'
-  data.tar.gz: bc4c26c5039d90cb5950f697cc7b242092fc92d194dc16cbfe3d075292b240bf439573645920f1b462591c5ad5f4661adc407965ebac9f181d6ea4fb838c7b2f
+  metadata.gz: a118085debb64d40d46aae65e8c88ddc69c0e55e49949e580966618ea14b7573a05c02a0df47aa8cac4c09bb2872b50c002e7828b275954a045728fa56115d6e
+  data.tar.gz: b05ee47b64997f7dbc0d16b0f8bf440e76e61d810d82b79ff3295d46f07c051b8048076db67983fd8df940e78f69b30e5504a2e646590f429993dc97ef1be5dd

data/README.md

@@ -91,7 +91,8 @@ BlueprinterSchema.generate(
   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' }
+    fallback_type: {}, # Type when no DB column is found or type is unknown. E.g. { 'type' => 'object' }
+    view: :default # The Blueprint view to use
   }
 )
 ```

data/lib/blueprinter_schema/generator.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+module BlueprinterSchema
+  class Generator
+    def initialize(serializer, model, options)
+      @serializer = serializer
+      @model = model
+      @options = options
+    end
+
+    def generate
+      {
+        'type' => 'object',
+        'title' => @model.name,
+        'properties' => build_properties,
+        'required' => build_required_fields,
+        'additionalProperties' => false
+      }
+    end
+
+    private
+
+    def fields
+      @fields ||= @serializer.reflections[@options[:view]].fields
+    end
+
+    def associations
+      @associations ||= @serializer.reflections[@options[:view]].associations
+    end
+
+    def build_properties
+      properties = {}
+
+      fields.each_value do |field|
+        next if skip_field?(field)
+
+        properties[field.display_name.to_s] = field_to_json_schema(field)
+      end
+
+      associations.each_value do |association|
+        properties[association.display_name.to_s] = association_to_json_schema(association)
+      end
+
+      properties
+    end
+
+    def skip_field?(field)
+      !@options[:include_conditional_fields] &&
+        (field.options[:if] || field.options[:unless] || field.options[:exclude_if_nil])
+    end
+
+    def build_required_fields
+      fields.reject { |_, field| skip_field?(field) }.keys.map(&:to_s)
+    end
+
+    def field_to_json_schema(field)
+      column = @model.columns_hash[field.name.to_s]
+
+      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
+      when :string, :text
+        build_json_schema_type('string', column.null)
+      when :integer
+        build_json_schema_type('integer', column.null)
+      when :float, :decimal
+        build_json_schema_type('number', column.null)
+      when :boolean
+        build_json_schema_type('boolean', column.null)
+      when :date
+        build_json_schema_type('string', column.null, 'date')
+      when :datetime, :timestamp
+        build_json_schema_type('string', column.null, 'date-time')
+      when :uuid
+        build_json_schema_type('string', column.null, 'uuid')
+      end
+    end
+    # rubocop:enable Metrics/MethodLength
+    # rubocop:enable Metrics/CyclomaticComplexity
+
+    def build_json_schema_type(json_schema_type, nullable, format = nil)
+      type = { 'type' => nullable ? [json_schema_type, 'null'] : json_schema_type }
+      type['format'] = format if format
+      type
+    end
+
+    def association_to_json_schema(association)
+      blueprint_class = association.options[:blueprint]
+
+      return { 'type' => 'object' } unless blueprint_class
+
+      ar_association = @model.reflect_on_association(association.name)
+      is_collection = ar_association.collection?
+      association_model = ar_association.klass
+
+      associated_schema = BlueprinterSchema.generate(blueprint_class, association_model)
+
+      is_collection ? { 'type' => 'array', 'items' => associated_schema } : associated_schema
+    end
+  end
+end

data/lib/blueprinter_schema/version.rb

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

data/lib/blueprinter_schema.rb

@@ -1,96 +1,10 @@
 # frozen_string_literal: true
 
 require_relative 'blueprinter_schema/version'
+require_relative 'blueprinter_schema/generator'
 
 module BlueprinterSchema
-  class << self
-    def generate(serializer, model, options = { include_conditional_fields: true, fallback_type: {} })
-      views = serializer.reflections
-      fields = views[:default].fields
-      associations = views[:default].associations
-
-      {
-        'type' => 'object',
-        'title' => model.name,
-        'properties' => build_properties(fields, associations, model, options),
-        'required' => build_required_fields(fields, options),
-        'additionalProperties' => false
-      }
-    end
-
-    private
-
-    def build_properties(fields, associations, model, options)
-      properties = {}
-
-      fields.each_value do |field|
-        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|
-        properties[association.display_name.to_s] = association_to_json_schema(association, model)
-      end
-
-      properties
-    end
-
-    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, options)
-      column = model.columns_hash[field.name.to_s]
-
-      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
-      when :string, :text
-        build_json_schema_type('string', column.null)
-      when :integer
-        build_json_schema_type('integer', column.null)
-      when :float, :decimal
-        build_json_schema_type('number', column.null)
-      when :boolean
-        build_json_schema_type('boolean', column.null)
-      when :date
-        build_json_schema_type('string', column.null, 'date')
-      when :datetime, :timestamp
-        build_json_schema_type('string', column.null, 'date-time')
-      when :uuid
-        build_json_schema_type('string', column.null, 'uuid')
-      end
-    end
-    # rubocop:enable Metrics/MethodLength
-    # rubocop:enable Metrics/CyclomaticComplexity
-
-    def build_json_schema_type(json_schema_type, nullable, format = nil)
-      type = { 'type' => nullable ? [json_schema_type, 'null'] : json_schema_type }
-      type['format'] = format if format
-      type
-    end
-
-    def association_to_json_schema(association, model)
-      blueprint_class = association.options[:blueprint]
-
-      return { 'type' => 'object' } unless blueprint_class
-
-      ar_association = model.reflect_on_association(association.name)
-      is_collection = ar_association.collection?
-      association_model = ar_association.klass
-
-      associated_schema = generate(blueprint_class, association_model)
-
-      is_collection ? { 'type' => 'array', 'items' => associated_schema } : associated_schema
-    end
+  def self.generate(serializer, model, options = { include_conditional_fields: true, fallback_type: {}, view: :default })
+    Generator.new(serializer, model, options).generate
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blueprinter_schema
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - thisismydesign
@@ -25,6 +25,7 @@ files:
 - Rakefile
 - docker-compose.yml
 - lib/blueprinter_schema.rb
+- lib/blueprinter_schema/generator.rb
 - lib/blueprinter_schema/version.rb
 - sig/blueprinter_schema.rbs
 homepage: https://github.com/thisismydesign/blueprinter_schema