emailness 0.1.0.alpha.2 → 0.1.0.beta.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 41fd5b6b799bfc5f93a7e4cbdbcf2c73900811ca580f04115858ffbd06e4e03c
-  data.tar.gz: e9f4eb4fd8b10c9ea7e3810e6f6e0cbeb0cf02cba0abb87099bc688ba1ecab49
+  metadata.gz: f5bce971c08e8dae66d610adc65c6987be3ec7f5a0f44bcc8d3fc8417a846f10
+  data.tar.gz: 17975c0103aa601c108cf23be39516fcea774d8fca5b9ab59377e28c7dcf5d3a
 SHA512:
-  metadata.gz: cad4e4961e2b076570a968a473a96796f9293ab68e7c89631717539e93e63325598f5099adf6ce047b14056e11a0b6ebdf2b4bae0bdb3209c5565a7270ec731a
-  data.tar.gz: 616e222f01899aea2cd02fd3ef5e19cd784a4847374cbcd19e135eb50fe88a13bfdd136b28fe748f19b62d6ea3063a4143d9cdc67c5fc77ebe1779bc2c076a40
+  metadata.gz: 36e9b7c4a2583f39e8c4ffd70f41f12457e94a9867db713d3a344de1ffa90e4d372eda826aebb98a279b4ca4164f115ab981a22ee8b3a51aa44487a7ac3d5b2f
+  data.tar.gz: 3ce9373ff951b0651788db4c62ba9ee22bf5757eb1e62c84ef991fee7f3a660a1db239200e6317b30f25d15c2feb5dfe74485d10eb661b2d0f4b3a9a0f5e6657

data/Gemfile

@@ -10,4 +10,5 @@ gem "pry"
 gem "pry-rescue"
 gem "pry-stack_explorer"
 
-gem "activesupport"
+gem "activesupport", require: "active_support"
+gem "activemodel", require: "active_model"

data/Gemfile.lock

@@ -1,51 +1,53 @@
 PATH
   remote: .
   specs:
-    emailness (0.1.0)
+    emailness (0.1.0.beta.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.0)
+    activemodel (6.1.3)
+      activesupport (= 6.1.3)
+    activesupport (6.1.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
       zeitwerk (~> 2.3)
-    binding_of_caller (0.8.0)
+    binding_of_caller (1.0.0)
       debug_inspector (>= 0.0.1)
     coderay (1.1.3)
-    concurrent-ruby (1.1.7)
-    debug_inspector (0.0.3)
+    concurrent-ruby (1.1.8)
+    debug_inspector (1.0.0)
     diff-lcs (1.4.4)
-    i18n (1.8.5)
+    i18n (1.8.9)
       concurrent-ruby (~> 1.0)
     interception (0.5)
     method_source (1.0.0)
-    minitest (5.14.2)
-    pry (0.13.1)
+    minitest (5.14.4)
+    pry (0.14.0)
       coderay (~> 1.1)
       method_source (~> 1.0)
     pry-rescue (1.5.2)
       interception (>= 0.5)
       pry (>= 0.12.0)
-    pry-stack_explorer (0.5.1)
-      binding_of_caller (~> 0.7)
+    pry-stack_explorer (0.6.1)
+      binding_of_caller (~> 1.0)
       pry (~> 0.13)
     rake (12.3.3)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
       rspec-expectations (~> 3.10.0)
       rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.0)
+    rspec-core (3.10.1)
       rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
-    rspec-support (3.10.0)
+    rspec-support (3.10.2)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
     zeitwerk (2.4.2)
@@ -54,13 +56,14 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  activemodel
   activesupport
   emailness!
   pry
   pry-rescue
-  pry-stack_explorer (~> 0.5.1)
+  pry-stack_explorer
   rake (~> 12.0)
   rspec (~> 3.0)
 
 BUNDLED WITH
-   2.1.4
+   2.2.3

data/README.md

@@ -1,72 +1,93 @@
 # Emailness
 **Care very little about email validation**
 
-Email validation with sensible defaults so you can go care about more important things.
+Email validation with reasonable defaults so you can go care about more important things.
 
-***TODO: The Rails validator isn't finished yet.***
+**Current status: Beta**
 
-* Strives to be trivially easy to choose and use
-* Meant to match HTML5 email validation, happily deviates from RFC 5322
-* Email tags with '+' are allowed
-* Two consecutive dots ('..') are not
-* Cares very little about most other things
+[Test Cases](#test-cases) · [Usage](#usage)
 
+### Goals
+* Be trivially easy to use (and choose)
+* Catch most common entry errors without being too strict
+* Meant to match HTML5 email validation, *happily deviates* from RFC 5322
 
+### Highlights of what is allowed/not allowed
+* Allowed
+    * **Email tags** with '+'
+* Not allowed
+    * Two consecutive dots: '..'
+    * Two at signs: '@@'
+
+See the other [test cases →](#test-cases)
+
+## Usage
+
+### Install
 Add the gem:
 
-```
+```sh
 bundle add emailness
 ```
 
-Add it to your model:
+### Use
+In **Rails**, add it to your model:
 
-```
-validates_emailness_of :email
-```
-
-And have a great day.
+```ruby
+# class Thing < ApplicationRecord
 
-*If this gem is what you needed but had any hesitation or cognitive load in choosing it, please let me know!*
+validates_email_format_of :email
 
----
+```
 
-## Test cases
-The spec file is made on purpose to be simple.
+Or, in **plain Ruby**, just use the module:
 
+```ruby
+Emailness.valid?("emailness@rubygems.org") # => true|false
 ```
-$ rspec
-
-Emailness::Validator
-  valid (✔)
-    jon+tag@hey.com ✔
-    email.me@ejemplo.com.ar ✔
-    jon@xn--acestunbeaudomaine-6ub.qc.ca ✔
-    johnson.o'jonathan@email.com ✔
-    fancytld@tld ✔
-  invalid (✘)
-    double..dot@gmail.com ✘
-    local@trailing-hyphen-.com ✘
-    leadingdigit@9domain.com ✘
-    white space@example.com ✘
-    "even_white_space\ escaped"@example.com ✘
-    email@@veryat.com ✘
-  no guarantees (✽)
-    jon(is_very_smart)@email.com ✘
-    send.to.my.server@[::1] ✘
-    who-needs-dns@[172.16.11.222] ✘
+
+### Commit
+```sh
+git commit [--all] -m "$MODEL: Validate email address"
 ```
 
-*TODO: Update this automatically*
+And have a great day.
 
-If you would like to add a case, simply open an issue or PR.
+## Test Cases
+
+### Should be valid
+| Case                       | Example                                  | Result    |
+|----------------------------|------------------------------------------|-----------|
+| Tag                        | `jon+tag@hey.com`                        | ✔ valid   |
+| 2nd level TLD              | `email.me@ejemplo.com.ar`                | ✔ valid   |
+| IDN (xn--)                 | `jon@xn--acestunbeaudomaine-6ub.qc.ca`   | ✔ valid   |
+| Single apostrophe          | `johnson.o'jonathan@email.com`           | ✔ valid   |
+| Single TLD                 | `fancytld@tld`                           | ✔ valid   |
+
+### Should be invalid
+| Case                       | Example                                  | Result    |
+|----------------------------|------------------------------------------|-----------|
+| Double dot                 | `double..dot@gmail.com`                  | ✘ invalid |
+| Trailing hyphen in domain  | `local@trailing-hyphen-.com`             | ✘ invalid |
+| Leading digit in domain    | `leadingdigit@9domain.com`               | ✘ invalid |
+| White space                | `white space@example.com`                | ✘ invalid |
+| Escaped white space        | `"even_white_space escaped"@example.com` | ✘ invalid |
+| Two at-signs               | `email@@veryat.com`                      | ✘ invalid |
+
+### No guarantees (undefined)
+| Case          | Example                          | Current   |
+|---------------|----------------------------------|-----------|
+| Local comment | `jon(is_very_smart)@email.com`   | ✘ invalid |
+| IPv6 host     | `send.to.my.server@[::1]`        | ✘ invalid |
+| IPv4 host     | `who-needs-dns@[172.16.11.222]"` | ✘ invalid |
+
+Those examples correspond to the
+[spec file](https://github.com/joallard/emailness/blob/master/spec/emailness_spec.rb), which is simple on purpose.
+
+*TODO: Update the tables automatically*
 
-## Usage
-
-Either use it in Rails, or vanilla:
+If you would like to add a case, simply open an issue or PR.
 
-```
-Emailness.valid?(email)  # true/false
-```
 
 ## Contributing
 Are welcome:

data/bin/rspec

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/lib/emailness.rb

@@ -18,5 +18,12 @@ module Emailness
     true
   end
 
+  def self.const_missing(name)
+    return super unless name == :Validator
+    require "emailness/validator"
+
+    defined?(Emailness::Validator) ? Emailness::Validator : super
+  end
+
   class Error < StandardError; end
 end

data/lib/emailness/validator.rb

@@ -1,10 +1,16 @@
-module Emailness::Validator < ActiveModel::EachValidator
+class Emailness::Validator < ActiveModel::EachValidator
   def validate_each(record, attribute, value)
     return if Emailness.valid?(value)
 
-    record.errors.add attribute, (options[:message] || "is not a valid email")
+    message = options[:message] || "is not a valid email"
+    record.errors.add(attribute, :invalid, message: message)
+  end
+
+  module HelperMethods
+    def validates_email_format_of(*attr_names)
+      validates_with ::Emailness::Validator, _merge_attributes(attr_names)
+    end
   end
-end
 
-if defined?(ActiveRecord::Base)
+  ActiveModel::Validations::HelperMethods.include(HelperMethods)
 end

data/lib/emailness/version.rb

@@ -1,4 +1,4 @@
 module Emailness
-  VERSION = "0.1.0.alpha.2"
+  VERSION = "0.1.0.beta.1"
   # then `rake release`
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: emailness
 version: !ruby/object:Gem::Version
-  version: 0.1.0.alpha.2
+  version: 0.1.0.beta.1
 platform: ruby
 authors:
 - Jonathan Allard
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-12-18 00:00:00.000000000 Z
+date: 2021-03-19 00:00:00.000000000 Z
 dependencies: []
 description: |2
 
@@ -36,6 +36,7 @@ files:
 - README.md
 - Rakefile
 - bin/console
+- bin/rspec
 - bin/setup
 - emailness.gemspec
 - lib/emailness.rb
@@ -49,7 +50,7 @@ metadata:
   homepage_uri: https://github.com/joallard/emailness
   source_code_uri: https://github.com/joallard/emailness
   changelog_uri: https://github.com/joallard/emailness/blob/master/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -64,8 +65,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Care very little about email validation
 test_files: []