validate_as_email 1.0.2 → 1.0.3

data/README.md

@@ -25,6 +25,54 @@ Rubinius using Travis CI.
 You will need to be using Rails 3 to make use of this validator, as it
 is built on top of ActiveModel, which was introduced in Rails 3.
 
+### Usage with ActiveModel
+
+``` ruby
+class Person
+  include ActiveModel::Validations
+  validates_as_email :email
+  attr_accessor :email
+end
+
+# OR
+
+class Person
+  include ActiveModel::Validations
+  validates :email, email: true
+  attr_accessor :email
+end
+```
+
+### Usage with ActiveRecord
+
+``` ruby
+class Person < ActiveRecord::Base
+  validates_as_email :email
+  attr_accessor :email
+end
+
+# OR
+
+class Person < ActiveRecord::Base
+  validates :email, email: true
+  attr_accessor :email
+end
+```
+
+### Built-in RSpec Matcher
+
+``` ruby
+class Person < ActiveRecord::Base
+  validates_as_email :email
+  attr_accessor :email
+end
+
+describe Person do
+  it { should have_a_valid_email_address_for(:email) }
+  it { should_not have_a_valid_email_address_for(:email) }
+end
+```
+
 ## Contributing
 
 1. Fork it

data/features/rspec_matcher.feature

@@ -0,0 +1,24 @@
+Feature: RSpec matcher
+
+  Scenario: The built-in RSpec matcher covers validation of email for you
+    Given a file named "rspec_matcher.rb" with:
+    """
+    require 'active_model'
+    require 'rspec'
+    require 'validate_as_email'
+
+    class Person
+      include ActiveModel::Validations
+      validates_as_email :email
+      attr_accessor :email
+    end
+
+    describe Person do
+      it { should_not have_a_valid_email_address_for(:email) }
+    end
+    """
+    When I run `rspec rspec_matcher.rb`
+    Then it should fail with:
+    """
+    not to have a valid email address for :email
+    """

data/features/support/env.rb

@@ -1,6 +1,11 @@
 require 'bundler'
 Bundler.setup
 
+begin
+  require 'simplecov'
+rescue LoadError
+end
+
 require 'aruba/cucumber'
 
 # Borrowed from VCR

data/lib/validate_as_email.rb

@@ -1,3 +1,7 @@
 require 'validate_as_email/version'
 require 'active_model'
 require 'active_model/validations/email_validator'
+
+if defined?(RSpec)
+  require 'validate_as_email/rspec'
+end

data/lib/validate_as_email/rspec.rb

@@ -0,0 +1,48 @@
+require 'rspec/rails/extensions/active_record/base'
+# Adds a custom matcher to RSpec to make it easier to make sure your email
+# column is valid.
+#
+#   class Person
+#     include ActiveModel::Validations
+#
+#     validates_as_email :email
+#
+#     def initialize(attributes = {})
+#       @attributes = attributes
+#     end
+#
+#     def email
+#       @attributes[:email]
+#     end
+#
+#     def email=(address)
+#       @attributes[:email] = address
+#     end
+#   end
+#
+#   describe Person
+#     it { should have_a_valid_email_address_for(:email) }
+#   end
+RSpec::Matchers.define(:have_a_valid_email_address_for) do |column_name|
+  match do |klass|
+    %w(
+      matz@example.com
+      a@b.tld
+      1@8.8.8.8
+    ).each do |valid|
+      klass.send("#{column_name}=", valid)
+      klass.should have(0).errors_on(column_name)
+    end
+
+    %w(
+      word
+      a@
+      @b
+      example.com
+      8.8.8.8
+    ).each do |invalid|
+      klass.send("#{column_name}=", invalid)
+      klass.should have(1).error_on(column_name)
+    end
+  end
+end

data/lib/validate_as_email/version.rb

@@ -1,3 +1,3 @@
 module ValidateAsEmail
-  VERSION = '1.0.2'
+  VERSION = '1.0.3'
 end

data/spec/spec_helper.rb

@@ -1,5 +1,10 @@
 $: << 'lib'
 
+begin
+  require 'simplecov'
+rescue LoadError
+end
+
 require 'validate_as_email'
 require 'rspec/rails/extensions/active_record/base'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: validate_as_email
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -163,12 +163,14 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/active_model/validations/email_validator.rb
+- lib/validate_as_email/rspec.rb
 - lib/validate_as_email/version.rb
 - lib/validate_as_email.rb
 - README.md
 - LICENSE
 - features/active_model.feature
 - features/active_record.feature
+- features/rspec_matcher.feature
 - features/support/cucumber_helpers.rb
 - features/support/env.rb
 - spec/active_model/validations/email_validator_spec.rb
@@ -201,6 +203,7 @@ summary: The ultimate Rails 3 email validator. Powered by the Mail gem.
 test_files:
 - features/active_model.feature
 - features/active_record.feature
+- features/rspec_matcher.feature
 - features/support/cucumber_helpers.rb
 - features/support/env.rb
 - spec/active_model/validations/email_validator_spec.rb