reverse_adoc 0.2.7 → 0.3.1

data/spec/assets/escapables.html

@@ -4,8 +4,10 @@
 
     **two asterisks**
     ***three asterisks***
+    ***three *and*the* asterisc*word and asterisc**multword asterisks***
     __two underscores__
     ___three underscores___
+    ___three__underscores___ and another_undersocre
 
     some text...
 

data/spec/bin/reverse_adoc_spec.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe 'exe/revrse_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' }
+
+      after do
+        FileUtils.rm_rf(images_folder) if File.directory?(images_folder)
+      end
+
+      it 'Does not raise error' do
+        expect { convert }.to_not raise_error
+      end
+
+      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
+    end
+  end
+end

data/spec/bin/w2a_spec.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+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' }
+
+      after do
+        FileUtils.rm_rf(images_folder) if File.directory?(images_folder)
+      end
+
+      it 'Does not raise error' do
+        expect { convert }.to_not raise_error
+      end
+
+      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))
+      end
+    end
+  end
+end

data/spec/components/anchors_spec.rb

@@ -1,10 +1,10 @@
 require 'spec_helper'
 
-describe ReverseAsciidoctor do
+describe ReverseAdoc do
 
   let(:input)    { File.read('spec/assets/anchors.html') }
   let(:document) { Nokogiri::HTML(input) }
-  subject { ReverseAsciidoctor.convert(input) }
+  subject { ReverseAdoc.convert(input) }
 
   it { is_expected.to include 'http://foobar.com[Foobar]' }
   it { is_expected.to include 'http://foobar.com[Fubar]' }

data/spec/components/basic_spec.rb

@@ -1,14 +1,14 @@
 require 'spec_helper'
 
-describe ReverseAsciidoctor do
+describe ReverseAdoc do
 
   let(:input)    { File.read('spec/assets/basic.html') }
   let(:document) { Nokogiri::HTML(input) }
-  subject { ReverseAsciidoctor.convert(input) }
+  subject { ReverseAdoc.convert(input) }
 
   it { is_expected.to match /plain text ?\n/ }
   it { is_expected.to match /\n== h1\n/ }
-  it { is_expected.to match /\n\[\[A]\]\n== h1 with anchor\n/ }
+  it { is_expected.to match /\n\[\[A\]\]\n== h1 with anchor\n/ }
   it { is_expected.to match /\n=== h2\n/ }
   it { is_expected.to match /\n==== h3\n/ }
   it { is_expected.to match /\n===== h4\n/ }

data/spec/components/code_spec.rb

@@ -1,28 +1,27 @@
 require 'spec_helper'
 
-describe ReverseAsciidoctor do
+describe ReverseAdoc do
 
   let(:input)    { File.read('spec/assets/code.html') }
   let(:document) { Nokogiri::HTML(input) }
-  subject { ReverseAsciidoctor.convert(input) }
+  subject { ReverseAdoc.convert(input) }
 
   it { is_expected.to match /inline `code` block/ }
   it { is_expected.to match /\n<code>var this\;\nthis\.is/ }
   it { is_expected.to match /block"\)\nconsole/ }
 
   context "with github style code blocks" do
-    subject { ReverseAsciidoctor.convert(input) }
+    subject { ReverseAdoc.convert(input) }
     it { is_expected.to match /inline `code` block/ }
     it { is_expected.to match /\n\.\.\.\.\n<code>var this\;\nthis/ }
     it { is_expected.to match /it is"\) ?\n	<\/code>\n\.\.\.\./ }
   end
 
   context "code with indentation" do
-    subject { ReverseAsciidoctor.convert(input) }
+    subject { ReverseAdoc.convert(input) }
     it { is_expected.to match(/^<code>tell application "Foo"\n/) }
     it { is_expected.to match(/^    beep\n/) }
     it { is_expected.to match(/^end tell\n/) }
   end
 
 end
-

data/spec/components/escapables_spec.rb

@@ -1,14 +1,17 @@
 require 'spec_helper'
 
-describe ReverseAsciidoctor do
+describe ReverseAdoc do
 
   let(:input)    { File.read('spec/assets/escapables.html') }
   let(:document) { Nokogiri::HTML(input) }
-  subject { ReverseAsciidoctor.convert(input) }
+  subject { ReverseAdoc.convert(input) }
 
   context "multiple asterisks" 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**multword asterisks\*\*\* ' }
   end
 
   context "multiple underscores" do
@@ -16,6 +19,11 @@ describe ReverseAsciidoctor do
     it { is_expected.to include ' \_\_\_three underscores\_\_\_ ' }
   end
 
+  context "multiple underscores with undersocre inside words and new lines" do
+    it { is_expected.to include 'another_undersocre' }
+    it { is_expected.to include ' \_\_\_three__underscores\_\_\_ ' }
+  end
+
   context "underscores within words in code blocks" do
     it { is_expected.to include "....\n<code>var theoretical_max_infin = 1.0;</code>\n....\n" }
   end

data/spec/components/from_the_wild_spec.rb

@@ -1,10 +1,10 @@
 require 'spec_helper'
 
-describe ReverseAsciidoctor do
+describe ReverseAdoc do
 
   let(:input)    { File.read('spec/assets/from_the_wild.html') }
   let(:document) { Nokogiri::HTML(input) }
-  subject { ReverseAsciidoctor.convert(input) }
+  subject { ReverseAdoc.convert(input) }
 
   it "should make sense of strong-crazy markup (as seen in the wild)" do
     expect(subject).to include "*. +\n \\*\\*\\* intentcast* : logo design *+*\n"

data/spec/components/html_fragment_spec.rb

@@ -1,11 +1,10 @@
 require 'spec_helper'
 
-describe ReverseAsciidoctor do
+describe ReverseAdoc do
 
   let(:input)    { File.read('spec/assets/html_fragment.html') }
   let(:document) { Nokogiri::HTML(input) }
-  subject { ReverseAsciidoctor.convert(input) }
+  subject { ReverseAdoc.convert(input) }
 
   it { is_expected.to eq("naked text 1\n\nparagraph text\n\nnaked text 2") }
 end
-

data/spec/components/lists_spec.rb

@@ -1,10 +1,10 @@
 require 'spec_helper'
 
-describe ReverseAsciidoctor do
+describe ReverseAdoc do
 
   let(:input)    { File.read('spec/assets/lists.html') }
   let(:document) { Nokogiri::HTML(input) }
-  subject { ReverseAsciidoctor.convert(input) }
+  subject { ReverseAdoc.convert(input) }
 
   it { is_expected.to match /\n\* unordered list entry\n/ }
   it { is_expected.to match /\n\* unordered list entry 2\n/ }

data/spec/components/paragraphs_spec.rb

@@ -1,10 +1,10 @@
 require 'spec_helper'
 
-describe ReverseAsciidoctor do
+describe ReverseAdoc do
 
   let(:input)    { File.read('spec/assets/paragraphs.html') }
   let(:document) { Nokogiri::HTML(input) }
-  subject { ReverseAsciidoctor.convert(input) }
+  subject { ReverseAdoc.convert(input) }
 
   it { is_expected.not_to start_with "\n\n" }
   it { is_expected.to start_with "First content\n\nSecond content\n\n" }

data/spec/components/quotation_spec.rb

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

data/spec/components/tables_spec.rb

@@ -1,10 +1,10 @@
 require 'spec_helper'
 
-describe ReverseAsciidoctor do
+describe ReverseAdoc do
 
   let(:input)    { File.read('spec/assets/tables.html') }
   let(:document) { Nokogiri::HTML(input) }
-  subject { ReverseAsciidoctor.convert(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/ }

data/spec/components/unknown_tags_spec.rb

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

data/spec/lib/reverse_adoc.rb

@@ -0,0 +1,90 @@
+require 'spec_helper'
+
+describe ReverseAdoc do
+  let(:input)    { File.read('spec/assets/minimum.html') }
+  let(:document) { Nokogiri::HTML(input) }
+
+  it 'parses nokogiri documents' do
+    expect { ReverseAdoc.convert(document) }.not_to raise_error
+  end
+
+  it 'parses nokogiri elements' do
+    expect { ReverseAdoc.convert(document.root) }.not_to raise_error
+  end
+
+  it 'parses string input' do
+    expect { ReverseAdoc.convert(input) }.not_to raise_error
+  end
+
+  it 'behaves in a sane way when root element is nil' do
+    expect(ReverseAdoc.convert(nil)).to eq ''
+  end
+
+  describe '#config' do
+    it 'stores a given configuration option' do
+      ReverseAdoc.config.tag_border = true
+      expect(ReverseAdoc.config.tag_border).to eq true
+    end
+
+    it 'can be used as a block configurator as well' do
+      ReverseAdoc.config do |config|
+        expect(config.tag_border).to eq ' '
+        config.tag_border = true
+      end
+      expect(ReverseAdoc.config.tag_border).to eq true
+    end
+  end
+
+  shared_examples 'converting source with external images included' do |result|
+    let(:temp_dir) do
+      Pathname.new(ReverseAdoc.config.destination).dirname
+    end
+    let(:images_folder) { File.join(temp_dir, 'images') }
+
+    before do
+      ReverseAdoc.config.destination = File.join(Dir.mktmpdir,
+                                                        'output.html')
+      ReverseAdoc.config.sourcedir = Dir.mktmpdir
+      ReverseAdoc.config.external_images = true
+    end
+
+    after do
+      FileUtils.rm_rf(temp_dir)
+    end
+
+    it 'Creates local files from external URI' do
+      expect { convert }
+        .to(change do
+          Dir["#{images_folder}/*gif"]
+            .map { |entry| File.basename(entry) }
+            .sort
+        end.from([]).to(result))
+    end
+  end
+
+  # TODO: fix github actions integration with libreoffice, currently it hangs
+  # when trying to use soffice binary
+  unless Gem::Platform.local.os == 'darwin' && !ENV['GITHUB_ACTION'].nil?
+    context 'when docx file input' do
+      subject(:convert) do
+        ReverseAdoc.convert(
+          ReverseAdoc.cleaner.preprocess_word_html(input.document.html),
+          WordToMarkdown::REVERSE_MARKDOWN_OPTIONS
+        )
+      end
+      let(:input) do
+        WordToMarkdown.new('spec/assets/external_images.docx',
+                           ReverseAdoc.config.sourcedir)
+      end
+      it_behaves_like 'converting source with external images included',
+                      ['001.gif', '002.gif']
+    end
+  end
+
+  context 'when html file input' do
+    subject(:convert) { ReverseAdoc.convert(input) }
+    let(:input) { File.read('spec/assets/external_images.html') }
+    it_behaves_like 'converting source with external images included',
+                    ['001.gif']
+  end
+end

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

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
-describe ReverseAsciidoctor::Cleaner do
-  let(:cleaner) { ReverseAsciidoctor::Cleaner.new }
+describe ReverseAdoc::Cleaner do
+  let(:cleaner) { ReverseAdoc::Cleaner.new }
 
   describe '#scrub_whitespace' do
     it "makes consistent nonbreaking spaces" do
@@ -86,7 +86,7 @@ describe ReverseAsciidoctor::Cleaner do
 
   describe '#clean_tag_borders' do
     context 'with default_border is set to space' do
-      before { ReverseAsciidoctor.config.tag_border = ' ' }
+      before { ReverseAdoc.config.tag_border = ' ' }
 
       it 'removes not needed whitespaces from strong tags' do
         input = "foo ** foobar ** bar"
@@ -132,7 +132,7 @@ describe ReverseAsciidoctor::Cleaner do
     end
 
     context 'with default_border set to no space' do
-      before { ReverseAsciidoctor.config.tag_border = '' }
+      before { ReverseAdoc.config.tag_border = '' }
 
       it 'removes not needed whitespaces from strong tags' do
         input = "foo ** foobar ** bar"

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

@@ -1,12 +1,12 @@
 require 'spec_helper'
 
-describe ReverseAsciidoctor::Config do
+describe ReverseAdoc::Config do
   describe '#with' do
-    let(:config) { ReverseAsciidoctor.config }
+    let(:config) { ReverseAdoc.config }
 
     it 'takes additional options into account' do
       config.with(tag_border: :foobar) do
-        expect(ReverseAsciidoctor.config.tag_border).to eq :foobar
+        expect(ReverseAdoc.config.tag_border).to eq :foobar
       end
     end
 
@@ -17,9 +17,9 @@ describe ReverseAsciidoctor::Config do
     it 'resets to original settings afterwards' do
       config.tag_border = :foo
       config.with(tag_border: :bar) do
-        expect(ReverseAsciidoctor.config.tag_border).to eq :bar
+        expect(ReverseAdoc.config.tag_border).to eq :bar
       end
-      expect(ReverseAsciidoctor.config.tag_border).to eq :foo
+      expect(ReverseAdoc.config.tag_border).to eq :foo
     end
 
   end