bridgetown_internal_markdown_links 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a5af81b6852818436a175b23ee682d48ee8f65c7bf2e84bd9c464e685542b22c
+  data.tar.gz: 28d22f8b05e5cdada85060e0a039a25b964ddad08580ef06211d69daed0aea39
+SHA512:
+  metadata.gz: 8959cb5ec3cc01b821eac074690714bc568de4d770098064003d364dbdd4c05091e0a1933f7b8809e33b7c067853f02dfb879de9e6210840d7a36e7a22bd0b94
+  data.tar.gz: 7fc681db4d1b6abaf9e090e7813a99f2c6482f929f7087d4adf338d6a3ec8ab1c1f52b9f0c1044d174387f96771d635e838b8b4cc446f2c84a11ad39a65c0c0f

data/.gitignore

@@ -0,0 +1,40 @@
+/vendor
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.gem
+Gemfile.lock
+.bundle
+.ruby-version
+
+# Node
+node_modules
+.npm
+.node_repl_history
+
+# Yarn
+yarn-error.log
+yarn-debug.log*
+.pnp/
+.pnp.js
+
+# Yarn Integrity file
+.yarn-integrity
+
+test/dest
+.bridgetown-metadata
+.bridgetown-cache
+.bridgetown-webpack
+
+.env

data/.rubocop.yml

@@ -0,0 +1,23 @@
+require: rubocop-bridgetown
+
+inherit_gem:
+  rubocop-bridgetown: .rubocop.yml
+
+AllCops:
+  TargetRubyVersion: 2.7
+
+  Exclude:
+    - .gitignore
+    - .rubocop.yml
+    - "*.gemspec"
+
+    - Gemfile.lock
+    - CHANGELOG.md
+    - LICENSE.txt
+    - README.md
+    - Rakefile
+    - bridgetown.automation.rb
+
+    - script/**/*
+    - test/fixtures/**/*
+    - vendor/**/*

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0] - 2023-03-24
+
+- First version

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+gemspec
+
+gem "bridgetown", ENV["BRIDGETOWN_VERSION"] if ENV["BRIDGETOWN_VERSION"]
+
+# group :test do
+#   gem "minitest"
+#   gem "minitest-profile"
+#   gem "minitest-reporters"
+# end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2020-present
+
+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,67 @@
+# 🔗 Bridgetown Internal Markdown links
+
+This plugin allows you to write paths in your markdown, like so:
+
+`[Check out the docs](_pages/docs.erb)`.
+
+Instead of the page's absolute url (ex. "/docs/"). If the slug is changed for that page, you don't have to go and do a find/replace throughout your site.
+
+This plugin  uses Bridgetown's `url_for()` helper in the background.
+
+
+## Installation
+
+Run this command to add this plugin to your site's Gemfile:
+
+```shell
+bundle add bridgetown_internal_markdown_links
+```
+
+Then add the initializer to your configuration in `config/initializers.rb`:
+
+```ruby
+init :bridgetown_internal_markdown_links
+```
+
+
+## Usage
+
+Link parsing is opt-in per collection.
+
+### Configuration
+
+Add the following in your `config/initializers.rb`:
+
+```ruby
+config.internal_markdown_links.collections = ["posts", "docs"]
+```
+
+Parsing of internal links is now happening for the collections “posts” and “docs”.
+
+
+### Disable per file
+
+Set `internal_markdown_links: false` in the frontmatter.
+
+
+## Testing (TBD)
+
+* Run `bundle exec rake test` to run the test suite
+* Or run `script/cibuild` to validate with Rubocop and Minitest together.
+
+
+## Sponsored By [Spinal](https://spinalcms.com/cms-for-bridgetown/)
+
+<a href="https://spinalcms.com/cms-for-bridgetown/" target="_blank">
+  <img src="https://user-images.githubusercontent.com/988051/183079316-af747ef2-42a9-47d8-9a0c-488ed4b6a689.jpg" alt="Spinal CMS logo" width="200"/>
+</a>
+
+
+## Contributing
+
+1. Fork it (https://github.com/SpinalCMS/bridgetown-internal-markdown-links/fork)
+2. Clone the fork using `git clone` to your local development machine.
+3. Create your feature branch (`git checkout -b my-new-feature`)
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+  t.warning = false
+end
+
+task :default => :test

data/bridgetown_internal_markdown_links.gemspec

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative "lib/bridgetown_internal_markdown_links/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "bridgetown_internal_markdown_links"
+  spec.version       = BridgetownInternalMarkdownLinks::VERSION
+  spec.author        = "Spinal Developers"
+  spec.email         = "developers@spinalcms.com"
+  spec.summary       = "Parse internal links in markdown files"
+  spec.homepage      = "https://github.com/spinalcms/bridgetown-internal-markdown-links"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r!^(test|script|spec|features)/!) }
+  spec.test_files    = spec.files.grep(%r!^test/!)
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = ">= 2.7.0"
+
+  spec.add_dependency "bridgetown", ">= 1.2.0", "< 2.0"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake", ">= 13.0"
+  spec.add_development_dependency "rubocop-bridgetown", "~> 0.3"
+end

data/lib/bridgetown_internal_markdown_links/builder.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module BridgetownInternalMarkdownLinks
+  class Builder < Bridgetown::Builder
+    MARKDOWN_LINK_REGEX = %r{\[([^\]]+)\]\(([^)]+)\)}.freeze
+
+    def build
+      parseable_collections.each do |collection|
+        Bridgetown.logger.info "Bridgetown Internal Markdown Links:",
+                               "Parsing links for #{collection}"
+
+        hook collection, :pre_render do |resource|
+          next if resource.data.internal_markdown_links == false
+
+          parse_internal_links(resource)
+        end
+      end
+    end
+
+    private
+
+    def parseable_collections
+      config.internal_markdown_links.collections.map(&:to_sym)
+    end
+
+    def parse_internal_links(resource)
+      resource.content.gsub!(MARKDOWN_LINK_REGEX) do
+        match = Regexp.last_match
+        label = match[1]
+        link = match[2]
+
+        if excluding?(link)
+          "[#{label}](#{link})"
+        else
+          "[#{label}](#{Bridgetown::RubyTemplateView::Helpers.new(resource, site).url_for(link)})"
+        end
+      end
+    end
+
+    def excluding?(link)
+      (link&.starts_with?("http") && !link&.include?(site.config.url)) ||
+        link&.starts_with?("#") ||
+        link&.starts_with?("mailto:") ||
+        link&.ends_with?("jpg")
+    end
+  end
+end

data/lib/bridgetown_internal_markdown_links/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module BridgetownInternalMarkdownLinks
+  VERSION = "0.1.0"
+end

data/lib/bridgetown_internal_markdown_links.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "bridgetown"
+require "bridgetown_internal_markdown_links/builder"
+
+Bridgetown.initializer :bridgetown_internal_markdown_links do |config|
+  config.internal_markdown_links ||= {}
+  config.internal_markdown_links.collections ||= []
+
+  config.builder BridgetownInternalMarkdownLinks::Builder
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: bridgetown_internal_markdown_links
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Spinal Developers
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-03-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bridgetown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-bridgetown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+description:
+email: developers@spinalcms.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bridgetown_internal_markdown_links.gemspec
+- lib/bridgetown_internal_markdown_links.rb
+- lib/bridgetown_internal_markdown_links/builder.rb
+- lib/bridgetown_internal_markdown_links/version.rb
+homepage: https://github.com/spinalcms/bridgetown-internal-markdown-links
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.7
+signing_key:
+specification_version: 4
+summary: Parse internal links in markdown files
+test_files: []