validated_object 1.0.0 → 2.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 917e06893558682ef44f4ae1570d73bb265dc980
-  data.tar.gz: b622a865760b6b3626ed1f270313ef26686371f6
+SHA256:
+  metadata.gz: 0c1aef88260ebc19d28fa8bd90a400ec6d05c45a60fea1632ebb1b81bbe2b456
+  data.tar.gz: 239216afd24adc90bb9ae4641253443a91d303e312f49b7bc6f348c541563f5f
 SHA512:
-  metadata.gz: 95affa10a6d3ee9efc02ced04778a8df4adab2e03a914086afbe79717c679454766be1aae77d2aaa7f7da670b82ed5baf9dc20bf0a0b6c6b0c0527123ab2c732
-  data.tar.gz: 079acd77f94c7c4664534a489fe5525ad47ab38883e666ea8575065138ce158c6d4b73a42d14b9ed175400e8e8251db2a44ff3b11811fb45229444fe6712d64d
+  metadata.gz: 032c79475b1a99e990f4b04da2cda94cd5cca556cb38e385a783300ef675bfcd2ed51cc055d653b86f77b70270de87518cd7296b1c754a108f11c70d4e989c86
+  data.tar.gz: affdd5eb1d8dd2525c6b0fd7730fb907317ce0ad3bf8f105b42d67c66aba69e3389c65f7eae85dbfc67ed273e242761a34c67210153f4d9cbaaa694a3e6cac57

data/.travis.yml

@@ -1,5 +1,5 @@
 language: ruby
 rvm:
-  - 2.1
   - 2.2.2
+  - 2.3.1
 before_install: gem install bundler -v 1.10.6

data/HISTORY.md

@@ -0,0 +1,2 @@
+# 1.1.0
+Introduces the new Boolean pseudo-type.

data/README.md

@@ -1,28 +1,18 @@
-[![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
 
-Uses
-[ActiveModel::Validations](http://api.rubyonrails.org/classes/ActiveModel/Validations/ClassMethods.html#method-i-validates)
-to create self-validating Plain Old Ruby objects. I wrote it for helping with CSV data imports into my Rails apps.
-Very readable error messages are also important in that context, to track down parsing errors. This gem provides those too.
+Plain Old Ruby Objects + Rails Validations = **self-checking Ruby objects**.
 
 
-## Installation
+## Goals
 
-Add this line to your application's Gemfile:
+* Very readable error messages
+* Clean, minimal syntax
 
-```ruby
-gem 'validated_object'
-```
+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).
 
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install validated_object
 
 ## Usage
 
@@ -33,47 +23,120 @@ All of the [ActiveModel::Validations](http://api.rubyonrails.org/classes/ActiveM
 
 ```ruby
 class Dog < ValidatedObject::Base
-  attr_accessor :name, :birthday
+  # Plain old Ruby
+  attr_accessor :name, :birthday  # attr_reader is supported as well for read-only attributes
 
+  # Plain old Rails
   validates :name, presence: true
-  validates :birthday, type: Date, allow_nil: 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 included `TypeValidator` is what enables `type: Date`, above. All classes can be checked, as well as a pseudo-class `Boolean`. E.g.:
+
+```ruby
+#...
+validates :premium_membership, type: Boolean
+#...
+```
+
 ### Instantiating and automatically validating
 
 ```ruby
-# The dog1 instance validates itself at the end of instantiation.
-# Here, it succeeds and so doesn't raise an exception.
-dog1 = Dog.new do |d|
-  d.name = 'Spot'
-end
+# This Dog instance validates itself at the end of instantiation.
+spot = Dog.new(name: 'Spot')
+```
 
-# We can also explicitly test for validity
-dog1.valid?  # => true
+```ruby
+# We can also explicitly test for validity because all of
+# ActiveModel::Validations is available.
+spot.valid?  # => true
 
-dog1.birthday = Date.new(2015, 1, 23)
-dog1.valid?  # => true
+spot.birthday = Date.new(2015, 1, 23)
+spot.valid?  # => true
 ```
 
-### Making an instance _invalid_
+### Good error messages
+
+Any of the standard Validations methods can be
+used to test an instance, plus the custom `check_validations!` convenience method:
 
 ```ruby
-dog1.birthday = '2015-01-23'
-dog1.valid?  # => false
-dog1.check_validations!  # => ArgumentError: Birthday is class String, not Date
+spot.birthday = '2015-01-23'
+spot.valid?  # => false
+spot.check_validations!  # => ArgumentError: Birthday is a String, not a Date
 ```
 
+Note the clear, explicit error message. These are great when reading a log
+file following a data import. It describes all the invalid conditions. Let's 
+test it by making another attribute invalid:
+
+```ruby
+spot.name = nil
+spot.check_validations!  # => ArgumentError: Name can't be blank; Birthday is a String, not a Date
+```
+
+
+### Use in parsing data
+
+I often use a validated object in a loop to import data, e.g.:
+
+```ruby
+# Import a CSV file of dogs
+dogs = []
+csv.next_row do |row|
+  begin
+    dogs << Dog.new(name: row.name)
+  rescue ArgumentError => e
+    logger.warn(e)
+  end
+end
+```
+
+The result is that `dogs` is an array of guaranteed valid Dog objects. And the
+error log lists unparseable rows with good info for tracking down problems in
+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. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'validated_object'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install validated_object
+
+
 
 ## Development
 
-(TODO: Verify these instructions.) After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+(TODO: Verify these instructions.) After checking out the repo, run `bin/setup`
+to install dependencies. Then, run `rake spec` to run the tests. You can also
+run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release`, which will create a git tag for the version, push
+git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/dogweather/validated_object.
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/dogweather/validated_object.
 
 
 ## License

data/lib/validated_object.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_model'
 require 'validated_object/version'
 
@@ -5,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.
@@ -21,9 +23,7 @@ module ValidatedObject
   # @example Instantiating and automatically validating
   #   # The dog1 instance validates itself at the end of instantiation.
   #   # Here, it succeeds and so doesn't raise an exception.
-  #   dog1 = Dog.new do |d|
-  #     d.name = 'Spot'
-  #   end
+  #   dog1 = Dog.new name: 'Spot'
   #
   #   # We can also explicitly test for validity
   #   dog1.valid?  # => true
@@ -42,44 +42,93 @@ module ValidatedObject
   class Base
     include ActiveModel::Validations
 
-    # Instantiate and validate a new object.
+    EMPTY_HASH = {}.freeze
+
+    # A private class definition, not intended to
+    # be used directly. Implements a pseudo-boolean class
+    # enabling validations like this:
     #
-    # @yieldparam [ValidatedObject] new_object the yielded new object
-    #   for configuration.
+    #   validates :enabled, type: Boolean
+    class Boolean
+    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.
-    def initialize
-      yield(self)
+    #   end of initialization or `attributes` is not a Hash.
+    def initialize(attributes=EMPTY_HASH)
+      raise ArgumentError, "#{attributes} is not a Hash" unless attributes.is_a?(Hash)
+
+      set_instance_variables from_hash: attributes
       check_validations!
-      self
+      return self
     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
     end
 
     # A custom validator which ensures an object is an instance of a class
-    # or a subclass.
-    # It's here as a nested class in {ValidatedObject} for easy
-    # access by subclasses of {ValidatedObject::Base}.
+    # 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
-    #     validates :weight, type: Numeric
+    #     attr_accessor :weight, :neutered
+    #     validates :weight, type: Numeric  # Typed and required
+    #     validates :neutered, type: Boolean, allow_nil: true  # Typed but optional
     #   end
     class TypeValidator < ActiveModel::EachValidator
       # @return [nil]
       def validate_each(record, attribute, value)
-        expected = options[:with]
-        return if value.kind_of?(expected)
+        expected_class = options[:with]
+
+        return if pseudo_boolean?(expected_class, value) ||
+                  expected_class?(expected_class, value)
+
+        save_error(record, attribute, value, options)
+      end
+
+
+      private
+
+      def pseudo_boolean?(expected_class, value)
+        expected_class == Boolean && boolean?(value)
+      end
+
+      def expected_class?(expected_class, value)
+        value.is_a?(expected_class)
+      end
+
+      def boolean?(value)
+        value.is_a?(TrueClass) || value.is_a?(FalseClass)
+      end
+
+      def save_error(record, attribute, value, options)
+        record.errors.add attribute,
+                          options[:message] || "is a #{value.class}, not a #{options[:with]}"
+      end
+    end
+
+
+    private
+
+    def set_instance_variables(from_hash:)
+      from_hash.each do |variable_name, variable_value|
+        # Test for the attribute reader
+        self.send variable_name.to_sym
 
-        msg = options[:message] || "is class #{value.class}, not #{expected}"
-        record.errors.add attribute, msg
+        # Set value in a way that succeeds even if attr is read-only
+        self.instance_variable_set "@#{variable_name}".to_sym, variable_value
       end
     end
   end

data/lib/validated_object/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ValidatedObject
-  VERSION = '1.0.0'.freeze
+  VERSION = '2.0.3'
 end

data/script/demo.rb

@@ -0,0 +1,17 @@
+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
+
+phoebe = Dog.new(name: 'Phoebe')
+puts phoebe.inspect
+
+maru = Dog.new(birthday: Date.today, name: 'Maru')
+puts maru.inspect
+
+hiro = Dog.new(birthday: 'today')
+puts hiro.inspect

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: 1.0.0
+  version: 2.0.3
 platform: ruby
 authors:
 - Robb Shecter
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2016-03-25 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: []
@@ -77,6 +63,7 @@ files:
 - ".rspec"
 - ".travis.yml"
 - Gemfile
+- HISTORY.md
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -84,13 +71,14 @@ files:
 - bin/setup
 - lib/validated_object.rb
 - 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
@@ -105,10 +93,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.0
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Self-validating plain Ruby objects.
 test_files: []
-has_rdoc: