metanorma-bipm 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0b794a40444463cb9b1d3723f7964c8bb2936165a845f48557be8ef7adcada9c
+  data.tar.gz: 7e392b5f79b223deacf1092b0d06dc4bb12c0af0987e37ef664b4100b1899528
+SHA512:
+  metadata.gz: 26571b020caa32428945853cafbea125396f0defd9fa2d2c2c209951f09dc4b2f48645941e7b5beab8a1a76d8f01d25a40e4caa4622c0a78cf481eaba08644b5
+  data.tar.gz: 79b3e4734a35aa5057421237e0a4d7b60c2c5890cd67a37fd8027522be26b780c92e672ce61885fbd780341094b40149a9f34858e58f5af75f98103d93fb1fd4

data/.github/workflows/macos.yml

@@ -0,0 +1,38 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+name: macos
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    paths-ignore:
+      - .github/workflows/ubuntu.yml
+      - .github/workflows/windows.yml
+
+jobs:
+  test-macos:
+    name: Test on Ruby ${{ matrix.ruby }} macOS
+    runs-on: macos-latest
+    continue-on-error: ${{ matrix.experimental }}
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ '2.6', '2.5', '2.4' ]
+        experimental: [false]
+        include:
+          - ruby: '2.7'
+            experimental: true
+    steps:
+      - uses: actions/checkout@master
+      - name: Use Ruby
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: Update gems
+        run: |
+          sudo gem install bundler --force
+          bundle install --jobs 4 --retry 3
+      - name: Run specs
+        run: |
+          bundle exec rake

data/.github/workflows/ubuntu.yml

@@ -0,0 +1,56 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+name: ubuntu
+
+on:
+  push:
+    branches: [ master ]
+    tags:
+      - '*'
+  pull_request:
+    paths-ignore:
+      - .github/workflows/macos.yml
+      - .github/workflows/windows.yml
+
+jobs:
+  test-linux:
+    name: Test on Ruby ${{ matrix.ruby }} Ubuntu
+    runs-on: ubuntu-latest
+    continue-on-error: ${{ matrix.experimental }}
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ '2.6', '2.5', '2.4' ]
+        experimental: [false]
+        include:
+          - ruby: '2.7'
+            experimental: true
+    steps:
+      - uses: actions/checkout@master
+      - name: Use Ruby
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: Update gems
+        run: |
+          gem install bundler
+          bundle install --jobs 4 --retry 3
+      - name: Run specs
+        run: |
+          bundle exec rake
+      - name: Trigger repositories
+        if: matrix.ruby == '2.6'
+        env:
+          GH_USERNAME: metanorma-ci
+          GH_ACCESS_TOKEN: ${{ secrets.METANORMA_CI_PAT_TOKEN }}
+        run: |
+          curl -LO --retry 3 https://raw.githubusercontent.com/metanorma/metanorma-build-scripts/master/trigger-gh-actions.sh
+          [[ -f ".github/workflows/dependent_repos.env" ]] && source .github/workflows/dependent_repos.env
+          CLIENT_PAYLOAD=$(cat <<EOF
+          "{ "ref": "${GITHUB_REF}", "repo": "${GITHUB_REPOSITORY}" }"
+          EOF
+          )
+          for repo in $REPOS
+          do
+            sh trigger-gh-actions.sh $ORGANISATION $repo $GH_USERNAME $GH_ACCESS_TOKEN $GITHUB_REPOSITORY "$CLIENT_PAYLOAD"
+          done

data/.github/workflows/windows.yml

@@ -0,0 +1,40 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+name: windows
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    paths-ignore:
+      - .github/workflows/macos.yml
+      - .github/workflows/ubuntu.yml
+
+jobs:
+  test-windows:
+    name: Test on Ruby ${{ matrix.ruby }} Windows
+    runs-on: windows-latest
+    continue-on-error: ${{ matrix.experimental }}
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ '2.6', '2.5', '2.4' ]
+        experimental: [false]
+        include:
+          - ruby: '2.7'
+            experimental: true
+    steps:
+      - uses: actions/checkout@master
+      - name: Use Ruby
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: Update gems
+        shell: pwsh
+        run: |
+          gem install bundler
+          bundle config --local path vendor/bundle
+          bundle install --jobs 4 --retry 3
+      - name: Run specs
+        run: |
+          bundle exec rake

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# 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. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and 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/Gemfile

@@ -0,0 +1,11 @@
+Encoding.default_external = Encoding::UTF_8
+Encoding.default_internal = Encoding::UTF_8
+
+source "https://rubygems.org"
+git_source(:github) { |repo| "https://github.com/#{repo}" }
+
+gemspec
+
+if File.exist? 'Gemfile.devel'
+  eval File.read('Gemfile.devel'), nil, 'Gemfile.devel' # rubocop:disable Security/Eval
+end

data/LICENSE

@@ -0,0 +1,25 @@
+BSD 2-Clause License
+
+Copyright (c) 2018, Ribose
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* 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,154 @@
+= Metanorma for BIPM: Metanorma processor for Bureau International de Poids et Mesures
+
+image:https://img.shields.io/gem/v/metanorma-bimp.sbimp["Gem Version", link="https://rubygems.org/gems/metanorma-bimp"]
+image:https://github.com/metanorma/metanorma-bimp/workflows/macos/badge.sbimp["Build Status (macOS)", link="https://github.com/metanorma/metanorma-bimp/actions?workflow=macos"]
+image:https://github.com/metanorma/metanorma-bimp/workflows/ubuntu/badge.sbimp["Build Status (ubuntu)", link="https://github.com/metanorma/metanorma-bimp/actions?workflow=ubuntu"]
+image:https://github.com/metanorma/metanorma-bimp/workflows/windows/badge.sbimp["Build Status (Windows)", link="https://github.com/metanorma/metanorma-bimp/actions?workflow=windows"]
+image:https://codeclimate.com/github/metanorma/metanorma-bimp/badges/gpa.sbimp["Code Climate", link="https://codeclimate.com/github/metanorma/metanorma-bimp"]
+image:https://img.shields.io/github/issues-pr-raw/metanorma/metanorma-bimp.sbimp["Pull Requests", link="https://github.com/metanorma/metanorma-bimp/pulls"]
+image:https://img.shields.io/github/commits-since/metanorma/metanorma-bimp/latest.sbimp["Commits since latest",link="https://github.com/metanorma/metanorma-bimp/releases"]
+
+== Functionality
+
+This gem processes http://asciidoctor.org/[Asciidoctor] documents following
+a template for generating BIPM standards.
+
+== Usage
+
+The preferred way to invoke this gem is via the `metanorma` script:
+
+[source,console]
+----
+$ metanorma --type bipm a.adoc                   # output HTML and PDF
+$ metanorma --type bipm --extensions html a.adoc # output just HTML
+$ metanorma --type bipm --extensions pdf a.pdf   # output just PDF
+$ metanorma --type bipm --extensions xml a.adoc  # output Metanorma XML
+----
+
+The gem translates the document into Metanorma XML format, and then
+validates its output against the BIPM Metanorma XML document model; errors are
+reported to console against the XML, and are intended for users to
+check that they have provided all necessary components of the
+document.
+
+The gem then converts the XML into output formats such as HTML and PDF.
+
+=== Installation
+
+If you are using a Mac, the https://github.com/riboseinc/metanorma-macos-setup
+repository has instructions on setting up your machine to run Metanorma
+scripts such as this one. You need only run the following in a Terminal console:
+
+[source,console]
+----
+$ bash <(curl -s https://raw.githubusercontent.com/riboseinc/metanorma-macos-setup/master/metanorma-setup)
+$ gem install metanorma-vg
+----
+
+
+== Document Attributes
+
+The gem relies on Asciidoctor document attributes to provide necessary
+metadata about the document. These include:
+
+`:edition:`:: The document edition
+
+`:revdate:`:: The date the document was last updated
+
+`:title-en:`:: The title of the document in English (mandatory)
+`:title-fr:`:: The title of the document in French (mandatory)
+`:title-cover-en:`:: The title of the front cover of the document in English (where different from the title proper)
+`:title-cover-fr:`:: The title of the front cover of the document in French (where different from the title proper)
+`:title-appendix-en:`:: The title of the appendix in English, if this document is an appendix published separately; `title-en` becomes the title of the main document, as presented within the standalone appendix.
+`:title-appendix-fr:`:: The title of the appendix in English, if this document is an appendix published separately; `title-en` becomes the title of the main document, as presented within the standalone appendix.
+
+`:appendix-id:`:: The number of the appendix, if this document is an appendix published separately
+
+`:si-aspect:`:: The domain of SI covered by the document; used to select logo in PDF cover page. The logo nominates one primary SI base units, and defining consonants for that unit and possibly others as well. The permitted values are:
++
+--
+* A_e_deltanu (ampere; time)
+* A_e (ampere)
+* cd_Kcd_h_deltanu (candela; mass, time)
+* cd_Kcd (candela)
+* full (all units)
+* K_k_deltanu (kelvin; mass, time)
+* K_k (kelvin)
+* kg_h_c_deltanu (kilogram; length, time)
+* kg_h (kilogram)
+* m_c_deltanu (metre; time)
+* m_c (metre)
+* mol_NA (mole)
+* s_deltanu (second)
+--
+
+`:copyright-year:`:: The year which will be claimed as when the copyright for
+the document was issued
+
+`:supersedes:`:: One or more BIPM document that this BIPM document standard supersedes; the superseded
+document may still remain in effect. Comma delimited.
+
+`:superseded-by:`:: One or more BIPM document that this BIPM document standard is superseded by; this
+document may still remain in effect. Comma delimited.
+
+`:doctype:`:: The document type (mandatory). The permitted types are:
++
+--
+* brochure (default)
+* mise-en-pratique
+* rapport
+* monographie
+* guide
+* meeting-report
+* technical-report
+* working-party-note
+* strategy
+* cipm-mra
+* resolution
+--
+
+`:status:``:: The document status. The permitted types are: `draft-proposal`,
+`draft-development`, `in-force`, `retired`.
+
+`:committee:`:: The name of the relevant committee (mandatory):
++
+--
+* CGPM: General Conference on Weights and Measures
+* CIPM: International Committee for Weights and Measures
+* BIPM: International Bureau of Weights and Measures
+* CCAUV: Consultative Committee for Acoustics, Ultrasound and Vibration
+* CCEM: Consultative Committee for Electricity and Magnetism
+* CCL: Consultative Committee for Length
+* CCM: Consultative Committee for Mass and Related Quantities
+* CCPR: Consultative Committee for Photometry and Radiometry
+* CCQM: Consultative Committee for Amount of Substance:: Metrology in Chemistry and Biology
+* CCRI: Consultative Committee for Ionizing Radiation
+* CCT: Consultative Committee for Thermometry
+* CCTF: Consultative Committee for Time and Frequency
+* CCU: Consultative Committee for Units
+* CCL-CCTF: Frequency Standards Working Group
+* JCGM: Joint Committee for Guides in Metrology
+* JCRB: Joint Committee of the Regional Metrology Organizations and the BIPM
+* JCTLM: Joint Committee for Traceability in Laboratory Medicine
+* INetQI: International Network on Quality Infrastructure
+--
+`:workgroup:`:: The name of the relevant workgroup (mandatory)
+
+`:language:` :: The language of the document (`en` or `fr`)  (mandatory)
+
+`:comment-period-from:`:: Start of the period during which comments are allowed on the document draft
+`:comment-period-to:`:: End of the period during which comments are allowed on the document draft (optional)
+
+`:obsoleted-date:`:: The date a document was superseded
+`:implemented-date:`:: The date a document became effective
+
+The attribute `:draft:`, if present, includes review notes in the XML output;
+these are otherwise suppressed.
+
+== Data Models
+
+The document model for BIPM is given in https://github.com/metanorma/metanorma-model-bipm[metanorma-model-bipm].
+
+== Examples
+
+Sample documents are given in https://github.com/metanorma/mn-samples-bipm[mn-samples-bipm]

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require 'isodoc/gem_tasks'
+
+IsoDoc::GemTasks.install
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "asciidoctor/vsd"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/rspec

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+  
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path(
+  "../../Gemfile", Pathname.new(__FILE__).realpath
+)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")
+