coradoc 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '09284ec8117d3052ad45275f82328e45e600fabc4f86379093af0dbe4ee9ebc4'
-  data.tar.gz: 8c9e2cef678a473459b091d05c303110a0caca9179d5ea89e1f4a07608d7bb9c
+  metadata.gz: c721a05ddb985a8bde74747c3c39e47818beca7525b13115794673394d46b2ab
+  data.tar.gz: f45600c3b4b85877a97904f38a03d5161b0ff83e7259ad6f54da5e1711ac9e46
 SHA512:
-  metadata.gz: 35510139cf9cd1cf0eedaaf12b0bc80709628660d88e0178f3651d7f213c870abf68eb04de6f23a8056af4681875f7ba59804228937bc65bfb6550753a4fb769
-  data.tar.gz: 714c0f79bdd9bb05d58de71c6ab5bcdedddcd48a784fad4b019e168078c221ee6e477c573822a6a8f2db328fa02da5a0b9ef60542f239adb0b109c40ff309a66
+  metadata.gz: 0063e9145b1a8e46046c7397b4278a480535ee119624842fad72a8e9280def9de4af7c8335dc5f64b5a118040a8e178af800b27879d8c335a00d37d574b34bbb
+  data.tar.gz: 8f02e79025a941ab47c8f359a7638129ce2e7a7aa80352a38bb9004540efdbadff8cd3c0427641004ab834a346f7d39676b9ace64e47f62dcbb9c0b0a357d2ce

data/.docker/Dockerfile

@@ -3,7 +3,7 @@ ARG RUBY_IMAGE=ruby:3.1.2-slim
 FROM ${RUBY_IMAGE}
 
 RUN apt-get update \
-    && apt-get install -y build-essential git \
+    && apt-get install -y build-essential git libreoffice \
     && apt-get clean && rm -rf /var/lib/apt/lists/*
 
 # install latest bundler

data/.docker/docker-compose.yml

@@ -7,8 +7,8 @@ services:
       dockerfile: ./.docker/Dockerfile
 
     volumes:
-      - .:/workspace
-      - bundle:/bundle
+      - .:/workspace:z
+      - bundle:/bundle:z
 
 volumes:
   bundle:

data/.editorconfig

@@ -0,0 +1,15 @@
+# EditorConfig is awesome: http://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+charset = utf-8
+end_of_line = lf
+
+[{*.adoc,*.html,*.js,*.json,*.rake,*.rb,*.rf,*.yaml,*.yml,Rakefile,rakefile}]
+indent_style = space
+indent_size = 2
+insert_final_newline = true
+trim_trailing_whitespace = true

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+## [0.3.0] - 2024-05-21
+
+- Merge reverse_adoc into coradoc
+
 ## [0.1.0] - 2023-01-08
 
 - Initial release

data/Rakefile

@@ -1,7 +1,17 @@
 # frozen_string_literal: true
 
 require "bundler/gem_tasks"
+
+if File.exist?(".codeclimate")
+  ENV["CODECLIMATE_REPO_TOKEN"] = File.read(".codeclimate").strip
+end
+
 require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 task default: :spec
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -Ilib -rcoradoc -rcoradoc/reverse_adoc"
+end

data/coradoc.gemspec

@@ -28,11 +28,20 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
   spec.required_ruby_version = ">= 2.7.0"
 
-  spec.add_dependency "parslet"
+  spec.add_dependency "marcel", "~> 1.0.0"
+  spec.add_dependency "mathml2asciimath"
+  spec.add_dependency "nokogiri", "~> 1.13"
   spec.add_dependency "oscal", "~> 0.1.1"
-
+  spec.add_dependency "parslet"
+  spec.add_dependency "premailer", "~> 1.11.0"
+  spec.add_dependency "word-to-markdown"
+  spec.add_development_dependency "codeclimate-test-reporter"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "redcarpet"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "rubocop-performance"
+  spec.add_development_dependency "simplecov"
+  # spec.add_runtime_dependency "thor"
 end

data/exe/reverse_adoc

@@ -0,0 +1,70 @@
+#!/usr/bin/env ruby
+# Usage: reverse_adoc [FILE]...
+# Usage: cat FILE | reverse_adoc
+require "rubygems"
+require "bundler/setup"
+
+require "coradoc/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|
+    Coradoc::ReverseAdoc.config.mathml2asciimath = true
+  end
+
+  opts.on("-oFILENAME", "--output=FILENAME", "Output file to write to") do |v|
+    Coradoc::ReverseAdoc.config.destination = File.expand_path(v)
+    # puts "output goes to #{Coradoc::ReverseAdoc.config.destination}"
+  end
+
+  opts.on("-e", "--external-images", "Export images if data URI") do |_v|
+    Coradoc::ReverseAdoc.config.external_images = true
+  end
+
+  opts.on("-u", "--unknown_tags [pass_through, drop, bypass, raise]",
+          "Unknown tag handling (default: pass_through)") do |v|
+    Coradoc::ReverseAdoc.config.unknown_tags = v
+  end
+
+  opts.on("-v", "--version", "Version information") do |_v|
+    puts "reverse_adoc: v#{Coradoc::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)
+  Coradoc::ReverseAdoc.config.sourcedir = File.dirname(File.expand_path(filename))
+else
+  if Coradoc::ReverseAdoc.config.external_images
+    raise "The -e | --external-images feature cannot be used with STDIN input. Exiting."
+  end
+
+  input_content = ARGF.read
+end
+
+if Coradoc::ReverseAdoc.config.external_images && Coradoc::ReverseAdoc.config.destination.nil?
+  raise "The -e | --external-images feature must be used with -o | --output. Exiting."
+end
+
+# Read from STDIN
+adoc_content = Coradoc::ReverseAdoc.convert(input_content)
+
+# Print to STDOUT
+unless Coradoc::ReverseAdoc.config.destination
+  puts adoc_content
+  exit
+end
+
+# Write output to Coradoc::ReverseAdoc.config.destination
+FileUtils.mkdir_p(File.dirname(Coradoc::ReverseAdoc.config.destination))
+File.open(Coradoc::ReverseAdoc.config.destination, "w") do |file|
+  file.write(adoc_content)
+end

data/exe/w2a

@@ -0,0 +1,72 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "rubygems"
+require "bundler/setup"
+
+require "word-to-markdown"
+require "optparse"
+require "coradoc/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|
+    Coradoc::ReverseAdoc.config.mathml2asciimath = true
+  end
+
+  opts.on("-oFILENAME", "--output=FILENAME", "Output file to write to") do |v|
+    Coradoc::ReverseAdoc.config.destination = File.expand_path(v)
+    # puts "output goes to #{Coradoc::ReverseAdoc.config.destination}"
+  end
+
+  opts.on("-e", "--external-images", "Export images if data URI") do |_v|
+    Coradoc::ReverseAdoc.config.external_images = true
+  end
+
+  opts.on("-v", "--version", "Version information") do |_v|
+    puts "reverse_adoc: v#{Coradoc::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 Coradoc::ReverseAdoc.config.external_images && Coradoc::ReverseAdoc.config.destination.nil?
+  raise "The -e | --external-images feature must be used with -o | --output. Exiting."
+end
+
+Coradoc::ReverseAdoc.config.sourcedir = Dir.mktmpdir
+
+doc = WordToMarkdown.new(filename, Coradoc::ReverseAdoc.config.sourcedir)
+# File.open("test.html", "w:UTF-8") { |f| f.write doc.document.html }
+adoc_content = Coradoc::ReverseAdoc.convert(
+  Coradoc::ReverseAdoc.cleaner.preprocess_word_html(doc.document.html),
+  WordToMarkdown::REVERSE_MARKDOWN_OPTIONS,
+)
+# puts scrub_whitespace(doc.document.html)
+
+# Print to STDOUT
+unless Coradoc::ReverseAdoc.config.destination
+  puts adoc_content
+  exit
+end
+
+# Write output to Coradoc::ReverseAdoc.config.destination
+FileUtils.mkdir_p(File.dirname(Coradoc::ReverseAdoc.config.destination))
+File.open(Coradoc::ReverseAdoc.config.destination, "w") do |file|
+  file.write(adoc_content)
+end

data/lib/coradoc/document.rb

@@ -20,7 +20,6 @@ require_relative "element/break"
 
 module Coradoc
   class Document
-
     class << self
       def from_adoc(filename)
         ast = Coradoc::Parser.parse(filename)
@@ -43,22 +42,22 @@ module Coradoc
           end
         end
 
-        self.new(
+        new(
           document_attributes: @document_attributes,
           header: @header,
-          sections: @sections
+          sections: @sections,
         )
       end
     end
 
     attr_accessor :header, :document_attributes, :sections
 
-    def initialize(options={})
-      @document_attributes = options.fetch(:document_attributes, Coradoc::Element::DocumentAttributes.new)
+    def initialize(options = {})
+      @document_attributes = options.fetch(:document_attributes,
+                                           Coradoc::Element::DocumentAttributes.new)
       @header = options.fetch(:header, Coradoc::Element::Header.new(""))
       @sections = options.fetch(:sections, [])
       self
     end
-
   end
 end

data/lib/coradoc/element/admonition.rb

@@ -1,11 +1,13 @@
 module Coradoc
-  class Element::Admonition
-    attr_reader :type, :content, :line_break
+  module Element
+    class Admonition
+      attr_reader :type, :content, :line_break
 
-    def initialize(content, type, options = {})
-      @content = content
-      @type = type.downcase.to_sym
-      @line_break = options.fetch(:line_break, "")
+      def initialize(content, type, options = {})
+        @content = content
+        @type = type.downcase.to_sym
+        @line_break = options.fetch(:line_break, "")
+      end
     end
   end
 end

data/lib/coradoc/element/attribute_list.rb

@@ -29,12 +29,12 @@ module Coradoc
         adoc << @named.map do |k, v|
           if v.is_a?(String)
             v2 = v.to_s
-            v2 = v2.include?("\"") ? v2.gsub("\"","\\\"") : v2
+            v2 = v2.include?("\"") ? v2.gsub("\"", "\\\"") : v2
             if v2.include?(" ") || v2.include?(",") || v2.include?("\"")
               v2 = "\"#{v2}\""
             end
           elsif v.is_a?(Array)
-            v2 = "\"#{v.join(",")}\""
+            v2 = "\"#{v.join(',')}\""
           end
           [k.to_s, "=", v2].join
         end.join(",")

data/lib/coradoc/element/audio.rb

@@ -7,7 +7,7 @@ module Coradoc
         @title = title
         @id = options.fetch(:id, nil)
         @anchor = Inline::Anchor.new(@id) if @id
-        @src = options.fetch(:src, '')
+        @src = options.fetch(:src, "")
         @attributes = options.fetch(:attributes, [])
       end
 

data/lib/coradoc/element/author.rb

@@ -1,20 +1,22 @@
 module Coradoc
-  class Element::Author
-    attr_reader :email, :last_name, :first_name
+  module Element
+    class Author
+      attr_reader :email, :last_name, :first_name
 
-    def initialize(first_name, last_name, email, middle_name = nil)
-      @first_name = first_name
-      @last_name = last_name
-      @email = email
-      @middle_name = middle_name
-    end
+      def initialize(first_name, last_name, email, middle_name = nil)
+        @first_name = first_name
+        @last_name = last_name
+        @email = email
+        @middle_name = middle_name
+      end
 
-    def to_adoc
-      adoc = "#{@first_name} "
-      adoc << "#{@middle_name} " if @middle_name
-      adoc << "#{@last_name}"
-      adoc << " <#{@email}>" if @email
-      adoc
+      def to_adoc
+        adoc = "#{@first_name} "
+        adoc << "#{@middle_name} " if @middle_name
+        adoc << @last_name.to_s
+        adoc << " <#{@email}>" if @email
+        adoc
+      end
     end
   end
 end

data/lib/coradoc/element/base.rb

@@ -7,8 +7,6 @@ module Coradoc
       #   @document_attributes = extract_document_attributes(asciidoc)
       # end
 
-      private
-
       # def extract_document_attributes(asciidoc)
       #   @document_attributes ||= DocumentAttributes.new(asciidoc.attributes)
       # end

data/lib/coradoc/element/block/core.rb

@@ -28,6 +28,7 @@ module Coradoc
         def gen_title
           t = Coradoc::Generator.gen_adoc(@title)
           return "" if t.empty?
+
           ".#{t}\n"
         end
 
@@ -59,10 +60,9 @@ module Coradoc
             "****" => :side,
             "----" => :source,
             "====" => :example,
-            "...." => :literal
+            "...." => :literal,
           }
         end
-
       end
     end
   end

data/lib/coradoc/element/block/literal.rb

@@ -2,7 +2,7 @@ module Coradoc
   module Element
     module Block
       class Literal < Core
-        def initialize(title, options = {})
+        def initialize(_title, options = {})
           @id = options.fetch(:id, nil)
           @anchor = @id.nil? ? nil : Inline::Anchor.new(@id)
           @lines = options.fetch(:lines, [])

data/lib/coradoc/element/block/sourcecode.rb

@@ -2,10 +2,10 @@ module Coradoc
   module Element
     module Block
       class SourceCode < Core
-        def initialize(title, options = {})
+        def initialize(_title, options = {})
           @id = options.fetch(:id, nil)
           @anchor = @id.nil? ? nil : Inline::Anchor.new(@id)
-          @lang = options.fetch(:lang, '')
+          @lang = options.fetch(:lang, "")
           @lines = options.fetch(:lines, [])
           @delimiter_char = "-"
           @delimiter_len = options.fetch(:delimiter_len, 4)

data/lib/coradoc/element/image/core.rb

@@ -3,6 +3,7 @@ module Coradoc
     module Image
       class Core
         attr_reader :title, :id, :src, :attributes
+
         def initialize(title, id, src, options = ())
           @title = title
           @id = id

data/lib/coradoc/element/image.rb

@@ -1,7 +1,6 @@
 module Coradoc
   module Element
     module Image
-
     end
   end
 end

data/lib/coradoc/element/inline/bold.rb

@@ -3,6 +3,7 @@ module Coradoc
     module Inline
       class Bold
         attr_accessor :content, :unconstrained
+
         def initialize(content, unconstrained = true)
           @content = content
           @unconstrained = unconstrained

data/lib/coradoc/element/inline/highlight.rb

@@ -3,6 +3,7 @@ module Coradoc
     module Inline
       class Highlight
         attr_accessor :content
+
         def initialize(content, constrained = true)
           @content = content
           @constrained = constrained

data/lib/coradoc/element/inline/image.rb

@@ -4,6 +4,7 @@ module Coradoc
     module Inline
       class Image
         attr_reader :title, :id, :src, :attributes
+
         def initialize(title, id, src, options = ())
           @title = title
           @id = id

data/lib/coradoc/element/inline/italic.rb

@@ -3,6 +3,7 @@ module Coradoc
     module Inline
       class Italic
         attr_accessor :content, :unconstrained
+
         def initialize(content, unconstrained = true)
           @content = content
           @unconstrained = unconstrained

data/lib/coradoc/element/inline/link.rb

@@ -5,19 +5,19 @@ module Coradoc
         attr_reader :path, :title, :name
 
         def initialize(options = {})
-          @path = options.fetch(:path,nil)
+          @path = options.fetch(:path, nil)
           @title = options.fetch(:title, nil)
-          @name = options.fetch(:name,nil)
+          @name = options.fetch(:name, nil)
         end
 
         def to_adoc
-          link = @path.to_s =~ URI::DEFAULT_PARSER.make_regexp ? @path : "link:#{@path}"
-          if @name.to_s.empty?
-            link << "[#{@title}]"
-          else
-            link << "[#{@name}]"
-          end
-          link.prepend(' ')
+          link = @path.to_s&.match?(URI::DEFAULT_PARSER.make_regexp) ? @path : "link:#{@path}"
+          link << if @name.to_s.empty?
+                    "[#{@title}]"
+                  else
+                    "[#{@name}]"
+                  end
+          link.prepend(" ")
           link
         end
       end

data/lib/coradoc/element/inline/monospace.rb

@@ -3,6 +3,7 @@ module Coradoc
     module Inline
       class Monospace
         attr_accessor :content, :constrained
+
         def initialize(content, unconstrained = true)
           @content = content
           @unconstrained = unconstrained

data/lib/coradoc/element/inline/quotation.rb

@@ -3,6 +3,7 @@ module Coradoc
     module Inline
       class Quotation
         attr_accessor :content
+
         def initialize(content)
           @content = content
         end

data/lib/coradoc/element/inline/subscript.rb

@@ -3,6 +3,7 @@ module Coradoc
     module Inline
       class Subscript
         attr_accessor :content
+
         def initialize(content)
           @content = content
         end

data/lib/coradoc/element/inline/superscript.rb

@@ -3,6 +3,7 @@ module Coradoc
     module Inline
       class Superscript
         attr_accessor :content
+
         def initialize(content)
           @content = content
         end

data/lib/coradoc/element/inline.rb

@@ -1,7 +1,6 @@
 module Coradoc
   module Element
     module Inline
-
     end
   end
 end

data/lib/coradoc/element/list/core.rb

@@ -21,15 +21,14 @@ module Coradoc
           @items.each do |item|
             c = Coradoc::Generator.gen_adoc(item)
             if !c.empty?
-              content << "#{prefix}"
+              content << prefix.to_s
               content << c
             end
           end
-          anchor = @anchor.nil? ? "" : "#{@anchor.to_adoc}"
-          attrs = @attrs.nil? ? "" : "#{@attrs.to_adoc}"
+          anchor = @anchor.nil? ? "" : @anchor.to_adoc.to_s
+          attrs = @attrs.nil? ? "" : @attrs.to_adoc.to_s
           "\n#{anchor}#{attrs}" + content
         end
-
       end
     end
   end

data/lib/coradoc/element/list.rb

@@ -1,7 +1,6 @@
 module Coradoc
   module Element
     module List
-
     end
   end
 end

data/lib/coradoc/element/list_item.rb

@@ -10,7 +10,7 @@ module Coradoc
       end
 
       def to_adoc
-        anchor = @anchor.nil? ? "" : "#{@anchor.to_adoc}"
+        anchor = @anchor.nil? ? "" : @anchor.to_adoc.to_s
         content = Coradoc::Generator.gen_adoc(@content).chomp
         " #{anchor}#{content.chomp}\n"
       end

data/lib/coradoc/element/paragraph.rb

@@ -22,7 +22,7 @@ module Coradoc
       def to_adoc
         anchor = @anchor.nil? ? "" : "#{@anchor.to_adoc}\n"
         if @tdsinglepara
-          "#{anchor}" << Coradoc::Generator.gen_adoc(@content).strip
+          anchor.to_s << Coradoc::Generator.gen_adoc(@content).strip
         else
           "\n\n#{anchor}" << Coradoc::Generator.gen_adoc(@content).strip << "\n\n"
         end

data/lib/coradoc/element/revision.rb

@@ -1,22 +1,24 @@
 module Coradoc
-  class Element::Revision
-    attr_reader :number, :date, :remark
+  module Element
+    class Revision
+      attr_reader :number, :date, :remark
 
-    def initialize(number, options = {})
-      @number = number
-      @date = options.fetch(:date, nil)
-      @remark = options.fetch(:remark, nil)
-    end
+      def initialize(number, options = {})
+        @number = number
+        @date = options.fetch(:date, nil)
+        @remark = options.fetch(:remark, nil)
+      end
 
-    def to_adoc
-      if @date.nil? && @remark.nil?
-        "v#{@number}\n"
-      elsif @remark.nil?
-        "#{@number}, #{@date}\n"
-      elsif @date.nil?
-        "#{@number}: #{@remark}\n"
-      else
-        "#{@number}, #{@date}: #{@revision}\n"
+      def to_adoc
+        if @date.nil? && @remark.nil?
+          "v#{@number}\n"
+        elsif @remark.nil?
+          "#{@number}, #{@date}\n"
+        elsif @date.nil?
+          "#{@number}: #{@remark}\n"
+        else
+          "#{@number}, #{@date}: #{@revision}\n"
+        end
       end
     end
   end