jekyll-autolink_email 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0019bccfada298555f99392c9d5b73f427d24b39
-  data.tar.gz: ee46f617ac3026408ed00f7441a67a2998c3b1f7
+  metadata.gz: 5f9e63257e1769963049d9b057bb626bff07abce
+  data.tar.gz: 05aa71d54151a148ab8b007bd68d0dc516243010
 SHA512:
-  metadata.gz: fc7a834e8b6b33651ea6e1074d2b1a7063b19e0cd23c5b7506085acbb53861fce848c920ab94b22c42efdb2e6ff3e45dfe71a97d4d3ae66da2ebcdc4c25ff419
-  data.tar.gz: 6da9fd6374a040d909f0e2e4189e677419e19dec975e5aa520f55ebb51c7899039f8d08b86137b027cf17651dd4f3b22beb83ae9e8a4768884f6d1ec02e55e51
+  metadata.gz: e38b22b9d087b7cf6b17e56fdd4bf482a41c98b3249d8641b61f3c7d6921937142a00635266d5ec408f3c9e564a50cb329afb6a400aaa72c01d3983d5ee9d8a9
+  data.tar.gz: 36e72819a05ff183f8ce05837692fb5cbf1f9feaeb92e8946571d88d3073cf0e4a892a1453fdb0d44b693023fa19c4fa9e520e2dd92d18f386d3a80b8b7ed398

data/README.md

@@ -1,6 +1,6 @@
 # Jekyll::AutolinkEmail
 
-Autolink emails for your Jekyll Site.
+Autolink emails for your Jekyll site.
 
 ## Installation
 
@@ -31,10 +31,14 @@ autolink_email:
   skip_tags: ['div']            # tags to skip
 ```
 
+Jekyll::AutolinkEmail also provides a `escape: true` option. Turning this on will html encode the email address and url encode the link to prevent spam.
+
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/jekyll-autolink/fork )
+1. Fork it ( https://github.com/ivantsepp/jekyll-autolink_email/fork )
 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 a new Pull Request
+
+You should also check out [Jemoji](https://github.com/jekyll/jemoji) and [Jekyll Mentions](https://github.com/jekyll/jekyll-mentions) as those gems were the source of inspiration for this gem.

data/jekyll-autolink_email.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "jekyll-autolink_email"
-  spec.version       = "0.0.1"
+  spec.version       = "0.0.2"
   spec.authors       = ["Ivan Tse"]
   spec.email         = ["ivan.tse1@gmail.com"]
   spec.summary       = "Autolink emails for your Jekyll site."

data/lib/jekyll-autolink_email.rb

@@ -4,10 +4,18 @@ require 'rinku'
 module Jekyll
   class AutolinkEmail < Jekyll::Generator
 
+    HTML_ENTITIES = {
+      '@' => '&#064;',
+      '.' => '&#046;'
+    }
+
+    attr_accessor :email_addresses
+
     safe true
 
     def initialize(config)
       config['autolink_email'] ||= {}
+      self.email_addresses = []
     end
 
     def generate(site)
@@ -19,7 +27,34 @@ module Jekyll
     private
 
     def autolinkify(page)
-      page.content = Rinku.auto_link(page.content, :email_addresses, link_attr, skip_tags)
+      page.content = Rinku.auto_link(page.content, :email_addresses, link_attr, skip_tags) do |email_address|
+        if escape?
+          email_addresses << email_address.dup
+          html_encode(email_address)
+        else
+          email_address
+        end
+      end
+      url_encode_email_addresses(page.content) if escape?
+    end
+
+    def html_encode(email_address)
+      HTML_ENTITIES.each do |char, code|
+        email_address.gsub!(char, code)
+      end
+      email_address
+    end
+
+    # A hack since Rinku doesn't offer a hook into changing what the link is
+    def url_encode_email_addresses(content)
+      content.gsub!(/mailto:(#{email_addresses.join('|')})/) do |m|
+        m[$1] = ERB::Util.url_encode($1)
+        m
+      end
+    end
+
+    def escape?
+      @site.config['autolink_email']['escape']
     end
 
     def link_attr

data/test/test_autolink_email.rb

@@ -48,5 +48,13 @@ class Jekyll::AutolinkEmailTest < Minitest::Test
       @autolink_email.generate(@site)
       assert_equal '<div>ivan.tse1@gmail.com</div>', @page.content
     end
+
+    should 'escape email' do
+      @site.config['autolink_email']['escape'] = true
+      escaped_email_link = '<div><a href="mailto:ivan.tse1%40gmail.com">ivan&#046;tse1&#064;gmail&#046;com</a></div>'
+      @autolink_email.instance_variable_set(:@site, @site)
+      @autolink_email.send(:autolinkify, @page)
+      assert_equal escaped_email_link, @page.content
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-autolink_email
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Ivan Tse
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-12 00:00:00.000000000 Z
+date: 2014-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll