validated_object 2.3.2 → 2.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e8c1cd381c24230e549a4592119a36e35fca43f73681b4c1cdbec1dcb48022dc
-  data.tar.gz: 4d8d47dfff3955b08aefff6a7577ab8d5010b632a774edfa5ed1c65fad7a9f86
+  metadata.gz: 8938191d6ee1e84b60f0c659674952d9fbb56c7ea01bc2672194c8aee3120bf4
+  data.tar.gz: 2dd18069152f37b629030d10e0d46408bdec7369c36ed4407cbaa36baf2ff297
 SHA512:
-  metadata.gz: 2baf550c5d49bcd550ba9302cafa3614edb1412ed1e3b3680dfc1646067ace35bf80765f3c8ffbd1d08ede6796a54f684e9fdf6fc6f4464330f3114ad0c9d0eb
-  data.tar.gz: e0a5e3b267d696b9ece09d626413ffb1d6d76ffa4280dbff0c87b24b2454faca0d4f082cf522c58545d5677b8a526f9fe3a0427df8cdd6f85649e7daa3fedfec
+  metadata.gz: beb309f24b778cf42ea63d503669a68ff71d0bc2432fb961ce32bfb1f84b32bf9a7fe8acf1a62dc00f84aaf5cbaa95954720d4a22faf5e9b4dda439d6ef425a3
+  data.tar.gz: 5e8b97e5ff1e46279b0e81da5b7e7a110732c7c68507638e822f39fff3059f7da02d619a33ba1fb403bdfe21d8c9b5f4b4ce77f7fac9adf4048f6d2199ba7561

data/.rubocop.yml

@@ -0,0 +1,14 @@
+plugins:
+  - rubocop-rspec
+  - rubocop-rake
+
+AllCops:
+  SuggestExtensions: true
+  DisplayCopNames: true
+  ExtraDetails: true
+  Color: true
+  FormatStyleGuide: true
+  DisabledByDefault: false
+
+Lint/ConstantDefinitionInBlock:
+  Enabled: false

data/CLAUDE.md

@@ -0,0 +1,67 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Commands
+
+### Development Setup
+- `bin/setup` - Install dependencies (runs `bundle install`)
+- `bin/console` - Start an interactive console with the gem loaded
+
+### Testing and Quality
+- `rake spec` or `bundle exec rspec` - Run the test suite
+- `bundle exec rubocop` - Run code linting (with rubocop-rspec and rubocop-rake plugins)
+- `rake` - Default task (runs specs)
+
+### Gem Development
+- `bundle exec rake install` - Install gem locally for testing
+- `bundle exec rake release` - Release new version (updates version, creates git tag, pushes to rubygems.org)
+
+## Architecture
+
+This is a Ruby gem that provides self-validating Plain Old Ruby Objects using ActiveModel validations. The core architecture consists of:
+
+### Main Components
+
+**ValidatedObject::Base** (`lib/validated_object.rb`):
+- The main class that objects inherit from to gain validation capabilities
+- Includes `ActiveModel::Validations` for standard Rails validation methods
+- Automatically validates objects during instantiation via `initialize`
+- Provides `check_validations!` method for explicit validation with clear error messages
+- Contains a custom `TypeValidator` that supports type checking including arrays and pseudo-boolean validation
+
+**ValidatedObject::SimplifiedApi** (`lib/validated_object/simplified_api.rb`):
+- Provides convenience methods like `validates_attr` that combine `attr_reader` and `validates` 
+- Supports streamlined array element type validation with `[ElementType]` syntax
+- Allows `validated` as synonym for `validates`
+
+### Key Features
+
+- **Type Validation**: Custom `TypeValidator` supports class validation, pseudo-boolean (`Boolean` class), and array element type checking
+- **Array Element Validation**: Two syntaxes supported:
+  - `validates_attr :tags, type: Array, element_type: String`
+  - `validates_attr :tags, type: [String]` (streamlined syntax)
+- **Immutable Objects**: Uses `attr_reader` with instance variable setting to create read-only validated objects
+- **Clear Error Messages**: Validation failures provide descriptive messages like "Birthday is a String, not a Date"
+
+### Validation Patterns
+
+The gem follows a declarative pattern where classes define their validation rules upfront:
+
+```ruby
+class Dog < ValidatedObject::Base
+  validates_attr :name, presence: true
+  validates_attr :birthday, type: Date, allow_nil: true
+  validates_attr :tags, type: [String], allow_nil: true
+end
+```
+
+Objects validate themselves during instantiation and raise `ArgumentError` with detailed messages if invalid.
+
+## Development Notes
+
+- Requires Ruby 3.1+
+- Uses RSpec for testing with color output enabled
+- RuboCop configured with rspec and rake plugins
+- Gem specification allows pushing to rubygems.org
+- Demo script available at `script/demo.rb`

data/README.md

@@ -12,7 +12,7 @@ class Person < ValidatedObject::Base
 end
 
 # Instantiating it runs the validations.
-me  = Person.new(name: 'Robb')
+me  = Person.new(name: 'Robert')
 you = Person.new(name: '')     # => ArgumentError: "Name can't be blank"
 ```
 
@@ -82,6 +82,19 @@ validates :premium_membership, type: Boolean
 #...
 ```
 
+
+### Array element type validation
+
+You can validate that an attribute is an array of a specific type using array syntax:
+
+```ruby
+# Validate that names is an array of String objects.
+validates_attr :names, type: [String]
+```
+
+If the array contains any elements that are not of the specified type, validation will fail with a clear error message.
+
+
 ### Instantiating and automatically validating
 
 ```ruby
@@ -141,7 +154,7 @@ the data.
 
 ### Use in code generation
 
-My [Schema.org structured data gem](https://github.com/public-law/schema-dot-org) uses ValidatedObjects to recursively create well formed HTML / JSON-LD. 
+The [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

@@ -1,8 +1,10 @@
-require "active_support/concern"
+# frozen_string_literal: true
+
+require 'active_support/concern'
 
-# Enable a simplified API for the common case of
-# read-only ValidatedObjects.
 module ValidatedObject
+  # Enable a simplified API for the common case of
+  # read-only ValidatedObjects.
   module SimplifiedApi
     extend ActiveSupport::Concern
 
@@ -10,6 +12,7 @@ module ValidatedObject
       # Simply delegate to `attr_reader` and `validates`.
       def validated_attr(attribute, *options)
         attr_reader attribute
+
         validates attribute, *options
       end
 
@@ -17,7 +20,35 @@ module ValidatedObject
       def validated(*args, **kwargs, &block)
         validates(*args, **kwargs, &block)
       end
-    end
 
+      def validates_attr(attribute, *options, **kwargs)
+        attr_reader attribute
+
+        if kwargs[:type]
+          type_val = kwargs.delete(:type)
+          element_type = kwargs.delete(:element_type)
+
+          # Handle Union types - pass them through directly
+          if type_val.is_a?(ValidatedObject::Base::Union)
+            opts = { type: { with: type_val } }
+            validates attribute, opts.merge(kwargs)
+          # Parse Array[ElementType] syntax
+          elsif type_val.is_a?(Array) && type_val.length == 1 && type_val[0].is_a?(Class)
+            # This handles Array[Comment] syntax
+            element_type = type_val[0]
+            type_val = Array
+            opts = { type: { with: type_val } }
+            opts[:type][:element_type] = element_type if element_type
+            validates attribute, opts.merge(kwargs)
+          else
+            opts = { type: { with: type_val } }
+            opts[:type][:element_type] = element_type if element_type
+            validates attribute, opts.merge(kwargs)
+          end
+        else
+          validates attribute, *options, **kwargs
+        end
+      end
+    end
   end
 end

data/lib/validated_object/version.rb

@@ -1,6 +1,5 @@
-# typed: strict
 # frozen_string_literal: true
 
 module ValidatedObject
-  VERSION = '2.3.2'
+  VERSION = '2.3.4'
 end

data/lib/validated_object.rb

@@ -1,12 +1,9 @@
-# typed: true
 # frozen_string_literal: true
 
 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
   #   to create custom validating objects.
@@ -46,11 +43,8 @@ module ValidatedObject
   class Base
     include ActiveModel::Validations
     include SimplifiedApi
-    extend T::Sig
-
-    SymbolHash = T.type_alias { T::Hash[Symbol, T.untyped] }
 
-    EMPTY_HASH = T.let({}.freeze, SymbolHash)
+    EMPTY_HASH = {}.freeze
 
     # A private class definition, not intended to
     # be used directly. Implements a pseudo-boolean class
@@ -60,21 +54,35 @@ module ValidatedObject
     class Boolean
     end
 
+    # A private class definition for union types.
+    # Stores multiple allowed types for validation.
+    # Created via ValidatedObject::Base.union(*types)
+    #
+    # @example
+    #   validates :id, type: union(String, Integer)
+    #   validates :data, type: union(Hash, [Hash])
+    class Union
+      attr_reader :types
+
+      def initialize(*types)
+        @types = types
+      end
+    end
+
     # Instantiate and validate a new object.
     # @example
     #   maru = Dog.new(birthday: Date.today, name: 'Maru')
     #
     # @raise [ArgumentError] if the object is not valid at the
     #   end of initialization or `attributes` is not a Hash.
-    sig { params(attributes: SymbolHash).void }
     def initialize(attributes = EMPTY_HASH)
       set_instance_variables from_hash: attributes
       check_validations!
-      nil
     end
 
     def validated_attr(attribute_name, **validation_options)
       attr_reader attribute_name
+
       validates attribute_name, validation_options
     end
 
@@ -82,7 +90,6 @@ module ValidatedObject
     #
     # @raise [ArgumentError] if any validations fail.
     # @return [ValidatedObject::Base] the receiver
-    sig { returns(ValidatedObject::Base) }
     def check_validations!
       raise ArgumentError, errors.full_messages.join('; ') if invalid?
 
@@ -102,22 +109,30 @@ module ValidatedObject
     #     validates :neutered, type: Boolean, allow_nil: true  # Typed but optional
     #   end
     class TypeValidator < ActiveModel::EachValidator
-      extend T::Sig
-
       # @return [nil]
-      sig do
-        params(
-          record: T.untyped,
-          attribute: T.untyped,
-          value: T.untyped
-        )
-          .void
-      end
       def validate_each(record, attribute, value)
-        validation_options = T.let(options, SymbolHash)
-
+        validation_options = options
         expected_class = validation_options[:with]
 
+        # Support union types
+        if expected_class.is_a?(Union)
+          return if validate_union_type(record, attribute, value, expected_class, validation_options)
+
+          save_union_error(record, attribute, value, expected_class, validation_options)
+          return
+        end
+
+        # Support type: Array, element_type: ElementType
+        if expected_class == Array && validation_options[:element_type]
+          return save_error(record, attribute, value, validation_options) unless value.is_a?(Array)
+
+          element_type = validation_options[:element_type]
+          unless value.all? { |el| el.is_a?(element_type) }
+            record.errors.add attribute, validation_options[:message] || "contains non-#{element_type} elements"
+          end
+          return
+        end
+
         return if pseudo_boolean?(expected_class, value) ||
                   expected_class?(expected_class, value)
 
@@ -126,34 +141,71 @@ module ValidatedObject
 
       private
 
-      sig { params(expected_class: T.untyped, value: T.untyped).returns(T.untyped) }
       def pseudo_boolean?(expected_class, value)
         expected_class == Boolean && boolean?(value)
       end
 
-      sig { params(expected_class: T.untyped, value: T.untyped).returns(T.untyped) }
       def expected_class?(expected_class, value)
         value.is_a?(expected_class)
       end
 
-      sig { params(value: T.untyped).returns(T.untyped) }
       def boolean?(value)
         value.is_a?(TrueClass) || value.is_a?(FalseClass)
       end
 
-      sig do
-        params(
-          record: T.untyped,
-          attribute: T.untyped,
-          value: T.untyped,
-          validation_options: SymbolHash
-        )
-          .void
-      end
       def save_error(record, attribute, value, validation_options)
         record.errors.add attribute,
                           validation_options[:message] || "is a #{value.class}, not a #{validation_options[:with]}"
       end
+
+      def validate_union_type(_record, _attribute, value, union, _validation_options)
+        union.types.any? do |type_spec|
+          if type_spec.is_a?(Array) && type_spec.length == 1
+            # Handle [ElementType] syntax within union
+            validate_array_element_type(value, type_spec[0])
+          elsif type_spec.is_a?(Class) || type_spec == Boolean
+            # Handle class types (String, Integer, etc.) and pseudo-boolean
+            pseudo_boolean?(type_spec, value) || expected_class?(type_spec, value)
+          else
+            # Handle literal values (symbols, strings, numbers, etc.)
+            value == type_spec
+          end
+        end
+      end
+
+      def validate_array_element_type(value, element_type)
+        return false unless value.is_a?(Array)
+
+        value.all? { |el| el.is_a?(element_type) }
+      end
+
+      def save_union_error(record, attribute, value, union, validation_options)
+        return if validation_options[:message]
+
+        type_names = union.types.map do |type_spec|
+          if type_spec.is_a?(Array) && type_spec.length == 1
+            "Array of #{type_spec[0]}"
+          elsif type_spec.is_a?(Class) || type_spec == Boolean
+            type_spec.to_s
+          else
+            # For literal values like :active, show them as-is
+            type_spec.inspect
+          end
+        end
+
+        message = if type_names.length == 1
+                    "is a #{value.class}, not one of #{type_names.first}"
+                  else
+                    "is a #{value.class}, not one of #{type_names.join(', ')}"
+                  end
+
+        record.errors.add attribute, message
+      end
+    end
+
+    # Register the TypeValidator with ActiveModel so `type:` validation option works
+    unless ActiveModel::Validations.const_defined?(:TypeValidator)
+      ActiveModel::Validations.const_set(:TypeValidator, TypeValidator)
     end
 
     # Allow 'validated' as a synonym for 'validates'
@@ -161,10 +213,21 @@ module ValidatedObject
       validates(*args, **kwargs, &block)
     end
 
+    # Create a union type specification for validation
+    # @param types [Array] The types that are allowed
+    # @return [Union] A union type specification
+    # @example
+    #   validates :id, type: union(String, Integer)
+    #   validates :data, type: union(Hash, [Hash])
+    def self.union(*types)
+      Union.new(*types)
+    end
+
     private
 
-    sig { params(from_hash: SymbolHash).void }
     def set_instance_variables(from_hash:)
+      raise TypeError, "#{from_hash} is not a hash" unless from_hash.is_a?(Hash)
+
       from_hash.each do |variable_name, variable_value|
         # Test for the attribute reader
         send variable_name.to_sym

data/script/demo.rb

@@ -1,9 +1,9 @@
-# typed: ignore
 require 'date'
 require 'validated_object'
 
 class Dog < ValidatedObject::Base
   attr_reader :name, :birthday
+
   validates :name, presence: true
   validates :birthday, type: Date, allow_nil: true
 end
@@ -15,4 +15,4 @@ maru = Dog.new(birthday: Date.today, name: 'Maru')
 puts maru.inspect
 
 hiro = Dog.new(birthday: 'today')
-puts hiro.inspect
+puts hiro.inspect

data/validated_object.gemspec

@@ -19,11 +19,9 @@ Gem::Specification.new do |spec|
 
   # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
   # delete this section to allow pushing this gem to any host.
-  if spec.respond_to?(:metadata)
-    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
-  else
-    raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
-  end
+  raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.' unless spec.respond_to?(:metadata)
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.bindir        = 'exe'
@@ -32,8 +30,9 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'rake', '>= 12.3.3'
   spec.add_development_dependency 'rspec', '>= 3.9.0'
-  spec.add_development_dependency 'sorbet', '>= 0.5.5890'
+  spec.add_development_dependency 'rubocop', '>= 1.80.0'
+  spec.add_development_dependency 'rubocop-rake', '>= 0.0.0'
+  spec.add_development_dependency 'rubocop-rspec', '>= 0.0.0'
 
   spec.add_runtime_dependency 'activemodel', '>= 3.2.21'
-  spec.add_runtime_dependency 'sorbet-runtime', '>= 0.5.5890'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: validated_object
 version: !ruby/object:Gem::Version
-  version: 2.3.2
+  version: 2.3.4
 platform: ruby
 authors:
 - Robb Shecter
@@ -38,47 +38,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 3.9.0
 - !ruby/object:Gem::Dependency
-  name: sorbet
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.5890
+        version: 1.80.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.5890
+        version: 1.80.0
 - !ruby/object:Gem::Dependency
-  name: activemodel
+  name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.21
-  type: :runtime
+        version: 0.0.0
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.21
+        version: 0.0.0
 - !ruby/object:Gem::Dependency
-  name: sorbet-runtime
+  name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.5890
+        version: 0.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.0
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.21
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.5890
+        version: 3.2.21
 description: A small wrapper around ActiveModel Validations.
 email:
 - robb@public.law
@@ -89,7 +103,9 @@ files:
 - ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
+- CLAUDE.md
 - Gemfile
 - HISTORY.md
 - LICENSE.txt
@@ -101,24 +117,6 @@ files:
 - lib/validated_object/simplified_api.rb
 - lib/validated_object/version.rb
 - script/demo.rb
-- sorbet/config
-- sorbet/rbi/gems/activemodel.rbi
-- sorbet/rbi/gems/activesupport.rbi
-- sorbet/rbi/gems/concurrent-ruby.rbi
-- sorbet/rbi/gems/i18n.rbi
-- sorbet/rbi/gems/rake.rbi
-- sorbet/rbi/gems/rspec-core.rbi
-- sorbet/rbi/gems/rspec-expectations.rbi
-- sorbet/rbi/gems/rspec-mocks.rbi
-- sorbet/rbi/gems/rspec-support.rbi
-- sorbet/rbi/gems/rspec.rbi
-- sorbet/rbi/gems/site_ruby.rbi
-- sorbet/rbi/gems/thread_safe.rbi
-- sorbet/rbi/gems/tzinfo.rbi
-- sorbet/rbi/sorbet-typed/lib/activemodel/all/activemodel.rbi
-- sorbet/rbi/sorbet-typed/lib/activesupport/>=6/activesupport.rbi
-- sorbet/rbi/sorbet-typed/lib/activesupport/all/activesupport.rbi
-- sorbet/rbi/sorbet-typed/lib/minitest/all/minitest.rbi
 - validated_object.gemspec
 homepage: https://github.com/public-law/validated_object
 licenses:
@@ -139,7 +137,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 3.7.1
 specification_version: 4
 summary: Self-validating plain Ruby objects.
 test_files: []

data/sorbet/config

@@ -1,2 +0,0 @@
---dir
-.