mortymer 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ecb9a7f658430de14fe07898f71288a63923707680c8a032de19ba6ede91c4a6
+  data.tar.gz: 034032b9168e5225d1c2a2fca5049c4436637aa8748e7e43376d0637fc4b3891
+SHA512:
+  metadata.gz: 6bae0bfe67e11f94216b6f04794c38bba579804780eeab91044e279d2da2a7beea076c2b42c7e644d639f0a2fb33b6ee5e64d84695301a6c74b6167980e8b5df
+  data.tar.gz: e34d25b038d008e2ec61f6bb949811d7f18b5d6d65bc379d45a9256e3436e17534faeaabddb2af97ea4f05ee533e56896d1818f06ac05a9bba370e0e6fedd10e

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 3.0.0
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-10-26
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at adriangonzalezsanchez1996@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Guardfile

@@ -0,0 +1,3 @@
+guard :shell do
+	watch(%r{^*\.rb}) { `rake spec` }
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Adrian Gonzalez
+
+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,167 @@
+# Morty
+
+```markdown
+███╗   ███╗ ██████╗ ██████╗ ████████╗██╗   ██╗
+████╗ ████║██╔═══██╗██╔══██╗╚══██╔══╝╚██╗ ██╔╝
+██╔████╔██║██║   ██║██████╔╝   ██║    ╚████╔╝ 
+██║╚██╔╝██║██║   ██║██╔══██╗   ██║     ╚██╔╝  
+██║ ╚═╝ ██║╚██████╔╝██║  ██║   ██║      ██║   
+╚═╝     ╚═╝ ╚═════╝ ╚═╝  ╚═╝   ╚═╝      ╚═╝   
+```
+
+Morty is a Ruby gem that simplifies API endpoint management and documentation for Ruby on Rails applications. It provides a clean DSL for defining API endpoints with input/output contracts and automatically generates OpenAPI documentation.
+
+[![Gem Version](https://badge.fury.io/rb/morty.svg)](https://badge.fury.io/rb/morty)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+## Features
+
+- 🚀 Simple DSL for defining API endpoints
+- 📝 Automatic OpenAPI documentation generation
+- ✨ Input/Output contract validation
+- 🎯 Dependency injection support
+- 🛣️ Seamless Rails integration
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'morty'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+## Usage
+
+### Basic Example
+
+```ruby
+class UserProfileEndpoint < ApplicationController
+  include Morty::ApiMetadata
+
+  # Define an endpoint with input/output contracts
+  get input: UserProfileInput, output: UserProfileOutput, path: '/api/v1/users/:id/profile'
+  def call(input)
+    user = User.find(input.id)
+    UserProfileOutput.new(
+      id: user.id,
+      name: user.name,
+      email: user.email
+    )
+  end
+end
+```
+
+### Input/Output Contracts
+
+```ruby
+class UserProfileInput < Morty::Model
+  attribute :id, Types::Integer
+  attribute :include_details, Types::Bool.optional.default(false)
+end
+
+class UserProfileOutput < Morty::Model
+  attribute :id, Types::Integer
+  attribute :name, Types::String
+  attribute :email, Types::String
+end
+```
+
+### Dependency Injection
+
+```ruby
+class UserService
+  include Morty::DependenciesDsl
+
+  # Inject dependencies
+  inject UserRepository
+  inject EmailService, as: :mailer
+
+  def process_user(id)
+    user = @user_repository.find_user(id)
+    @email_service.send_email(user.email, "Welcome!")
+  end
+end
+```
+
+### Rails Integration
+
+In your `config/routes.rb`:
+
+```ruby
+Rails.application.routes.draw do
+  Morty::Rails::Routes.new(self).mount_controllers
+end
+```
+
+## OpenAPI Documentation
+
+Morty automatically generates OpenAPI documentation for your API endpoints. The documentation includes:
+
+- Endpoint paths and HTTP methods
+- Request/response schemas
+- Input validation rules
+- Error responses
+
+To generate the OpenAPI documentation:
+
+```ruby
+generator = Morty::OpenapiGenerator.new(
+  prefix: "/api",
+  title: "My API",
+  version: "v1"
+)
+generator.generate
+```
+
+## Contributing
+
+We love your input! We want to make contributing to Morty as easy and transparent as possible, whether it's:
+
+- Reporting a bug
+- Discussing the current state of the code
+- Submitting a fix
+- Proposing new features
+- Becoming a maintainer
+
+### Development Process
+
+1. Fork the repo and create your branch from `master`
+2. If you've added code, please, add some tests to contribute to gem health
+3. If you've changed APIs, update the documentation accordingly
+4. Ensure the test suite passes
+5. Make sure your code lints
+6. Issue that pull request!
+
+### Running Tests
+
+```bash
+bundle install
+bundle exec rspec
+```
+
+## License
+
+MIT License. See [LICENSE](LICENSE) for details.
+
+## Code of Conduct
+
+This project follows the [Contributor Covenant](https://www.contributor-covenant.org/version/2/0/code_of_conduct/) Code of Conduct.
+
+## Support
+
+If you have any questions or need help with Morty:
+
+- Open an [issue](https://github.com/yourusername/morty/issues)
+- Join our [Discord community](#) (coming soon)
+
+## Credits
+
+Morty is maintained by [Adrian Gonzalez] and was inspired by the need for a simple,
+yet powerful API management solution in the Ruby ecosystem, that integrates well
+with existing frameworks. We deserve a FastAPI experience within the ruby side.

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/config.ru

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require_relative "lib/morty"
+
+run Morty::App.new

data/docs/.vitepress/config.mts

@@ -0,0 +1,73 @@
+import { defineConfig } from "vitepress";
+
+// https://vitepress.dev/reference/site-config
+export default defineConfig({
+  title: "Morty",
+  description:
+    "Standalone API definition for ruby frameworks based on dry.rb. Rails compatible from day 0 with a full Ruby flavored dependency injection engine.",
+  markdown: {
+    theme: "catppuccin-mocha",
+  },
+  themeConfig: {
+    nav: [
+      { text: "Guide", link: "/guide/introduction" },
+      { text: "API", link: "/api/" },
+      {
+        text: "GitHub",
+        link: "https://github.com/adriangs1996/morty",
+      },
+    ],
+
+    sidebar: {
+      "/guide/": [
+        {
+          text: "Getting Started",
+          items: [
+            { text: "Introduction", link: "/guide/introduction" },
+            { text: "Quick Start", link: "/guide/quick-start" },
+            { text: "Installation", link: "/guide/installation" },
+          ],
+        },
+        {
+          text: "Core Concepts",
+          items: [
+            { text: "API Metadata", link: "/guide/api-metadata" },
+            { text: "Type System", link: "/guide/type-system" },
+            {
+              text: "Dependency Injection",
+              link: "/guide/dependency-injection",
+            },
+            { text: "Error Handling", link: "/guide/error-handling" },
+          ],
+        },
+        {
+          text: "Rails Integration",
+          items: [
+            { text: "Setup", link: "/guide/rails-setup" },
+            { text: "Routing", link: "/guide/routing" },
+            { text: "Controllers", link: "/guide/controllers" },
+            { text: "Testing", link: "/guide/testing" },
+          ],
+        },
+        {
+          text: "Advanced",
+          items: [
+            { text: "OpenAPI Generation", link: "/guide/openapi" },
+            { text: "Custom Types", link: "/guide/custom-types" },
+            { text: "Middleware", link: "/guide/middleware" },
+            { text: "Configuration", link: "/guide/configuration" },
+          ],
+        },
+      ],
+    },
+
+    socialLinks: [
+      { icon: "github", link: "https://github.com/yourusername/morty" },
+    ],
+
+    footer: {
+      message: "Released under the MIT License.",
+      copyright: "Copyright © 2024-present",
+    },
+  },
+});

data/docs/.vitepress/theme/Layout.vue

@@ -0,0 +1,21 @@
+<script setup lang="ts">
+import { useData } from 'vitepress'
+
+// https://vitepress.dev/reference/runtime-api#usedata
+const { site, frontmatter } = useData()
+</script>
+
+<template>
+  <div v-if="frontmatter.home">
+    <h1>{{ site.title }}</h1>
+    <p>{{ site.description }}</p>
+    <ul>
+      <li><a href="/markdown-examples.html">Markdown Examples</a></li>
+      <li><a href="/api-examples.html">API Examples</a></li>
+    </ul>
+  </div>
+  <div v-else>
+    <a href="/">Home</a>
+    <Content />
+  </div>
+</template>

data/docs/.vitepress/theme/index.ts

@@ -0,0 +1,5 @@
+// https://vitepress.dev/guide/custom-
+import DefaultTheme from "vitepress/theme";
+import "@catppuccin/vitepress/theme/mocha/green.css";
+
+export default DefaultTheme;

data/docs/.vitepress/theme/style.css

@@ -0,0 +1,5 @@
+
+html {
+  font-family: Arial, Helvetica;
+}
+

data/docs/advanced/dependency-injection.md

@@ -0,0 +1,21 @@
+# Dependency Injection
+
+Morty provides a powerful dependency injection system
+that helps you write clean, testable code.
+
+## Basic Usage
+
+```ruby
+class UserService
+  include Morty::DependenciesDsl
+
+  inject EmailService
+  inject UserRepository
+
+  def process_user(id)
+    user = user_repository.find(id)
+    email_service.send_welcome_email(user)
+  end
+end
+
+```

data/docs/advanced/openapi.md

@@ -0,0 +1,16 @@
+# OpenAPI Documentation
+
+Morty automatically generates OpenAPI (Swagger)
+documentation from your endpoints and models.
+
+## Basic Configuration
+
+```ruby
+# config/initializers/morty.rb
+Rails.application.config.morty.configure do |config|
+  config.openapi.title = "My API"
+  config.openapi.version = "v1"
+  config.openapi.description = "API documentation for My Application"
+end
+
+```

data/docs/guide/api-metadata.md

@@ -0,0 +1,142 @@
+# API Metadata
+
+The `ApiMetadata` module is a core component of Morty that allows you to define and configure API endpoints in your Ruby classes. It provides a clean DSL for declaring HTTP endpoints with their input/output types and automatically handles endpoint registration and Rails integration.
+
+## Basic Usage
+
+Include the `ApiMetadata` module in your endpoint classes to use the DSL:
+
+````ruby
+class UserEndpoint
+  include Morty::ApiMetadata
+
+  # Define a GET endpoint
+  get input: UserSearchInput,
+      output: UserSearchOutput
+
+  def call(input)
+    # Your endpoint logic here
+    UserSearchOutput.new(...)
+  end
+end
+# API Metadata
+
+The `ApiMetadata` module is a core component of Morty that allows you to define and configure API endpoints in your Ruby classes. It provides a clean DSL for declaring HTTP endpoints with their input/output types and automatically handles endpoint registration and Rails integration.
+
+## Basic Usage
+
+Include the `ApiMetadata` module in your endpoint classes to use the DSL:
+
+```ruby
+class UserEndpoint
+  include Morty::ApiMetadata
+
+  # Define a GET endpoint
+  get input: UserSearchInput,
+      output: UserSearchOutput
+
+  def call(input)
+    # Your endpoint logic here
+    UserSearchOutput.new(...)
+  end
+end
+````
+
+## HTTP Method DSL
+
+The module provides methods for all common HTTP verbs:
+
+- `get(input:, output:, path: nil)`
+- `post(input:, output:, path: nil)`
+- `put(input:, output:, path: nil)`
+- `delete(input:, output:, path: nil)`
+
+Each method accepts:
+
+- `input`: The class that defines the input schema/parameters
+- `output`: The class that defines the response schema
+- `path`: Optional custom path override (defaults to convention-based routing)
+
+## Method Names
+
+By default, Morty looks for either a `call` or `execute` method as the endpoint handler. You can use other method names, but the endpoint name will include the method name in its registration:
+
+```ruby
+class UserEndpoint
+  include Morty::ApiMetadata
+
+  # Registers as "UserEndpoint"
+  get input: SearchInput, output: SearchOutput
+  def call(input)
+    # ...
+  end
+
+  # Registers as "UserEndpoint#search"
+  get input: SearchInput, output: SearchOutput
+  def search(input)
+    # ...
+  end
+end
+```
+
+## Rails Integration
+
+When used in a Rails application with `config.morty.wrap_methods` enabled, the module automatically:
+
+1. Wraps endpoint methods to handle parameter conversion
+2. Transforms Rails params into your input class
+3. Renders JSON responses with proper status codes
+
+This means your endpoint methods can focus purely on business logic while Morty handles the HTTP/Rails integration.
+
+## OpenAPI Generation
+
+Endpoints defined with ApiMetadata automatically participate in OpenAPI documentation generation. The input and output classes are used to generate request/response schemas, and the HTTP method and path information is used to generate path documentation.
+
+See the [OpenAPI Documentation](../advanced/openapi.md) section for more details on how Morty generates API documentation.
+
+## Best Practices
+
+1. Keep endpoint classes focused on a single resource or concern
+2. Use meaningful input/output class names that reflect their purpose
+3. Consider using namespaces to organize related endpoints
+4. Let Morty handle the Rails integration rather than mixing Rails-specific code in your endpoints
+
+## Example
+
+Here's a complete example showing various features:
+
+```ruby
+module API
+  module V1
+    class UsersEndpoint
+      include Morty::ApiMetadata
+
+      # GET /api/v1/users
+      get input: Users::ListInput, output: Users::ListOutput
+      def list(input)
+        users = User.limit(input.limit).offset(input.offset)
+        Users::ListOutput.new(users: users)
+      end
+
+      # POST /api/v1/users
+      post input: Users::CreateInput, output: Users::CreateOutput
+      def create(input)
+        user = User.create!(input.to_h)
+        Users::CreateOutput.new(user: user)
+      end
+
+      # Custom path example
+      # PUT /api/v1/users/:id/activate
+      put input: Users::ActivateInput,
+          output: Users::ActivateOutput,
+          path: '/api/v1/users/:id/activate'
+      def activate(input)
+        user = User.find(input.id)
+        user.activate!
+        Users::ActivateOutput.new(user: user)
+      end
+    end
+  end
+end
+```

data/docs/guide/introduction.md

@@ -0,0 +1,31 @@
+# Introduction
+
+Morty is a modern Ruby gem designed to enhance API development with features
+present in most modern API-first frameworks, like FastAPI and bringing some goodies
+to the ruby ecosystem. It brings type safety, automatic documentation,
+and dependency injection to your APIs, while beign web framework agnostic and
+mantaining a good balance between explicitness and development experience.
+It provides a seamless integration with Ruby on Rails, but it could be used along side
+other frameworks like Sinatra or Grape.
+
+## Features
+
+- **Type-Safe APIs**: Define input and output types for your endpoints
+- **Automatic Documentation**: OpenAPI/Swagger documentation generation from your defined input and outputs.
+- **DI**: Dependency injection and clear separation of concerns through a simple DI Engine.
+- **Rails Integration**: Seamless integration with Ruby on Rails
+
+## Why Morty?
+
+Morty brings the best practices of modern API development to the Ruby ecosystem. Topics
+like API documentation is really painful, at least from my experience, in the Ruby world. There
+are a lot of alternatives, from general ones like Rswag to Grape's approach, but none of them
+feels intuitive or comfortable to use for me. In Rails' I personally hate the strong parameters
+features, I strongly believe that if you are able to define the shape of your enpoint, i.e, your contract,
+you should be able to use a fully Parsed object from your params, much like FastAPI's approach.
+Im tire of beign jelous of FastAPI and want to use Ruby in a similar way, that's when Morty was born.
+
+The name Morty comes from the popular series Rick and Morty, where Morty is like an assistant, a
+faithful companion. And that is what this gem aims to be, not a replacement for any existent framework,
+but a companion that allows the real heroes (Rails, Sinatra, Grape, etc) shine with their cool features,
+and not get bored with the API handling stuff.

data/docs/guide/models.md

@@ -0,0 +1,16 @@
+# Models
+
+Morty models provide a type-safe way to define your API's data structures.
+They're used for both input validation and output serialization.
+
+## Basic Model
+
+```ruby
+class UserModel < Morty::Model
+  attribute :id, Types::Integer
+  attribute :name, Types::String
+  attribute :email, Types::String
+  attribute :age, Types::Integer.optional
+end
+
+```