validated_object 1.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 97d91eb8801c44a0daecab2f6bf5e66c1dc34908
-  data.tar.gz: b53ae1848ed9176217969907ff95d4ceb6f0d06b
+SHA256:
+  metadata.gz: ba509cb442a5ef4c67d7186bd58b329551c00e137ec2c2b1cd7c4e268b92344a
+  data.tar.gz: 79a4f93be0f9919bf189f01258ed0379382df90aa01bc69a5ae883d924d53527
 SHA512:
-  metadata.gz: 7df6a6cacb4a691183fe606828b572a74e08b139d136e8e6826e5fd2ff3f441443b2f4ef451da96a65040075a46ecfee7e123da9f1ed911308c26b586e0482fe
-  data.tar.gz: 86ff719a5c3f23f76f843c049a1071b5ff79e6b20953ca482a3cedf33904adde167553d6efce284e067a0f69bb3841534f1bceb2d29a6bd01ed1dacd77bd8931
+  metadata.gz: d626a9f7e53258a92e5a0fa3a8cfabf4c7ba38e2c960466e29aaf98dacb7e433c02e3facaca3d2c96a3bd769077a3c3d6e1378b9631a48b6e307db88c8b91f98
+  data.tar.gz: 73771320ac4176387bbe336057c2459b5772898a68b380518e149f93af8a29243312462adda6f498a15fb777cb8e803e0db684bc41c130fc316135b63dcc9dac

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/README.md

@@ -2,78 +2,133 @@
 
 # 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
 
 
 ### Writing a self-validating object
 
-All of the [ActiveModel::Validations](http://api.rubyonrails.org/classes/ActiveModel/Validations/ClassMethods.html#method-i-validates) are available, plus a new one, `TypeValidator`.
+All of the [ActiveModel::Validations](http://api.rubyonrails.org/classes/ActiveModel/Validations/ClassMethods.html#method-i-validates) are available, plus a new one, `TypeValidator`.  
 
 ```ruby
 class Dog < ValidatedObject::Base
-  attr_accessor :name, :birthday
+  attr_accessor :name, :birthday  # attr_reader is supported as well for read-only attributes
 
   validates :name, presence: true
-  validates :birthday, type: Date, allow_nil: true
+  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.:
+
+```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')
+```
+
+```ruby
+# We can also explicitly test for validity because all of
+# ActiveModel::Validations is available.
+spot.valid?  # => true
+
+spot.birthday = Date.new(2015, 1, 23)
+spot.valid?  # => true
+```
 
-# We can also explicitly test for validity
-dog1.valid?  # => true
+### Good error messages
 
-dog1.birthday = Date.new(2015, 1, 23)
-dog1.valid?  # => true
+Any of the standard Validations methods can be
+used to test an instance, plus the custom `check_validations!` convenience method:
+
+```ruby
+spot.birthday = '2015-01-23'
+spot.valid?  # => false
+spot.check_validations!  # => ArgumentError: Birthday is class String, not Date
 ```
 
-### Making an instance _invalid_
+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
-dog1.birthday = '2015-01-23'
-dog1.valid?  # => false
-dog1.check_validations!  # => ArgumentError: Birthday is class String, not Date
+spot.name = nil
+spot.check_validations!  # => ArgumentError: Name can't be blank; Birthday is class String, not 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.
+
+## 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/version.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ValidatedObject
-  VERSION = '1.1.0'.freeze
+  VERSION = '2.0.0'.freeze
 end

data/lib/validated_object.rb

@@ -21,9 +21,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,19 +40,24 @@ module ValidatedObject
   class Base
     include ActiveModel::Validations
 
+    EMPTY_HASH = {}.freeze
+
     # Implements a pseudo-boolean class.
     class Boolean
     end
 
     # Instantiate and validate a new object.
-    #
-    # @yieldparam [ValidatedObject] new_object the yielded new object
-    #   for configuration.
+    # @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)
+
+      attributes.keys.each do |key|
+        self.instance_variable_set "@#{key}".to_sym, attributes.fetch(key)
+      end
       check_validations!
       self
     end
@@ -73,8 +76,8 @@ module ValidatedObject
     # @example Ensure that weight is a number
     #   class Dog < ValidatedObject::Base
     #     attr_accessor :weight, :neutered
-    #     validates :weight, type: Numeric
-    #     validates :neutered, type: Boolean
+    #     validates :weight, type: Numeric  # Typed and required
+    #     validates :neutered, type: Boolean, allow_nil: true  # Typed but optional
     #   end
     class TypeValidator < ActiveModel::EachValidator
       # @return [nil]
@@ -87,7 +90,7 @@ module ValidatedObject
           return if value.is_a?(expected_class)
         end
 
-        msg = options[:message] || "is class #{value.class}, not #{expected_class}"
+        msg = options[:message] || "is a #{value.class}, not a #{expected_class}"
         record.errors.add attribute, msg
       end
     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
+
+paris = Dog.new
+puts paris.inspect

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: validated_object
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Robb Shecter
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-04-13 00:00:00.000000000 Z
+date: 2018-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -85,6 +85,7 @@ 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
 licenses:
@@ -107,7 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.0
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Self-validating plain Ruby objects.