Introduce types for builder

lib/jsonschema_serializer.rb

@@ -2,6 +2,7 @@
 
 require 'jsonschema_serializer/version'
 require 'jsonschema_serializer/builder'
+require 'jsonschema_serializer/typed_builder'
 require 'jsonschema_serializer/active_record'
 require 'jsonschema_serializer/filter_utilities'
 

lib/jsonschema_serializer/error.rb

@@ -10,4 +10,14 @@ def initialize(msg = DEFAULT_MESSAGE)
       super(msg)
     end
   end
+
+  # +DuplicatedObjectPropertyError+ is an +ArgumentError+
+  class DuplicatedObjectPropertyError < ArgumentError
+    # Default message for +DuplicatedObjectPropertyError+ instance
+    DEFAULT_MESSAGE = 'Duplicated declaration for object properties'
+
+    def initialize(msg = DEFAULT_MESSAGE)
+      super(msg)
+    end
+  end
 end

lib/jsonschema_serializer/typed_builder.rb

@@ -0,0 +1,195 @@
+# frozen_string_literal: true
+
+require_relative 'types'
+
+module JsonschemaSerializer
+  # The +JsonschemaSerializer::Builder+ class provides
+  # an effective DSL to generate a valid json schema.
+  class TypedBuilder < JsonschemaSerializer::Types::Object
+    class << self
+      # The +build+ class method create a new instance and applies the block
+      def build
+        new.tap do |builder|
+          yield(builder) if block_given?
+        end
+      end
+    end
+
+    # The +new+ method creates assigns a new object
+    # to a +schema+ instance variable
+    def schema
+        self
+    end
+
+    # Assigns the +title+ to the root schema object
+    #
+    # Params:
+    # +title+:: +String+ or +Symbol+ title field of the schema object
+
+    def title(title)
+      schema[:title] = title
+    end
+
+    # Assigns the +description+ to the root schema object
+    #
+    # params:
+    # +description+:: +String+ description field of the schema object
+
+    def description(description)
+      schema[:description] = description
+    end
+
+    # The +required+ method allows to provide a list of required properties
+    #
+    # params:
+    # +required+ [Array[String, Symbol]]
+
+    def required(*required)
+      schema[:required] = required
+    end
+
+    # The +properties+ method allows to access object properties
+    #
+    # e.g.:
+    #   JsonschemaSerializer::Builder.build do |b|
+    #     b.properties.tap do |p|
+    #       p.merge! {}
+    #     end
+    #   end
+
+    def properties
+      schema[:properties] ||= {}
+    end
+
+    # A base representation of the +boolean+ type.
+    def _boolean(**opts)
+      JsonschemaSerializer::Types::Boolean.new(**opts)
+    end
+
+    # A property representation of the +boolean+ type.
+    #
+    # Params:
+    # +name+:: +String+ or +Symbol+
+    #
+    # Optional Params:
+    # +default+:: +Boolean+ default value
+    # +description+:: +String+ property description
+    # +title+:: +String+ property title
+
+    def boolean(name, **opts)
+      JsonschemaSerializer::Types::Boolean.named(name, **opts)
+    end
+
+    # A base representation of the +integer+ type.
+    def _integer(**opts)
+      JsonschemaSerializer::Types::Integer.new(**opts)
+    end
+
+    # A property representation of the +integer+ type.
+    #
+    # Params:
+    # +name+:: +String+ or +Symbol+
+    #
+    # Optional Params:
+    # +default+:: +Integer+ default value
+    # +description+:: +String+ property description
+    # +title+:: +String+ property title
+    # +enum+:: +Array+ property allowed values
+    # +minimum+:: +Integer+ property minimum value
+    # +maximum+:: +Integer+ property maximum value
+    # +multipleOf+:: +Integer+ property conditional constraint
+
+    def integer(name, **opts)
+      JsonschemaSerializer::Types::Integer.named(name, **opts)
+    end
+
+    # A base representation of the +number+ type.
+    def _number(**opts)
+      JsonschemaSerializer::Types::Number.new(**opts)
+    end
+
+    # A property representation of the +number+ type.
+    #
+    # Params:
+    # +name+:: +String+ or +Symbol+
+    #
+    # Optional Params:
+    # +default+:: +Numeric+ default value
+    # +description+:: +String+ property description
+    # +title+:: +String+ property title
+    # +enum+:: +Array+ property allowed values
+    # +minimum+:: +Numeric+ property minimum value
+    # +maximum+:: +Numeric+ property maximum value
+    # +multipleOf+:: +Numeric+ property conditional constraint
+
+    def number(name, **opts)
+      JsonschemaSerializer::Types::Number.named(name, **opts)
+    end
+
+    # A base representation of the +string+ type.
+    def _string(**opts)
+      JsonschemaSerializer::Types::String.new(**opts)
+    end
+
+    # A property representation of the +string+ type.
+    #
+    # Params:
+    # +name+:: +String+ or +Symbol+
+    #
+    # Optional Params:
+    # +default+:: +String+ default value
+    # +description+:: +String+ property description
+    # +title+:: +String+ property title
+    # +format+:: +String+ property format for validation
+    # +minLength+:: +Int+ property minimum length
+
+    def string(name, **opts)
+      JsonschemaSerializer::Types::String.named(name, **opts)
+    end
+
+    # A base representation of the +object+ type.
+    #
+    #   JsonschemaSerializer::Builder.build do |b|
+    #     subscriber = b._object title: :subscriber, required: [:age] do |prop|
+    #       prop.merge! b.string :first_name, title: 'First Name'
+    #       prop.merge! b.string :last_name, title: 'Last Name'
+    #       prop.merge! b.integer :age, title: 'Age'
+    #     end
+    #   end
+
+    def _object(**opts)
+      JsonschemaSerializer::Types::Object.new(**opts).tap do |h|
+        yield(h[:properties]) if block_given?
+      end
+    end
+
+    # A property representation of the +array+ type.
+    #
+    # Params:
+    # +name+:: +String+ or +Symbol+
+    # +items+:: an object representation or an array of objects
+    #
+    # Optional Params:
+    # +default+:: +Array+ default value
+    # +description+:: +String+ property description
+    # +title+:: +String+ property title
+    # +minItems+:: +Int+ property minimum length
+    # +maxItems+:: +Int+ property maximum length
+    #
+    #   JsonschemaSerializer::Builder.build do |b|
+    #     b.array :integers, items: {type: :integer}, minItems:5
+    #     b.array :strings, items: b._string, default: []
+    #
+    #     subscriber = b._object title: :subscriber, required: [:age] do |prop|
+    #       prop.merge! b.string :first_name, title: 'First Name'
+    #       prop.merge! b.string :last_name, title: 'Last Name'
+    #       prop.merge! b.integer :age, title: 'Age'
+    #     end
+    #     b.array :subscribers, items: subscriber
+    #   end
+
+    def array(name, items:, **opts)
+      JsonschemaSerializer::Types::Array.named(name, items: items, **opts)
+    end
+  end
+end