reverse_adoc 1.0.0 → 2.0.0

data/.gitignore

@@ -1,10 +0,0 @@
-/coverage
-/Gemfile.lock
-
-.DS_Store
-
-# RuboCop's remote style books
-.rubocop-https---*
-
-# Some odd files created by specs
-/test1

data/.hound.yml

@@ -1,5 +0,0 @@
-# Auto-generated by Cimas: Do not edit it manually!
-# See https://github.com/metanorma/cimas
-ruby:
-  enabled: true
-  config_file: .rubocop.yml

data/.rubocop.yml

@@ -1,10 +0,0 @@
-# Auto-generated by Cimas: Do not edit it manually!
-# See https://github.com/metanorma/cimas
-inherit_from:
-  - https://raw.githubusercontent.com/riboseinc/oss-guides/master/ci/rubocop.yml
-
-# local repo-specific modifications
-# ...
-
-AllCops:
-  TargetRubyVersion: 2.5

data/LICENSE.txt

@@ -1,25 +0,0 @@
-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/exe/reverse_adoc

@@ -1,70 +0,0 @@
-#!/usr/bin/env ruby
-# Usage: reverse_adoc [FILE]...
-# Usage: cat FILE | reverse_adoc
-require "rubygems"
-require "bundler/setup"
-
-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|
-    ReverseAdoc.config.mathml2asciimath = true
-  end
-
-  opts.on("-oFILENAME", "--output=FILENAME", "Output file to write to") do |v|
-    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|
-    ReverseAdoc.config.external_images = true
-  end
-
-  opts.on("-u", "--unknown_tags [pass_through, drop, bypass, raise]",
-          "Unknown tag handling (default: pass_through)") do |v|
-    ReverseAdoc.config.unknown_tags = v
-  end
-
-  opts.on("-v", "--version", "Version information") do |_v|
-    puts "reverse_adoc: v#{ReverseAdoc::VERSION}"
-    exit
-  end
-
-  opts.on("-h", "--help", "Prints this help") do
-    puts opts
-    exit
-  end
-end.parse!
-
-if filename = ARGV.pop
-  input_content = IO.read(filename)
-  ReverseAdoc.config.sourcedir = File.dirname(File.expand_path(filename))
-else
-  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 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 = ReverseAdoc.convert(input_content)
-
-# Print to STDOUT
-unless ReverseAdoc.config.destination
-  puts adoc_content
-  exit
-end
-
-# 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/exe/w2a

@@ -1,72 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require "rubygems"
-require "bundler/setup"
-
-require "word-to-markdown"
-require "optparse"
-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|
-    ReverseAdoc.config.mathml2asciimath = true
-  end
-
-  opts.on("-oFILENAME", "--output=FILENAME", "Output file to write to") do |v|
-    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|
-    ReverseAdoc.config.external_images = true
-  end
-
-  opts.on("-v", "--version", "Version information") do |_v|
-    puts "reverse_adoc: v#{ReverseAdoc::VERSION}"
-    puts "[dependency] WordToMarkdown: v#{WordToMarkdown::VERSION}"
-    if Gem.win_platform?
-      puts "[dependency] LibreOffice: version not available on Windows"
-    else
-      puts "[dependency] LibreOffice: v#{WordToMarkdown.soffice.version}"
-    end
-    exit
-  end
-
-  opts.on("-h", "--help", "Prints this help") do
-    puts opts
-    exit
-  end
-end.parse!
-
-filename = ARGV.pop
-raise "Please provide an input file to process. Exiting." unless filename
-
-if ReverseAdoc.config.external_images && ReverseAdoc.config.destination.nil?
-  raise "The -e | --external-images feature must be used with -o | --output. Exiting."
-end
-
-ReverseAdoc.config.sourcedir = Dir.mktmpdir
-
-doc = WordToMarkdown.new(filename, ReverseAdoc.config.sourcedir)
-# File.open("test.html", "w:UTF-8") { |f| f.write 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 ReverseAdoc.config.destination
-  puts adoc_content
-  exit
-end
-
-# 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_adoc/cleaner.rb

@@ -1,113 +0,0 @@
-module ReverseAdoc
-  class Cleaner
-    def tidy(string)
-      result = remove_inner_whitespaces(string)
-      result = remove_newlines(result)
-      result = remove_leading_newlines(result)
-      result = clean_tag_borders(result)
-      clean_punctuation_characters(result)
-    end
-
-    def remove_newlines(string)
-      string.gsub(/\n{3,}/, "\n\n")
-    end
-
-    def remove_leading_newlines(string)
-      string.gsub(/\A\n+/, "")
-    end
-
-    def remove_inner_whitespaces(string)
-      unless string.nil?
-        string.gsub!(/\n stem:\[/, "\nstem:[")
-        string.gsub!(/(stem:\[([^\]]|\\\])*\])\n(?=\S)/, "\\1 ")
-        string.gsub!(/(stem:\[([^\]]|\\\])*\])\s+(?=[\^-])/, "\\1")
-      end
-      string.each_line.inject("") do |memo, line|
-        memo + preserve_border_whitespaces(line) do
-          line.strip.gsub(/[ \t]{2,}/, " ")
-        end
-      end
-    end
-
-    # Find non-asterisk content that is enclosed by two or
-    # more asterisks. Ensure that only one whitespace occurs
-    # in the border area.
-    # 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: ReverseAdoc.config.tag_border) do
-      #   match.strip.sub("** ", "**").sub(" **", "**")
-      # end
-      # end
-
-      # result = string.gsub(/\s?_{2,}.*?_{2,}\s?/) do |match|
-      #   preserve_border_whitespaces(match, default_border: ReverseAdoc.config.tag_border) do
-      #     match.strip.sub("__ ", "__").sub(" __", "__")
-      #   end
-      # end
-
-      result = string.gsub(/\s?~{2,}.*?~{2,}\s?/) do |match|
-        preserve_border_whitespaces(match,
-                                    default_border: ReverseAdoc.config.tag_border) do
-          match.strip.sub("~~ ", "~~").sub(" ~~", "~~")
-        end
-      end
-
-      result.gsub(/\s?\[.*?\]\s?/) do |match|
-        preserve_border_whitespaces(match) do
-          match.strip.sub("[ ", "[").sub(" ]", "]")
-        end
-      end
-    end
-
-    def clean_punctuation_characters(string)
-      string.gsub(/(\*\*|~~|__)\s([.!?'"])/, "#{'\\1'.strip}\\2")
-    end
-
-    # preprocesses HTML, rather than postprocessing it
-    def preprocess_word_html(string)
-      clean_headings(scrub_whitespace(string.dup))
-    end
-
-    def scrub_whitespace(string)
-      string.gsub!(/ | |\u00a0/i, " ") # HTML encoded spaces
-      string.sub!(/^\A[[:space:]]+/m, "") # document leading whitespace
-      string.sub!(/[[:space:]]+\z$/m, "") # document trailing whitespace
-      string.gsub!(/( +)$/, " ") # line trailing whitespace
-      string.gsub!(/\n\n\n\n/, "\n\n") # Quadruple line breaks
-      # string.delete!('?| ')               # Unicode non-breaking spaces, injected as tabs
-      string
-    end
-
-    # following added by me
-    def clean_headings(string)
-      string.gsub!(%r{<h([1-9])[^>]*></h\1>}, " ")
-      # I don't know why Libre Office is inserting them, but they need to go
-      string.gsub!(%r{<h([1-9])[^>]* style="vertical-align: super;[^>]*>(.+?)</h\1>},
-                   "<sup>\\2</sup>")
-      # I absolutely don't know why Libre Office is rendering superscripts as h1
-      string
-    end
-
-    private
-
-    def preserve_border_whitespaces(string, options = {})
-      return string if /\A\s*\Z/.match?(string)
-
-      default_border = options.fetch(:default_border, "")
-      # If the string contains part of a link so the characters [,],(,)
-      # then don't add any extra spaces
-      default_border = "" if /[\[(\])]/.match?(string)
-      string_start   = present_or_default(string[/\A\s*/], default_border)
-      string_end     = present_or_default(string[/\s*\Z/], default_border)
-      result         = yield
-      string_start + result + string_end
-    end
-
-    def present_or_default(string, default)
-      return default if string.nil? || string.empty?
-
-      string
-    end
-  end
-end

data/lib/reverse_adoc/config.rb

@@ -1,54 +0,0 @@
-require "tmpdir"
-
-module ReverseAdoc
-  class Config
-    attr_accessor :unknown_tags, :tag_border, :mathml2asciimath, :external_images,
-                  :destination, :sourcedir, :image_counter, :image_counter_pattern, :input_format
-
-    def initialize
-      @unknown_tags     = :pass_through
-      @input_format     = :html
-      @mathml2asciimath = false
-      @external_images  = false
-
-      # Destination to save file and images
-      @destination      = nil
-
-      # Source of HTML
-      # @sourcedir        = nil
-
-      # Image counter, assuming there are max 999 images
-      @image_counter = 1
-      # pad with 0s
-      @image_counter_pattern = "%03d"
-
-      @em_delimiter     = "_".freeze
-      @strong_delimiter = "*".freeze
-      @inline_options   = {}
-      @tag_border       = " ".freeze
-    end
-
-    def with(options = {})
-      @inline_options = options
-      result = yield
-      @inline_options = {}
-      result
-    end
-
-    def unknown_tags
-      @inline_options[:unknown_tags] || @unknown_tags
-    end
-
-    def mathml2asciimath
-      @inline_options[:mathml2asciimath] || @mathml2asciimath
-    end
-
-    def external_images
-      @inline_options[:external_images] || @external_images
-    end
-
-    def tag_border
-      @inline_options[:tag_border] || @tag_border
-    end
-  end
-end

data/lib/reverse_adoc/converters/a.rb

@@ -1,42 +0,0 @@
-require "coradoc"
-
-module ReverseAdoc
-  module Converters
-    class A < Base
-      def to_coradoc(node, state = {})
-        name  = treat_children(node, state)
-
-        href  = node["href"]
-        title = extract_title(node)
-        id = node["id"] || node["name"]
-
-        id = id&.gsub(/\s/, "")&.gsub(/__+/, "_")
-
-        return "" if /^_Toc\d+$|^_GoBack$/.match?(id)
-
-        if !id.nil? && !id.empty?
-          return Coradoc::Element::Inline::Anchor.new(id)
-        end
-
-        if href.to_s.start_with?("#")
-          href = href.sub(/^#/, "").gsub(/\s/, "").gsub(/__+/, "_")
-          return Coradoc::Element::Inline::CrossReference.new(href, name)
-        end
-
-        if href.to_s.empty?
-          return name
-        end
-
-        Coradoc::Element::Inline::Link.new(path: href,
-                                           name: name,
-                                           title: title)
-      end
-
-      def convert(node, state = {})
-        Coradoc::Generator.gen_adoc(to_coradoc(node, state))
-      end
-    end
-
-    register :a, A.new
-  end
-end

data/lib/reverse_adoc/converters/aside.rb

@@ -1,16 +0,0 @@
-module ReverseAdoc
-  module Converters
-    class Aside < Base
-      def to_coradoc(node, state = {})
-        content = treat_children(node, state)
-        Coradoc::Element::Block::Side.new(lines: content.lines)
-      end
-
-      def convert(node, state = {})
-        Coradoc::Generator.gen_adoc(to_coradoc(node, state))
-      end
-    end
-
-    register :aside, Aside.new
-  end
-end

data/lib/reverse_adoc/converters/audio.rb

@@ -1,29 +0,0 @@
-module ReverseAdoc
-  module Converters
-    class Audio < Base
-      def to_coradoc(node, _state = {})
-        src = node["src"]
-        id = node["id"]
-        title = extract_title(node)
-        attributes = Coradoc::Element::AttributeList.new
-        options = options(node)
-        attributes.add_named("options", options) if options.any?
-        Coradoc::Element::Audio.new(title, id: id, src: src,
-                                           attributes: attributes)
-      end
-
-      def convert(node, state = {})
-        Coradoc::Generator.gen_adoc(to_coradoc(node, state))
-      end
-
-      def options(node)
-        autoplay = node["autoplay"]
-        loop_attr = node["loop"]
-        controls = node["controls"]
-        [autoplay, loop_attr, controls].compact
-      end
-    end
-
-    register :audio, Audio.new
-  end
-end

data/lib/reverse_adoc/converters/base.rb

@@ -1,100 +0,0 @@
-module ReverseAdoc
-  module Converters
-    class Base
-      def treat_children(node, state)
-        node.children.inject("") do |memo, child|
-          memo << treat(child, state)
-        end
-      end
-
-      def treat(node, state)
-        ReverseAdoc::Converters.lookup(node.name).convert(node, state)
-      end
-
-      def treat_children_coradoc(node, state)
-        node.children.inject([]) do |memo, child|
-          memo << treat_coradoc(child, state)
-        end.flatten.reject { |x| x == "" || x.nil? }
-      end
-
-      def treat_coradoc(node, state)
-        ReverseAdoc::Converters.lookup(node.name).to_coradoc(node, state)
-      end
-
-      def escape_keychars(string)
-        subs = { "*" => '\*', "_" => '\_' }
-        string
-          .gsub(/((?<=\s)[\*_]+)|[\*_]+(?=\s)/) do |n|
-          n.chars.map do |char|
-            subs[char]
-          end.join
-        end
-      end
-
-      def extract_title(node)
-        title = escape_keychars(node["title"].to_s)
-        title.empty? ? "" : %[ #{title}]
-      end
-
-      def node_has_ancestor?(node, name)
-        case name
-        when String
-          node.ancestors.map(&:name).include?(name)
-        when Array
-          (node.ancestors.map(&:name) & name).any?
-        end
-      end
-
-      def textnode_before_end_with?(node, str)
-        return nil if !str.is_a?(String) || str.empty?
-
-        node2 = node.at_xpath("preceding-sibling::node()[1]")
-        node2.respond_to?(:text) && node2.text.end_with?(str)
-      end
-
-      def unconstrained_before?(node)
-        before = node.at_xpath("preceding::node()[1]")
-
-        before &&
-          !before.text.strip.empty? &&
-          before.text[-1]&.match?(/\w/)
-      end
-
-      # TODO: This logic ought to be cleaned up.
-      def unconstrained_after?(node)
-        after = node.at_xpath("following::node()[1]")
-
-        after && !after.text.strip.empty? &&
-          after.text[0]&.match?(/\w|,|;|"|\.\?!/)
-      end
-
-      # def trailing_whitespace?(node)
-
-      # TODO: This logic ought to be cleaned up.
-      def constrained?(node)
-        before = node.at_xpath("preceding::node()[1]").to_s[-1]
-        before = if before
-                   before&.match?(/\s/) ? true : false
-                 else
-                   true
-                 end
-
-        if !before && (node.to_s[0] =~ /\s/)
-          before = true
-        end
-
-        after = node.at_xpath("following::node()[1]").to_s[0]
-        after = if after
-                  after&.match?(/\s|,|;|"|\.\?!/) ? true : false
-                else
-                  true
-                end
-        if !after && (node.to_s[-1] =~ /\s/)
-          after = true
-        end
-
-        before && after
-      end
-    end
-  end
-end

data/lib/reverse_adoc/converters/blockquote.rb

@@ -1,27 +0,0 @@
-module ReverseAdoc
-  module Converters
-    class Blockquote < Base
-      def to_coradoc(node, state = {})
-        node["id"]
-        cite = node["cite"]
-        attributes = if cite.nil?
-                       nil
-                     else
-                       Coradoc::Element::AttributeList.new(
-                         "quote", cite
-                       )
-                     end
-        content = treat_children(node, state).strip
-        content = ReverseAdoc.cleaner.remove_newlines(content)
-        Coradoc::Element::Block::Quote.new(nil, lines: content,
-                                                attributes: attributes)
-      end
-
-      def convert(node, state = {})
-        Coradoc::Generator.gen_adoc(to_coradoc(node, state))
-      end
-    end
-
-    register :blockquote, Blockquote.new
-  end
-end

data/lib/reverse_adoc/converters/br.rb

@@ -1,15 +0,0 @@
-module ReverseAdoc
-  module Converters
-    class Br < Base
-      def to_coradoc(_node, _state = {})
-        Coradoc::Element::Inline::HardLineBreak.new
-      end
-
-      def convert(node, state = {})
-        Coradoc::Generator.gen_adoc(to_coradoc(node, state))
-      end
-    end
-
-    register :br, Br.new
-  end
-end

data/lib/reverse_adoc/converters/bypass.rb

@@ -1,81 +0,0 @@
-module ReverseAdoc
-  module Converters
-    class Bypass < Base
-      def to_coradoc(node, state = {})
-        treat_children_coradoc(node, state)
-      end
-
-      def convert(node, state = {})
-        Coradoc::Generator.gen_adoc(to_coradoc(node, state))
-      end
-    end
-
-    register :document, Bypass.new
-    register :html,     Bypass.new
-    register :body,     Bypass.new
-    register :span,     Bypass.new
-    register :thead,    Bypass.new
-    register :tbody,    Bypass.new
-    register :tfoot,    Bypass.new
-    register :abbr, Bypass.new
-    register :acronym,    Bypass.new
-    register :address,    Bypass.new
-    register :applet, Bypass.new
-    register :map, Bypass.new
-    register :area, Bypass.new
-    register :bdi,    Bypass.new
-    register :bdo,    Bypass.new
-    register :big,    Bypass.new
-    register :button,    Bypass.new
-    register :canvas,    Bypass.new
-    register :data, Bypass.new
-    register :datalist, Bypass.new
-    register :del,    Bypass.new
-    register :ins,    Bypass.new
-    register :dfn,    Bypass.new
-    register :dialog, Bypass.new
-    register :embed, Bypass.new
-    register :fieldset, Bypass.new
-    register :font, Bypass.new
-    register :footer, Bypass.new
-    register :form, Bypass.new
-    register :frame, Bypass.new
-    register :frameset, Bypass.new
-    register :header,    Bypass.new
-    register :iframe,    Bypass.new
-    register :input,    Bypass.new
-    register :label,    Bypass.new
-    register :legend, Bypass.new
-    register :main,    Bypass.new
-    register :menu,    Bypass.new
-    register :menulist, Bypass.new
-    register :meter, Bypass.new
-    register :nav, Bypass.new
-    register :noframes,    Bypass.new
-    register :noscript,    Bypass.new
-    register :object, Bypass.new
-    register :optgroup, Bypass.new
-    register :option,    Bypass.new
-    register :output,    Bypass.new
-    register :param, Bypass.new
-    register :picture, Bypass.new
-    register :progress, Bypass.new
-    register :ruby, Bypass.new
-    register :rt,    Bypass.new
-    register :rp,    Bypass.new
-    register :s, Bypass.new
-    register :select, Bypass.new
-    register :small, Bypass.new
-    register :span, Bypass.new
-    register :strike, Bypass.new
-    register :details,    Bypass.new
-    register :section,    Bypass.new
-    register :summary,    Bypass.new
-    register :svg, Bypass.new
-    register :template,    Bypass.new
-    register :textarea,    Bypass.new
-    register :track, Bypass.new
-    register :u, Bypass.new
-    register :wbr, Bypass.new
-  end
-end