validated_object 2.2.0 → 2.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 66bdc1ee048b6518b260908a2a48e8c4676c4350f99641a0da1c041fdc82a530
-  data.tar.gz: 27e9c03469ee86a4875fc9b99d8796055f12e48f7c627bbf410c7b43468c6022
+  metadata.gz: 03a54694b8208e1e788cd55ece182bacdbfa75f3389db8c0dcc8902df92d9822
+  data.tar.gz: 03c58a85faa371f663201c0deb0e7ed8cb021f35aae8d3568e18f24e7db09c59
 SHA512:
-  metadata.gz: 667688231472cb2d893ac1235be71c97111831f8f8510164c5152e4d37d4bd99b994c4cb189a36f1feb4af5786d0200b14e74ba27e69b7be3e1929795419d2db
-  data.tar.gz: ed1589b44cf7c83d7424ce46b5b09cb1990331aee38bee239232ed2e71b49b32a0c65e2a3fc4ad909c44cd2df1e0b81ee9e65b3191f35621ec50e1be2b499f30
+  metadata.gz: 9f3bf8d6e81b2359e60f830d493e0a4fed9997bc21fa21c33f838794300e1b97514999ab42fb478a5cd22562ec89aa0dcfddf3a2c127b6b804f9f5f34faaea11
+  data.tar.gz: 5f05239f7150ffc10dc11544717298ec6500804ba4ab764cc8ba1dcb0bf1c6af7dfe59c927c829183902b575b2133ebc5278d2b1b9a3d8cd701dda8fd7a08f4d

data/.github/workflows/ruby.yml

@@ -0,0 +1,37 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['3.1', '3.2', '3.3', '3.4']
+
+    steps:
+    - uses: actions/checkout@v3
+    
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    
+    - name: Run tests
+      run: bundle exec rake

data/README.md

@@ -1,8 +1,22 @@
-[![Gem Version](https://badge.fury.io/rb/validated_object.svg)](https://badge.fury.io/rb/validated_object) [![Build Status](https://travis-ci.org/public-law/validated_object.svg?branch=master)](https://travis-ci.org/public-law/validated_object) [![Code Climate](https://codeclimate.com/github/dogweather/validated_object/badges/gpa.svg)](https://codeclimate.com/github/dogweather/validated_object)
-
+[![Gem Version](https://badge.fury.io/rb/validated_object.svg)](https://badge.fury.io/rb/validated_object) 
 # ValidatedObject
 
-Plain Old Ruby Objects + Rails Validations = **self-checking Ruby objects**.
+`Plain Old Ruby` + `Rails Validations` = **self-checking Ruby objects**.
+
+## Example: A `Person` class that ensures its `name` isn't blank (nil or empty string):
+
+```ruby
+class Person < ValidatedObject::Base
+  attr_reader :name
+  validates :name, presence: true
+end
+
+# Instantiating it runs the validations.
+me  = Person.new(name: 'Robb')
+you = Person.new(name: '')     # => ArgumentError: "Name can't be blank"
+```
+
+Note how Person's two lines of code are nothing new: `attr_reader` is standard Ruby. [`validates`](https://guides.rubyonrails.org/active_record_validations.html) is standard Rails. I use classes like these as Data Transfer Objects at my system boundaries.
 
 
 ## Goals
@@ -11,7 +25,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](https://guides.rubyonrails.org/active_record_validations.html), you're good to go. I wrote this to help with CSV data imports and [website structured data](https://github.com/public-law/schema-dot-org).
 
 
 ## Usage
@@ -24,7 +38,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 +48,32 @@ class Dog < ValidatedObject::Base
 end
 ```
 
+Alternatively, we could make it immutable with Ruby's [attr_reader](https://bootrails.com/blog/ruby-attr-accessor-attr-writer-attr-reader/#2-attr_reader-attr_writer--attr_accessor):
+
+```ruby
+class ImmutableDog < ValidatedObject::Base
+  attr_reader :name, :birthday
+
+  validates :name, presence: true
+  validates :birthday, type: Date, allow_nil: true
+end
+```
+
+And again, that `ImmutableDog` consists of one line of plain Ruby and two lines of standard Rails validations.
+
+### `attr_reader` followed by `validates` is such a common pattern that there's a DSL which wraps them up into one call: `validates_attr`.
+
+Here's the immutable version of `Dog` re-written with the new, 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
@@ -101,7 +141,7 @@ the data.
 
 ### Use in code generation
 
-My [Schema.org microdata generation gem](https://github.com/dogweather/schema-dot-org) uses ValidatedObjects to recursively create well formed HTML / JSON-LD. 
+My [Schema.org structured data gem](https://github.com/public-law/schema-dot-org) uses ValidatedObjects to recursively create well formed HTML / JSON-LD. 
 
 ## Installation
 

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.1'
 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.

data/validated_object.gemspec

@@ -5,6 +5,8 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'validated_object/version'
 
 Gem::Specification.new do |spec|
+  spec.required_ruby_version = '>= 3.1'
+
   spec.name          = 'validated_object'
   spec.version       = ValidatedObject::VERSION
   spec.authors       = ['Robb Shecter']

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: validated_object
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.1
 platform: ruby
 authors:
 - Robb Shecter
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-02-03 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -87,6 +86,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -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
@@ -124,7 +125,6 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -132,15 +132,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Self-validating plain Ruby objects.
 test_files: []