dim_to_rst 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 579d2781264a9f8d98969971456201971ad74b116bbaf708fa7978040e525b5c
+  data.tar.gz: '09189a0087c0028f24b5de95ce110cb478f0ed45b98f334d8306bd13307fb578'
+SHA512:
+  metadata.gz: 867bc94e7ed751a09450976883689ad214e521d22cfc66e49d048ad07e0e9f3249d5b32f60c401473413b2be7bd8a554a350f3d982edc5c21d69dc3c0261fe94
+  data.tar.gz: c2f5bbd3fe751b1002325afa0132347499f01f826d173b25316a1a50c41a09605cf7aa6393bf72f765b5b8ab4e7225cdf07f10e5f5a92c83cbd08042f385d0bc

data/CHANGELOG.md

@@ -0,0 +1,29 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [2.0.0] - 2024-11-27
+
+### Changed
+- ! Adapted the code for `dim-toolkit` `>= 2.1.1`
+
+## [1.0.1] - 2023-10-06
+
+### Fixed
+- Fixed a `NoMethodError` that was introduced with `activesupport 7.1.0`.
+
+## [1.0.0] - 2023-05-15
+
+### Changed
+- ! Update `activesupport` from `~> 6` to `~> 7`
+
+## [0.1.0] - 2022-11-22
+
+### Added
+- Executable file and necessary templates to read the DIM requirements and
+  produce basic RST output. 

data/README.md

@@ -0,0 +1,32 @@
+# Dim to RST
+
+This example illustrates how to use [dim](https://github.com/esrlabs/dox/tree/master/dim)
+inside a gem.
+
+This example shows how to create a custom requirements exporter.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add dim_to_rst
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install dim_to_rst
+
+## Usage
+
+    $ dim_to_rst <path/to/config.yaml> <export/destination>
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake spec` to run the tests.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+[https://github.com/esrlabs/dox/tree/master/dim/examples/scripting/dim_to_rst].

data/dim_to_rst.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative "lib/dim_to_rst/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "dim_to_rst"
+  spec.version = DimToRst::VERSION
+  spec.authors = ["Accenture"]
+
+  spec.summary = "An example of a custom exporter gem for dim."
+  spec.description = "Exports requirements written in dim to plain RST source."
+  spec.homepage = "https://github.com/esrlabs/dox/tree/master/dim/examples/scripting/dim_to_rst"
+  spec.required_ruby_version = ">= 2.7"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "https://github.com/esrlabs/dox/tree/master/dim/examples/scripting/dim_to_rst/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").select do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[exe/ lib/ CHANGELOG.md README.md])
+    end
+  end
+
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport", "~> 7"
+  spec.add_dependency "dim-toolkit", '>= 2.1.1'
+end

data/exe/dim_to_rst

@@ -0,0 +1,91 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "active_support"
+require "active_support/core_ext/string"
+require "dim/loader"
+require "erb"
+require "fileutils"
+
+# rubocop:disable Style/GlobalVars
+# (required by DIM)
+$subcommands = {}
+# rubocop:enable Style/GlobalVars
+
+def asil_level(requirement)
+  requirement.asil == "not_set" ? nil : "#{requirement.asil} |"
+end
+
+def req_text(requirement)
+  buffer = StringIO.new
+  text_lines = requirement.text.lines.map(&:chomp)
+  buffer << text_lines.shift
+
+  if text_lines.any?
+    text_lines.each do |line|
+      buffer << "\n#{line.indent(7)}"
+    end
+  end
+
+  buffer.string
+end
+
+def req_refs(references)
+  return "none" unless references&.any?
+
+  references.map { |ref| ":ref:`dim-req-#{ref}`" }.join(', ')
+end
+
+input_file = ARGV.shift
+output_dir = ARGV.shift
+
+@loader = Dim::Loader.new.tap do |loader|
+  loader.load input_filenames: [input_file]
+end
+
+categories = {}
+
+@loader.requirements.each_value do |requirement|
+  category_name = requirement.category
+
+  category_data = categories[category_name] ||= {}
+  category_data[:name] = category_name
+  category_data[:id] = category_name.parameterize.downcase
+  category_requirements = category_data[:requirements] ||= []
+  category_requirements << requirement
+
+  module_name = requirement.moduleName
+  category_modules = category_data[:modules] ||= {}
+  module_data = category_modules[module_name] ||= {}
+  module_data[:name] = module_name
+  module_data[:id] = module_name.parameterize.downcase
+  module_requirements = module_data[:requirements] ||= []
+  module_requirements << requirement
+end
+
+templates_path = Pathname.new(__dir__) / ".." / "lib" / "dim_to_rst" / "templates"
+
+index_template = File.read(templates_path / "index.rst.erb")
+index_erb = ERB.new(index_template)
+index_dest = File.join(output_dir, "index.rst")
+
+File.write(index_dest, index_erb.result_with_hash(
+  categories: categories
+))
+
+module_template = File.read(templates_path / "module.rst.erb")
+module_erb = ERB.new(module_template)
+
+categories.each do |category_name, category_data|
+  category_dir = File.join(output_dir, category_data[:id])
+
+  FileUtils.rm_rf(category_dir)
+  FileUtils.mkdir(category_dir)
+
+  category_data[:modules].each do |module_name, module_data|
+    module_dest = File.join(category_dir, "#{module_data[:id]}.rst")
+    File.write(module_dest, module_erb.result_with_hash(
+                              module_name: module_name, module_data: module_data
+                            ))
+  end
+end

data/lib/dim_to_rst/templates/index.rst.erb

@@ -0,0 +1,16 @@
+Requirements
+============
+
+<% categories.each do |category_name, category_data| %>
+<% label = category_name.capitalize %>
+
+<%= label %>
+<%= '-' * label.length %>
+
+.. toctree::
+  :maxdepth: 1
+  :glob:
+
+  <%= category_data[:id] %>/*
+
+<% end %>

data/lib/dim_to_rst/templates/module.rst.erb

@@ -0,0 +1,20 @@
+<%= module_name %>
+<%= '=' * module_name.length %>
+
+<% module_data[:requirements].each do |requirement|
+  requirement_id = requirement.id %>
+
+.. _`dim-req-<%= requirement_id %>`:
+
+<%= requirement_id %>
+<%= "-" * requirement_id.length %>
+
+.. list-table::
+
+   * - **<%= requirement_id %>** | <%= requirement.accepted %> | <%= asil_level(requirement) %> <%= requirement.origin %>
+   * - **Tags:** <%= requirement.tags %>
+   * - **Test Setups:** <%= requirement.test_setups %>
+   * - <%= req_text(requirement) %>
+   * - **References:** <%= req_refs(requirement.refs) %>
+   * - **Back References:** <%= req_refs(requirement.backwardRefs) %>
+<% end %>

data/lib/dim_to_rst/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module DimToRst
+  VERSION = "2.0.0"
+end

data/lib/dim_to_rst.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require_relative "dim_to_rst/version"
+
+module DimToRst; end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: dim_to_rst
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+platform: ruby
+authors:
+- Accenture
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-01-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7'
+- !ruby/object:Gem::Dependency
+  name: dim-toolkit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.1
+description: Exports requirements written in dim to plain RST source.
+email:
+executables:
+- dim_to_rst
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- README.md
+- dim_to_rst.gemspec
+- exe/dim_to_rst
+- lib/dim_to_rst.rb
+- lib/dim_to_rst/templates/index.rst.erb
+- lib/dim_to_rst/templates/module.rst.erb
+- lib/dim_to_rst/version.rb
+homepage: https://github.com/esrlabs/dox/tree/master/dim/examples/scripting/dim_to_rst
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/esrlabs/dox/tree/master/dim/examples/scripting/dim_to_rst
+  source_code_uri: https://github.com/esrlabs/dox/tree/master/dim/examples/scripting/dim_to_rst
+  changelog_uri: https://github.com/esrlabs/dox/tree/master/dim/examples/scripting/dim_to_rst/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: An example of a custom exporter gem for dim.
+test_files: []