dry_schema_rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6a4f36b5c56fee74bae96b4dc58ad417771401e43a3ad09ea82a1af3ede0796b
+  data.tar.gz: 789431a29531e8bb001f4f5c59cf8edfa7f2a8d303a5ca8db2b5cace60a3dd85
+SHA512:
+  metadata.gz: 4944f5d17da6df9265ebb55fbc03a9452ed74ef07eb05d95266e88f0247605c6846855aa74db3bb577653ca00d3991afdbe38e542b03404dd6af8ac169aa6acc
+  data.tar.gz: 0ec54b772f7c76c3940aa36020d7cb89ab351734128f0c34e8c4538425114e838e32676ac43129bccab33195a2e40a4a7036de7ea49b2b55418bbd55ca225993

data/CHANGELOG.md

@@ -0,0 +1,40 @@
+# Changelog
+
+All notable changes to "dry_schema_rails" will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+- Initial development and features yet to be released.
+
+## [0.2.0] - 2023-10-20
+
+### Added
+- Feature X that does Y.
+- Improved documentation for feature Z.
+
+### Fixed
+- Bug that did Y under circumstance Z.
+
+### Changed
+- Refactored module X for better readability and performance.
+
+### Removed
+- Deprecated methods in module Y.
+
+## [0.1.0] - 2023-10-10
+
+### Added
+- Initial release of the gem.
+- Basic schema functionality.
+- Basic documentation on usage and installation.
+
+### Notes
+- This version serves as the foundational architecture for future features.
+
+[Unreleased]: https://github.com/your_username/dry_schema_rails/compare/v0.2.0...HEAD
+[0.2.0]: https://github.com/your_username/dry_schema_rails/compare/v0.1.0...v0.2.0
+[0.1.0]: https://github.com/your_username/dry_schema_rails/releases/tag/v0.1.0

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 David Rybolovlev
+
+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,164 @@
+# dry_schema_rails [![Gem Version](https://badge.fury.io/rb/dry_schema_rails.svg)](https://badge.fury.io/rb/dry_schema_rails)
+
+Simplify Your Schema Management in Rails.
+
+## Description
+
+DrySchemaRails is a lightweight gem that leverages `dry-schema` for defining schemas in a DRY and consistent manner across your Rails application. It encapsulates common schema definition functionalities, promoting a clean and easy-to-follow schema definition practice.
+
+## Key Features
+- **Concise Schema Definitions**: Write compact and clear schema definitions using block syntax.
+- **Reusable Schemas**: Create and reuse schema definitions across different parts of your application.
+- **Extendable**: Easily extend and customize your schema definitions as per your requirements.
+
+## Installation
+
+Add DrySchemaRails to your Gemfile and bundle.
+
+```ruby
+gem 'dry_schema_rails'
+```
+
+Run
+```bash
+bundle install
+```
+
+## Quick Usage Guide
+
+1. **Define Schema:**
+
+   Define your schema classes with necessary validation rules in a block passed to `schema`.
+
+   ```ruby
+   class UserSchema < DrySchemaRails::ApplicationSchema
+     schema do
+       required(:username).filled(:string)
+       required(:email).filled(:string, format?: /@/)
+       required(:age).filled(:integer, gt?: 18)
+     end
+   end
+   ```
+
+2. **Use Schema:**
+
+   Validate and sanitize parameters using defined schemas.
+
+   ```ruby
+   user_params = { username: "John", email: "john@example.com", age: 25 }
+   result = UserSchema.call(user_params)
+   
+   puts result.success?   # => true
+   puts result.errors     # => {}
+   ```
+
+## In-Depth Usage
+
+### Custom Validators
+```ruby
+module User
+  class CreateValidator < DrySchemaRails::Base
+    params User::CreateSchema.params
+  end
+end
+```
+
+### In Controllers
+```ruby
+class UsersController < ApiController
+  ...
+  schema(:create, &User::CreateSchema.schema) 
+  
+  # This checks maybe in base controller for reusability
+  if safe_params&.failure?
+    render json: { errors: safe_params.errors }, status: :unprocessable_entity
+  end
+  
+  def create
+    @user = User.create!(safe_params.output)
+    render json: @user, status: :created
+  end
+  ...
+end
+```
+
+## Example Application: DrySchemaRailsDemo
+
+### Idea
+
+Create a Rails application `DrySchemaRailsDemo` demonstrating the usage of `DrySchemaRails` in various common Rails use-cases: model validation, parameter validation in controllers, form object validation, etc.
+
+### Key Features:
+
+- **User Management:** Simple CRUD for managing users with validations using defined schemas.
+- **API Endpoint:** Demonstrate parameter validation for API endpoints.
+- **Form Object:** Use schemas to validate form objects.
+
+### Implementation
+
+1. **Model and Schema:**
+
+   Define `User` model and `UserSchema` for validating user attributes.
+
+   ```ruby
+   class User < ApplicationRecord
+     # your model code
+   end
+   
+   class UserSchema < DrySchemaRails::Base
+     schema do
+       required(:username).filled(:string)
+       # additional validations...
+     end
+   end
+   ```
+
+2. **Controller Validation:**
+
+   Implement validations in controllers and API endpoints using schema.
+
+   ```ruby
+   class UsersController < ApplicationController
+     def create
+       validation = UserSchema.call(params.permit!.to_h)
+       if validation.success?
+         # handle success...
+       else
+         # handle failure...
+       end
+     end
+   end
+   ```
+
+3. **Form Object:**
+
+   Define form objects validating data using schema before processing.
+
+   ```ruby
+   class RegistrationForm
+     def initialize(params)
+       @params = params
+     end
+     
+     def save
+       validation = UserSchema.call(@params)
+       if validation.success?
+         User.create(validation.output)
+       else
+         # handle errors...
+       end
+     end
+   end
+   ```
+
+## Tests
+
+Write tests for models, controllers, and form objects ensuring schema validations are applied and working as expected.
+
+## License
+
+See `LICENSE` file.
+
+---
+
+For more complex understanding you might adjust specifics to cater to the unique needs and standards of your app or team. For further details on `dry-schema`, visit [Dry Schema](https://dry-rb.org/gems/dry-schema).

data/lib/dry_schema_rails/base.rb

@@ -0,0 +1,28 @@
+require 'dry-schema'
+require 'active_support/core_ext/class/attribute'
+
+module DrySchemaRails
+  class Base
+    class_attribute :_schema_proc, default: -> {}
+
+    class << self
+      def call(*args)
+        params.call(*args)
+      end
+
+      def params
+        Dry::Schema.Params(&_schema_proc)
+      end
+
+      alias :contract :params
+
+      def schema(&block)
+        if block_given?
+          self._schema_proc = block
+        else
+          _schema_proc
+        end
+      end
+    end
+  end
+end

data/lib/dry_schema_rails/version.rb

@@ -0,0 +1,3 @@
+module DrySchemaRails
+  VERSION = "0.1.0"
+end

data/lib/dry_schema_rails.rb

@@ -0,0 +1,5 @@
+module DrySchemaRails
+end
+
+require "dry_schema_rails/version"
+require "dry_schema_rails/base"

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: dry_schema_rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- David Rybolovlev
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-10-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Simple DSL for reusing dry-schema in Rails.
+email: i@golifox.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/dry_schema_rails.rb
+- lib/dry_schema_rails/base.rb
+- lib/dry_schema_rails/version.rb
+homepage: http://github.com/golifox/dry_schema_rails
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.19
+signing_key:
+specification_version: 4
+summary: Simple DSL for reusing dry-schema in Rails.
+test_files: []