email_address 0.1.17 → 0.1.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8835c0835419dbf67cab6698b47d8641e5839036685727d4e5ed0e455caef6f4
-  data.tar.gz: 553e9787f16788dce7bcff2d9b0d1f962deb03c575b35d2131a93a1c6795fd08
+  metadata.gz: 2a5ff67ec79e4de2d356293664296391fc8296ad6a6ba08f1d1256e93f7c729c
+  data.tar.gz: 5485014c6f886d9a382c046f9025948eeed6c114accde2957424f1f613d1b51b
 SHA512:
-  metadata.gz: b1be9796aa6e245c623b940e0254cd303726439c0382c8f30e4b3d444c97dbd5575bbec5e61745621c1a8e5a39e764dad0b19a1200c64a1187978db8c9664a04
-  data.tar.gz: 7c395ddbacdb048c96b8ceeeed2504ebbf42acc8c68b9d1424811cb22156789f2844704ba2919841065421242830ec180fa13fbd810976f2ea02bec0626c60a3
+  metadata.gz: 336f61eb9e81ccf8fe859b0d05e5e4d1aaf734e06328169ce919a01fdf30caaebdb2f44e673b52cdde99e3790c413c854e486fd97e4c610b5ee6349c1e3dbe40
+  data.tar.gz: c08f83be388d6fdb646ea46439c0a65543091e401b9c9d38e312a7d2dc34313c3269f9c16916340d090f48ae224a1cd18631153d6478f87e32073f38e319ff28

data/README.md

@@ -552,6 +552,33 @@ The value is an array of match tokens.
 * host_match:         %w(.org example.com hotmail. user*@ sub.*.com)
 * exchanger_match:    %w(google.com 127.0.0.1 10.9.8.0/24 ::1/64)
 
+### Namespace conflict resolution
+
+If your application already uses the `EmailAddress` class name,
+it's possible to create an alias prior to loading your code:
+
+For a Rails application, you can do this in `config/application.rb`
+after the `Bundler.require` line, usually:
+
+```ruby
+Bundler.require(*Rails.groups)
+```
+
+Add these lines immediately after that point:
+
+```ruby
+EmailAddressValidator = EmailAddress
+Object.send(:remove_const, :EmailAddress)
+```
+
+Then your application loads with your EmailAddress class. You may
+then use this gem with `EmailAddressValidator` or whatever name you
+gave it above:
+
+```ruby
+EmailAddressValidator.valid?("clark.kent@gmail.com") # => true
+```
+
 ## Notes
 
 #### Internationalization

data/lib/email_address.rb

@@ -40,31 +40,30 @@ module EmailAddress
   #   secret to use in options[:secret]
   class << self
     (%i[valid? error normal redact munge canonical reference base srs] &
-     EmailAddress::Address.public_instance_methods
+     Address.public_instance_methods
     ).each do |proxy_method|
       define_method(proxy_method) do |*args, &block|
-        EmailAddress::Address.new(*args).public_send(proxy_method, &block)
+        Address.new(*args).public_send(proxy_method, &block)
       end
     end
-  end
-
 
-  # Creates an instance of this email address.
-  # This is a short-cut to Email::Address::Address.new
-  def self.new(email_address, config={})
-    EmailAddress::Address.new(email_address, config)
-  end
+    # Creates an instance of this email address.
+    # This is a short-cut to EmailAddress::Address.new
+    def new(email_address, config={})
+      Address.new(email_address, config)
+    end
 
-  def self.new_redacted(email_address, config={})
-    EmailAddress::Address.new(EmailAddress::Address.new(email_address, config).redact)
-  end
+    def new_redacted(email_address, config={})
+      Address.new(Address.new(email_address, config).redact)
+    end
 
-  def self.new_canonical(email_address, config={})
-    EmailAddress::Address.new(EmailAddress::Address.new(email_address, config).canonical, config)
-  end
+    def new_canonical(email_address, config={})
+      Address.new(Address.new(email_address, config).canonical, config)
+    end
 
-  # Does the email address match any of the given rules
-  def self.matches?(email_address, rules, config={})
-    EmailAddress::Address.new(email_address, config).matches?(rules)
+    # Does the email address match any of the given rules
+    def matches?(email_address, rules, config={})
+      Address.new(email_address, config).matches?(rules)
+    end
   end
 end

data/lib/email_address/active_record_validator.rb

@@ -35,10 +35,10 @@ module EmailAddress
 
     def validate_email(r,f)
       return if r[f].nil?
-      e = EmailAddress.new(r[f])
+      e = Address.new(r[f])
       unless e.valid?
         r.errors[f] << (@opt[:message] ||
-                       EmailAddress::Config.error_messages[:invalid_address] ||
+                       Config.error_messages[:invalid_address] ||
                        "Invalid Email Address")
       end
     end

data/lib/email_address/address.rb

@@ -5,32 +5,32 @@ require "digest/md5"
 
 module EmailAddress
   # Implements the Email Address container, which hold the Local
-  # (EmailAddress::Local) and Host (Email::AddressHost) parts.
+  # (EmailAddress::Local) and Host (EmailAddress::Host) parts.
   class Address
     include Comparable
-    include EmailAddress::Rewriter
+    include Rewriter
 
     attr_accessor :original, :local, :host, :config, :reason
 
-    CONVENTIONAL_REGEX = /\A#{::EmailAddress::Local::CONVENTIONAL_MAILBOX_WITHIN}
-                           @#{::EmailAddress::Host::DNS_HOST_REGEX}\z/x
-    STANDARD_REGEX = /\A#{::EmailAddress::Local::STANDARD_LOCAL_WITHIN}
-                           @#{::EmailAddress::Host::DNS_HOST_REGEX}\z/x
-    RELAXED_REGEX = /\A#{::EmailAddress::Local::RELAXED_MAILBOX_WITHIN}
-                           @#{::EmailAddress::Host::DNS_HOST_REGEX}\z/x
+    CONVENTIONAL_REGEX = /\A#{Local::CONVENTIONAL_MAILBOX_WITHIN}
+                           @#{Host::DNS_HOST_REGEX}\z/x
+    STANDARD_REGEX = /\A#{Local::STANDARD_LOCAL_WITHIN}
+                           @#{Host::DNS_HOST_REGEX}\z/x
+    RELAXED_REGEX = /\A#{Local::RELAXED_MAILBOX_WITHIN}
+                           @#{Host::DNS_HOST_REGEX}\z/x
 
     # Given an email address of the form "local@hostname", this sets up the
     # instance, and initializes the address to the "normalized" format of the
     # address. The original string is available in the #original method.
     def initialize(email_address, config = {})
-      @config = EmailAddress::Config.new(config)
+      @config = Config.new(config)
       @original = email_address
       email_address = (email_address || "").strip
       email_address = parse_rewritten(email_address) unless config[:skip_rewrite]
-      local, host = EmailAddress::Address.split_local_host(email_address)
+      local, host = Address.split_local_host(email_address)
 
-      @host = EmailAddress::Host.new(host, @config)
-      @local = EmailAddress::Local.new(local, @config, @host)
+      @host = Host.new(host, @config)
+      @local = Local.new(local, @config, @host)
       @error = @error_message = nil
     end
 
@@ -114,7 +114,7 @@ module EmailAddress
     alias to_s normal
 
     def inspect
-      "#<EmailAddress::Address:0x#{object_id.to_s(16)} address=\"#{self}\">"
+      "#<#{self.class}:0x#{object_id.to_s(16)} address=\"#{self}\">"
     end
 
     # Returns the canonical email address according to the provider
@@ -190,7 +190,7 @@ module EmailAddress
     # of this addres with another, using the canonical or redacted forms.
     def same_as?(other_email)
       if other_email.is_a?(String)
-        other_email = EmailAddress::Address.new(other_email)
+        other_email = Address.new(other_email)
       end
 
       canonical == other_email.canonical ||
@@ -276,7 +276,7 @@ module EmailAddress
     def set_error(err, reason = nil)
       @error = err
       @reason = reason
-      @error_message = EmailAddress::Config.error_message(err)
+      @error_message = Config.error_message(err)
       false
     end
 

data/lib/email_address/canonical_email_address_type.rb

@@ -29,20 +29,22 @@
 #    user.canonical_email #=> "patsmith@gmail.com"
 ################################################################################
 
-class EmailAddress::CanonicalEmailAddressType < ActiveRecord::Type::Value
+module EmailAddress
+  class CanonicalEmailAddressType < ActiveRecord::Type::Value
 
-  # From user input, setter
-  def cast(value)
-    super(EmailAddress.canonical(value))
-  end
+    # From user input, setter
+    def cast(value)
+      super(Address.new(value).canonical)
+    end
 
-  # From a database value
-  def deserialize(value)
-    value && EmailAddress.normal(value)
-  end
+    # From a database value
+    def deserialize(value)
+      value && Address.new(value).normal
+    end
 
-  # To a database value (string)
-  def serialize(value)
-    value && EmailAddress.normal(value)
+    # To a database value (string)
+    def serialize(value)
+      value && Address.new(value).normal
+    end
   end
 end

data/lib/email_address/config.rb

@@ -201,7 +201,7 @@ module EmailAddress
     end
 
     def initialize(overrides = {})
-      @config = EmailAddress::Config.all_settings(overrides)
+      @config = Config.all_settings(overrides)
     end
 
     def []=(setting, value)

data/lib/email_address/email_address_type.rb

@@ -29,20 +29,22 @@
 #    user.canonical_email #=> "patsmith@gmail.com"
 ################################################################################
 
-class EmailAddress::EmailAddressType < ActiveRecord::Type::Value
+module EmailAddress
+  class EmailAddressType < ActiveRecord::Type::Value
 
-  # From user input, setter
-  def cast(value)
-    super(EmailAddress.normal(value))
-  end
+    # From user input, setter
+    def cast(value)
+      super(Address.new(value).normal)
+    end
 
-  # From a database value
-  def deserialize(value)
-    value && EmailAddress.normal(value)
-  end
-  #
-  # To a database value (string)
-  def serialize(value)
-    value && EmailAddress.normal(value)
+    # From a database value
+    def deserialize(value)
+      value && Address.new(value).normal
+    end
+
+    # To a database value (string)
+    def serialize(value)
+      value && Address.new(value).normal
+    end
   end
 end

data/lib/email_address/exchanger.rb

@@ -24,7 +24,7 @@ module EmailAddress
 
     def initialize(host, config = {})
       @host = host
-      @config = config.is_a?(Hash) ? EmailAddress::Config.new(config) : config
+      @config = config.is_a?(Hash) ? Config.new(config) : config
       @dns_disabled = @config[:host_validation] == :syntax || @config[:dns_lookup] == :off
     end
 
@@ -38,7 +38,7 @@ module EmailAddress
     # Returns the provider name based on the MX-er host names, or nil if not matched
     def provider
       return @provider if defined? @provider
-      EmailAddress::Config.providers.each do |provider, config|
+      Config.providers.each do |provider, config|
         if config[:exchanger_match] && matches?(config[:exchanger_match])
           return @provider = provider
         end
@@ -76,7 +76,7 @@ module EmailAddress
 
     # Returns Array of domain names for the MX'ers, used to determine the Provider
     def domains
-      @_domains ||= mxers.map { |m| EmailAddress::Host.new(m.first).domain_name }.sort.uniq
+      @_domains ||= mxers.map { |m| Host.new(m.first).domain_name }.sort.uniq
     end
 
     # Returns an array of MX IP address (String) for the given email domain

data/lib/email_address/host.rb

@@ -87,7 +87,7 @@ module EmailAddress
     def initialize(host_name, config = {})
       @original = host_name ||= ""
       config[:host_type] ||= :email
-      @config = config.is_a?(Hash) ? EmailAddress::Config.new(config) : config
+      @config = config.is_a?(Hash) ? Config.new(config) : config
       @error = @error_message = nil
       parse(host_name)
     end
@@ -209,7 +209,7 @@ module EmailAddress
     def find_provider # :nodoc:
       return provider if provider
 
-      EmailAddress::Config.providers.each do |provider, config|
+      Config.providers.each do |provider, config|
         if config[:host_match] && matches?(config[:host_match])
           return set_provider(provider, config)
         end
@@ -233,7 +233,7 @@ module EmailAddress
     end
 
     def hosted_provider
-      EmailAddress::Exchanger.cached(dns_name).provider
+      Exchanger.cached(dns_name).provider
     end
 
     ############################################################################
@@ -338,11 +338,11 @@ module EmailAddress
       @_dns_a_record ||= []
     end
 
-    # Returns an array of EmailAddress::Exchanger hosts configured in DNS.
+    # Returns an array of Exchanger hosts configured in DNS.
     # The array will be empty if none are configured.
     def exchangers
       # return nil if @config[:host_type] != :email || !self.dns_enabled?
-      @_exchangers ||= EmailAddress::Exchanger.cached(dns_name, @config)
+      @_exchangers ||= Exchanger.cached(dns_name, @config)
     end
 
     # Returns a DNS TXT Record
@@ -497,7 +497,7 @@ module EmailAddress
     def set_error(err, reason = nil)
       @error = err
       @reason = reason
-      @error_message = EmailAddress::Config.error_message(err)
+      @error_message = Config.error_message(err)
       false
     end
 

data/lib/email_address/local.rb

@@ -107,7 +107,7 @@ module EmailAddress
       %r/^([\w\!\#\$\%\&\'\*\+\-\/\=\?\^\`\{\|\}\~]+)$/i.freeze
 
     def initialize(local, config={}, host=nil)
-      @config = config.is_a?(Hash) ? EmailAddress::Config.new(config) : config
+      @config = config.is_a?(Hash) ? Config.new(config) : config
       self.local    = local
       @host         = host
       @error        = @error_message = nil
@@ -388,7 +388,7 @@ module EmailAddress
     def set_error(err, reason=nil)
       @error = err
       @reason= reason
-      @error_message = EmailAddress::Config.error_message(err)
+      @error_message = Config.error_message(err)
       false
     end
 

data/lib/email_address/version.rb

@@ -1,3 +1,3 @@
 module EmailAddress
-  VERSION = "0.1.17"
+  VERSION = "0.1.18"
 end

data/test/test_aliasing.rb

@@ -0,0 +1,54 @@
+# encoding: UTF-8
+require_relative 'test_helper'
+
+class TestAliasing < MiniTest::Test
+  def setup
+    Object.send(:const_set, :EmailAddressValidator, EmailAddress)
+    Object.send(:remove_const, :EmailAddress)
+  end
+
+  def test_email_address_not_defined
+    assert_nil defined?(EmailAddress)
+    assert_nil defined?(EmailAddress::Address)
+    assert_nil defined?(EmailAddress::Config)
+    assert_nil defined?(EmailAddress::Exchanger)
+    assert_nil defined?(EmailAddress::Host)
+    assert_nil defined?(EmailAddress::Local)
+    assert_nil defined?(EmailAddress::Rewriter)
+  end
+
+  def test_alias_defined
+    assert_equal defined?(EmailAddressValidator), "constant"
+    assert_equal defined?(EmailAddressValidator::Address), "constant"
+    assert_equal defined?(EmailAddressValidator::Config), "constant"
+    assert_equal defined?(EmailAddressValidator::Exchanger), "constant"
+    assert_equal defined?(EmailAddressValidator::Host), "constant"
+    assert_equal defined?(EmailAddressValidator::Local), "constant"
+    assert_equal defined?(EmailAddressValidator::Rewriter), "constant"
+  end
+
+  def test_alias_class_methods
+    assert_equal true, EmailAddressValidator.valid?("user@yahoo.com")
+  end
+
+  def test_alias_host_methods
+    assert_equal true, EmailAddressValidator::Host.new("yahoo.com").valid?
+  end
+
+  def test_alias_address_methods
+    assert_equal true, EmailAddressValidator::Address.new("user@yahoo.com").valid?
+  end
+
+  def test_alias_config_methods
+    assert Hash, EmailAddressValidator::Config.new.to_h
+  end
+
+  def test_alias_local_methods
+    assert_equal true, EmailAddressValidator::Local.new("user").valid?
+  end
+
+  def teardown
+    Object.send(:const_set, :EmailAddress, EmailAddressValidator)
+    Object.send(:remove_const, :EmailAddressValidator)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: email_address
 version: !ruby/object:Gem::Version
-  version: 0.1.17
+  version: 0.1.18
 platform: ruby
 authors:
 - Allen Fair
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-05-10 00:00:00.000000000 Z
+date: 2020-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -162,13 +162,14 @@ files:
 - test/email_address/test_host.rb
 - test/email_address/test_local.rb
 - test/email_address/test_rewriter.rb
+- test/test_aliasing.rb
 - test/test_email_address.rb
 - test/test_helper.rb
 homepage: https://github.com/afair/email_address
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -184,7 +185,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.6
-signing_key: 
+signing_key:
 specification_version: 4
 summary: This gem provides a ruby language library for working with and validating
   email addresses. By default, it validates against conventional usage, the format
@@ -199,5 +200,6 @@ test_files:
 - test/email_address/test_host.rb
 - test/email_address/test_local.rb
 - test/email_address/test_rewriter.rb
+- test/test_aliasing.rb
 - test/test_email_address.rb
 - test/test_helper.rb