asciidoctor-foodogsquared-extensions 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f9f519d0ae3e0ac0e73c26e85acb925d53b9b937019d0361ee82b47fa4f8466a
-  data.tar.gz: b25430e1aeb1dee8b2563dc859a45879ed283698e4cdadef73f534a9a9876aaa
+  metadata.gz: 6a55ecb1f3ae045ca8f031f4aa860ac4f41e1d496fa870267a2b58bc95da210f
+  data.tar.gz: ed560382c0fa5f713c90141dc2365332dddcc9a0020f9c7889372b93c405a421
 SHA512:
-  metadata.gz: 307b4db3e7bc66f0ea323344fb177d90c65c3141aa714891277b76cfb656fc501f7ca7e9788e7dbeee7141637e2ec0cea2d0f13b409679f854840ae1b76c0163
-  data.tar.gz: 63dfa05bd984ea781cb53791a155303e162c1b6b6f582140b28f1804bc20c86fdeee7aaae523c5ec410266417130dba8852801b50d2cc5cc1e727e656a530b9a
+  metadata.gz: 0ba15527bab757745d67ec082b4afff429d712b9d727bf01bb4725177e7b0d138e68c8ff9a5428cd9b2c562a81258d24637cdc6b58125b660a68873155bd21c5
+  data.tar.gz: be6a519a1417b082d571f806c115942c338fce4296e95bf9bf8e8cc658fbe59afba7ef321e683bd2e986d30eb0aea668b4d6ca2727416e092ce5d7688865c8ea

data/CHANGELOG.adoc

@@ -0,0 +1,48 @@
+= Changelog
+:toc:
+
+:github-repo: asciidoctor-foodogsquared-extensions
+:commit-url: https://github.com/foo-dogsquared/{github-repo}/commit
+
+
+The guidelines for writing this changelog is based from link:https://common-changelog.org[Common Changelog].
+
+
+== [1.0.1] - 2023-07-09
+
+=== Updated
+
+* Update the gem metadata. (link:{commit-url}/b052cddf56397489c4eb9c7908bfbadbce2c080f[`b052cddf`]) (Gabriel Arazas)
+
+=== Fixed
+
+* Fix the `avatarstype` attribute override for the chat block extension.
+This is considered a bug since it is more intended as a project-wide attribute. (link:{commit-url}/1faf4d45ec9891532254867c219ffb5094781948[`1faf4d45`]) (Gabriel Arazas)
+
+
+== [1.0.0] - 2023-07-07
+
+The initial version of the extension set.
+
+=== Added
+
+* Add `man:` inline macro for online manual pages (link:{commit-url}/4201e1c6e8a028618ab4cb4c6e54af5c3990aa27[`4201e1c6e`] footnote:[Hehe...]) (Gabriel Arazas)
+* Add `rfc:` inline macro for IETF RFCs (link:{commit-url}/0def42d0675dc73ead13491d61ec0220d888462c[`0def42d0`]) (Gabriel Arazas)
+* Add `swh:` inline macro for linking SWHIDs (link:{commit-url}/e18383275ed691d992e5894301534a869e0ccded[`e18383275`]) (Gabriel Arazas)
+* Add `github:` inline macro for adding GitHub links (link:{commit-url}/d846aaa15990ed009261caa6f9d9f1b72a09a727[`d846aaa1`]) (Gabriel Arazas)
+* Add `gitlab:` inline macro for adding GitLab links (link:{commit-url}/e36e3ef452a34f985e974fc56474da1124256649[`e36e3ef45`]) (Gabriel Arazas)
+* Add `wikipedia:` inline macro for adding Wikipedia links (link:{commit-url}/fb35866b30f6266c540541ad6d5c71f58f8bd401[`fb35866b`]) (Gabriel Arazas)
+* Add `ctan:` inline macro for linking CTAN packages (link:{commit-url}/50a9c33f8c55925d690a29f9c3812a79c1a19087[`50a9c33f`]) (Gabriel Arazas)
+* Add `pypi:` inline macro for linking Pypi packages (link:{commit-url}/50a9c33f8c55925d690a29f9c3812a79c1a19087[`50a9c33f`]) (Gabriel Arazas)
+* Add `cratesio:` inline macro for linking crates.io packages (link:{commit-url}/50a9c33f8c55925d690a29f9c3812a79c1a19087[`50a9c33f`]) (Gabriel Arazas)
+* Add `flathub:` inline macro for Flathub packages (link:{commit-url}/ebbde1491c2a0df40938d507b28c6f958ce4fef2[`ebbde149`]) (Gabriel Arazas)
+* Add `fdroid:` inline macro for F-Droid apps (link:{commit-url}/7ddcd9be707833f2958da5e8ba839a0cfceefc92[`7ddcd9be`]) (Gabriel Arazas)
+* Add `musicbrainz:` inline macro for MusicBrainz database objects (link:{commit-url}/ca82f674af87363bda64d8e7795ce0a2b7ef2fe6[`ca82f674`]) (Gabriel Arazas)
+* Add `repology:` inline macro for Repology projects (link:{commit-url}/cef163c722c8af5fa7db2588cfbaf4b3a6fd1f55[`cef163c7`]) (Gabriel Arazas)
+* Add HTML-backend exclusive chat block.
+* Add include processor for SWHIDs (link:{commit-url}/567c52d80aafdd940e095bc8f3708ec4aa9a5097[`567c52d8`]) (Gabriel Arazas)
+* Add include processor for GitHub content (link:{commit-url}/88902f6540a67916eb9233ac5cfe174219017af4[`88902f65`]) (Gabriel Arazas)
+
+* Add include processor for GitLab content (link:{commit-url}/d03f1ca7008bb8928de0ec8538d8c110516b68f7[`d03f1ca7`]) (Gabriel Arazas)
+* Add include processor for Git blob objects (link:{commit-url}/02bebfef70d7b2424377bed497671ba1bc8be84d[`02bebfef`]) (Gabriel Arazas)
+* Add preprocessor as prerequisite for `GitBlobIncludeProcessor` (link:{commit-url}/02bebfef70d7b2424377bed497671ba1bc8be84d[`02bebfef`]) (Gabriel Arazas)

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2023 Gabriel Arazas <foodogsquared@foodogsquared.one>
+
+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.adoc

@@ -0,0 +1,40 @@
+= asciidoctor-foodogsquared-extensions
+:toc:
+
+
+A set of link:https://asciidoctor.org/[Asciidoctor] extensions mainly for personal use of its author (foodogsquared). :)
+
+Despite being v1.0.0, treat this as almost unstable because it is only aimed for its author.
+However, feel free to leave suggestions and improvements.
+Who knows, parts of the set might develop into a more presentable and stable extension of its own.
+
+
+== Prerequisites
+
+The extension is required to be used with Ruby 3.0 and above.
+(At least until I can test and confirm it works on the previous versions.)
+
+In order to use it, you have to install it first in your Ruby environment.
+It is available as a gem in RubyGems as `asciidoctor-foodogsquared-extensions` so you can add the following line in `Gemfile`.
+
+[source, ruby]
+----
+gem 'asciidoctor-foodogsquared-extensions'
+----
+
+Somewhere in your Ruby codebase, you can just import it with the following line.
+
+[source, ruby]
+----
+require 'asciidoctor-foodogsquared-extensions'
+----
+
+And bada-bing-bada-boom, you now have the Asciidoctor extensions.
+If installed in the environment, you can now use the extension with the following Asciidoctor command.
+
+[source, shell]
+----
+asciidoctor -r asciidoctor-foodogsquared-extensions ./document.adoc
+----
+
+For now, there's no documentation for the individual macros but you can look into the README files for each macro at link:./lib/asciidoctor/[`./lib/asciidoctor/`].

data/asciidoctor-foodogsquared-extensions.gemspec

@@ -1,21 +1,21 @@
 Gem::Specification.new do |s|
   s.name          = 'asciidoctor-foodogsquared-extensions'
-  s.version       = '1.0.0'
+  s.version       = '1.0.1'
   s.licenses      = ['MIT']
   s.summary       = "foo-dogsquared's custom Asciidoctor extensions"
   s.description   = <<-DESC
-    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.
+    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
+    Asciidoctor.
   DESC
 
   s.required_ruby_version = '>= 3.0.0'
 
   s.authors       = ['Gabriel Arazas']
   s.email         = 'foodogsquared@foodogsquared.one'
-  s.metadata      = { 'source_code_uri' => 'https://github.com/foo-dogsquared/foo-dogsquared.github.io' }
+  s.metadata      = { 'source_code_uri' => 'https://github.com/foo-dogsquared/asciidoctor-foodogsquared-extensions' }
 
-  s.files         = Dir['lib/**/*', '*.gemspec']
+  s.files         = Dir['lib/**/*', '*.gemspec', 'LICENSE', 'CHANGELOG.adoc', 'README.adoc']
 
   s.add_runtime_dependency 'asciidoctor', '~> 2.0'
   s.add_runtime_dependency 'rugged', '~> 1.0'

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

@@ -6,7 +6,7 @@ class ChatBlock < Asciidoctor::Extensions::BlockProcessor
   named :chat
   on_context :example
   name_positional_attributes 'avatar', 'state'
-  default_attributes 'state' => 'default', 'avatarstype' => 'avif'
+  default_attributes 'state' => 'default'
 
   def process(parent, reader, attrs)
     block = create_block parent, :pass, nil, attrs, content_model: :compound
@@ -23,6 +23,7 @@ class ChatBlock < Asciidoctor::Extensions::BlockProcessor
     ))
 
     attrs['avatarsdir'] ||= File.expand_path('./avatars', attrs['iconsdir'])
+    attrs['avatarstype'] ||= 'avif'
 
     avatar_sticker = "#{attrs['avatar'].to_kebab}/#{attrs['state'].to_kebab}.#{attrs['avatarstype']}"
     avatar_img_attrs = {

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-foodogsquared-extensions
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Gabriel Arazas
@@ -39,14 +39,17 @@ dependencies:
       - !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.
+      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
+      Asciidoctor.
 email: foodogsquared@foodogsquared.one
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.adoc
+- LICENSE
+- README.adoc
 - asciidoctor-foodogsquared-extensions.gemspec
 - lib/asciidoctor-foodogsquared-extensions.rb
 - lib/asciidoctor/chat-block-processor/README.adoc
@@ -86,7 +89,7 @@ homepage:
 licenses:
 - MIT
 metadata:
-  source_code_uri: https://github.com/foo-dogsquared/foo-dogsquared.github.io
+  source_code_uri: https://github.com/foo-dogsquared/asciidoctor-foodogsquared-extensions
 post_install_message:
 rdoc_options: []
 require_paths: