asciidoctor-foodogsquared-extensions 1.0.1 → 1.2.1

data/lib/asciidoctor/man-inline-macro/extension.rb

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-
-class ManInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
-  use_dsl
-
-  named :man
-  name_positional_attributes 'volnum'
-  default_attributes 'service' => 'debian'
-
-  def process(parent, target, attrs)
-    doc = parent.document
-    text = manname = target
-    suffix = (volnum = attrs['volnum']) ? %((#{volnum})) : ''
-
-    if doc.basebackend? 'html'
-      domain = case attrs['service']
-               when 'debian'
-                 'https://manpages.debian.org'
-               when 'arch'
-                 'https://man.archlinux.org/man'
-               when 'opensuse'
-                 'https://manpages.opensuse.org'
-               when 'voidlinux'
-                 'https://man.voidlinux.org'
-               when 'none'
-                 nil
-               else
-                 raise "no available manpage service #{attrs['service']}"
-               end
-
-      if !domain.nil?
-        target = %(#{domain}/#{manname}.#{volnum})
-        doc.register :links, target
-        node = create_anchor parent, text, type: :link, target: target
-      else
-        node = create_inline parent, :quoted, manname
-      end
-    elsif doc.backend == 'manpage'
-      node = create_inline parent, :quoted, manname, type: :strong
-    else
-      node = create_inline parent, :quoted, manname
-    end
-    create_inline parent, :quoted, %(#{node.convert}#{suffix})
-  end
-end

data/lib/asciidoctor/musicbrainz-link-inline-macro/README.adoc

@@ -1,45 +0,0 @@
-= Musicbrainz link inline macro
-:toc:
-
-
-An inline macro for easily linking objects from link:https://musicbrainz.org/doc/MusicBrainz_Database[Musicbrainz database].
-
-
-== Synopsis
-
-[source, asciidoc]
-----
-musicbrainz:$ID[$CAPTION, $TYPE]
-----
-
-- `$ID` is the database identifier for that object (e.g., `9adcff14-7dba-4ccf-a6a6-298bcde3dd46`).
-
-- `$CAPTION` is the link text.
-By default, it will be the name of the database object (if valid).
-Take note it will use the MusicBrainz API to query the title/name of the object.
-In other words, it costs an additional network request.
-
-- `$TYPE` is the database object type.
-It defaults to 'Release' object type.
-
-
-== Attributes
-
-The macro can also accept some attributes.
-
-- `caption` is the link text to be used.
-This can be used instead of the first positional attribute.
-
-- `type` is the database object type to be queried.
-This can be used instead of the second positional attribute.
-
-
-== Example usage
-
-- `musicbrainz:9adcff14-7dba-4ccf-a6a6-298bcde3dd46[]` should have a link to the link:https://musicbrainz.org/release/9adcff14-7dba-4ccf-a6a6-298bcde3dd46[Musicbrainz page for The Bindings of Isaac Rebirth] with 'The Bindings of Isaac: Rebirth' as the link caption.
-
-- `musicbrainz:9adcff14-7dba-4ccf-a6a6-298bcde3dd46[Ridiculon's Rebirth soundtrack]` same as above but with the link text replaced with 'Ridiculon's Rebirth Soundtrack'.
-
-- `musicbrainz:b7c7f603-4c42-45a4-b364-3ddba82da412[type=release-group]` links to the link:https://musicbrainz.org/release-group/b7c7f603-4c42-45a4-b364-3ddba82da412[Musicbrainz page for The Bindings of Isaac Rebirth release group] with 'The Bindings of Isaac: Rebirth' as the link text.
-
-- `musicbrainz:f07c6afe-ee84-4cd5-9b11-5c541d1dff3b[type=artist]` links to link:https://musicbrainz.org/artist/f07c6afe-ee84-4cd5-9b11-5c541d1dff3b[Musicbrainz page for Ridiculon] with their name as the caption.

data/lib/asciidoctor/musicbrainz-link-inline-macro/extension.rb

@@ -1,47 +0,0 @@
-# frozen_string_literal: true
-
-require 'json'
-require 'open-uri'
-require 'uri'
-
-class MusicBrainzLinkInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
-  use_dsl
-
-  named :musicbrainz
-  name_positional_attributes 'caption', 'type'
-  default_attributes 'type' => 'release'
-
-  def process(parent, target, attrs)
-    doc = parent.document
-    root_endpoint = 'https://musicbrainz.org/ws/2'
-
-    begin
-      headers = {
-        'Accept' => 'application/json',
-        'User-Agent' => ::Asciidoctor::FoodogsquaredCustomExtensions::USER_AGENT
-      }
-
-      uri = %(#{root_endpoint}/#{attrs['type']}/#{target})
-
-      if attrs['caption'].nil?
-        metadata = OpenURI.open_uri(uri, headers) { |f| JSON.parse(f.read) }
-        attrs['caption'] ||= case attrs['type']
-                             when 'artist', 'area', 'events', 'genre', 'instrument', 'label', 'place', 'series'
-                               metadata['name']
-                             when 'recording', 'release-group', 'release', 'cdstub', 'work'
-                               metadata['title']
-                             when 'url'
-                               metadata['resource']
-                             end
-      end
-
-      target = %(https://musicbrainz.org/#{attrs['type']}/#{target})
-      doc.register :links, target
-      create_anchor parent, attrs['caption'], type: :link, target: target
-    rescue 
-      warning = %(error while getting Musicbrainz database object '#{target}: #{e}')
-      warn_or_raise doc, warning
-      reader.push_include warning, target, target, 1, attrs
-    end
-  end
-end

data/lib/asciidoctor/package-indices-link-macro/extension.rb

@@ -1,56 +0,0 @@
-# frozen_string_literal: true
-
-# I'm fairly sure this could be programmed since Ruby has nice metaprogramming
-# capabilities. Though, we'll be keeping it manually defining classes for now
-# for initial versions since there could be additional features for each macro.
-
-class CtanLinkInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
-  use_dsl
-
-  named :ctan
-  name_positional_attributes 'caption'
-
-  def process(parent, target, attrs)
-    doc = parent.document
-    text = attrs['caption'] || target
-    url = %(https://ctan.org/pkg/#{target})
-
-    doc.register :links, url
-
-    create_anchor parent, text, type: :link, target: url
-  end
-end
-
-class PypiLinkInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
-  use_dsl
-
-  named :pypi
-  name_positional_attributes 'caption'
-
-  def process(parent, target, attrs)
-    doc = parent.document
-    text = attrs['caption'] || target
-    url = %(https://pypi.org/project/#{target})
-
-    doc.register :links, url
-
-    create_anchor parent, text, type: :link, target: url
-  end
-end
-
-class CratesIOLinkInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
-  use_dsl
-
-  named :cratesio
-  name_positional_attributes 'caption'
-
-  def process(parent, target, attrs)
-    doc = parent.document
-    text = attrs['caption'] || target
-    url = %(https://crates.io/crates/#{target})
-
-    doc.register :links, url
-
-    create_anchor parent, text, type: :link, target: url
-  end
-end

data/lib/asciidoctor/repology-link-inline-macro/README.adoc

@@ -1,27 +0,0 @@
-= Repology link inline macro
-:toc:
-
-
-An inline macro for shorthands Repology links.
-
-
-== Synopsis
-
-[source, asciidoc]
-----
-repology:$PROJECT[$CAPTION]
-----
-
-Where...
-
-- `$PROJECT` is the project name listed in link:https://repology.org/projects/[Repology's project list].
-
-- `$CAPTION` is the link text to be used.
-By default, it will use the project name.
-
-
-== Example usage
-
-- `repology:beets[]` should link to the link:https://repology.org/project/beets/[Beets project page in Repology] with `beets` as the link text.
-
-- `repology:beets[widely available in Linux distributions]` is the same as the previous item but with the link text replaced to `widely available in Linux distributions`.

data/lib/asciidoctor/repology-link-inline-macro/extension.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-class RepologyLinkInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
-  use_dsl
-
-  named :repology
-  name_positional_attributes 'caption'
-
-  def process(parent, target, attrs)
-    doc = parent.document
-    text = attrs['caption'] || target
-    url = %(https://repology.org/project/#{target})
-
-    doc.register :links, url
-
-    create_anchor parent, text, type: :link, target: url
-  end
-end

data/lib/asciidoctor/swhid-include-processor/README.adoc

@@ -1,44 +0,0 @@
-= SWHID include processor
-:toc:
-
-
-This is an include processor extension for easily fetching SWHIDs, only with the `cnt` schema type.
-
-
-== Synopsis
-
-[source, asciidoc]
-----
-\include::$SWHID[]
-----
-
-Where `$SWHID` is a link:https://docs.softwareheritage.org/devel/swh-model/persistent-identifiers.html[SWHID].
-This could accept SWHIDs with qualifiers.
-
-Take note this include processor will only give the raw content with the `cnt` schema type.
-Anything else will be skipped and log a warning instead.
-
-
-
-== Extra notes
-
-[source, asciidoc]
-----
-= doctitle
-:swhid-gpl3: swh:1:cnt:94a9ed024d3859793618152ea559a168bbcbb5e2
-
-\include::{swhid-nixpkgs}[]
-----
-
-This include processor also respects the safe mode setting.
-This means in order to permit including by SWHID, you have to permit link:https://docs.asciidoctor.org/asciidoc/latest/directives/include-uri/[includes by URIs].
-
-Lastly, this include processor uses the Software Heritage API which includes a limitation.
-You could create authorized requests by setting `SWH_API_BEARER_TOKEN` environment variable with a token.
-
-
-== Example usage
-
-- SWHID with a bare core identifier: `include::swh:1:cnt:94a9ed024d3859793618152ea559a168bbcbb5e2[]`.
-
-- SWHID with full contextual information: `include::swh:1:cnt:4c6ad635164b25b9bc2ebe17d2c3b7c0835f6035;origin=https://github.com/NixOS/nixpkgs;visit=swh:1:snp:6ea7d28dfd4789609e0be2b64179fc9c12931beb;anchor=swh:1:rev:7f5639fa3b68054ca0b062866dc62b22c3f11505;path=/README.md`.

data/lib/asciidoctor/swhid-include-processor/extension.rb

@@ -1,53 +0,0 @@
-# frozen_string_literal: true
-
-require 'json'
-require 'open-uri'
-require 'uri'
-
-class SWHIDIncludeProcessor < Asciidoctor::Extensions::IncludeProcessor
-  def handles?(target)
-    target.start_with? 'swh:'
-  end
-
-  def process(doc, reader, target, attributes)
-    swhid = target
-    swhid_core_identifier = swhid.split(';').at(0)
-    swhid_object_type = (swhid_core_identifier.split ':').at 2
-
-    unless (doc.safe <= Asciidoctor::SafeMode::SERVER) && (doc.attr? 'allow-uri-read')
-      raise %('swh:' include cannot be used in safe mode level > SERVER and without attribute 'allow-uri-read')
-    end
-
-    # We're already going to throw out anything that is not content object type
-    # just to make the later pipelines easier to construct.
-    if swhid_object_type != 'cnt'
-      warn %(SWHID '#{swhid_core_identifier}' is not of 'cnt' type; ignoring)
-      return reader
-    end
-
-    version = '1'
-
-    content = begin
-      uri = URI.parse %(https://archive.softwareheritage.org/api/#{version}/resolve/#{target}/)
-
-      headers = {
-        'Accept' => 'application/json'
-      }
-
-      headers['Authorization'] = "Bearer #{ENV['SWH_API_BEARER_TOKEN']}" if ENV['SWH_API_BEARER_TOKEN']
-
-      metadata = OpenURI.open_uri(uri, headers) { |f| JSON.parse(f.read) }
-      object_hash = metadata['object_id']
-
-      uri = URI.parse %(https://archive.softwareheritage.org/api/#{version}/content/sha1_git:#{object_hash}/raw/)
-      OpenURI.open_uri(uri, headers, &:read)
-    rescue OpenURI::HTTPError => e
-      warning = %(error while getting '#{swhid_core_identifier}': #{e})
-      warn warning
-      warning
-    end
-
-    reader.push_include content, target, target, 1, attributes
-    reader
-  end
-end

data/lib/asciidoctor/swhid-inline-macro/README.adoc

@@ -1,54 +0,0 @@
-= SWHID inline macro extension
-:toc:
-
-
-An inline macro for easily linking link:https://docs.softwareheritage.org/devel/swh-model/persistent-identifiers.html[SWHIDs].
-
-
-== Synopsis
-
-[source, asciidoc]
-----
-swh:$SWHID[$CAPTION]
-----
-
-If no caption is given, the link text will be the core identifier of the SWHID.
-
-
-== Attributes
-
-You can configure certain behavior of the macro with the link:https://docs.asciidoctor.org/asciidoc/latest/attributes/options/[options attribute].
-Here's a list of them...
-
-- `full` will make the entire SWHID as the default link text.
-
-
-== Extra notes
-
-You would use like in the following form `swh:swh:1:snp:6ea7d28dfd4789609e0be2b64179fc9c12931beb[]` but you could also cut off `swh:` from the SWHID if you want to (i.e., `swh:1:snp:6ea7d28dfd4789609e0be2b64179fc9c12931beb[]`) to make it aesthetically pleasing.
-
-Whatever your preference is, the best practice for dealing with linking SWHIDs with this macro is setting attributes containing the SWHIDs.
-
-[source, asciidoc]
-----
-= doctitle
-:swhid-nixpkgs: swh:1:dir:2885ecf76632a83610d8e95f0eb3383109a7c90a
-
-{swhid-nixpkgs}[this revision of nixpkgs]
-or
-swh:{swhid-nixpkgs}[that revision of nixpkgs]
-----
-
-
-== Example usage
-
-This should work with the following types of SWHIDs.
-
-- A SWHID with only the core identifier: `swh:1:snp:6ea7d28dfd4789609e0be2b64179fc9c12931beb[]`.
-
-- A SWHID with only one qualifier with a link caption: `swh:1:cnt:ce4dd1988d2d5dfcec48252757a6fea94339ac38;lines=3-4[some code text]`
-
-- A SWHID with full contextual information.
-This is as depicted from the recommended practice for writings (i.e., blog posts, technical documentation, research papers) when referring to one of the objects in the archive.
-+
-`swh:1:dir:2885ecf76632a83610d8e95f0eb3383109a7c90a;origin=https://github.com/NixOS/nixpkgs;visit=swh:1:snp:6ea7d28dfd4789609e0be2b64179fc9c12931beb;anchor=swh:1:rev:b7ee21d0ced814d07b7d5aca334dfe018ceafaa5[]`

data/lib/asciidoctor/swhid-inline-macro/extension.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-class SWHInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
-  use_dsl
-
-  named :swh
-  name_positional_attributes 'caption'
-
-  def process(parent, target, attrs)
-    doc = parent.document
-
-    # We're only considering `swh:` starting with the scheme version. Also, it
-    # looks nice aesthetically.
-    swhid = target.start_with?('swh:') ? target : %(swh:#{target})
-    default_caption = if attrs.key? 'full-option'
-                        swhid
-                      else
-                        swhid.split(';').at(0)
-                      end
-    text = attrs['caption'] || default_caption
-    target = %(https://archive.softwareheritage.org/#{swhid})
-
-    doc.register :links, target
-    create_anchor parent, text, type: :link, target: target
-  end
-end

data/lib/asciidoctor/wikipedia-inline-macro/README.adoc

@@ -1,30 +0,0 @@
-= Wikipedia inline macro
-:toc:
-
-
-An inline macro for easily creating Wikipedia links (i.e., `wikipedia.org`).
-
-
-== Synopsis
-
-[source, asciidoc]
-----
-wikipedia:PAGE[$CAPTION]
-----
-
-Where if `$CAPTION` is present, it will be used as the link text.
-Otherwise, it will just be the page.
-
-
-== Attributes
-
-- `lang` is the language domain to be linked into.
-By default, it is set to `en`.
-
-
-== Example usage
-
-- `wikipedia:Diff[]` should link to the link:https://en.wikipedia.org/wiki/Diff[Diff page on English Wikipedia].
-- `wikipedia:Diff[lang=ja]` should link to the link:https://ja.wikipedia.org/wiki/Diff[Diff page on Japanese Wikipedia].
-- `wikipedia:Photosynthesis[lang=simple]` should link to the link:https://simple.wikipedia.org/wiki/Photosynthesis[Photosynthesis page on Simple English Wikipedia].
-- `wikipedia:Diff[diff in Japanese Wikipedia, lang=ja]` should link to the link:https://ja.wikipedia.org/wiki/Diff[Diff page on Japanese Wikipedia] with the `diff in Japanese Wikipedia` as the link text.

data/lib/asciidoctor/wikipedia-inline-macro/extension.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-require 'uri'
-
-class WikipediaInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
-  use_dsl
-
-  named :wikipedia
-  name_positional_attributes 'caption'
-  default_attributes 'lang' => 'en'
-
-  def process(parent, target, attrs)
-    caption = attrs['caption'] || target
-    parser = URI::Parser.new
-    page = parser.escape target
-    link = %(https://#{attrs['lang']}.wikipedia.org/wiki/#{page})
-    node = create_anchor parent, caption, type: :link, target: link
-
-    create_inline parent, :quoted, node.convert
-  end
-end