metanorma-plugin-asyncapi 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ea0aae0b9a7d2850a356442c84380e8d96801a770ac4fdf4949d85c79fb5ac77
+  data.tar.gz: ba4411db22f87b0b0f9ea4ab1f601c4d2042006e22e0d22922d74afa487aa248
+SHA512:
+  metadata.gz: fee0318e56771c1fb83f7747f0661707e4b924a157c29d5e3ca5c3169d0b42e1d4686bc1398fda67be256dc19556214aff18a6e71105bc6621b09a9086f1d0ef
+  data.tar.gz: 54b03d10443bf063fa3dab00104ab5985f64b6c044fe1d8da3233746e9e61593aac0c0c269d6d66854749e9d61ae2a6af763a654d2da3413b648ddd40f38f06e

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers 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, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at ronald.tse@ribose.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/README-bootstrap.md

@@ -0,0 +1 @@
+# metanorma-plugin-asyncapi

data/README.md

@@ -0,0 +1,13 @@
+# metanorma-plugin-asyncapi
+
+Renders [AsyncAPI](https://www.asyncapi.com) documents as normative
+Metanorma sections — the `[asyncapi,path=...]` preprocessor and
+renderer over [lutaml-asyncapi](https://github.com/lutaml/lutaml-asyncapi).
+
+```adoc
+[asyncapi,path=asyncapi.yaml]
+--
+--
+```
+
+See PLAN.md at lutaml-asyncapi for the program.

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/metanorma/plugin/asyncapi/preprocessor.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require "asciidoctor"
+
+module Metanorma
+  module Plugin
+    module Asyncapi
+      # Splices rendered AsciiDoc in place of an
+      #
+      #   [asyncapi,path=/to/document.yaml]
+      #   --
+      #   --
+      #
+      # envelope before the document parses. A preprocessor, not a
+      # block processor: Parser.parse_blocks (the only parse path a
+      # block processor gets) cannot create sections.
+      class Preprocessor < ::Asciidoctor::Extensions::Preprocessor
+        ASYNCAPI_ATTRS = /\A\[asyncapi([,\]].*)?\]\s*\z/
+
+        def process(document, reader)
+          ::Asciidoctor::Reader.new(splice(document, reader.readlines),
+                                    reader.cursor)
+        end
+
+        private
+
+        def splice(document, lines)
+          out = []
+          until lines.empty?
+            line = lines.shift
+            if line.match?(ASYNCAPI_ATTRS)
+              out.concat(consume_and_render(document, line, lines))
+            else
+              out << line
+            end
+          end
+          out
+        end
+
+        def dashed?(line)
+          line&.strip == "--"
+        end
+
+        # The closing -- is optional; a missing opening envelope raises
+        # from consume_and_render
+        def envelope(lines)
+          lines.shift while lines.first && lines.first.strip.empty?
+          return nil unless dashed?(lines.shift)
+
+          body = []
+          while (line = lines.shift) && !dashed?(line)
+            body << line
+          end
+          body
+        end
+
+        def consume_and_render(document, attr_line, lines)
+          envelope(lines) or
+            raise ::ArgumentError,
+                  "asyncapi block needs a -- -- envelope: #{attr_line}"
+          base = ::File.dirname(document.attributes["docfile"] || ".")
+          source = envelope_path(attr_line)
+          renderer = Renderer.new(load_document(document, source, base))
+          content = renderer.render
+          content.split("\n")
+        end
+
+        def envelope_path(attr_line)
+          path = attr_line[/path=("([^"]+)"|(\S+?))\]/, 2] ||
+            attr_line[/path=("([^"]+)"|(\S+?))\]/, 3] ||
+            attr_line[/path=([^\]\s]+)/, 1]
+          raise ::ArgumentError, "asyncapi block needs a path" unless path
+
+          path
+        end
+
+        def load_document(_document, source, base)
+          # ::Lutaml — metanorma-plugin-lutaml defines
+          # Metanorma::Plugin::Lutaml, which would capture a lexically
+          # scoped Lutaml::Asyncapi lookup
+          ::Lutaml::Asyncapi.parse(
+            ::File.read(::File.expand_path(source, base)),
+          )
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/plugin/asyncapi/renderer.rb

@@ -0,0 +1,205 @@
+# frozen_string_literal: true
+
+require "lutaml/asyncapi"
+
+module Metanorma
+  module Plugin
+    module Asyncapi
+      # metanorma-plugin-lutaml pins coradoc ~> 1.1.8, which excludes the
+      # 2.0 hub in every metanorma-cli bundle; descriptions pass through
+      # with only the link bridge when the monorepo is absent.
+      begin
+        require "coradoc"
+        require "coradoc/markdown"
+        require "coradoc/asciidoc"
+        MONOREPO = true
+      rescue LoadError
+        MONOREPO = false
+      end
+
+      # Renders an AsyncAPI document as normative AsciiDoc sections.
+      class Renderer
+        def initialize(document)
+          @document = document
+        end
+
+        def render
+          [preface, servers_section, channels_section,
+           operations_section, messages_section].compact.join("\n\n")
+        end
+
+        TEXT_KEYS = %w[summary description].freeze
+
+        private
+
+        def raw
+          @raw ||= @document.to_hash
+        end
+
+        def preface
+          info = raw["info"] || {}
+          lines = ["== #{info['title'] || 'AsyncAPI document'}", ""]
+          if @document.asyncapi
+            lines << "AsyncAPI version: #{@document.asyncapi}"
+          end
+          if (desc = info["description"])
+            lines << to_asciidoc(desc) << ""
+          end
+          lines.join("\n")
+        end
+
+        def servers_section
+          servers = raw["servers"]
+          return nil if servers.nil? || servers.empty?
+
+          lines = ["== Servers", ""]
+          servers.sort.each do |name, server|
+            lines << "=== #{name}" << ""
+            lines.concat(server_lines(server)) if server.is_a?(Hash)
+            lines << ""
+          end
+          lines.join("\n")
+        end
+
+        def server_lines(server)
+          out = []
+          out << "URL: `#{server['url']}`" if server["url"]
+          if server["protocol"]
+            out << "Protocol: `#{server['protocol']}`"
+          end
+          if server["description"]
+            out << to_asciidoc(server["description"]) << ""
+          end
+          out
+        end
+
+        def channels_section
+          channels = raw["channels"]
+          return nil if channels.nil? || channels.empty?
+
+          lines = ["== Channels", ""]
+          channels.sort.each do |id, channel|
+            lines << "=== #{id}" << ""
+            lines.concat(channel_lines(channel)) if channel.is_a?(Hash)
+            lines << ""
+          end
+          lines.join("\n")
+        end
+
+        def channel_lines(channel)
+          out = []
+          if channel["address"]
+            out << "Address: `#{channel['address']}`"
+          end
+          if channel["description"]
+            out << to_asciidoc(channel["description"]) << ""
+          end
+          out
+        end
+
+        def operations_section
+          ops = operations
+          return nil if ops.empty?
+
+          lines = ["== Operations", ""]
+          ops.each do |name, op|
+            lines << "=== #{name}" << ""
+            lines << "Action: `#{op['action']}`" if op["action"]
+            lines.concat(text_lines(op))
+            lines << ""
+          end
+          lines.join("\n")
+        end
+
+        # 3.x: top-level operations. 2.x: publish/subscribe embedded in
+        # channels, keyed "<channel> <action>".
+        def operations
+          root_ops = (raw["operations"] || {}).select do |_name, op|
+            op.is_a?(Hash)
+          end
+          root_ops.merge(embedded_operations)
+        end
+
+        def embedded_operations
+          ops = {}
+          (raw["channels"] || {}).each do |id, channel|
+            next unless channel.is_a?(Hash)
+
+            append_embedded(ops, id, channel)
+          end
+          ops
+        end
+
+        def append_embedded(ops, id, channel)
+          %w[publish subscribe].each do |action|
+            if (op = channel[action]).is_a?(Hash)
+              ops["#{id} #{action}"] = op.merge("action" => action)
+            end
+          end
+        end
+
+        def messages_section
+          messages = collect_messages
+          return nil if messages.empty?
+
+          lines = ["== Messages", ""]
+          messages.each do |name, message|
+            lines << "=== #{name}" << ""
+            lines.concat(message_lines(message)) if message.is_a?(Hash)
+            lines << ""
+          end
+          lines.join("\n")
+        end
+
+        def message_lines(message)
+          out = []
+          if message["contentType"]
+            out << "Payload content type: `#{message['contentType']}`"
+          end
+          out.concat(text_lines(message))
+          out
+        end
+
+        def text_lines(node)
+          TEXT_KEYS.filter_map do |key|
+            to_asciidoc(node[key]) << "" if node[key]
+          end
+        end
+
+        def collect_messages
+          found = {}
+          walk(raw) do |node|
+            next unless node.is_a?(Hash) && node["payload"]
+
+            name = node["name"] || node["title"] || "message"
+            found[name] = node unless found.key?(name)
+          end
+          found
+        end
+
+        def walk(node, &)
+          case node
+          when Hash
+            yield node
+            node.each_value { |v| walk(v, &) }
+          when Array
+            node.each { |v| walk(v, &) }
+          end
+        end
+
+        def to_asciidoc(markdown)
+          adoc = convert_markdown(markdown)
+          adoc.gsub(/\[([^\]]+)\]\((https?:\/\/[^)\s]+)\)/) do
+            "#{Regexp.last_match(2)}[#{Regexp.last_match(1)}]"
+          end
+        end
+
+        def convert_markdown(markdown)
+          return markdown unless MONOREPO
+
+          Coradoc.convert(markdown, from: :markdown, to: :asciidoc)
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/plugin/asyncapi/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Plugin
+    module Asyncapi
+      VERSION = "0.1.0"
+    end
+  end
+end

data/lib/metanorma/plugin/asyncapi.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "asciidoctor/extensions"
+
+module Metanorma
+  module Plugin
+    module Asyncapi
+      autoload :VERSION, "metanorma/plugin/asyncapi/version"
+      autoload :Renderer, "metanorma/plugin/asyncapi/renderer"
+      autoload :Preprocessor, "metanorma/plugin/asyncapi/preprocessor"
+    end
+  end
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: metanorma-plugin-asyncapi
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ribose Inc.
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: asciidoctor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: lutaml-asyncapi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: lutaml-model
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.122
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.122
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yeptris
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.34
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.34
+description: 'Render AsyncAPI documents as normative Metanorma sections: the [asyncapi,path=...]
+  preprocessor and renderer over lutaml-asyncapi'
+email:
+- open.source@ribose.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop_todo.yml"
+- CODE_OF_CONDUCT.md
+- README-bootstrap.md
+- README.md
+- Rakefile
+- lib/metanorma/plugin/asyncapi.rb
+- lib/metanorma/plugin/asyncapi/preprocessor.rb
+- lib/metanorma/plugin/asyncapi/renderer.rb
+- lib/metanorma/plugin/asyncapi/version.rb
+homepage: https://github.com/metanorma/metanorma-plugin-asyncapi
+licenses:
+- BSD-2-Clause
+metadata:
+  homepage_uri: https://github.com/metanorma/metanorma-plugin-asyncapi
+  source_code_uri: https://github.com/metanorma/metanorma-plugin-asyncapi
+  changelog_uri: https://github.com/metanorma/metanorma-plugin-asyncapi/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: AsyncAPI as normative Metanorma sections
+test_files: []