validated_object 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba509cb442a5ef4c67d7186bd58b329551c00e137ec2c2b1cd7c4e268b92344a
-  data.tar.gz: 79a4f93be0f9919bf189f01258ed0379382df90aa01bc69a5ae883d924d53527
+  metadata.gz: ead35b1f631106e09d5ed245b18ced301b0fd22a642136d2198dc65f592feb72
+  data.tar.gz: 119b6594bedc0b63a11256ae7e40dccf67561cab4acccf6a67b7c3a08789642d
 SHA512:
-  metadata.gz: d626a9f7e53258a92e5a0fa3a8cfabf4c7ba38e2c960466e29aaf98dacb7e433c02e3facaca3d2c96a3bd769077a3c3d6e1378b9631a48b6e307db88c8b91f98
-  data.tar.gz: 73771320ac4176387bbe336057c2459b5772898a68b380518e149f93af8a29243312462adda6f498a15fb777cb8e803e0db684bc41c130fc316135b63dcc9dac
+  metadata.gz: 371f7b30919720b846b2d0a8f1b065e011da484632f889cf98b21847f34b41d1b4ed0bf213662f6876bdbbd088faede79e054ed83284cc9d589bdc8dd4fc52a3
+  data.tar.gz: 8c9c3ea80f2924d23bd9297852b557f373a4bdcdb26785ef279730dbec5d3c372740be475f36652ece87884e6ec92bae13a5ea7b488e032ba684fdb29354ee09

data/README.md

@@ -2,7 +2,7 @@
 
 # ValidatedObject
 
-Plain Old Ruby Objects + Rails Validations = self-checking Ruby objects. 
+Plain Old Ruby Objects + Rails Validations = self-checking Ruby objects.
 
 
 ## Goals
@@ -19,12 +19,14 @@ This is a small layer around
 
 ### 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
+  # 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  # Strongly typed but optional
 end
@@ -62,7 +64,7 @@ used to test an instance, plus the custom `check_validations!` convenience metho
 ```ruby
 spot.birthday = '2015-01-23'
 spot.valid?  # => false
-spot.check_validations!  # => ArgumentError: Birthday is class String, not Date
+spot.check_validations!  # => ArgumentError: Birthday is a String, not a Date
 ```
 
 Note the clear, explicit error message. These are great when reading a log
@@ -71,7 +73,7 @@ test it by making another attribute invalid:
 
 ```ruby
 spot.name = nil
-spot.check_validations!  # => ArgumentError: Name can't be blank; Birthday is class String, not Date
+spot.check_validations!  # => ArgumentError: Name can't be blank; Birthday is a String, not a Date
 ```
 
 
@@ -95,6 +97,10 @@ 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:

data/lib/validated_object.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_model'
 require 'validated_object/version'
 
@@ -55,9 +57,7 @@ module ValidatedObject
     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
+      set_instance_variables from_hash: attributes
       check_validations!
       self
     end
@@ -84,15 +84,41 @@ module ValidatedObject
       def validate_each(record, attribute, value)
         expected_class = options[:with]
 
-        if expected_class == Boolean
-          return if value.is_a?(TrueClass) || value.is_a?(FalseClass)
-        else
-          return if value.is_a?(expected_class)
-        end
+        return if pseudo_boolean?(expected_class, value) ||
+                  expected_class?(expected_class, value)
 
-        msg = options[:message] || "is a #{value.class}, not a #{expected_class}"
-        record.errors.add attribute, msg
+        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|
+        self.instance_variable_set "@#{variable_name}".to_sym, variable_value
       end
     end
+
   end
 end

data/lib/validated_object/version.rb

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

data/script/demo.rb

@@ -13,5 +13,5 @@ puts phoebe.inspect
 maru = Dog.new(birthday: Date.today, name: 'Maru')
 puts maru.inspect
 
-paris = Dog.new
-puts paris.inspect
+hiro = Dog.new(birthday: 'today')
+puts hiro.inspect

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: validated_object
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Robb Shecter
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-23 00:00:00.000000000 Z
+date: 2018-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler