reverse_adoc 0.3.6 → 1.0.0

data/lib/reverse_adoc.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
-require 'digest'
-require 'nokogiri'
-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'
-require "reverse_adoc/html_converter"
+require "digest"
+require "nokogiri"
+require_relative "reverse_adoc/version"
+require_relative "reverse_adoc/errors"
+require_relative "reverse_adoc/cleaner"
+require_relative "reverse_adoc/config"
+require_relative "reverse_adoc/converters"
+require_relative "reverse_adoc/converters/base"
+require_relative "reverse_adoc/html_converter"
 
 module ReverseAdoc
   def self.convert(input, options = {})

data/reverse_adoc.gemspec

@@ -16,15 +16,18 @@ Gem::Specification.new do |s|
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- exe/*`.split("\n").map { |f| File.basename(f) }
+  s.executables   = `git ls-files -- exe/*`.split("\n").map do |f|
+    File.basename(f)
+  end
   s.bindir        = "exe"
   s.require_paths = ["lib"]
-  s.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
+  s.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
 
   # specify any dependencies here; for example:
+  s.add_dependency "coradoc", "~> 0.2"
   s.add_dependency "marcel", "~> 1.0.0"
   s.add_dependency "mathml2asciimath"
-  s.add_dependency "nokogiri", "~> 1.12"
+  s.add_dependency "nokogiri", "~> 1.13"
   s.add_development_dependency "codeclimate-test-reporter"
   s.add_development_dependency "rake"
   s.add_development_dependency "redcarpet"

data/spec/assets/basic.html

@@ -37,6 +37,9 @@
         strong with extra leading and trailing   
         </strong>whitespace
 
+    constrai<strong>ned</strong> strong
+    constrai<i>ned</i> italic
+    
     <b>b tag content</b>
     <i>i tag content</i>
 

data/spec/bin/reverse_adoc_spec.rb

@@ -1,31 +1,32 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
+require "spec_helper"
 
-describe 'exe/revrse_adoc' do
+describe "exe/reverse_adoc" do
   subject(:convert) do
     ShellUtils.execute!("./exe/reverse_adoc -e -o test1 #{input_file_path}")
   end
+
   unless Gem.win_platform?
-    context 'when external images present' do
-      let(:input_file_path) { 'spec/assets/external_images.html' }
-      let(:images_folder) { 'images' }
+    context "when external images present" do
+      let(:input_file_path) { "spec/assets/external_images.html" }
+      let(:images_folder) { "images" }
 
       after do
         FileUtils.rm_rf(images_folder) if File.directory?(images_folder)
       end
 
-      it 'Does not raise error' do
+      it "Does not raise error" do
         expect { convert }.to_not raise_error
       end
 
-      it 'exatracts images from source html' do
+      it "exatracts images from source html" do
         expect { convert }
           .to(change do
             Dir["#{images_folder}/*gif"]
               .map { |entry| File.basename(entry) }
               .sort
-          end.from([]).to(['001.gif']))
+          end.from([]).to(["001.gif"]))
       end
     end
   end

data/spec/bin/w2a_spec.rb

@@ -1,34 +1,34 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
+require "spec_helper"
 
-describe 'exe/w2a' do
+describe "exe/w2a" do
   subject(:convert) do
     ShellUtils.execute!("./exe/w2a -e -o test1 #{input_file_path}")
   end
+
   # TODO: fix github actions integration with libreoffice, currently it hangs
   # when trying to use soffice binary
   unless Gem.win_platform? ||
-         (Gem::Platform.local.os == 'darwin' && !ENV['GITHUB_ACTION'].nil?)
-    context 'when external images present' do
-      let(:input_file_path) { 'spec/assets/external_images.docx' }
-      let(:images_folder) { 'images' }
+      (Gem::Platform.local.os == "darwin" && !ENV["GITHUB_ACTION"].nil?)
+    context "when external images present" do
+      let(:input_file_path) { "spec/assets/external_images.docx" }
+      let(:images_folder) { "images" }
 
       after do
         FileUtils.rm_rf(images_folder) if File.directory?(images_folder)
       end
 
-      it 'Does not raise error' do
+      it "Does not raise error" do
         expect { convert }.to_not raise_error
       end
 
-      it 'extracts images from source html' do
+      it "extracts images from source html" do
         expect { convert }
           .to(change do
-          Dir["#{images_folder}/*gif"]
-            .map { |entry| File.basename(entry) }
-            .size > 0
-        end.from(false).to(true))
+                !Dir["#{images_folder}/*gif"]
+                  .map { |entry| File.basename(entry) }.empty?
+              end.from(false).to(true))
       end
     end
   end

data/spec/components/anchors_spec.rb

@@ -1,26 +1,32 @@
-require 'spec_helper'
+require "spec_helper"
 
 describe ReverseAdoc do
-
-  let(:input)    { File.read('spec/assets/anchors.html') }
+  let(:input)    { File.read("spec/assets/anchors.html") }
   let(:document) { Nokogiri::HTML(input) }
   subject { ReverseAdoc.convert(input) }
 
-  it { is_expected.to include 'http://foobar.com[Foobar]' }
-  it { is_expected.to include 'http://foobar.com[Fubar]' }
+  it { is_expected.to include "http://foobar.com[Foobar]" }
+  it { is_expected.to include "http://foobar.com[Fubar]" }
   it { is_expected.to include 'http://foobar.com[f\*\*\*\*\* up beyond all redemption]' }
-  it { is_expected.to include 'http://strong.foobar.com[*Strong foobar*]' }
+  it { is_expected.to include "http://strong.foobar.com[*Strong foobar*]" }
 
-  it { is_expected.to include 'There should be space before but not after the anchor ( http://foobar.com[stripped]).' }
+  it {
+    is_expected.to include "There should be space before but not after the anchor ( http://foobar.com[stripped])."
+  }
 
-  it { is_expected.to include ' do not ignore link:foo.html[] anchor tags with no link text ' }
-  it { is_expected.to include ' link <<content,internal jumplinks>> with anchors ' }
-  it { is_expected.to include ' link <<content2>>internal jumplinks without anchors ' }
-  it { is_expected.to include ' treat [[content]] as bookmarks ' }
+  it {
+    is_expected.to include " do not ignore link:foo.html[] anchor tags with no link text "
+  }
+  it {
+    is_expected.to include " link <<content,internal jumplinks>> with anchors "
+  }
+  it {
+    is_expected.to include " link <<content2>>internal jumplinks without anchors "
+  }
+  it { is_expected.to include " treat [[content]] as bookmarks " }
 
   it { is_expected.to include "<<a_bspaced,Double \\_\\_ anchor with space>>" }
   it { is_expected.to include "[[a_bspaced]]" }
   it { is_expected.to include "[[a_Foreword]]\n== Text" }
   it { is_expected.not_to include "[[_Toc12345]]" }
-
 end

data/spec/components/basic_spec.rb

@@ -1,9 +1,8 @@
-require 'spec_helper'
+require "spec_helper"
 
 describe ReverseAdoc do
-
-  let(:input)    { File.read('spec/assets/basic.html') }
-  let(:document) { Nokogiri::HTML(input) }
+  let(:input) { File.read("spec/assets/basic.html") }
+  # let(:document) { Nokogiri::HTML(input) }
   subject { ReverseAdoc.convert(input) }
 
   it { is_expected.to match /plain text ?\n/ }
@@ -21,25 +20,40 @@ describe ReverseAdoc do
   it { is_expected.to match /_double em tags_/ }
   it { is_expected.to match /_double em tags in p tag_/ }
   it { is_expected.to match /a _em with leading and trailing_ whitespace/ }
-  it { is_expected.to match /a _em with extra leading and trailing_ whitespace/ }
+  it {
+    is_expected.to match /a _em with extra leading and trailing_ whitespace/
+  }
 
   it { is_expected.to match /\*strong tag content\*/ }
   it { is_expected.to match /before and after empty strong tags/ }
-  it { is_expected.to match /before and after strong tags containing whitespace/ }
+  it {
+    is_expected.to match /before and after strong tags containing whitespace/
+  }
   it { is_expected.to match /\*double strong tags\*/ }
   it { is_expected.to match /\*double strong tags in p tag\*/ }
-  it { is_expected.to match /before \*double strong tags containing whitespace\* after/ }
-  it { is_expected.to match /a \*strong with leading and trailing\* whitespace/ }
-  it { is_expected.to match /a \*strong with extra leading and trailing\* whitespace/ }
-
-  it { is_expected.to match /H~2~O/ }
-  it { is_expected.to match /A\^2\^B/ }
+  it {
+    is_expected.to match /before \*double strong tags containing whitespace\* after/
+  }
+  it {
+    is_expected.to match /a \*strong with leading and trailing\* whitespace/
+  }
+  it {
+    is_expected.to match /a \*strong with extra leading and trailing\* whitespace/
+  }
+
+  it { is_expected.to match /constrai\*\*ned\*\* strong/ }
+  it { is_expected.to match /constrai__ned__ italic/ }
 
   it { is_expected.to match /_i tag content_/ }
   it { is_expected.to match /\*b tag content\*/ }
 
-  it { is_expected.to match /br tags become double space followed by newline \+\n/ }
-  #it { should match /br tags XXX  \n/ }
+  it { is_expected.to match /H~2~O/ }
+  it { is_expected.to match /A\^2\^B/ }
+
+  it {
+    is_expected.to match /br tags become double space followed by newline \+\n/
+  }
+  # it { should match /br tags XXX  \n/ }
 
   it { is_expected.to match /before hr \n\* \* \*\n after hr/ }
 

data/spec/components/code_spec.rb

@@ -1,8 +1,7 @@
-require 'spec_helper'
+require "spec_helper"
 
 describe ReverseAdoc do
-
-  let(:input)    { File.read('spec/assets/code.html') }
+  let(:input)    { File.read("spec/assets/code.html") }
   let(:document) { Nokogiri::HTML(input) }
   subject { ReverseAdoc.convert(input) }
 
@@ -23,5 +22,4 @@ describe ReverseAdoc do
     it { is_expected.to match(/^    beep\n/) }
     it { is_expected.to match(/^end tell\n/) }
   end
-
 end

data/spec/components/escapables_spec.rb

@@ -1,8 +1,7 @@
-require 'spec_helper'
+require "spec_helper"
 
 describe ReverseAdoc do
-
-  let(:input)    { File.read('spec/assets/escapables.html') }
+  let(:input)    { File.read("spec/assets/escapables.html") }
   let(:document) { Nokogiri::HTML(input) }
   subject { ReverseAdoc.convert(input) }
 
@@ -10,7 +9,7 @@ describe ReverseAdoc do
     it { is_expected.to include ' \*\*two asterisks\*\* ' }
     it { is_expected.to include ' \*\*\*three asterisks\*\*\* ' }
     it { is_expected.to include ' \*and*the\* ' }
-    it { is_expected.to include ' asterisc*word ' }
+    it { is_expected.to include " asterisc*word " }
     it { is_expected.to include ' asterisc**multword asterisks\*\*\* ' }
   end
 
@@ -20,7 +19,7 @@ describe ReverseAdoc do
   end
 
   context "multiple underscores with undersocre inside words and new lines" do
-    it { is_expected.to include 'another_undersocre' }
+    it { is_expected.to include "another_undersocre" }
     it { is_expected.to include ' \_\_\_three__underscores\_\_\_ ' }
   end
 
@@ -28,5 +27,4 @@ describe ReverseAdoc do
     let(:expected_output) { "....\nvar theoretical_max_infin = 1.0;\n....\n" }
     it { is_expected.to include expected_output }
   end
-
 end

data/spec/components/from_the_wild_spec.rb

@@ -1,8 +1,7 @@
-require 'spec_helper'
+require "spec_helper"
 
 describe ReverseAdoc do
-
-  let(:input)    { File.read('spec/assets/from_the_wild.html') }
+  let(:input)    { File.read("spec/assets/from_the_wild.html") }
   let(:document) { Nokogiri::HTML(input) }
   subject { ReverseAdoc.convert(input) }
 
@@ -13,5 +12,4 @@ describe ReverseAdoc do
   it "should not over escape * or _" do
     expect(subject).to include 'link:example.com/foo_bar[image::example.com/foo_bar.png[] I\_AM\_HELPFUL]'
   end
-
 end

data/spec/components/html_fragment_spec.rb

@@ -1,8 +1,7 @@
-require 'spec_helper'
+require "spec_helper"
 
 describe ReverseAdoc do
-
-  let(:input)    { File.read('spec/assets/html_fragment.html') }
+  let(:input)    { File.read("spec/assets/html_fragment.html") }
   let(:document) { Nokogiri::HTML(input) }
   subject { ReverseAdoc.convert(input) }
 

data/spec/components/lists_spec.rb

@@ -1,8 +1,7 @@
-require 'spec_helper'
+require "spec_helper"
 
 describe ReverseAdoc do
-
-  let(:input)    { File.read('spec/assets/lists.html') }
+  let(:input)    { File.read("spec/assets/lists.html") }
   let(:document) { Nokogiri::HTML(input) }
   subject { ReverseAdoc.convert(input) }
 
@@ -30,7 +29,9 @@ describe ReverseAdoc do
 
   context "list start, reversed" do
     it { is_expected.to match /\n\[start=3\]\n\. another ordered list entry\n/ }
-    it { is_expected.to match /\n\[%reversed\]\n\. a reversed ordered list entry\n/ }
+    it {
+      is_expected.to match /\n\[%reversed\]\n\. a reversed ordered list entry\n/
+    }
   end
 
   context "nested list with no whitespace" do
@@ -49,8 +50,12 @@ describe ReverseAdoc do
 
   context "lists containing links" do
     it { is_expected.to match /\n\* link:Basic_concepts\[1 Basic concepts\]\n/ }
-    it { is_expected.to match /\n\* link:History_of_the_idea\[2 History of the idea\]\n/ }
-    it { is_expected.to match /\n\* link:Intelligence_explosion\[3 Intelligence explosion\]\n/ }
+    it {
+      is_expected.to match /\n\* link:History_of_the_idea\[2 History of the idea\]\n/
+    }
+    it {
+      is_expected.to match /\n\* link:Intelligence_explosion\[3 Intelligence explosion\]\n/
+    }
   end
 
   context "lists containing embedded <p> tags" do
@@ -61,7 +66,7 @@ describe ReverseAdoc do
     xit { is_expected.to match /\n\* li 1, p 1\n\n\* li 1, p 2\n/ }
   end
 
-  context 'it produces correct numbering' do
+  context "it produces correct numbering" do
     it { is_expected.to include "\. one" }
     it { is_expected.to include "\.\. one one" }
     it { is_expected.to include "\.\. one two" }
@@ -82,5 +87,4 @@ describe ReverseAdoc do
     it { is_expected.to match /\n\* charlie\n/ }
     it { is_expected.to match /\n\* delta\n/ }
   end
-
 end

data/spec/components/paragraphs_spec.rb

@@ -1,8 +1,7 @@
-require 'spec_helper'
+require "spec_helper"
 
 describe ReverseAdoc do
-
-  let(:input)    { File.read('spec/assets/paragraphs.html') }
+  let(:input)    { File.read("spec/assets/paragraphs.html") }
   let(:document) { Nokogiri::HTML(input) }
   subject { ReverseAdoc.convert(input) }
 

data/spec/components/quotation_spec.rb

@@ -1,12 +1,12 @@
-require 'spec_helper'
+require "spec_helper"
 
 describe ReverseAdoc do
-
-  let(:input)    { File.read('spec/assets/quotation.html') }
+  let(:input)    { File.read("spec/assets/quotation.html") }
   let(:document) { Nokogiri::HTML(input) }
   subject { ReverseAdoc.convert(input) }
 
   it { is_expected.to match /\n      Block of code$/ }
-  it { is_expected.to include "\n____\nFirst quoted paragraph\n\nSecond quoted paragraph\n____\n" }
-
+  it {
+    is_expected.to include "\n____\nFirst quoted paragraph\n\nSecond quoted paragraph\n____\n"
+  }
 end

data/spec/components/tables_spec.rb

@@ -1,17 +1,24 @@
-require 'spec_helper'
+require "spec_helper"
 
 describe ReverseAdoc do
-
-  let(:input)    { File.read('spec/assets/tables.html') }
+  let(:input)    { File.read("spec/assets/tables.html") }
   let(:document) { Nokogiri::HTML(input) }
   subject { ReverseAdoc.convert(input) }
 
-  it { is_expected.to match /\[\[A\]\]\n\|===\n\| \[\[C\]\]header 1 \| header 2 \| header 3\n\n/ }
-  it { is_expected.to match /\nh\| \[\[D\]\]data 1-1 \| data 2-1 \| data 3-1\n/ }
+  it {
+    is_expected.to match /\[\[A\]\]\n\|===\n\| \[\[C\]\]header 1 \| header 2 \| header 3\n\n/
+  }
+  it {
+    is_expected.to match /\nh\| \[\[D\]\]data 1-1 \| data 2-1 \| data 3-1\n/
+  }
   it { is_expected.to match /\nh\| data 1-2 \| data 2-2 \| data 3-2\n/ }
 
-  it { is_expected.to match /\n\| _header oblique_ \| \*header bold\* \| `header code`\n\n/ }
-  it { is_expected.to match /\n\| _data oblique_ \| \*data bold\* \| `data code`\n/ }
+  it {
+    is_expected.to match /\n\| _header oblique_ \| \*header bold\* \| `header code`\n\n/
+  }
+  it {
+    is_expected.to match /\n\| _data oblique_ \| \*data bold\* \| `data code`\n/
+  }
 
   it { is_expected.to match /\n\.2\+\| rowspan 2\n/ }
   it { is_expected.to match /\n2\+| colspan 2\n/ }
@@ -23,9 +30,13 @@ describe ReverseAdoc do
   it { is_expected.to match /\^\.\^\| center middle\n/ }
 
   it { is_expected.to match /\n\.Table _caption_\n\|===\n/ }
-  it { is_expected.to match /\n\[width=75%\]\n\|===\n\| 75% width table\n/ }
-  it { is_expected.to match /\n\[frame=topbot,rules=cols\]\n\|===\n\| topbot\n/ }
-
-  it { is_expected.to match /\na|\nHello\n\nThis cell has multiple paragraphs\n\n/ }
+  # it { is_expected.to match /\n\[width=75%\]\n\|===\n\| 75% width table\n/ }
+  it {
+    is_expected.to match /\n\[frame=topbot,rules=cols\]\n\|===\n\| topbot\n/
+  }
+
+  it {
+    is_expected.to match /\na|\nHello\n\nThis cell has multiple paragraphs\n\n/
+  }
   it { is_expected.to match /\n\| This cell has a single paragraph\n/ }
 end

data/spec/components/unknown_tags_spec.rb

@@ -1,38 +1,41 @@
-require 'spec_helper'
+require "spec_helper"
 
 describe ReverseAdoc do
-
-  let(:input)    { File.read('spec/assets/unknown_tags.html') }
+  let(:input)    { File.read("spec/assets/unknown_tags.html") }
   let(:document) { Nokogiri::HTML(input) }
   let(:result)   { ReverseAdoc.convert(input) }
 
-  context 'with unknown_tags = :pass_through' do
+  context "with unknown_tags = :pass_through" do
     before { ReverseAdoc.config.unknown_tags = :pass_through }
 
     it { expect(result).to include "<bar>Foo with bar</bar>" }
   end
 
-  context 'with unknown_tags = :raise' do
+  context "with unknown_tags = :raise" do
     before { ReverseAdoc.config.unknown_tags = :raise }
 
     it { expect { result }.to raise_error(ReverseAdoc::UnknownTagError) }
   end
 
-  context 'with unknown_tags = :drop' do
+  context "with unknown_tags = :drop" do
     before { ReverseAdoc.config.unknown_tags = :drop }
 
-    it { expect(result).to eq '' }
+    it { expect(result).to eq "" }
   end
 
-  context 'with unknown_tags = :bypass' do
+  context "with unknown_tags = :bypass" do
     before { ReverseAdoc.config.unknown_tags = :bypass }
 
     it { expect(result).to eq "Foo with bar\n\n" }
   end
 
-  context 'with unknown_tags = :something_wrong' do
+  context "with unknown_tags = :something_wrong" do
     before { ReverseAdoc.config.unknown_tags = :something_wrong }
 
-    it { expect { result }.to raise_error(ReverseAdoc::InvalidConfigurationError) }
+    it {
+      expect do
+        result
+      end.to raise_error(ReverseAdoc::InvalidConfigurationError)
+    }
   end
 end