validated_object 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1f32a3569317b4ac6693c86bf9b4f1d30e035c7b
-  data.tar.gz: 589c0f17eea6ddbb85518a224033485c536735c7
+  metadata.gz: 5b76d3f8fe9c6f252f2e6ff709800cd10cd8b6b0
+  data.tar.gz: 785c77bba6ede1f3c7e3f59c2b0f63605d2cb5d6
 SHA512:
-  metadata.gz: 02104cd38f5f88d621084ce95bd7f14ec29e3d6c1dc40812f78ac584953ce98afc33d09c63a9135f6e27503e98c1cb29e7bad2786f62dd98f148d17c03a8d8ea
-  data.tar.gz: fbec06b3948959293b669fc25708f107a9b53d69e6b47346edf32c43951915f256b53df53335b78c59dad192acba6dcb6cab4a7fb773f59dbfd95a0d890717fc
+  metadata.gz: 7da913249ec669171fab23b35edea1a0ce1a2916ad28db759de46d4122d4f2a1a7e62744d956702f09e7833228fe462bf2e5e7932bee510700aee049242d2e21
+  data.tar.gz: b3ba82c241a08f8eee58ff0aaa44f5b072f09136857664a2033ef0a5301c229340109fd52e9dd5bd1e1e09f38405c7a6bbe2f15ca8562b8f8cb74fc0268670ad

data/lib/validated_object/version.rb

@@ -1,3 +1,3 @@
 module ValidatedObject
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/validated_object.rb

@@ -1,5 +1,84 @@
+require 'active_model'
 require "validated_object/version"
 
 module ValidatedObject
-  # Your code goes here...
+  # @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)
+  # 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.
+  #
+  # @example Writing a self-validating object
+  #   class Dog < Eaternet::ValidatedObject
+  #     attr_accessor :name, :birthday
+  #
+  #     validates :name, presence: true
+  #     validates :birthday, type: Date, allow_nil: true
+  #   end
+  #
+  # @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
+  #
+  #   # We can also explicitly test for validity
+  #   dog1.valid?  # => true
+  #
+  #   dog1.birthday = Date.new(2015, 1, 23)
+  #   dog1.valid?  # => true
+  #
+  # @example Making an instance invalid
+  #   dog1.birthday = '2015-01-23'
+  #   dog1.valid?  # => false
+  #   dog1.check_validations!  # => ArgumentError: Birthday is class String, not Date
+  #
+  # @see Eaternet::ValidatedObject::TypeValidator
+  # @see http://yehudakatz.com/2010/01/10/activemodel-make-any-ruby-object-feel-like-activerecord/ ActiveModel: Make Any Ruby Object Feel Like ActiveRecord, Yehuda Katz
+  # @see http://www.rubyinside.com/rails-3-0s-activemodel-how-to-give-ruby-classes-some-activerecord-magic-2937.html Rails 3.0′s ActiveModel: How To Give Ruby Classes Some ActiveRecord Magic, Peter Cooper
+  class Base
+    include ActiveModel::Validations
+
+    # Instantiate and validate a new object.
+    #
+    # @yieldparam [ValidatedObject] new_object the yielded new object
+    #   for configuration.
+    #
+    # @raise [ArgumentError] if the object is not valid at the
+    #   end of initialization.
+    def initialize(&block)
+      block.call(self)
+      check_validations!
+    end
+
+    # Run any validations and raise an error if invalid.
+    # @raise [ArgumentError] if any validations fail.
+    def check_validations!
+      fail ArgumentError, errors.full_messages.join('; ') if invalid?
+    end
+
+    # A custom validator which ensures an object is a certain class.
+    # It's here as a nested class in {ValidatedObject} for easy
+    # access by subclasses.
+    #
+    # @example Ensure that weight is a floating point number
+    #   class Dog < ValidatedObject
+    #     attr_accessor :weight
+    #     validates :weight, type: Float
+    #   end
+    class TypeValidator < ActiveModel::EachValidator
+      # @return [nil]
+      def validate_each(record, attribute, value)
+        expected = options[:with]
+        actual = value.class
+        return if actual == expected
+
+        msg = options[:message] || "is class #{actual}, not #{expected}"
+        record.errors.add attribute, msg
+      end
+    end
+  end
 end

data/validated_object.gemspec

@@ -30,4 +30,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec"
+
+  spec.add_runtime_dependency 'activemodel', '>= 3.2.21'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: validated_object
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Robb Shecter
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '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: 3.2.21
 description: A small wrapper around ActiveModel Validations.
 email:
 - robb@weblaws.org