asciidoctor-external-callout 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a6968fdcf2ef95e88f45bc923c8f971cd0ecea32fe0054b39920403d270c99ff
-  data.tar.gz: d9bc142aa3d6cd397cfc8e6fd6dca889e6e0e03e0546a2fc97ed8b8aea49de18
+  metadata.gz: 9071bcc8bd5b3d881297e12f8a9f27cb9220dd4633584f35aa537a33b2a1ffcc
+  data.tar.gz: 6e1e73370eb5ee7df1c5128f0178975ba30852c69b450fb0cb02e5ca105db3a6
 SHA512:
-  metadata.gz: 1084e775864420eba3dad00a363068912260f8fddfeac62c3771ede801562edda9f27428ace473e364d1a4a02e673b07db1c9c8ab5153a5f88036f739104a640
-  data.tar.gz: 6a5b4f84193d7d41346bb71b69acc37b24d3ccdd30aae1760c0c5c437bfb68d4e4e60047c13a0c36c565ead529a815a01371aeb85a6df24ba8a70856b8b4e6af
+  metadata.gz: a62d43ad6fee410aa7d71862f71bb28ad67e12a44d102fce91ea5130c19b9ac14b5fbe905278eb9aaf6a2d39e347f99f8caadf68ae3c737119086ab17902455a
+  data.tar.gz: 2a0671db148dd4c7e855fbd5e00a87c885167a31716fa387810e1cacc0368c9b4d0af3131b5b26fbf23834c40c74a4dd5fe579f13638524e37755f598a4dc668

data/.gitignore

@@ -7,8 +7,8 @@
 /spec/reports/
 /tmp/
 /.idea
-**/sample.html
-**/sample_global_search.html
+/test/*.html
+/test/*.pdf
 *.gem
 /Gemfile.lock
 /.asciidoctor

data/CHANGELOG.md

@@ -2,6 +2,22 @@
 
 Record of bug fixes, enhancements, and changes.
 
+## [1.2.0] – 2022-07-30
+
+### Added
+- If you add the role `[calloutlist]` to an ordered list then it will be styled to look like a callout list. This allows you to add callouts to annotated images etc. 
+
+## [1.1.3] – 2022-07-07-16
+
+### Fixed
+- The global and case-insensitive flags (ig) are now parsing correctly: using ii or gg will cause prevent the callout block from being processed. Thanks to Hakim Cassimally for finding the bug.
+- Escaped slash characters were not being processed in the search.  Thanks to Hakim Cassimally for finding the bug.
+
+## [1.1.2] – 2022-07-07
+
+### Fixed
+- Code fix to stop the constants from reloading every time the extension is run. (Tidying up for execution inside the Asciidoc plugin)
+
 ## [1.1.1] – 2022-06-23
 
 ### Fixed

data/README.md

@@ -53,24 +53,31 @@ Rather than tagging the code, you add a location token at the end of a list item
 
 Two types of location token are supported:
 
-@_number_
+**@_number_**
 : This format takes a numeric value indicating the line in the source block where the callout should appear. The callouts will appear at the end of the line. Multiple callouts on the same line will have a single space between them.
 
-
-@/_text_/
+**@/_text_/**
 : The text between the two slashes will be used in a regex search. A callout will be placed at the end of the first matching line.
 If you have a large listing then it may be preferable to use the text search rather than counting all the lines. It may also be preferable to use a smaller listing, as a long listing might mean that your description is a bit too general. +
 Using the text search method means that the location of the callout will move with the line; handy if you're referencing a source file that might get the occasional tweak outside your control.
 
-@/_text_/g
+**@/_text_/g**
 : Works the same as the standard text search; the `g` flag means that callouts willl be added to _all_ the lines that match the search string, instead of just the first one.
 
-@/_text_/i
+**@/_text_/i**
 : This is a case-insensitive search.
 
-@/_text_/gi
+**@/_text_/gi**
 : And of course, you can combine the two, though I'm not sure why you'd want to.
 
+## Standalone callout lists
+You can create a standalone callout list by adding the `calloutlist` role to an ordered list. This simply styles the list to make it look like a list of callouts so you can use it as a reference to annoted images etc.
+```asciidoc
+[calloutlist]
+. This list can be used to add references to annotated images
+. The list will look like a standard callout list.
+```
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/lib/asciidoctor-external-callout.rb

@@ -15,11 +15,16 @@ include Asciidoctor
 
 Asciidoctor::Extensions::register do
 
-  CALLOUT_SOURCE_BLOCK_ROLE = 'external-callout-block'
-  CALLOUT_ORDERED_LIST_ROLE = 'external-callout-list'
+  CALLOUT_SOURCE_BLOCK_ROLE ||= 'external-callout-block'
+  CALLOUT_ORDERED_LIST_ROLE ||= 'external-callout-list'
 
-  LOCATION_TOKEN_RX = /@(\d+)|(@\/[^\/]+?\/(?:i|g|gi|ig){0,2})/
-  LOCATION_TOKEN_ARRAY_RX = /^(@\d+|@\/[^\/]+?\/(i|g|gi|ig){0,2})((\s+@\d+)|(\s+@\/[^\/]+?\/(i|g|gi|ig){0,2}))*$/
+  STANDALONE_CALLOUT_LIST_STYLE ||= 'calloutlist'
+
+  LOCATION_TOKEN_RX ||= /@(\d+)|(@\/(?:\\\/|[^\/])+?\/[ig]{0,2})/
+  LOCATION_TOKEN_ARRAY_RX ||= /^(@\d+|@\/(?:\\\/|[^\/]|)+?\/[ig]{0,2})((\s+@\d+)|(\s+@\/(?:\\\/|[^\/]|)+?\/[ig]{0,2}))*$/
+
+  SEARCH_STRING_RX ||= /\/((?:\\\/|[^\/])+?)\//
+  SEARCH_OPTIONS_RX ||= /\/(?:\\\/|[^\/])+?\/([ig]{0,2})/
 
   tree_processor do
 
@@ -30,18 +35,30 @@ Asciidoctor::Extensions::register do
         # The makes sure it's the right kind of list.
         document.find_by context: :olist do |list|
 
-          if external_callout_list? list
+          # if there is as calloutlist style attached to the block
+          # then simply style the block as a colist. This will allow folk
+          # to create callout blocks that can be attached to annotated images etc.
+
+          if list.style.include? STANDALONE_CALLOUT_LIST_STYLE
 
-            owner_block = owning_block list
+            list.context = :colist
 
-            owner_block.subs.replace(owner_block.subs + [:callouts]).uniq
+          else
 
-            process_callouts(list, owner_block)
+            if external_callout_list? list
 
-            list.context = :colist
+              owner_block = owning_block list
 
-            owner_block.add_role(CALLOUT_SOURCE_BLOCK_ROLE) unless owner_block.has_role?(CALLOUT_SOURCE_BLOCK_ROLE)
-            list.add_role(CALLOUT_ORDERED_LIST_ROLE) unless list.has_role?(CALLOUT_ORDERED_LIST_ROLE)
+              owner_block.subs.replace(owner_block.subs + [:callouts]).uniq
+
+              process_callouts(list, owner_block)
+
+              list.context = :colist
+
+              owner_block.add_role(CALLOUT_SOURCE_BLOCK_ROLE) unless owner_block.has_role?(CALLOUT_SOURCE_BLOCK_ROLE)
+              list.add_role(CALLOUT_ORDERED_LIST_ROLE) unless list.has_role?(CALLOUT_ORDERED_LIST_ROLE)
+
+            end
 
           end
 
@@ -157,12 +174,11 @@ Asciidoctor::Extensions::register do
           else
 
             # Must be a string matcher then
+            search_options = get_search_options location
 
-            # Is this a global search?
-            global_search = !!location.match(/\/([^\/]+?)\/.*g.*/)
-            case_insensitive = !!location.match(/\/([^\/]+?)\/.*i.*/)
-            search_string = location[/\/([^\/]+?)\//, 1]
-            found_line_numbers = find_matching_lines(search_string, global_search, case_insensitive, owner_block)
+            search_string = location[SEARCH_STRING_RX, 1]
+            found_line_numbers = find_matching_lines(search_string, search_options[:global_search],
+                                                     search_options[:case_insensitive], owner_block)
 
             if !found_line_numbers.empty?
 
@@ -214,6 +230,27 @@ Asciidoctor::Extensions::register do
 
     end
 
+    def get_search_options(location)
+
+      options = { :case_insensitive => false,
+                  :global_search => false }
+
+      matches = location.match(SEARCH_OPTIONS_RX)
+
+      return options unless matches
+
+      # This is just for completeness, but make sure that
+      # none of the options are mentioned twice in the list
+
+      raise "Invalid search options: #{matches[1]}" if matches[1].match /^(.).*\1$/
+
+      options[:case_insensitive] = true if matches[1].include? 'i'
+      options[:global_search] = true if matches[1].include? 'g'
+
+      return options
+
+    end
+
     class String
       def is_numeric?
         self.match(/^\d+$/)

data/lib/version.rb

@@ -3,7 +3,7 @@
 module Asciidoctor
   module External
     module Callout
-      VERSION = "1.1.1"
+      VERSION = "1.2.0"
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-external-callout
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Ray Offiah
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-06-24 00:00:00.000000000 Z
+date: 2022-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor