jekyll-autolinks 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1efbf4080e17ee8c6baacd375198514960375306d00ae5db4a690fe6e39afbbc
+  data.tar.gz: 6f5b547545094a894e4e57950e0dc709d2b1d4ce5d58ab8e771448920d7ec96a
+SHA512:
+  metadata.gz: 590a2c2236f07c1f548092fdd1bdaa15e9323a6fd6e00b721746ecfdb8d6d7a54e3dfee17ca12af57a3aa40be69b66cd01e75217f95e465b038957234139ed47
+  data.tar.gz: 50dd8ed83ec0b59cfc5cdbcafe390daa88465af649e0f4c03cdecaa8ba27aace434b8ecbf7fafd713cca73b002c364c6ec0384ba3849e6d2bbf7b1d75115ae9c

data/.gitignore

@@ -0,0 +1,114 @@
+# Created by https://www.toptal.com/developers/gitignore/api/ruby,macos,vim
+# Edit at https://www.toptal.com/developers/gitignore?templates=ruby,macos,vim
+
+### macOS ###
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+### macOS Patch ###
+# iCloud generated files
+*.icloud
+
+### Ruby ###
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*
+
+### Vim ###
+# Swap
+[._]*.s[a-v][a-z]
+!*.svg  # comment out if you don't need vector files
+[._]*.sw[a-p]
+[._]s[a-rt-v][a-z]
+[._]ss[a-gi-z]
+[._]sw[a-p]
+
+# Session
+Session.vim
+Sessionx.vim
+
+# Temporary
+.netrwhist
+*~
+# Auto-generated tag files
+tags
+# Persistent undo
+[._]*.un~
+
+# End of https://www.toptal.com/developers/gitignore/api/ruby,macos,vim

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,100 @@
+PATH
+  remote: .
+  specs:
+    jekyll-autolinks (0.1.0)
+      jekyll (>= 3.9.3)
+      rinku (~> 2.0.6)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (7.0.5)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    addressable (2.8.4)
+      public_suffix (>= 2.0.2, < 6.0)
+    colorator (1.1.0)
+    concurrent-ruby (1.2.2)
+    em-websocket (0.5.3)
+      eventmachine (>= 0.12.9)
+      http_parser.rb (~> 0)
+    eventmachine (1.2.7)
+    ffi (1.15.5)
+    forwardable-extended (2.6.0)
+    google-protobuf (3.23.3-arm64-darwin)
+    http_parser.rb (0.8.0)
+    i18n (1.14.1)
+      concurrent-ruby (~> 1.0)
+    jekyll (4.3.2)
+      addressable (~> 2.4)
+      colorator (~> 1.0)
+      em-websocket (~> 0.5)
+      i18n (~> 1.0)
+      jekyll-sass-converter (>= 2.0, < 4.0)
+      jekyll-watch (~> 2.0)
+      kramdown (~> 2.3, >= 2.3.1)
+      kramdown-parser-gfm (~> 1.0)
+      liquid (~> 4.0)
+      mercenary (>= 0.3.6, < 0.5)
+      pathutil (~> 0.9)
+      rouge (>= 3.0, < 5.0)
+      safe_yaml (~> 1.0)
+      terminal-table (>= 1.8, < 4.0)
+      webrick (~> 1.7)
+    jekyll-sass-converter (3.0.0)
+      sass-embedded (~> 1.54)
+    jekyll-watch (2.2.1)
+      listen (~> 3.0)
+    kramdown (2.4.0)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    liquid (4.0.4)
+    listen (3.8.0)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    mercenary (0.4.0)
+    minitest (5.18.1)
+    mocha (2.0.4)
+      ruby2_keywords (>= 0.0.5)
+    pathutil (0.16.2)
+      forwardable-extended (~> 2.6)
+    public_suffix (5.0.1)
+    rake (13.0.6)
+    rb-fsevent (0.11.2)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rexml (3.2.5)
+    rinku (2.0.6)
+    rouge (4.1.2)
+    ruby2_keywords (0.0.5)
+    safe_yaml (1.0.5)
+    sass-embedded (1.63.6-arm64-darwin)
+      google-protobuf (~> 3.23)
+    shoulda (4.0.0)
+      shoulda-context (~> 2.0)
+      shoulda-matchers (~> 4.0)
+    shoulda-context (2.0.0)
+    shoulda-matchers (4.5.1)
+      activesupport (>= 4.2.0)
+    terminal-table (3.0.2)
+      unicode-display_width (>= 1.1.1, < 3)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.4.2)
+    webrick (1.8.1)
+
+PLATFORMS
+  arm64-darwin-22
+
+DEPENDENCIES
+  bundler
+  jekyll-autolinks!
+  mocha
+  rake
+  shoulda
+
+BUNDLED WITH
+   2.4.10

data/LICENSE

@@ -0,0 +1,12 @@
+Copyright (c) 2023 ADoyle (adoyle.h@gmail.com)
+Some rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/Makefile

@@ -0,0 +1,25 @@
+.PHONY: test
+test:
+	bundle exec rake test
+
+.PHONY: install
+install: init vendor/bundle
+
+.PHONY: init
+init:
+	bundle config set --local path 'vendor/bundle'
+
+.PHONY: build
+build:
+	bundle exec rake build
+
+.PHONY: release
+release:
+	bundle exec rake release
+
+.PHONY: clean
+clean:
+	rm -rf vendor
+
+vendor/bundle:
+	bundle install

data/README.md

@@ -0,0 +1,65 @@
+# Jekyll::Autolinks
+
+Automatically create `<a>` DOMs from standard URLs for your Jekyll site.
+
+In any html page or post, standard URLs and emails will be autolinked.
+
+- `https://github.com/` => `<a href="https://github.com/">https://github.com/</a>`.
+- `hi@gmail.com` => `<a href="mailto:hi@gmail.com">hi@gmail.com</a>`.
+
+Modified based on [ivantsepp/jekyll-autolink_email](https://github.com/ivantsepp/jekyll-autolink_email).
+
+## Installation
+
+1. Add to your `Gemfile`:
+
+    ```
+    gem 'jekyll-autolinks'
+    ```
+
+2. Add to your `_config.yml`:
+
+    ```yml
+    gems:
+      - jekyll-autolinks
+    ```
+
+## Usage
+
+## 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: 'target="_blank"'
+  skip_tags: ["a", "pre", "code", "kbd", "script"]
+```
+
+- `link_attr` is a string containing the link attributes for each link that will be generated. These attributes are not sanitized and will be include as-is in each generated link, e.g.
+
+    ```
+    link_attr: 'target="_blank" class="my-link"'
+# hi.com => '<a href="http://hi.com" target="_blank" class="my-link">hi.com</a>'
+    ```
+
+- `skip_tags` is a list of strings with the names of HTML tags that will be skipped when autolinking. If nil, this defaults to the value of the global Rinku.skip_tags, which is initially `["a", "pre", "code", "kbd", "script"]`.
+
+## Suggestion, Bug Reporting, Contributing
+
+**Before opening new Issue/Discussion/PR and posting any comments**, please read [Contributing Guidelines](https://gcg.adoyle.me/CONTRIBUTING).
+
+## Copyright and License
+
+Copyright 2023 ADoyle (adoyle.h@gmail.com). Some Rights Reserved.
+The project is licensed under the **BSD 3-clause License**.
+
+Read the [LICENSE][] file for the specific language governing permissions and limitations under the License.
+
+Read the [NOTICE][] file distributed with this work for additional information regarding copyright ownership.
+
+
+<!-- links -->
+
+[LICENSE]: ./LICENSE
+[NOTICE]: ./NOTICE

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-autolinks.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-autolinks"
+  spec.version       = "0.1.0"
+  spec.authors       = ["ADoyle"]
+  spec.email         = ["adoyle.h@gmail.com"]
+  spec.summary       = "Autolink for your Jekyll site."
+  spec.description   = "Automatically create <a> DOMs from standard URLs."
+  spec.homepage      = "https://github.com/adoyle-h/jekyll-autolinks"
+  spec.license       = "BSD-3-Clause"
+
+  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", '>= 3.9.3'
+  spec.add_dependency "rinku", '~> 2.0.6'
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "shoulda"
+  spec.add_development_dependency "mocha"
+end

data/lib/jekyll-autolinks.rb

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

data/test/helper.rb

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

data/test/test_autolinks.rb

@@ -0,0 +1,74 @@
+require 'helper'
+
+class Jekyll::AutolinksTest < Minitest::Test
+  context 'Autolinks' do
+    setup do
+      @site = Jekyll::Site.new(Jekyll::Configuration::DEFAULTS.dup)
+      @autolinks = Jekyll::Autolinks.new(@site.config)
+      @page = Jekyll::Page.new(@site, File.expand_path('../../', __FILE__), '', 'README.md')
+      @page.instance_variable_set(:@content, '<div>hi@gmail.com</div>')
+      @site.pages << @page
+      @email_link = '<div><a href="mailto:hi@gmail.com">hi@gmail.com</a></div>'
+    end
+
+    should 'replace https url with link' do
+      @page.instance_variable_set(:@content, 'https://123.com')
+      @autolinks.instance_variable_set(:@site, @site)
+      @autolinks.send(:autolinkify, @page)
+      assert_equal '<a href="https://123.com">https://123.com</a>', @page.content
+    end
+
+    should 'replace http url with link' do
+      @page.instance_variable_set(:@content, 'http://123.com')
+      @autolinks.instance_variable_set(:@site, @site)
+      @autolinks.send(:autolinkify, @page)
+      assert_equal '<a href="http://123.com">http://123.com</a>', @page.content
+    end
+
+    should 'replace url with link (with link_attr)' do
+      @autolinks = Jekyll::Autolinks.new(@site.config)
+      @site.config['autolinks']['link_attr'] = 'target="_blank" class="my-link"'
+      @page.instance_variable_set(:@content, 'http://123.com')
+      @autolinks.instance_variable_set(:@site, @site)
+      @autolinks.send(:autolinkify, @page)
+      assert_equal '<a href="http://123.com" target="_blank" class="my-link">http://123.com</a>', @page.content
+    end
+
+    should 'replace email with link' do
+      @autolinks.instance_variable_set(:@site, @site)
+      @autolinks.send(:autolinkify, @page)
+      assert_equal @email_link, @page.content
+    end
+
+    should 'replace page content on generate' do
+      @autolinks.generate(@site)
+      assert_equal @email_link, @page.content
+    end
+
+    should 'replace page content on site#generate' do
+      @site.generators = Array(@autolinks)
+      @site.generate
+      assert_equal @email_link, @page.content
+    end
+
+    should 'pull link_attr from config' do
+      @site.config['autolinks']['link_attr'] = 'class="ivan"'
+      @autolinks.generate(@site)
+      assert @page.content.include?('class="ivan"')
+    end
+
+    should 'pull skip_tags from config' do
+      @site.config['autolinks']['skip_tags'] = 'div'
+      @autolinks.generate(@site)
+      assert_equal '<div>hi@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')
+      @page.instance_variable_set(:@content, '<div>adoyle.h@gmail.com</div>')
+      @site.pages << @page
+      @autolinks.generate(@site)
+      assert_equal '<div>adoyle.h@gmail.com</div>', @page.content
+    end
+  end
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-autolinks
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ADoyle
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-06-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.9.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.9.3
+- !ruby/object:Gem::Dependency
+  name: rinku
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.6
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: 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: Automatically create <a> DOMs from standard URLs.
+email:
+- adoyle.h@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- Makefile
+- NOTICE
+- README.md
+- Rakefile
+- jekyll-autolinks.gemspec
+- lib/jekyll-autolinks.rb
+- test/helper.rb
+- test/test_autolinks.rb
+homepage: https://github.com/adoyle-h/jekyll-autolinks
+licenses:
+- BSD-3-Clause
+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: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Autolink for your Jekyll site.
+test_files:
+- test/helper.rb
+- test/test_autolinks.rb