caramelize 0.1.2 → 1.1.0

data/spec/lib/caramelize/content_transferer_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe Caramelize::ContentTransferer do
+  describe '#execute' do
+    context 'with original_wiki' do
+      pending
+    end
+  end
+end

data/spec/lib/caramelize/filter_processor_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe Caramelize::FilterProcessor do
+  let(:filters) { [] }
+  let(:input_wiki) { double(filters: filters) }
+  let(:body) { 'body' }
+  subject(:processor) { described_class.new(input_wiki) }
+
+  class ReverseFilter
+    def initialize(body)
+      @body = body
+    end
+
+    def run
+      @body.reverse
+    end
+  end
+
+  describe '#run' do
+    context 'without any filters' do
+      it 'returns same revision body' do
+        expect(processor.run(body)).to eql body
+      end
+    end
+
+    context 'with reverse filter' do
+      let(:filters) { [ReverseFilter] }
+
+      it 'returns reversed body' do
+        expect(processor.run(body)).to eql body.reverse
+      end
+    end
+  end
+end

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

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+describe Caramelize::RemoveTableTabLineEndings do
+  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"
+      end
+    end
+
+    context 'with spaces on line ending' 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"
+      end
+
+      context 'replace in full file' do
+        let(:body) { File.open(File.join(['spec', 'fixtures', 'markup', 'table-tab-line-endings-input.textile']), 'r').read }
+
+        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
+        end
+      end
+    end
+
+    context 'table with 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"
+      end
+    end
+
+    context 'with spaces and windows line-endings' 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"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+describe Caramelize::SwapWikiLinks do
+  describe '#run' do
+    let(:filter) { described_class.new(body) }
+    subject { filter.run }
+
+    context '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]]'
+      end
+    end
+
+    context '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]]'
+      end
+    end
+
+    context 'wiki title with dashes' do
+      let(:body) { '[[Release-1.0]]' }
+
+      it 'removes dots' do
+        is_expected.to eq '[[Release-1.0|release-10]]'
+      end
+    end
+
+    context '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]]'
+      end
+
+      context 'replace in full file' do
+        let(:body) { File.open(File.join(['spec', 'fixtures', 'markup', 'swap-links-input.textile']), 'r').read }
+
+        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
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,198 @@
+require 'spec_helper'
+
+describe Caramelize::Wikka2Markdown do
+  let(:filter) { described_class.new(body) }
+
+  describe '#run' do
+    subject { filter.run }
+
+    xcontext 'keep line breaks' do
+      let(:body) { "line1\nline2" }
+
+      it { is_expected.to eq "line1  \nline2" }
+    end
+
+    context 'headline h1' do
+      let(:body) { '======Headline======' }
+
+      it { is_expected.to eq '# Headline' }
+    end
+
+    context 'headline h2' do
+      let(:body) { '=====Headline=====' }
+
+      it { is_expected.to eq '## Headline' }
+    end
+
+    context 'headline h3' do
+      let(:body) { '====Headline===='}
+
+      it { is_expected.to eq '### Headline' }
+    end
+
+    context 'headline h4' do
+      let(:body) { '===Headline===' }
+
+      it { is_expected.to eq '#### Headline' }
+    end
+
+    context 'headline h5' do
+      let(:body) { '==Headline==' }
+
+      it { is_expected.to eq '##### Headline' }
+    end
+
+    context 'bold' do
+      let(:body) { '**Text is bold**' }
+
+      it { is_expected.to eq '**Text is bold**' }
+    end
+
+    context 'italic' do
+      let(:body) { '//Text is italic//' }
+
+      it { is_expected.to eq '*Text is italic*' }
+    end
+
+    context 'underline' do
+      let(:body) { '__Text is underlined__' }
+
+      it { is_expected.to eq '<u>Text is underlined</u>' }
+    end
+
+    context '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
+        let(:body) { "\t-unordered list entry" }
+
+        it { is_expected.to eq '* unordered list entry' }
+      end
+
+      context 'also tab based' do
+        let(:body) { "~-unordered list entry" }
+
+        it { is_expected.to eq '* unordered list entry' }
+      end
+
+      context 'space based' do
+        let(:body) { "    -unordered list entry" }
+
+        it { is_expected.to eq '* unordered list entry' }
+      end
+
+      context 'tab based with space' do
+        let(:body) { "\t- unordered list entry" }
+
+        it { is_expected.to eq '* unordered list entry' }
+      end
+
+      context 'also tab based with space' do
+        let(:body) { "~- unordered list entry" }
+
+        it { is_expected.to eq '* unordered list entry' }
+      end
+
+      context 'space based with space' do
+        let(:body) { "    - unordered list entry" }
+
+        it { is_expected.to eq '* unordered list entry' }
+      end
+    end
+
+    context 'ordered list entry' do
+      context 'without space' do
+        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" }
+
+        it { is_expected.to eq '1. ordered list entry' }
+      end
+    end
+
+    context 'wikilink' do
+      context 'only url' do
+        let(:body) { '[[LemmaLemma]]' }
+
+        it { is_expected.to eq '[[LemmaLemma]]' }
+      end
+
+      context '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
+        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
+        let(:body) { '[[http://target]]' }
+
+        it { is_expected.to eq '<http://target>' }
+      end
+
+      context 'url with title' do
+        let(:body) { '[[http://target Title]]' }
+
+        it { is_expected.to eq '[Title](http://target)' }
+      end
+
+      context 'url with pipe' do
+        let(:body) { '[[http://target|Title]]' }
+
+        it { is_expected.to eq '[Title](http://target)' }
+      end
+    end
+
+    context '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
+  end
+end

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

@@ -0,0 +1,57 @@
+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
+      it 'return empty array' do
+        expect(wiki.latest_revisions).to eq []
+      end
+    end
+
+    context 'pages with revisions' do
+      it 'returns list of latest pages' do
+        wiki.titles = %w[allosaurus brachiosaurus]
+        allow(wiki).to receive(:revisions_by_title)
+          .with('allosaurus').and_return([page1, page2])
+        allow(wiki).to receive(:revisions_by_title)
+          .with('brachiosaurus').and_return([page3])
+
+        expect(wiki.latest_revisions).to eq([page2, page3])
+      end
+    end
+  end
+
+  describe '#revisions_by_author' do
+    context 'revisions is empty' do
+      context 'and titles is empty' do
+        it 'returns empty array' do
+          allow(wiki).to receive(:titles).and_return []
+          expect(wiki.revisions_by_title('title')).to eq []
+        end
+      end
+    end
+
+    context 'revisions are given' do
+      context 'and 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
+          allow(wiki).to receive(:revisions).and_return pages
+          expect(wiki.revisions_by_title('Home')).to eq [home_2, home_1]
+        end
+      end
+    end
+  end
+end

data/spec/lib/caramelize/output_wiki/gollum_spec.rb

@@ -0,0 +1,113 @@
+require 'spec_helper'
+
+describe Caramelize::OutputWiki::Gollum do
+  let(:gollum_output) { described_class.new('wiki.git') }
+  before do
+    allow(gollum_output).to receive(:initialize_repository).and_return true
+  end
+
+  describe '#commit_revision' do
+    let(:title) { 'title' }
+    let(:author) { double(name: 'Steven Universe', email: 'steven@example.com') }
+    let(:input_page) do
+      double(author: author,
+             body: 'body',
+             commit_message: 'done',
+             time: Time.now,
+             title: title,
+             path: title)
+    end
+    let(:gollum_page) do
+      double(:gollum_page,
+             name: 'title',
+             format: :markdown)
+    end
+    let(:markup) { :markdown }
+    let(:gollum) { double(:gollum) }
+
+    before do
+      allow(Gollum::Wiki).to receive(:new).and_return(gollum)
+    end
+
+    context 'page exists' do
+      before do
+        allow(gollum).to receive(:page).with(title).and_return(gollum_page)
+      end
+
+      it 'updates page' do
+        expect(gollum).to receive(:update_page).once.and_return(true)
+        gollum_output.commit_revision(input_page, markup)
+      end
+    end
+
+    context 'page does not exist yet' do
+      before do
+        allow(gollum).to receive(:page).with(title).and_return(nil)
+      end
+
+      it 'creates page' do
+        expect(gollum).to receive(:write_page).once
+        gollum_output.commit_revision(input_page, markup)
+      end
+    end
+  end
+
+  describe '#commit_history' do
+    pending
+  end
+
+  describe '#commit_namespace_overview' do
+    let(:namespaces) do
+      [
+        OpenStruct.new(identifier: 'velociraptors', name: 'Velociraptor'),
+        OpenStruct.new(identifier: 'allosaurus', name: 'Allosaurus')
+      ]
+    end
+
+    context '2 pages in namespaces' do
+      it 'commits page' do
+        allow(gollum_output).to receive(:commit_revision)
+        gollum_output.commit_namespace_overview(namespaces)
+        expect(gollum_output).to have_received(:commit_revision)
+      end
+    end
+  end
+
+  describe '#build_commit' do
+    let(:page) do
+      Caramelize::Page.new( title: 'Feathered Dinosaurs',
+                message: 'Dinosaurs really had feathers, do not forget!',
+                time: Time.parse('2015-02-12'),
+                body: 'Dinosaurs are awesome and have feathers!',
+                author: OpenStruct.new(name: 'Jeff Goldblum', email: 'jeff.g@example.com') )
+    end
+
+    let(:expected_hash) do
+      {
+        message: 'Dinosaurs really had feathers, do not forget!',
+        time: Time.parse('2015-02-12'),
+        name: 'Jeff Goldblum',
+        email: 'jeff.g@example.com'
+      }
+    end
+
+    it 'builds commit hash' do
+      expect(gollum_output.build_commit(page)).to eq expected_hash
+    end
+
+    context 'page has message' do
+      it 'uses page.title' do
+        expect(gollum_output.build_commit(page)[:message])
+          .to eq 'Dinosaurs really had feathers, do not forget!'
+      end
+    end
+
+    context 'page has no message' do
+      it 'should create message "Edit in page Feathered Dinosaurs"' do
+        page.message = ''
+        expect(gollum_output.build_commit(page)[:message])
+          .to eq 'Edit in page Feathered Dinosaurs'
+      end
+    end
+  end
+end