ruby_email 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cb0c82b4013b33854d71d9f434b3b2c74ec633a5
-  data.tar.gz: 515ce7795e8f86984d09651a2adbaa8f0f44a38d
+  metadata.gz: 992dcd485d48991c1e09827fefd0f396ba93099c
+  data.tar.gz: f4c6e74256ad4f147bc32a4b99221424f85bb8b2
 SHA512:
-  metadata.gz: 5c8c48fc64c5eb10fcb2e4d312ff78e159774c4fe03c77c042cb490b4ccdd548a04dae0763d83b7dd2756ad82a0d0d68dbd9ae444a03a81579ba8432a21c3ec3
-  data.tar.gz: aae07e1346703f0b7ae00031c52bc706ad845e2889a46525a095a27f7d454b9106cc5669d2c6a5c384b0eb1765d740623b2e6133441838a1b17bcf924d76638e
+  metadata.gz: d75c0b231723e17f9eeec5c34b8fb898f29c88c2b3a84ad72da406e2c426c7ce2d40ae1863bfd14485a49435d99e3e2dcbb0f17f2d594859c326bbd08a65cd9a
+  data.tar.gz: 0477f20e580eb1165a69bcc89b31c203e1fe564faadc2f60be644eb72316ea0e435b9dee5474163285c54020d89d578f765e0e963eb0291cbb70fb6f04d0da63

data/CHANGELOG

@@ -1,3 +1,13 @@
+v0.1.6
+  * Break compatibility (100%)
+  * Improve architecture
+    * Rfc5322 designed as it
+    * Rfc5322 and Rfc5322::Public are now Classes (instead of modules)
+    * Core is now an Abstract, completed by adding the REGEXP constant in it's
+      children
+  * Update unitary tests
+  * Add some documentation
+
 v0.1.5
   * Split into files each feature (core, public, f/string)
 

data/README.md

@@ -1,6 +1,10 @@
 # A RFC compliant Email validator
 
-Compliant to the [rfc 5322](http://www.ietf.org/rfc/rfc5322.txt) standard.
+What is an [email address](https://en.wikipedia.org/wiki/Email_address) ?
+
+- Compliant to the [rfc 5322](https://tools.ietf.org/html/rfc5322) standard.
+- To do [rfc 6530](https://tools.ietf.org/html/rfc6530).
+
 
 ## Installation
 
@@ -20,17 +24,26 @@ gem 'ruby_email'
 ```ruby
 require 'ruby_email'
 
+# Pure Rfc5322
+RubyEmail::Rfc322.validates? "toto@tata" # => true
+RubyEmail::Rfc322.match "toto@tata" # => #<MatchData "toto@tata" local:"toto" domain:"tata">
+RubyEmail::Rfc322.validates? "toto" # => false
+RubyEmail::Rfc322.match "toto" # => nil
+
+# Rfc5322 + Internet basic usage
+RubyEmail::Rfc322::Public.validates? "toto@tata.com" # => true
+RubyEmail::Rfc322::Public.match "toto@tata.com" # => #<MatchData "toto@tata" local:"toto" domain:"tata.com">
+
+# Rfc5322 Strings
+require 'ruby_email/rfc5322/string'
 "local@domain".is_email? # => true
-RubyEmail.validates? "toto@tata" # => true
-RubyEmail.match "toto@tata" # => #<MatchData "toto@tata" local:"toto" domain:"tata">
 "local".is_email? # => false
-RubyEmail.validates? "toto" # => false
-RubyEmail.match "toto" # => nil
 
+# Rfc5322 Strings + Internet basic usage
+require 'ruby_email/rfc5322/public/string'
 "local@domain.root".is_public_email? # => true
 "local@domain".is_public_email? # => false
-RubyEmail::Public.validates? "toto@tata.com" # => true
-RubyEmail::Public.match "toto@tata.com" # => #<MatchData "toto@tata" local:"toto" domain:"tata.com">
+
 ```
 
 
@@ -38,8 +51,8 @@ RubyEmail::Public.match "toto@tata.com" # => #<MatchData "toto@tata" local:"toto
 
 ```ruby
 class Model < ActiveRecord::Base
-  # validates :email, format: RubyEmail::REGEXP # valid on an intranet ...
-  validates :email, format: RubyEmail::Public::REGEXP
+  # validates :email, format: RubyEmail::Rfc322::REGEXP # valid on an intranet ...
+  validates :email, format: RubyEmail::Rfc322::Public::REGEXP
 end
 ```
 

data/lib/ruby_email/core.rb

@@ -1,37 +1,28 @@
-# http://www.ietf.org/rfc/rfc5322.txt
 module RubyEmail
-  # one valid character (not . because used to separe domains)
-  ATEXT = '([A-Za-z0-9!#\$%&\'*\+\-/=\?\^_`\{\}\|~])'
-  ATOM = "#{ATEXT}+"
-  DOT_ATOM_TEXT = "(#{ATOM})(\\.#{ATOM})*"
-  # email grammar
-  VALIDE = "(?<local>#{DOT_ATOM_TEXT})@(?<domain>#{DOT_ATOM_TEXT})"
-  # regexp to validate complete email
-  REGEXP = Regexp.new "\\A#{VALIDE}\\Z"
 
-  # Check if the {::String} is a valid email
-  # @param str [::String] string to match
-  # @raise [ArgumentError] if str is not a String
-  # @return [TrueClass or FalseClass]
-  def self.validates? str
-    !!match(str)
-  end
+  # Abstract class to inherit and complete by adding the REGEXP constant
+  class Core
+    # Check if the {::String} is a valid email.
+    # @param str [::String] string to match
+    # @raise [ArgumentError] if str is not a String
+    # @return [TrueClass or FalseClass]
+    def self.validates? str
+      !!match(str)
+    end
 
-  # Check if the string is a valid email and details how
-  # @param str [::String] string to match
-  # @raise [ArgumentError] if str is not a String
-  # @return [MatchData or NilClass] matched email with the keys "local" and "domain"
-  def self.match str
-    raise ArgumentError, "Cannot validate a `#{str.class}`. Only `String` can be." unless str.is_a?(String)
-    str.match(REGEXP)
-  end
+    # Check if the string is a valid email and details how
+    # @param str [::String] string to match
+    # @raise [ArgumentError] if str is not a String
+    # @return [MatchData or NilClass] matched email with the keys "local" and "domain"
+    def self.match str
+      raise ArgumentError, "Cannot validate a `#{str.class}`. Only `String` can be." unless str.is_a?(String)
+      str.match regexp
+    end
 
-  # included by {::String}
-  module String
-    # Check if the current [::String] instance is a valid email
-    # @return [TrueClass or FalseClass]
-    def is_email?
-      RubyEmail.validates? self
+    # @return [Regexp] constant to erase in the children
+    def self.regexp
+      self::REGEXP
+      #raise NoMethodError, "Not implemented in #{self.class}"
     end
 
   end

data/lib/ruby_email/{public → rfc5322/public}/string.rb

@@ -1,5 +1,5 @@
 require_relative '../public'
 
 class String
-  include RubyEmail::Public::String
+  include RubyEmail::Rfc5322::Public::String
 end

data/lib/ruby_email/rfc5322/public.rb

@@ -0,0 +1,21 @@
+require_relative '../rfc5322'
+
+module RubyEmail
+  class Rfc5322
+
+    # Internet realist version of {Rfc5322}. It requires a root domain.
+    class Public < Rfc5322
+      VALIDE = "(?<local>#{DOT_ATOM_TEXT})@(?<domain>#{DOT_ATOM_TEXT}\\.#{DOT_ATOM_TEXT})"
+      REGEXP = Regexp.new "\\A#{VALIDE}\\Z"
+
+      module String
+        # Check if the current [::String] instance is a valid email
+        # @return [TrueClass or FalseClass]
+        def is_public_email?
+          RubyEmail::Rfc5322::Public.validates? self
+        end
+      end
+    end
+
+  end
+end

data/lib/ruby_email/rfc5322/string.rb

@@ -0,0 +1,5 @@
+require_relative '../rfc5322'
+
+class String
+  include RubyEmail::Rfc5322::String
+end

data/lib/ruby_email/rfc5322.rb

@@ -0,0 +1,28 @@
+require_relative 'core'
+
+module RubyEmail
+
+  # http://www.ietf.org/rfc/rfc5322.txt
+  # The Rfc5322 designe an email with the format local@domain, wher local and
+  # domain are a string of US-ASCII characters, without some symboles.
+  class Rfc5322 < Core
+    # one valid character (not . because used to separe domains)
+    ATEXT = '([A-Za-z0-9!#\$%&\'*\+\-/=\?\^_`\{\}\|~])'
+    # a valid string
+    ATOM = "#{ATEXT}+"
+    # a valid string with subdomains, separated by dots
+    DOT_ATOM_TEXT = "(#{ATOM})(\\.#{ATOM})*"
+    # email grammar
+    VALIDE = "(?<local>#{DOT_ATOM_TEXT})@(?<domain>#{DOT_ATOM_TEXT})"
+    # regexp to validate complete email
+    REGEXP = Regexp.new "\\A#{VALIDE}\\Z"
+    module String
+      # Check if the current [::String] instance is a valid email
+      # @return [TrueClass or FalseClass]
+      def is_email?
+        RubyEmail::Rfc5322.validates? self
+      end
+    end
+  end
+
+end

data/lib/ruby_email.rb

@@ -1,5 +1,8 @@
 require_relative 'ruby_email/core'
-require_relative 'ruby_email/core/string'
 
-require_relative 'ruby_email/public'
-require_relative 'ruby_email/public/string'
+require_relative 'ruby_email/rfc5322'
+
+require_relative 'ruby_email/rfc5322/public'
+
+#require_relative 'ruby_email/rfc5322/string'
+#require_relative 'ruby_email/rfc5322/public/string'

data/ruby_email.gemspec

@@ -9,9 +9,10 @@ Gem::Specification.new do |s|
   s.files       = %w(
 lib/ruby_email.rb
 lib/ruby_email/core.rb
-lib/ruby_email/core/string.rb
-lib/ruby_email/public.rb
-lib/ruby_email/public/string.rb
+lib/ruby_email/rfc5322.rb
+lib/ruby_email/rfc5322/string.rb
+lib/ruby_email/rfc5322/public.rb
+lib/ruby_email/rfc5322/public/string.rb
 
 README.md
 CHANGELOG

data/test/unit_test.rb

@@ -7,65 +7,72 @@ require_relative '../lib/ruby_email'
 class TestRubyEmail < Test::Unit::TestCase
 
   def test_simple_true
-    assert RubyEmail.validates?("toto@toto")
-    assert RubyEmail.validates?("toto@toto.toto")
-    assert RubyEmail.validates?("toto@toto.toto.toto")
-    assert RubyEmail.validates?("toto@toto.toto.toto.toto")
+    assert RubyEmail::Rfc5322.validates?("toto@toto")
+    assert RubyEmail::Rfc5322.validates?("toto@toto.toto")
+    assert RubyEmail::Rfc5322.validates?("toto@toto.toto.toto")
+    assert RubyEmail::Rfc5322.validates?("toto@toto.toto.toto.toto")
   end
 
   def test_simple_false
-    assert !RubyEmail.validates?("t")
-    assert !RubyEmail.validates?("t@")
-    assert !RubyEmail.validates?("@t")
+    assert !RubyEmail::Rfc5322.validates?("t")
+    assert !RubyEmail::Rfc5322.validates?("t@")
+    assert !RubyEmail::Rfc5322.validates?("@t")
   end
 
   def test_plus_true
-    assert RubyEmail.validates?("i'am%toto@here")
-    assert RubyEmail.validates?("ich-bin-toto@___")
-    assert RubyEmail.validates?("arthur+spam@mail.com")
+    assert RubyEmail::Rfc5322.validates?("i'am%toto@here")
+    assert RubyEmail::Rfc5322.validates?("ich-bin-toto@___")
+    assert RubyEmail::Rfc5322.validates?("arthur+spam@mail.com")
   end
 
   def test_plus_false
-    assert !RubyEmail.validates?("i have @ some things")
-    assert !RubyEmail.validates?("toto;toto@toto;toto")
-    assert !RubyEmail.validates?("toto,toto@toto,toto")
-    assert !RubyEmail.validates?("toto()toto@toto()toto")
-    assert !RubyEmail.validates?("toto[]toto@toto[]toto")
-    assert !RubyEmail.validates?("toto:toto@toto:toto")
-    assert !RubyEmail.validates?("toto<>toto@toto<>toto")
-    assert !RubyEmail.validates?("toto\\toto@toto\\toto")
-    assert !RubyEmail.validates?("toto\"toto@toto\"toto")
+    assert !RubyEmail::Rfc5322.validates?("i have @ some things")
+    assert !RubyEmail::Rfc5322.validates?("toto;toto@toto;toto")
+    assert !RubyEmail::Rfc5322.validates?("toto,toto@toto,toto")
+    assert !RubyEmail::Rfc5322.validates?("toto()toto@toto()toto")
+    assert !RubyEmail::Rfc5322.validates?("toto[]toto@toto[]toto")
+    assert !RubyEmail::Rfc5322.validates?("toto:toto@toto:toto")
+    assert !RubyEmail::Rfc5322.validates?("toto<>toto@toto<>toto")
+    assert !RubyEmail::Rfc5322.validates?("toto\\toto@toto\\toto")
+    assert !RubyEmail::Rfc5322.validates?("toto\"toto@toto\"toto")
   end
 
   def test_match
-    m = RubyEmail.match "toto@toto.toto.toto.toto"
+    m = RubyEmail::Rfc5322.match "toto@toto.toto.toto.toto"
     assert m.names & %w(local domain)
     assert_equal "toto", m["local"]
     assert_equal "toto.toto.toto.toto", m["domain"]
   end
 
   def test_string
-    assert !"toto".is_email?
+    assert_raise { "toto@toto".is_email? }
+    require_relative '../lib/ruby_email/rfc5322/string'
     assert "toto@toto".is_email?
+    assert !"toto".is_email?
   end
 
   def test_exceptions
-    assert_raise { RubyEmail.match 1 }
-    assert_raise { RubyEmail.validates? 1.0 }
-    assert_raise { RubyEmail.validates? /toto/ }
-    assert_raise { RubyEmail.validates? :ok }
-    assert_raise { RubyEmail.validates? Class }
+    assert_raise { RubyEmail::Rfc5322.match 1 }
+    assert_raise { RubyEmail::Rfc5322.validates? 1.0 }
+    assert_raise { RubyEmail::Rfc5322.validates? /toto/ }
+    assert_raise { RubyEmail::Rfc5322.validates? :ok }
+    assert_raise { RubyEmail::Rfc5322.validates? Class }
   end
 
 end
 
 class TestRubyEmailPublic < Test::Unit::TestCase
   def test_simpe
-    assert RubyEmail::Public.validates?("toto@toto.toto")
-    assert RubyEmail::Public.validates?("toto@toto.toto.toto")
-    assert RubyEmail::Public.validates?("toto@toto.toto.toto.toto")
-    assert !RubyEmail::Public.validates?("toto@toto")
-    assert RubyEmail::Public.match("toto@toto.toto")
+    assert RubyEmail::Rfc5322::Public.validates?("toto@toto.toto")
+    assert RubyEmail::Rfc5322::Public.validates?("toto@toto.toto.toto")
+    assert RubyEmail::Rfc5322::Public.validates?("toto@toto.toto.toto.toto")
+    assert !RubyEmail::Rfc5322::Public.validates?("toto@toto")
+    assert RubyEmail::Rfc5322::Public.match("toto@toto.toto")
+  end
+
+  def test_string
+    assert_raise { "toto@toto.toto".is_public_email? }
+    require_relative '../lib/ruby_email/rfc5322/public/string'
     assert "toto@toto.toto".is_public_email?
     assert !"toto@toto".is_public_email?
   end

data/version

@@ -1 +1 @@
-0.1.5
+0.1.6

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby_email
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Nephos (poulet_a)
@@ -61,9 +61,10 @@ files:
 - Rakefile
 - lib/ruby_email.rb
 - lib/ruby_email/core.rb
-- lib/ruby_email/core/string.rb
-- lib/ruby_email/public.rb
-- lib/ruby_email/public/string.rb
+- lib/ruby_email/rfc5322.rb
+- lib/ruby_email/rfc5322/public.rb
+- lib/ruby_email/rfc5322/public/string.rb
+- lib/ruby_email/rfc5322/string.rb
 - ruby_email.gemspec
 - test/unit_test.rb
 - version

data/lib/ruby_email/core/string.rb

@@ -1,5 +0,0 @@
-require_relative '../core'
-
-class String
-  include RubyEmail::String
-end

data/lib/ruby_email/public.rb

@@ -1,43 +0,0 @@
-require_relative 'core'
-
-# http://www.ietf.org/rfc/rfc5322.txt
-module RubyEmail
-
-  # Only valid on the public internet. "toto@toto" is not valid, but "toto@toto.toto" is good
-  module Public
-    # one valid character (not . because used to separe domains)
-    ATEXT = '([A-Za-z0-9!#\$%&\'*\+\-/=\?\^_`\{\}\|~])'
-    ATOM = "#{ATEXT}+"
-    DOT_ATOM_TEXT = "(#{ATOM})(\\.#{ATOM})*"
-    VALIDE = "(?<local>#{DOT_ATOM_TEXT})@(?<domain>#{DOT_ATOM_TEXT}\\.#{DOT_ATOM_TEXT})"
-    REGEXP = Regexp.new "\\A#{VALIDE}\\Z"
-
-    # Check if the {::String} is a valid email on internet
-    # @param str [::String] string to match
-    # @raise [ArgumentError] if str is not a String
-    # @return [TrueClass or FalseClass]
-    def self.validates? str
-      !!match(str)
-    end
-
-    # Check if the string is a valid email on internet and details how
-    # @param str [::String] string to match
-    # @raise [ArgumentError] if str is not a String
-    # @return [MatchData or NilClass] matched email with the keys "local" and "domain"
-    def self.match str
-      raise ArgumentError, "Cannot validate a `#{str.class}`. Only `String` can be." unless str.is_a?(String)
-      str.match(REGEXP)
-    end
-
-    # included by {::String}
-    module String
-      # Check if the current [::String] instance is a valid email on internet
-      # @return [TrueClass or FalseClass]
-      def is_public_email?
-        RubyEmail::Public.validates? self
-      end
-    end
-
-  end
-
-end