asciidoctor-external-callout 1.0.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 53e488dac87a1685e9450b031e44aea9ef5d265b92f974965e7b212df326b284
-  data.tar.gz: 27559c5adc5c7daf42eb2b958ed6d96be360d6ee4a25689e726f2c42dffca8b5
+  metadata.gz: a6968fdcf2ef95e88f45bc923c8f971cd0ecea32fe0054b39920403d270c99ff
+  data.tar.gz: d9bc142aa3d6cd397cfc8e6fd6dca889e6e0e03e0546a2fc97ed8b8aea49de18
 SHA512:
-  metadata.gz: 7b48ae24cdb081bedffb3702cd10821ac8739e52d372042dfeb851acb9d0b607d3e72afb6fd6e7cabc0be2a81647eaf50f46604ba3b0f44b5d30ea2db9616608
-  data.tar.gz: 53cd492e35f520d503d7643723a4289abe3f88ef8f9b00607d494e1e2e0240692e58da74af6f05d0f10e365070ac24fe0d195612b29b589f8579e585eccc6797
+  metadata.gz: 1084e775864420eba3dad00a363068912260f8fddfeac62c3771ede801562edda9f27428ace473e364d1a4a02e673b07db1c9c8ab5153a5f88036f739104a640
+  data.tar.gz: 6a5b4f84193d7d41346bb71b69acc37b24d3ccdd30aae1760c0c5c437bfb68d4e4e60047c13a0c36c565ead529a815a01371aeb85a6df24ba8a70856b8b4e6af

data/.gitignore

@@ -8,6 +8,7 @@
 /tmp/
 /.idea
 **/sample.html
+**/sample_global_search.html
 *.gem
 /Gemfile.lock
 /.asciidoctor

data/CHANGELOG.md

@@ -2,7 +2,18 @@
 
 Record of bug fixes, enhancements, and changes.
 
-## [1.0.0] – 22-06-16
+## [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

@@ -62,6 +62,15 @@ Two types of location token are supported:
 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

@@ -18,8 +18,8 @@ Asciidoctor::Extensions::register do
   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+)|(@\/[^\/]+?\/(?: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}))*$/
 
   tree_processor do
 
@@ -146,23 +146,27 @@ 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
 
-            number = find_matching_lines(location, owner_block)
+            # 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)
 
-            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 +189,28 @@ 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)
 
-      owner_block.lines.index { |x| x.match(%r[#{search_string}]) }
+      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
 

data/lib/version.rb

@@ -3,7 +3,7 @@
 module Asciidoctor
   module External
     module Callout
-      VERSION = "1.0.0"
+      VERSION = "1.1.1"
     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.1
 platform: ruby
 authors:
 - Ray Offiah
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-06-16 00:00:00.000000000 Z
+date: 2022-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor