esquema 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 558e39a6744da50805af73033bd229dcb5767ccd6eaf0709a24fbebb451f914a
+  data.tar.gz: a7579351072e9c130d815af4347280a82679b3e1160473b146458dc1e0367b24
+SHA512:
+  metadata.gz: daafedad9677ee070eec3b955e20fa3bdda4e6b58319672f17eb08cbafbf4c3074a1c9f4d759569c10e48d6d2165d7bf1a3720983babf369e88f2238b85d89d2
+  data.tar.gz: 732723cf1c653139c8dc255d91fc73eb792f583e2d0a839088a23af4c521a73301aa9ac99f875696a72cd6fe436e4842f36bd6783e7e28ebc6d4187bde4d00c6

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,16 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+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.3.0

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [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,109 @@
+# 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 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.
+- 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 and add to the application's Gemfile by executing:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+
+
+Execute 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"
+  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.
+
+
+## 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 = "esquema"
+  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://esquema.co"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  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 "rails", "~> 7.0"
+  spec.add_development_dependency "pry-byebug", ">= 3.10.1"
+  spec.add_development_dependency "rake", "~> 13.1"
+end

data/lib/esquema/builder.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+require_relative "property"
+
+module Esquema
+  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
+
+    def build_schema
+      schema = {
+        title: build_title,
+        description: build_description,
+        type: "object",
+        properties: build_properties,
+        required: required_properties
+      }
+
+      schema.compact
+    end
+
+    def build_properties
+      add_properties_from_columns
+      add_properties_from_has_many_associations
+      add_properties_from_has_one_associations
+
+      @properties
+    end
+
+    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
+
+    def add_properties_from_has_many_associations
+      has_many_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
+
+    def columns
+      model.columns.reject { |c| excluded_column?(c.name) }
+    end
+
+    def enhancement_for(property_name)
+      schema_enhancements&.dig(:properties, property_name.to_sym) || {}
+    end
+
+    def has_many_associations
+      model.reflect_on_all_associations(:has_many)
+    end
+
+    def has_one_associations
+      model.reflect_on_all_associations(:has_one)
+    end
+
+    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
+
+    def build_title
+      schema_enhancements[:model_title].presence || model.name.demodulize.humanize
+    end
+
+    def build_description
+      schema_enhancements[:model_description].presence
+    end
+
+    def name
+      model.name
+    end
+
+    def schema_enhancements
+      if model.respond_to?(:schema_enhancements)
+        model.schema_enhancements
+      else
+        {}
+      end
+    end
+
+    def config
+      Esquema.configuration
+    end
+  end
+end

data/lib/esquema/configuration.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Esquema
+  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/model.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+require_relative "builder"
+require_relative "schema_enhancer"
+
+module Esquema
+  module Model
+    extend ActiveSupport::Concern
+
+    included do
+      def self.json_schema
+        Esquema::Builder.new(self).build_schema.to_json
+      end
+
+      def self.enhance_schema(&block)
+        schema_enhancements
+        enhancer = SchemaEnhancer.new(self, @schema_enhancements)
+        enhancer.instance_eval(&block)
+      end
+
+      def self.schema_enhancements
+        @schema_enhancements ||= {}
+      end
+    end
+  end
+end

data/lib/esquema/property.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require_relative "type_caster"
+module Esquema
+  class Property
+    DB_TO_JSON_TYPE_MAPPINGS = {
+      date: "date",
+      datetime: "date-time",
+      time: "time",
+      string: "string",
+      text: "string",
+      integer: "integer",
+      float: "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
+      @options = options
+    end
+
+    def as_json
+      ATTRS.each_with_object({}) do |property, hash|
+        value = send("build_#{property}")
+        next if value.nil? || (value.is_a?(String) && value.empty?)
+
+        hash[property] = value
+      end.compact
+    end
+
+    def build_title
+      options[:title].presence || property.name.to_s.humanize
+    end
+
+    def build_default
+      return unless property.respond_to?(:default)
+
+      default_value = property.default || options[:default].presence
+
+      @default = TypeCaster.cast(property.type, default_value) unless default_value.nil?
+    end
+
+    def build_type
+      return DB_TO_JSON_TYPE_MAPPINGS[:array] if property.try(:collection?)
+
+      @type = DB_TO_JSON_TYPE_MAPPINGS[property.type]
+    end
+
+    def build_item_type
+      return unless property.respond_to?(:item_type)
+
+      @item_type = property.item_type if property.type == :array
+    end
+
+    def build_description
+      options[:description]
+    end
+
+    def build_items
+      return unless property.try(:collection?)
+
+      class_name = property.class_name.constantize
+      @items = Builder.new(class_name).build_schema
+    end
+
+    def build_enum
+      options[:enum]
+    end
+  end
+end

data/lib/esquema/schema_enhancer.rb

@@ -0,0 +1,65 @@
+require "date"
+require "bigdecimal"
+
+module Esquema
+  class SchemaEnhancer
+    VALID_OPTIONS = %i[title description maxLength minLength pattern maxItems minItems uniqueItems
+                       maxProperties minProperties properties additionalProperties dependencies
+                       enum format multipleOf maximum exclusiveMaximum minimum exclusiveMinimum
+                       const allOf anyOf oneOf not default].freeze
+
+    TYPE_MAPPINGS = {
+      date: Date,
+      datetime: DateTime,
+      time: Time,
+      string: String,
+      text: String,
+      integer: Integer,
+      float: Float,
+      decimal: BigDecimal,
+      boolean: [TrueClass, FalseClass],
+      array: Array,
+      object: Object
+    }.freeze
+    attr_reader :model
+
+    def initialize(model, schema_enhancements)
+      @schema_enhancements = schema_enhancements
+      @model = model
+    end
+
+    def model_description(description)
+      @schema_enhancements[:model_description] = description
+    end
+
+    def model_title(title)
+      @schema_enhancements[:model_title] = title
+    end
+
+    def property(name, options = {})
+      db_type = model.type_for_attribute(name).type
+      klass_type = Array(TYPE_MAPPINGS[db_type])
+
+      validate_default_value(options[:default], klass_type, db_type)
+      validate_enum_values(options[:enum], klass_type, db_type)
+
+      options.assert_valid_keys(VALID_OPTIONS)
+      @schema_enhancements[:properties] ||= {}
+      @schema_enhancements[:properties][name] = options
+    end
+
+    private
+
+    def validate_default_value(default_value, klass_type, db_type)
+      return unless default_value.present? && !klass_type.include?(default_value.class)
+
+      raise ArgumentError, "Default value must be of type #{db_type}"
+    end
+
+    def validate_enum_values(enum_values, klass_type, db_type)
+      return unless enum_values.present? && !enum_values.all? { |value| klass_type.include?(value.class) }
+
+      raise ArgumentError, "Enum values must be of type #{db_type}"
+    end
+  end
+end

data/lib/esquema/type_caster.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Esquema
+  module TypeCaster
+    def self.cast(type, value) # rubocop:disable Metrics/MethodLength
+      case type
+      when :string, :text
+        value.to_s
+      when :integer
+        begin
+          Integer(value)
+        rescue StandardError
+          nil
+        end
+      when :float
+        begin
+          Float(value)
+        rescue StandardError
+          nil
+        end
+      when :boolean
+        case value
+        when true, "true", "1", 1
+          true
+        when false, "false", "0", 0
+          false
+        else
+          nil # or handle as desired
+        end
+      when :array
+        Array(value)
+      when :object
+        value.is_a?(Hash) ? value : nil # or convert as desired
+      when :null
+        nil if value.nil?
+      else
+        raise ArgumentError, "Unsupported type: #{type}"
+      end
+    end
+  end
+end

data/lib/esquema/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Esquema
+  VERSION = "0.1.0"
+end

data/lib/esquema.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative "esquema/version"
+require_relative "esquema/configuration"
+require_relative "esquema/model"
+
+module Esquema
+end

data/lib/generators/esquema/install/install_generator.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+
+module Esquema
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+
+      def copy_initializer_file
+        template "esquema_initializer.rb", "config/initializers/esquema.rb"
+      end
+    end
+  end
+end

data/lib/generators/esquema/install/templates/esquema_initializer.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "esquema"
+
+Esquema.configure do |config|
+  # Exclude Associations:
+  # Exclude associated models from the json-schema output.
+  # By default, all associated models are included.
+  config.exclude_associations = false
+
+  # Exclude Foreign Keys:
+  # Specify whether or not to exclude foreign keys from the json-schema output.
+  # By default, foreign keys are excluded.
+  # foreign keys are loosely defined as columns that end with "_id".
+  config.exclude_foreign_keys = true
+
+  # Excluded Columns:
+  # Specify the columns that you want to exclude from the json-schema output.
+  # These are columns common to all models, such as id, created_at, updated_at, etc.
+  # It's okay if not all models have these columns, they will be ignored.
+  config.excluded_columns = %i[id created_at updated_at deleted_at]
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: esquema
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sergio Bayona
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-02-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.10.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.10.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.1'
+description: Generate json-schema from ActiveRecord models.
+email:
+- bayona.sergio@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- esquema.gemspec
+- lib/esquema.rb
+- lib/esquema/builder.rb
+- lib/esquema/configuration.rb
+- lib/esquema/model.rb
+- lib/esquema/property.rb
+- lib/esquema/schema_enhancer.rb
+- lib/esquema/type_caster.rb
+- lib/esquema/version.rb
+- lib/generators/esquema/install/install_generator.rb
+- lib/generators/esquema/install/templates/esquema_initializer.rb
+homepage: https://esquema.co
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://esquema.co
+  source_code_uri: https://github.com/sergiobayona/esquema
+  changelog_uri: https://github.com/sergiobayona/esquema/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.3
+signing_key:
+specification_version: 4
+summary: Generate json-schema from ActiveRecord models.
+test_files: []