dry_schema_rails 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e0ab00d425f197732b212e89786fc907a79777a587553179f9bfb1f73fd0993
-  data.tar.gz: 9febc5e668f7baef5e14d586aa1defcc911bf5db669a27406127a3a59dba5d0b
+  metadata.gz: 6c3560caeddcea00621aed557566de2f4095e9ad0ff0c7b4581467cad3c0f813
+  data.tar.gz: 8ba8692aadec09ba7d50604f31ab94a5ea5e90c66b55edad8ddf6a9469cb1250
 SHA512:
-  metadata.gz: 55cf34abdd81b67cd17bee24148f6ad759e94534b72da8987f08459446066bd1066f16d99067600e5b0de25bb853dbda6a52a1168d2c4a258873a8fa62b35df1
-  data.tar.gz: b86a495286b57a8b88ae35a1c355cf36f0fa62e3b431429493e827242feb29240500c933bbb72ce4d6a08677214c86699c0f4b8b690d508efdd2a08db32d1a36
+  metadata.gz: bc5375cf1db629467b34f91c79d00a0e099ab43b021042600e4ba9228f98878145c9dde969111b580bb9cc7ce80c895357347162c00eedac8eabe19514bcfbf7
+  data.tar.gz: 8b93626e2e87a47a14527fdf9a78ca162034ce560ee63f49e71b9cd5c00da37309a386f68b385d1d244487c30b8af510591ed801ef3ec4bfe6172343705d964d

data/CHANGELOG.md

@@ -5,6 +5,15 @@ All notable changes to [dry_schema_rails](https://github.com/golifox/dry_schema_
 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).
 
+## [0.1.3] - 2023-10-12
+### Add
+- Class comments
+- Class method comments & return values linting
+
+## [0.1.2] - 2023-10-12
+### Fixed
+- Compatibility errors
+
 ## [0.1.1] - 2023-10-12
 ### Fixed
 - Maintain errors
@@ -25,5 +34,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Notes
 - This version serves as the foundational architecture for future features.
 
-[0.1.1]: https://github.com/your_username/dry_schema_rails/compare/v0.1.0...v0.1.1
-[0.1.0]: https://github.com/your_username/dry_schema_rails/releases/tag/v0.1.0
+[0.1.2]: https://github.com/golifox/dry_schema_rails/compare/v0.1.0...v0.1.2  
+[0.1.1]: https://github.com/golifox/dry_schema_rails/compare/v0.1.0...v0.1.1
+[0.1.0]: https://github.com/golifox/dry_schema_rails/releases/tag/v0.1.0

data/README.md

@@ -31,7 +31,7 @@ bundle install
    Define your schema classes with necessary validation rules in a block passed to `schema`.
 
    ```ruby
-   class UserSchema < DrySchemaRails::ApplicationSchema
+   class UserSchema < DrySchemaRails::Base
      schema do
        required(:username).filled(:string)
        required(:email).filled(:string, format?: /@/)
@@ -59,6 +59,14 @@ bundle install
 module User
   class CreateValidator < DrySchemaRails::Base
     params User::CreateSchema.params
+     
+    rule(:username) do
+      key.failure('must be unique') if User.exists?(username: value)
+    end
+     
+    rule(:email) do
+      key.failure('must be in internation format') unless value.end_with?('.com')
+    end 
   end
 end
 ```
@@ -67,7 +75,7 @@ end
 ```ruby
 class UsersController < ApiController
   ...
-  schema(:create, &User::CreateSchema.schema) 
+  schema(:create, &UserSchema.schema) 
   
   # This checks maybe in base controller for reusability
   if safe_params&.failure?

data/lib/dry_schema_rails/base.rb

@@ -1,6 +1,40 @@
 require 'dry-schema'
 
 module DrySchemaRails
+  # Base class serves as a foundational class designed to encapsulate
+  # common functionalities associated with schema definitions. It provides a
+  # blueprint for creating new schema classes efficiently and consistently.
+  #
+  # The core mechanism of this class hinges on the `class_attribute` called
+  # `_schema_proc`, which stores the schema's definition as a proc.
+  # This proc gets executed in the context of `Dry::Schema` to define the schema.
+  #
+  #  Example Usage:
+  #
+  # To create a new schema, simply inherit from the Base class and provide
+  # the schema definition inside a block passed to the `schema` class method.
+  #
+  # Example:
+  #   BaseSchema = Class.new(DrySchemaRails::Base)
+  #   UserSchema = Class.new(BaseSchema) do
+  #     schema do
+  #       required(:username).filled(:string)
+  #       required(:email).filled(:string, format?: /@/)
+  #       required(:age).filled(:integer, gt?: 18)
+  #     end
+  #   end
+  #
+  #   user_params = { username: "John", email: "john@example.com", age: 25 }
+  #   result = UserSchema.params.call(user_params)
+  #   OR
+  #   result = UserSchema.call(user_params)
+  #
+  #   puts result.success?   # => true
+  #   puts result.errors     # => {}
+  #
+  # This approach allows for the creation of multiple schema classes in a concise
+  # and consistent manner, all inheriting common functionality from the base
+  # Base class.
   class Base
     class << self
       def _schema_proc
@@ -11,16 +45,70 @@ module DrySchemaRails
         @_schema_proc = proc
       end
 
+      # @return [Dry::Schema::Result] the schema matching result
       def call(*args)
         params.call(*args)
       end
 
+      # Using to create custom validators easy.
+      #
+      #  Example:
+      #
+      #  UserSchema = Class.new(DrySchemaRails) do
+      #    schema do
+      #      required(:name).filled(:string)
+      #      required(:email).filled(:string)
+      #    end
+      #  end
+      #
+      #  class UserValidator < Dry::Validation::Contract
+      #    params UserSchema.params
+      #    # OR
+      #    params UserSchema.contract
+      #
+      #    rule(:name) do
+      #      key.failure('name is too short') if value.length < 3
+      #    end
+      #  end
+      #
+      #  validation = UserSchema.params
+      #
+      # @return [Dry::Schema::Params] the schema definition
       def params
         Dry::Schema.Params(&_schema_proc)
       end
 
       alias :contract :params
 
+      # Using in rails controllers.
+      #
+      #  Example:
+      #
+      #  UserSchema = Class.new(BaseSchema) do
+      #    schema do
+      #      required(:name).filled(:string)
+      #      optional(:email).filled(:string)
+      #    end
+      #  end
+      #
+      #  class ApplicationController < ActionController::Base
+      #    before_action do
+      #       if safe_params&.failure?
+      #        render json: { errors: safe_params.errors.to_h }, status: :bad_request
+      #       end
+      #    end
+      #  end
+      #
+      #  class UsersController < ApplicationController
+      #    schema(:create, &UserSchema.schema)
+      #
+      #    def create
+      #      @user = User.create(safe_params.output)
+      #      render json: @user, status: :created
+      #    end
+      #  end
+      #
+      # @return [Proc] the schema definition
       def schema(&block)
         if block_given?
           self._schema_proc = block

data/lib/dry_schema_rails/version.rb

@@ -1,3 +1,3 @@
 module DrySchemaRails
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dry_schema_rails
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - David Rybolovlev