bridgetown_markdown_lazylinks 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a944effb47e50a54e844dc41a7394af50a8f8140273794953eb01c2b3cc4a662
-  data.tar.gz: 7fbaf75c16eae42ed8911ef74860e557aa20e8bba193796cd356ed8692ff2ada
+  metadata.gz: bfb7aabefee9a49f88a7c2969723a72700aa7faf9418384aefe0e9cdeda8f0ce
+  data.tar.gz: a365c1dfe8b03f391be738437d8a04ac9e3b3f6b6659db57b3a6b22ff83620fb
 SHA512:
-  metadata.gz: d56b2bf3438a69233e4c1bc407c30c97adcf9cd8e814ea7867e72c0f444ccf3ebdcc179091fe975dda7ca7ba072e7af5b0334cf759bea7ca74296f6dbb0b9acb
-  data.tar.gz: 4a908bf5d842001475673bf092fc6f4a8d21f45932cc0be9c0633a1733d25252f37ef6e63175c5e318f545e6233fb84deb90beb8d5eb05f7e35ab3adf3d5e70e
+  metadata.gz: 2fec30ccdadb994e07aa840fddcbb6c13079c1dcf4987f6058a1288f6e40117c4481be0976f70dfa3e21085f3cc0ac877c7ff581707564a0aeeb4a2164c2b6fc
+  data.tar.gz: 8cce949321493052945ff333827add6046e57eb4ccf59b03c09aaa8d0920b9a449ba62a3634ab16740042ae4cb1db73727049ee8318a36310206d2388e0bc712

data/CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.3.0] - 2023-06-26
+
+- distinguish between basic & external placeholders
+
 ## [0.2.2] - 2023-06-26
 
 - allow placeholder customization
@@ -28,3 +32,4 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 [0.2.0]: https://github.com/akarzim/bridgetown_markdown_lazylinks/releases/tag/v0.2.0
 [0.2.1]: https://github.com/akarzim/bridgetown_markdown_lazylinks/releases/tag/v0.2.1
 [0.2.2]: https://github.com/akarzim/bridgetown_markdown_lazylinks/releases/tag/v0.2.2
+[0.3.0]: https://github.com/akarzim/bridgetown_markdown_lazylinks/releases/tag/v0.3.0

data/README.md

@@ -28,7 +28,8 @@ You can customize the lazylinks placeholder in this way to use `+` instead of `*
 
 ```ruby
 init :bridgetown_markdown_lazylinks do
-  placeholder "+"
+  basic_placeholder "-"
+  external_placeholder "@"
 end
 ```
 
@@ -52,6 +53,10 @@ and then just define them in order below it.
 [*]: http://blog.bignerdranch.com/4044-rock-heads/
 ```
 
+Since version 0.3.0, we can use `+` as an external link reference, in the same
+way as `*`, but this will add `target="_blank" rel="external"` to the resulting
+links.
+
 ## Testing
 
 * Run `bundle exec rake test` to run the test suite

data/lib/bridgetown_markdown_lazylinks/converter.rb

@@ -21,23 +21,36 @@ module BridgetownMarkdownLazylinks
   class Converter < Bridgetown::Converter
     priority :high
 
-    DEFAULT_PLACEHOLDER = :*
+    DEFAULT_BASIC_PLACEHOLDER = :*
+    DEFAULT_EXTERNAL_PLACEHOLDER = :+
 
     def initialize(config = {})
       super
 
       self.class.input @config["markdown_ext"].split(",")
       @counter = 0
-      @placeholder = config.bridgetown_markdown_lazylinks.placeholder || DEFAULT_PLACEHOLDER
+      @basic_placeholder = config.bridgetown_markdown_lazylinks.basic_placeholder
+      @basic_placeholder ||= DEFAULT_BASIC_PLACEHOLDER
+      @external_placeholder = config.bridgetown_markdown_lazylinks.external_placeholder
+      @external_placeholder ||= DEFAULT_EXTERNAL_PLACEHOLDER
     end
 
     def convert(content)
-      lazy_links_regex = %r!(\[[^\]]+\]\s*\[)#{placeholder}(\].*?^\[)#{placeholder}\]:!m.freeze
+      # rubocop:disable Layout/LineLength
+      basic_regex = %r!(\[[^\]]+\]\s*\[)#{basic_placeholder}(\].*?^\[)#{basic_placeholder}\]:!m.freeze
+      external_regex = %r!(\[[^\]]+\]\s*\[)#{external_placeholder}\](.*?^\[)#{external_placeholder}\]:!m.freeze
+      # rubocop:enable Layout/LineLength
 
       cache.getset(content) do
-        while content =~ lazy_links_regex
+        while content =~ basic_regex
           self.counter += 1
-          content.sub!(lazy_links_regex, "\\1#{counter}\\2#{counter}]:")
+          content.sub!(basic_regex, "\\1#{counter}\\2#{counter}]:")
+        end
+
+        while content =~ external_regex
+          self.counter += 1
+          attrs = '{:target="_blank"}{:rel="external"}'
+          content.sub!(external_regex, %(\\1#{counter}]#{attrs}\\2#{counter}]:))
         end
 
         content
@@ -48,8 +61,12 @@ module BridgetownMarkdownLazylinks
 
     attr_accessor :counter
 
-    def placeholder
-      Regexp.quote(@placeholder)
+    def basic_placeholder
+      Regexp.quote(@basic_placeholder)
+    end
+
+    def external_placeholder
+      Regexp.quote(@external_placeholder)
     end
 
     def cache

data/lib/bridgetown_markdown_lazylinks/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BridgetownMarkdownLazylinks
-  VERSION = "0.2.2"
+  VERSION = "0.3.0"
 end

data/lib/bridgetown_markdown_lazylinks.rb

@@ -8,7 +8,14 @@ require "bridgetown_markdown_lazylinks/converter"
 # @see https://github.com/bridgetownrb/bridgetown/issues/769#issuecomment-1596520674
 #
 # @param config [Bridgetown::Configuration::ConfigurationDSL]
-Bridgetown.initializer :bridgetown_markdown_lazylinks do |config, placeholder: :*|
+# @param [Hash<String, String>] opts custom configuration
+# @option opts [String] :placeholder ('*') the basic placeholder
+# @option opts [String] :external_placeholder ('+') the external placeholder
+#
+# rubocop:disable Metrics/LineLength
+Bridgetown.initializer :bridgetown_markdown_lazylinks do |config, placeholder: "*", external_placeholder: "+"|
   config.bridgetown_markdown_lazylinks ||= {}
-  config.bridgetown_markdown_lazylinks.placeholder = placeholder
+  config.bridgetown_markdown_lazylinks.basic_placeholder = placeholder
+  config.bridgetown_markdown_lazylinks.external_placeholder = external_placeholder
 end
+# rubocop:enable Metrics/LineLength

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bridgetown_markdown_lazylinks
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - François Vantomme