email_inquire 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b639114949de9f154873ae307bcbb047f1f2dfccf61039ca1d9e88e08d19fca4
-  data.tar.gz: f10a40ce09d7680f64a3214483b871a9946221cf7ce86029627eab797600a9b6
+  metadata.gz: d902d865f00ac01fd685b1d1ec4741acc8f1867df1a22f77473f8025af286354
+  data.tar.gz: bf87d72da118a972b9c73509b57f91c1a15ec515102eb35f13f7ccd04351b8c2
 SHA512:
-  metadata.gz: 6238edec60834896804ab373630846ce0f7171278bd3d51ae2f40720c9f2abb42e130bbd7b7f902e5ff02139bd4fe345d36b67c605ed5b9b46f2390617111d62
-  data.tar.gz: 174d9daa9959771e59e5af1e3d080b2c461b2621958f75e9b03a2a8551630a91e14d91c29fffd9591e79f9054de76f7e31f2bd9430d2d1bd94e82247f7026b12
+  metadata.gz: 8125d4178751fac27e8eef93d7edf59431535bf962ed91419692c0843b73317debc0d5a18d8e17fc5dc4ba1db605c92969db7094d2c0788384709e2283331852
+  data.tar.gz: a398c148a51adb5e6346ceabdf967142cd46d196613ea7a41ff0efcf939a62155308ecdaeb03b8b11b5cf004fcf416dca77d90033076f15808fca74cbcd2a525

data/.rubocop.yml

@@ -71,14 +71,14 @@ Lint/UnusedMethodArgument:
   IgnoreEmptyMethods: true
 
 Metrics/AbcSize:
-  Enabled: false # todo
+  Enabled: true
   Max: 20 # default: 15
 
 Metrics/BlockLength:
-  Enabled: false # todo
+  Enabled: true
 
 Metrics/CyclomaticComplexity:
-  Enabled: false # todo
+  Enabled: true
   Max: 10 # default: 6
 
 Metrics/LineLength:
@@ -88,23 +88,26 @@ Metrics/LineLength:
     - "^ *#" # comments
 
 Metrics/MethodLength:
-  Enabled: false # todo
+  Enabled: true
   Max: 12 # default: 10
 
 Metrics/PerceivedComplexity:
-  Enabled: false # todo
+  Enabled: true
   Max: 10 # default: 7
 
 Naming/VariableNumber:
   EnforcedStyle: snake_case
 
-Style/AsciiComments:
+Style/AccessModifierDeclarations:
   Enabled: false
 
 Style/AndOr:
   Enabled: true
   EnforcedStyle: conditionals
 
+Style/AsciiComments:
+  Enabled: false
+
 Style/BracesAroundHashParameters:
   Enabled: false
 
@@ -115,11 +118,7 @@ Style/Documentation:
   Enabled: false
 
 Style/FrozenStringLiteralComment:
-  Enabled: false # we'll do later
-
-Style/Lambda:
-  Enabled: false
-
+  Enabled: true
 
 Style/MethodCallWithArgsParentheses:
   Enabled: true # false by default
@@ -167,70 +166,3 @@ Style/TrailingCommaInArrayLiteral:
 
 Style/TrailingCommaInHashLiteral:
   EnforcedStyleForMultiline: comma
-
-#
-# Temporary disabled
-#
-
-Layout/EmptyLinesAroundArguments:
-  Enabled: false # buggy yet
-
-Lint/IneffectiveAccessModifier:
-  Enabled: false
-
-Lint/MissingCopEnableDirective:
-  Enabled: false
-
-Lint/RescueException:
-  Enabled: false
-
-Lint/ShadowedException:
-  Enabled: false
-
-Metrics/BlockNesting:
-  Enabled: false
-
-Metrics/ClassLength:
-  Enabled: false
-
-Metrics/ModuleLength:
-  Enabled: false
-
-Metrics/ParameterLists:
-  Enabled: false
-
-Naming/AccessorMethodName:
-  Enabled: false
-
-Naming/PredicateName:
-  Enabled: false
-
-Security/Eval:
-  Enabled: false
-
-Style/ClassAndModuleChildren:
-  Enabled: false
-
-Style/ClassVars:
-  Enabled: false
-
-Style/DateTime:
-  Enabled: false
-
-Style/FormatStringToken:
-  Enabled: false # issue with strftime
-
-Style/GuardClause:
-  Enabled: false
-
-Style/MixinUsage:
-  Enabled: false
-
-Style/NumericPredicate:
-  Enabled: false
-
-Style/SafeNavigation:
-  Enabled: false
-
-Style/StructInheritance:
-  Enabled: false

data/CHANGELOG.md

@@ -1,14 +1,29 @@
 # Change Log
 
 ## [Unreleased]
-[Full Changelog](https://github.com/maximeg/email_inquire/compare/v0.9.0...master)
+[Full Changelog](https://github.com/maximeg/email_inquire/compare/v0.10.0...master)
+
+## [v0.10.0](https://github.com/maximeg/email_inquire/tree/v0.10.0) (2019-01-08)
+[Full Changelog](https://github.com/maximeg/email_inquire/compare/v0.9.0...v0.10.0)
+
+**Changed:**
+
+- ccTLD open to registration are no longer hinted from foo.xx to foo.co.xx
+  (common providers are still hinted, e.g. yahoo.uk => yahoo.co.uk)
+  ([maximeg](https://github.com/maximeg))
+
+**Dev:**
+
+- Add mutant to do mutation testing ([maximeg](https://github.com/maximeg))
+- Extract validators into their own class ([maximeg](https://github.com/maximeg))
+- Bring mutation testing coverage to 100% ([maximeg](https://github.com/maximeg))
 
 ## [v0.9.0](https://github.com/maximeg/email_inquire/tree/v0.9.0) (2019-01-04)
 [Full Changelog](https://github.com/maximeg/email_inquire/compare/v0.8.0...v0.9.0)
 
 **Added:**
 
-- Custom valid domains ([maximeg](https://github.com/maximeg))
+- Custom valid domains ([maximeg](https://github.com/maximeg), [kwoodard22](https://github.com/kwoodard22))
 
 **Changed:**
 

data/Gemfile

@@ -9,6 +9,9 @@ group :local do
   # Guard
   gem "guard-rspec", require: false
   gem "terminal-notifier-guard", require: false # OS X
+
+  # Mutation testing
+  gem "mutant-rspec", require: false
 end
 
 # Code coverage

data/README.md

@@ -23,9 +23,14 @@ While we can't do so much for the name part of the email address, for the domain
 And also, we don't want for users to use one-time email addresses (also called burner or disposable
 email addresses).
 
-### Supported cases
+## Supported cases
 
-Format error. This doesn't strictly follow RFC 5322, it aims at validating email that will be
+All supported cases are based on a static validation.
+The gem does not check (yet) for domain existence (DNS) and prior delivery (MX entries on DNS).
+
+### Email format
+
+This doesn't strictly follow RFC 5322, it aims at validating email that will be
 deliverable on Internet. It also takes into account length of email, name part and domain part as
 per SMTP specification.
 
@@ -38,6 +43,8 @@ per SMTP specification.
 - `foo+test@domain.com` => valid
 - ...
 
+### Typos
+
 One char typo for 43 common email providers (worldwide and from France, United Kingdom and USA):
 
 - `gmil.com` => hint `gmail.com`
@@ -46,16 +53,21 @@ One char typo for 43 common email providers (worldwide and from France, United K
 - `virinmedia.com` => hint `virginmedia.com`
 - ...
 
+### ccTLD typos
+
 ccTLD specificity, like United Kingdom `.xx.uk` domains:
 
 - `foo.couk` => hint `foo.co.uk`
 - `fooco.uk` => hint `foo.co.uk`
-- `foo.uk` => hint `foo.co.uk`
+- `yahoo.uk` => hint `yahoo.co.uk`
 - `foo.judiciary.uk` => ok!
+- `foo.uk` => ok, .uk is open to registration
 - ...
 
 ...and same thing with `.co.jp` & `.com.br` domains.
 
+### Email provider
+
 Providers with an unique domain:
 
 - `gmail.fr` => hint `gmail.com`
@@ -66,13 +78,21 @@ Providers with an unique domain:
 - `laposte.fr` => hint `laposte.net`
 - ...
 
-3981 one-time email providers (a.k.a. burners, or disposable email
-[source](https://github.com/wesbos/burner-email-providers)):
+### Burners
+
+3981 one-time email providers a.k.a. burners, or disposable email
+([source](https://github.com/wesbos/burner-email-providers)):
 
 - `yopmail.com` => invalid
 - ...
 
-Custom invalid domains: Add your own invalid domains:
+### Known invalid domains
+
+- `example.com` => invalid
+
+### Custom invalid domains
+
+Add your own invalid domains:
 
 ```ruby
 # in config/initializers/email_inquire.rb
@@ -81,6 +101,18 @@ EmailInquire.custom_invalid_domains << "bad-domain.com"
 
 - `bad-domain.com` => invalid
 
+### Custom valid domains
+
+Take precedence over all the above rules and make any domain in the list valid, and non hintable.
+Add your own valid domains:
+
+```ruby
+# in config/initializers/email_inquire.rb
+EmailInquire.custom_valid_domains << "good-domain.com"
+```
+
+- `good-domain.com` => valid
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -201,12 +233,45 @@ tap on it should replace the email by the suggestion.
 
 Note that you could even have this validation for your Sign In form...
 
+## FAQ
+
+### Why does a perfectly valid corporate domain is hinted ?
+
+There are a few cases of corporate domains that will be hinted to the related public provider domain:
+
+- `google.com` => hint `gmail.com`
+- `laposte.fr` => hint `laposte.net`
+- `sfr.com` => hint `sfr.fr`
+
+This is intended. Taking `google.com` (corp) vs. `gmail.com` (public provider):
+
+- there are far more people with a `gmail.com` address rather than people with `google.com` address;
+- employees of Google are well aware of the difference between `google.com` (their employee address)
+  and `gmail.com` (the public email provider offered by their company)
+  and will not be mistaken by a hint;
+- non-tech savvy people are not, and have in mind "my email address is google",
+  so not hinting to `gmail.com` would let a lot of actual errors pass.
+
+If you do not want this, add the affected domains to `EmailInquire.custom_valid_domains`.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+
+### Mutation testing
+
+We use [mutant](https://github.com/mbj/mutant) to ensure that everything is well
+tested and the code is minimal. Coverage reported should be close to 100%.
+
+Run it with:
+
+```
+bundle exec mutant --include lib --require 'email_inquire.rb' --use rspec -- 'EmailInquire*'
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/maximeg/email_inquire.

data/data/country_code_tld/br.txt

@@ -0,0 +1,72 @@
+adm
+adv
+agr
+am
+arq
+art
+ato
+b
+bio
+blog
+bmd
+cim
+cng
+cnt
+com
+coop
+cri
+def
+ecn
+eco
+edu
+emp
+eng
+esp
+etc
+eti
+far
+flog
+fm
+fnd
+fot
+fst
+g12
+ggf
+gov
+imb
+ind
+inf
+jor
+jus
+leg
+lel
+mat
+med
+mil
+mp
+mus
+net
+nom
+not
+ntr
+odo
+org
+ppg
+pro
+psc
+psi
+qsl
+radio
+rec
+slg
+srv
+taxi
+teo
+tmp
+trd
+tur
+tv
+vet
+vlog
+wiki
+zlg

data/data/country_code_tld/jp.txt

@@ -0,0 +1,9 @@
+ac
+ad
+co
+ed
+go
+gr
+lg
+ne
+or

data/data/country_code_tld/uk.txt

@@ -0,0 +1,15 @@
+ac
+co
+gov
+judiciary
+ltd
+me
+mod
+net
+nhs
+nic
+org
+parliament
+plc
+police
+sch

data/lib/email_inquire.rb

@@ -1,9 +1,7 @@
 # frozen_string_literal: true
 
 require "email_inquire/version"
-require "email_inquire/email_validator"
 require "email_inquire/inquirer"
-require "email_inquire/response"
 
 module EmailInquire
 
@@ -13,43 +11,35 @@ module EmailInquire
   end
 
   def self.custom_invalid_domains=(domains)
-    @@custom_invalid_domains =
+    @custom_invalid_domains =
       case domains
-      when Set
+      when Set, nil
         domains
       when Array
         domains.to_set
-      when nil
-        Set.new
       else
         raise ArgumentError, "Unsupported type in `custom_invalid_domains=`"
       end
   end
 
   def self.custom_invalid_domains
-    @@custom_invalid_domains ||= Set.new
-
-    @@custom_invalid_domains
+    @custom_invalid_domains ||= Set.new
   end
 
   def self.custom_valid_domains=(domains)
-    @@custom_valid_domains =
+    @custom_valid_domains =
       case domains
-      when Set
+      when Set, nil
         domains
       when Array
         domains.to_set
-      when nil
-        Set.new
       else
         raise ArgumentError, "Unsupported type in `custom_valid_domains=`"
       end
   end
 
   def self.custom_valid_domains
-    @@custom_valid_domains ||= Set.new
-
-    @@custom_valid_domains
+    @custom_valid_domains ||= Set.new
   end
 
 end