emailness 0.1.0.alpha

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5c214db36c29017473cd5702bf9ce3d9c392b28670e663e8c82d05c4216e3ce9
+  data.tar.gz: 44ac81ed3b31cf8599e3fdc125849b44a8dcc9a759a3459767e6590dcabe98dc
+SHA512:
+  metadata.gz: 7aaf69076e11dd2802ea2a11b5811be18cf50b19254258ce23b09575d1abfe6bce0db58040a31cdde323d4f89fef20dd0d680df136778320feeaba116d88d22f
+  data.tar.gz: cb159d71c25ebbc044cf7ff28112185aeed0b49bff4f0f17e9832312501866112a5f234ecb5c9911b3f8bffaf971345da3b7d6d7cd6c44eddb809f760b7ea9cd

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.2
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+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 jonathan@allard.io. 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.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,13 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in emailness.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+
+gem "pry"
+gem "pry-rescue"
+gem "pry-stack_explorer"
+
+gem "activesupport"

data/Gemfile.lock

@@ -0,0 +1,66 @@
+PATH
+  remote: .
+  specs:
+    emailness (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.1.0)
+      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)
+      debug_inspector (>= 0.0.1)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.7)
+    debug_inspector (0.0.3)
+    diff-lcs (1.4.4)
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
+    interception (0.5)
+    method_source (1.0.0)
+    minitest (5.14.2)
+    pry (0.13.1)
+      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 (~> 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-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport
+  emailness!
+  pry
+  pry-rescue
+  pry-stack_explorer (~> 0.5.1)
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Jonathan Allard
+
+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,90 @@
+# Emailness
+**Care very little about email validation**
+
+Email validation with sensible defaults so you can go care about more important things.
+
+* 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
+
+**TODO: Make the Rails validator work/test it.**
+**TODO: Publish gem**
+
+Add the gem:
+
+```
+bundle add emailness
+```
+
+Add it to your model:
+
+```
+validates_emailness_of :email
+```
+
+And have a great day.
+
+---
+
+## Test cases
+The spec file is made on purpose to be simple.
+
+```
+$ 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] ✘
+```
+
+*TODO: Update this automatically*
+
+If you would like to add a case, simply open an issue or PR.
+
+## Usage
+
+Either use it in Rails, or vanilla:
+
+```
+Emailness.valid?(email)  # true/false
+```
+
+## Contributing
+Are welcome:
+
+* Contributions about making it easier to use this gem
+* Improving the present documentation
+* "Forgotten" email address cases that follow the spirit of this gem
+
+I also gladly welcome suggestions about merging this code elsewhere and making it obsolete entirely.
+
+## 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).
+
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/joallard/emailness/blob/master/CODE_OF_CONDUCT.md).
+
+Everyone interacting in the Emailness project's codebases, issue trackers, chat rooms and mailing lists is expected to follow it.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "emailness"
+
+# 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__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/emailness.gemspec

@@ -0,0 +1,29 @@
+require_relative 'lib/emailness/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "emailness"
+  spec.version       = Emailness::VERSION
+  spec.authors       = ["Jonathan Allard"]
+  spec.email         = ["jonathan@allard.io"]
+
+  spec.summary       = %q{Care very little about email validation}
+  # spec.description   = %q{TOD0: Write a longer description or delete this line.}
+  spec.homepage      = "https://github.com/joallard/emailness"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = spec.homepage + "/blob/master/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) 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"]
+end

data/lib/emailness.rb

@@ -0,0 +1,22 @@
+require "emailness/version"
+require "emailness/validator" if defined?(ActiveModel::EachValidator)
+
+module Emailness
+  def self.valid?(string)
+    parts = string.split("@")
+    return false if parts.length != 2
+
+    local, domain = parts
+
+    domain.split(".").each do |it|
+      return false unless it =~ /^[a-z]([a-z0-9-])*[a-z0-9]$/i
+    end
+
+    return false if local.include?("..")
+    return false unless local =~ /^[a-z0-9\-.!#$%&'*+\/=?^_`{|}~]*$/i
+
+    true
+  end
+
+  class Error < StandardError; end
+end

data/lib/emailness/validator.rb

@@ -0,0 +1,10 @@
+module 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")
+  end
+end
+
+if defined?(ActiveRecord::Base)
+end

data/lib/emailness/version.rb

@@ -0,0 +1,3 @@
+module Emailness
+  VERSION = "0.1.0.alpha"
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: emailness
+version: !ruby/object:Gem::Version
+  version: 0.1.0.alpha
+platform: ruby
+authors:
+- Jonathan Allard
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-12-18 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- jonathan@allard.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- emailness.gemspec
+- lib/emailness.rb
+- lib/emailness/validator.rb
+- lib/emailness/version.rb
+homepage: https://github.com/joallard/emailness
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  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: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Care very little about email validation
+test_files: []