asciidoctor-external-callout 1.1.4 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 92129f0b6fe96367004f4aa8e3f44b8bdf1182e56b07f296bb1d341a9568c7a1
-  data.tar.gz: c342a82f9630d128c38d1b87a802aa8a59791dc4666576cea6ced8ccea99aaae
+  metadata.gz: 988ee7db8d0166dee5024f3fb8d480d169b5e1b7ad5d520cdfa6d1732af8246c
+  data.tar.gz: d124ae287c1e1f8b3c046e58129da71ece998892b05cd3f31827fea2141098cf
 SHA512:
-  metadata.gz: 6c292169bea665e64331fbd2a9e473860d26845c953c8fa64666b10a262c205cd978dc786ec31584df864c04fa59c0301ad2d00e8db218dff033ecd9320baad1
-  data.tar.gz: 2d571d81ea89b61250050c64ecdf6f7b94b18ca60ce9653c294d1c95fdd8fe824807791d0e98e82fa9026571569dba93daaa5a26ce439be96517ea02e6ef1888
+  metadata.gz: '0782b1b464338a58aebc8134b9586100461fd84fc0a6e929a2aa7233c3c0ad21c461c8d0270e4159e098ef4e87971a2942a48e056dba9fdcdc1dcadbc078e54a'
+  data.tar.gz: a02cc9f11cbd93ce43d5c8031af3033aa1c28ec9422e49b873af70afd22ae245dc0331784638dc6fb72e5fe07c26946e971f9ed82bcbb1ec4442fe9e5690b171

data/.gitignore

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

data/CHANGELOG.md

@@ -2,10 +2,19 @@
 
 Record of bug fixes, enhancements, and changes.
 
-## [1.1.3] – 2022-07-07-16
+## [1.2.1] – 2022-09-16
 
 ### Fixed
+- Fixed detection of source blocks that are nested inside other blocks.
+
+## [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.
 

data/README.md

@@ -70,6 +70,14 @@ Using the text search method means that the location of the callout will move wi
 **@/_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

@@ -18,6 +18,8 @@ Asciidoctor::Extensions::register do
   CALLOUT_SOURCE_BLOCK_ROLE ||= 'external-callout-block'
   CALLOUT_ORDERED_LIST_ROLE ||= 'external-callout-list'
 
+  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}))*$/
 
@@ -33,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.
 
-            owner_block = owning_block list
+          if list.style.include? STANDALONE_CALLOUT_LIST_STYLE
 
-            owner_block.subs.replace(owner_block.subs + [:callouts]).uniq
+            list.context = :colist
 
-            process_callouts(list, owner_block)
+          else
 
-            list.context = :colist
+            if external_callout_list? list
+
+              owner_block = owning_block document, 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
 
@@ -85,13 +99,13 @@ Asciidoctor::Extensions::register do
 
     # Have a look at the next level up
     # to find the block that our CO list belongs to
-    def owning_block(list)
+    def owning_block(document, list)
 
-      list_parent = list.parent
+      all_blocks = document.find_by
 
-      raise "There is no block above the callout list" if list_parent == nil
+      raise "There are no available blocks" if all_blocks == nil
 
-      index_back = list_parent.blocks.index { |x| x == list }
+      index_back = all_blocks.index { |x| x == list }
 
       # We should be able to find our own block, but in case we can't …
       raise "Error – could not locate our ordered list" if index_back == nil
@@ -101,11 +115,11 @@ Asciidoctor::Extensions::register do
         index_back = index_back - 1
 
         # We have found our matching block
-        return list_parent.blocks[index_back] if list_parent.blocks[index_back].context == :listing
+        return all_blocks[index_back] if all_blocks[index_back].context == :listing
 
         # We have hit another callout list, but there was no list block first.
         # Assume we have an error
-        raise "Callout list found while seeking listing block" if list_parent.blocks[index_back].context == :colist
+        raise "Callout list found while seeking listing block" if all_blocks[index_back].context == :colist
 
       end
 

data/lib/version.rb

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

metadata

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