caramelize 1.1.1 → 1.2.0

data/spec/lib/caramelize/filters/add_newline_on_page_end_spec.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Caramelize::AddNewlineOnPageEnd do
+  describe '#run' do
+    subject(:run) { filter.run }
+
+    let(:filter) { described_class.new(body) }
+
+    context 'with newline on body end' do
+      let(:body) { "Here is a sample body\n" }
+
+      it 'adds no newline character' do
+        expect(run).to eq "Here is a sample body\n"
+      end
+    end
+
+    context 'without newline on body end' do
+      let(:body) { 'Here is a sample body' }
+
+      it 'adds newline character' do
+        expect(run).to eq "Here is a sample body\n"
+      end
+    end
+  end
+end

data/spec/lib/caramelize/filters/camel_case_to_wiki_links_spec.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Caramelize::CamelCaseToWikiLinks do
+  describe '#run' do
+    subject(:run) { filter.run }
+
+    let(:filter) { described_class.new(body) }
+
+    context 'with camel case text' do
+      let(:body) { 'Hier ein CamelCaseExample, bitte [[DankeDanke]]' }
+
+      it 'does wiki link' do
+        expect(run).to eq 'Hier ein [[CamelCaseExample]], bitte [[DankeDanke]]'
+      end
+    end
+
+    context 'with camel case text downcased' do
+      let(:body) { 'Hier ein camelCaseExample, bitte [[DankeDanke]]' }
+
+      it 'does not to wiki link' do
+        expect(run).to eq 'Hier ein camelCaseExample, bitte [[DankeDanke]]'
+      end
+    end
+
+    context 'with camel case text at document end' do
+      let(:body) { 'Hier ein CamelCaseExample' }
+
+      # NOTE: this is sortof expected behavior - a wiki page should end on a newline in which case this does not happen
+      it 'cuts last character' do
+        expect(run).to eq 'Hier ein [[CamelCaseExampl]]e'
+      end
+    end
+
+    context 'with camel case text at document end with newline' do
+      let(:body) { "Hier ein CamelCaseExample\n" }
+
+      it 'does wiki link' do
+        expect(run).to eq "Hier ein [[CamelCaseExample]]\n"
+      end
+    end
+  end
+end

data/spec/lib/caramelize/filters/remove_table_tab_line_endings_spec.rb

@@ -1,15 +1,18 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Caramelize::RemoveTableTabLineEndings do
+  subject(:run) { filter.run }
+
   let(:filter) { described_class.new(body) }
-  subject { filter.run}
 
   describe '#run' do
     context 'table with tabs at unix line-endings' do
       let(:body) { "cell1\t|cell2\t|\t\t\n" }
 
       it 'removes tabs at end of line' do
-        is_expected.to eq "cell1\t|cell2\t|\n"
+        expect(run).to eq "cell1\t|cell2\t|\n"
       end
     end
 
@@ -17,24 +20,26 @@ describe Caramelize::RemoveTableTabLineEndings do
       let(:body) { "cell1\t|cell2\t|\t    \n" }
 
       it 'removes spaces at end of line' do
-        is_expected.to eq "cell1\t|cell2\t|\n"
+        expect(run).to eq "cell1\t|cell2\t|\n"
       end
 
       context 'replace in full file' do
-        let(:body) { File.open(File.join(['spec', 'fixtures', 'markup', 'table-tab-line-endings-input.textile']), 'r').read }
+        let(:body) do
+          File.read(File.join(['spec', 'fixtures', 'markup', 'table-tab-line-endings-input.textile']))
+        end
 
         it 'returns as expected' do
-          output_text = File.open(File.join(['spec', 'fixtures', 'markup', 'table-tab-line-endings-output.textile']), 'r').read
-          is_expected.to eq output_text
+          output_text = File.read(File.join(['spec', 'fixtures', 'markup', 'table-tab-line-endings-output.textile']))
+          expect(run).to eq output_text
         end
       end
     end
 
-    context 'table with tabs at windows line-endings' do
+    context 'with table having tabs at windows line-endings' do
       let(:body) { "cell1\t|cell2\t|\t\t\r\n" }
 
       it 'removes tabs at end of line' do
-        is_expected.to eq "cell1\t|cell2\t|\n"
+        expect(run).to eq "cell1\t|cell2\t|\n"
       end
     end
 
@@ -42,7 +47,7 @@ describe Caramelize::RemoveTableTabLineEndings do
       let(:body) { "cell1\t|cell2\t|\t    \r\n" }
 
       it 'removes spaces at end of line' do
-        is_expected.to eq "cell1\t|cell2\t|\n"
+        expect(run).to eq "cell1\t|cell2\t|\n"
       end
     end
   end

data/spec/lib/caramelize/filters/swap_wiki_links_spec.rb

@@ -1,47 +1,50 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Caramelize::SwapWikiLinks do
   describe '#run' do
+    subject(:run) { filter.run }
+
     let(:filter) { described_class.new(body) }
-    subject { filter.run }
 
-    context 'wiki link with title' do
+    context 'with wiki link with title' do
       let(:body) { '[[statistics|Driver & Team Statistics]]' }
 
       it 'swaps title and target' do
-        is_expected.to eq '[[Driver & Team Statistics|statistics]]'
+        expect(run).to eq '[[Driver & Team Statistics|statistics]]'
       end
     end
 
-    context 'wiki title with spaces' do
+    context 'with wiki title with spaces' do
       let(:body) { '[[Release 1 0]]' }
 
       it 'replaces space with dashes' do
-        is_expected.to eq '[[Release 1 0|release_1_0]]'
+        expect(run).to eq '[[Release 1 0|release_1_0]]'
       end
     end
 
-    context 'wiki title with dashes' do
+    context 'with wiki title with dashes' do
       let(:body) { '[[Release-1.0]]' }
 
       it 'removes dots' do
-        is_expected.to eq '[[Release-1.0|release-10]]'
+        expect(run).to eq '[[Release-1.0|release-10]]'
       end
     end
 
-    context 'wiki link with spaces and without title' do
+    context 'with wiki link with spaces and without title' do
       let(:body) { '[[Intra wiki link]]' }
 
       it 'simples link to hyperlink' do
-        is_expected.to eq '[[Intra wiki link|intra_wiki_link]]'
+        expect(run).to eq '[[Intra wiki link|intra_wiki_link]]'
       end
 
-      context 'replace in full file' do
-        let(:body) { File.open(File.join(['spec', 'fixtures', 'markup', 'swap-links-input.textile']), 'r').read }
+      context 'with replace in full file' do
+        let(:body) { File.read(File.join(['spec', 'fixtures', 'markup', 'swap-links-input.textile'])) }
 
         it 'returns as expected' do
-          output_text = File.open(File.join(['spec', 'fixtures', 'markup', 'swap-links-output.textile']), 'r').read
-          is_expected.to eq output_text
+          output_text = File.read(File.join(['spec', 'fixtures', 'markup', 'swap-links-output.textile']))
+          expect(run).to eq output_text
         end
       end
     end

data/spec/lib/caramelize/filters/wikka_to_markdown_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Caramelize::Wikka2Markdown do
@@ -6,188 +8,251 @@ describe Caramelize::Wikka2Markdown do
   describe '#run' do
     subject { filter.run }
 
-    xcontext 'keep line breaks' do
+    xcontext 'when keep line breaks' do
       let(:body) { "line1\nline2" }
 
       it { is_expected.to eq "line1  \nline2" }
     end
 
-    context 'headline h1' do
+    context 'when headline h1' do
       let(:body) { '======Headline======' }
 
       it { is_expected.to eq '# Headline' }
     end
 
-    context 'headline h2' do
+    context 'when headline h2' do
       let(:body) { '=====Headline=====' }
 
       it { is_expected.to eq '## Headline' }
     end
 
-    context 'headline h3' do
-      let(:body) { '====Headline===='}
+    context 'when headline h3' do
+      let(:body) { '====Headline====' }
 
       it { is_expected.to eq '### Headline' }
     end
 
-    context 'headline h4' do
+    context 'when headline h4' do
       let(:body) { '===Headline===' }
 
       it { is_expected.to eq '#### Headline' }
     end
 
-    context 'headline h5' do
+    context 'when headline h5' do
       let(:body) { '==Headline==' }
 
       it { is_expected.to eq '##### Headline' }
     end
 
-    context 'bold' do
+    context 'when bold' do
       let(:body) { '**Text is bold**' }
 
       it { is_expected.to eq '**Text is bold**' }
     end
 
-    context 'italic' do
+    context 'when italic' do
       let(:body) { '//Text is italic//' }
 
       it { is_expected.to eq '*Text is italic*' }
     end
 
-    context 'underline' do
+    context 'when underline' do
       let(:body) { '__Text is underlined__' }
 
       it { is_expected.to eq '<u>Text is underlined</u>' }
     end
 
-    context 'line break' do
+    context 'when line break' do
       let(:body) { 'Text is---\nbroken to two lines.' }
 
       it { is_expected.to eq 'Text is  \nbroken to two lines.' }
     end
 
-    context 'unordered list entry' do
-      context 'tab based' do
+    context 'when unordered list entry' do
+      context 'with tab based' do
         let(:body) { "\t-unordered list entry" }
 
-        it { is_expected.to eq '* unordered list entry' }
+        it { is_expected.to eq '- unordered list entry' }
       end
 
-      context 'also tab based' do
-        let(:body) { "~-unordered list entry" }
+      context 'with tabs' do
+        let(:body) { '~-unordered list entry' }
 
-        it { is_expected.to eq '* unordered list entry' }
+        it { is_expected.to eq '- unordered list entry' }
       end
 
-      context 'space based' do
-        let(:body) { "    -unordered list entry" }
+      context 'with spaces' do
+        let(:body) { '    -unordered list entry' }
 
-        it { is_expected.to eq '* unordered list entry' }
+        it { is_expected.to eq '- unordered list entry' }
       end
 
-      context 'tab based with space' do
+      context 'with tab based with space' do
         let(:body) { "\t- unordered list entry" }
 
-        it { is_expected.to eq '* unordered list entry' }
+        it { is_expected.to eq '- unordered list entry' }
       end
 
-      context 'also tab based with space' do
-        let(:body) { "~- unordered list entry" }
+      context 'with another tab based with space' do
+        let(:body) { '~- unordered list entry' }
 
-        it { is_expected.to eq '* unordered list entry' }
+        it { is_expected.to eq '- unordered list entry' }
       end
 
-      context 'space based with space' do
-        let(:body) { "    - unordered list entry" }
+      context 'with space based with space' do
+        let(:body) { '    - unordered list entry' }
 
-        it { is_expected.to eq '* unordered list entry' }
+        it { is_expected.to eq '- unordered list entry' }
       end
     end
 
-    context 'ordered list entry' do
+    context 'when ordered list entry' do
       context 'without space' do
-        let(:body) { "~1)ordered list entry" }
+        let(:body) { '~1)ordered list entry' }
 
         it { is_expected.to eq '1. ordered list entry' }
       end
 
       context 'with space' do
-        let(:body) { "~1) ordered list entry" }
+        let(:body) { '~1) ordered list entry' }
 
         it { is_expected.to eq '1. ordered list entry' }
       end
     end
 
-    context 'wikilink' do
-      context 'only url' do
+    context 'when wikilink' do
+      context 'with only url' do
         let(:body) { '[[LemmaLemma]]' }
 
         it { is_expected.to eq '[[LemmaLemma]]' }
       end
 
-      context 'url and pipe title' do
+      context 'with only url sklfs' do
+        let(:body) { "\n        [[ComunitySiteIdeas]]        \n" }
+
+        it { is_expected.to eq "\n        [[ComunitySiteIdeas]]        \n" }
+      end
+
+      context 'with url and pipe title' do
         let(:body) { '[[SandBox|Test your formatting skills]]' }
 
         it { is_expected.to eq '[[Test your formatting skills|SandBox]]' }
       end
 
-      context 'url and title' do
+      context 'with url and title' do
         let(:body) { '[[SandBox Test your formatting skills]]' }
 
         it { is_expected.to eq '[[Test your formatting skills|SandBox]]' }
       end
     end
 
-    context 'hyperlink' do
-      context 'only url' do
+    context 'when hyperlink' do
+      context 'with only url' do
         let(:body) { '[[http://target]]' }
 
         it { is_expected.to eq '<http://target>' }
       end
 
-      context 'url with title' do
+      context 'with url with title' do
         let(:body) { '[[http://target Title]]' }
 
         it { is_expected.to eq '[Title](http://target)' }
       end
 
-      context 'url with pipe' do
+      context 'with url with title and special characters' do
+        let(:body) { '- [[http://www.sourcepole.com/sources/programming/cpp/cppqref.html C++ Syntax Reference]]' }
+
+        it { is_expected.to eq '- [C++ Syntax Reference](http://www.sourcepole.com/sources/programming/cpp/cppqref.html)' }
+      end
+
+      context 'with url with pipe' do
         let(:body) { '[[http://target|Title]]' }
 
         it { is_expected.to eq '[Title](http://target)' }
       end
     end
 
-    context 'code block' do
+    context 'when inline code' do
+      let(:body) { 'Code: %%Hello World%% // done' }
+
+      it { is_expected.to eq 'Code: `Hello World` // done' }
+    end
+
+    context 'when code block' do
+      let(:body) do
+        <<~EOS
+          Text before
+
+          %%
+          std::cin >> input;
+          ++stat[input];
+          %%
+
+          Text after
+
+          %%
+          std::cin >> input;
+          ++stat[input];
+          %%
+
+        EOS
+      end
+      let(:expected_result) do
+        <<~EOS
+          Text before
+
+          ```
+          std::cin >> input;
+          ++stat[input];
+          ```
+
+          Text after
+
+          ```
+          std::cin >> input;
+          ++stat[input];
+          ```
+
+        EOS
+      end
+
+      it { is_expected.to eq expected_result }
+    end
+
+    context 'when code block with language' do
       let(:body) do
-        <<-EOS
-Text before
+        <<~EOS
+          Text before
 
-%%
-std::cin >> input;
-++stat[input];
-%%
+          %%(php)
+          std::cin >> input;
+          ++stat[input];
+          %%
 
-Text after
+          Text after
 
-%%
-std::cin >> input;
-++stat[input];
-%%
+          %%(java)
+          std::cin >> input;
+          ++stat[input];
+          %%
 
         EOS
       end
       let(:expected_result) do
-        <<-EOS
-Text before
+        <<~EOS
+          Text before
 
-    std::cin >> input;
-    ++stat[input];
+          ```php
+          std::cin >> input;
+          ++stat[input];
+          ```
 
-Text after
+          Text after
 
-    std::cin >> input;
-    ++stat[input];
+          ```java
+          std::cin >> input;
+          ++stat[input];
+          ```
 
         EOS
       end

data/spec/lib/caramelize/input_wiki/wiki_spec.rb

@@ -1,21 +1,22 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Caramelize::InputWiki::Wiki do
   subject(:wiki) { described_class.new }
 
-
   describe '#latest_revisions' do
     let(:page1) { double }
     let(:page2) { double }
     let(:page3) { double }
 
-    context 'no pages' do
+    context 'without pages' do
       it 'return empty array' do
         expect(wiki.latest_revisions).to eq []
       end
     end
 
-    context 'pages with revisions' do
+    context 'with pages with revisions' do
       it 'returns list of latest pages' do
         wiki.titles = %w[allosaurus brachiosaurus]
         allow(wiki).to receive(:revisions_by_title)
@@ -29,8 +30,8 @@ describe Caramelize::InputWiki::Wiki do
   end
 
   describe '#revisions_by_author' do
-    context 'revisions is empty' do
-      context 'and titles is empty' do
+    context 'with revisions is empty' do
+      context 'with titles is empty' do
         it 'returns empty array' do
           allow(wiki).to receive(:titles).and_return []
           expect(wiki.revisions_by_title('title')).to eq []
@@ -38,18 +39,18 @@ describe Caramelize::InputWiki::Wiki do
       end
     end
 
-    context 'revisions are given' do
-      context 'and title given' do
+    context 'with revisions are given' do
+      context 'with title given' do
         it 'returns empty array' do
           pages = []
-          home_1 = OpenStruct.new(title: 'Home', time: Time.parse('2015-01-23'))
-          pages << home_1
-          pages << OpenStruct.new(title: 'Example', time: Time.parse('2015-01-20'))
-          pages << OpenStruct.new(title: 'Authors', time: Time.parse('2015-01-30'))
-          home_2 = OpenStruct.new(title: 'Home', time: Time.parse('2014-01-23'))
-          pages << home_2
+          home1 = double(title: 'Home', time: Time.parse('2015-01-23'))
+          pages << home1
+          pages << double(title: 'Example', time: Time.parse('2015-01-20'))
+          pages << double(title: 'Authors', time: Time.parse('2015-01-30'))
+          home2 = double(title: 'Home', time: Time.parse('2014-01-23'))
+          pages << home2
           allow(wiki).to receive(:revisions).and_return pages
-          expect(wiki.revisions_by_title('Home')).to eq [home_2, home_1]
+          expect(wiki.revisions_by_title('Home')).to eq [home2, home1]
         end
       end
     end