caramelize 1.1.1 → 1.2.1

data/lib/caramelize/page.rb

@@ -1,8 +1,8 @@
+# frozen_string_literal: true
+
 module Caramelize
   class Page
-
-    attr_accessor :title, :body, :id, :markup, :latest, :time, :message,
-                  :author, :author_name
+    attr_accessor :title, :body, :id, :markup, :latest, :time, :message, :author
 
     def initialize(page = {})
       @id =      page[:id]
@@ -13,20 +13,18 @@ module Caramelize
       @time =    page.fetch(:time, Time.now)
       @message = page.fetch(:message, '')
       @author =  page[:author]
-      @author_name = page[:author_name]
     end
 
     def author_email
-      author.email
+      author[:email]
     end
 
     def author_name
-      author.name
+      author[:name]
     end
 
-    def author
-      @author ||= OpenStruct.new(name: @author_name || "Caramelize",
-                             email: "mail@example.com")
+    def author # rubocop:todo Lint/DuplicateMethods
+      @author ||= { name: 'Caramelize', email: 'mail@example.com' }
     end
 
     def latest?
@@ -35,7 +33,12 @@ module Caramelize
 
     def path
       return @title unless @title.index('/')
-      @title.split('/').first + '/' + @title.split('/').last.downcase
+
+      "#{title_pieces.first}/#{title_pieces.last.downcase}"
+    end
+
+    def title_pieces
+      @title.split('/')
     end
 
     def set_latest
@@ -48,6 +51,7 @@ module Caramelize
 
     def commit_message
       return "Edit in page #{title}" if message.empty?
+
       message
     end
   end

data/lib/caramelize/services/page_builder.rb

@@ -1,17 +1,20 @@
+# frozen_string_literal: true
+
 module Caramelize
   module Services
     class PageBuilder
+      HEADLINE = "## Overview of namespaces\n"
+
       def self.build_namespace_overview(namespaces)
-        body = "## Overview of namespaces\n\n"
+        # TODO: change wiki as configurable default home
+        # TODO support other markup syntaxes
 
-        namespaces.each do |namespace|
-          # TODO change wiki as configurable default home
-          # TODO support other markup syntaxes
-          body << "* [[#{namespace[:name]}|#{namespace[:identifier]}/wiki]]  \n"
-        end
+        body = namespaces.map do |namespace|
+          "* [[#{namespace[:name]}|#{namespace[:identifier]}/wiki]]"
+        end.prepend(HEADLINE).join("  \n")
 
-        Page.new(title: "Home",
-                 body: body,
+        Page.new(title: 'Home',
+                 body:,
                  message: 'Create Namespace Overview',
                  latest: true)
       end

data/lib/caramelize/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Caramelize
-  VERSION = '1.1.1'
+  VERSION = '1.2.1'
 end

data/lib/caramelize.rb

@@ -1,9 +1,14 @@
+# frozen_string_literal: true
+
 require 'caramelize/version'
 require 'caramelize/page'
 require 'caramelize/content_transferer'
 require 'caramelize/filter_processor'
 require 'caramelize/database_connector'
 require 'caramelize/health_check'
+require 'caramelize/health_checks/home_page_check'
+require 'caramelize/health_checks/orphaned_pages_check'
+require 'caramelize/health_checks/page'
 require 'caramelize/output_wiki/gollum'
 require 'caramelize/services/page_builder'
 require 'caramelize/input_wiki/wiki'

data/spec/lib/caramelize/content_transferer_spec.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Caramelize::ContentTransferer do
   describe '#execute' do
     context 'with original_wiki' do
-      pending
+      pending('test full transfer')
     end
   end
 end

data/spec/lib/caramelize/filter_processor_spec.rb

@@ -1,20 +1,25 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Caramelize::FilterProcessor do
+  subject(:processor) { described_class.new(input_wiki) }
+
   let(:filters) { [] }
-  let(:input_wiki) { double(filters: filters) }
+  let(:input_wiki) { double(filters:) } # rubocop:todo RSpec/VerifiedDoubles
   let(:body) { 'body' }
-  subject(:processor) { described_class.new(input_wiki) }
 
-  class ReverseFilter
+  # rubocop:todo RSpec/LeakyConstantDeclaration
+  class ReverseFilter # rubocop:todo Lint/ConstantDefinitionInBlock, RSpec/LeakyConstantDeclaration
     def initialize(body)
       @body = body
     end
 
     def run
-      @body.reverse
+      @body.reverse # rubocop:todo RSpec/InstanceVariable
     end
   end
+  # rubocop:enable RSpec/LeakyConstantDeclaration
 
   describe '#run' do
     context 'without any filters' do

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+# rubocop:todo RSpec/SpecFilePathFormat
+describe Caramelize::Filter::AddNewlineToPageEnd do # rubocop:todo RSpec/FilePath, RSpec/SpecFilePathFormat
+  # rubocop:enable RSpec/SpecFilePathFormat
+  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,46 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+# rubocop:todo RSpec/SpecFilePathFormat
+describe Caramelize::CamelCaseToWikiLinks do # rubocop:todo RSpec/FilePath, RSpec/SpecFilePathFormat
+  # rubocop:enable RSpec/SpecFilePathFormat
+  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,20 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
-describe Caramelize::RemoveTableTabLineEndings do
+# rubocop:todo RSpec/SpecFilePathFormat
+describe Caramelize::RemoveTableTabLineEndings do # rubocop:todo RSpec/FilePath, RSpec/SpecFilePathFormat
+  # rubocop:enable RSpec/SpecFilePathFormat
+  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
+    context 'table with tabs at unix line-endings' do # rubocop:todo RSpec/ContextWording
       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 +22,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 }
+      context 'replace in full file' do # rubocop:todo RSpec/ContextWording
+        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 +49,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,52 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
-describe Caramelize::SwapWikiLinks do
+# rubocop:todo RSpec/SpecFilePathFormat
+describe Caramelize::SwapWikiLinks do # rubocop:todo RSpec/FilePath, RSpec/SpecFilePathFormat
+  # rubocop:enable RSpec/SpecFilePathFormat
   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/wikka2markdown_spec.rb

@@ -0,0 +1,265 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+# rubocop:todo RSpec/SpecFilePathFormat
+describe Caramelize::Wikka2Markdown do # rubocop:todo RSpec/FilePath, RSpec/SpecFilePathFormat
+  # rubocop:enable RSpec/SpecFilePathFormat
+  let(:filter) { described_class.new(body) }
+
+  describe '#run' do
+    subject { filter.run }
+
+    xcontext 'when keep line breaks' do # rubocop:todo RSpec/PendingWithoutReason
+      let(:body) { "line1\nline2" }
+
+      it { is_expected.to eq "line1  \nline2" }
+    end
+
+    context 'when headline h1' do
+      let(:body) { '======Headline======' }
+
+      it { is_expected.to eq '# Headline' }
+    end
+
+    context 'when headline h2' do
+      let(:body) { '=====Headline=====' }
+
+      it { is_expected.to eq '## Headline' }
+    end
+
+    context 'when headline h3' do
+      let(:body) { '====Headline====' }
+
+      it { is_expected.to eq '### Headline' }
+    end
+
+    context 'when headline h4' do
+      let(:body) { '===Headline===' }
+
+      it { is_expected.to eq '#### Headline' }
+    end
+
+    context 'when headline h5' do
+      let(:body) { '==Headline==' }
+
+      it { is_expected.to eq '##### Headline' }
+    end
+
+    context 'when bold' do
+      let(:body) { '**Text is bold**' }
+
+      it { is_expected.to eq '**Text is bold**' }
+    end
+
+    context 'when italic' do
+      let(:body) { '//Text is italic//' }
+
+      it { is_expected.to eq '*Text is italic*' }
+    end
+
+    context 'when underline' do
+      let(:body) { '__Text is underlined__' }
+
+      it { is_expected.to eq '<u>Text is underlined</u>' }
+    end
+
+    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 'when unordered list entry' do
+      context 'with tab based' do
+        let(:body) { "\t-unordered list entry" }
+
+        it { is_expected.to eq '- unordered list entry' }
+      end
+
+      context 'with tabs' do
+        let(:body) { '~-unordered list entry' }
+
+        it { is_expected.to eq '- unordered list entry' }
+      end
+
+      context 'with spaces' do
+        let(:body) { '    -unordered list entry' }
+
+        it { is_expected.to eq '- unordered list entry' }
+      end
+
+      context 'with tab based with space' do
+        let(:body) { "\t- unordered list entry" }
+
+        it { is_expected.to eq '- unordered list entry' }
+      end
+
+      context 'with another tab based with space' do
+        let(:body) { '~- unordered list entry' }
+
+        it { is_expected.to eq '- unordered list entry' }
+      end
+
+      context 'with space based with space' do
+        let(:body) { '    - unordered list entry' }
+
+        it { is_expected.to eq '- unordered list entry' }
+      end
+    end
+
+    context 'when 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 'when wikilink' do
+      context 'with only url' do
+        let(:body) { '[[LemmaLemma]]' }
+
+        it { is_expected.to eq '[[LemmaLemma]]' }
+      end
+
+      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 '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 'when hyperlink' do
+      context 'with only url' do
+        let(:body) { '[[http://target]]' }
+
+        it { is_expected.to eq '<http://target>' }
+      end
+
+      context 'with url with title' do
+        let(:body) { '[[http://target Title]]' }
+
+        it { is_expected.to eq '[Title](http://target)' }
+      end
+
+      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 '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
+        <<~CPP
+          Text before
+
+          %%
+          std::cin >> input;
+          ++stat[input];
+          %%
+
+          Text after
+
+          %%
+          std::cin >> input;
+          ++stat[input];
+          %%
+
+        CPP
+      end
+      let(:expected_result) do
+        <<~CPP
+          Text before
+
+          ```
+          std::cin >> input;
+          ++stat[input];
+          ```
+
+          Text after
+
+          ```
+          std::cin >> input;
+          ++stat[input];
+          ```
+
+        CPP
+      end
+
+      it { is_expected.to eq expected_result }
+    end
+
+    context 'when code block with language' do
+      let(:body) do
+        <<~CPP
+          Text before
+
+          %%(php)
+          std::cin >> input;
+          ++stat[input];
+          %%
+
+          Text after
+
+          %%(java)
+          std::cin >> input;
+          ++stat[input];
+          %%
+
+        CPP
+      end
+      let(:expected_result) do
+        <<~CPP
+          Text before
+
+          ```php
+          std::cin >> input;
+          ++stat[input];
+          ```
+
+          Text after
+
+          ```java
+          std::cin >> input;
+          ++stat[input];
+          ```
+
+        CPP
+      end
+
+      it { is_expected.to eq expected_result }
+    end
+  end
+end