email_format 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 694dda2a4da9653812f143d3d8064224ee367fca
+  data.tar.gz: 7ff1b8bd68f1ae304284dcc3500ae44dea2220a9
+SHA512:
+  metadata.gz: 6b8dcbff6d81a51b8ddb4883496c253d2165b997c02f623fa05944db8760528afde2a6d09a8514e8328027ea1112d3652f645069ad53276db342f7b9afc25c29
+  data.tar.gz: fc75a7f00ab0d93401402cf3d19bee59e729963c64fc58488811e2069a11347ba76cf172bf5090fa8da2f9107b3c1c46ec3ff0f9c60e1c1986a3e3a1bc628e25

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in email_format.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 johnotander
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,72 @@
+# Email Format
+
+This gem uses the thorough email validation check used by the [email_regex](https://github.com/dougwig/email_regex) gem written by Doug Wiegley which "provides a valid email regex that conforms to most valid RFC edges cases (disallows backticks), and allows for a few illegal patterns that are in common use".
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'email_format'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install email_format
+
+## Usage
+
+Using it is as simple as using the `validates` keyword in your model:
+
+```ruby
+class User < ActiveRecord::Base
+  
+  # ...
+
+  validates :email, email_format: true
+
+  # ...
+
+end
+```
+
+Now the email attribute will be validated accordingly:
+
+```ruby
+User.new('valid@email.com').valid? # => true
+User.new('invalid_email@@').valid? # => false
+```
+
+Also, the model in question doesn't need to inherit from ActiveRecord::Base, you only need to `include ActiveModel::Validations` in your class:
+
+```ruby
+require 'email_format'
+
+class Awesome
+  include ActiveModel::Validations
+
+  attr_accessor :email
+
+  validates :email, email_format: true
+end
+
+awesome = Awesome.new
+
+awesome.email = "valid@email.com"
+awesome.valid? # => true
+
+awesome.email = "invalid_email"
+awesome.valid? # => false
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+task default: :spec
+task test: :spec

data/email_format.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'email_format/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "email_format"
+  spec.version       = EmailFormat::VERSION
+  spec.authors       = ["johnotander"]
+  spec.email         = ["johnotander@gmail.com"]
+  spec.description   = %q{Validates the email format.}
+  spec.summary       = %q{Validates the email format with the email_regex gem.}
+  spec.homepage      = "https://github.com/johnotander/email_format"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+
+  spec.add_dependency "activemodel"
+  spec.add_dependency "email_regex"
+end

data/lib/email_format.rb

@@ -0,0 +1,6 @@
+require "email_regex"
+require "email_format/version"
+require "email_format/email_format_validator"
+
+module EmailFormat
+end

data/lib/email_format/email_format_validator.rb

@@ -0,0 +1,7 @@
+class EmailFormatValidator < ActiveModel::EachValidator
+  def validate_each(record, attribute, value)
+    unless value =~ EmailRegex::EMAIL_ADDRESS_REGEX
+      record.errors[attribute] << (options[:message] || "is invalid")
+    end
+  end
+end

data/lib/email_format/version.rb

@@ -0,0 +1,3 @@
+module EmailFormat
+  VERSION = "0.0.1"
+end

data/spec/email_format_validator_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe EmailFormatValidator do
+
+  let(:fake_model) { FakeModel.new }
+
+  context "with valid emails" do
+
+    let(:valid_emails) { %w(valid@email.com another.valid@email.email.net) }
+
+    it "should be happy" do
+      valid_emails.each do |email|
+        fake_model.email = email
+        expect(fake_model.valid?).to be_true
+      end
+    end
+  end
+
+  context "with invalid emails" do
+
+    let(:invalid_emails) { %w(invalid_email@ another_invalid_email@@email.email) }
+
+    it "shouldn't be happy" do
+      invalid_emails.each do |email|
+        fake_model.email = email
+        expect(fake_model.valid?).to be_false
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'rspec'
+require 'active_model'
+require 'email_format'
+
+RSpec.configure do |config|
+  config.color_enabled = true
+end
+
+class FakeModel
+  include ActiveModel::Validations
+
+  attr_accessor :email
+
+  validates :email, email_format: true
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: email_format
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- johnotander
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: email_regex
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Validates the email format.
+email:
+- johnotander@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- email_format.gemspec
+- lib/email_format.rb
+- lib/email_format/email_format_validator.rb
+- lib/email_format/version.rb
+- spec/email_format_validator_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/johnotander/email_format
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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: []
+rubyforge_project: 
+rubygems_version: 2.0.7
+signing_key: 
+specification_version: 4
+summary: Validates the email format with the email_regex gem.
+test_files:
+- spec/email_format_validator_spec.rb
+- spec/spec_helper.rb