metanorma-tools 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 76e3a5e6d7264d8ef41b974de472562d470df5ae00c3d5c02c7e1ba4cbc13da9
+  data.tar.gz: 34cdac2a1177adc3a5abec9c8032df6fd7ce61564c8a222e5c9e0119ae769457
+SHA512:
+  metadata.gz: 737e212afb0c25293f4f1d3886c39d882cc88f5bd25ecb83dec13b0884664667c6fb05952fc339aab487bc22bd05650be1777de2a28d2f718c483af119510a21
+  data.tar.gz: a0aa96f957e218d682a2e5827f7608359618243e7218fbe82bb2359eec1066d70a7102333254ff28de32fc9f469b0569728f1ab2b72c6379a6409eee77740de8

data/.github/workflows/rake.yml

@@ -0,0 +1,15 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+name: rake
+
+on:
+  push:
+    branches: [ master, main ]
+    tags: [ v* ]
+  pull_request:
+
+jobs:
+  rake:
+    uses: metanorma/ci/.github/workflows/generic-rake.yml@main
+    secrets:
+      pat_token: ${{ secrets.METANORMA_CI_PAT_TOKEN }}

data/.github/workflows/release.yml

@@ -0,0 +1,24 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+name: release
+
+on:
+  workflow_dispatch:
+    inputs:
+      next_version:
+        description: |
+          Next release version. Possible values: x.y.z, major, minor, patch (or pre|rc|etc).
+          Also, you can pass 'skip' to skip 'git tag' and do 'gem push' for the current version
+        required: true
+        default: 'skip'
+  repository_dispatch:
+    types: [ do-release ]
+
+jobs:
+  release:
+    uses: metanorma/ci/.github/workflows/rubygems-release.yml@main
+    with:
+      next_version: ${{ github.event.inputs.next_version }}
+    secrets:
+      rubygems-api-key: ${{ secrets.METANORMA_CI_RUBYGEMS_API_KEY }}
+      pat_token: ${{ secrets.METANORMA_CI_PAT_TOKEN }}

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+Gemfile.lock

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--backtrace

data/.rubocop.yml

@@ -0,0 +1,14 @@
+inherit_from:
+  - https://raw.githubusercontent.com/riboseinc/oss-guides/master/ci/rubocop.yml
+  - .rubocop_todo.yml
+
+plugins:
+- rubocop-performance
+- rubocop-rake
+- rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 3.0
+  NewCops: enable
+  Exclude:
+    - 'vendor/**/*'

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders 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, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in revix.gemspec
+gemspec
+
+gem 'rake'
+gem 'rspec'
+gem 'rubocop'
+gem 'xml-c14n'

data/README.adoc

@@ -0,0 +1,94 @@
+= Metanorma Tools
+
+image:https://img.shields.io/gem/v/metanorma-tools.svg["Gem Version", link="https://rubygems.org/gems/metanorma-tools"]
+image:https://github.com/metanorma/metanorma-tools/actions/workflows/rake.yml/badge.svg["Windows Build Status", link="https://github.com/metanorma/metanorma-tools/actions/workflows/rake.yml"]
+image:https://img.shields.io/github/issues-pr-raw/metanorma/metanorma-tools.svg["Pull Requests", link="https://github.com/metanorma/metanorma-tools/pulls"]
+image:https://img.shields.io/github/commits-since/metanorma/metanorma-tools/latest.svg["Commits since latest",link="https://github.com/metanorma/metanorma-tools/releases"]
+
+== Purpose
+
+Metanorma Tools is a command-line interface that supports the standards
+development lifecycle for various SDOs (Standards Development Organizations) to
+facilitate the production, packaging and delivery of Metanorma documents.
+
+The post-compilation steps work on Metanorma Presentation XML output
+(`*.presentation.xml`).
+
+
+== Features
+
+The gem provides workflow tools for:
+
+ISO (International Organization for Standardization)::
+
+** link:docs/figure-extraction.adoc[ISO figure package]: export images with ISO
+DRG compliant filenames into a package from Metanorma PXML
+
+** Comment management for ISO comment sheets (planned - integrating `commenter` gem functionality)
+
+** GitHub comment management integration for collaborative review processes (planned)
+** Pre-production fetch of ISO documents from the OBP into Metanorma documents (planned)
+
+* [other SDOs when needed...]
+
+
+== Installation
+
+Add this line to your application's Gemfile:
+
+[source,ruby]
+----
+gem 'metanorma-tools'
+----
+
+And then execute:
+
+[source,shell]
+----
+$ bundle install
+----
+
+Or install it yourself as:
+
+[source,shell]
+----
+$ gem install metanorma-tools
+----
+
+
+== Usage
+
+See the documentation for individual tools:
+
+* link:docs/figure-extraction.adoc[Figure extraction] - Extract embedded
+  figures from Metanorma presentation XML files
+
+ISO workflows:
+
+* link:docs/workflows-iso.adoc[ISO workflows and best practices]
+* link:docs/iso-drg-filename-guidance.adoc[ISO DRG filename guidance]
+
+
+
+== Development notes
+
+The `spec/fixtures/document-en.dis.presentation.xml` file contains sample
+Metanorma XML for testing purposes from the
+https://github.com/metanorma/mn-samples-iso[mn-samples-iso repository].
+
+== Dependencies
+
+* `lutaml-model`: For structured data modeling
+* `nokogiri`: For XML parsing
+* `rubyzip`: For ZIP archive creation
+* `thor`: For command-line interface
+
+== Copyright
+
+This gem is developed, maintained and funded by
+https://www.ribose.com[Ribose Inc.]
+
+== License
+
+The gem is available as open source under the terms of the
+https://opensource.org/licenses/BSD-2-Clause[2-Clause BSD License].

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/docs/figure-extraction.adoc

@@ -0,0 +1,111 @@
+= Figure extraction
+
+== Overview
+
+The figure extraction tool extracts embedded figures from Metanorma presentation
+XML files.
+
+The filenames are generated according to the extended
+link:docs/iso-drg-filename-guidance.adoc[ISO DRG guidelines].
+
+
+== How it works
+
+* The input Metanorma presentation XML file is parsed to identify embedded
+figures and obtain metadata needed for the naming.
+
+* Each figure is extracted and saved according to the specified output format
+and naming conventions.
+
+
+== Usage
+
+=== Command
+
+Extract figures from a Metanorma presentation XML file:
+
+[source,bash]
+----
+metanorma-tools extract-images document.presentation.xml
+----
+
+When no options are provided, the files will be named according to ISO DRG guidelines.
+
+This generates filenames like:
+
+* `19135-1_ed1fig1.svg`
+
+`-o, --output-dir DIR`::
+Output directory for extracted figures (default: under current directory). By
+default named using the "document portion" of the DRG filename pattern as the
+output directory name.
++
+[example]
+====
+`19135-1_ed1/{image_filenames}`
+====
+
+`--prefix PREFIX`::
+Filename prefix for extracted figures
++
+[example]
+====
+`{prefix}_fig1.svg`
+====
+
+`--zip`::
+Create ZIP archive of extracted figures. By default named using the "document
+portion" of the DRG filename pattern.
++
+[example]
+====
+`19135-1_ed1.zip`
+====
+
+`--retain-original-filenames`::
+Keep original filenames from source document. The Metanorma XML
+presentation format allows for embedded figures to retain their original
+filenames, which can be useful for versioning and tracking changes.
++
+[example]
+====
+`80000-2_ed2fig2_originalname.png`
+====
+
+
+
+A custom prefix can be specified to follow a specific naming convention (that is
+different from the ISO DRG style).
+
+[source,bash]
+----
+metanorma-tools extract-images document.presentation.xml \
+  --prefix "my_prefix" \
+  --output-dir figures
+----
+
+[example]
+====
+`figures/my_prefixfig2_originalname.png`
+====
+
+
+To create a figure submission package, use the following command:
+
+[source,bash]
+----
+metanorma-tools extract-images document.presentation.xml \
+  --zip \
+  --output-dir submission-figures
+----
+
+[example]
+====
+`submission-figures.zip`
+====
+
+
+== See also
+
+* link:iso-drg-filename-guidance.adoc[ISO DRG filename guidance]
+* link:workflows-iso.adoc[ISO workflows and best practices]