esquema 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e8324bb76d58095f92b42debd64164b92ea4b710ed6e4a8245727f0f37738ecc
-  data.tar.gz: cff598345220aa3ca29a30cf3020f27f4bcc093a660137203a564ec2adf2318a
+  metadata.gz: 4a31e08f199e964d003d99fe4e8e03b62dd86231a48d29053fec1fef03ce06f8
+  data.tar.gz: 20f4e5198607e7bba751bc61f1b4b0666f4468f19879ac44fdbdf2ee8542675b
 SHA512:
-  metadata.gz: b875bf9a00edbf26515c261e96e512cf8b940a48a613d35d1b461380c96528777c8a4522403d2ae1a907876c4e635033e453bec2356d708f554105c9533aeb3b
-  data.tar.gz: cdfcc607f90a1695d96aacbc0af3a07e646843a6bd0ebd221adf27105356fd61e6d75e1946826c893fedfde48990788547caf9ebbae522785f665c7b5154d186
+  metadata.gz: 7c621671e563866f1c9d0216b4561f135dc4d8c66c3921b18876600fedaa4c37417c6b2a12ee12c15ec9cdf6cbabbac6fe910bed3820d193a5395412a94aa975
+  data.tar.gz: 69a1b9637e854a0ae3f5cc7730c37af8e4fce0170432bab567fb6bc079d7914dc256346e4f1d35c9e9691ed801ef7effe062d098df9387c04136d08047a9f56c

data/.rubocop.yml

@@ -1,5 +1,8 @@
 AllCops:
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 3.2
+  Exclude:
+    - 'spec/support/matchers/**'
+    - 'vendor/**/*'
 
 Style/StringLiterals:
   Enabled: true

data/CHANGELOG.md

@@ -1,4 +1,12 @@
-## [Unreleased]
+## [0.1.2] - 2024-02-22
+- Removed Rails dependency and added ActiveRecord dependency.
+- Added documentation for `virtual_property` and improved overall README.md
+- Only supporting Ruby 3.2 and above for now.
+- Added support for `virtual_property`. This allows you to define JSON schema properties that don't have a corresponding AR attribute.
+- Performance improvements.
+- Improved error handling and added more tests.
+- Improved documentation and added more examples.
+- Added additional support for schema validation keywords. Example: `minLength`, `maxLength`, `pattern`, `format`, `multipleOf`, `minimum`, `maximum`, `exclusiveMinimum`, `exclusiveMaximum`, `enum`, `const`, `items`, `additionalItems`, `contains`, `minItems`, `maxItems`, `uniqueItems`, `propertyNames`, `minProperties`, `maxProperties`, `required`, `dependencies`, `patternProperties`, `allOf`, `anyOf`, `oneOf`, `not`.
 
 ## [0.1.0] - 2024-02-14
 

data/README.md

@@ -4,10 +4,10 @@ Esquema is a Ruby library for JSON Schema generation from ActiveRecord models.
 
 Esquema was designed with the following assumptions:
 
-- An ActiveRecord model represents a JSON object.
+- An ActiveRecord model represents a JSON Schema object.
 - The JSON object properties are a representation of the model's attributes.
 - The JSON Schema property types are inferred from the model's attribute types.
-- The model associations (has_many, belongs_to, etc.) are represented as subschemas in the JSON Schema.
+- The model associations (has_many, belongs_to, etc.) are represented as subschemas or nested schema objects.
 - You can customize the generated schema by using the configuration file or the `enhance_schema` method.
 
 Example Use:
@@ -82,12 +82,18 @@ class User < ApplicationRecord
     model_description "A user of the system"
     property :name, description: "The user's name", title: "Full Name"
     property :group, enum: [1, 2, 3], default: 1, description: "The user's group"
+    property :email, description: "The user's email", format: "email"
+    virtual_property :age, type: "integer", minimum: 18, maximum: 100, description: "The user's age"
   end
 end
 ```
 
 In the example above, the `enhance_schema` method is used to add a description to the model, change the title of the `name` property and add a description. It adds an enum, default value and a description to the `group` property.
 
+Use the `property` keyword for the existing model attributes. In other words the symbol passed to the `property` method must be a column in the table that the model represents. Property does not accept a `type` argument, as the type is inferred from the column type.
+
+Use the `virtual_property` keyword for properties that are not columns in the table that the model represents. Virtual properties require a `type` argument, as the type cannot be inferred.
+
 
 ## Development
 

data/lib/esquema/builder.rb

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
 
 require_relative "property"
+require_relative "virtual_column"
 
 module Esquema
+  # The Builder class is responsible for building a schema for an ActiveRecord model.
   class Builder
     attr_reader :model, :required_properties
 
@@ -14,26 +16,57 @@ module Esquema
       @required_properties = []
     end
 
+    # Builds the schema for the ActiveRecord model.
+    #
+    # @return [Hash] The built schema.
     def build_schema
-      schema = {
+      @build_schema ||= {
         title: build_title,
         description: build_description,
-        type: "object",
+        type: build_type,
         properties: build_properties,
         required: required_properties
-      }
+      }.compact
+    end
 
-      schema.compact
+    # @return [Hash] The schema for the ActiveRecord model.
+    def schema
+      build_schema
     end
 
+    # Builds the properties for the schema.
+    #
+    # @return [Hash] The built properties.
     def build_properties
       add_properties_from_columns
-      add_properties_from_has_many_associations
-      add_properties_from_has_one_associations
-
+      add_properties_from_associations
+      add_virtual_properties
       @properties
     end
 
+    # Builds the type for the schema.
+    #
+    # @return [String] The built type.
+    def build_type
+      model.respond_to?(:type) ? model.type : "object"
+    end
+
+    private
+
+    # Adds virtual properties to the schema.
+    def add_virtual_properties
+      return unless schema_enhancements[:properties]
+
+      virtual_properties = schema_enhancements[:properties].select { |_k, v| v[:virtual] }
+      required_properties.concat(virtual_properties.keys)
+
+      virtual_properties.each do |property_name, options|
+        virtual_col = VirtualColumn.new(property_name, options)
+        @properties[property_name] = Property.new(virtual_col, options)
+      end
+    end
+
+    # Adds properties from columns to the schema.
     def add_properties_from_columns
       columns.each do |property|
         next if property.name.end_with?("_id") && config.exclude_foreign_keys?
@@ -44,57 +77,66 @@ module Esquema
       end
     end
 
-    def add_properties_from_has_many_associations
-      has_many_associations.each do |association|
+    # Adds properties from associations to the schema.
+    def add_properties_from_associations
+      associations.each do |association|
         next if config.exclude_associations?
 
         @properties[association.name] ||= Property.new(association)
       end
     end
 
-    def add_properties_from_has_one_associations
-      has_one_associations.each do |association|
-        next if config.exclude_associations?
-
-        klass = association.klass.name.constantize
-        @properties[association.name] ||= self.class.new(klass).build_schema
-      end
-    end
-
+    # Retrieves the columns of the model.
+    #
+    # @return [Array<ActiveRecord::ConnectionAdapters::Column>] The columns of the model.
     def columns
       model.columns.reject { |c| excluded_column?(c.name) }
     end
 
+    # Retrieves the enhancement options for a property.
+    #
+    # @param property_name [Symbol] The name of the property.
+    # @return [Hash] The enhancement options for the property.
     def enhancement_for(property_name)
-      schema_enhancements&.dig(:properties, property_name.to_sym) || {}
+      schema_enhancements.dig(:properties, property_name.to_sym) || {}
     end
 
-    def has_many_associations
-      model.reflect_on_all_associations(:has_many)
-    end
+    # Retrieves the associations of the model.
+    #
+    # @return [Array<ActiveRecord::Reflection::AssociationReflection>] The associations of the model.
+    def associations
+      return [] unless model.respond_to?(:reflect_on_all_associations)
 
-    def has_one_associations
-      model.reflect_on_all_associations(:has_one)
+      model.reflect_on_all_associations
     end
 
+    # Checks if a column is excluded.
+    #
+    # @param column_name [String] The name of the column.
+    # @return [Boolean] True if the column is excluded, false otherwise.
     def excluded_column?(column_name)
       raise ArgumentError, "Column name must be a string" unless column_name.is_a? String
 
       config.excluded_columns.include?(column_name.to_sym)
     end
 
+    # Builds the title for the schema.
+    #
+    # @return [String] The built title.
     def build_title
       schema_enhancements[:model_title].presence || model.name.demodulize.humanize
     end
 
+    # Builds the description for the schema.
+    #
+    # @return [String] The built description.
     def build_description
       schema_enhancements[:model_description].presence
     end
 
-    def name
-      model.name
-    end
-
+    # Retrieves the schema enhancements for the model.
+    #
+    # @return [Hash] The schema enhancements.
     def schema_enhancements
       if model.respond_to?(:schema_enhancements)
         model.schema_enhancements
@@ -103,6 +145,9 @@ module Esquema
       end
     end
 
+    # Retrieves the Esquema configuration.
+    #
+    # @return [Esquema::Configuration] The Esquema configuration.
     def config
       Esquema.configuration
     end

data/lib/esquema/configuration.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
-module Esquema
+module Esquema # rubocop:disable Style/Documentation
+  # The Configuration module provides configuration options for the gem.
   class Configuration
     attr_accessor :exclude_associations, :exclude_foreign_keys, :excluded_columns
 

data/lib/esquema/keyword_validator.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+module Esquema
+  # The KeywordValidator module provides functionality for validating schema keyword values.
+  # There are three types of keyword values that must be validated against the type of the
+  # property they are associated with:
+  # - default: The default value for a property.
+  # - enum: The allowed values for a property.
+  # - const: The constant value for a property.
+  module KeywordValidator
+    # The valid options for a property.
+    VALID_OPTIONS = %i[type title description maxLength minLength pattern maxItems minItems
+                       maxProperties minProperties properties additionalProperties dependencies
+                       enum format multipleOf maximum exclusiveMaximum minimum exclusiveMinimum
+                       const allOf anyOf oneOf not default items uniqueItems virtual].freeze
+
+    # Hash containing type validators for different data types.
+    TYPE_VALIDATORS = {
+      string: ->(value) { value.is_a?(String) },
+      integer: ->(value) { value.is_a?(Integer) },
+      number: ->(value) { value.is_a?(Numeric) },
+      boolean: ->(value) { [true, false].include?(value) },
+      array: ->(value) { value.is_a?(Array) },
+      object: ->(value) { value.is_a?(Hash) },
+      null: ->(value) { value.nil? },
+      date: ->(value) { value.is_a?(Date) },
+      datetime: ->(value) { value.is_a?(DateTime) },
+      time: ->(value) { value.is_a?(Time) }
+    }.freeze
+
+    # Validates a property based on its type and options.
+    #
+    # @param property_name [Symbol] The name of the property being validated.
+    # @param type [Symbol] The type of the property.
+    # @param options [Hash] The options for the property.
+    # @option options [Object] :default The default value for the property.
+    # @option options [Array] :enum The allowed values for the property.
+    # @option options [Object] :const The constant value for the property.
+    # @raise [ArgumentError] If the options are not in the VALID_OPTIONS constant.
+    # @raise [ArgumentError] If the property name is not a symbol.
+    # @raise [ArgumentError] If the property type is not a symbol.
+    # @raise [ArgumentError] If the type is unknown.
+    def self.validate!(property_name, type, options) # rubocop:disable Metrics/AbcSize
+      options.assert_valid_keys(VALID_OPTIONS)
+      raise ArgumentError, "Property must be a symbol" unless property_name.is_a?(Symbol)
+      raise ArgumentError, "Property type must be a symbol" unless type.is_a?(Symbol)
+      raise ArgumentError, "Unknown type #{type}" unless TYPE_VALIDATORS.key?(type)
+
+      validate_default(property_name, type, options[:default]) if options.key?(:default)
+      validate_enum(property_name, type, options[:enum]) if options.key?(:enum)
+      validate_const(property_name, type, options[:const]) if options.key?(:const)
+    end
+
+    # Validates the default value for a property.
+    #
+    # @param property_name [Symbol] The name of the property being validated.
+    # @param type [Symbol] The type of the property.
+    # @param default [Object] The default value for the property.
+    def self.validate_default(property_name, type, default)
+      validate_value!(property_name, type, default, "default")
+    end
+
+    # Validates the allowed values for a property.
+    #
+    # @param property_name [Symbol] The name of the property being validated.
+    # @param type [Symbol] The type of the property.
+    # @param enum [Array] The allowed values for the property.
+    # @raise [ArgumentError] If the enum is not an array.
+    def self.validate_enum(property_name, type, enum)
+      raise ArgumentError, "Enum for #{property_name} is not an array" unless enum.is_a?(Array)
+
+      enum.each { |value| validate_value!(property_name, type, value, "enum") }
+    end
+
+    # Validates the constant value for a property.
+    #
+    # @param property_name [Symbol] The name of the property being validated.
+    # @param type [Symbol] The type of the property.
+    # @param const [Object] The constant value for the property.
+    def self.validate_const(property_name, type, const)
+      validate_value!(property_name, type, const, "const")
+    end
+
+    # Validates a value based on its type and keyword.
+    #
+    # @param property_name [Symbol] The name of the property being validated.
+    # @param type [Symbol] The type of the property.
+    # @param value [Object] The value to be validated.
+    # @param keyword [String] The keyword being validated (e.g., "default", "enum").
+    # @raise [ArgumentError] If the value does not match the type.
+    def self.validate_value!(property_name, type, value, keyword)
+      validator = TYPE_VALIDATORS[type]
+      return if validator.call(value)
+
+      raise ArgumentError, "#{keyword.capitalize} value for #{property_name} does not match type #{type}"
+    end
+  end
+end

data/lib/esquema/model.rb

@@ -5,20 +5,24 @@ require_relative "builder"
 require_relative "schema_enhancer"
 
 module Esquema
+  # The Esquema module provides functionality for building JSON schemas.
   module Model
     extend ActiveSupport::Concern
 
     included do
+      # Returns the JSON schema for the model.
       def self.json_schema
         Esquema::Builder.new(self).build_schema.to_json
       end
 
+      # Enhances the schema using the provided block.
       def self.enhance_schema(&block)
         schema_enhancements
         enhancer = SchemaEnhancer.new(self, @schema_enhancements)
         enhancer.instance_eval(&block)
       end
 
+      # Returns the schema enhancements.
       def self.schema_enhancements
         @schema_enhancements ||= {}
       end

data/lib/esquema/property.rb

@@ -2,7 +2,9 @@
 
 require_relative "type_caster"
 module Esquema
-  class Property
+  # Represents a property in the Esquema schema.
+  class Property # rubocop:disable Metrics/ClassLength
+    # Mapping of database types to JSON types.
     DB_TO_JSON_TYPE_MAPPINGS = {
       date: "date",
       datetime: "date-time",
@@ -11,69 +13,226 @@ module Esquema
       text: "string",
       integer: "integer",
       float: "number",
+      number: "number",
       decimal: "number",
       boolean: "boolean",
       array: "array",
       object: "object"
     }.freeze
 
-    ATTRS = %i[type default title description item_type items enum].freeze
-    attr_accessor(*ATTRS)
-    attr_reader :property, :options
-
-    def initialize(property, options = {})
-      raise ArgumentError, "property must have a name" unless property.respond_to?(:name)
-
-      @property = property
+    NUMERIC_CONSTRAINT_KEYWORDS = %i[minimum maximum exclusiveMinimum exclusiveMaximum multipleOf].freeze
+    STRING_CONSTRAINT_KEYWORDS = %i[maxLength minLength pattern format].freeze
+    ARRAY_CONSTRAINT_KEYWORDS = %i[maxItems minItems uniqueItems items].freeze
+    OBJECT_CONSTRAINT_KEYWORDS = %i[maxProperties minProperties properties additionalProperties dependencies].freeze
+    LOGICAL_KEYWORDS = %i[allOf anyOf oneOf not].freeze
+    GENERIC_KEYWORDS = %i[type default title description enum const].freeze
+
+    KEYWORDS = (
+      NUMERIC_CONSTRAINT_KEYWORDS +
+      STRING_CONSTRAINT_KEYWORDS  +
+      ARRAY_CONSTRAINT_KEYWORDS   +
+      OBJECT_CONSTRAINT_KEYWORDS  +
+      LOGICAL_KEYWORDS            +
+      GENERIC_KEYWORDS
+    ).freeze
+
+    FORMAT_OPTIONS = %i[date-time date time email hostname ipv4 ipv6 uri uuid uri-reference uri-template].freeze
+
+    attr_reader :object, :options
+
+    # Initializes a new Property instance.
+    #
+    # @param object [Object] The object to build the property for.
+    # An object can be any of the following instance types:
+    #  An ActiveRecord column. Example: ActiveRecord::ConnectionAdapters::SQLite3::Column
+    #  An ActiveRecord association reflection. Example: ActiveRecord::Reflection::BelongsToReflection
+    #  An Esquema virtual column. Example: Esquema::VirtualColumn
+    # @param options [Hash] Additional options for the property.
+    # @raise [ArgumentError] If the property does not have a name.
+    def initialize(object, options = {})
+      raise ArgumentError, "property must have a name" unless object.respond_to?(:name)
+
+      @object = object
       @options = options
     end
 
+    # Converts the Property instance to a JSON representation.
+    #
+    # @return [Hash] The JSON representation of the Property.
     def as_json
-      ATTRS.each_with_object({}) do |property, hash|
-        value = send("build_#{property}")
+      KEYWORDS.each_with_object({}) do |property, hash|
+        value = send("build_#{property.downcase}")
         next if value.nil? || (value.is_a?(String) && value.empty?)
 
         hash[property] = value
       end.compact
     end
 
+    # Builds the title attribute for the Property.
+    #
+    # @return [String] The title attribute.
     def build_title
-      options[:title].presence || property.name.to_s.humanize
+      options[:title].presence || object.name.to_s.humanize
     end
 
+    # Builds the default attribute for the Property.
+    #
+    # @return [Object, nil] The default attribute.
     def build_default
-      return unless property.respond_to?(:default)
+      return unless object.respond_to?(:default)
 
-      default_value = property.default || options[:default].presence
+      default_value = object.default || options[:default].presence
 
-      @default = TypeCaster.cast(property.type, default_value) unless default_value.nil?
+      @default = TypeCaster.cast(object.type, default_value) unless default_value.nil?
     end
 
+    # Builds the type attribute for the Property.
+    #
+    # @return [String, nil] The type attribute.
     def build_type
-      return DB_TO_JSON_TYPE_MAPPINGS[:array] if property.try(:collection?)
-
-      @type = DB_TO_JSON_TYPE_MAPPINGS[property.type]
-    end
+      return DB_TO_JSON_TYPE_MAPPINGS[:array] if object.try(:collection?)
 
-    def build_item_type
-      return unless property.respond_to?(:item_type)
+      return unless object.respond_to?(:type)
 
-      @item_type = property.item_type if property.type == :array
+      @type = DB_TO_JSON_TYPE_MAPPINGS[object.type]
     end
 
+    # Builds the description attribute for the Property.
+    #
+    # @return [String, nil] The description attribute.
     def build_description
       options[:description]
     end
 
+    # Builds the items attribute for the Property.
+    #
+    # @return [Hash, nil] The items attribute.
     def build_items
-      return unless property.try(:collection?)
-
-      class_name = property.class_name.constantize
-      @items = Builder.new(class_name).build_schema
+      return unless object.try(:collection?)
+
+      case object.type
+      when :array
+        { type: DB_TO_JSON_TYPE_MAPPINGS[object.item_type] }
+      else
+        Builder.new(object.klass).build_schema
+      end
     end
 
+    # Builds the enum attribute for the Property.
+    #
+    # @return [Array, nil] The enum attribute.
     def build_enum
       options[:enum]
     end
+
+    def build_minimum
+      options[:minimum]
+    end
+
+    def build_maximum
+      options[:maximum]
+    end
+
+    def build_exclusiveminimum
+      options[:exclusiveMinimum]
+    end
+
+    def build_exclusivemaximum
+      options[:exclusiveMaximum]
+    end
+
+    def build_multipleof
+      options[:multipleof]
+    end
+
+    def build_maxlength
+      options[:maxLength]
+    end
+
+    def build_minlength
+      options[:minLength]
+    end
+
+    def build_pattern
+      options[:pattern]
+    end
+
+    def build_format
+      options[:format]
+    end
+
+    def build_maxitems # rubocop:disable Metrics/AbcSize
+      raise ArgumentError, "maxItems must be an integer" if options[:maxItems] && !options[:maxItems].is_a?(Integer)
+
+      if options[:maxItems]&.negative?
+        raise ArgumentError,
+              "maxItems must be a non-negative integer"
+      end
+
+      if options[:maxItems] && options[:type] != :array
+        raise ArgumentError, "maxItems must be use for array type properties only."
+      end
+
+      options[:maxItems]
+    end
+
+    def build_minitems # rubocop:disable Metrics/AbcSize
+      raise ArgumentError, "minItems must be an integer" if options[:minItems] && !options[:minItems].is_a?(Integer)
+
+      if options[:minItems]&.negative?
+        raise ArgumentError,
+              "minItems must be a non-negative integer"
+      end
+
+      if options[:minItems] && options[:type] != :array
+        raise ArgumentError, "minItems must be use for array type properties only."
+      end
+
+      options[:minItems]
+    end
+
+    def build_uniqueitems
+      options[:uniqueItems]
+    end
+
+    def build_properties
+      options[:properties]
+    end
+
+    def build_maxproperties
+      options[:maxProperties]
+    end
+
+    def build_minproperties
+      options[:minProperties]
+    end
+
+    def build_additionalproperties
+      options[:additionalProperties]
+    end
+
+    def build_dependencies
+      options[:dependencies]
+    end
+
+    def build_allof
+      options[:allOf]
+    end
+
+    def build_anyof
+      options[:anyOf]
+    end
+
+    def build_oneof
+      options[:oneOf]
+    end
+
+    def build_not
+      options[:not]
+    end
+
+    def build_const
+      options[:const]
+    end
   end
 end