mn2sts 1.0.1 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: faa2b82e626f0e881dfb528d5d8af44a0595e788805e397e8e407cd3729a4da8
-  data.tar.gz: 827af3746c0532afd6ad7e7ff2eafb2113205438c0ebdf8d6ec7f0bc29055849
+  metadata.gz: 728c21f447228036c9c7bd4f3e8069db7f122c9e3c3adc2feba8cb6c622692a1
+  data.tar.gz: 81816654bc4fa7cbf7136c4260786107b94f821a6a4930d9e7b5d1e1dae84159
 SHA512:
-  metadata.gz: 33d036cd117a176b9a61e44822bf05780a2237fba5b443366aa7100478e6a345de87ce06b86cdb8f3cfe551732ab977134bcc9b1f1eed577bb6e54fadefa43d6
-  data.tar.gz: d86909d3bd656d2f02a1b0491a8f9d16aadfd57a23ad6c1ff128da9aa97c056317290fd38bfa105137f512b63cb714f0d7aa49323d6a28b31201e29d6a984df6
+  metadata.gz: bed52d1f5a451a1013364c6089171292fe41408b581f2d05c3dcbe7c0dcc40fd91c8bb0988fe795cd20fabdd1e327224a3561515764b3b66547395566283e110
+  data.tar.gz: 588205a92867327303f3a39320c6fcb695dfe277657c90ebcb2cfa45ddff743382f55e9bbd2e4cf45b117bcc8dcca25cf5c72a17b4c6b9ccf33078ed0edfd49b

data/.github/workflows/rake.yml

@@ -0,0 +1,42 @@
+# 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:
+    name: Test on Ruby ${{ matrix.ruby }} ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    continue-on-error: ${{ matrix.experimental }}
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ '2.7', '2.6', '2.5', '2.4' ]
+        os: [ ubuntu-latest, windows-latest, macos-latest ]
+        experimental: [ false ]
+        include:
+          - ruby: '3.0'
+            os: 'ubuntu-latest'
+            experimental: true
+          - ruby: '3.0'
+            os: 'windows-latest'
+            experimental: true
+          - ruby: '3.0'
+            os: 'macos-latest'
+            experimental: true
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          submodules: true
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - run: bundle exec rake

data/.github/workflows/release-tag.yml

@@ -20,7 +20,7 @@ jobs:
         env:
           mn2sts_TAG: ${{ github.event.client_payload.ref }}
         run: |
-          echo "::set-env name=mn2sts_VERSION::${mn2sts_TAG#*/v}"
+          echo mn2sts_VERSION=${mn2sts_TAG#*/v} >> ${GITHUB_ENV}
       - name: Use Ruby
         uses: actions/setup-ruby@v1
         with:

data/.gitignore

@@ -10,3 +10,4 @@
 
 # rspec failure tracking
 .rspec_status
+/.rubocop-http*

data/.rubocop.yml

@@ -0,0 +1,6 @@
+# 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

data/README.adoc

@@ -1,6 +1,6 @@
 = mn2sts Ruby gem
 
-image:https://img.shields.io/gem/v/metanorma.svg["Gem Version", link="https://rubygems.org/gems/metanorma"]
+image:https://img.shields.io/gem/v/mn2sts.svg["Gem Version", link="https://rubygems.org/gems/mn2sts"]
 image:https://github.com/metanorma/mn2sts-ruby/workflows/ubuntu/badge.svg["Ubuntu Build Status", link="https://github.com/metanorma/mn2sts-ruby/actions?query=workflow%3Aubuntu"]
 image:https://github.com/metanorma/mn2sts-ruby/workflows/macos/badge.svg["OSX Build Status", link="https://github.com/metanorma/mn2sts-ruby/actions?query=workflow%3Amacos"]
 image:https://github.com/metanorma/mn2sts-ruby/workflows/windows/badge.svg["Windows Build Status", link="https://github.com/metanorma/mn2sts-ruby/actions?query=workflow%3Awindows"]
@@ -30,7 +30,7 @@ Or include it in your gemspec.
 [source,ruby]
 ----
 require 'mn2sts'
-Mn2sts.convert(sample_xml_path, output_pdf_path, sample_xsl_path)
+Mn2sts.convert(sample_xml_path, output_pdf_path)
 ----
 
 == Updating the gem

data/Rakefile

@@ -1,10 +1,11 @@
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 require_relative 'lib/mn2sts/version'
+require 'open-uri'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task :default => ['bin/mn2sts.jar', 'spec/fixtures/rice-en.cd.mn.xml', :spec]
 
 require 'open-uri'
 
@@ -15,3 +16,15 @@ file 'bin/mn2sts.jar' do |file|
     file.write open(url).read
   end
 end
+
+file 'spec/fixtures/rice-en.cd.mn.xml' do |file|
+  uri = "https://raw.githubusercontent.com/metanorma/mn-samples-iso/gh-pages/documents/international-standard/rice-en.cd.xml"
+
+  File.open(file.name, "w") do |saved_file|
+    # the following "open" is provided by open-uri
+    open(uri, "r") do |read_file|
+      saved_file.write(read_file.read)
+    end
+  end
+
+end

data/lib/mn2sts.rb

@@ -1,35 +1,45 @@
-require 'open3'
-require 'mn2sts/version'
+require "open3"
+require "mn2sts/version"
 
 module Mn2sts
-  MN2STS_JAR_PATH = File.join(File.dirname(__FILE__), '../bin/mn2sts.jar')
+  MN2STS_JAR_PATH = File.join(File.dirname(__FILE__), "../bin/mn2sts.jar")
+
+  def self.jvm_options
+    options = []
+
+    if RbConfig::CONFIG["host_os"].match?(/darwin|mac os/)
+      options << "-Dapple.awt.UIElement=true"
+    end
+
+    options
+  end
 
   def self.help
-    cmd = ['java', '-jar', MN2STS_JAR_PATH].join(' ')
-    message, error_str, status = Open3.capture3(cmd)
+    cmd = ["java", *jvm_options, "-jar", MN2STS_JAR_PATH].join(" ")
+    message, = Open3.capture3(cmd)
     message
   end
 
   def self.version
-    cmd = ['java', '-jar', MN2STS_JAR_PATH, '-v'].join(' ')
-    message, error_str, status = Open3.capture3(cmd)
+    cmd = ["java", *jvm_options, "-jar", MN2STS_JAR_PATH, "-v"].join(" ")
+    message, = Open3.capture3(cmd)
     message.strip
   end
 
-  def self.convert(url_path, output_path, xsl_stylesheet)
-    return if url_path.nil? || output_path.nil? || xsl_stylesheet.nil?
+  def self.convert(xml_path_in, xml_path_out, opts = {})
+    return if xml_path_in.nil? || xml_path_out.nil?
+
+    cmd = ["java", "-Xss5m", "-Xmx1024m", *jvm_options, "-jar", MN2STS_JAR_PATH,
+           "--xml-file-in", xml_path_in, "--xml-file-out", xml_path_out].join(" ")
 
-    puts MN2STS_JAR_PATH
-    cmd = ['java', '-Xss5m', '-Xmx1024m', '-jar', MN2STS_JAR_PATH, '--xml-file',
-           url_path, '--xsl-file', xsl_stylesheet, '--pdf-file',
-           output_path].join(' ')
+    cmd += " --output-format iso" if opts[:iso]
 
     puts cmd
     _, error_str, status = Open3.capture3(cmd)
 
     unless status.success?
+      warn error_str
       raise error_str
     end
   end
-
 end

data/lib/mn2sts/version.rb

@@ -1,4 +1,4 @@
 module Mn2sts
-  MN2STS_JAR_VERSION = '1.0'
-  VERSION = "#{MN2STS_JAR_VERSION}.1"
+  MN2STS_JAR_VERSION = '1.8'
+  VERSION = "#{MN2STS_JAR_VERSION}.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mn2sts
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.8.0
 platform: ruby
 authors:
 - Ribose Inc.
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-05-24 00:00:00.000000000 Z
+date: 2021-05-24 00:00:00.000000000 Z
 dependencies: []
 description: |
   mn2sts converts Metanorma XML into NISO STS XML.
@@ -20,13 +20,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/macos.yml"
+- ".github/workflows/rake.yml"
 - ".github/workflows/release-tag.yml"
 - ".github/workflows/release.yml"
-- ".github/workflows/ubuntu.yml"
-- ".github/workflows/windows.yml"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - README.adoc
@@ -41,7 +40,7 @@ homepage: https://github.com/metanorma/mn2sts-ruby
 licenses:
 - BSD-2-Clause
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -56,8 +55,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: mn2sts converts Metanorma XML into NISO STS XML.
 test_files: []

data/.github/workflows/macos.yml

@@ -1,39 +0,0 @@
-# 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

@@ -1,53 +0,0 @@
-# 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

@@ -1,41 +0,0 @@
-# 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