hanami-validations 2.0.0.rc1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b63b671cb011a8cb85a8bfa666184e63b3c7c6919b2d784c8c9b57a13330bdc7
-  data.tar.gz: ad78ba03ca31c9f42a2dc74fcd58f9af725a3b2e6894cdfd61a4f356a5bbbfe1
+  metadata.gz: 4a0d6367d5ae641a10c53578dba401c026a6e7b125210312a18a8f9f1430093e
+  data.tar.gz: 22891e60e1235640d73b896acda9961764255bf219f76cc3107f884ea4fc27b7
 SHA512:
-  metadata.gz: 332a8174ba02f21ad874fe53b00f11599ac10d0f0f2e6c7707b793b296725805eabfbd4aebf46bd105ce9fb0e29adf1a96058087b3539a08e70181c3749095cd
-  data.tar.gz: fbfba46341537f9df000582a620a38d58f855bf2fcd1102b078c38691b1b0bc0feec1b9ba11217c123a75210dae1c5554e284fc8156b3f8f6c99098125b04462
+  metadata.gz: f1aa7f299bed7884008b0325870fc40143e838e6af4b498bd6979e676198cd8166e04d987cb31ac619d39a14851ab04b825e192865bed4c571cd01243197e9f7
+  data.tar.gz: 3854da5422fe1c48aa839fa3cefa58b7f93c7ea5115d8ad15601e82561245cb10de27fc8810fe416b56e43d9c0c11ae2c26506b56bf625d40c74e82fa7b52226

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 Validations mixin for Ruby objects
 
+## v2.0.0 - 2022-11-22
+
+### Added
+
+- [Tim Riley] Use Zeitwerk to autoload the gem
+
 ## v2.0.0.rc1 - 2022-11-08
 
 ## v2.0.0.beta4 - 2022-10-24

data/README.md

@@ -1,6 +1,6 @@
 # Hanami::Validations
 
-Data validation library for Ruby
+Internal support gem for `Hanami::Action` params validation.
 
 ## Status
 
@@ -51,437 +51,30 @@ $ gem install hanami-validations
 
 ## Usage
 
-[Hanami](http://hanamirb.org), [ROM](https://rom-rb.org), and [DRY](https://dry-rb.org) projects are working together to create a strong Ruby ecosystem.
-`hanami-validations` is based on [`dry-validation`](https://dry-rb.org/gems/dry-validation/master/), for this reason the documentation explains the basics of this gem, but for advanced topics, it links to `dry-validation` docs.
-
-### Overview
-
-The main object provided by this gem is `Hanami::Validator`.
-It providers a powerful DSL to define a validation contract, which is made of a schema and optional rules.
-
-A validation **schema** is a set of steps that filters, coerces, and checks the validity of incoming data.
-Validation **rules** are a set of directives, to check if business rules are respected.
-
-Only when the input is formally valid (according to the **schema**), validation **rules** are checked.
-
-```ruby
-# frozen_string_literal: true
-
-require "hanami/validations"
-
-class SignupValidator < Hanami::Validator
-  schema do
-    required(:email).value(:string)
-    required(:age).value(:integer)
-  end
-
-  rule(:age) do
-    key.failure("must be greater than 18") if value < 18
-  end
-end
-
-validator = SignupValidator.new
-
-result = validator.call(email: "user@hanamirb.test", age: 37)
-result.success? # => true
-
-result = validator.call(email: "user@hanamirb.test", age: "foo")
-result.success? # => false
-result.errors.to_h # => {:age=>["must be an integer"]}
-
-result = validator.call(email: "user@hanamirb.test", age: 17)
-puts result.success? # => false
-puts result.errors.to_h # => {:age=>["must be greater than 18"]}
-```
-
-### Schemas
-
-A basic schema doesn't apply data coercion, input must already have the right Ruby types.
-
-```ruby
-# frozen_string_literal: true
-
-require "hanami/validations"
-
-class SignupValidator < Hanami::Validator
-  schema do
-    required(:email).value(:string)
-    required(:age).value(:integer)
-  end
-end
-
-validator = SignupValidator.new
-
-result = validator.call(email: "user@hanamirb.test", age: 37)
-puts result.success? # => true
-
-result = validator.call(email: "user@hanamirb.test", age: "37")
-puts result.success? # => false
-puts result.errors.to_h # => {:age=>["must be an integer"]}
-```
-
-### Params
-
-When used in _params mode_, a schema applies data coercion, before to run validation checks.
-
-This is designed for Web form/HTTP params.
-
-```ruby
-# frozen_string_literal: true
-
-require "bundler/setup"
-require "hanami/validations"
-
-class SignupValidator < Hanami::Validator
-  params do
-    required(:email).value(:string)
-    required(:age).value(:integer)
-  end
-end
-
-validator = SignupValidator.new
-
-result = validator.call(email: "user@hanamirb.test", age: "37")
-puts result.success? # => true
-puts result.to_h # => {:email=>"user@hanamirb.test", :age=>37}
-```
-
-### JSON
-
-When used in _JSON mode_, data coercions are still applied, but they follow different policies.
-For instance, because JSON supports integers, strings won't be coerced into integers.
-
-```ruby
-# frozen_string_literal: true
-
-require "hanami/validations"
-
-class SignupValidator < Hanami::Validator
-  json do
-    required(:email).value(:string)
-    required(:age).value(:integer)
-  end
-end
-
-validator = SignupValidator.new
-
-result = validator.call(email: "user@hanamirb.test", age: 37)
-puts result.success? # => true
-puts result.to_h # => {:email=>"user@hanamirb.test", :age=>37}
-
-result = validator.call(email: "user@hanamirb.test", age: "37")
-puts result.success? # => false
-```
-
-### Whitelisting
-
-Unknown keys from incoming data are filtered out:
-
-```ruby
-# frozen_string_literal: true
-
-require "hanami/validations"
-
-class SignupValidator < Hanami::Validator
-  schema do
-    required(:email).value(:string)
-  end
-end
-
-validator = SignupValidator.new
-
-result = validator.call(email: "user@hanamirb.test", foo: "bar")
-puts result.success? # => true
-puts result.to_h # => {:email=>"user@hanamirb.test"}
-```
-
-### Custom Types
-
-```ruby
-# frozen_string_literal: true
-
-require "hanami/validations"
-
-module Types
-  include Dry::Types()
-
-  StrippedString = Types::String.constructor(&:strip)
-end
-
-class SignupValidator < Hanami::Validator
-  params do
-    required(:email).value(Types::StrippedString)
-    required(:age).value(:integer)
-  end
-end
-
-validator = SignupValidator.new
-
-result = validator.call(email: "     user@hanamirb.test     ", age: "37")
-puts result.success? # => true
-puts result.to_h # => {:email=>"user@hanamirb.test", :age=>37}
-```
-
-### Rules
-
-Rules are performing a set of domain-specific validation checks.
-Rules are executed only after the validations from the schema are satisfied.
-
-```ruby
-# frozen_string_literal: true
-
-require "hanami/validations"
-
-class EventValidator < Hanami::Validator
-  params do
-    required(:start_date).value(:date)
-  end
-
-  rule(:start_date) do
-    key.failure("must be in the future") if value <= Date.today
-  end
-end
-
-validator = EventValidator.new
-
-result = validator.call(start_date: "foo")
-puts result.success? # => false
-puts result.errors.to_h # => {:start_date=>["must be a date"]}
-
-result = validator.call(start_date: Date.today)
-puts result.success? # => false
-puts result.errors.to_h # => {:start_date=>["must be in the future"]}
-
-result = validator.call(start_date: Date.today + 1)
-puts result.success? # => true
-puts result.to_h # => {:start_date=>#<Date: 2019-07-03 ((2458668j,0s,0n),+0s,2299161j)>}
-```
-
-Learn more about rules: https://dry-rb.org/gems/dry-validation/master/rules/
-
-### Inheritance
-
-Schema and rules validations can be inherited and used by subclasses
+Installing hanami-validations enables support for `params` validation in
+[hanami-controller][controller]’s `Hanami::Action` classes.
 
 ```ruby
-# frozen_string_literal: true
-
-require "hanami/validations"
-
-class ApplicationValidator < Hanami::Validator
+class Signup < Hanami::Action
   params do
-    optional(:_csrf_token).filled(:string)
-  end
-end
-
-class SignupValidator < ApplicationValidator
-  params do
-    required(:user).hash do
-      required(:email).filled(:string)
-    end
-  end
-end
-
-validator = SignupValidator.new
-
-result = validator.call(user: { email: "user@hanamirb.test" }, _csrf_token: "abc123")
-puts result.success? # => true
-puts result.to_h # => {:user=>{:email=>"user@hanamirb.test"}, :_csrf_token=>"abc123"}
-```
-
-### Messages
-
-Failure messages can be hardcoded or refer to a message template system.
-`hanami-validations` supports natively a default YAML based message template system, or alternatively, `i18n` gem.
-
-We have already seen rule failures set with hardcoded messages, here's an example of how to use keys to refer to interpolated messages.
-
-```ruby
-# frozen_string_literal: true
-
-require "hanami/validations"
-
-class ApplicationValidator < Hanami::Validator
-  config.messages.top_namespace = "bookshelf"
-  config.messages.load_paths << "config/errors.yml"
-end
-```
-
-In the `ApplicationValidator` there is defined the application namespace (`"bookshelf"`), which is the root of the messages file.
-Below that top name, there is the key `errors`. Everything that is nested here is accessible by the validations.
-
-There are two ways to organize messages:
-
-  1. Right below `errors`. This is for **general purposes** error messages (e.g. `bookshelf` => `errors` => `taken`)
-  2. Below `errors` => `rules` => name of the attribute => custom key (e.g. `bookshelf` => `errors` => `age` => `invalid`). This is for **specific** messages that affect only a specific attribute.
-
-Our **suggestion** is to start with **specific** messages and see if there is a need to generalize them.
-
-```yaml
-# config/errors.yml
-en:
-  bookshelf:
-    errors:
-      taken: "oh noes, it's already taken"
-      network: "there is a network error (%{code})"
-      rules:
-        age:
-          invalid: "must be greater than 18"
-        email:
-          invalid: "not a valid email"
-```
-
-#### General purpose messages
-
-```ruby
-class SignupValidator < ApplicationValidator
-  schema do
-    required(:username).filled(:string)
-  end
-
-  rule(:username) do
-    key.failure(:taken) if values[:username] == "jodosha"
-  end
-end
-
-validator = SignupValidator.new
-
-result = validator.call(username: "foo")
-puts result.success? # => true
-
-result = validator.call(username: "jodosha")
-puts result.success? # => false
-puts result.errors.to_h # => {:username=>["oh noes, it's already taken"]}
-```
-
-#### Specific messages
-
-Please note that the failure key used it's the same for both the attributes (`:invalid`), but thanks to the nesting, the library is able to lookup the right message.
-
-```ruby
-class SignupValidator < ApplicationValidator
-  schema do
-    required(:email).filled(:string)
-    required(:age).filled(:integer)
-  end
-
-  rule(:email) do
-    key.failure(:invalid) unless values[:email] =~ /@/
+    required(:first_name)
+    required(:last_name)
+    required(:email)
   end
 
-  rule(:age) do
-    key.failure(:invalid) if values[:age] < 18
-  end
-end
-
-validator = SignupValidator.new
-
-result = validator.call(email: "foo", age: 17)
-puts result.success? # => false
-puts result.errors.to_h # => {:email=>["not a valid email"], :age=>["must be greater than 18"]}
-```
-
-#### Extra information
+  def handle(req, *)
+    puts req.params.class            # => Signup::Params
+    puts req.params.class.superclass # => Hanami::Action::Params
 
-The interpolation mechanism, accepts extra, arbitrary information expressed as a `Hash` (e.g. `code: "123"`)
-
-```ruby
-class RefundValidator < ApplicationValidator
-  schema do
-    required(:refunded_code).filled(:string)
-  end
-
-  rule(:refunded_code) do
-    key.failure(:network, code: "123") if values[:refunded_code] == "error"
+    puts req.params[:first_name]     # => "Luca"
+    puts req.params[:admin]          # => nil
   end
 end
-
-validator = RefundValidator.new
-
-result = validator.call(refunded_code: "error")
-puts result.success? # => false
-puts result.errors.to_h # => {:refunded_code=>["there is a network error (123)"]}
 ```
 
-Learn more about messages: https://dry-rb.org/gems/dry-validation/master/messages/
-
-### External dependencies
-
-If the validator needs to plug one or more objects to run the validations, there is a DSL to do so: `:option`.
-When the validator is instantiated, the declared dependencies must be passed.
-
-```ruby
-# frozen_string_literal: true
-
-require "hanami/validations"
-
-class AddressValidator
-  def valid?(value)
-    value.match(/Rome/)
-  end
-end
-
-class DeliveryValidator < Hanami::Validator
-  option :address_validator
-
-  schema do
-    required(:address).filled(:string)
-  end
-
-  rule(:address) do
-    key.failure("not a valid address") unless address_validator.valid?(values[:address])
-  end
-end
-
-validator = DeliveryValidator.new(address_validator: AddressValidator.new)
-
-result = validator.call(address: "foo")
-puts result.success? # => false
-puts result.errors.to_h # => {:address=>["not a valid address"]}
-```
-
-Read more about external dependencies: https://dry-rb.org/gems/dry-validation/master/external-dependencies/
-
-### Mixin
-
-`hanami-validations` 1.x used to ship a mixin `Hanami::Validations` to be included in classes to provide validation rules.
-The 2.x series, still ships this mixin, but it will be probably removed in 3.x.
-
-```ruby
-# frozen_string_literal: true
-
-require "hanami/validations"
-
-class UserValidator
-  include Hanami::Validations
-
-  validations do
-    required(:number).filled(:integer, eql?: 23)
-  end
-end
-
-result = UserValidator.new(number: 23).validate
-
-puts result.success? # => true
-puts result.to_h # => {:number=>23}
-puts result.errors.to_h # => {}
-
-result = UserValidator.new(number: 11).validate
-
-puts result.success? # => true
-puts result.to_h # => {:number=>21}
-puts result.errors.to_h # => {:number=>["must be equal to 23"]}
-```
-
-## FAQs
-### Uniqueness Validation
-
-Uniqueness validation isn't implemented by `Hanami::Validations` because the context of execution is completely decoupled from persistence.
-Please remember that **uniqueness validation is a huge race condition between application and the database, and it doesn't guarantee records uniqueness for real.** To effectively enforce this policy you can use SQL database constraints.
-
-Please read more at: [The Perils of Uniqueness Validations](http://robots.thoughtbot.com/the-perils-of-uniqueness-validations).
+See [hanami-controller][controller] for more detail on params validation.
 
-If you need to implement it, please use the External dependencies feature (see above).
+[controller]: http://github.com/hanami/controller
 
 ## Contributing
 
@@ -493,6 +86,6 @@ If you need to implement it, please use the External dependencies feature (see a
 
 ## Copyright
 
-Copyright © 2014-2021 Luca Guidi – Released under MIT License
+Copyright © 2014-2022 Hanami Team – Released under MIT License
 
 This project was formerly known as Lotus (`lotus-validations`).

data/hanami-validations.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = ">= 3.0"
 
   spec.add_dependency "dry-validation", ">= 1.10", "< 2"
+  spec.add_dependency "zeitwerk", "~> 2.6.0"
 
   spec.add_development_dependency "bundler", ">= 1.6", "< 3"
   spec.add_development_dependency "rake",    "~> 13"

data/lib/hanami/validations/form.rb

@@ -4,38 +4,8 @@ module Hanami
   module Validations
     # Validations mixin for forms/HTTP params.
     #
-    # This must be used when the input comes from a browser or an HTTP endpoint.
-    # It knows how to deal with common data types, and common edge cases like blank strings.
-    #
     # @since 0.6.0
-    #
-    # @example
-    #   require "hanami/validations/form"
-    #
-    #   class Signup
-    #     include Hanami::Validations::Form
-    #
-    #     validations do
-    #       required(:name).filled(:string)
-    #       optional(:location).filled(:string)
-    #     end
-    #   end
-    #
-    #   result = Signup.new("location" => "Rome").validate
-    #   result.success? # => false
-    #
-    #   result = Signup.new("name" => "Luca").validate
-    #   result.success? # => true
-    #
-    #   # it works with symbol keys too
-    #   result = Signup.new(location: "Rome").validate
-    #   result.success? # => false
-    #
-    #   result = Signup.new(name: "Luca").validate
-    #   result.success? # => true
-    #
-    #   result = Signup.new(name: "Luca", location: "Rome").validate
-    #   result.success? # => true
+    # @api private
     module Form
       # @since 2.0.0
       # @api private
@@ -45,14 +15,8 @@ module Hanami
         end
       end
 
-      # Override Ruby's hook for modules.
-      #
-      # @param klass [Class] the target action
-      #
       # @since 0.6.0
       # @api private
-      #
-      # @see http://www.ruby-doc.org/core/Module.html#method-i-included
       def self.included(klass)
         super
 

data/lib/hanami/validations/version.rb

@@ -2,7 +2,10 @@
 
 module Hanami
   module Validations
+    # The current hanami-validations version.
+    #
+    # @since 0.1.0
     # @api public
-    VERSION = "2.0.0.rc1"
+    VERSION = "2.0.0"
   end
 end

data/lib/hanami/validations.rb

@@ -2,15 +2,34 @@
 
 require "dry/validation"
 require "delegate"
+require "zeitwerk"
 
+# @see Hanami::Validations
+# @since 0.1.0
 module Hanami
   # @since 0.1.0
+  # @api private
   module Validations
-    class Error < StandardError; end
+    # @since 2.0.0
+    # @api private
+    def self.gem_loader
+      @gem_loader ||= Zeitwerk::Loader.new.tap do |loader|
+        root = File.expand_path("..", __dir__)
+        loader.tag = "hanami-validations"
+        loader.inflector = Zeitwerk::GemInflector.new("#{root}/hanami-validations.rb")
+        loader.push_dir(root)
+        loader.ignore(
+          "#{root}/hanami-validations.rb",
+          "#{root}/hanami/validations/version.rb"
+        )
+      end
+    end
 
-    require "hanami/validations/version"
-    require "hanami/validator"
+    gem_loader.setup
+    require_relative "validations/version"
 
+    # @since 0.1.0
+    # @api private
     def self.included(klass)
       super
       klass.extend(ClassMethods)
@@ -35,37 +54,14 @@ module Hanami
     # Validations DSL
     #
     # @since 0.1.0
+    # @api private
     module ClassMethods
       # Define validation rules from the given block.
       #
       # @param blk [Proc] validation rules
       #
       # @since 0.6.0
-      #
-      # @see https://guides.hanamirb.org/validations/overview
-      #
-      # @example Basic Example
-      #   require "hanami/validations"
-      #
-      #   class Signup
-      #     include Hanami::Validations
-      #
-      #     validations do
-      #       required(:name).filled(:string)
-      #     end
-      #   end
-      #
-      #   result = Signup.new(name: "Luca").validate
-      #
-      #   result.success? # => true
-      #   result.messages # => []
-      #   result.output   # => {:name=>""}
-      #
-      #   result = Signup.new(name: "").validate
-      #
-      #   result.success? # => false
-      #   result.messages # => {:name=>["must be filled"]}
-      #   result.output   # => {:name=>""}
+      # @api private
       def validations(&blk)
         @_validator = Dry::Validation::Contract.build { schema(&blk) }
       end
@@ -82,6 +78,7 @@ module Hanami
     # @param input [#to_h] a set of input data
     #
     # @since 0.6.0
+    # @api private
     def initialize(input)
       @input = input
     end
@@ -91,6 +88,7 @@ module Hanami
     # @return [Hanami::Validations::Result]
     #
     # @since 0.2.4
+    # @api private
     def validate
       Result.new(
         self.class._validator.call(@input)
@@ -103,6 +101,7 @@ module Hanami
     # @return [Hash]
     #
     # @since 0.1.0
+    # @api private
     def to_h
       validate.to_h
     end

data/lib/hanami/validator.rb

@@ -4,6 +4,7 @@ require "dry/validation"
 
 module Hanami
   # @since 2.0.0
+  # @api private
   class Validator < Dry::Validation::Contract
   end
 end

data/lib/hanami-validations.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "hanami/validations"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hanami-validations
 version: !ruby/object:Gem::Version
-  version: 2.0.0.rc1
+  version: 2.0.0
 platform: ruby
 authors:
 - Luca Guidi
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-08 00:00:00.000000000 Z
+date: 2022-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-validation
@@ -30,6 +30,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '2'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -103,6 +117,7 @@ files:
 - LICENSE.md
 - README.md
 - hanami-validations.gemspec
+- lib/hanami-validations.rb
 - lib/hanami/validations.rb
 - lib/hanami/validations/form.rb
 - lib/hanami/validations/version.rb
@@ -123,11 +138,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Validations mixin for Ruby objects