asciidoctor-foodogsquared-extensions 1.0.0

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

@@ -0,0 +1,53 @@
+# 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

@@ -0,0 +1,54 @@
+= 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

@@ -0,0 +1,26 @@
+# 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

@@ -0,0 +1,30 @@
+= 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

@@ -0,0 +1,21 @@
+# 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

data/lib/asciidoctor-foodogsquared-extensions.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'asciidoctor/foodogsquared-extensions'

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: asciidoctor-foodogsquared-extensions
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Gabriel Arazas
+autorequire:
+bindir: bin
+cert_chain: []
+date: 1980-01-01 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'
+- !ruby/object:Gem::Dependency
+  name: rugged
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: |2
+      foo-dogsquared's custom Asciidoctor extensions as a Gem. This is not meant
+      to be used in production or as a public Gem. This is used since Hugo
+      doesn't allow loading Asciidoctor extensions with path separators.
+email: foodogsquared@foodogsquared.one
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- asciidoctor-foodogsquared-extensions.gemspec
+- lib/asciidoctor-foodogsquared-extensions.rb
+- lib/asciidoctor/chat-block-processor/README.adoc
+- lib/asciidoctor/chat-block-processor/extension.rb
+- lib/asciidoctor/fdroid-link-inline-macro/README.adoc
+- lib/asciidoctor/fdroid-link-inline-macro/extension.rb
+- lib/asciidoctor/flathub-link-inline-macro/README.adoc
+- lib/asciidoctor/flathub-link-inline-macro/extension.rb
+- lib/asciidoctor/foodogsquared-extensions.rb
+- lib/asciidoctor/git-blob-include-processor/README.adoc
+- lib/asciidoctor/git-blob-include-processor/extension.rb
+- lib/asciidoctor/github-link-inline-macro/README.adoc
+- lib/asciidoctor/github-link-inline-macro/extension.rb
+- lib/asciidoctor/github-raw-content-include-processor/README.adoc
+- lib/asciidoctor/github-raw-content-include-processor/extension.rb
+- lib/asciidoctor/gitlab-link-inline-macro/README.adoc
+- lib/asciidoctor/gitlab-link-inline-macro/extension.rb
+- lib/asciidoctor/gitlab-raw-content-include-processor/README.adoc
+- lib/asciidoctor/gitlab-raw-content-include-processor/extension.rb
+- lib/asciidoctor/helpers.rb
+- lib/asciidoctor/ietf-rfc-link-inline-macro/README.adoc
+- lib/asciidoctor/ietf-rfc-link-inline-macro/extension.rb
+- lib/asciidoctor/man-inline-macro/README.adoc
+- lib/asciidoctor/man-inline-macro/extension.rb
+- lib/asciidoctor/musicbrainz-link-inline-macro/README.adoc
+- lib/asciidoctor/musicbrainz-link-inline-macro/extension.rb
+- lib/asciidoctor/package-indices-link-macro/extension.rb
+- lib/asciidoctor/repology-link-inline-macro/README.adoc
+- lib/asciidoctor/repology-link-inline-macro/extension.rb
+- lib/asciidoctor/swhid-include-processor/README.adoc
+- lib/asciidoctor/swhid-include-processor/extension.rb
+- lib/asciidoctor/swhid-inline-macro/README.adoc
+- lib/asciidoctor/swhid-inline-macro/extension.rb
+- lib/asciidoctor/wikipedia-inline-macro/README.adoc
+- lib/asciidoctor/wikipedia-inline-macro/extension.rb
+homepage:
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/foo-dogsquared/foo-dogsquared.github.io
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.14
+signing_key:
+specification_version: 4
+summary: foo-dogsquared's custom Asciidoctor extensions
+test_files: []