email_detector 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in email_detector.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Gabriel Gilder
+
+MIT License
+
+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,32 @@
+# EmailDetector
+
+A lightweight gem for detecting email addresses in text.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'email_detector'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install email_detector
+
+## Usage
+
+    emails = EmailDetector.new('You should invite joe@example.com and bob@example.com to the party!')
+    emails.to_s # => "joe@example.com, bob@example.com"
+    emails.map # => ["joe@example.com", "bob@example.com"]
+    emails.ignored # => ["You should invite", "and", "to the party!"]
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/email_detector.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/email_detector/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Gabriel Gilder"]
+  gem.email         = ["gabriel@gabrielgilder.com"]
+  gem.description   = %q{EmailDetector detects email addresses in an input string.}
+  gem.summary       = %q{EmailDetector detects email addresses in an input string.}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "email_detector"
+  gem.require_paths = ["lib"]
+  gem.version       = EmailDetector::VERSION
+  gem.add_development_dependency 'rspec', '~>2'
+  gem.add_development_dependency 'simplecov'
+end

data/lib/email_detector.rb

@@ -0,0 +1,8 @@
+require "email_detector/version"
+require "email_detector/detector"
+
+module EmailDetector
+  def self.new *args
+    Detector.new *args
+  end
+end

data/lib/email_detector/detector.rb

@@ -0,0 +1,38 @@
+require 'forwardable'
+
+module EmailDetector
+  class Detector
+    extend Forwardable
+    include Enumerable
+
+    attr_reader :emails, :ignored
+
+    # delegate to_a, each, empty? to the @list ivar
+    def_delegators :@list, :to_a, :each, :empty?
+    alias :to_s :emails
+
+    def initialize input
+      self.emails = input
+    end
+
+    def emails= input
+      @ignored = []
+      input ||= ''
+      input = input.join(', ') if input.is_a? Array
+
+      pattern = /(?<=\A|[<\s,])[A-Z0-9._%+-]+@[A-Z0-9.-]+\.[A-Z]{2,3}(?=[>,\s]|\Z)/i
+      @list = input.scan(pattern).map(&:downcase).uniq
+      @ignored = input.split(pattern).map {|e| e.gsub(/\A[,<>\s]+|[,<>\s]+\z/, '')}
+      @ignored.delete_if(&:empty?)
+      @emails = @list.join(", ")
+    end
+
+    def + other
+      self.class.new(to_a + other.to_a)
+    end
+
+    def == other
+      to_a == Array(other)
+    end
+  end
+end

data/lib/email_detector/version.rb

@@ -0,0 +1,3 @@
+module EmailDetector
+  VERSION = "0.0.1"
+end

data/spec/email_detector/detector_spec.rb

@@ -0,0 +1,130 @@
+require 'spec_helper'
+require 'email_detector'
+
+describe EmailDetector::Detector do
+  describe "given a blank string" do
+    before do
+      @it = EmailDetector::Detector.new("")
+    end
+  
+    it "is empty" do
+      @it.should be_empty
+    end
+  
+    it "stringifies to the empty string" do
+      @it.to_s.should eq("")
+    end
+    
+    it "arrayifies to the empty array" do
+      @it.to_a.should eq([])
+    end
+  end
+  
+  describe "given emails separated by commas" do
+    before do
+      @it = EmailDetector::Detector.new("test@example.com, bob@example.com, jim@example.com")
+    end
+    
+    it "is not empty" do
+      @it.should_not be_empty
+    end
+    
+    it "stringifies to a comma-separated list" do
+      @it.to_s.should eq("test@example.com, bob@example.com, jim@example.com")
+    end
+    
+    it "arrayifies to a list of strings" do
+      @it.to_a.should eq(%w[test@example.com bob@example.com jim@example.com])
+    end
+  end
+  
+  describe "given duplicate emails" do
+    before do
+      @it = EmailDetector::Detector.new("test@example.com, bob@example.com, Test <test@example.com>")
+    end
+    
+    it "eliminates duplicates" do
+      @it.to_a.should eq(%w[test@example.com bob@example.com])
+    end
+  end
+  
+  describe "given duplicate emails with different case" do
+    before do
+      @it = EmailDetector::Detector.new("Test Lowercase <test@example.com>, bob@example.com, Test Uppercase <TEST@example.com>")
+    end
+    
+    it "eliminates duplicates" do
+      @it.to_s.should eq("test@example.com, bob@example.com")
+    end
+  end
+  
+  describe "given nil" do
+    before do
+      @it = EmailDetector::Detector.new(nil)
+    end
+    
+    it "is empty" do
+      @it.should be_empty
+    end
+  end
+  
+  describe "given an email list with both comma-separated and space-separated addresses" do
+    before do
+      @it = EmailDetector::Detector.new("billy@example.com, joe@example.com bob@example.com")
+    end
+    
+    it "correctly identifies all the addresses" do
+      @it.to_a.should eq(%w[billy@example.com joe@example.com bob@example.com])
+    end
+  end
+  
+  describe "given an email list with extraneous information (names)" do
+    before do
+      @it = EmailDetector::Detector.new("Billy Example <billy@example.com>\nJoe Example <joe@example.com>, Bob Example bob@example.com\n\n\n")
+    end
+    
+    it "correctly identifies all the addresses" do
+      @it.to_a.should eq(%w[billy@example.com joe@example.com bob@example.com])
+    end
+
+    it "gives feedback about parts of the input that were ignored" do
+      @it.ignored.should_not be_empty
+    end
+    
+    it "should not include feedback about whitespace, delimiter characters, or empty strings" do
+      @it.ignored.should eq(['Billy Example', 'Joe Example', 'Bob Example'])
+    end
+  end
+  
+  describe "given a string with no valid email addresses" do
+    it "should return the entire string as a warning" do
+      @it = EmailDetector::Detector.new("punching your face")
+      @it.to_a.should eq([])
+      @it.ignored.should eq(["punching your face"])
+    end
+  end
+
+  describe "given two email addresses concatenated" do
+    it "marks the content as invalid" do
+      @it = EmailDetector::Detector.new("billy@example.co.ukjoe@example.com")
+      @it.to_a.should eq([])
+      @it.ignored.should eq(["billy@example.co.ukjoe@example.com"])
+    end
+  end
+  
+  describe "given two email addresses separated by a comma but no space" do
+    it "should correctly identify each address" do
+      @it = EmailDetector::Detector.new("billy@example.com,susie@example.com")
+      @it.to_a.should eq(%w[billy@example.com susie@example.com])
+      @it.ignored.should be_empty
+    end
+  end
+  
+  describe "#+" do
+    it "combines email lists into one" do
+      result = EmailDetector::Detector.new("test@example.com, bob@example.com") + EmailDetector::Detector.new("jim@example.com, test@example.com")
+      result.should eq(EmailDetector::Detector.new("test@example.com, bob@example.com, jim@example.com"))
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'simplecov'
+require 'rspec/autorun'
+
+$LOAD_PATH << File.expand_path('../lib', File.dirname(__FILE__))

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: email_detector
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Gabriel Gilder
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70198044614320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: *70198044614320
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &70198044613820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70198044613820
+description: EmailDetector detects email addresses in an input string.
+email:
+- gabriel@gabrielgilder.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- email_detector.gemspec
+- lib/email_detector.rb
+- lib/email_detector/detector.rb
+- lib/email_detector/version.rb
+- spec/email_detector/detector_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: EmailDetector detects email addresses in an input string.
+test_files:
+- spec/email_detector/detector_spec.rb
+- spec/spec_helper.rb