metanorma-mpfa 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0fb2546742168abc4af81c4a1c6921b0c01c2e27fb8d52eed46cf40a20f92353
+  data.tar.gz: 26473b6efacf914469da737a54fab479e00e171438a3838df6f19b003082b9fc
+SHA512:
+  metadata.gz: 57b0d79d12c1ce861cb7c52c14b2257e5d1ca30a9c52f01c241ce413ce62767b63c0e4b70d7d192d6b1ed4cf81319664ce8b6c9ec6b4b28a4d64d6ecf69f44ad
+  data.tar.gz: 0e70bf148a47b66edc05bc372da8b77d50d6693e31b8cd2c613cb6d6615ae510327e2d5c4ca31cae3f1d3c0f44beb0f39dce64602a268b594928db29ec09f541

data/.github/workflows/macos.yml

@@ -0,0 +1,39 @@
+# 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 }}
+          architecture: 'x64'
+      - 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,53 @@
+# 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 }}
+          architecture: 'x64'
+      - name: Update gems
+        run: |
+          gem install bundler
+          bundle install --jobs 4 --retry 3
+      - name: Run specs
+        run: |
+          bundle exec rake
+      - name: Trigger dependent repositories
+        if: github.ref == 'refs/heads/master' && matrix.ruby == '2.6'
+        env:
+          GH_USERNAME: ${{ secrets.PAT_USERNAME }}
+          GH_ACCESS_TOKEN: ${{ secrets.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
+          for repo in $DEPENDENT_REPOS
+          do
+            sh trigger-gh-actions.sh $ORGANISATION $repo $GH_USERNAME $GH_ACCESS_TOKEN $GITHUB_REPOSITORY "{ \"ref\": \"${GITHUB_REF}\" }"
+          done

data/.github/workflows/windows.yml

@@ -0,0 +1,41 @@
+# 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 }}
+          architecture: 'x64'
+      - 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/.gitignore

@@ -0,0 +1 @@
+.DS_Store

data/.hound.yml

@@ -0,0 +1,3 @@
+ruby:
+  Enabled: true
+  config_file: .rubocop.yml

data/.rubocop.yml

@@ -0,0 +1,10 @@
+# This project follows the Ribose OSS style guide.
+# https://github.com/riboseinc/oss-guides
+# All project-specific additions and overrides should be specified in this file.
+
+inherit_from:
+  - https://raw.githubusercontent.com/riboseinc/oss-guides/master/ci/rubocop.yml
+AllCops:
+  TargetRubyVersion: 2.3
+Rails:
+  Enabled: true

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,79 @@
+= Metanorma-MPFA: Metanorma processor for MPFA documents
+
+image:https://img.shields.io/gem/v/metanorma-mpfa.svg["Gem Version", link="https://rubygems.org/gems/metanorma-mpfa"]
+image:https://github.com/metanorma/metanorma-mpfa/workflows/macos/badge.svg["Build Status (macOS)", link="https://github.com/metanorma/metanorma-mpfa/actions?workflow=macos"]
+image:https://github.com/metanorma/metanorma-mpfa/workflows/ubuntu/badge.svg["Build Status (ubuntu)", link="https://github.com/metanorma/metanorma-mpfa/actions?workflow=ubuntu"]
+image:https://github.com/metanorma/metanorma-mpfa/workflows/windows/badge.svg["Build Status (Windows)", link="https://github.com/metanorma/metanorma-mpfa/actions?workflow=windows"]
+image:https://codeclimate.com/github/metanorma/metanorma-mpfa/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/metanorma/metanorma-mpfa"]
+image:https://img.shields.io/github/issues-pr-raw/metanorma/metanorma-mpfa.svg["Pull Requests", link="https://github.com/metanorma/metanorma-mpfa/pulls"]
+image:https://img.shields.io/github/commits-since/metanorma/metanorma-mpfa/latest.svg["Commits since latest",link="https://github.com/metanorma/metanorma-mpfa/releases"]
+
+_Formerly known as_ `metanorma-mpfd`.
+
+WARNING: This gem is still under development. Moreover, unlike other Metanorma gems, 
+there is no formal MPFA specification, and this work is still currently exploratory.
+
+== Functionality
+
+This gem processes http://asciidoctor.org/[Asciidoctor] documents following
+a template for generating documents for the http://www.mpfa.org.hk[Mandatory Provident Fund Schemes Authority of Hong Kong].
+
+The gem currently inherits from the https://github.com/metanorma/metanorma-standoc
+gem, and aligns closely to it. Refer to https://metanorma.com[] for guidance.
+
+== Usage
+
+The preferred way to invoke this gem is via the `metanorma` script:
+
+[source,console]
+----
+$ metanorma --type mpfa a.adoc                   # output HTML and DOC
+$ metanorma --type mpfa --extensions html a.adoc # output just HTML
+$ metanorma --type mpfa --extensions doc a.adoc  # output just DOC
+$ metanorma --type mpfa --extensions xml a.adoc  # output MPFA XML
+----
+
+The gem translates the document into Metanorma XML format, and then
+validates its output against the MPFA 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 DOC.
+
+Sample documents are available at https://github.com/metanorma/mn-samples-mpfa
+
+=== Installation
+
+If you are using a Mac, the https://github.com/metanorma/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/metanorma/metanorma-macos-setup/master/metanorma-setup)
+$ gem install metanorma-mpfa
+$ gem install metanorma-cli
+----
+
+The metanorma-cli gem is the command-line interface for the Metanorma tool suite
+(incorporating the `metanorma` executable seen above).
+
+== Documentation
+
+See https://www.metanorma.com/author/mpfa/[The MPFA flavor of Metanorma]
+
+
+== Data Models
+
+The MPFA Document format is an instance of the
+https://github.com/metanorma/metanorma-model-standoc[StandardDocument model]. Details of
+this general model can be found on its page. 
+
+== Examples
+
+* Example documents are avalable at the https://github.com/metanorma/mn-samples-mpfa[MPFA Samples] repository.
+
+////
+* Document templates are available at the https://github.com/metanorma/mn-templates-mpf[mn-templates-mpf] repository.
+/////

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "asciidoctor/rsd"
+
+# 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/manifest

@@ -0,0 +1,146 @@
+#!/usr/bin/env ruby
+
+require "yaml"
+require "optparse"
+require "metanorma"
+require "uuidtools"
+
+registry = Metanorma::Registry.instance
+supported_gem_paths = [
+  "asciidoctor-rfc",
+  "metanorma-iso",
+  "metanorma-gb",
+  "metanorma-csd",
+  "metanorma-csand",
+  "metanorma-m3d",
+  "metanorma-rsd",
+  "metanorma-acme",
+  "metanorma-standoc",
+]
+
+puts "[metanorma] detecting backends:"
+supported_gem_paths.each do |backend|
+  begin
+    puts backend
+    require backend
+  rescue LoadError
+    puts "[metanorma] backend #{backend} not present"
+  end
+end
+puts
+
+def uuid()
+  UUIDTools::UUID.random_create
+end
+
+def extract_documents(m)
+  return [] unless m and m["sections"]
+  ret = []
+  m["sections"].each do |s|
+    ret << s if s["file"]
+    ret << extract_documents(s) if s["sections"]
+  end
+  ret.flatten
+end
+
+def hyperlink(link)
+  return unless link
+  link.sub(/\.adoc(?=$|#)/, ".html")
+end
+
+def iterate(sections)
+  return "" unless sections
+  ret = ""
+  Array(sections).each do |m|
+    ret+= "<clause id='#{uuid}'>\n"
+    title = m["title"] && m["number"] ? "#{m['number']}. #{m['title']}" : ( m["number"] || m["title"] || "&mdash;" )
+    file = hyperlink(m["file"])
+    title = "<link target='#{file}'>#{title}</link>" if file
+    ret+= "<title>#{title}</title>\n"
+    ret+= "<p>#{m['description']}</p>\n" if m["description"]
+    ret+= "<p align='right'>#{m['revdate']}</p>\n" if m["revdate"]
+    ret += iterate(m["sections"])
+    ret+= "</clause>\n"
+  end
+  ret
+end
+
+options = {}
+opt_parser = OptionParser.new do |opts|
+  opts.banner += " <file>"
+  opts.on(
+    '-t',
+    '--type TYPE',
+    "Type of standard to generate"
+  ) { |v| options[:type] = v.to_sym }
+
+    opts.on(
+    '-r',
+    '--require LIBRARY',
+    'Require LIBRARY prior to execution'
+  ) { |v|
+    options[:require] ||= []
+    options[:require] << v
+  }
+
+
+  opts.on_tail("-h", "--help", "Show this message") do
+    puts opts
+    exit
+  end
+end
+opt_parser.parse!(ARGV)
+options[:filename] = ARGV.pop
+
+if options[:require]
+  options[:require].each do |r|
+    require r
+  end
+end
+
+
+manifest = YAML.load_file(ARGV.pop)
+
+documents = extract_documents(manifest)
+
+# TODO real lookup of namespaces and root elements
+
+out = <<~END
+<#{options[:type]}-standard xmlns="http://riboseinc.com/isoxml">
+<bibdata type="standard">
+  <title>#{manifest["title"]}</title>
+END
+
+# TODO leave in anchor references?
+#
+documents.each do |d|
+  out += <<~END
+  <relation type="partOf">
+    <bibdata type="standard">
+      <title>#{d['title']}</title>
+      <docidentifier>#{d['number']}</docidentifier>
+      <abstract>#{d['description']}</abstract>
+    </bibdata>
+  </relation>
+  END
+end
+
+out += <<~END
+</bibdata>
+<sections>
+END
+
+out+=iterate(manifest["sections"])
+
+out+= <<~END
+</sections>
+<#{options[:type]}-standard>
+END
+    outfilename = options[:filename].sub(/\.[^.]+$/, ".xml")
+    File.open(outfilename, "w") { |f| f.write out }
+
+  processor = registry.find_processor(options[:type].to_sym)
+  ext = :html
+    file_extension = "html" || processor.output_formats[ext] 
+    outfilename = options[:filename].sub(/\.[^.]+$/, ".#{file_extension}")
+    processor.output(out, outfilename, ext, {suppressheadingnumbers: true})