model-to-schema 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 92f331264f95271e7f464eadf17836ae1bfc3ef7d968b0f4c7e09c0694375200
+  data.tar.gz: ab9a5582eee8f567802129b7248aaf1aface3970363d79112e7ad5e071d8396e
+SHA512:
+  metadata.gz: a6253ecb98c34f70ab1c9d8f00613bdf40cc55656a8f29dc37d45f95d211408718e437f7b1f74f81145def1aeb25185bf85270f0a7ed8887b5a4e8b44d50dd30
+  data.tar.gz: 71110299132f10d628f717ee65c90d772da6790f0f8b0711541a714653c50a35f8928ddc6e5dec756a433e9a9de2d2be546f04c29d849f7d823bb03351c1a5fa

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,20 @@
+AllCops:
+  TargetRubyVersion: 3.1
+  Exclude:
+    - "spec/support/matchers/**"
+    - "vendor/**/*"
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/BlockLength:
+  Enabled: false
+

data/.ruby-version

@@ -0,0 +1 @@
+3.1.0

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+## [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
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Sergio Bayona
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,111 @@
+# Esquema
+
+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 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 or nested schema objects.
+- You can customize the generated schema by using the configuration file or the `enhance_schema` method.
+
+Example Use:
+
+```ruby
+class User < ApplicationRecord
+  include Esquema::Model
+
+    # Assuming the User db table has the following columns:
+    # column :name, :string
+    # column :email, :string
+
+  end
+end
+```
+
+Calling `User.json_schema` will return the JSON Schema for the User model:
+
+```json
+{
+    "title": "User model",
+    "type": "object",
+    "properties": {
+        "id": {
+            "type": "integer"
+        },
+        "name": {
+            "type": "string"
+        },
+        "email": {
+            "type": "string"
+        }
+    },
+    "required:": [
+        "name",
+        "email"
+    ]
+}
+```
+
+## Installation
+
+ install the gem by executing:
+
+    $ gem install esquema
+
+
+Run the following command to install the gem and generate the configuration file:
+
+```bash
+rails generate esquema:install 
+```
+
+This will generate a configuration file at:
+
+    <rails_app>/config/initializer/esquema.rb
+
+
+## Usage
+
+Simply include the `Esquema::Model` module in your ActiveRecord model and call the `json_schema` method to generate the JSON Schema for the model.
+
+There are multiple ways to customize the generated schema:
+- You can exclude columns, foreign keys, and associations from the schema. See the <rails_project>/config/initializer/esquema.rb configuration for more details.
+- For more complex customizations, you can use the `enhance_schema` method to modify the schema directly on the AR model. Here is an example:
+
+```ruby
+class User < ApplicationRecord
+  include Esquema::Model
+
+  enhance_schema do
+    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
+
+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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sergiobayona/esquema. 
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/esquema.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative "lib/esquema/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "model-to-schema"
+  spec.version = Esquema::VERSION
+  spec.authors = ["Sergio Bayona"]
+  spec.email = ["bayona.sergio@gmail.com"]
+
+  spec.summary = "Generate json-schema from ActiveRecord models."
+  spec.description = "Generate json-schema from ActiveRecord models."
+  spec.homepage = "https://github.com/sergiobayona/esquema"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.1"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/sergiobayona/esquema"
+  spec.metadata["changelog_uri"] = "https://github.com/sergiobayona/esquema/blob/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ spec/ .git .github Gemfile])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activerecord", "~> 7.0"
+  spec.add_development_dependency "pry-byebug", "~> 3.10", ">= 3.10.1"
+  spec.add_development_dependency "rake", "~> 13.0"
+end

data/lib/esquema/builder.rb

@@ -0,0 +1,155 @@
+# 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
+
+    def initialize(model)
+      raise ArgumentError, "Class is not an ActiveRecord model" unless model.ancestors.include? ActiveRecord::Base
+
+      @model = model
+      @properties = {}
+      @required_properties = []
+    end
+
+    # Builds the schema for the ActiveRecord model.
+    #
+    # @return [Hash] The built schema.
+    def build_schema
+      @build_schema ||= {
+        title: build_title,
+        description: build_description,
+        type: build_type,
+        properties: build_properties,
+        required: required_properties
+      }.compact
+    end
+
+    # @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_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?
+
+        required_properties << property.name
+        options = enhancement_for(property.name)
+        @properties[property.name] ||= Property.new(property, options)
+      end
+    end
+
+    # 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
+
+    # 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) || {}
+    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)
+
+      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
+
+    # Retrieves the schema enhancements for the model.
+    #
+    # @return [Hash] The schema enhancements.
+    def schema_enhancements
+      if model.respond_to?(:schema_enhancements)
+        model.schema_enhancements
+      else
+        {}
+      end
+    end
+
+    # Retrieves the Esquema configuration.
+    #
+    # @return [Esquema::Configuration] The Esquema configuration.
+    def config
+      Esquema.configuration
+    end
+  end
+end

data/lib/esquema/configuration.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+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
+
+    def initialize
+      reset
+    end
+
+    def reset
+      @exclude_associations = false
+      @exclude_foreign_keys = true
+      @excluded_columns = []
+    end
+
+    def exclude_foreign_keys?
+      exclude_foreign_keys
+    end
+
+    def exclude_associations?
+      exclude_associations
+    end
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+end

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+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
+    end
+  end
+end