validated_object 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 66bdc1ee048b6518b260908a2a48e8c4676c4350f99641a0da1c041fdc82a530
-  data.tar.gz: 27e9c03469ee86a4875fc9b99d8796055f12e48f7c627bbf410c7b43468c6022
+  metadata.gz: cbb448bc227821b65819e57ae210f715ea5295bf4c7f2e14925e560340a56a38
+  data.tar.gz: 7e78815f3603aedfe4e4eda9cf5e626a64d0ef91f3f237b78a13e110697ce999
 SHA512:
-  metadata.gz: 667688231472cb2d893ac1235be71c97111831f8f8510164c5152e4d37d4bd99b994c4cb189a36f1feb4af5786d0200b14e74ba27e69b7be3e1929795419d2db
-  data.tar.gz: ed1589b44cf7c83d7424ce46b5b09cb1990331aee38bee239232ed2e71b49b32a0c65e2a3fc4ad909c44cd2df1e0b81ee9e65b3191f35621ec50e1be2b499f30
+  metadata.gz: 75745c4db0c873e4a4a5f63ca792a8646abcf5402408d0824e9a704e11112d91c5c303de4a4cf6addffd61ed9532f7327f602442c10ab4969b9332a6e3b6e161
+  data.tar.gz: 4fa2b7800b2675469d85d5ce9a69f5bf2683fc56376f2bfa0fb623fd0491ad2d1c0833d44f55e124ebf067cc04066a5afd3f7d9ad6ea9d76d87ae00f917b770e

data/README.md

@@ -3,6 +3,19 @@
 # ValidatedObject
 
 Plain Old Ruby Objects + Rails Validations = **self-checking Ruby objects**.
+Here's a quick example of a common case: a class with an immutable,
+required, type-checked attribute:
+
+```ruby
+class Person < ValidatedObject::Base
+  validated_attr :name, type: String, presence: true
+end
+
+# Using it
+me = Person.new(name: 'Robb')
+```
+
+I use classes like these as Data Transfer Objects at my system boundaries.
 
 
 ## Goals
@@ -11,7 +24,7 @@ Plain Old Ruby Objects + Rails Validations = **self-checking Ruby objects**.
 * Clean, minimal syntax
 
 This is a small layer around
-[ActiveModel::Validations](http://api.rubyonrails.org/classes/ActiveModel/Validations/ClassMethods.html#method-i-validates). (About 18 lines of code.) So if you know how to use Rails Validations, you're good to go. I wrote this to help with CSV data imports and [website microdata generation](https://github.com/dogweather/schema-dot-org).
+[ActiveModel::Validations](http://api.rubyonrails.org/classes/ActiveModel/Validations/ClassMethods.html#method-i-validates). (About 25 lines of code.) So if you know how to use Rails Validations, you're good to go. I wrote this to help with CSV data imports and [website microdata generation](https://github.com/dogweather/schema-dot-org).
 
 
 ## Usage
@@ -24,7 +37,7 @@ All of the [ActiveModel::Validations](http://api.rubyonrails.org/classes/ActiveM
 ```ruby
 class Dog < ValidatedObject::Base
   # Plain old Ruby
-  attr_accessor :name, :birthday  # attr_reader is supported as well for read-only attributes
+  attr_accessor :name, :birthday
 
   # Plain old Rails
   validates :name, presence: true
@@ -34,6 +47,31 @@ class Dog < ValidatedObject::Base
 end
 ```
 
+We can make it immutable with `attr_reader`:
+
+```ruby
+class ImmutableDog < ValidatedObject::Base
+  attr_reader :name, :birthday
+
+  validates :name, presence: true
+  validates :birthday, type: Date, allow_nil: true
+end
+```
+
+> `attr_reader` followed by `validates` is such a common pattern that
+> there's a second DSL which wraps them up into one call: `validates_attr`.
+
+Here's the immutable version of `Dog` re-written with the simplified DSL:
+
+```ruby
+class ImmutableDog < ValidatedObject::Base
+  validates_attr :name, presence: true
+  validates_attr :birthday, type: Date, allow_nil: true 
+end
+```
+
+### About that `type:` check
+
 The included `TypeValidator` is what enables `type: Date`, above. All classes can be checked, as well as a pseudo-class `Boolean`. E.g.:
 
 ```ruby

data/lib/validated_object/simplified_api.rb

@@ -0,0 +1,18 @@
+require "active_support/concern"
+
+# Enable a simplified API for the common case of
+# read-only ValidatedObjects.
+module ValidatedObject
+  module SimplifiedApi
+    extend ActiveSupport::Concern
+
+    class_methods do
+      # Simply delegate to `attr_reader` and `validates`.
+      def validated_attr(attribute, *options)
+        attr_reader attribute
+        validates attribute, *options
+      end
+    end
+
+  end
+end

data/lib/validated_object/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module ValidatedObject
-  VERSION = '2.2.0'
+  VERSION = '2.3.0'
 end

data/lib/validated_object.rb

@@ -4,6 +4,8 @@
 require 'active_model'
 require 'sorbet-runtime'
 require 'validated_object/version'
+require 'validated_object/simplified_api'
+
 
 module ValidatedObject
   # @abstract Subclass and add `attr_accessor` and validations
@@ -43,6 +45,7 @@ module ValidatedObject
   # @see http://www.rubyinside.com/rails-3-0s-activemodel-how-to-give-ruby-classes-some-activerecord-magic-2937.html Rails 3.0′s ActiveModel: How To Give Ruby Classes Some ActiveRecord Magic, Peter Cooper
   class Base
     include ActiveModel::Validations
+    include SimplifiedApi
     extend T::Sig
 
     SymbolHash = T.type_alias { T::Hash[Symbol, T.untyped] }
@@ -70,6 +73,11 @@ module ValidatedObject
       nil
     end
 
+    def validated_attr(attribute_name, **validation_options)
+      attr_reader attribute_name
+      validates attribute_name, validation_options
+    end
+
     # Run any validations and raise an error if invalid.
     #
     # @raise [ArgumentError] if any validations fail.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: validated_object
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Robb Shecter
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-02-03 00:00:00.000000000 Z
+date: 2023-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -98,6 +98,7 @@ files:
 - bin/console
 - bin/setup
 - lib/validated_object.rb
+- lib/validated_object/simplified_api.rb
 - lib/validated_object/version.rb
 - script/demo.rb
 - sorbet/config
@@ -139,7 +140,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.4.20
 signing_key:
 specification_version: 4
 summary: Self-validating plain Ruby objects.