validated_object 2.3.0 → 2.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cbb448bc227821b65819e57ae210f715ea5295bf4c7f2e14925e560340a56a38
-  data.tar.gz: 7e78815f3603aedfe4e4eda9cf5e626a64d0ef91f3f237b78a13e110697ce999
+  metadata.gz: 03a54694b8208e1e788cd55ece182bacdbfa75f3389db8c0dcc8902df92d9822
+  data.tar.gz: 03c58a85faa371f663201c0deb0e7ed8cb021f35aae8d3568e18f24e7db09c59
 SHA512:
-  metadata.gz: 75745c4db0c873e4a4a5f63ca792a8646abcf5402408d0824e9a704e11112d91c5c303de4a4cf6addffd61ed9532f7327f602442c10ab4969b9332a6e3b6e161
-  data.tar.gz: 4fa2b7800b2675469d85d5ce9a69f5bf2683fc56376f2bfa0fb623fd0491ad2d1c0833d44f55e124ebf067cc04066a5afd3f7d9ad6ea9d76d87ae00f917b770e
+  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,21 +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**.
-Here's a quick example of a common case: a class with an immutable,
-required, type-checked attribute:
+`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
-  validated_attr :name, type: String, presence: true
+  attr_reader :name
+  validates :name, presence: true
 end
 
-# Using it
-me = Person.new(name: 'Robb')
+# Instantiating it runs the validations.
+me  = Person.new(name: 'Robb')
+you = Person.new(name: '')     # => ArgumentError: "Name can't be blank"
 ```
 
-I use classes like these as Data Transfer Objects at my system boundaries.
+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
@@ -24,7 +25,7 @@ I use classes like these as Data Transfer Objects at my system boundaries.
 * Clean, minimal syntax
 
 This is a small layer around
-[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).
+[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
@@ -47,7 +48,7 @@ class Dog < ValidatedObject::Base
 end
 ```
 
-We can make it immutable with `attr_reader`:
+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
@@ -58,10 +59,11 @@ class ImmutableDog < ValidatedObject::Base
 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`.
+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 simplified DSL:
+Here's the immutable version of `Dog` re-written with the new, simplified DSL:
 
 ```ruby
 class ImmutableDog < ValidatedObject::Base
@@ -139,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/version.rb

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

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.3.0
+  version: 2.3.1
 platform: ruby
 authors:
 - Robb Shecter
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-10-12 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"
@@ -125,7 +125,6 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -133,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.20
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Self-validating plain Ruby objects.
 test_files: []