asciidoctor-requirements 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 301514808e1331f3da304cffbe9cd23c0b3360525288f5b60072b38883362afa
+  data.tar.gz: 2f64fe4edfc0191bdd578f43a4a01955480d4494790dcbbf6bcd77a930a233c0
+SHA512:
+  metadata.gz: dd004f1c6c936bb12865054e8293520f40f504de28d9f1d439eb4a1c4a69e29d5834f7bcd278b39f6bb3250221009c6297cf9e4f3bb728b0d869b37c3a3c7d77
+  data.tar.gz: 2b7cd1e195dc4bd496c0b309d8efeea22f005d9c63c0e62e0d33574de7ebc561610725a5d0fce3d7446409fc3fa6721b98dfb649cee04748e997881f81c298c0

data/README.adoc

@@ -0,0 +1,35 @@
+= Asciidoctor::Requirements
+
+TODO: Delete this and the text below, and describe your gem
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/asciidoctor/requirements`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+== Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+== Usage
+
+TODO: Write usage instructions here
+
+== Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+== Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/asciidoctor-requirements.
+
+== License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/asciidoctor-requirements/extension.rb

@@ -0,0 +1,118 @@
+require 'asciidoctor/extensions' unless RUBY_ENGINE == 'opal'
+require 'yaml'
+
+# An asciidoctor extension that transforms a yaml block in a formatted requirement
+module AsciidoctorRequirements
+    module Asciidoctor
+
+        class RequirementBlock < ::Asciidoctor::Extensions::BlockProcessor
+            use_dsl
+
+            named :requirement
+            on_context :example
+            parse_content_as :raw
+
+            def process(parent, reader, attrs)
+                raw_data = reader.readlines.join("\n")
+                yaml_req = YAML.load(raw_data)
+
+                req_create_section(parent, yaml_req, attrs)                           
+                req_create_description(parent, yaml_req, attrs)
+                req_create_tabs_table(parent, yaml_req, attrs)
+                req_create_rationale(parent, yaml_req, attrs)
+                req_create_break(parent)
+               
+                parent
+
+            end
+
+            def req_create_section(parent, yaml, attrs)
+                if yaml["title"].nil?
+                    raise "Title missing in requirement yaml.\n" + req_usage() 
+                end
+
+                if yaml["rev"].nil?
+                    raise "Revision missing in requirement yaml.\n" + req_usage() 
+                end
+
+                if yaml["id"].nil?
+                    raise "id missing in requirement yaml.\n" + req_usage() 
+                end
+
+                section_title = String(parent.document.attributes["reqprefix"] + "_" +yaml["id"] + "_" + yaml["rev"] + " : " + yaml["title"])
+
+                parent << create_section(parent, section_title, {})
+            end
+
+            def req_create_description(parent, yaml, attrs)
+                if yaml["description"].nil?
+                    raise "Description missing in requirement yaml.\n" + req_usage() 
+                end
+
+                description_text = "[.lead]\n" +  yaml["description"]
+
+                parse_content(parent, description_text, {})
+            end
+
+            def req_create_rationale(parent, yaml, attrs)
+                if yaml["rationale"].nil?
+                    return
+                end
+
+                table_delimiter = "|==="
+                rationale = "[cols='.^1,6', frame=none, grid=none]\n" + table_delimiter + "\ns|Rationale a|[.rationale]\n" + yaml["rationale"].strip + "\n" + table_delimiter
+
+                parse_content(parent, rationale, {})
+            end
+
+            def req_create_tabs_table(parent, yaml, attrs)
+                if yaml["tags"].empty?
+                    return ""
+                end
+
+                tag_lines = ""
+                table_delimiter = "|==="
+
+                yaml["tags"].each do |k, v|
+                    tag_lines += "|" + k + "|" + v + "\n"
+                end
+
+                tag_lines = "[%autowidth.stretch]\n" + table_delimiter + "\n" + tag_lines + table_delimiter
+
+                parse_content(parent, tag_lines, {})
+            end
+
+            def req_create_break(parent)
+                parse_content(parent, "'''", {})
+            end
+
+            def req_usage()
+                usage = '
+                USAGE : 
+                
+                [requirement]
+                ====
+                id: "0170"
+                rev: a
+                status: valid
+                title: Document Capability
+                description: The STRS platform provider shall describe, in the HID document, the reconfigurability behavior and capability of each reconfigurable component. 
+                rationale: |
+                    Waveform developers need to know the features and limitations of the platform for their applications.
+                    Once the radio has been procured, NASA has the knowledge to procure or produce new or additional modules using HID information.
+                    Also, future module replacement or additions will be possible without designing a new platform.
+                
+                
+                tags:
+                    key1: value1
+                    key2: value2
+                ====
+                
+                '
+
+
+                usage
+            end
+        end
+    end
+end

data/lib/asciidoctor-requirements/version.rb

@@ -0,0 +1,3 @@
+module AsciidoctorRequirements
+    VERSION = '1.0.0'
+  end

data/lib/asciidoctor-requirements.rb

@@ -0,0 +1,6 @@
+RUBY_ENGINE == 'opal' ? (require 'asciidoctor-requirements/extension') : (require_relative 'asciidoctor-requirements/extension')
+
+# Register the extensions to asciidoctor
+Asciidoctor::Extensions.register do
+    block AsciidoctorRequirements::Asciidoctor::RequirementBlock
+  end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: asciidoctor-requirements
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- clemnjord
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-06-25 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'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.20
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.20
+- !ruby/object:Gem::Dependency
+  name: yaml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+- !ruby/object:Gem::Dependency
+  name: asciidoctor-pdf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.8
+- !ruby/object:Gem::Dependency
+  name: asciidoctor-diagram
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+description: An asciidoctor extension that transforms a yaml block in a formatted
+  requirement.
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.adoc
+- lib/asciidoctor-requirements.rb
+- lib/asciidoctor-requirements/extension.rb
+- lib/asciidoctor-requirements/version.rb
+homepage: https://github.com/clemnjord/asciidoctor-requirements
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: An asciidoctor extension that transforms a yaml block in a formatted requirement.
+test_files: []