asciidoctor-foodogsquared-extensions 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6a55ecb1f3ae045ca8f031f4aa860ac4f41e1d496fa870267a2b58bc95da210f
-  data.tar.gz: ed560382c0fa5f713c90141dc2365332dddcc9a0020f9c7889372b93c405a421
+  metadata.gz: 903ca29ce450d3aad60571b57c851fbfcf11524f9fcda8ae3ba388e9c619fdf0
+  data.tar.gz: 405bfafa852a1bc66ebf46c1242bee986cc949c78289d699c987dacda17feac0
 SHA512:
-  metadata.gz: 0ba15527bab757745d67ec082b4afff429d712b9d727bf01bb4725177e7b0d138e68c8ff9a5428cd9b2c562a81258d24637cdc6b58125b660a68873155bd21c5
-  data.tar.gz: be6a519a1417b082d571f806c115942c338fce4296e95bf9bf8e8cc658fbe59afba7ef321e683bd2e986d30eb0aea668b4d6ca2727416e092ce5d7688865c8ea
+  metadata.gz: 63bc0807247b017729d2b4177796a32ffa34635fb373020552028827ff3b4cfdcea22c958e1abeb084f2c6f6d3e44a5bd154b6e5c479af94425e86c69aeed067
+  data.tar.gz: bed6effd30c18654a20582ddb383c249ed6f6ddf83ee751c10e4f1f01c98ab0551b7e3fcb095997893a16bf6bfa05e91f28d37986923c59b7fb6190882c5997f

data/CHANGELOG.adoc

@@ -8,6 +8,37 @@
 The guidelines for writing this changelog is based from link:https://common-changelog.org[Common Changelog].
 
 
+== [1.1.0] - 2023-11-01
+
+=== Removed
+
+* Remove preprocessor extension from Git blob include processor.
+Thus, `doccontentref` document attribute has been removed. ({commit-url}/a95b09a81f623554e4e747063befcf5a14fd060e[`a95b09a`]) (Gabriel Arazas)
+
+=== Updated
+
+* Update the default behavior of several extensions where it will create a network request in all cases, not just when the caption is unset.
+It will now throw an error once it detected no object given from a service.
+These extensions are the Flathub link inline macro, the F-Droid link inline macro, and the MusicBrainz link inline macro.
+For example, `flathub:com.example.NonExistentApp[example app]` will now throw an error since the given app doesn't exist from Flathub. ({commit-url}/924fd9eac5653a14d6105bc8f27f99fabe955f98[`924fd9e`]) (Gabriel Arazas)
+
+* Revise the default text for manpages for man inline macro. ({commit-url}/928cd80561957a529551e42cad8123840aa6afa0[`928cd80`]) (Gabriel Arazas)
+
+=== Added
+
+* Add 'openbsd' option for man inline macro for easily linking manpages from https://man.openbsd.org. ({commit-url}/fcb06be49fba5d3251e6c68e5fdaf934034dcf41[`fcb06be`]) (Gabriel Arazas)
+
+* Add 'issue' option for GitLab link inline macro enabling users to link to issues from GitLab instances easily. ({commit-url}/cf8a942011cbd6b26785689d0ee4b8eff67f947e[`cf8a942`]) (Gabriel Arazas)
+
+=== Fixed
+
+* Fix the Git repo discovery processor of the Git blob include processor with `gitrepo` attribute.
+By default, it will try to discover it through the base directory of the document. ({commit-url}/a95b09a81f623554e4e747063befcf5a14fd060e[`a95b09a`]) (Gabriel Arazas)
+
+* Make the extensions inherit part of the parent's (or if possible, the document) attributes.
+This should fix some things such as setting the `avatarstype` document attribute for chat block processor extension. ({commit-url}/de3ced3d3a237870f9d57279649db71feaba975c[`de3ced3`]) (Gabriel Arazas)
+
+
 == [1.0.1] - 2023-07-09
 
 === Updated

data/asciidoctor-foodogsquared-extensions.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name          = 'asciidoctor-foodogsquared-extensions'
-  s.version       = '1.0.1'
+  s.version       = '1.1.0'
   s.licenses      = ['MIT']
   s.summary       = "foo-dogsquared's custom Asciidoctor extensions"
   s.description   = <<-DESC
@@ -19,4 +19,6 @@ Gem::Specification.new do |s|
 
   s.add_runtime_dependency 'asciidoctor', '~> 2.0'
   s.add_runtime_dependency 'rugged', '~> 1.0'
+
+  s.add_development_dependency 'rspec', '~> 3.0'
 end

data/lib/asciidoctor/chat-block-processor/extension.rb

@@ -17,13 +17,15 @@ class ChatBlock < Asciidoctor::Extensions::BlockProcessor
     # contains two output: the dialog image of our avatar and its content.
     attrs['name'] ||= attrs['avatar']
 
-    block << (create_html_fragment block, %(
+    block << (create_html_fragment block, <<~HTML
       <div role="figure" class="dialogblock dialogblock__box dialogblock__avatar--#{attrs['avatar']} #{attrs['role']}">
         <div class="dialogblock dialogblock__avatar">
-    ))
+    HTML
+
+             )
 
     attrs['avatarsdir'] ||= File.expand_path('./avatars', attrs['iconsdir'])
-    attrs['avatarstype'] ||= 'avif'
+    attrs['avatarstype'] ||= parent.attributes['avatarstype'] || 'avif'
 
     avatar_sticker = "#{attrs['avatar'].to_kebab}/#{attrs['state'].to_kebab}.#{attrs['avatarstype']}"
     avatar_img_attrs = {
@@ -33,18 +35,20 @@ class ChatBlock < Asciidoctor::Extensions::BlockProcessor
     avatar_imgblock = create_image_block block, avatar_img_attrs
 
     block << avatar_imgblock
-    block << (create_html_fragment block, %(
+    block << (create_html_fragment block, <<~HTML
         </div>
         <div class="dialogblock dialogblock__text">
           <small class="dialogblock dialogblock__avatar-name">#{attrs['name']}</small>
-    ))
+    HTML
+             )
 
     parse_content block, reader
 
-    block << (create_html_fragment block, %(
+    block << (create_html_fragment block, <<~HTML
         </div>
       </div>
-    ))
+    HTML
+             )
 
     block
   end

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

@@ -16,10 +16,8 @@ class FDroidLinkInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
     app_id = target
     app_metadata_uri = %(https://gitlab.com/fdroid/fdroiddata/-/raw/master/metadata/#{app_id}.yml)
 
-    if attrs['caption'].nil?
-      metadata = OpenURI.open_uri(app_metadata_uri) { |f| YAML.safe_load(f.read) }
-      attrs['caption'] = metadata['AutoName']
-    end
+    metadata = OpenURI.open_uri(app_metadata_uri) { |f| YAML.safe_load(f.read) }
+    attrs['caption'] ||= metadata['AutoName']
 
     url = %(https://f-droid.org/#{attrs['lang']}/packages/#{app_id})
     doc.register :links, url

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

@@ -23,10 +23,8 @@ class FlathubLinkInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
       'User-Agent' => ::Asciidoctor::FoodogsquaredCustomExtensions::USER_AGENT
     }
 
-    if attrs['caption'].nil?
-      metadata = OpenURI.open_uri(app_metadata_uri, headers) { |f| JSON.parse(f.read) }
-      attrs['caption'] = metadata['name']
-    end
+    metadata = OpenURI.open_uri(app_metadata_uri, headers) { |f| JSON.parse(f.read) }
+    attrs['caption'] ||= metadata['name']
 
     url = %(https://flathub.org/apps/#{app_id})
     doc.register :links, url

data/lib/asciidoctor/foodogsquared-extensions.rb

@@ -37,7 +37,6 @@ Asciidoctor::Extensions.register do
   include_processor GitLabRawIncludeProcessor
 
   include_processor GitBlobIncludeProcessor
-  preprocessor GitContentBranchAttributePreprocessor
 
   inline_macro WikipediaInlineMacro
 

data/lib/asciidoctor/git-blob-include-processor/README.adoc

@@ -23,6 +23,9 @@ If the resulting operation ends in an error (i.e., non-existing revision, file,
 
 == Attributes
 
+- `gitrepo` is the path to the Git repo.
+By default, it is the base directory of the document.
+
 - `path` is the filepath to be retrieved from the revision.
 When used with `diff`, it changes into a semicolon-delimited (`;`) list of files to make diffs with multiple files.
 
@@ -43,25 +46,11 @@ You can give the following options through `opts` attribute (i.e., `opts="diff,r
 - `reverse` reverses the sides to be compared.
 
 
-== Extra notes
-
-The extension is composed of two parts: an include processor and a preprocessor.
-
-The preprocessor add a document attribute, `doccontentref`, which it gives the Git reference for that content.
-`doccontentref` is the difference between the process working directory (`Dir.pwd`) and the base directory of the content to be converted.
-In case the process working directory is not entirely consistent for several reasons, you could give the attribute `rootdir` as the basis for the comparison.
-As another option, you could also manually set `doccontentref` in case it isn't applicable (i.e., for multilingual sites in Hugo projects).
-
-The include processor also accepts an empty target with the prefix (i.e., `include::git:[]`) as a shorthand for `include::git:{doccontentref}`.
-
-
 == Example usage
 
-The following examples assume that `doccontentref` points to `content/posts/sample`.
-
 - `include::git:HEAD[path=shell.nix]` should transclude the current iteration of `shell.nix`.
 
-- `include::git:{doccontentref}[opts="diff", path=Gemfile]` should include a diff of the Gemfile from `content/posts/sample` branch (assuming that Gemfile has changed).
+- `include::git:v1.0.0[opts="diff", path=Gemfile]` should include a diff of the Gemfile from `content/posts/sample` branch (assuming that Gemfile has changed).
 
 - `include::git:non-existing-rev[opts="diff"]` should result in a warning with the non-existing revision.
 

data/lib/asciidoctor/git-blob-include-processor/extension.rb

@@ -8,7 +8,8 @@ class GitBlobIncludeProcessor < Asciidoctor::Extensions::IncludeProcessor
   end
 
   def process(doc, reader, target, attrs)
-    repo = Rugged::Repository.discover(__dir__)
+    attrs['gitrepo'] ||= doc.attributes['gitrepo'] || doc.base_dir
+    repo = Rugged::Repository.discover(attrs['gitrepo'])
 
     git_object_ref = target.delete_prefix 'git:'
     git_object_ref = doc.attributes['doccontentref'] if git_object_ref.empty?
@@ -63,17 +64,3 @@ class GitBlobIncludeProcessor < Asciidoctor::Extensions::IncludeProcessor
     reader
   end
 end
-
-class GitContentBranchAttributePreprocessor < Asciidoctor::Extensions::Preprocessor
-  def process(document, reader)
-    base_dir = Pathname.new(document.base_dir)
-    rootdir = if document.attributes['rootdir'].nil?
-                Dir.pwd
-              else
-                document.attributes['rootdir']
-              end
-
-    document.attributes['doccontentref'] = base_dir.relative_path_from(rootdir).to_s
-    reader
-  end
-end

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

@@ -23,6 +23,9 @@ By default. it doesn't point to anything which should be in the default branch o
 
 - `path` is the filepath to be linked.
 
+- `issue` is the issue to be linked from the repo.
+Take note issue has higher precedence so once `domain` and `issue` are both set, it will still link to an issue.
+
 There are settings that is enabled with the link:https://docs.asciidoctor.org/asciidoc/latest/attributes/options/[options attribute].
 
 - `repo` sets the default caption to be the repo part.

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

@@ -20,8 +20,14 @@ class GitLabLinkInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
     text = attrs['caption'] || default_caption
     uri = URI.parse %(https://#{attrs['domain']}/#{target})
 
-    uri.path += %(/-/tree/#{attrs['rev']}) if attrs['rev']
-    uri.path += %(/#{attrs['path']}) if attrs['path']
+    if attrs.key? 'issue'
+      uri.path += %(/-/issues/#{attrs['issue']})
+      text << "##{attrs['issue']}" if text == target
+    else
+      uri.path += %(/-/tree/#{attrs['rev']}) if attrs.key? 'rev'
+      uri.path += %(/#{attrs['path']}) if attrs.key? 'path'
+      text << "@#{attrs['rev']}" if attrs.key?('rev') && text == target
+    end
 
     target = uri.to_s
 

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

@@ -9,8 +9,10 @@ class ManInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
 
   def process(parent, target, attrs)
     doc = parent.document
-    text = manname = target
-    suffix = (volnum = attrs['volnum']) ? %((#{volnum})) : ''
+    manname = target
+    volnum = attrs['volnum']
+
+    text = %(#{manname}(#{volnum}))
 
     if doc.basebackend? 'html'
       domain = case attrs['service']
@@ -22,6 +24,8 @@ class ManInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
                  'https://manpages.opensuse.org'
                when 'voidlinux'
                  'https://man.voidlinux.org'
+               when 'openbsd'
+                 'https://man.openbsd.org'
                when 'none'
                  nil
                else
@@ -33,13 +37,14 @@ class ManInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
         doc.register :links, target
         node = create_anchor parent, text, type: :link, target: target
       else
-        node = create_inline parent, :quoted, manname
+        node = create_inline parent, :quoted, text
       end
     elsif doc.backend == 'manpage'
-      node = create_inline parent, :quoted, manname, type: :strong
+      node = create_inline parent, :quoted, text, type: :strong
     else
-      node = create_inline parent, :quoted, manname
+      node = create_inline parent, :quoted, text
     end
-    create_inline parent, :quoted, %(#{node.convert}#{suffix})
+
+    node
   end
 end

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

@@ -23,17 +23,15 @@ class MusicBrainzLinkInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
 
       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
+      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
 
       target = %(https://musicbrainz.org/#{attrs['type']}/#{target})
       doc.register :links, target

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

@@ -0,0 +1,26 @@
+= SPDX link inline macro
+:toc:
+
+It's an inline macro for easily creating licenses from SPDX license data.
+
+
+== Synopsis
+
+[source, asciidoc]
+----
+spdx:$LICENSE_ID[$CAPTION]
+----
+
+Where...
+
+* `$LICENSE_ID` is the identifier for the license.
+
+* `$CAPTION` is the link caption to be used.
+By default, it will use the name of the license.
+
+
+== Example usage
+
+* `spdx:MIT[]` will result to the link:https://spdx.org/licenses/MIT.html[MIT license page on SPDX] with the caption `MIT License`.
+
+* `spdx:MIT[the MIT license]` is the same as the previous example but with a different caption of `the MIT license`.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-foodogsquared-extensions
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Gabriel Arazas
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 description: |2
       foo-dogsquared's set of Asciidoctor extensions as a Gem. This is where I
       implemented several pet features that will most likely never be a part of
@@ -79,6 +93,7 @@ files:
 - 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/spdx-link-inline-macro/README.adoc
 - lib/asciidoctor/swhid-include-processor/README.adoc
 - lib/asciidoctor/swhid-include-processor/extension.rb
 - lib/asciidoctor/swhid-inline-macro/README.adoc