asciidoctor-external-callout 1.0.0 → 1.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 53e488dac87a1685e9450b031e44aea9ef5d265b92f974965e7b212df326b284
-  data.tar.gz: 27559c5adc5c7daf42eb2b958ed6d96be360d6ee4a25689e726f2c42dffca8b5
+  metadata.gz: 92129f0b6fe96367004f4aa8e3f44b8bdf1182e56b07f296bb1d341a9568c7a1
+  data.tar.gz: c342a82f9630d128c38d1b87a802aa8a59791dc4666576cea6ced8ccea99aaae
 SHA512:
-  metadata.gz: 7b48ae24cdb081bedffb3702cd10821ac8739e52d372042dfeb851acb9d0b607d3e72afb6fd6e7cabc0be2a81647eaf50f46604ba3b0f44b5d30ea2db9616608
-  data.tar.gz: 53cd492e35f520d503d7643723a4289abe3f88ef8f9b00607d494e1e2e0240692e58da74af6f05d0f10e365070ac24fe0d195612b29b589f8579e585eccc6797
+  metadata.gz: 6c292169bea665e64331fbd2a9e473860d26845c953c8fa64666b10a262c205cd978dc786ec31584df864c04fa59c0301ad2d00e8db218dff033ecd9320baad1
+  data.tar.gz: 2d571d81ea89b61250050c64ecdf6f7b94b18ca60ce9653c294d1c95fdd8fe824807791d0e98e82fa9026571569dba93daaa5a26ce439be96517ea02e6ef1888

data/.gitignore

@@ -8,6 +8,9 @@
 /tmp/
 /.idea
 **/sample.html
+**/sample_global_search.html
+**/callout-list-block-sample.html
+**/sample.pdf
 *.gem
 /Gemfile.lock
 /.asciidoctor

data/CHANGELOG.md

@@ -2,7 +2,30 @@
 
 Record of bug fixes, enhancements, and changes.
 
-## [1.0.0] – 22-06-16
+## [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
+- Fixed regular expression to correctly detect new flags.
+
+## [1.1.0] – 2022-06-23
+
+### Added
+- The text search now supports a global flag (`@/text/g`). The `g` flag will add the callout to all the lines that match the search criteria. Use wisely.
+- Added the `i` flag for case-insensitive searches: (`@/text/i`). Again, don't go mad.
+
+## [1.0.0] – 2022-06-16
 
 ### Added
 - Added roles to the source block and the callout list so that CSS folk can pick them out to make style changes (For example, adjusting the gap between callout items in the source code block.)

data/README.md

@@ -53,15 +53,23 @@ 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**
+: 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**
+: This is a case-insensitive search.
+
+**@/_text_/gi**
+: And of course, you can combine the two, though I'm not sure why you'd want to.
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/lib/asciidoctor-external-callout.rb

@@ -15,11 +15,14 @@ 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+)|@\/([^\/]+?)\//
-  LOCATION_TOKEN_ARRAY_RX = /^(@\d+|@\/[^\/]+?\/)((\s+@\d+)|(\s+@\/[^\/]+?\/))*$/
+  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
 
@@ -146,23 +149,26 @@ Asciidoctor::Extensions::register do
 
           if location.is_numeric?
 
-            number = location.to_i
+            line_number = location.to_i
 
-            if number <= owner_block.lines.length
-              line_numbers << (number - 1)
+            if line_number.between?(1, owner_block.lines.length)
+              line_numbers << (line_number - 1)  # Because the line number is now an array index, so -1
             else
-              warn "Out of range ==> #{number}"
+              warn "Line number out of range ==> #{line_number}"
             end
 
           else
 
             # Must be a string matcher then
+            search_options = get_search_options location
 
-            number = find_matching_lines(location, 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 number != nil
+            if !found_line_numbers.empty?
 
-              line_numbers << number
+              line_numbers = line_numbers.merge(found_line_numbers)
 
             else
               warn "Search term not found ==> #{location}"
@@ -185,9 +191,49 @@ Asciidoctor::Extensions::register do
 
     end
 
-    def find_matching_lines(search_string, owner_block)
+    def find_matching_lines(search_string, global_search, case_insensitive, owner_block)
+
+      if case_insensitive
+        string_to_match = Regexp.new(search_string, Regexp::IGNORECASE)
+      else
+        string_to_match = Regexp.new(search_string)
+      end
+      found_lines = Set.new
+
+      owner_block.lines.each_with_index do |line, index|
+
+        if line.match(string_to_match) != nil
+
+          found_lines << index
+
+          return found_lines unless global_search
+
+        end
+
+      end
+
+      found_lines
+
+    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'
 
-      owner_block.lines.index { |x| x.match(%r[#{search_string}]) }
+      return options
 
     end
 

data/lib/version.rb

@@ -3,7 +3,7 @@
 module Asciidoctor
   module External
     module Callout
-      VERSION = "1.0.0"
+      VERSION = "1.1.4"
     end
   end
 end

metadata

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