validated_object 2.0.2 → 2.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9a4dc2f4ddb469aa576852bcaf36c911fdd948c7004587845addd89b942a1e2
-  data.tar.gz: 553d9e9974c1e3b833f5a8501e5fea4ecea54d8bb9188403a316fbea3b13f49f
+  metadata.gz: 0c1aef88260ebc19d28fa8bd90a400ec6d05c45a60fea1632ebb1b81bbe2b456
+  data.tar.gz: 239216afd24adc90bb9ae4641253443a91d303e312f49b7bc6f348c541563f5f
 SHA512:
-  metadata.gz: 7c0c33890be210b01c5b412795265c6c2babe78ab09f8f9743185b5134f659be85d42ff755428f73097cd0cd699fa8cb026311810fbf8ece289a7548e3e22081
-  data.tar.gz: 36dd56f3e89c9911ffa7984f97ce3c0966f879e331f5b6141a3773948598e8eae712f0a6fbb5df9fadf9fc481176cb18a2f1537a93ba64f73cfd11070b3716dc
+  metadata.gz: 032c79475b1a99e990f4b04da2cda94cd5cca556cb38e385a783300ef675bfcd2ed51cc055d653b86f77b70270de87518cd7296b1c754a108f11c70d4e989c86
+  data.tar.gz: affdd5eb1d8dd2525c6b0fd7730fb907317ce0ad3bf8f105b42d67c66aba69e3389c65f7eae85dbfc67ed273e242761a34c67210153f4d9cbaaa694a3e6cac57

data/README.md

@@ -1,8 +1,8 @@
-[![Gem Version](https://badge.fury.io/rb/validated_object.svg)](https://badge.fury.io/rb/validated_object) [![Build Status](https://travis-ci.org/dogweather/validated_object.svg?branch=master)](https://travis-ci.org/dogweather/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) [![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)
 
 # ValidatedObject
 
-Plain Old Ruby Objects + Rails Validations = self-checking Ruby objects.
+Plain Old Ruby Objects + Rails Validations = **self-checking Ruby objects**.
 
 
 ## Goals
@@ -28,11 +28,13 @@ class Dog < ValidatedObject::Base
 
   # Plain old Rails
   validates :name, presence: true
+  
+  # A new type-validation if you'd like to use it
   validates :birthday, type: Date, allow_nil: true  # Strongly typed but optional
 end
 ```
 
-The `TypeValidator` is what enables `type: Date`, above. All classes can be checked, as well as a pseudo-class `Boolean`. E.g.:
+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.rb

@@ -7,7 +7,7 @@ module ValidatedObject
   # @abstract Subclass and add `attr_accessor` and validations
   #   to create custom validating objects.
   #
-  # Uses [ActiveModel::Validations](http://api.rubyonrails.org/classes/ActiveModel/Validations/ClassMethods.html#method-i-validates)
+  # Uses {http://api.rubyonrails.org/classes/ActiveModel/Validations/ClassMethods.html#method-i-validates ActiveModel::Validations}
   # to create self-validating Plain Old Ruby objects. This is especially
   # useful when importing data from one system into another. This class also
   # creates very readable error messages.
@@ -44,7 +44,11 @@ module ValidatedObject
 
     EMPTY_HASH = {}.freeze
 
-    # Implements a pseudo-boolean class.
+    # A private class definition, not intended to
+    # be used directly. Implements a pseudo-boolean class
+    # enabling validations like this:
+    #
+    #   validates :enabled, type: Boolean
     class Boolean
     end
 
@@ -63,7 +67,9 @@ module ValidatedObject
     end
 
     # Run any validations and raise an error if invalid.
+    #
     # @raise [ArgumentError] if any validations fail.
+    # @return [ValidatedObject::Base] the receiver
     def check_validations!
       raise ArgumentError, errors.full_messages.join('; ') if invalid?
       self
@@ -73,6 +79,8 @@ module ValidatedObject
     # or a subclass. It supports a pseudo-boolean class for convenient
     # validation. (Ruby doesn't have a built-in Boolean.)
     #
+    # Automatically used in a `type` validation:
+    #
     # @example Ensure that weight is a number
     #   class Dog < ValidatedObject::Base
     #     attr_accessor :weight, :neutered
@@ -106,7 +114,7 @@ module ValidatedObject
       end
 
       def save_error(record, attribute, value, options)
-        record.errors.add attribute, 
+        record.errors.add attribute,
                           options[:message] || "is a #{value.class}, not a #{options[:with]}"
       end
     end

data/lib/validated_object/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ValidatedObject
-  VERSION = '2.0.2'
+  VERSION = '2.0.3'
 end

data/validated_object.gemspec

@@ -1,5 +1,6 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'validated_object/version'
 
@@ -7,11 +8,11 @@ Gem::Specification.new do |spec|
   spec.name          = 'validated_object'
   spec.version       = ValidatedObject::VERSION
   spec.authors       = ['Robb Shecter']
-  spec.email         = ['robb@weblaws.org']
+  spec.email         = ['robb@public.law']
 
   spec.summary       = 'Self-validating plain Ruby objects.'
   spec.description   = 'A small wrapper around ActiveModel Validations.'
-  spec.homepage      = 'https://github.com/dogweather/validated_object'
+  spec.homepage      = 'https://github.com/public-law/validated_object'
   spec.license       = 'MIT'
 
   # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
@@ -27,8 +28,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.10'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake', '>= 12.3.3'
   spec.add_development_dependency 'rspec'
 
   spec.add_runtime_dependency 'activemodel', '>= 3.2.21'

metadata

@@ -1,43 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: validated_object
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.0.3
 platform: ruby
 authors:
 - Robb Shecter
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2018-04-05 00:00:00.000000000 Z
+date: 2020-08-23 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.10'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.10'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -68,7 +54,7 @@ dependencies:
         version: 3.2.21
 description: A small wrapper around ActiveModel Validations.
 email:
-- robb@weblaws.org
+- robb@public.law
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -87,12 +73,12 @@ files:
 - lib/validated_object/version.rb
 - script/demo.rb
 - validated_object.gemspec
-homepage: https://github.com/dogweather/validated_object
+homepage: https://github.com/public-law/validated_object
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -107,9 +93,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.5
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Self-validating plain Ruby objects.
 test_files: []