schemable 0.1.3 → 1.0.0

data/lib/templates/schemable.rb

@@ -0,0 +1,76 @@
+Schemable.configure do |config|
+  # The following options are available for configuration.
+  # If you do not specify a configuration option, then its default value will be used.
+  # To configure them, uncomment them and set them to the desired value.
+
+  # The ORM options are :active_record, :mongoid
+  #
+  # config.orm = :active_record
+
+  # The gem uses `{ type: :number, format: :float }` for float attributes by default.
+  # If you want to use `{ type: :string }` instead, set this option to true.
+  #
+  # config.float_as_string = false
+
+  # The gem uses `{ type: :number, format: :decimal }` for decimal attributes by default.
+  # If you want to use `{ type: :string }` instead, set this option to true.
+  #
+  # config.decimal_as_string = false
+
+  # The gem by default sets the pagination_enabled option to true
+  # which means in the meta section of the response schema
+  # it will add the pagination links and the total count
+  # if you don't want to have the pagination links and the total count
+  # in the meta section of the response schema, set this option to false
+  # If you want to define your own meta schema, you can set the custom_meta_response_schema option
+  #
+  # config.pagination_enabled = true
+  #
+  # config.custom_meta_response_schema = nil
+
+  # The gem allows for custom defined schema for a specific type
+  # for example if you wish to have all your arrays have the schema
+  # { type: :array, items: { type: string } } then use the below method to add to custom_type_mappers
+  #
+  # config.add_custom_type_mapper(:array, { type: :array, items: { type: string } })
+
+  # If you have a custom enum method defined on all of your model, you can set it here
+  # for example if you have a method called `base_attributes` on all of your models
+  # and you use that method to return an array of symbols that are the attributes
+  # to be serialized then you can set the below to `base_attributes`
+  #
+  # config.infer_attributes_from_custom_method = nil
+
+  # If you want to get the list of attributes from the jsonapi-rails gem's
+  # JSONAPI::Serializable::Resource class, set this option to true.
+  # It uses the attribute_blocks method to get the list of attributes.
+  #
+  # config.infer_attributes_from_jsonapi_serializable = false
+
+  # Sometimes you may have virtual attributes that are not in the database
+  # Generating the schema for these attributes will fail, in that case you can
+  # add your logic to return an instance of the model that is serialized in
+  # jsonapi format and the gem will use that to generate the schema
+  # this is useful if you use factory_bot and jsonapi-rails to generate the instance
+  # check the commented out code in the definition template for an example
+  # Set this option to true to enable this feature
+  #
+  # config.use_serialized_instance = false
+
+  # By default the gem uses activerecord's defined_enums method to get the enums
+  # with their keys and values, if you don't have this method defined on your model
+  # then please set the below option to the name of the method that returns the
+  # enums with their keys and values as a hash. This will handle the auto generation
+  # of the enum schema for you, with correct values.
+  #
+  # config.custom_defined_enum_method = nil
+
+  # If you use mongoid and simple_enum gem, you can set the below options to the prefix and suffix
+  # Since simple_enum uses the prefix and suffix to generate the enum methods, and the fields' names
+  # are usually the enum name with the prefix and suffix, the gem will remove the prefix and suffix
+  # from the field name to get the enum name and then use that to get the enum values
+  #
+  # config.enum_prefix_for_simple_enum = nil
+  #
+  # config.enum_suffix_for_simple_enum = nil
+end

data/schemable.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.authors = ['Muhammad Nawzad']
   spec.email = ['hama127n@gmail.com']
 
-  spec.summary = 'An opiniated Gem for Rails applications to auto generate schema in JSONAPI format.'
-  spec.description = "The schemable gem is an opiniated Gem for Rails applications to auto generate schema for models in JSONAPI format. It is designed to work with rswag's swagger documentation since it can generate the schemas for it."
+  spec.summary = 'An opinionated Gem for Rails applications to auto generate schema in JSONAPI format.'
+  spec.description = "The schemable gem is an opinionated Gem for Rails applications to auto generate schema for models in JSONAPI format. It is designed to work with rswag's swagger documentation since it can generate the schemas for it."
   spec.homepage = 'https://github.com/muhammadnawzad/schemable'
   spec.license = 'MIT'
   spec.required_ruby_version = '>= 3.1.2'
@@ -29,8 +29,5 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'factory_bot_rails', '~> 6.2.0'
-  spec.add_dependency 'jsonapi-rails', '~> 0.4.1'
-
   spec.metadata['rubygems_mfa_required'] = 'true'
 end

data/sig/schemable/attribute_schema_generator.rbs

@@ -0,0 +1,13 @@
+module Schemable
+  class AttributeSchemaGenerator
+    attr_reader model: Class
+    attr_reader model_definition: Definition
+    attr_reader configuration: Configuration
+    attr_reader response: Hash[Symbol, any]?
+    attr_reader schema_modifier: SchemaModifier
+
+    def initialize: (Definition) -> void
+    def generate: -> (Hash[Symbol, any] | Array[any])
+    def generate_attribute_schema: (Symbol) -> Hash[Symbol, any]
+  end
+end

data/sig/schemable/configuration.rbs

@@ -0,0 +1,21 @@
+module Schemable
+  class Configuration
+    attr_accessor orm: Symbol
+    attr_accessor float_as_string: bool
+    attr_accessor decimal_as_string: bool
+    attr_accessor pagination_enabled: bool
+    attr_accessor use_serialized_instance: bool
+    attr_accessor custom_defined_enum_method: Symbol?
+    attr_accessor enum_prefix_for_simple_enum: String?
+    attr_accessor enum_suffix_for_simple_enum: String?
+    attr_accessor custom_type_mappers: Hash[Symbol, any]
+    attr_accessor infer_attributes_from_custom_method: Symbol?
+    attr_accessor custom_meta_response_schema: Hash[Symbol, any]?
+    attr_accessor infer_attributes_from_jsonapi_serializable: bool
+
+
+    def initialize: -> void
+    def type_mapper: (Symbol) -> Hash[Symbol, any]
+    def add_custom_type_mapper: (Symbol, Hash[Symbol, any]) -> void
+  end
+end

data/sig/schemable/definition.rbs

@@ -0,0 +1,32 @@
+module Schemable
+  class Definition
+    attr_reader configuration: Configuration
+    attr_writer relationships: Hash[Symbol, any]
+    attr_writer additional_create_request_attributes: Hash[Symbol, any]
+    attr_writer additional_update_request_attributes: Hash[Symbol, any]
+
+    def model: -> Class
+    def initialize: -> void
+    def serializer: -> Class?
+    def model_name: -> String
+    def attributes: -> Array[Symbol]
+    def array_types: -> Hash[Symbol, any]
+    def relationships: -> Hash[Symbol, any]
+    def nullable_attributes: -> Array[Symbol]
+    def serialized_instance: -> Hash[Symbol, any]
+    def self.generate: -> Array[Hash[Symbol, any]]
+    def excluded_response_included: -> Array[Symbol]
+    def excluded_response_relations: -> Array[Symbol]
+    def excluded_response_attributes: -> Array[Symbol]
+    def additional_response_included: -> Hash[Symbol, any]
+    def additional_response_relations: -> Hash[Symbol, any]
+    def additional_response_attributes: -> Hash[Symbol, any]
+    def excluded_create_request_attributes: -> Array[Symbol]
+    def excluded_update_request_attributes: -> Array[Symbol]
+    def optional_create_request_attributes: -> Array[Symbol]
+    def optional_update_request_attributes: -> Array[Symbol]
+    def additional_create_request_attributes: -> Hash[Symbol, any]
+    def additional_update_request_attributes: -> Hash[Symbol, any]
+    def camelize_keys: (Hash[Symbol, any]) -> (Array[Hash[Symbol, any]] | Hash[Symbol, any])
+  end
+end

data/sig/schemable/included_schema_generator.rbs

@@ -0,0 +1,11 @@
+module Schemable
+  class IncludedSchemaGenerator
+    attr_reader model_definition: Definition
+    attr_reader schema_modifier: SchemaModifier
+    attr_reader relationships: Hash[Symbol, any]
+
+    def initialize: (Definition) -> void
+    def generate: (?relationships_to_exclude_from_expansion: Array[String], ?expand: bool) -> (Hash[Symbol, any])
+    def prepare_schema_for_included: (Definition, ?relationships_to_exclude_from_expansion: Array[String], ?expand: bool) -> Hash[Symbol, any]
+  end
+end

data/sig/schemable/relationship_schema_generator.rbs

@@ -0,0 +1,11 @@
+module Schemable
+  class RelationshipSchemaGenerator
+    attr_reader model_definition: Definition
+    attr_reader schema_modifier: SchemaModifier
+    attr_reader relationships: Hash[Symbol, any]
+
+    def initialize: (Definition) -> void
+    def generate_schema: (String, ?collection: bool) -> Hash[Symbol, any]
+    def generate: (?relationships_to_exclude_from_expansion: Array[String], ?expand: bool) -> (Hash[Symbol, any])
+  end
+end

data/sig/schemable/request_schema_generator.rbs

@@ -0,0 +1,10 @@
+module Schemable
+  class RequestSchemaGenerator
+    attr_reader model_definition: Definition
+    attr_reader schema_modifier: SchemaModifier
+
+    def initialize: (Definition) -> void
+    def generate_for_create: () -> (Hash[Symbol, any])
+    def generate_for_update: () -> (Hash[Symbol, any])
+  end
+end

data/sig/schemable/response_schema_generator.rbs

@@ -0,0 +1,13 @@
+module Schemable
+  class ResponseSchemaGenerator
+    attr_reader model: Class
+    attr_reader model_definition: Definition
+    attr_reader schema_modifier: SchemaModifier
+    attr_reader configuration: Configuration
+
+    def initialize: (Definition) -> void
+    def meta: -> Hash[Symbol, any]
+    def jsonapi: -> Hash[Symbol, any]
+    def generate: (expand: bool, relationships_to_exclude_from_expansion: Array[Symbol], collection: bool) -> Hash[Symbol, any]
+  end
+end

data/sig/schemable/schema_modifier.rbs

@@ -0,0 +1,9 @@
+module Schemable
+  class SchemaModifier
+    def parse_path: (path: String) -> Array[Symbol]
+    def path_exists?: (schema: Hash[Symbol, any], path: String) -> bool
+    def deep_merge_hashes: (destination: Hash[Symbol, any], new_data: Hash[Symbol, any]) -> (Hash[Symbol, any])
+    def add_properties: (original_schema: (Hash[Symbol, any]), new_schema: Hash[Symbol, any], path: String) -> (Hash[Symbol, any])
+    def delete_properties: (original_schema: (Hash[Symbol, any]), path: String) -> (Hash[Symbol, any])
+  end
+end

data/sig/schemable.rbs

@@ -1,4 +1,7 @@
 module Schemable
   VERSION: String
-  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+
+  attr_accessor configuration: Configuration
+
+  def configure: () { (Configuration) -> Configuration } -> Configuration
 end

metadata

@@ -1,44 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: schemable
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 1.0.0
 platform: ruby
 authors:
 - Muhammad Nawzad
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-07-29 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: factory_bot_rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 6.2.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 6.2.0
-- !ruby/object:Gem::Dependency
-  name: jsonapi-rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.4.1
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.4.1
-description: The schemable gem is an opiniated Gem for Rails applications to auto
+date: 2023-11-17 00:00:00.000000000 Z
+dependencies: []
+description: The schemable gem is an opinionated Gem for Rails applications to auto
   generate schema for models in JSONAPI format. It is designed to work with rswag's
   swagger documentation since it can generate the schemas for it.
 email:
@@ -59,11 +31,26 @@ files:
 - lib/generators/schemable/install_generator.rb
 - lib/generators/schemable/model_generator.rb
 - lib/schemable.rb
+- lib/schemable/attribute_schema_generator.rb
+- lib/schemable/configuration.rb
+- lib/schemable/definition.rb
+- lib/schemable/included_schema_generator.rb
+- lib/schemable/relationship_schema_generator.rb
+- lib/schemable/request_schema_generator.rb
+- lib/schemable/response_schema_generator.rb
+- lib/schemable/schema_modifier.rb
 - lib/schemable/version.rb
-- lib/templates/common_definitions.rb
-- lib/templates/serializers_helper.rb
+- lib/templates/schemable.rb
 - schemable.gemspec
 - sig/schemable.rbs
+- sig/schemable/attribute_schema_generator.rbs
+- sig/schemable/configuration.rbs
+- sig/schemable/definition.rbs
+- sig/schemable/included_schema_generator.rbs
+- sig/schemable/relationship_schema_generator.rbs
+- sig/schemable/request_schema_generator.rbs
+- sig/schemable/response_schema_generator.rbs
+- sig/schemable/schema_modifier.rbs
 homepage: https://github.com/muhammadnawzad/schemable
 licenses:
 - MIT
@@ -88,9 +75,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.1
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
-summary: An opiniated Gem for Rails applications to auto generate schema in JSONAPI
+summary: An opinionated Gem for Rails applications to auto generate schema in JSONAPI
   format.
 test_files: []

data/lib/templates/common_definitions.rb

@@ -1,13 +0,0 @@
-module SwaggerDefinitions
-  module CommonDefinitions
-    def self.aggregate
-      [
-        # Import definitions like this:
-        # Swagger::Definitions::Model.definitions
-
-        # Make sure in swagger_helper.rb's components section you have:
-        # schemas: SwaggerDefinitions::CommonDefinitions.aggregate
-      ].flatten.reduce({}, :merge)
-    end
-  end
-end

data/lib/templates/serializers_helper.rb

@@ -1,7 +0,0 @@
-module SerializersHelper
-  def serializers_map
-    {
-      # TheModel: V1::TheModelSerializer
-    }.freeze
-  end
-end