jekyll-autolink_email 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0019bccfada298555f99392c9d5b73f427d24b39
+  data.tar.gz: ee46f617ac3026408ed00f7441a67a2998c3b1f7
+SHA512:
+  metadata.gz: fc7a834e8b6b33651ea6e1074d2b1a7063b19e0cd23c5b7506085acbb53861fce848c920ab94b22c42efdb2e6ff3e45dfe71a97d4d3ae66da2ebcdc4c25ff419
+  data.tar.gz: 6da9fd6374a040d909f0e2e4189e677419e19dec975e5aa520f55ebb51c7899039f8d08b86137b027cf17651dd4f3b22beb83ae9e8a4768884f6d1ec02e55e51

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Ivan Tse
+
+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 @@
+# Jekyll::AutolinkEmail
+
+Autolink emails for your Jekyll Site.
+
+## Installation
+
+Add to your `Gemfile`:
+
+```
+gem 'jekyll-autolink_email'
+```
+
+Add to your `_config.yml`:
+
+```yml
+gems:
+  - jekyll-autolink_email
+```
+
+## Usage
+
+In any html page or post, emails will be autolinked. So if you write `foo@example.com`, the resulting html will be `<a href="mailto:foo@example.com">foo@example.com</a>`
+
+## Configuration
+
+Autolinking is done by [Rinku](https://github.com/vmg/rinku) so visit that gem for a more in-depth explanation of the configuration options:
+
+```yml
+autolink_email:
+  link_attr: class='email-link' # attributes to add to the link
+  skip_tags: ['div']            # tags to skip
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/jekyll-autolink/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

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/test_*.rb']
+  t.verbose = true
+end
+

data/jekyll-autolink_email.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$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.authors       = ["Ivan Tse"]
+  spec.email         = ["ivan.tse1@gmail.com"]
+  spec.summary       = "Autolink emails for your Jekyll site."
+  spec.description   = ""
+  spec.homepage      = "https://github.com/ivantsepp/jekyll-autolink_email"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "jekyll", '~> 2.0'
+  spec.add_dependency "rinku", '~> 1.7.0'
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "shoulda"
+  spec.add_development_dependency "mocha"
+end

data/lib/jekyll-autolink_email.rb

@@ -0,0 +1,33 @@
+require 'jekyll'
+require 'rinku'
+
+module Jekyll
+  class AutolinkEmail < Jekyll::Generator
+
+    safe true
+
+    def initialize(config)
+      config['autolink_email'] ||= {}
+    end
+
+    def generate(site)
+      @site = site
+      site.pages.each { |page| autolinkify page if page.html?}
+      site.posts.each { |page| autolinkify page }
+    end
+
+    private
+
+    def autolinkify(page)
+      page.content = Rinku.auto_link(page.content, :email_addresses, link_attr, skip_tags)
+    end
+
+    def link_attr
+      @link_attr ||= @site.config['autolink_email']['link_attr']
+    end
+
+    def skip_tags
+      @skip_tags ||= Array(@site.config['autolink_email']['skip_tags'])
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,5 @@
+require 'minitest/autorun'
+require 'minitest/unit'
+require 'shoulda'
+require 'mocha/mini_test'
+require 'jekyll-autolink_email'

data/test/test_autolink_email.rb

@@ -0,0 +1,52 @@
+require 'helper'
+
+class Jekyll::AutolinkEmailTest < Minitest::Test
+  context 'AutolinkEmail' do
+
+    setup do
+      @site = Jekyll::Site.new(Jekyll::Configuration::DEFAULTS)
+      @autolink_email = Jekyll::AutolinkEmail.new(@site.config)
+      @page = Jekyll::Page.new(@site, File.expand_path('../../', __FILE__), '', 'README.md')
+      @page.instance_variable_set(:@content, '<div>ivan.tse1@gmail.com</div>')
+      @site.pages << @page
+      @email_link = '<div><a href="mailto:ivan.tse1@gmail.com">ivan.tse1@gmail.com</a></div>'
+    end
+
+    should 'replace email with link' do
+      @autolink_email.instance_variable_set(:@site, @site)
+      @autolink_email.send(:autolinkify, @page)
+      assert_equal @email_link, @page.content
+    end
+
+    should 'replace page content on generate' do
+      @autolink_email.generate(@site)
+      assert_equal @email_link, @page.content
+    end
+
+    should 'replace page content on site#generate' do
+      @site.generators = Array(@autolink_email)
+      @site.generate
+      assert_equal @email_link, @page.content
+    end
+
+    should 'pull link_attr from config' do
+      @site.config['autolink_email']['link_attr'] = 'class="ivan"'
+      @autolink_email.generate(@site)
+      assert @page.content.include?('class="ivan"')
+    end
+
+    should 'pull skip_tags from config' do
+      @site.config['autolink_email']['skip_tags'] = 'div'
+      @autolink_email.generate(@site)
+      assert_equal '<div>ivan.tse1@gmail.com</div>', @page.content
+    end
+
+    should 'not replace email with link if page is not html' do
+      @page = Jekyll::Page.new(@site, File.expand_path('../../', __FILE__), '', 'LICENSE.txt')
+      @page.instance_variable_set(:@content, '<div>ivan.tse1@gmail.com</div>')
+      @site.pages << @page
+      @autolink_email.generate(@site)
+      assert_equal '<div>ivan.tse1@gmail.com</div>', @page.content
+    end
+  end
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-autolink_email
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ivan Tse
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rinku
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email:
+- ivan.tse1@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- jekyll-autolink_email.gemspec
+- lib/jekyll-autolink_email.rb
+- test/helper.rb
+- test/test_autolink_email.rb
+homepage: https://github.com/ivantsepp/jekyll-autolink_email
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Autolink emails for your Jekyll site.
+test_files:
+- test/helper.rb
+- test/test_autolink_email.rb