validated_object 0.1.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5b76d3f8fe9c6f252f2e6ff709800cd10cd8b6b0
-  data.tar.gz: 785c77bba6ede1f3c7e3f59c2b0f63605d2cb5d6
+  metadata.gz: 917e06893558682ef44f4ae1570d73bb265dc980
+  data.tar.gz: b622a865760b6b3626ed1f270313ef26686371f6
 SHA512:
-  metadata.gz: 7da913249ec669171fab23b35edea1a0ce1a2916ad28db759de46d4122d4f2a1a7e62744d956702f09e7833228fe462bf2e5e7932bee510700aee049242d2e21
-  data.tar.gz: b3ba82c241a08f8eee58ff0aaa44f5b072f09136857664a2033ef0a5301c229340109fd52e9dd5bd1e1e09f38405c7a6bbe2f15ca8562b8f8cb74fc0268670ad
+  metadata.gz: 95affa10a6d3ee9efc02ced04778a8df4adab2e03a914086afbe79717c679454766be1aae77d2aaa7f7da670b82ed5baf9dc20bf0a0b6c6b0c0527123ab2c732
+  data.tar.gz: 079acd77f94c7c4664534a489fe5525ad47ab38883e666ea8575065138ce158c6d4b73a42d14b9ed175400e8e8251db2a44ff3b11811fb45229444fe6712d64d

data/README.md

@@ -1,8 +1,12 @@
+[![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)
+
 # ValidatedObject
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/validated_object`. To experiment with that code, run `bin/console` for an interactive prompt.
+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.
 
-TODO: Delete this and the text above, and describe your gem
 
 ## Installation
 
@@ -22,20 +26,56 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+
+### 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`.
+
+```ruby
+class Dog < ValidatedObject::Base
+  attr_accessor :name, :birthday
+
+  validates :name, presence: true
+  validates :birthday, type: Date, allow_nil: true
+end
+```
+
+### 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
+
+# We can also explicitly test for validity
+dog1.valid?  # => true
+
+dog1.birthday = Date.new(2015, 1, 23)
+dog1.valid?  # => true
+```
+
+### Making an instance _invalid_
+
+```ruby
+dog1.birthday = '2015-01-23'
+dog1.valid?  # => false
+dog1.check_validations!  # => ArgumentError: Birthday is class String, not Date
+```
+
 
 ## Development
 
-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).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/validated_object.
+Bug reports and pull requests are welcome on GitHub at https://github.com/dogweather/validated_object.
 
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/Rakefile

@@ -1,6 +1,6 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "validated_object"
+require 'bundler/setup'
+require 'validated_object'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +10,5 @@ require "validated_object"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start

data/lib/validated_object/version.rb

@@ -1,3 +1,3 @@
 module ValidatedObject
-  VERSION = "0.1.1"
+  VERSION = '1.0.0'.freeze
 end

data/lib/validated_object.rb

@@ -1,5 +1,5 @@
 require 'active_model'
-require "validated_object/version"
+require 'validated_object/version'
 
 module ValidatedObject
   # @abstract Subclass and add `attr_accessor` and validations
@@ -11,7 +11,7 @@ module ValidatedObject
   # creates very readable error messages.
   #
   # @example Writing a self-validating object
-  #   class Dog < Eaternet::ValidatedObject
+  #   class Dog < ValidatedObject::Base
   #     attr_accessor :name, :birthday
   #
   #     validates :name, presence: true
@@ -36,7 +36,7 @@ module ValidatedObject
   #   dog1.valid?  # => false
   #   dog1.check_validations!  # => ArgumentError: Birthday is class String, not Date
   #
-  # @see Eaternet::ValidatedObject::TypeValidator
+  # @see ValidatedObject::Base::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
@@ -49,34 +49,36 @@ module ValidatedObject
     #
     # @raise [ArgumentError] if the object is not valid at the
     #   end of initialization.
-    def initialize(&block)
-      block.call(self)
+    def initialize
+      yield(self)
       check_validations!
+      self
     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?
+      raise ArgumentError, errors.full_messages.join('; ') if invalid?
+      self
     end
 
-    # A custom validator which ensures an object is a certain class.
+    # 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.
+    # access by subclasses of {ValidatedObject::Base}.
     #
-    # @example Ensure that weight is a floating point number
-    #   class Dog < ValidatedObject
+    # @example Ensure that weight is a number
+    #   class Dog < ValidatedObject::Base
     #     attr_accessor :weight
-    #     validates :weight, type: Float
+    #     validates :weight, type: Numeric
     #   end
     class TypeValidator < ActiveModel::EachValidator
       # @return [nil]
       def validate_each(record, attribute, value)
         expected = options[:with]
-        actual = value.class
-        return if actual == expected
+        return if value.kind_of?(expected)
 
-        msg = options[:message] || "is class #{actual}, not #{expected}"
+        msg = options[:message] || "is class #{value.class}, not #{expected}"
         record.errors.add attribute, msg
       end
     end

data/validated_object.gemspec

@@ -4,32 +4,32 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'validated_object/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "validated_object"
+  spec.name          = 'validated_object'
   spec.version       = ValidatedObject::VERSION
-  spec.authors       = ["Robb Shecter"]
-  spec.email         = ["robb@weblaws.org"]
+  spec.authors       = ['Robb Shecter']
+  spec.email         = ['robb@weblaws.org']
 
-  spec.summary       = %q{Self-validating plain Ruby objects.}
-  spec.description   = %q{A small wrapper around ActiveModel Validations.}
-  spec.homepage      = "https://github.com/dogweather/validated_object"
-  spec.license       = "MIT"
+  spec.summary       = 'Self-validating plain Ruby objects.'
+  spec.description   = 'A small wrapper around ActiveModel Validations.'
+  spec.homepage      = 'https://github.com/dogweather/validated_object'
+  spec.license       = 'MIT'
 
   # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
   # delete this section to allow pushing this gem to any host.
   if spec.respond_to?(:metadata)
-    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
   else
-    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+    raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
   end
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.10"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec"
+  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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: validated_object
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Robb Shecter
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-08-18 00:00:00.000000000 Z
+date: 2016-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -106,8 +106,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.0
 signing_key: 
 specification_version: 4
 summary: Self-validating plain Ruby objects.
 test_files: []
+has_rdoc: