metanorma-plugin-openapi 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0cc137b68b59999c5d99577793b14fd3ece351ab14f95372ac8745c016d5e780
+  data.tar.gz: a6f5628475121accbf69b485ddca657f1e433b6ed191ae958de85c2bbc97c900
+SHA512:
+  metadata.gz: 6adfce232953b977dfb8b7cf1f7474a6047d9ed106626e81e9a5f14f50fa27f7d6dbdaf38c677f6054de1509c40ffcfccc335b83d5ece16df744cea5e83e8965
+  data.tar.gz: 0c21e681440b8a261190099b4d103766f7cc5668ddbb8a66ff1607bc5f2c0bac5632e4bb96577806e0fb0493d31a82dfef5a94dbf64189234d8e8e7d7715b812

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/LICENSE

@@ -0,0 +1,26 @@
+BSD 2-Clause License
+
+Copyright (c) 2026, Ribose Inc.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+1.  Redistributions of source code must retain the above copyright notice,
+    this list of conditions and the following disclaimer.
+
+2.  Redistributions in binary form must reproduce the above copyright notice,
+    this list of conditions and the following disclaimer in the documentation
+    and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.

data/README.adoc

@@ -0,0 +1,5 @@
+= metanorma-plugin-openapi
+
+Metanorma plugin rendering model-driven normative sections from OpenAPI documents.
+
+Status: scaffold. The program plan (model gem, requirements-class rendering, acceptance on the OGC API - Features corpus) lives in https://github.com/lutaml/lutaml-openapi[ lutaml/lutaml-openapi's PLAN.md]; this plugin closes https://github.com/metanorma/metanorma-ogc/issues/153[metanorma-ogc#153].

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/examples/ogcapi-features-1.adoc

@@ -0,0 +1,114 @@
+= Building Blocks specified in OGC API - Features - Part 1: Core
+
+API version: 3.1.1
+Common components used in the
+https://docs.ogc.org/is/17-069r5/17-069r5.html[OGC standard "OGC API - Features - Part 1: Core"].
+
+OGC API - Features - Part 1: Core 1.1 is an OGC Standard.
+Copyright (c) 2024 Open Geospatial Consortium.
+To obtain additional rights of use, visit https://www.ogc.org/legal/ .
+
+This document is also available on
+https://schemas.opengis.net/ogcapi/features/part1/1.1/openapi/ogcapi-features-1-oas31.yaml[OGC].
+
+
+== Schemas
+
+=== collection
+
+Type: `object`
+
+=== collections
+
+Type: `object`
+
+=== confClasses
+
+Type: `object`
+
+=== exception
+
+Type: `object`
+
+=== extent
+
+The extent of the features in the collection. In the Core only spatial and temporal
+extents are specified. Extensions may add additional members to represent other
+extents, for example, thermal or pressure ranges.
+
+Type: `object`
+
+=== featureCollectionGeoJSON
+
+Type: `object`
+
+=== featureGeoJSON
+
+Type: `object`
+
+=== geometryGeoJSON
+
+=== geometrycollectionGeoJSON
+
+Type: `object`
+
+=== landingPage
+
+Type: `object`
+
+=== linestringGeoJSON
+
+Type: `object`
+
+=== link
+
+Type: `object`
+
+=== linkTemplate
+
+Type: `object`
+
+=== multilinestringGeoJSON
+
+Type: `object`
+
+=== multipointGeoJSON
+
+Type: `object`
+
+=== multipolygonGeoJSON
+
+Type: `object`
+
+=== numberMatched
+
+The number of features of the feature type that match the selection
+parameters like ``bbox``.
+
+Type: `integer`
+
+=== numberReturned
+
+The number of features in the feature collection.
+
+A server may omit this information in a response, if the information
+about the number of features is not known or difficult to compute.
+
+If the value is provided, the value shall be identical to the number
+of items in the "features" array.
+
+Type: `integer`
+
+=== pointGeoJSON
+
+Type: `object`
+
+=== polygonGeoJSON
+
+Type: `object`
+
+=== timeStamp
+
+This property indicates the time and date when the response was generated.
+
+Type: `string`

data/lib/metanorma/plugin/openapi/block.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require "asciidoctor"
+
+module Metanorma
+  module Plugin
+    module Openapi
+      # [openapi,path=/path/to/document.yaml]
+      # --
+      # --
+      #
+      # Loads an OpenAPI document and renders it as normative AsciiDoc
+      # sections. The path resolves against the source document.
+      class Block < ::Asciidoctor::Extensions::BlockProcessor
+        use_dsl
+        named :openapi
+        on_context :open
+
+        def process(parent, _reader, attrs)
+          source = attrs["path"] || parent.document.attr("openapi_document")
+          unless source
+            raise ::ArgumentError,
+                  "openapi block needs a path attribute"
+          end
+
+          content = Renderer.new(load_document(parent, source)).render
+          parent.blocks << ::Asciidoctor::Block.new(
+            parent, :open, source: content.split("\n"), attrs: {}
+          )
+          nil
+        end
+
+        private
+
+        def load_document(parent, source)
+          base = ::File.dirname(parent.document.attributes["docfile"] || ".")
+          Lutaml::Openapi.parse(::File.read(::File.expand_path(source, base)))
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+require "lutaml/openapi"
+require "coradoc"
+require "coradoc/markdown"
+require "coradoc/asciidoc"
+
+module Metanorma
+  module Plugin
+    module Openapi
+      # Renders an OpenAPI document as normative AsciiDoc sections.
+      # Descriptions are CommonMark (per the OpenAPI spec) and convert
+      # to AsciiDoc through the coradoc tree — the metanorma-ogc#153
+      # pipeline: OpenAPI(Markdown) → Coradoc → Metanorma.
+      class Renderer
+        def initialize(document)
+          @document = document
+        end
+
+        def render
+          [preface, schemas_section, paths_section].compact.join("\n\n")
+        end
+
+        private
+
+        def preface
+          info = @document.info || {}
+          lines = ["= #{info['title'] || 'OpenAPI document'}", ""]
+          lines << "API version: #{@document.openapi}" if @document.openapi
+          if (desc = info["description"])
+            lines << to_asciidoc(desc) << ""
+          end
+          lines.join("\n")
+        end
+
+        def schemas_section
+          schemas = @document.schemas
+          return nil if schemas.empty?
+
+          lines = ["== Schemas", ""]
+          schemas.each do |name, schema|
+            lines.concat(schema_lines(schema, name))
+          end
+          lines.join("\n")
+        end
+
+        def schema_lines(schema, name)
+          lines = ["=== #{name}", ""]
+          if (desc = schema.description) && !desc.empty?
+            lines << to_asciidoc(desc) << ""
+          end
+          lines << "Type: `#{schema.type}`" << "" if schema.type
+          lines
+        end
+
+        def paths_section
+          paths = @document.paths
+          return nil if paths.nil? || paths.empty?
+
+          lines = ["== Paths", ""]
+          paths.sort.each do |path, item|
+            lines.concat(operation_lines(path, item))
+          end
+          lines.join("\n")
+        end
+
+        def operation_lines(path, item)
+          entries = (item["operations"] || item).select do |_, op|
+            op.is_a?(Hash)
+          end
+          entries.flat_map do |method, operation|
+            lines = ["=== #{method.to_s.upcase} #{path}", ""]
+            if (desc = operation["description"])
+              lines << to_asciidoc(desc) << ""
+            end
+            lines
+          end
+        end
+
+        def to_asciidoc(markdown)
+          adoc = Coradoc.convert(markdown, from: :markdown, to: :asciidoc)
+          # coradoc-markdown does not convert CommonMark links yet (they
+          # pass through raw); bridge the dominant inline form to
+          # AsciiDoc's https://url[text]. Remove once coradoc grows
+          # native link support (metanorma/coradoc issue to follow).
+          adoc.gsub(/\[([^\]]+)\]\((https?:\/\/[^)\s]+)\)/) do
+            "#{Regexp.last_match(2)}[#{Regexp.last_match(1)}]"
+          end
+        end
+      end
+    end
+  end
+end

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

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

data/lib/metanorma/plugin/openapi.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "asciidoctor/extensions"
+
+module Metanorma
+  module Plugin
+    module Openapi
+      autoload :VERSION, "metanorma/plugin/openapi/version"
+      autoload :Renderer, "metanorma/plugin/openapi/renderer"
+      autoload :Block, "metanorma/plugin/openapi/block"
+    end
+  end
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: metanorma-plugin-openapi
+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: coradoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !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: lutaml-openapi
+  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
+description: Metanorma plugin rendering model-driven normative sections from OpenAPI
+  documents
+email:
+- open.source@ribose.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop_todo.yml"
+- CODE_OF_CONDUCT.md
+- LICENSE
+- README.adoc
+- Rakefile
+- examples/ogcapi-features-1.adoc
+- lib/metanorma/plugin/openapi.rb
+- lib/metanorma/plugin/openapi/block.rb
+- lib/metanorma/plugin/openapi/renderer.rb
+- lib/metanorma/plugin/openapi/version.rb
+homepage: https://github.com/metanorma/metanorma-plugin-openapi
+licenses:
+- BSD-2-Clause
+metadata:
+  rubygems_mfa_required: 'true'
+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.6.9
+specification_version: 4
+summary: Metanorma plugin for OpenAPI
+test_files: []