blueprinter_schema 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 69d6a80c2ce8e67eeaa8b45e3b1b0052b76752fc4f9f3d06692519983e521695
-  data.tar.gz: e968b4d65653a2ff5cba85bb8b8717709f7d855963ff1b124eb65f9858fbdc76
+  metadata.gz: bc07f2ba27532688748d728cfdb6ee4ae6d0c92a66b17d753519384ee8538f5b
+  data.tar.gz: 2add634f63f55305245acb2fb7d64438f7017d8ce6bdce9bb7626f59f186b66a
 SHA512:
-  metadata.gz: fd7f793f1df05e0e8fc536e246f1bcd172cdb17a7e0fc059315608c4fc4b0f2df09e52be59b6097ee6ce51eaccac8c317126594134ade72d512c3c01eb9af81c
-  data.tar.gz: 94a8ff84818b9ddf2e8c29080becaaf0a5211ab00e7d3007f94b087a71b19c65aea9f7c5aedef0443eae00b0729abe0270eb9ab41e6d6bc566d440756808c73e
+  metadata.gz: 592881730764b7873f8ae95bc4de43942f3f8345c37327157b528b9b740706544c206b1ea84b3c41d430d8e6f389cd6699cf0a535797c07e4f2e82aa06c8aa33
+  data.tar.gz: 88163ad100fa9e310cb42c8b1dc9240b3aa09831b048e6215ddc6636cfea57ade49d452290ca01cd91a13f001e902fe8291ff17d8da63ad85a32d1abe470e7c4

data/.rubocop.yml

@@ -1,8 +1,11 @@
+plugins:
+  - rubocop-rake
+  - rubocop-rspec
+
 AllCops:
   TargetRubyVersion: 3.1
+  NewCops: enable
 
-Style/StringLiterals:
-  EnforcedStyle: double_quotes
-
-Style/StringLiteralsInInterpolation:
-  EnforcedStyle: double_quotes
+# Do not enforce documentation
+Style/Documentation:
+  Enabled: false

data/README.md

@@ -1,6 +1,6 @@
 # BlueprinterSchema
 
-### Create JSON Schema from Blueprinter serializers and ActiveRecord Models.
+### Create JSON Schema from Blueprinter Serializers and ActiveRecord Models.
 
 ## Installation
 
@@ -12,6 +12,75 @@ gem "blueprinter_schema"
 
 ## Usage
 
+With the folloing Models and Serializers:
+```rb
+class Address < ApplicationRecord
+  belongs_to :user
+end
+
+class User < ApplicationRecord
+  has_many :addresses
+end
+
+class AddressSerializer < Blueprinter::Base
+  identifier :id
+
+  fields :address
+end
+
+class UserSerializer < Blueprinter::Base
+  identifier :id
+
+  fields :name, :email, :created_at
+  association :addresses, blueprint: AddressSerializer
+end
+```
+
+Generate JSON Schema:
+```rb
+BlueprinterSchema.generate(UserSerializer, User)
+```
+
+```rb
+{
+  "type" => "object",
+  "title" => "User",
+  "properties" => {
+    "id" => {
+      "type" => "integer"
+    },
+    "created_at" => {
+      "type" => "string", "format" => "date-time"
+    },
+    "email" => {
+      "type" => "string"
+    },
+    "name" => {
+      "type" => ["string", "null"]
+    },
+    "addresses" => {
+      "type" => "array",
+      "items" => {
+        "type" => "object",
+        "title" => "Address",
+        "properties" => {
+          "id" => {
+            "type" => "integer"
+          },
+          "address" => {
+            "type" => "string"
+          }
+        },
+        "required" => ["id", "address"],
+        "additionalProperties" => false
+      }
+    }
+  },
+  "required" => ["id", "created_at", "email", "name"],
+  "additionalProperties" => false
+}
+```
+
 ## 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/Rakefile

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-require "rubocop/rake_task"
+require 'rubocop/rake_task'
 
 RuboCop::RakeTask.new
 

data/lib/blueprinter_schema/version.rb

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

data/lib/blueprinter_schema.rb

@@ -1,8 +1,98 @@
 # frozen_string_literal: true
 
-require_relative "blueprinter_schema/version"
+require_relative 'blueprinter_schema/version'
 
 module BlueprinterSchema
-  class Error < StandardError; end
-  # Your code goes here...
+  class << self
+    def generate(serializer, model)
+      views = serializer.reflections
+      fields = views[:default].fields
+      associations = views[:default].associations
+
+      {
+        'type' => 'object',
+        'title' => model.name,
+        'properties' => build_properties(fields, associations, model),
+        'required' => build_required_fields(fields),
+        'additionalProperties' => false
+      }
+    end
+
+    private
+
+    def build_properties(fields, associations, model)
+      properties = {}
+
+      fields.each_value do |field|
+        properties[field.display_name.to_s] = field_to_json_schema(field, model)
+      end
+
+      associations.each_value do |association|
+        properties[association.display_name.to_s] = association_to_json_schema(association, model)
+      end
+
+      properties
+    end
+
+    def build_required_fields(fields)
+      fields.keys.map(&:to_s)
+    end
+
+    def field_to_json_schema(field, model)
+      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
+    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')
+      else
+        # Unknown column type, we don't know the schema type
+        {}
+      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
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blueprinter_schema
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - thisismydesign
@@ -33,6 +33,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/thisismydesign/blueprinter_schema
   source_code_uri: https://github.com/thisismydesign/blueprinter_schema
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib