validity 0.0.2 → 1.0.1

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: beb78593ced7359983b6ec67d25feb60671d5284
-  data.tar.gz: 21d5a1f8687b5963666978399acc9bc42b98b54c
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NWNhNDQzMzUxYTQ4ZjQ3ODJhOWFjZmNlNTBhNDRmMzk5NjUxMTBlNw==
+  data.tar.gz: !binary |-
+    MmQzNDE1NTUwODhmYTU1YTIwMDdhNjNmMDZiZTE4MzRkNjdlMTQ3YQ==
 SHA512:
-  metadata.gz: bd8ee1805308de021d90009e9562872101ffb32b83ffb884670b73dfd35b30b2b60e3ce63cefd0a5ff81e1bb593d6d3cfcab1b621962d0942f13f1652ad4a9b1
-  data.tar.gz: 1e4b4acf97af072ff04d6a9818088dc85a019aec59e67c1f7385725a4e80b078fd94e1958101e7e74068065551d1b4c3527600a1aa7f733441e2ab076361d78b
+  metadata.gz: !binary |-
+    MzNiNzNhOWY4ODM3NDgyZTI0ODk4YTgwNjdhODdjMTQ2MzMzNGIzM2FkY2Zh
+    MWY2NzBhZTNjYjI2NTgzNGU1Yjc1ZDNmYzM0MjUyZWM2MTcyYmZkNzRiODll
+    YWU0ZDVjMTFmMzMwNTM3YTg3NjFmMTZkNWVjMTIxNzhiNTQxOGY=
+  data.tar.gz: !binary |-
+    OTg2M2EwNThhNTJjZmNmMTE3ZDY5OWZiMzAyNzU4OGFmNmZjZjEwYWQ5YzA4
+    MjkxZTI1ZmM5OTJjYjk0YzllM2UwYzgxZjY4YzVhZTJlMGJkNzA0NDk5YzI0
+    OTVlMzU2YzJjNDg0ODNkYjJkNjViNGFiMTliODhiY2M3MzJhMzA=

data/lib/validity/record.rb

@@ -0,0 +1,115 @@
+module Validity
+  # The Validity::Record module contains testing logic specific to ActiveRecord.
+  # Example Usage:
+  #   @user = Record.validates(User.new)
+  #   @user.field_uniqueness(:email)
+  #   @user.field_presence(:email)
+  #
+  # Author::    Matt Fornaciari (mailto:mattforni@gmail.com)
+  # License::   MIT
+  class Record
+    include Test::Unit::Assertions
+    include Validity
+
+    attr_reader :record
+
+    # Creates a Validity::Record for validation.
+    #
+    # * *Args*:
+    #   - +record+ the ActiveRecord model to validate
+    # * *Returns*:
+    #   - a newly created Validity::Record object
+    # * *Raises*:
+    #   - +Unconfigured+ if Validity is not configured
+    def self.validates(record)
+      Validity.check_configured!
+      Record.new(record)
+    end
+
+    # Asserts the record has a +belongs_to+ association as indicated by the provided
+    # +field+ and that the record equals the +target+ record, if provided.
+    #
+    # * *Args*:
+    #   - +field+ the fields to check for has_many association
+    #   - +targets+ the target associated records
+    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}"
+      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+.
+    #
+    # * *Args*:
+    #   - +field+ the fields to check for presence
+    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 given +field+ must be present for the record to be valid.
+    #
+    # * *Args*:
+    #   - +field+ the fields to check for presence
+    def field_presence(field)
+      @record.send("#{field}=", nil)
+
+      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 given +field+ must be unique for the record to be valid.
+    #
+    # * *Args*:
+    #   - +field+ the fields to check for uniqueness
+    def field_uniqueness(field)
+      dup = @record.dup
+
+      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
+
+    # Asserts the record has a +has_many+ association as indicated by the provided
+    # +field+ and that the many records equal the +targets+ records, if provided.
+    #
+    # * *Args*:
+    #   - +field+ the fields to check for has_many association
+    #   - +targets+ the target associated records
+    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}"
+      if targets
+        assert_equal targets.size, many.size, "#{clazz} does not have #{targets.size} associated #{field}"
+      end
+    end
+
+    private
+
+    attr_writer :record
+
+    # Creates a Validity::Record for validation.
+    #
+    # * *Args*:
+    #   - +record+ the ActiveRecord model to validate
+    # * *Returns*:
+    #   - a newly created Validity::Record object
+    def initialize(record)
+      self.record = record
+    end
+  end
+end
+

data/lib/validity.rb

@@ -1,12 +1,101 @@
-# 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
+# This gem provides a library aimed at making testing easy.  At this point it
+# is aimed at testing ActiveRecord models, though the ultimate goal is to make
+# spinning up 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.
+# This testing library is test framework agnostic, though it currently only
+# supports test-unit and rspec.  Which framework you would like to use must
+# be configured prior to use.  Happy testing!
 #
 # Author::    Matt Fornaciari (mailto:mattforni@gmail.com)
 # License::   MIT
 
 require 'test/unit/assertions'
-require 'validity/active_record'
+require 'validity/record'
+
+module Validity
+  # Configures Validity to use the provided test_module.
+  #
+  # * *Args*:
+  #   - +test_module+ the module to use for testing
+  # * *Returns*:
+  #   - the test module Validity was configured to use
+  # * *Raises*:
+  #   - +Unsupported+ if the provided test module is unsupported
+  def self.configure(test_module)
+    raise Unsupported.new(test_module) if !supported?(test_module)
+    @@test_module = test_module
+  end
+
+  # Returns whether or not Validity is configured.
+  #
+  # * *Returns*:
+  #   - whether or not Validity has been configured
+  def self.configured?
+    !@@test_module.nil?
+  end
+
+  # Resets Validity to an unconfigured state.
+  def self.reset!
+    @@test_module = nil
+  end
+
+  # Returns a list of test modules Validity supports.
+  #
+  # * *Returns*:
+  #   - a list of test modules Validity supports
+  def self.supported
+    SUPPORTED
+  end
+
+  # A Validity specific error signifying an unsupported test module.
+  #
+  # Author::    Matt Fornaciari (mailto:mattforni@gmail.com)
+  # License::   MIT
+  class Unsupported < RuntimeError
+    def initialize(test_module)
+      super(UNSUPPORTED % {test_module: test_module})
+    end
+  end
+
+  # A Validity specific error signifying Validity is unconfigured.
+  #
+  # Author::    Matt Fornaciari (mailto:mattforni@gmail.com)
+  # License::   MIT
+  class Unconfigured < RuntimeError
+    def initialize
+      super('Validity must be configured before use')
+    end
+  end
+
+  protected
+
+  # Checks if Validity is configured and raises an error if is not.
+  #
+  # * *Raises*:
+  #   - +Unconfigured+ if Validity is not configured
+  def self.check_configured!
+    raise Unconfigured.new if !configured?
+  end
+
+  module TestUnit
+  end
+
+  SUPPORTED = [TestUnit]
+  UNSUPPORTED = "%{test_module} is not a supported test module, please specify one of #{SUPPORTED.join(', ')}"
+
+  private
+
+  @@test_module = nil
+
+  # Returns whether or not a test module is supported by Validity.
+  #
+  # * *Args*:
+  #   - +test_module+ the module to check
+  # * *Returns*:
+  #   - whether or not the module is supported by Validity
+  def self.supported?(test_module)
+    SUPPORTED.include?(test_module)
+  end
+end
 

metadata

@@ -1,27 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: validity
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 1.0.1
 platform: ruby
 authors:
 - Matt Fornaciari
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-02 00:00:00.000000000 Z
+date: 2014-05-15 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'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2'
 description: The beginning of a validation library
@@ -31,7 +73,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/validity.rb
-- lib/validity/active_record.rb
+- lib/validity/record.rb
 homepage: http://rubygems.org/gems/validity
 licenses:
 - MIT
@@ -42,12 +84,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []

data/lib/validity/active_record.rb

@@ -1,86 +0,0 @@
-# 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
-
-      # 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}"
-        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)
-        @record.send("#{field}=", nil)
-
-        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)
-        dup = @record.dup
-
-        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
-
-      # 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}"
-        if targets
-          assert_equal targets.size, many.size, "#{clazz} does not have #{targets.size} associated #{field}"
-        end
-      end
-
-      private
-
-      attr_reader :record
-    end
-  end
-end
-