mnconvert 1.13.0 → 1.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c168fcbff9013a1acf4318cc88b7b5c90c3004ef250fa2bbdc885b8e4542a0e3
-  data.tar.gz: cee38d1e2eb34117860829504f8d21d3b221d20a6061e87cfeb43adcd4c42a9c
+  metadata.gz: a81599221a272e090908462b3f615a71611cf53e5c8c5f450866ed2514a7cf3c
+  data.tar.gz: 93cfb1a2d7f8d9e1bc846a4d2e44f38748131e9c3e8ff384cffb30fd35c8b14a
 SHA512:
-  metadata.gz: efc8815680af9f95db3d560b113ebd334cd06cbe61388b6547110a8a4d80bc3237deb9ac3a7f185c48db46fdfeb033add2a297f37971027f7ce928d5471595fe
-  data.tar.gz: ff74ee243c5a9db87ae0957b0ff880fd4088e28323922a29ed15dcaef5865e90df8f917b546eecb44c76c6aeed32341794d25d50efba02b367ef734b2692d101
+  metadata.gz: b284d2a94698d0bae078640ce501d6e0337dac4972777ba63f8cc0f18207913da041282b0f60b4a0bc90bb3fff5bba00c0230eb45bf4d2ff5f644d5626b6ef5c
+  data.tar.gz: d8d6d23ddb563d97235d61c8df661d16f9a5281878b7c140d2a43c572e4cabe45a7d2e77168fd62c69c900d0ce18cbfee5222deabe8f23def1d6d64b32b602af

data/.github/workflows/rake.yml

@@ -10,23 +10,6 @@ on:
 
 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: [ '3.0', '2.7', '2.6', '2.5' ]
-        os: [ ubuntu-latest, windows-latest, macos-latest ]
-        experimental: [ false ]
-    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
+    uses: metanorma/metanorma-build-scripts/.github/workflows/generic-rake.yml@main
+    secrets:
+      pat_token: ${{ secrets.METANORMA_CI_PAT_TOKEN }}

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

@@ -9,41 +9,36 @@ jobs:
     runs-on: ubuntu-18.04
     if: startsWith(github.event.client_payload.ref, 'refs/tags/v')
     steps:
-      - uses: actions/checkout@v1
-      - name: Add writable remote
-        run: |
-          git config --global user.name metanorma-ci
+      - uses: actions/checkout@v2
+        with:
+          token: ${{ secrets.METANORMA_CI_PAT_TOKEN }}
+
+      - run: |
+          git config --global user.name "metanorma-ci"
           git config --global user.email "metanorma-ci@users.noreply.github.com"
-          git remote add github https://metanorma-ci:${{ secrets.METANORMA_CI_PAT_TOKEN }}@github.com/$GITHUB_REPOSITORY
-          git pull github ${GITHUB_REF} --ff-only
-      - name: Parse mnconvert version
+
+      - run: echo mnconvert_VERSION=${mnconvert_TAG#*/v} >> ${GITHUB_ENV}
         env:
           mnconvert_TAG: ${{ github.event.client_payload.ref }}
-        run: |
-          echo mnconvert_VERSION=${mnconvert_TAG#*/v} >> ${GITHUB_ENV}
-      - name: Use Ruby
-        uses: actions/setup-ruby@v1
+
+      - uses: ruby/setup-ruby@v1
         with:
           ruby-version: '2.6'
-          architecture: 'x64'
-      - name: Update gems
-        run: |
-          gem install gem-release
-          gem install bundler
-          bundle install --jobs 4 --retry 3
-      - name: Update version
-        run: |
-          gem bump --version ${mnconvert_VERSION} --no-commit
-      - name: Update mnconvert.jar
-        run: |
+          bundler-cache: true
+
+      - run: gem install gem-release
+
+      - run: gem bump --version ${mnconvert_VERSION} --no-commit
+
+      - run: |
           rm -f bin/mnconvert.jar
-          rake bin/mnconvert.jar
-      - name: Run specs
-        run: |
-          bundle exec rake
+          bundle exec rake bin/mnconvert.jar
+
+      - run: bundle exec rake
+
       - name: Push commit and tag
         run: |
           git add -u bin/mnconvert.jar lib/mnconvert/version.rb
           git commit -m "Bump version to ${mnconvert_VERSION}"
           git tag v${mnconvert_VERSION}
-          git push github HEAD:${GITHUB_REF} --tags
+          git push origin HEAD:${GITHUB_REF} --tags

data/.github/workflows/release.yml

@@ -4,6 +4,7 @@ on:
   push:
     tags:
       - '*'
+  workflow_dispatch: # just for manual release if previous was failed
 
 jobs:
   release:

data/.gitignore

@@ -11,6 +11,3 @@
 # rspec failure tracking
 .rspec_status
 /.rubocop-http*
-
-/spec/fixtures/rice-en.cd.mn.xml
-/spec/fixtures/rice-en.final.sts.xml

data/Rakefile

@@ -1,28 +1,31 @@
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-require_relative 'lib/mnconvert/version'
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require_relative "lib/mnconvert/version"
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => ['bin/mnconvert.jar', 'spec/fixtures/rice-en.cd.mn.xml', 'spec/fixtures/rice-en.final.sts.xml', :spec]
+task default: [
+  "bin/mnconvert.jar",
+  "spec/fixtures/rice-en.cd.mn.xml",
+  "spec/fixtures/rice-en.final.sts.xml",
+  "spec/fixtures/rfc8650.xml",
+  :spec,
+]
 
 def uri_open(url)
   require 'open-uri'
-  if Gem::Version.new(RUBY_VERSION) < Gem::Version.new("2.5")
-    return open(url)
-  end
-  return URI.open(url)
+  URI.parse(url).open
 end
 
-file 'bin/mnconvert.jar' do |file|
+file "bin/mnconvert.jar" do |file|
   ver = MnConvert::MNCONVERT_JAR_VERSION
   url = "https://github.com/metanorma/mnconvert/releases/download/v#{ver}/mnconvert-#{ver}.jar"
-  File.open(file.name, 'wb') do |file|
-    file.write uri_open(url).read
+  File.open(file.name, "wb") do |f|
+    f.write uri_open(url).read
   end
 end
 
-file 'spec/fixtures/rice-en.cd.mn.xml' do |file|
+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|
@@ -30,10 +33,18 @@ file 'spec/fixtures/rice-en.cd.mn.xml' do |file|
   end
 end
 
-file 'spec/fixtures/rice-en.final.sts.xml' do |file|
+file "spec/fixtures/rice-en.final.sts.xml" do |file|
   uri = "https://raw.githubusercontent.com/metanorma/sts2mn/master/src/test/resources/rice-en.final.sts.xml"
 
   File.open(file.name, "w") do |saved_file|
     saved_file.write(uri_open(uri).read)
   end
-end
+end
+
+file "spec/fixtures/rfc8650.xml" do |file|
+  uri = "https://raw.githubusercontent.com/metanorma/mnconvert/main/src/test/resources/rfc/rfc8650.xml"
+
+  File.open(file.name, "w") do |saved_file|
+    saved_file.write(uri_open(uri).read)
+  end
+end

data/lib/mnconvert/version.rb

@@ -1,4 +1,4 @@
 module MnConvert
-  VERSION = "1.13.0"
+  VERSION = "1.15.0"
   MNCONVERT_JAR_VERSION = VERSION
 end

data/lib/mnconvert.rb

@@ -7,7 +7,9 @@ module MnConvert
     STS = :sts
   end
 
-  MNCONVERT_JAR_PATH = File.join(File.dirname(__FILE__), "../bin/mnconvert.jar")
+  MNCONVERT_JAR_NAME = "mnconvert.jar".freeze
+  MNCONVERT_JAR_PATH = File.join(File.dirname(__FILE__), "..", "bin",
+                                 MNCONVERT_JAR_NAME)
 
   def self.jvm_options
     options = ["-Xss5m", "-Xmx1024m"]
@@ -31,12 +33,10 @@ module MnConvert
     message.strip
   end
 
-  def self.convert(input_file, output_file, input_format, opts = {})
-    validate(opts, input_format)
+  def self.convert(input_file, opts = {})
+    validate(opts)
 
-    cmd = ["java", *jvm_options, "-jar", MNCONVERT_JAR_PATH,
-           input_file, "--input-format", input_format,
-           "--output", output_file, *optional_opts(opts)].join(" ")
+    cmd = [*java_cmd, input_file, *optional_opts(opts)].join(" ")
 
     puts cmd if opts[:debug]
     output_str, error_str, status = Open3.capture3(cmd)
@@ -50,16 +50,31 @@ module MnConvert
   class << self
     private
 
-    def validate(opts, input_format)
+    OPTIONAL_OPTS = {
+      sts_type: "--type",
+      imagesdir: "--imagesdir",
+      check_type: "--check-type",
+      input_format: "--input-format",
+      output_format: "--output-format",
+      output_file: "--output",
+      xsl_file: "--xsl-file",
+    }.freeze
+
+    def java_cmd
+      ["java", *jvm_options, "-jar", MNCONVERT_JAR_PATH]
+    end
+
+    def validate(opts)
       output_format = opts[:output_format]
+      debug = opts[:debug]
 
-      case input_format
+      case opts[:input_format]
       when InputFormat::MN
         validate_mn(opts, output_format)
       when InputFormat::STS
         validate_sts(opts, output_format)
       else
-        raise StandardError.new("Invalid input format: #{input_format}")
+        puts "input format will be decided by #{MNCONVERT_JAR_NAME}" if debug
       end
     end
 
@@ -84,16 +99,12 @@ module MnConvert
     end
 
     def optional_opts(opts)
-      result = {
-        sts_type: "--type",
-        imagesdir: "--imagesdir",
-        check_type: "--check-type",
-        output_format: "--output-format",
-        xsl_file: "--xsl-file",
-      }.reject { |k, _| opts[k].nil? }.map { |k, v| "#{v} #{opts[k]}" }
+      result = OPTIONAL_OPTS.reject { |k, _| opts[k].nil? }
+      result = result.map { |k, v| "#{v} #{opts[k]}" }
 
       result << "--debug" if opts[:debug]
       result << "--split-bibdata" if opts[:split_bibdata]
+      result << "--semantic" if opts[:semantic]
 
       result
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mnconvert
 version: !ruby/object:Gem::Version
-  version: 1.13.0
+  version: 1.15.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-11-16 00:00:00.000000000 Z
+date: 2022-03-01 00:00:00.000000000 Z
 dependencies: []
 description: |
   mnconvert converts Metanorma XML into NISO STS XML.