email_typo 0.1.1 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b2bb8b32af16302a1fbc103c69d81fc49b8586eaf04828f6f5805b060ad319e
-  data.tar.gz: 415393c2f3fe10f979641799f75735b0ac89ed1ee020d898e2d5f2d52f9fd87c
+  metadata.gz: efa2ec563a56461dcd879a22a93f23db4153e552da434ab958a2756b9a6bd366
+  data.tar.gz: f433a26872669bd05c154e21bb6f4de2d98e438ad133d098d8edafee2dc33217
 SHA512:
-  metadata.gz: a6ec7d969ce82f3f10e6fbdd5b1da4a592a2cdfa8c734064d9618a4186d59d406d61fbb0a83bdc74ab92087004865579ac566bb41302d9293abdb6db6da7918c
-  data.tar.gz: 4b920c7ceb864f4976d266174d65f8b141e376dd842d9ea4bffb513e08dd5d9718fa0b77f46825c0664daedef1402efe886a3a955ee63a74ebb4c5e298913b61
+  metadata.gz: e277ece3460063a25bc27a0c561f06cc9fc3d917afb10579e855ef4874db775c58ce43bc010ddaa433766fe1bcd277f728e9c003170fa534c17105b8c27ffc1d
+  data.tar.gz: 06a00156afe49f489c65bcb67a69babe652ba432f41465641138cbb4b7fe9e23af384a918543080d1884420263d18fa3a46b22cc419ad541e036502bbb3c5b68

data/.github/FUNDING.yml

@@ -0,0 +1,4 @@
+# These are supported funding model platforms
+
+github: [fnando]
+custom: ["https://paypal.me/nandovieira/🍕"]

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,41 @@
+---
+name: "🐛 Bug Report"
+about: Report a reproducible bug or regression.
+title: 'Bug: '
+labels: 'Status: Unconfirmed'
+
+---
+
+<!--
+  - Please provide a clear and concise description of what the bug is.
+  - If possible, add an example reproducing your issue.
+  - Please test using the latest version of email_typo
+    to make sure your issue has not already been fixed.
+-->
+
+## Description
+
+[Add bug description here]
+
+## How to reproduce
+
+[Add steps on how to reproduce this issue]
+
+## What do you expect
+
+[Describe what do you expect to happen]
+
+## What happened instead
+
+[Describe the actual results]
+
+## Software:
+
+- Gem version: [Add gem version here]
+- Ruby version: [Add version here]
+
+## Full backtrace
+
+```text
+[Paste full backtrace here]
+```

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,23 @@
+---
+name: "💡 Feature request"
+about: Have an idea that may be useful? Make a suggestion!
+title: 'Feature Request: '
+labels: 'Feature request'
+
+---
+
+## Description
+
+_A clear and concise description of what the problem is._
+
+## Describe the solution
+
+_A clear and concise description of what you want to happen._
+
+## Alternatives you considered
+
+_A clear and concise description of any alternative solutions or features you've considered._
+
+## Additional context
+
+_Add any other context, screenshots, links, etc about the feature request here._

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,38 @@
+<!--
+If you're making a doc PR or something tiny where the below is irrelevant,
+delete this template and use a short description, but in your description aim to
+include both what the change is, and why it is being made, with enough context
+for anyone to understand.
+-->
+
+<details>
+  <summary>PR Checklist</summary>
+
+### PR Structure
+
+- [ ] This PR has reasonably narrow scope (if not, break it down into smaller
+      PRs).
+- [ ] This PR avoids mixing refactoring changes with feature changes (split into
+      two PRs otherwise).
+- [ ] This PR's title starts is concise and descriptive.
+
+### Thoroughness
+
+- [ ] This PR adds tests for the most critical parts of the new functionality or
+      fixes.
+- [ ] I've updated any docs, `.md` files, etc… affected by this change.
+
+</details>
+
+### What
+
+[TODO: Short statement about what is changing.]
+
+### Why
+
+[TODO: Why this change is being made. Include any context required to understand
+the why.]
+
+### Known limitations
+
+[TODO or N/A]

data/.github/dependabot.yml

@@ -0,0 +1,15 @@
+---
+# Documentation:
+# https://docs.github.com/en/free-pro-team@latest/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"
+
+  - package-ecosystem: "bundler"
+    directory: "/"
+    schedule:
+      interval: "daily"

data/.github/workflows/tests.yml

@@ -0,0 +1,55 @@
+name: Tests
+
+on:
+  pull_request:
+    branches:
+      - main
+  push:
+    branches:
+      - main
+
+  schedule:
+    - cron: "0 10 * * *"
+
+jobs:
+  build:
+    name: Tests with Ruby ${{ matrix.ruby }} and ${{ matrix.gemfile }}
+    runs-on: "ubuntu-latest"
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [2.6.x, 2.7.x]
+        gemfile:
+          - Gemfile
+
+    steps:
+      - uses: actions/checkout@v1
+
+      - uses: actions/cache@v2
+        with:
+          path: vendor/bundle
+          key: >
+            ${{ runner.os }}-${{ matrix.ruby }}-gems-${{ hashFiles(matrix.gemfile) }}
+          restore-keys: >
+            ${{ runner.os }}-${{ matrix.ruby }}-gems-${{ hashFiles(matrix.gemfile) }}
+
+      - name: Set up Ruby
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+
+      - name: Install gem dependencies
+        env:
+          BUNDLE_GEMFILE: ${{ matrix.gemfile }}
+        run: |
+          gem install bundler
+          bundle config path vendor/bundle
+          bundle update --jobs 4 --retry 3
+
+      - name: Run Tests
+        env:
+          PGHOST: localhost
+          PGUSER: postgres
+          BUNDLE_GEMFILE: ${{ matrix.gemfile }}
+        run: |
+          bundle exec rake

data/.rubocop.yml

@@ -1,126 +1,7 @@
-AllCops:
-  Exclude:
-    - "bin/**/*"
-    - "gemfiles/**/*"
-    - "vendor/**/*"
-    - "Gemfile"
-    - "Rakefile"
-    - "*.gemspec"
-    - "config.ru"
-
-Style/Alias:
-  EnforcedStyle: prefer_alias_method
-
-Style/FrozenStringLiteralComment:
-  EnforcedStyle: always
-
-Style/ClassCheck:
-  EnforcedStyle: kind_of?
-
-Metrics/LineLength:
-  Max: 80
-
-Style/BlockDelimiters:
-  Enabled: false
-
-Style/RegexpLiteral:
-  Enabled: false
-
-Metrics/AbcSize:
-  Enabled: false
-
-Style/PerlBackrefs:
-  Enabled: false
-
-ClassLength:
-  Enabled: false
-
-CyclomaticComplexity:
-  Enabled: false
-
-Documentation:
-  Enabled: false
-
-Encoding:
-  Enabled: false
-
-FileName:
-  Enabled: false
-
-IfUnlessModifier:
-  Enabled: false
-
-MethodLength:
-  Enabled: false
-
-ModuleFunction:
-  Enabled: false
+---
+inherit_gem:
+  rubocop-fnando: .rubocop.yml
 
-OneLineConditional:
-  Enabled: false
-
-ParameterLists:
-  Enabled: false
-
-Proc:
-  Enabled: false
-
-SingleLineBlockParams:
-  Enabled: false
-
-VariableInterpolation:
-  Enabled: false
-
-Style/TrailingCommaInLiteral:
-  Enabled: false
-
-WhileUntilModifier:
-  Enabled: false
-
-PredicateName:
-  NamePrefixBlacklist:
-    - is_
-
-StringLiterals:
-  EnforcedStyle: double_quotes
-  SupportedStyles:
-    - single_quotes
-    - double_quotes
-
-DotPosition:
-  EnforcedStyle: leading
-
-SpaceBeforeBlockBraces:
-  EnforcedStyle: space
-
-SpaceInsideBlockBraces:
-  EnforcedStyle: no_space
-
-DoubleNegation:
-  Enabled: false
-
-SpaceInsideBlockBraces:
-  SpaceBeforeBlockParameters: false
-
-SpaceInsideHashLiteralBraces:
-  Enabled: false
-
-PercentLiteralDelimiters:
-  PreferredDelimiters:
-    '%':  '[]'
-    '%i': '[]'
-    '%q': '[]'
-    '%Q': '[]'
-    '%r': '[]'
-    '%s': '[]'
-    '%w': '[]'
-    '%W': '[]'
-    '%x': '[]'
-
-Style/CollectionMethods:
-  PreferredMethods:
-    collect: 'map'
-    collect!: 'map!'
-    inject: 'reduce'
-    detect: 'find'
-    find_all: 'select'
+AllCops:
+  TargetRubyVersion: 2.6
+  NewCops: enable

data/.travis.yml

@@ -1,18 +1,19 @@
+---
 sudo: false
 cache: bundler
 language: ruby
 rvm:
-- 2.5.2
+  - "2.7"
 before_install: gem install bundler
 script: bundle exec rake
 notifications:
   email: false
 before_script:
-- curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
-- chmod +x ./cc-test-reporter
-- "./cc-test-reporter before-build"
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - "./cc-test-reporter before-build"
 after_script:
-- "./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT"
+  - "./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT"
 env:
   global:
     secure: XU0SxxhufYnJNYC88bsAHseHtK4fd12B97b7NwHxnND9dDbUPCuGI9mkt06wTZchWnB4nDuS4SF6ib73zAP1JI3m7f2FyazAqrgm/OneXy8GYVQtbrG2+1XObSMc7ONX8K/+VGVnZi2nHO3XyC7VRWQreppVK8U24P7qNpJzmWUTy8XqvJT0ZTupELhbikh1cY1np/ammV4eX6QwoeSDd0Wx5QM4D/P06NEXqQ7PdYBBIDuB8zFwSZLh/Q8wNDiOwcUVJTULh/nLmdGMclCcp/aRPrbbWk01scS3khqiJK8SfujeDYNJeuaECGm/9r9MZHvH9Qd88aUJBZcxJRXJiZJ6xuYvc7WnF8tNxGp8xNYTr9/YJrUPPMDdoLr50LyXiY1wf3A0dQHdGNIv5gd7pMoEK+kg0dkqcnhg6OQNRkihudbFuORdKRocIVzHgxB3We+FBnqfexgzLNoYU3eJB3IL8nS0dRX2lSP36SDXTkZNUxflDgGLmoz//FRll3WJ1VsGOkZqBPA2TMoRxqLyhaVnXuPS5uiBUu4gAC4df4HWPAtM1LFtI1HvMenKOYFDqjrPqLevtmQTP/72zl84GAA3hoBGnPgOh2GBtAo/nn5ExbWQUfHSYMwSVD3rrMhe5Lt7G6mzg8hkGU7hYOKwrfSUq/i3+omS0gwHEUBh2vQ=

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+# Changelog
+
+<!--
+Prefix your message with one of the following:
+
+- [Added] for new features.
+- [Changed] for changes in existing functionality.
+- [Deprecated] for soon-to-be removed features.
+- [Removed] for now removed features.
+- [Fixed] for any bug fixes.
+- [Security] in case of vulnerabilities.
+-->
+
+## Unreleased
+
+- Initial release.

data/CODE_OF_CONDUCT.md

@@ -55,7 +55,7 @@ further defined and clarified by project maintainers.
 ## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at fnando.vieira@gmail.com. All
+reported by contacting the project team at me@fnando.com. All
 complaints will be reviewed and investigated and will result in a response that
 is deemed necessary and appropriate to the circumstances. The project team is
 obligated to maintain confidentiality with regard to the reporter of an incident.
@@ -68,7 +68,7 @@ members of the project's leadership.
 ## Attribution
 
 This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at [http://contributor-covenant.org/version/1/4][version]
+available at [https://contributor-covenant.org/version/1/4][version]
 
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/4/
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/CONTRIBUTING.md

@@ -0,0 +1,79 @@
+# Contributing to email_typo
+
+👍🎉 First off, thanks for taking the time to contribute! 🎉👍
+
+The following is a set of guidelines for contributing to this project. These are
+mostly guidelines, not rules. Use your best judgment, and feel free to propose
+changes to this document in a pull request.
+
+## Code of Conduct
+
+Everyone interacting in this project's codebases, issue trackers, chat rooms and
+mailing lists is expected to follow the [code of conduct](https://github.com/fnando/email_typo/blob/main/CODE_OF_CONDUCT.md).
+
+## Reporting bugs
+
+This section guides you through submitting a bug report. Following these
+guidelines helps maintainers and the community understand your report, reproduce
+the behavior, and find related reports.
+
+- Before creating bug reports, please check the open issues; somebody may
+  already have submitted something similar, and you may not need to create a new
+  one.
+- When you are creating a bug report, please include as many details as
+  possible, with an example reproducing the issue.
+
+## Contributing with code
+
+Before making any radicals changes, please make sure you discuss your intention
+by [opening an issue on Github](https://github.com/fnando/email_typo/issues).
+
+When you're ready to make your pull request, follow checklist below to make sure
+your contribution is according to how this project works.
+
+1. [Fork](https://help.github.com/forking/) email_typo
+2. Create a topic branch - `git checkout -b my_branch`
+3. Make your changes using [descriptive commit messages](#commit-messages)
+4. Update CHANGELOG.md describing your changes by adding an entry to the
+   "Unreleased" section. If this section is not available, create one right
+   before the last version.
+5. Push to your branch - `git push origin my_branch`
+6. [Create a pull request](https://docs.github.com/articles/creating-a-pull-request)
+7. That's it!
+
+## Styleguides
+
+### Commit messages
+
+- Use the present tense ("Add feature" not "Added feature")
+- Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
+- Limit the first line to 72 characters or less
+- Reference issues and pull requests liberally after the first line
+
+### Changelog
+
+- Add a message describing your changes to the "Unreleased" section. The
+  changelog message should follow the same style as the commit message.
+- Prefix your message with one of the following:
+  - `[Added]` for new features.
+  - `[Changed]` for changes in existing functionality.
+  - `[Deprecated]` for soon-to-be removed features.
+  - `[Removed]` for now removed features.
+  - `[Fixed]` for any bug fixes.
+  - `[Security]` in case of vulnerabilities.
+
+### Ruby code
+
+- This project uses [Rubocop](https://rubocop.org) to enforce code style. Before
+  submitting your changes, make sure your tests are passing and code conforms to
+  the expected style by running `rake`.
+- Do not change the library version. This will be done by the maintainer
+  whenever a new version is about to be released.
+
+### JavaScript code
+
+- This project uses [ESLint](https://eslint.org) to enforce code style. Before
+  submitting your changes, make sure your tests are passing and code conforms to
+  the expected style by running `yarn test:ci`.
+- Do not change the library version. This will be done by the maintainer
+  whenever a new version is about to be released.

data/Gemfile

@@ -1,4 +1,5 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 
-# Specify your gem's dependencies in email_typo.gemspec
 gemspec

data/LICENSE.md

@@ -0,0 +1,20 @@
+# The MIT License (MIT)
+
+Copyright (c) 2020 Nando Vieira
+
+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

@@ -1,45 +1,49 @@
-# EmailTypo
+# email_typo
 
-[![Travis-CI](https://travis-ci.org/fnando/email_typo.svg)](https://travis-ci.org/fnando/email_typo)
+[![Tests](https://github.com/fnando/email_typo/workflows/Tests/badge.svg)](https://github.com/fnando/email_typo)
 [![Code Climate](https://codeclimate.com/github/fnando/email_typo/badges/gpa.svg)](https://codeclimate.com/github/fnando/email_typo)
-[![Test Coverage](https://codeclimate.com/github/fnando/email_typo/badges/coverage.svg)](https://codeclimate.com/github/fnando/email_typo/coverage)
 [![Gem](https://img.shields.io/gem/v/email_typo.svg)](https://rubygems.org/gems/email_typo)
 [![Gem](https://img.shields.io/gem/dt/email_typo.svg)](https://rubygems.org/gems/email_typo)
 
-EmailTypo is a Ruby gem that gives you an easy, tested method that fixes email typos.
+EmailTypo is a Ruby gem that gives you an easy, tested method that fixes email
+typos.
 
-As an example: A user with the email "joe@gmail.com" accidentally enters in "joe@gmal.cmo", EmailTypo will fix it automatically.
+As an example: A user with the email "joe@gmail.com" accidentally enters in
+"joe@gmal.cmo", EmailTypo will fix it automatically.
 
-EmailTypo is concerned with incorrectly-entered data (email provider names, TLDs), not with evaluating whether a particular domain is valid, or whether a particular email address is legitimate. (That is, it's focused on fixing the part that comes after the "@" in the email address.) It works really well for helping you — and your users — when they accidentally type something in wrong.
+EmailTypo is concerned with incorrectly-entered data (email provider names,
+TLDs), not with evaluating whether a particular domain is valid, or whether a
+particular email address is legitimate. (That is, it's focused on fixing the
+part that comes after the "@" in the email address.) It works really well for
+helping you — and your users — when they accidentally type something in wrong.
 
-**NOTE**: This is based on https://github.com/charliepark/fat_fingers, but without polluting the `String` class and with easier extension support.
+**NOTE**: This is based on https://github.com/charliepark/fat_fingers, but
+without polluting the `String` class and with easier extension support.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+```bash
+gem install email_typo
+```
+
+Or add the following line to your project's Gemfile:
 
 ```ruby
 gem "email_typo"
 ```
 
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install email_typo
-
 ## Usage
 
-To fix any typos, just use `EmailTypo.fix(email)`.
+To fix any typos, just use `EmailTypo.call(email)`.
 
 ```ruby
-EmailTypo.fix("john.doe@gmail.co")
+EmailTypo.call("john.doe@gmail.co")
 #=> "john.doe@gmail.com"
 ```
 
-To add/change the processors, add any object that responds to `#call(email)` to `EmailTypo.default_processors`. The following example adds a processor for `.uol.com.br`, a Brazilian email provider:
+To add/change the processors, add any object that responds to `#call(email)` to
+`EmailTypo.default_processors`. The following example adds a processor for
+`.uol.com.br`, a Brazilian email provider:
 
 ```ruby
 EmailTypo.default_processors << lambda do |email|
@@ -47,16 +51,27 @@ EmailTypo.default_processors << lambda do |email|
 end
 ```
 
-## Development
+## Maintainer
+
+- [Nando Vieira](https://github.com/fnando)
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+## Contributors
 
-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).
+- https://github.com/fnando/email_typo/contributors
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/fnando/email_typo. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+For more details about how to contribute, please read
+https://github.com/fnando/email_typo/blob/main/CONTRIBUTING.md.
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the
+[MIT License](https://opensource.org/licenses/MIT). A copy of the license can be
+found at https://github.com/fnando/email_typo/blob/main/LICENSE.md.
+
+## Code of Conduct
+
+Everyone interacting in the email_typo project's codebases, issue trackers, chat
+rooms and mailing lists is expected to follow the
+[code of conduct](https://github.com/fnando/email_typo/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 require "rake/testtask"
+require "rubocop/rake_task"
 
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"
@@ -7,4 +10,6 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList["test/**/*_test.rb"]
 end
 
-task :default => :test
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require "bundler/setup"
 require "email_typo"
@@ -6,9 +7,10 @@ require "email_typo"
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
 
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)
+begin
+  require "pry"
+  Pry.start
+rescue LoadError
+  require "irb"
+  IRB.start(__FILE__)
+end

data/bin/setup

@@ -1,5 +1,7 @@
 #!/usr/bin/env bash
+
 set -euo pipefail
+
 IFS=$'\n\t'
 set -vx
 

data/email_typo.gemspec

@@ -1,28 +1,46 @@
 # frozen_string_literal: true
 
-require "./lib/email_typo/version"
+require_relative "./lib/email_typo/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = "email_typo"
-  spec.version       = EmailTypo::VERSION
-  spec.authors       = ["Nando Vieira"]
-  spec.email         = ["fnando.vieira@gmail.com"]
-
-  spec.summary       = "Clean up e-mail strings when the user's made a typo (like 'gmail.cmo')."
-  spec.description   = spec.summary
-  spec.homepage      = "https://github.com/fnando/email_typo"
-  spec.license       = "MIT"
-
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
+  spec.name    = "email_typo"
+  spec.version = EmailTypo::VERSION
+  spec.authors = ["Nando Vieira"]
+  spec.email   = ["me@fnando.com"]
+
+  spec.summary     = "Suggest fixes to a misspelled email address, like " \
+                     "john@gmail.cmo."
+  spec.description = spec.summary
+  spec.license     = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.6.0")
+
+  github_url = "https://github.com/fnando/email_typo"
+  github_tree_url = "#{github_url}/tree/v#{spec.version}"
+
+  spec.homepage = github_url
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["bug_tracker_uri"] = "#{github_url}/issues"
+  spec.metadata["source_code_uri"] = github_tree_url
+  spec.metadata["changelog_uri"] = "#{github_tree_url}/CHANGELOG.md"
+  spec.metadata["documentation_uri"] = "#{github_tree_url}/README.md"
+  spec.metadata["license_uri"] = "#{github_tree_url}/LICENSE.md"
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`
+      .split("\x0")
+      .reject {|f| f.match(%r{^(test|spec|features)/}) }
   end
+
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) {|f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler"
-  spec.add_development_dependency "rake"
+  spec.add_development_dependency "email_data"
+  spec.add_development_dependency "minitest"
   spec.add_development_dependency "minitest-utils"
   spec.add_development_dependency "pry-meta"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "rubocop-fnando"
   spec.add_development_dependency "simplecov"
 end

data/fat_fingers_last_commit

@@ -0,0 +1 @@
+40ccae7c07c87212f1397f92a6f0224373130260

data/lib/email_typo.rb

@@ -9,9 +9,12 @@ require_relative "./email_typo/different_tlds"
 require_relative "./email_typo/dot_com"
 require_relative "./email_typo/dot_net"
 require_relative "./email_typo/dot_org"
+require_relative "./email_typo/fix_extraneous_letter_dot_com"
+require_relative "./email_typo/fix_extraneous_numbers"
 require_relative "./email_typo/gmail"
 require_relative "./email_typo/googlemail"
 require_relative "./email_typo/hotmail"
+require_relative "./email_typo/icloud"
 require_relative "./email_typo/known_dot_com"
 require_relative "./email_typo/period_around_at_sign"
 require_relative "./email_typo/providers"
@@ -32,6 +35,8 @@ module EmailTypo
     TransposedPeriods,
     PeriodAroundAtSign,
     DifferentTlds,
+    FixExtraneousLetterDotCom,
+    FixExtraneousNumbers,
     AddMissingM,
     AddMissingPeriod,
     Providers,
@@ -42,15 +47,21 @@ module EmailTypo
     Gmail,
     Googlemail,
     Hotmail,
+    Icloud,
     KnownDotCom,
     Yahoo
   ]
 
-  def self.fix(email, processors = default_processors)
+  def self.call(email, processors = default_processors)
     return unless email
 
     processors.reduce(email.downcase) do |processed_email, processor|
       processor.call(processed_email)
     end
   end
+
+  def self.fix(email, processors = default_processors)
+    warn "EmailTypo.fix is deprecated; use EmailTypo.call instead."
+    call(email, processors)
+  end
 end

data/lib/email_typo/add_missing_period.rb

@@ -2,6 +2,6 @@
 
 module EmailTypo
   AddMissingPeriod = lambda do |email|
-    email.gsub(/([^\.])(com|org|net)$/, "\\1.\\2")
+    email.gsub(/([^.])(com|org|net)$/, "\\1.\\2")
   end
 end

data/lib/email_typo/different_tlds.rb

@@ -3,7 +3,20 @@
 module EmailTypo
   DifferentTlds = lambda do |email|
     email
-      .gsub(/\.(o\.uk|couk|co\.um)$/, ".co.uk")
-      .gsub(/\.(cojp|co\.lp)$/, ".co.jp")
+      .gsub(/\.(o\.uk|co\.k|couk|co\.u[kmnlj]{0,2})$/, ".co.uk")
+      .gsub(/\.(cojp|co\.lp|co\.p)$/, ".co.jp")
+      .gsub(/\.(com?br|com?\.[bv]r+)$/, ".com.br")
+      .gsub(/\.(r+(u+(?!n).|y)|r)$/, ".ru")
+      .gsub(/\.i+t+$/, ".it")
+      .gsub(/\.f+[re]+$/, ".fr")
+      .gsub(/\.de+(?!v).$/, ".de")
+      .gsub(/\.jn$/, ".in")
+      .gsub(/\.lde$/, ".de")
+      .gsub(/\.oprg$/, ".org")
+      .gsub(/\.gob(\b|\.)/, ".gov")
+      .gsub(/\.edi?(\b|\.)/, ".edu")
+      .gsub(/\.mx.{1,2}$/, ".mx")
+      .gsub(/\.[com.]{2,3}ar$/, ".com.ar")
+      .gsub(/\.[com.]{2,3}au$/, ".com.au")
   end
 end

data/lib/email_typo/dot_net.rb

@@ -2,6 +2,8 @@
 
 module EmailTypo
   DotNet = lambda do |email|
-    email.gsub(/\.(nte*|n*et*)$/, ".net")
+    email
+      .gsub(/\.(nte*|n*et*|ney)$/, ".net")
+      .gsub(/\.met$/, ".net")
   end
 end

data/lib/email_typo/fix_extraneous_letter_dot_com.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module EmailTypo
+  FixExtraneousLetterDotCom = lambda do |email|
+    email
+      .gsub(/\..com$/, ".com")
+  end
+end

data/lib/email_typo/fix_extraneous_numbers.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module EmailTypo
+  FixExtraneousNumbers = lambda do |email|
+    email.gsub(/\.?\d+$/, "")
+  end
+end

data/lib/email_typo/gmail.rb

@@ -2,6 +2,11 @@
 
 module EmailTypo
   Gmail = lambda do |email|
-    email.gsub(/@g[nm]{0,2}s?[ail]{1,2}[aiklmou]{0,3}\.(?!gov|edu)/, "@gmail.")
+    email
+      .gsub(
+        /@ga?e?i?o?r?g?[nm]{0,2}s?[ail]{1,2}[aiklmou]{0,3}\.(?!gov|edu|ac\.in)/,
+        "@gmail."
+      )
+      .gsub(/@gmail\.(com\.\w+|c)$/, "@gmail.com")
   end
 end

data/lib/email_typo/googlemail.rb

@@ -3,6 +3,9 @@
 module EmailTypo
   Googlemail = lambda do |email|
     email
-      .gsub(/@go{0,3}g{0,2}o?le?[mn]?[ail]{1,2}m?[aikl]{0,3}\./, "@googlemail.")
+      .gsub(
+        /@go{0,3}g{0,2}o?le?[mn]?[ail]{1,2}m?[aikl]{0,3}\.(?!gov|edu|ac\.in)/,
+        "@googlemail."
+      )
   end
 end

data/lib/email_typo/hotmail.rb

@@ -2,6 +2,12 @@
 
 module EmailTypo
   Hotmail = lambda do |email|
-    email.gsub(/@h(i|o|p)?y?t?o?a?m?n?t?[aikl]{1,3}l?\./, "@hotmail.")
+    email
+      .gsub(
+        /@h((?!anmail)(i|o|p)?y?t?o?a?r?m?n?t?m?[aikl]{1,3}l?)\./,
+        "@hotmail."
+      )
+      .gsub(/@otmail\.com/, "@hotmail.com")
+      .gsub(/@hotmail.com[a-z]+/, "@hotmail.com")
   end
 end

data/lib/email_typo/icloud.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module EmailTypo
+  Icloud = lambda do |email|
+    email.gsub(/@icl{0,2}(?:uo|u|o)?d\./, "@icloud.")
+  end
+end

data/lib/email_typo/known_dot_com.rb

@@ -4,7 +4,7 @@ module EmailTypo
   KnownDotCom = lambda do |email|
     email
       .gsub(
-        /@(aol|googlemail|gmail|hotmail|yahoo|icloud|outlook)\.([a-z]+)$/,
+        /@(aol|googlemail|gmail|hotmail|yahoo|icloud|outlook)\.(co|net|org)$/,
         "@\\1.com"
       )
   end

data/lib/email_typo/remove_invalid_chars.rb

@@ -3,8 +3,10 @@
 module EmailTypo
   RemoveInvalidChars = lambda do |email|
     email
-      .gsub(/(\s|\#|\'|\"|\\)*/, "")
-      .gsub(/(\,|\.\.)/, ".")
+      .gsub(/(\s|[#`'"\\|])*/, "")
+      .gsub(%r{/}, ".")
+      .gsub(/(,|\.\.)/, ".")
+      .gsub("!", "1")
       .gsub("@@", "@")
   end
 end

data/lib/email_typo/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module EmailTypo
-  VERSION = "0.1.1".freeze
+  VERSION = "0.2.3"
 end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: email_typo
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.3
 platform: ruby
 authors:
 - Nando Vieira
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-02-09 00:00:00.000000000 Z
+date: 2020-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: email_data
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -66,6 +66,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !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: rubocop
+  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: rubocop-fnando
+  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: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -80,24 +122,33 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Clean up e-mail strings when the user's made a typo (like 'gmail.cmo').
+description: Suggest fixes to a misspelled email address, like john@gmail.cmo.
 email:
-- fnando.vieira@gmail.com
+- me@fnando.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/FUNDING.yml"
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/feature_request.md"
+- ".github/PULL_REQUEST_TEMPLATE.md"
+- ".github/dependabot.yml"
+- ".github/workflows/tests.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
 - Gemfile
-- LICENSE.txt
+- LICENSE.md
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
 - email_typo.gemspec
+- fat_fingers_last_commit
 - lib/email_typo.rb
 - lib/email_typo/add_missing_m.rb
 - lib/email_typo/add_missing_period.rb
@@ -106,9 +157,12 @@ files:
 - lib/email_typo/dot_com.rb
 - lib/email_typo/dot_net.rb
 - lib/email_typo/dot_org.rb
+- lib/email_typo/fix_extraneous_letter_dot_com.rb
+- lib/email_typo/fix_extraneous_numbers.rb
 - lib/email_typo/gmail.rb
 - lib/email_typo/googlemail.rb
 - lib/email_typo/hotmail.rb
+- lib/email_typo/icloud.rb
 - lib/email_typo/known_dot_com.rb
 - lib/email_typo/period_around_at_sign.rb
 - lib/email_typo/providers.rb
@@ -120,8 +174,14 @@ files:
 homepage: https://github.com/fnando/email_typo
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  homepage_uri: https://github.com/fnando/email_typo
+  bug_tracker_uri: https://github.com/fnando/email_typo/issues
+  source_code_uri: https://github.com/fnando/email_typo/tree/v0.2.3
+  changelog_uri: https://github.com/fnando/email_typo/tree/v0.2.3/CHANGELOG.md
+  documentation_uri: https://github.com/fnando/email_typo/tree/v0.2.3/README.md
+  license_uri: https://github.com/fnando/email_typo/tree/v0.2.3/LICENSE.md
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -129,15 +189,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
-summary: Clean up e-mail strings when the user's made a typo (like 'gmail.cmo').
+summary: Suggest fixes to a misspelled email address, like john@gmail.cmo.
 test_files: []

data/LICENSE.txt

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2017 Nando Vieira
-
-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.