reverse_adoc 0.2.8 → 0.2.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb34effa1c1af2e72ef8df7b6b1553c7c2574bcca9608e02cfaf561ed8a2bfec
-  data.tar.gz: e18b3b9cf2d936a48fdf2e6d5f265aa5c945c9493bd232a4d8fb311df780e81f
+  metadata.gz: 906cadff19bcc530a5aa527f3a7cb87bd80050163638ce87d052d3615e82c68d
+  data.tar.gz: ffaf10410be78e4971c80a7c45c946aa4d4803546102b90c0c5bc01342dd962d
 SHA512:
-  metadata.gz: ca8454b96ad3064c16018f09198f8450f9a15e6525c1df6e63b7a0e3dd3254f66f2bee56e69e8c7088087962911480513f3608c759f955489b2e602dc2251890
-  data.tar.gz: 49c2198645f22b9ac26ea78aa36e1073a27807dca8364ad076250dccfc6b307055775894962d70d6400d7c8ec6b3dfa02cb31c84c922c60d8c18cbbf5ee55171
+  metadata.gz: 1436a34f5bd46e9c73d41028562f9edd78970bc5c88acf3cf815c6b76975c228045266c32e6cbc63ffcef3fc9d05101f51de446476f10ace57d565cc306d8629
+  data.tar.gz: 78e5514b5d5e01e5407d12644db5deda0d73e9d62f274932a2dee50de098dd65e36ddd96ef0a523726ec1915d80e42ab847d6227e8d927b5a85e229f53aaff86

data/.github/workflows/macos.yml

@@ -6,22 +6,29 @@ 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

data/.github/workflows/ubuntu.yml

@@ -6,22 +6,29 @@ on:
   push:
     branches: [ master ]
   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: Install LibreOffice
         run: sudo apt-get -y --no-install-recommends install libreoffice
       - name: Update gems

data/.github/workflows/windows.yml

@@ -6,22 +6,29 @@ 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: Install LibreOffice
         run: |
           choco install libreoffice-still

data/Gemfile

@@ -2,7 +2,7 @@ source "https://rubygems.org"
 
 git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 
-# Specify your gem's dependencies in reverse_asciidoctor.gemspec
+# Specify your gem's dependencies in reverse_adoc.gemspec
 gemspec
 
 gem "byebug"

data/README.adoc

@@ -247,7 +247,7 @@ The gem does not support:
 === MathML support
 
 If you are using this gem in the context of https://www.metanorma.com[Metanorma],
-Metanorma Asciidoctor accepts MathML as a native mathematical format. So you do not need
+Metanorma AsciiDoc accepts MathML as a native mathematical format. So you do not need
 to convert the MathML to AsciiMath.
 
 The gem will optionally invoke the https://github.com/metanorma/mathml2asciimath
@@ -265,7 +265,7 @@ uses the output) as such; so this is still much better than nothing for stem pro
 
 === Word cleanup
 
-This gem is routinely used in the Metanorma project to export Word documents to Asciidoctor.
+This gem is routinely used in the Metanorma project to export Word documents to AsciiDoc.
 The HTML export from Word that the gem uses, from LibreOffice, is much cleaner than the
 native HTML 4 export from Word; but it has some infelicities which this gem cleans up:
 
@@ -284,7 +284,7 @@ Simple to use.
 
 [source,ruby]
 ----
-result = ReverseAsciidoctor.convert input
+result = ReverseAdoc.convert input
 result.inspect # " *feelings* "
 ----
 
@@ -294,7 +294,7 @@ Just pass your chosen configuration options in after the input. The given option
 
 [source,ruby]
 ----
-ReverseAsciidoctor.convert(input, unknown_tags: :raise, mathml2asciimath: true)
+ReverseAdoc.convert(input, unknown_tags: :raise, mathml2asciimath: true)
 ----
 
 
@@ -304,7 +304,7 @@ Or configure it block style on a initializer level. These configurations will la
 
 [source,ruby]
 ----
-ReverseAsciidoctor.config do |config|
+ReverseAdoc.config do |config|
   config.unknown_tags      = :bypass
   config.mathml2asciimath  = true
   config.tag_border  = ''

data/Rakefile

@@ -10,5 +10,5 @@ task :default => :spec
 
 desc 'Open an irb session preloaded with this library'
 task :console do
-  sh 'irb -rubygems -I lib -r reverse_asciidoctor.rb'
+  sh 'irb -rubygems -I lib -r reverse_adoc.rb'
 end

data/bin/reverse_adoc

@@ -1,38 +1,38 @@
 #!/usr/bin/env ruby
-# Usage: reverse_asciidoctor [FILE]...
-# Usage: cat FILE | reverse_asciidoctor
+# Usage: reverse_adoc [FILE]...
+# Usage: cat FILE | reverse_adoc
 require 'rubygems'
 require 'bundler/setup'
 
-require 'reverse_asciidoctor'
+require 'reverse_adoc'
 require 'optparse'
 require 'fileutils'
 
 OptionParser.new do |opts|
   opts.banner = "Usage: reverse_adoc [options] <file>"
   opts.on('-m', '--mathml2asciimath', 'Convert MathML to AsciiMath') do |v|
-    ReverseAsciidoctor.config.mathml2asciimath = true
+    ReverseAdoc.config.mathml2asciimath = true
   end
 
   opts.on('-oFILENAME', '--output=FILENAME', 'Output file to write to') do |v|
-    ReverseAsciidoctor.config.destination = File.expand_path(v)
-    # puts "output goes to #{ReverseAsciidoctor.config.destination}"
+    ReverseAdoc.config.destination = File.expand_path(v)
+    # puts "output goes to #{ReverseAdoc.config.destination}"
   end
 
   opts.on('-e', '--external-images', 'Export images if data URI') do |v|
-    ReverseAsciidoctor.config.external_images = true
+    ReverseAdoc.config.external_images = true
   end
 
   opts.on('-f', '--input_format [html, smrl_description]', 'Unknown input format (default: html)') do |v|
-    ReverseAsciidoctor.config.input_format = v
+    ReverseAdoc.config.input_format = v
   end
 
   opts.on('-u', '--unknown_tags [pass_through, drop, bypass, raise]', 'Unknown tag handling (default: pass_through)') do |v|
-    ReverseAsciidoctor.config.unknown_tags = v
+    ReverseAdoc.config.unknown_tags = v
   end
 
   opts.on('-v', '--version', 'Version information') do |v|
-    puts "reverse_adoc: v#{ReverseAsciidoctor::VERSION}"
+    puts "reverse_adoc: v#{ReverseAdoc::VERSION}"
     exit
   end
 
@@ -45,30 +45,30 @@ end.parse!
 
 if filename = ARGV.pop
   input_content = IO.read(filename)
-  ReverseAsciidoctor.config.sourcedir = File.dirname(File.expand_path(filename))
+  ReverseAdoc.config.sourcedir = File.dirname(File.expand_path(filename))
 else
-  if ReverseAsciidoctor.config.external_images
+  if ReverseAdoc.config.external_images
     raise "The -e | --external-images feature cannot be used with STDIN input. Exiting."
   end
 
   input_content = ARGF.read
 end
 
-if ReverseAsciidoctor.config.external_images && ReverseAsciidoctor.config.destination.nil?
+if ReverseAdoc.config.external_images && ReverseAdoc.config.destination.nil?
   raise "The -e | --external-images feature must be used with -o | --output. Exiting."
 end
 
 # Read from STDIN
-adoc_content = ReverseAsciidoctor.convert(input_content)
+adoc_content = ReverseAdoc.convert(input_content)
 
 # Print to STDOUT
-unless ReverseAsciidoctor.config.destination
+unless ReverseAdoc.config.destination
   puts adoc_content
   exit
 end
 
-# Write output to ReverseAsciidoctor.config.destination
-FileUtils.mkdir_p(File.dirname(ReverseAsciidoctor.config.destination))
-File.open(ReverseAsciidoctor.config.destination, "w") do |file|
+# Write output to ReverseAdoc.config.destination
+FileUtils.mkdir_p(File.dirname(ReverseAdoc.config.destination))
+File.open(ReverseAdoc.config.destination, "w") do |file|
   file.write(adoc_content)
 end

data/bin/w2a

@@ -6,27 +6,27 @@ require 'bundler/setup'
 
 require 'word-to-markdown'
 require 'optparse'
-require 'reverse_asciidoctor'
+require 'reverse_adoc'
 
 ARGV.push('-h') if ARGV.empty?
 
 OptionParser.new do |opts|
   opts.banner = "Usage: w2a [options] <file>"
   opts.on('-m', '--mathml2asciimath', 'Convert MathML to AsciiMath') do |v|
-    ReverseAsciidoctor.config.mathml2asciimath = true
+    ReverseAdoc.config.mathml2asciimath = true
   end
 
   opts.on('-oFILENAME', '--output=FILENAME', 'Output file to write to') do |v|
-    ReverseAsciidoctor.config.destination = File.expand_path(v)
-    # puts "output goes to #{ReverseAsciidoctor.config.destination}"
+    ReverseAdoc.config.destination = File.expand_path(v)
+    # puts "output goes to #{ReverseAdoc.config.destination}"
   end
 
   opts.on('-e', '--external-images', 'Export images if data URI') do |v|
-    ReverseAsciidoctor.config.external_images = true
+    ReverseAdoc.config.external_images = true
   end
 
   opts.on('-v', '--version', 'Version information') do |v|
-    puts "reverse_adoc: v#{ReverseAsciidoctor::VERSION}"
+    puts "reverse_adoc: v#{ReverseAdoc::VERSION}"
     puts "[dependency] WordToMarkdown: v#{WordToMarkdown::VERSION}"
     unless Gem.win_platform?
       puts "[dependency] LibreOffice: v#{WordToMarkdown.soffice.version}"
@@ -46,28 +46,28 @@ end.parse!
 filename = ARGV.pop
 raise "Please provide an input file to process. Exiting." unless filename
 
-if ReverseAsciidoctor.config.external_images && ReverseAsciidoctor.config.destination.nil?
+if ReverseAdoc.config.external_images && ReverseAdoc.config.destination.nil?
   raise "The -e | --external-images feature must be used with -o | --output. Exiting."
 end
 
-ReverseAsciidoctor.config.sourcedir = Dir.mktmpdir
+ReverseAdoc.config.sourcedir = Dir.mktmpdir
 
-doc = WordToMarkdown.new(filename, ReverseAsciidoctor.config.sourcedir)
+doc = WordToMarkdown.new(filename, ReverseAdoc.config.sourcedir)
 #File.open("test.html", "w:UTF-8") { |f| f.write doc.document.html }
-adoc_content = ReverseAsciidoctor.convert(
-  ReverseAsciidoctor.cleaner.preprocess_word_html(doc.document.html),
+adoc_content = ReverseAdoc.convert(
+  ReverseAdoc.cleaner.preprocess_word_html(doc.document.html),
   WordToMarkdown::REVERSE_MARKDOWN_OPTIONS
 )
 # puts scrub_whitespace(doc.document.html)
 
 # Print to STDOUT
-unless ReverseAsciidoctor.config.destination
+unless ReverseAdoc.config.destination
   puts adoc_content
   exit
 end
 
-# Write output to ReverseAsciidoctor.config.destination
-FileUtils.mkdir_p(File.dirname(ReverseAsciidoctor.config.destination))
-File.open(ReverseAsciidoctor.config.destination, "w") do |file|
+# Write output to ReverseAdoc.config.destination
+FileUtils.mkdir_p(File.dirname(ReverseAdoc.config.destination))
+File.open(ReverseAdoc.config.destination, "w") do |file|
   file.write(adoc_content)
 end

data/lib/{reverse_asciidoctor.rb → reverse_adoc.rb}

@@ -2,20 +2,20 @@
 
 require 'digest'
 require 'nokogiri'
-require 'reverse_asciidoctor/version'
-require 'reverse_asciidoctor/errors'
-require 'reverse_asciidoctor/cleaner'
-require 'reverse_asciidoctor/config'
-require 'reverse_asciidoctor/converters'
-require 'reverse_asciidoctor/converters/base'
+require 'reverse_adoc/version'
+require 'reverse_adoc/errors'
+require 'reverse_adoc/cleaner'
+require 'reverse_adoc/config'
+require 'reverse_adoc/converters'
+require 'reverse_adoc/converters/base'
 
-module ReverseAsciidoctor
+module ReverseAdoc
   def self.convert(input, options = {})
     type = config.input_format
     name = "#{type}_converter"
-    require "reverse_asciidoctor/#{type}_converter"
+    require "reverse_adoc/#{type}_converter"
     constant = name.split('_').map(&:capitalize).join.to_s
-    ReverseAsciidoctor.const_get(constant).convert(input, options)
+    ReverseAdoc.const_get(constant).convert(input, options)
   end
 
   def self.config

data/lib/{reverse_asciidoctor → reverse_adoc}/cleaner.rb

@@ -1,4 +1,4 @@
-module ReverseAsciidoctor
+module ReverseAdoc
   class Cleaner
 
     def tidy(string)
@@ -36,19 +36,19 @@ module ReverseAsciidoctor
     # Same for underscores and brackets.
     def clean_tag_borders(string)
       result = string.gsub(/\s?\*{2,}.*?\*{2,}\s?/) do |match|
-        preserve_border_whitespaces(match, default_border: ReverseAsciidoctor.config.tag_border) do
+        preserve_border_whitespaces(match, default_border: ReverseAdoc.config.tag_border) do
           match.strip.sub('** ', '**').sub(' **', '**')
         end
       end
 
       result = result.gsub(/\s?\_{2,}.*?\_{2,}\s?/) do |match|
-        preserve_border_whitespaces(match, default_border: ReverseAsciidoctor.config.tag_border) do
+        preserve_border_whitespaces(match, default_border: ReverseAdoc.config.tag_border) do
           match.strip.sub('__ ', '__').sub(' __', '__')
         end
       end
 
       result = result.gsub(/\s?~{2,}.*?~{2,}\s?/) do |match|
-        preserve_border_whitespaces(match, default_border: ReverseAsciidoctor.config.tag_border) do
+        preserve_border_whitespaces(match, default_border: ReverseAdoc.config.tag_border) do
           match.strip.sub('~~ ', '~~').sub(' ~~', '~~')
         end
       end

data/lib/{reverse_asciidoctor → reverse_adoc}/config.rb

@@ -1,6 +1,6 @@
 require 'tmpdir'
 
-module ReverseAsciidoctor
+module ReverseAdoc
   class Config
     attr_accessor :unknown_tags, :tag_border, :mathml2asciimath, :external_images,
       :destination, :sourcedir, :image_counter, :image_counter_pattern, :input_format

data/lib/{reverse_asciidoctor → reverse_adoc}/converters.rb

@@ -1,4 +1,4 @@
-module ReverseAsciidoctor
+module ReverseAdoc
   module Converters
     def self.register(tag_name, converter)
       @@converters ||= {}
@@ -16,17 +16,17 @@ module ReverseAsciidoctor
     private
 
     def self.default_converter(tag_name)
-      case ReverseAsciidoctor.config.unknown_tags.to_sym
+      case ReverseAdoc.config.unknown_tags.to_sym
       when :pass_through
-        ReverseAsciidoctor::Converters::PassThrough.new
+        ReverseAdoc::Converters::PassThrough.new
       when :drop
-        ReverseAsciidoctor::Converters::Drop.new
+        ReverseAdoc::Converters::Drop.new
       when :bypass
-        ReverseAsciidoctor::Converters::Bypass.new
+        ReverseAdoc::Converters::Bypass.new
       when :raise
         raise UnknownTagError, "unknown tag: #{tag_name}"
       else
-        raise InvalidConfigurationError, "unknown value #{ReverseAsciidoctor.config.unknown_tags.inspect} for ReverseAsciidoctor.config.unknown_tags"
+        raise InvalidConfigurationError, "unknown value #{ReverseAdoc.config.unknown_tags.inspect} for ReverseAdoc.config.unknown_tags"
       end
     end
   end

data/lib/{reverse_asciidoctor → reverse_adoc}/converters/a.rb

@@ -1,6 +1,6 @@
 require "uri"
 
-module ReverseAsciidoctor
+module ReverseAdoc
   module Converters
     class A < Base
       def convert(node, state = {})

data/lib/{reverse_asciidoctor → reverse_adoc}/converters/aside.rb

@@ -1,4 +1,4 @@
-module ReverseAsciidoctor
+module ReverseAdoc
   module Converters
     class Aside < Base
       def convert(node, state = {})

data/lib/{reverse_asciidoctor → reverse_adoc}/converters/audio.rb

@@ -1,4 +1,4 @@
-module ReverseAsciidoctor
+module ReverseAdoc
   module Converters
     class Audio < Base
       def convert(node, state = {})