spamspanify 1.0.0

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/.rspec

@@ -0,0 +1,2 @@
+--colour
+--format nested

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Corné Verbruggen
+
+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,40 @@
+# Spamspanify
+
+Extends the String class with a {String#spamspanify} method that converts email
+addresses in the string into [SpamSpan](http://www.spamspan.com) HTML markup.
+This HTML markup can then easily be transformed in a clickable mailto link in
+the browser by using the SpanSpan javascript library.
+
+__Note:__ Currently only paranoia levels 1 and 3 are supported.
+See the [SpamSpan website](http://www.spamspan.com) for info on paranoia
+levels.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'spamspanify'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install spamspanify
+
+## Usage
+
+Simply call the {String#spamspanify} method on a string. 
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+Spamspanify is released under a MIT License 

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/spamspanify/core_ext/string.rb

@@ -0,0 +1,10 @@
+class String
+  # Converts plain email addresses and mailto links into SpamSpan markup.
+  #
+  # @param [Integer] paranoia_level SpamSpan paranoia level
+  # @return [String] the input with all plain email addresses converted to
+  #   SpamSpam markup
+  def spamspanify paranoia_level = 1
+    Spamspanify.all(self, paranoia_level)
+  end
+end

data/lib/spamspanify/exceptions.rb

@@ -0,0 +1,3 @@
+module Spamspanify
+  class ParanoiaLevelNotSupportedError < StandardError; end
+end

data/lib/spamspanify/version.rb

@@ -0,0 +1,3 @@
+module Spamspanify
+  VERSION = "1.0.0"
+end

data/lib/spamspanify.rb

@@ -0,0 +1,74 @@
+require "spamspanify/version"
+require "spamspanify/core_ext/string"
+require "spamspanify/exceptions"
+
+module Spamspanify
+  EMAIL_REGEXP = /([\w|\-\.])+@([\w|\-\.])+\w+/
+  MAILTO_REGEXP = /<a\s*href=(\'|\")mailto:#{ EMAIL_REGEXP }(\'|\").*<\/a>/
+
+  module_function
+
+  # Converts plain email addresses and mailto links in the input into SpamSpan
+  # markup.
+  #
+  # @param [String] input
+  # @param [Integer] paranoia_level SpamSpan paranoia level
+  # @return [String] the input with all plain email addresses converted to
+  #   SpamSpam markup
+  def all input, paranoia_level = 1
+    plain_email_addresses(mailto_links(input, paranoia_level), paranoia_level)
+  end
+
+  # Converts all plain email addresses in the input into SpamSpan markup.
+  #
+  # @param [String] input
+  # @param [Integer] paranoia_level SpamSpan paranoia level
+  # @return [String] the input with all plain email addresses converted to
+  #   SpamSpam markup
+  def plain_email_addresses input, paranoia_level = 1
+    input.gsub(EMAIL_REGEXP) do |email|
+      create_markup(email, paranoia_level)
+    end
+  end
+
+  # Converts all HTML mailto links in the input into SpamSpan markup.
+  #
+  # @param [String] input
+  # @param [Integer] paranoia_level SpamSpan paranoia level
+  # @return [String] the input with all plain email addresses converted to
+  #   SpamSpam markup
+  def mailto_links input, paranoia_level = 1
+    input.gsub(MAILTO_REGEXP) do |mailto|
+      create_markup(mailto[EMAIL_REGEXP], paranoia_level)
+    end
+  end
+
+  # Creates SpanSpam HTML markup.
+  #
+  # @param [String] email_address
+  # @param [Integer] paranoia_level
+  # @return [String] SpamSpan HTML markup
+  # @raise [Spamspanify::ParanoiaLevelNotSupportedError] when a not supported
+  #   paranoia level is requested
+  def create_markup email_address, paranoia_level = 1
+    user, domain = email_address.split("@")
+    case paranoia_level
+    when 1
+      "<span class='spamspan'><span class='u'>#{ user }</span>@<span class='d'>"\
+        "#{ domain }</span></span>"
+    when 3
+      "<span class='spamspan'><span class='u'>#{ undotify(user) }</span> [at] "\
+        "<span class='d'>#{ undotify(domain) }</span></span>"
+    else
+      Raise ParanoiaLevelNotSupportError
+    end
+  end
+
+  # Converts every "." in a string into " [dot] "
+  #
+  # @param [String] input
+  # @return [String] the input with each dot replaced by " [dot] "
+  def undotify input
+    input.gsub ".", " [dot] "
+  end
+end

data/spamspanify.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'spamspanify/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "spamspanify"
+  gem.version       = Spamspanify::VERSION
+  gem.authors       = ["Corné Verbruggen"]
+  gem.email         = ["corne@g-majeur.nl"]
+  gem.description   = %q{
+    Spamspanify extends the String class with a spamspanify method that
+    replaces all email addresses in a string with HTML markup that can be
+    handled by the SpamSpan javascript library.
+  }
+  gem.summary       = "Transforms email addresses in a string into SpamSpam markup"
+  gem.homepage      = "https://github.com/g-majeur/spamspanify"
+
+  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.require_paths = ["lib"]
+
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "rspec", "~> 2.12"
+  gem.add_development_dependency "yard", "~> 0.8.3"
+end

data/spec/spamspanify_spec.rb

@@ -0,0 +1,27 @@
+require "spec_helper"
+
+describe Spamspanify do
+
+  describe "replaces an email address in a string with SpamSpan markup" do
+    let(:s){ "Email b.flat@minor.com please." }
+
+    it "of paranoia level 1" do
+      expect(s.spamspanify(1)).to eq "Email <span class='spamspan'><span class='u'>b.flat</span>@<span class='d'>minor.com</span></span> please."
+    end
+
+    it "of paranoia level 3" do
+      expect(s.spamspanify(3)).to eq "Email <span class='spamspan'><span class='u'>b [dot] flat</span> [at] <span class='d'>minor [dot] com</span></span> please."
+    end
+  end
+
+  it "does not include a dot as the last character of an address" do
+    s = "Email major.seven@a-flat.com."
+    expect(s.spamspanify).to eq "Email <span class='spamspan'><span class="\
+      "'u'>major.seven</span>@<span class='d'>a-flat.com</span></span>."
+  end
+
+  it "should transform html <a href='mailto:..> links as well", focus: true do
+    s = "Email <a href='mailto:b.flat@minor.com'>B.Flat</a> please."
+    expect(s.spamspanify(1)).to eq "Email <span class='spamspan'><span class='u'>b.flat</span>@<span class='d'>minor.com</span></span> please."
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require "rspec"
+require "spamspanify"
+
+RSpec.configure do |config|
+
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: spamspanify
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Corné Verbruggen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.12'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.3
+description: ! "\n    Spamspanify extends the String class with a spamspanify method
+  that\n    replaces all email addresses in a string with HTML markup that can be\n
+  \   handled by the SpamSpan javascript library.\n  "
+email:
+- corne@g-majeur.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/spamspanify.rb
+- lib/spamspanify/core_ext/string.rb
+- lib/spamspanify/exceptions.rb
+- lib/spamspanify/version.rb
+- spamspanify.gemspec
+- spec/spamspanify_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/g-majeur/spamspanify
+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.24
+signing_key: 
+specification_version: 3
+summary: Transforms email addresses in a string into SpamSpam markup
+test_files:
+- spec/spamspanify_spec.rb
+- spec/spec_helper.rb
+has_rdoc: