ditkrg/schemable
4
0
Fork 0
mirror of https://github.com/ditkrg/schemable.git synced 2026-01-22 22:26:41 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add documentation for AttributeSchemaGenerator class

Browse Source
This commit is contained in:
Muhammad Nawzad 2023-11-16 13:58:39 +03:00
parent e75e18c43b
commit c4a2af54e7
No known key found for this signature in database
GPG Key ID: B954B6AAE33940B2
1 changed files with 20 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
lib/schemable/attribute_schema_generator.rb
View File

@ -1,7 +1,16 @@
module Schemable module Schemable
# The AttributeSchemaGenerator class is responsible for generating JSON schemas for model attributes.
# It includes methods for generating the overall schema and individual attribute schemas.
#
# @see Schemable
class AttributeSchemaGenerator class AttributeSchemaGenerator
attr_reader :model_definition, :configuration, :model, :schema_modifier, :response attr_reader :model_definition, :configuration, :model, :schema_modifier, :response
# Initializes a new AttributeSchemaGenerator instance.
#
# @param model_definition [ModelDefinition] The model definition to generate the schema for.
# @example
# generator = AttributeSchemaGenerator.new(model_definition)
def initialize(model_definition) def initialize(model_definition)
@model_definition = model_definition @model_definition = model_definition
@model = model_definition.model @model = model_definition.model
@ -10,7 +19,11 @@ module Schemable
@response = nil @response = nil
end end
# Generate the JSON schema for attributes # Generates the JSON schema for the model attributes.
#
# @return [Hash] The generated schema.
# @example
# schema = generator.generate
def generate def generate
schema = { schema = {
type: :object, type: :object,
@ -37,7 +50,12 @@ module Schemable
schema schema
end end
# Generate the JSON schema for a specific attribute # Generates the JSON schema for a specific attribute.
#
# @param attribute [Symbol, String] The attribute to generate the schema for.
# @return [Hash] The generated schema for the attribute.
# @example
# attribute_schema = generator.generate_attribute_schema(:attribute_name)
def generate_attribute_schema(attribute) def generate_attribute_schema(attribute)
if @configuration.orm == :mongoid if @configuration.orm == :mongoid
# Get the column hash for the attribute # Get the column hash for the attribute