validity 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9612ae7e91b7132c10b0f0113b3b1bc46aaeb080
-  data.tar.gz: 36b3d82c42fa44f90f9430b807d7199015afc15b
+  metadata.gz: beb78593ced7359983b6ec67d25feb60671d5284
+  data.tar.gz: 21d5a1f8687b5963666978399acc9bc42b98b54c
 SHA512:
-  metadata.gz: 87a3799c447d7d030eabfb317384e414a84fa0730a4a96865aa49f5fdb03d69b62fc59f74e07be943ff207bdddd4d85e5344aa8a8ba04a18d29731cfdcf56228
-  data.tar.gz: 6d84b1bacb1b381d4c9eaa0c6fb205c86deb85cb6faee825d633b4601174b9e589a57961ccf119a2c7a6c65e644a122cec208a303bcf0e6c28b2ca4f82911405
+  metadata.gz: bd8ee1805308de021d90009e9562872101ffb32b83ffb884670b73dfd35b30b2b60e3ce63cefd0a5ff81e1bb593d6d3cfcab1b621962d0942f13f1652ad4a9b1
+  data.tar.gz: 1e4b4acf97af072ff04d6a9818088dc85a019aec59e67c1f7385725a4e80b078fd94e1958101e7e74068065551d1b4c3527600a1aa7f733441e2ab076361d78b

data/lib/validity/active_record.rb

@@ -1,62 +1,80 @@
+# Author::    Matt Fornaciari (mailto:mattforni@gmail.com)
+# License::   MIT
+
 module Validity
+  # The Validity::ActiveRecord module contains testing logic specific to ActiveRecord
   module ActiveRecord
+    # Creates an ActiveRecord::Wrapper to test against
     def validates(record)
       Wrapper.new(record)
     end
 
     private
 
+    # The Wrapper class is just a thin wrapper around the ActiveRecord model
+    # which defines several methods to validate a model behaves as it should.
+    # Example Usage:
+    #   validates(@model).field_presence(:required)
     class Wrapper 
       include Test::Unit::Assertions
 
+      # Creates a new instance of Validity::ActiveRecord::Wrapper to test against
       def initialize(record)
         @record = record
       end
 
-      def belongs_to(field, target)
+      # Asserts that the record has a belongs_to association and that the
+      # associated record equals the +target+ record, if provided.
+      def belongs_to(field, target = nil)
         clazz = @record.class
         assert_respond_to @record, field, "#{clazz} cannot find associated #{field}"
 
         one = @record.send(field)
         assert_not_nil one, "#{clazz} does not have associated #{field}"
-        assert_equal target, one, "#{field.to_s.capitalize} associated with this #{clazz.to_s.downcase} is not the target #{field}"
+        if target
+          assert_equal target, one, "#{field.to_s.capitalize} associated with this #{clazz.to_s.downcase} is not the target #{field}"
+        end
       end
 
+      # Asserts that the record responds to the +delegated+ method and that
+      # the returned object is equal to the object referenced by +delegated_to+
       def delegates(delegated, delegated_to)
         clazz = @record.class
         assert_respond_to @record, delegated, "#{clazz} does not respond to #{delegated}"
         assert_equal delegated_to.send(delegated), @record.send(delegated), "Delegated objects do not match"
       end
 
+      # Asserts that the +field+ field must be present for the record to be valid
       def field_presence(field)
-        # Null out the field to test
         @record.send("#{field}=", nil)
 
-        # Assert the record is invalid and will not save
         clazz = @record.class
         assert !@record.valid?, "#{clazz} is considered valid with nil #{field}"
         assert !@record.save, "#{clazz} saved without #{field} field"
         assert @record.errors[field].any?, "#{clazz} does not have an error on #{field}"
       end
 
+      # Asserts that the +field+ field must be unique for the record to be valid
       def field_uniqueness(field)
-        # Create a duplicate of the record
         dup = @record.dup
 
-        # Assert the duplicate is invalid based on the field
         clazz = dup.class
         assert !dup.valid?, "#{clazz} is considered valid with duplicate #{field}"
         assert !dup.save, "#{clazz} saved with a duplicate #{field}"
         assert dup.errors[field].any?, "#{clazz} does not have an error on #{field}"
       end
 
-      def has_many(field, targets)
+      # Asserts that the record has a has_many association and that the
+      # associated records equal the +targets+ records, if provided.
+      def has_many(field, targets = nil)
         clazz = @record.class
         assert_respond_to @record, field, "#{clazz} cannot find associated #{field}"
 
         many = @record.send(field)
         assert !(many.nil? || many.empty?), "#{clazz} does not have associated #{field}"
-        assert_equal targets.size, many.size, "#{clazz} does not have #{targets.size} associated #{field}"
+        if targets
+          assert_equal targets.size, many.size, "#{clazz} does not have #{targets.size} associated #{field}"
+        end
       end
 
       private

data/lib/validity.rb

@@ -1,3 +1,12 @@
+# This gem attempts to provide a library to easily test validations on
+# ActiveRecord models. The ultimate goal is to make spinning up and testing a
+# data model for a Ruby on Rails stack both quick and painless.  The
+# syntactical structure of this library is based losely upon rspec's
+# expect/match syntax as it seems to lend itself well to testing readability.
+#
+# Author::    Matt Fornaciari (mailto:mattforni@gmail.com)
+# License::   MIT
+
 require 'test/unit/assertions'
 require 'validity/active_record'
 

metadata

@@ -1,16 +1,30 @@
 --- !ruby/object:Gem::Specification
 name: validity
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Matt Fornaciari
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-30 00:00:00.000000000 Z
-dependencies: []
-description: Just the beginning of a validation library
+date: 2014-05-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+description: The beginning of a validation library
 email: mattforni@gmail.com
 executables: []
 extensions: []
@@ -22,7 +36,7 @@ homepage: http://rubygems.org/gems/validity
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message: Happy testing!
 rdoc_options: []
 require_paths:
 - lib