active_json_schema 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cdfca17ff6cc30e98bba49122db2b8072a3bedf880486ce80574dde8e73d74ba
+  data.tar.gz: 6209512ebddb4a3903f1ad1762ad16a76a998ddc59a031d7a88a2aefc34ca137
+SHA512:
+  metadata.gz: f3643c51ef453e218e320617d6521548903734e3c47efb0c22a2bd0fe2b167f07fe85356ee1c6fbe797e6d19cc2a13c38d7bae9675206d86dd769ccdfbfdc479
+  data.tar.gz: fb09e2a10dd66bd4431a2281c4637f8a552be34620726894b06c76a98be125519f058a64a20b4b1b845bf468eea89c8ebba52a60bea2d6a2ed46246e5346d0d1

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/standardrb/standard
+ruby_version: 3.0

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+## [Unreleased]
+
+### Added
+- Comprehensive README with installation instructions, usage examples, and customization options
+- Filled in gemspec with summary, description, and metadata
+- Support for generating JSON Schema for ActiveRecord models
+- Customizable schema generation with options for specific attributes and associations
+- Ability to include nested associations in schema generation
+
+## [0.1.0] - 2024-10-08
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Kaleb Lape
+
+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,134 @@
+# ActiveJsonSchema
+
+ActiveJsonSchema is a Ruby gem that extends ActiveRecord models to generate JSON Schema representations. It provides an easy way to create JSON Schema definitions for your ActiveRecord models, including support for associations.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "active_json_schema"
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install active_json_schema
+```
+
+## Usage
+
+### Basic Usage
+
+To use ActiveJsonSchema in your ActiveRecord models, include the `ActiveJsonSchema::ToJsonSchema` module:
+
+```ruby
+class User < ActiveRecord::Base
+  include ActiveJsonSchema::ToJsonSchema
+
+  has_many :posts
+end
+
+class Post < ActiveRecord::Base
+  include ActiveJsonSchema::ToJsonSchema
+
+  belongs_to :user
+end
+```
+
+Now you can generate JSON Schema for your models:
+
+```ruby
+user_schema = User.to_json_schema
+puts user_schema
+```
+
+This will output a JSON Schema representation of the User model, including all its attributes.
+
+### Customizing Schema Generation
+
+You can customize the schema generation by passing options to the `to_json_schema` method:
+
+```ruby
+# Generate schema for specific attributes only
+user_schema = User.to_json_schema(only: %w[name email])
+
+# Include associations in the schema
+user_schema = User.to_json_schema(associations: %w[posts])
+
+# Customize association options
+user_schema = User.to_json_schema(associations: { posts: { only: %w[title content] } })
+
+# Allow additional properties
+user_schema = User.to_json_schema(additional_properties: true)
+```
+
+### Working with Associations
+
+ActiveJsonSchema supports generating schemas for associated models:
+
+```ruby
+class User < ActiveRecord::Base
+  include ActiveJsonSchema::ToJsonSchema
+
+  has_many :posts
+end
+
+user_schema = User.to_json_schema(associations: %w[posts])
+```
+
+This will include a `posts_attributes` property in the User schema, referencing the Post schema definition.
+
+### Overriding Default Behavior
+
+You can override the default `to_json_schema` method in your models for more control:
+
+```ruby
+class Post < ActiveRecord::Base
+  include ActiveJsonSchema::ToJsonSchema
+
+  def self.to_json_schema(only: %w[title content], **)
+    super
+  end
+end
+```
+
+This example will always include only the 'title' and 'content' attributes in the Post schema unless specified otherwise.
+
+## Examples
+
+Here are some more examples to illustrate the usage:
+
+```ruby
+# Generate schema for User model with all attributes
+User.to_json_schema
+
+# Generate schema for User model with specific attributes and associations
+User.to_json_schema(only: %w[name email], associations: %w[posts])
+
+# Generate schema for Post model with customized association
+Post.to_json_schema(associations: { user: { only: %w[name] } })
+
+# Generate schema with nested associations
+User.to_json_schema(associations: { posts: { associations: %w[comments] } })
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/pingortle/active_json_schema. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](CODE_OF_CONDUCT.md).
+
+## 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,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "standard/rake"
+
+task default: %i[test standard]

data/lib/active_json_schema/converts_to_json_schema_with_refs.rb

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+class ConvertsToJsonSchemaWithRefs
+  class UnsupportedAssociationType < StandardError; end
+
+  def self.generate(model_class, only: nil, associations: {}, additional_properties: false)
+    new(model_class, only: only, associations: associations, additional_properties: additional_properties).generate
+  end
+
+  def initialize(model_class, only: nil, associations: [], additional_properties: false)
+    @model_class = model_class
+    @only = only
+    @associations = associations.is_a?(Array) ? associations.to_h { |a| [a, {}] } : associations
+    @additional_properties = additional_properties
+    @definitions = {}
+  end
+
+  def generate
+    schema = {
+      type: "object",
+      properties: properties_for(@model_class, @only, @associations),
+      required: required_properties(@model_class, @only),
+      additionalProperties: @additional_properties
+    }
+    schema[:definitions] = @definitions unless @definitions.empty?
+    schema
+  end
+
+  private
+
+  def properties_for(model_class, only, associations)
+    puts "properties_for(...)"
+    puts "model_class: #{model_class}"
+    puts "only: #{only}"
+    puts "associations: #{associations}"
+    puts
+
+    properties = {}
+
+    model_class.columns_hash.each do |column_name, column_info|
+      next unless only.nil? || only.include?(column_name)
+
+      properties[column_name] = column_to_json_property(column_info)
+    end
+
+    puts "associations.each do |association_name, options|"
+    associations.each do |association_name, options|
+      puts "association_name: #{association_name}"
+      association = model_class.reflect_on_association(association_name)
+      puts "association: #{association}"
+      next unless association
+
+      definition_name = association.klass.name.underscore
+      if options.empty?
+        klass = association.klass
+        unless klass.ancestors.include?(ActiveJsonSchema::ToJsonSchema)
+          raise UnsupportedAssociationType.new("Please include ActiveJsonSchema::ToJsonSchema in #{klass} or specify association options.")
+        end
+
+        nested_schema = klass.to_json_schema
+        @definitions.merge!(nested_schema[:definitions] || {})
+        @definitions[definition_name] ||= nested_schema.except(:definitions)
+      else
+        @definitions[definition_name] ||= generate_definition(association.klass, options)
+      end
+
+      property_name = "#{association_name}_attributes"
+      properties[property_name] = association_to_json_property(association, definition_name)
+    end
+
+    properties
+  end
+
+  def generate_definition(model_class, options)
+    puts "generate_definition(...)"
+    puts "model_class: #{model_class}"
+    puts "options: #{options}"
+    only = options[:only]
+    nested_associations = options[:associations] || {}
+
+    {
+      type: "object",
+      properties: properties_for(model_class, only, nested_associations),
+      required: required_properties(model_class, only)
+    }
+  end
+
+  def required_properties(model_class, only)
+    model_class.columns_hash.select do |column_name, column_info|
+      (only.nil? || only.include?(column_name)) && !column_info.null
+    end.keys
+  end
+
+  def column_to_json_property(column_info)
+    property = {type: sql_type_to_json_type(column_info.type)}
+
+    case column_info.type
+    when :string, :text
+      property[:maxLength] = column_info.limit if column_info.limit
+    when :integer, :bigint
+      property[:minimum] = 0 if column_info.sql_type.include?("unsigned")
+    when :decimal
+      property[:multipleOf] = 10**-column_info.scale if column_info.scale
+    end
+
+    property
+  end
+
+  def association_to_json_property(association, definition_name)
+    case association.macro
+    when :has_many, :has_and_belongs_to_many
+      {
+        type: "array",
+        items: {"$ref": "#/definitions/#{definition_name}"}
+      }
+    when :belongs_to, :has_one
+      {"$ref": "#/definitions/#{definition_name}"}
+    else
+      raise "Unsupported association type: #{association.macro}"
+    end
+  end
+
+  def sql_type_to_json_type(sql_type)
+    case sql_type
+    when :string, :text
+      "string"
+    when :integer, :bigint
+      "integer"
+    when :float, :decimal
+      "number"
+    when :boolean
+      "boolean"
+    when :date, :datetime, :time
+      "string"
+    else
+      "string"
+    end
+  end
+end

data/lib/active_json_schema/to_json_schema.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module ActiveJsonSchema
+  module ToJsonSchema
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def to_json_schema(only: nil, associations: {}, additional_properties: false)
+        ConvertsToJsonSchemaWithRefs.generate(self, only: only, associations: associations, additional_properties: additional_properties)
+      end
+    end
+  end
+end

data/lib/active_json_schema/version.rb

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

data/lib/active_json_schema.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative "active_json_schema/version"
+
+module ActiveJsonSchema
+  class Error < StandardError; end
+  require_relative "active_json_schema/converts_to_json_schema_with_refs"
+  require_relative "active_json_schema/to_json_schema"
+end

data/sig/active_json_schema.rbs

@@ -0,0 +1,4 @@
+module ActiveJsonSchema
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: active_json_schema
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kaleb Lape
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-10-08 00:00:00.000000000 Z
+dependencies: []
+description: ActiveJsonSchema extends ActiveRecord models to generate JSON Schema
+  representations, including support for associations.
+email:
+- kaleb.lape@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".standard.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/active_json_schema.rb
+- lib/active_json_schema/converts_to_json_schema_with_refs.rb
+- lib/active_json_schema/to_json_schema.rb
+- lib/active_json_schema/version.rb
+- sig/active_json_schema.rbs
+homepage: https://github.com/RailsQuest/active_json_schema
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/RailsQuest/active_json_schema
+  source_code_uri: https://github.com/RailsQuest/active_json_schema
+  changelog_uri: https://github.com/RailsQuest/active_json_schema/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: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.20
+signing_key:
+specification_version: 4
+summary: Generate JSON Schema representations for ActiveRecord models
+test_files: []