jekyll-link-attributes 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d59a29fc9f1e6e6ec043e624b4cdf4a3694ae2f6440e1c09c4b6199587075fda
+  data.tar.gz: 13d53f2e5d102022f32d475cb66eec47dcbc4aac7e3aef874fdf5f8d502b37e0
+SHA512:
+  metadata.gz: 8fb6ebbb5691b81672b195b0609ce7f6d29285e6fc0944fae2e06e0f004b4efe32d6286b07c3e629845006c8be916a3f3e4eb8fa2fe1b4a0e236b4335cf8c9fa
+  data.tar.gz: 8a79b43d72e9f59174da0e1f5a448c9456f2e29b5877575265f9d651adab0bc242679953cc29d59b820b5143bafd758ad1ceb16ee0167869a5268220242d2756

data/.gitignore

@@ -0,0 +1 @@
+.idea

data/.ruby-version

@@ -0,0 +1 @@
+3.1.0

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec
+
+group :test do
+  gem 'rspec'
+end

data/Gemfile.lock

@@ -0,0 +1,95 @@
+PATH
+  remote: .
+  specs:
+    jekyll-link-attributes (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
+    colorator (1.1.0)
+    concurrent-ruby (1.1.10)
+    diff-lcs (1.5.0)
+    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)
+    http_parser.rb (0.8.0)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    jekyll (4.2.2)
+      addressable (~> 2.4)
+      colorator (~> 1.0)
+      em-websocket (~> 0.5)
+      i18n (~> 1.0)
+      jekyll-sass-converter (~> 2.0)
+      jekyll-watch (~> 2.0)
+      kramdown (~> 2.3)
+      kramdown-parser-gfm (~> 1.0)
+      liquid (~> 4.0)
+      mercenary (~> 0.4.0)
+      pathutil (~> 0.9)
+      rouge (~> 3.0)
+      safe_yaml (~> 1.0)
+      terminal-table (~> 2.0)
+    jekyll-sass-converter (2.2.0)
+      sassc (> 2.0.1, < 3.0)
+    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.3)
+    listen (3.7.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    mercenary (0.4.0)
+    nokogiri (1.13.8-x86_64-darwin)
+      racc (~> 1.4)
+    pathutil (0.16.2)
+      forwardable-extended (~> 2.6)
+    public_suffix (5.0.0)
+    racc (1.6.0)
+    rake (10.5.0)
+    rb-fsevent (0.11.2)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rexml (3.2.5)
+    rouge (3.30.0)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    safe_yaml (1.0.5)
+    sassc (2.4.0)
+      ffi (~> 1.9)
+    terminal-table (2.0.0)
+      unicode-display_width (~> 1.1, >= 1.1.1)
+    unicode-display_width (1.8.0)
+
+PLATFORMS
+  x86_64-darwin-20
+
+DEPENDENCIES
+  bundler (>= 2.0.0)
+  jekyll (>= 4.0.0)
+  jekyll-link-attributes!
+  nokogiri (>= 1.0.0)
+  rake (>= 10.0.0)
+  rspec
+
+BUNDLED WITH
+   2.3.21

data/LICENSE

@@ -0,0 +1,25 @@
+Copyright 2022 Twin Sun, LLC
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+    * 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.
+    * Neither the name of Twin Sun, LLC 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 OWNER 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/README.md

@@ -0,0 +1,49 @@
+# Jekyll Link Attributes
+
+This plugin adds `rel` and `target` attributes to all external links in your Jekyll site.
+The default configuration opens external links in a new tab and conserves domain authority for your site.
+
+## Setup
+
+1. Add the gem to your `Gemfile`:
+    ```ruby
+    gem 'jekyll-link-attributes'
+    ```
+2. Run `bundle install` to install the gem
+3. Add the following to your `_config.yml`:
+    ```yaml
+    plugins:
+      - jekyll-link-attributes
+    ```
+
+## Configuration
+
+You can override the default configuration by adding the following section to your Jekyll site's `config.yml`:
+
+```yaml
+external_links:
+  enabled: true
+  rel: external nofollow noopener
+  target: _blank
+  exclude:
+    - "https://example.com"
+    - "https://another.example.com/test.html"
+```
+
+### Default Values
+| Key | Default Value | Description |
+| ---------------------------- | ---------------------------- | -------------------------------------------------- |
+| `external_links.enabled` | `true`                       | Enable attribute modifications for external links. |
+| `external_links.rel`     | `external nofollow noopener` | The `rel` attribute to add to external links.      |
+| `external_links.target`  | `_blank`                     | The `target` attribute to add to external links.   |
+| `external_links.exclude` | `[]`                         | A list of URLs to exclude from processing.         |
+
+## Contributing
+
+Pull requests are welcome!
+If you wish to change existing behavior, please open an issue to discuss the change before investing time in a PR.
+RSpec tests are encouraged for any new features.
+
+## Supported by Twin Sun
+
+This project is maintained by [Twin Sun](https://twinsunsolutions.com/), a custom mobile and web app development agency in Nashville, TN.

data/Rakefile

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'

data/jekyll-link-attributes.gemspec

@@ -0,0 +1,33 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jekyll-link-attributes/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'jekyll-link-attributes'
+  spec.version       = Jekyll::LinkAttributes::VERSION
+  spec.authors       = ['twinsunllc']
+  spec.email         = ['contact@twinsunsolutions.com']
+
+  spec.summary       = 'This plugin adds `rel` and `target` attributes to all external links in your Jekyll site.'
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/twinsunllc/jekyll-link-attributes'
+  spec.license       = 'BSD 3-Clause'
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '>= 2.0.0'
+  spec.add_development_dependency 'jekyll', '>= 4.0.0'
+  spec.add_development_dependency 'nokogiri', '>= 1.0.0'
+  spec.add_development_dependency 'rake', '>= 10.0.0'
+end

data/lib/jekyll-link-attributes/hooks.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'jekyll/hooks'
+require 'jekyll-link-attributes'
+
+Jekyll::Hooks.register :documents, :post_render do |document|
+  Jekyll::LinkAttributes.post_render_html(document)
+end
+
+Jekyll::Hooks.register :pages, :post_render do |page|
+  next unless page.output_ext.eql?('.html')
+
+  Jekyll::LinkAttributes.post_render_html(page)
+end
+
+Jekyll::Hooks.register :posts, :post_render do |post|
+  Jekyll::LinkAttributes.post_render_html(post)
+end

data/lib/jekyll-link-attributes/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Jekyll
+  class LinkAttributes
+    VERSION = '0.0.1'
+  end
+end

data/lib/jekyll-link-attributes.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'jekyll-link-attributes/hooks'
+require 'jekyll-link-attributes/version'
+require 'nokogiri'
+
+module Jekyll
+
+  # Adjusts external links in HTML documents.
+  class LinkAttributes
+
+    # Perform post_render processing on the specified document/page/post
+    # @param [Object] article a Jekyll document, page, or post
+    def self.post_render_html(article)
+      config = article.site.config
+      return unless external_links_enabled?(config: config)
+
+      output = Nokogiri::HTML(article.output)
+      output.css('a').each do |a|
+        next unless external_link?(a['href'])
+        next if excludes_external_link?(config: config, url: a['href'])
+
+        a['rel'] = external_link_rel(config: config)
+        a['target'] = external_link_target(config: config)
+      end
+
+      article.output = output.to_s
+    end
+
+    private
+
+    def self.excludes_external_link?(config:, url:)
+      (config.dig('external_links', 'exclude') || []).include?(url)
+    end
+
+    def self.external_link?(url)
+      (url =~ %r{^https?://}) != nil
+    end
+
+    def self.external_links_enabled?(config:)
+      enabled = config.dig('external_links', 'enabled')
+      enabled.nil? || enabled
+    end
+
+    def self.external_link_rel(config:)
+      config.dig('external_links', 'rel') || 'external nofollow noopener'
+    end
+
+    def self.external_link_target(config:)
+      config.dig('external_links', 'target') || '_blank'
+    end
+  end
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-link-attributes
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- twinsunllc
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-09-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.0.0
+description: This plugin adds `rel` and `target` attributes to all external links
+  in your Jekyll site.
+email:
+- contact@twinsunsolutions.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- jekyll-link-attributes.gemspec
+- lib/jekyll-link-attributes.rb
+- lib/jekyll-link-attributes/hooks.rb
+- lib/jekyll-link-attributes/version.rb
+homepage: https://github.com/twinsunllc/jekyll-link-attributes
+licenses:
+- BSD 3-Clause
+metadata:
+  allowed_push_host: https://rubygems.org
+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.3.3
+signing_key:
+specification_version: 4
+summary: This plugin adds `rel` and `target` attributes to all external links in your
+  Jekyll site.
+test_files: []