serviced 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 846cb3be063fd58cece40a219adb68e678c855e5eada4d0ca5b8bdd97d150804
-  data.tar.gz: 98095c54b426771b8fa036c5ac2bcdbb4358700d14877875eaab1f3a672f9e07
+  metadata.gz: 3643886bd1dac4dfc9750a4a6fbf08f672f6c9b33905b4cd19bedc482a527bc9
+  data.tar.gz: d7d95804f42d9a786a0a2647fe46a84a0c9e4ed9cfac39a598f2a9db5ae5a469
 SHA512:
-  metadata.gz: 17a0bea0ddf4bd50cb8b3305fea5e074b3c3d5ea1510c5e3ce2945a74f7bea9ebcd24f0aafaa6ba52d1a5bec73dd5495d2ee2b107fd75c8eb5a046f60c57637c
-  data.tar.gz: d55dc5d0189586d8d719053bfb0fa796090078d42054d7b5b828ae1cad0320af15d9114e4b95806a60e8b798222ffa7ac7ff65dcf86b9615dc83ae2c77c18df4
+  metadata.gz: 6404482276c8e3057a978f94c9a46580258b2c981968f05ee031f09bb5e870edc0bce494301fbd2938bbff42671c3aa3b9e28f018d72c80fc7db9b349b7c9d29
+  data.tar.gz: 6aab0347f47d2fd19edaf017990c31e329e990999ea1047f03a1d9229121a5e60b9a1993153e9e77cdb07164e5b8475f2240723b7ef84c31f7e94995a16a7115

data/CHANGELOG.md

@@ -7,7 +7,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
-## [0.1.0]
+## [0.1.1]
 
 ### Added
 
@@ -25,10 +25,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   `quote_column`, `sanitize`, `count_of`), and raises `Serviced::InvalidQuery`
   on invalid input.
 - `Serviced::Typed`: shared concern providing typed, immutable, validatable
-  attributes; included by both `Serviced::Service` and `Serviced::Query`.
-  Inputs are isolated by default: value-like data (arrays, hashes, sets,
-  strings) is captured as a deep-frozen snapshot at construction, while objects
-  with identity (records) are shared by reference. Opt out per attribute with
-  `isolate: false`.
+  attributes; included by both `Serviced::Service` and `Serviced::Query`. An
+  attribute type can be an ActiveModel type symbol (coerced) or a class (the
+  value must be an instance of it: ActiveRecord records, POROs, anything;
+  subclasses count, `nil` is allowed). Inputs are isolated by default:
+  value-like data (arrays, hashes, sets, strings) is captured as a deep-frozen
+  snapshot at construction, while objects with identity (records) are shared by
+  reference. Opt out per attribute with `isolate: false`.
 - `Serviced.configure` with a pluggable `transaction_handler` (defaults to
   `ActiveRecord::Base.transaction` when ActiveRecord is available).

data/README.md

@@ -3,6 +3,7 @@
 </p>
 
 <p align="center">
+  <a href="https://github.com/lbernardelli/serviced/actions/workflows/ci.yml"><img src="https://github.com/lbernardelli/serviced/actions/workflows/ci.yml/badge.svg" alt="CI"></a>
   <a href="https://rubygems.org/gems/serviced"><img src="https://img.shields.io/gem/v/serviced?color=CC342D" alt="Gem Version"></a>
   <img src="https://img.shields.io/badge/ruby-%3E%3D%203.1-CC342D" alt="Ruby >= 3.1">
   <a href="LICENSE.txt"><img src="https://img.shields.io/badge/license-MIT-blue" alt="License: MIT"></a>
@@ -162,6 +163,26 @@ report.limit      # => 50          (default)
 
 Unknown keys are ignored, which is what lets a service drop cleanly into a [flow](#flows) without matching the exact shape of the context.
 
+Types are not just scalars. A symbol coerces the value through an ActiveModel type; a class requires the value to be an instance of it, so you can type an attribute as an ActiveRecord record, a plain object, or anything:
+
+```ruby
+class ChargeSubscription < Serviced::Service
+  attribute :account, Account  # must be an Account (record, PORO, subclass), or nil
+  attribute :coupon,  Coupon   # must be a Coupon, or nil
+  attribute :cents,   :integer # coerced to Integer
+
+  def call
+    # account and coupon are guaranteed to be the right type here
+    success(account.charge!(cents, coupon:))
+  end
+end
+
+ChargeSubscription.call(account: "oops", cents: 500)
+# => Failure(:invalid), errors: ["Account must be an instance of Account"]
+```
+
+The check allows `nil` (make it required with `validates :account, presence: true`) and accepts subclasses. The object is shared by reference, not coerced, so a record stays the same record.
+
 ### Immutability that actually holds
 
 Inputs are read-only. There is no writer to reassign them:

data/lib/serviced/typed.rb

@@ -73,17 +73,22 @@ module Serviced
       # ActiveModel::Attributes.attribute, plus +isolate:+.
       #
       # @param name [Symbol] attribute name
-      # @param type [Symbol, ActiveModel::Type::Value, nil] the cast type
+      # @param type [Symbol, ActiveModel::Type::Value, Class, Module, nil] an
+      #   ActiveModel type symbol/instance (the value is coerced), or a
+      #   class/module (the value must be an instance of it: records, POROs,
+      #   anything), or nil for an untyped pass-through
       # @param isolate [Boolean] capture an immutable snapshot of the value at
       #   construction (default); pass +false+ to share it by reference
       # @param options [Hash] forwarded to ActiveModel (e.g. +default:+)
       def attribute(name, type = nil, isolate: true, **options)
-        if type.nil?
+        klass = type if type.is_a?(Module)
+        if type.nil? || klass
           super(name, **options)
         else
           super(name, type, **options)
         end
         private(:"#{name}=")
+        validate_instance_of(name, klass) if klass
         return unless isolate
 
         isolated_attribute_names << name.to_s
@@ -100,6 +105,17 @@ module Serviced
           instance_variable_set(ivar, Serviced.snapshot(super()))
         end
       end
+
+      # Adds a validation that the attribute holds an instance of +klass+
+      # (subclasses count). nil is allowed; require it with +presence: true+.
+      def validate_instance_of(name, klass)
+        validate do
+          value = public_send(name)
+          next if value.nil? || value.is_a?(klass)
+
+          errors.add(name, "must be an instance of #{klass.name || klass.inspect}")
+        end
+      end
     end
   end
 end

data/lib/serviced/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Serviced
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: serviced
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Leonardo Bernardelli