well_formed-dry_types 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9f1ac7db352c20975d977aa5b0be90fab517cf99b1a13a90777582192d687796
+  data.tar.gz: fbb5c1c872a390905b58f20e8cafd99033125e94eebf19717cd81b965b85570a
+SHA512:
+  metadata.gz: d554e08c5e9a3ff9da0ec183552884fbf5b84a0c4a063d7302147f3d1347e64fd66362b85e9d3221bbebe6c2cf05582e4a83a665a2f94dd138f3fe77bd5eec83
+  data.tar.gz: 5c15062aba57a466f85b4e89a56f359d5c5962d34c8ae3cfc7f427e6a836abe3cf9d78e9508db80e2af5efcc78fa352ceb2587de218df8f026fe1a3dd32ad861

data/.rspec

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

data/README.md

@@ -0,0 +1,107 @@
+# well_formed-dry_types
+
+[dry-types](https://dry-rb.org/gems/dry-types) coercion integration for [WellFormed](https://github.com/bmorrall/well_formed) form objects.
+
+Declare typed attributes with `dry_attribute` and coercion runs automatically before validation — keeping your forms free of manual casting logic.
+
+## Installation
+
+```bash
+bundle add well_formed-dry_types
+```
+
+## Usage
+
+Require the gem in your application:
+
+```ruby
+require "well_formed-dry_types"
+```
+
+Include `WellFormed::DryTypes` in any form, then use `dry_attribute` in place of `attribute` for fields that need type coercion:
+
+```ruby
+module Types
+  include Dry.Types()
+end
+
+class CreateOrderForm < WellFormed::ResourceForm
+  include WellFormed::DryTypes
+
+  resource_alias :order
+
+  dry_attribute :quantity, Types::Params::Integer
+  dry_attribute :amount,   Types::Params::Decimal
+  dry_attribute :status,   Types::String.enum("pending", "confirmed")
+
+  validates :quantity, presence: true, numericality: {greater_than: 0}
+  validates :amount,   presence: true
+  validates :status,   presence: true
+end
+```
+
+Coercion runs before validation. If coercion fails, an error is added to the attribute and validation is skipped for that field:
+
+```ruby
+form = CreateOrderForm.new(order, current_user, {quantity: "abc", amount: "9.99", status: "pending"})
+form.valid?
+# => false
+form.errors[:quantity]
+# => ["must be Params::Integer"]  # dry-types error message
+```
+
+## Custom error messages
+
+Pass `message:` to override the default dry-types error message.
+
+#### I18n key
+
+```ruby
+dry_attribute :status, Types::String.enum("pending", "confirmed"), message: :inclusion
+```
+
+Passes the symbol to `errors.add`, which resolves it through your I18n translations.
+
+#### Literal string
+
+```ruby
+dry_attribute :amount, Types::Params::Decimal, message: "must be a number"
+```
+
+#### Default (no message option)
+
+```ruby
+dry_attribute :quantity, Types::Params::Integer
+```
+
+Falls back to the error message from dry-types itself.
+
+## Inheritance
+
+`_dry_attributes` merges up the superclass chain, so subclass forms inherit parent coercions and can add their own:
+
+```ruby
+class BaseOrderForm < WellFormed::ResourceForm
+  include WellFormed::DryTypes
+  dry_attribute :amount, Types::Params::Decimal
+end
+
+class CreateOrderForm < BaseOrderForm
+  dry_attribute :quantity, Types::Params::Integer
+  # inherits :amount coercion from BaseOrderForm
+end
+```
+
+## API
+
+| Class macro | Description |
+|---|---|
+| `dry_attribute(name, type, message: nil)` | Declares a coerced attribute. Coercion runs before validation via a `before_validate` callback. |
+
+## How it works
+
+When `WellFormed::DryTypes` is included, a `before_validate` callback (`_coerce_dry_attributes`) is registered. Before each validation run, every `dry_attribute` is coerced in declaration order. On `Dry::Types::CoercionError`, an error is added and the raw value is left in place. Subsequent validators can still run against the failing attribute (e.g. a `presence` check on a nil optional).
+
+## License
+
+MIT

data/Rakefile

@@ -0,0 +1,10 @@
+# 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(:rubocop)

data/lib/well_formed/dry_types/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module WellFormed
+  module DryTypes
+    VERSION = "0.1.0"
+  end
+end

data/lib/well_formed/dry_types.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module WellFormed
+  module DryTypes
+    def self.included(base)
+      base.extend(ClassMethods)
+      base.set_callback(:validate, :before, :_coerce_dry_attributes)
+    end
+
+    module ClassMethods
+      # Declares an attribute whose value is coerced via a dry-types type before
+      # validation runs. Any dry-types type is accepted, including constrained,
+      # optional, and sum types.
+      #
+      #   dry_attribute :amount,  Types::Params::Decimal
+      #   dry_attribute :status,  Types::String.enum("draft", "published")
+      #   dry_attribute :tags,    Types::Strict::Array.of(Types::Strict::String)
+      #   dry_attribute :score,   Types::Params::Integer.optional
+      #
+      # If coercion fails, an error is added to the attribute. Pass +message:+ to
+      # use a specific error message or I18n key instead of the dry-types error:
+      #
+      #   dry_attribute :status, Types::String.enum("draft", "published"), message: :inclusion
+      #   dry_attribute :amount, Types::Params::Decimal, message: "must be a number"
+      #
+      # Coercion runs before validation, so +validates :amount, presence: true+ will
+      # still fire for nil values on optional attributes.
+      def dry_attribute(name, type, message: nil)
+        _dry_attribute_registry[name] = {type: type, message: message}
+        attribute name
+      end
+
+      # Returns the merged dry-types attribute registry for this class and all ancestors.
+      def _dry_attributes
+        parent = superclass.respond_to?(:_dry_attributes) ? superclass._dry_attributes : {}
+        parent.merge(_dry_attribute_registry)
+      end
+
+      private
+
+      def _dry_attribute_registry
+        @_dry_attribute_registry ||= {}
+      end
+    end
+
+    private
+
+    def _coerce_dry_attributes
+      self.class._dry_attributes.each do |name, options|
+        coerced = options[:type].call(public_send(name))
+        public_send(:"#{name}=", coerced)
+      rescue ::Dry::Types::CoercionError => e
+        errors.add(name, options[:message] || e.message)
+      end
+    end
+  end
+end

data/lib/well_formed-dry_types.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "well_formed"
+require "dry-types"
+require_relative "well_formed/dry_types/version"
+require_relative "well_formed/dry_types"
+
+WellFormed::Extensions.register_extension(WellFormed::DryTypes)

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: well_formed-dry_types
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ben Morrall
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: well_formed
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: dry-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+email:
+- bemo56@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- README.md
+- Rakefile
+- lib/well_formed-dry_types.rb
+- lib/well_formed/dry_types.rb
+- lib/well_formed/dry_types/version.rb
+homepage: https://github.com/bmorrall/well_formed
+licenses:
+- MIT
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: dry-types attribute coercion integration for well_formed
+test_files: []