asciidoctor-external-callout 0.0.6.pre.beta7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 910479158955009faec89ab7797f5b30c5d97aff3433c276fb6bc34d0f1e10c2
+  data.tar.gz: e082c0a766caa8a2cd5f5f60f8063052f75ca398b2a6933afc06eb581c9c1e48
+SHA512:
+  metadata.gz: ce3c945787e12aef49a863250cbdab404e5a2c0ee7396c81c8a969829b724506c0c5cfec3bb42a407cac9bb017d03bb4d1979fd11d0539ee466339648f52f4a4
+  data.tar.gz: 4bf8d47eb9008153011617d1e3438b7c8bff86d1e70a0686dd8494f543fac7dc4f72c7cd75d4c8ae02b9a95ddea30f8ad665a4f23e7a208775e9e6f6fa5dd145

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea
+**/sample.html
+*.gem
+/Gemfile.lock
+/.asciidoctor

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+
+Record of bug fixes, enhancements, and changes.
+
+## [0.0.6-beta6] – 2022-06-11
+
+### Changed
+
+- Ordered lists were only processes if they occurred directly beneath a source listing block. This turns out to be quite restrictive, and doesn't follow Asciidoc's stance on processing standard callouts, which allows for intermediate blocks to separate the source list from the attached callout list.\
+  The processor will now allow intermediate blocks to separate the source listing from the ordered list containing callouts.
+- Fixed  a few spelling mistakes and a code line where I was picking up a formatted item, rather than a raw item.
+

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at ray.offiah@couchbase.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in asciidoctor-external-callout.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Ray Offiah
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,97 @@
+# Asciidoctor External Callout
+
+## Description
+
+An [Asciidoctor](https://asciidoctor.org/) extension which adds support for callout tags added outside the listing block.
+
+## Motivation
+
+Aside from getting little practice around  Ruby and JavaScript, I decided to have a crack at this to help with a problem that comes up at work every so often.
+
+The [callout mechanism](https://docs.asciidoctor.org/asciidoc/latest/verbatim/callouts/) for Asciidoc works extremely well in 99% of the cases I run into:
+
+```asciidoc
+[source,ruby]
+----
+require 'sinatra' #<1>
+
+get '/hi' do #<2> #<3>
+"Hello World!"
+end
+----
+<1> Library import
+<2> URL mapping
+<3> Response block
+```
+
+
+Great, but it does mean you have to add commented to the tags to the source code to register the callout in the following block. As I've said, this is fine, 99% of the time, but I've run across a few occasions when adding tags to the source code (either in-line or an included file) can be a little problematic:
+
+1. Restricted access to the source code: as a humble tech-writer, you might not have access to the included source code to add your own tags.
+1. The source code has to remain runnable, but doesn't have a commenting mechanism that works well with Asciidoc (shell scripts amd json files spring to mind.)
+
+## A possible Solution
+
+And that's where this extension comes in: it adds support adding tags outside the source listing block, like this:
+
+```asciidoc
+[source,ruby]
+----
+require 'sinatra'
+
+get '/hi' do
+  "Hello World!"
+end
+----
+. Library import @3
+. URL mapping @5
+. Response block @5
+-----
+```
+
+Rather than tagging the code, you add a location token at the end of a list item, which will then add the tag at the specified line number. Run the source text through Asciidoctor+extension, and it'll spit the same source block complete with callouts.
+
+Two types of location token are supported:
+
+@_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_/
+: 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.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'asciidoctor-external-callout'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install asciidoctor-external-callout
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Asciidoctor::External::Callout project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/asciidoctor-external-callout/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test

data/asciidoctor-external-callout.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative "lib/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "asciidoctor-external-callout"
+  spec.version       = Asciidoctor::External::Callout::VERSION
+  spec.authors       = ["Ray Offiah"]
+  spec.email         = ["clogs-wrench-0z@icloud.com"]
+
+  spec.summary       = "Asciidoc extension for adding callouts without marking up the source listing block."
+  # spec.description   = "TODO: Write a longer description or delete this line."
+  spec.homepage      = "https://github.com/RayOffiah/asciidoctor-external-callout-ruby"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/RayOffiah/asciidoctor-external-callout-ruby"
+  spec.metadata["changelog_uri"] = "https://github.com/RayOffiah/asciidoctor-external-callout-ruby/blob/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+
+  spec.add_dependency "asciidoctor", "~>2.0"
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "asciidoctor/external/callout"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/asciidoctor-external-callout.rb

@@ -0,0 +1,201 @@
+require 'asciidoctor/extensions' unless RUBY_ENGINE == 'opal'
+
+include Asciidoctor
+
+# Treeprocessor that adds external callout marks to source code
+#
+# [source, ruby]
+# ----
+# puts 'Hello World'
+# puts 'Hello again'
+# ---
+# 1. Saying hello @1
+# 2. And again @2
+# 3. Text search @/again/
+
+Asciidoctor::Extensions::register do
+
+  LOCATION_TOKEN_RX = /@(\d+)|@\/([^\/]+?)\//
+  LOCATION_TOKEN_ARRAY_RX = /^(@\d+|@\/[^\/]+?\/)((\s+@\d+)|(\s+@\/[^\/]+?\/))*$/
+
+  tree_processor do
+
+    process do |document|
+
+      begin
+        # set the traverse_documents option to look for ordered lists
+        # The makes sure it's the right kind of list.
+        document.find_by context: :olist do |list|
+
+          if external_callout_list? list
+
+            owner_block = owning_block list
+
+            owner_block.subs.replace(owner_block.subs + [:callouts]).uniq
+
+            process_callouts(list, owner_block)
+
+            list.context = :colist
+
+          end
+
+        end
+
+      rescue => e
+        warn e.message
+      ensure
+
+        document
+
+      end
+
+    end
+
+    # Checks the format of the list
+    # to make sure it's a callout list we should be
+    # dealing with.
+    # We also won't want any nested lists.
+    def external_callout_list?(list)
+
+      list.blocks.all? do |x|
+
+        item_under_test = x.instance_variable_get(:@text)
+        location_token_index = item_under_test.index(LOCATION_TOKEN_RX)
+
+        # if we don't find the start of the list of location tokens, or the token is the first item
+        # then we don't need to carry on any further; this is not the list we are looking for.
+        return false if location_token_index == nil or location_token_index == 0
+
+        # just look at the string of location tokens.
+        location_tokens = item_under_test[location_token_index..-1].strip
+        location_tokens.match(LOCATION_TOKEN_ARRAY_RX) && x.blocks.empty?
+
+      end
+
+    end
+
+    # Have a look at the next level up
+    # to find the block that our CO list belongs to
+    def owning_block(list)
+
+      list_parent = list.parent
+
+      raise "There is no block above the callout list" if list_parent == nil
+
+      index_back = list_parent.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
+
+      while index_back > 0
+
+        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
+
+        # 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
+
+      end
+
+      # If we didn't find a listing then this document has probably got
+      # bits missing.
+      raise "No listing found"
+
+    end
+
+    def find_list_index_for_item (list_item)
+
+      list = list_item.parent
+
+      list_numeral = 1
+      index_of_this_item = list.blocks.index { |x| x == list_item }
+      index_of_this_item.times { list_numeral = list_numeral.next }
+      list_numeral
+
+    end
+
+    def process_callouts(list, owner_block)
+      list.blocks.each do |list_item|
+
+        # Don't call `list_item.text` because this returns
+        # the string in a formatted form. We want the
+        # raw string, so go straight to the instance variable.
+        item = list_item.instance_variable_get(:@text)
+
+        # No need to test the matcher; we tested
+        # the whole block of items when we started
+
+        location_token_index = item.index(LOCATION_TOKEN_RX)
+        location_tokens = item[location_token_index..-1].strip
+        phrase = item[0..location_token_index - 1].strip
+
+        locations = location_tokens.scan(LOCATION_TOKEN_RX).flatten.compact
+
+        line_numbers = Set.new
+
+        locations.each do |location|
+
+          if location.is_numeric?
+
+            number = location.to_i
+
+            if number <= owner_block.lines.length
+              line_numbers << (number - 1)
+            else
+              warn "Out of range ==> #{number}"
+            end
+
+          else
+
+            # Must be a string matcher then
+
+            number = find_matching_lines(location, owner_block)
+
+            if number != nil
+
+              line_numbers << number
+
+            else
+              warn "Search term not found ==> #{location}"
+            end
+
+          end
+
+        end
+
+        line_numbers.each do |line_number|
+
+          callout = find_list_index_for_item(list_item)
+          owner_block.lines[line_number] += " <#{callout}>"
+
+        end
+
+        list_item.text = phrase
+
+      end
+
+    end
+
+    def find_matching_lines(search_string, owner_block)
+
+      owner_block.lines.index { |x| x.match(%r[#{search_string}]) }
+
+    end
+
+    class String
+      def is_numeric?
+        self.match(/^\d+$/)
+      end
+    end
+
+  end
+
+end
+
+
+
+
+

data/lib/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Asciidoctor
+  module External
+    module Callout
+      VERSION = "0.0.6-beta7"
+    end
+  end
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: asciidoctor-external-callout
+version: !ruby/object:Gem::Version
+  version: 0.0.6.pre.beta7
+platform: ruby
+authors:
+- Ray Offiah
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-06-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: asciidoctor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description:
+email:
+- clogs-wrench-0z@icloud.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- asciidoctor-external-callout.gemspec
+- bin/console
+- bin/setup
+- lib/asciidoctor-external-callout.rb
+- lib/version.rb
+homepage: https://github.com/RayOffiah/asciidoctor-external-callout-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/RayOffiah/asciidoctor-external-callout-ruby
+  source_code_uri: https://github.com/RayOffiah/asciidoctor-external-callout-ruby
+  changelog_uri: https://github.com/RayOffiah/asciidoctor-external-callout-ruby/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: Asciidoc extension for adding callouts without marking up the source listing
+  block.
+test_files: []