jekyll-email-protect 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 49aef42f85f248f6e7b00229d4c40fcd5f4fabb1
-  data.tar.gz: 7ba84f7328c3cf57aebf83a172c92309d684b657
+  metadata.gz: 1d273a3c3ef11a835e9c6c770f06f81c249f665f
+  data.tar.gz: 14cb77041dc95e53c7cf295b4490f0bf2c790a09
 SHA512:
-  metadata.gz: a204a430f683104401d26ff7f4edbbf0f5a216744123fe3c05fedc68b26de9aa1d7e0ea4ebf5b83f1d3e6d99ca1165978c317504d9b1bc49cdcecb7d9ab134d8
-  data.tar.gz: 3d4dcea9eba4e0ba44dc3b7e5e54c9db1d6c70bf74ee6513e14628967b89214df7e69a4312c4cf29cd0b5f9167e15da03e8faaf3e5b32fc322f34e8e1bfd54ef
+  metadata.gz: 0e8f95d5593a7e33e1394f18c984f7adaa7a6e86e124ed78394433aee209f0115618cbbdcd35f43ecc8a4ed000cd55492ba32c544de42265ed14f9f228833ef6
+  data.tar.gz: afa24eb781878a66dac1d1099007cb5620a36ecfad3fa933f7e6fed553cb02cd260298550ea467311fe7e24b6cb0379a31794cb0609eaf970710adf23f280c9e

data/README.md

@@ -34,7 +34,17 @@ gems:
 In your markup, simply use the `protect_email` liquid filter made available through this plugin:
 
 ```
-{{ 'example@example.com' | protect_email }}
+{{ 'example@example.com' | encode_email }}
+```
+
+The above code will yield `%65%78%61%6D%70%6C%65@%65%78%61%6D%70%6C%65.%63%6F%6D`. Only use this filter within the `href` attribute of a given link.
+
+## Example
+
+The following example shows how this plugin can be used to protect the `site`'s email address:
+
+```
+<a href="mailto:{{ site.email | protect_email }}" title="Contact me">Contact me</a>
 ```
 
 # Contribute

data/lib/jekyll-email-protect.rb

@@ -1,9 +1,17 @@
-require 'addressable/uri'
-
 module JekyllEmailProtect
   module EmailProtectionFilter
-    def protect_email(email)
-      Addressable::URI.encode_component(email, /[^\.@]/)
+
+    # Percent-encode alphanumeric characters of an email address
+    def encode_email(input)
+      input.to_s.chars.inject("") do |result, char|
+        if char =~ /\p{Alnum}/
+          char.bytes.inject(result) do |result, byte|
+            result << '%%%02X' % byte
+          end
+        else
+          result << char
+        end
+      end
     end
   end
 end

data/spec/protect_email_filter_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe(JekyllEmailProtect::EmailProtectionFilter) do
+  let(:output) do
+    doc = doc_with_content(content)
+    doc.content = content
+    doc.output  = Jekyll::Renderer.new(doc.site, doc).run
+  end
+
+  context "simple example address" do
+    let(:email) { "example@example.com" }
+    let(:content)  { "{{ '#{email}' | encode_email }}" }
+
+    it "produces the correct percent-encoded email" do
+      expect(output).to match(/%65%78%61%6D%70%6C%65@%65%78%61%6D%70%6C%65\.%63%6F%6D/)
+    end
+  end
+
+  context "example address with plus and dash" do
+    let(:email) { "example-person+spam@example.com" }
+    let(:content)  { "{{ '#{email}' | encode_email }}" }
+
+    it "produces the correct percent-encoded email" do
+      expect(output).to match(/%65%78%61%6D%70%6C%65\-%70%65%72%73%6F%6E\+%73%70%61%6D@%65%78%61%6D%70%6C%65\.%63%6F%6D/)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,42 @@
+TEST_DIR = File.dirname(__FILE__)
+TMP_DIR  = File.expand_path("../tmp", TEST_DIR)
+
+require 'jekyll'
+require File.expand_path("../lib/jekyll-email-protect.rb", TEST_DIR)
+Jekyll.logger.log_level = :error
+STDERR.reopen(test(?e, '/dev/null') ? '/dev/null' : 'NUL:')
+
+RSpec.configure do |config|
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.order = 'random'
+
+  def tmp_dir(*files)
+    File.join(TMP_DIR, *files)
+  end
+
+  def source_dir(*files)
+    tmp_dir('source', *files)
+  end
+
+  def dest_dir(*files)
+    tmp_dir('dest', *files)
+  end
+
+  def doc_with_content(content, opts = {})
+    my_site = site
+    Jekyll::Document.new(source_dir('_test/doc.md'), {site: my_site, collection: collection(my_site)})
+  end
+
+  def collection(site, label = 'test')
+    Jekyll::Collection.new(site, label)
+  end
+
+  def site(opts = {})
+    conf = Jekyll::Utils.deep_merge_hashes(Jekyll::Configuration::DEFAULTS, opts.merge({
+      "source"      => source_dir,
+      "destination" => dest_dir
+    }))
+    Jekyll::Site.new(conf)
+  end
+end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-email-protect
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Vincent Wochnik
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-20 00:00:00.000000000 Z
+date: 2015-11-22 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: addressable
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 2.3.8
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 2.3.8
 - !ruby/object:Gem::Dependency
   name: jekyll
   requirement: !ruby/object:Gem::Requirement
@@ -40,20 +26,6 @@ dependencies:
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -90,6 +62,8 @@ files:
 - lib/jekyll-email-protect.rb
 - README.md
 - LICENSE.md
+- spec/protect_email_filter_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/vwochnik/jekyll-email-protect
 licenses:
 - MIT
@@ -102,7 +76,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='
@@ -115,4 +89,6 @@ signing_key:
 specification_version: 4
 summary: This plugin provides a simple liquid filter which converts emails into percent-encoded
   strings.
-test_files: []
+test_files:
+- spec/protect_email_filter_spec.rb
+- spec/spec_helper.rb