caramelize 1.3.0 → 1.3.2

data/lib/caramelize/filters/wikka_to_markdown.rb

@@ -34,7 +34,7 @@ module Caramelize
       target_body.gsub!(/(\*\*)(.*?)(\*\*)/) { |_s| "**#{::Regexp.last_match(2)}**" } # bold
       target_body.gsub!(%r{(//)(.*?)(//)}, '*\2*') # italic
       target_body.gsub!(/(__)(.*?)(__)/) { |_s| "<u>#{::Regexp.last_match(2)}</u>" } # underline
-      target_body.gsub!(/(---)/, '  ') # forced linebreak
+      target_body.gsub!(/(---)/, "  ") # forced linebreak
     end
 
     def replace_lists
@@ -51,7 +51,7 @@ module Caramelize
 
     def replace_links
       target_body.gsub!(/\[{2}((\w+):\S[^| ]*)[| ](.*)\]{2}/,
-                        '[\3](\1)')
+        '[\3](\1)')
       target_body.gsub!(/\[{2}((\w+):.*)\]{2}/, '<\1>')
     end
 

data/lib/caramelize/health_check.rb

@@ -17,7 +17,7 @@ module Caramelize
     private
 
     def gollum
-      @gollum ||= ::Gollum::Wiki.new(wiki_path, { ref: 'main' })
+      @gollum ||= ::Gollum::Wiki.new(wiki_path, {ref: "main"})
     end
   end
 end

data/lib/caramelize/health_checks/home_page_check.rb

@@ -10,13 +10,13 @@ module Caramelize
       end
 
       def check
-        puts 'Home.md missing' unless has_home_page?
+        puts "Home.md missing" unless has_home_page?
       end
 
       private
 
       def has_home_page? # rubocop:todo Naming/PredicateName
-        gollum.file('Home')
+        gollum.file("Home")
       end
     end
   end

data/lib/caramelize/health_checks/orphaned_pages_check.rb

@@ -33,7 +33,7 @@ module Caramelize
       end
 
       def page_paths
-        pages.map(&:path).map { |path| path.split('.').first }
+        pages.map(&:path).map { |path| path.split(".").first }
       end
 
       def check_pages

data/lib/caramelize/health_checks/page.rb

@@ -12,12 +12,12 @@ module Caramelize
       def intra_wiki_links
         gollum_page.text_data.scan(/\[\[(.+\|)?(\S+)\]\]/).map do |match|
           link = match[1]
-          filename == path ? link : [filename, link].join('/')
+          (filename == path) ? link : [filename, link].join("/")
         end.uniq
       end
 
       def filename
-        path.split('/').first
+        path.split("/").first
       end
 
       def path

data/lib/caramelize/input_wiki/media_wiki.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'caramelize/filters/add_newline_to_page_end'
-require 'caramelize/filters/mediawiki_to_markdown'
+require "caramelize/filters/add_newline_to_page_end"
+require "caramelize/filters/mediawiki_to_markdown"
 
 module Caramelize
   module InputWiki
@@ -20,7 +20,7 @@ module Caramelize
         JOIN text as t ON cn.content_address = CONCAT('tt:', t.old_id)
         ORDER BY r.rev_timestamp ASC;
       }
-      SQL_AUTHORS = 'SELECT user_id, user_name, user_real_name, user_email FROM user;'
+      SQL_AUTHORS = "SELECT user_id, user_name, user_real_name, user_email FROM user;"
       NAMESPACE_MAPPING = {
         0 => :NS_MAIN,
         1 => :NS_TALK,
@@ -41,7 +41,7 @@ module Caramelize
       }.freeze
 
       def initialize(options = {})
-        super(options)
+        super
         @options[:markup] = :media_wiki
         @options[:filters] << Caramelize::AddNewlineToPageEnd
         @options[:filters] << ::Caramelize::MediawikiToMarkdown
@@ -50,7 +50,7 @@ module Caramelize
       # after calling this action, titles and @revisions are expected to be filled
       def read_pages
         pages.each do |row|
-          titles << row['page_title']
+          titles << row["page_title"]
           revisions << Page.new(build_properties(row))
         end
         titles.uniq!
@@ -59,9 +59,9 @@ module Caramelize
 
       def read_authors
         database.query(authors_query).each do |row|
-          name = row['user_real_name'].empty? ? row['user_name'] : 'Anonymous'
-          email = row['user_email'].empty? ? nil : row['user_email']
-          authors[row['user_id']] = { name:, email: }
+          name = row["user_real_name"].empty? ? row["user_name"] : "Anonymous"
+          email = row["user_email"].empty? ? nil : row["user_email"]
+          authors[row["user_id"]] = {name:, email:}
         end
 
         authors
@@ -86,24 +86,24 @@ module Caramelize
       end
 
       def build_properties(row)
-        author = authors[row['actor_user']] || { name: 'Anonymous', email: 'anonymous@example.com' }
+        author = authors[row["actor_user"]] || {name: "Anonymous", email: "anonymous@example.com"}
         {
-          id: row['rev_id'],
+          id: row["rev_id"],
           title: title_by_namespace(row),
-          body: row['old_text'],
+          body: row["old_text"],
           markup: :media_wiki,
-          latest: row['page_latest'] == row['rev_id'],
-          time: Time.strptime(row['rev_timestamp'], '%Y%m%d%H%M%S'),
-          message: row['comment_text'],
+          latest: row["page_latest"] == row["rev_id"],
+          time: Time.strptime(row["rev_timestamp"], "%Y%m%d%H%M%S"),
+          message: row["comment_text"],
           author:
         }
       end
 
       def title_by_namespace(row)
-        return row['page_title'] if namespace_matches?(row['page_namespace'], :NS_MAIN)
-        return "#{row['page_title']}_Discussion" if namespace_matches?(row['page_namespace'], :NS_TALK)
+        return row["page_title"] if namespace_matches?(row["page_namespace"], :NS_MAIN)
+        return "#{row["page_title"]}_Discussion" if namespace_matches?(row["page_namespace"], :NS_TALK)
 
-        row['page_title']
+        row["page_title"]
       end
 
       def namespace_matches?(namespace_id, expected_namespace)

data/lib/caramelize/input_wiki/redmine_wiki.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'caramelize/filters/swap_wiki_links'
-require 'caramelize/filters/remove_table_tab_line_endings'
+require "caramelize/filters/swap_wiki_links"
+require "caramelize/filters/remove_table_tab_line_endings"
 
 module Caramelize
   module InputWiki
@@ -9,7 +9,7 @@ module Caramelize
       include DatabaseConnector
 
       def initialize(options = {})
-        super(options)
+        super
         @options[:markup] = :textile
         @options[:filters] << ::Caramelize::SwapWikiLinks
         @options[:filters] << ::Caramelize::RemoveTableTabLineEndings
@@ -31,9 +31,9 @@ module Caramelize
 
       def read_authors
         database.query(authors_query).each do |row|
-          authors[row['id']] = { id: row['id'],
-                                 name: row['login'],
-                                 email: row['mail'] }
+          authors[row["id"]] = {id: row["id"],
+                                 name: row["login"],
+                                 email: row["mail"]}
         end
         authors
       end
@@ -41,18 +41,18 @@ module Caramelize
       private
 
       def build_page(row_page)
-        results_contents = database.query(single_page_query(row_page['id']))
+        results_contents = database.query(single_page_query(row_page["id"]))
 
-        wiki = wikis.find { |row| row['id'] == row_page['wiki_id'] }
+        wiki = wikis.find { |row| row["id"] == row_page["wiki_id"] }
 
-        project_identifier = ''
+        project_identifier = ""
 
         if wiki
-          project = projects.find { |row| row['id'] == wiki['project_id'] }
-          project_identifier = "#{project['identifier']}/"
+          project = projects.find { |row| row["id"] == wiki["project_id"] }
+          project_identifier = "#{project["identifier"]}/"
         end
 
-        title = project_identifier + row_page['title']
+        title = project_identifier + row_page["title"]
         titles << title
 
         results_contents.each do |row_content|
@@ -63,14 +63,14 @@ module Caramelize
 
       def add_projects_as_namespaces
         projects.each do |row_project|
-          namespace = { identifier: row_project['identifier'],
-                        name: row_project['name'] }
+          namespace = {identifier: row_project["identifier"],
+                       name: row_project["name"]}
           namespaces << namespace
         end
       end
 
       def authors_query
-        'SELECT id, login, mail FROM users;'
+        "SELECT id, login, mail FROM users;"
       end
 
       def single_page_query(page_id)
@@ -78,15 +78,15 @@ module Caramelize
       end
 
       def projects_query
-        'SELECT id, identifier, name FROM projects;'
+        "SELECT id, identifier, name FROM projects;"
       end
 
       def pages_query
-        'SELECT id, title, wiki_id FROM wiki_pages;'
+        "SELECT id, title, wiki_id FROM wiki_pages;"
       end
 
       def wikis_query
-        'SELECT id, project_id FROM wikis;'
+        "SELECT id, project_id FROM wikis;"
       end
 
       def pages
@@ -102,15 +102,15 @@ module Caramelize
       end
 
       def build_properties(title, row_content)
-        author = authors.fetch(row_content['author_id'], nil)
+        author = authors.fetch(row_content["author_id"], nil)
         {
-          id: row_content['id'],
+          id: row_content["id"],
           title:,
-          body: row_content['data'],
+          body: row_content["data"],
           markup: :textile,
           latest: false,
-          time: row_content['updated_on'],
-          message: row_content['comments'],
+          time: row_content["updated_on"],
+          message: row_content["comments"],
           author:
         }
       end

data/lib/caramelize/input_wiki/wiki.rb

@@ -17,7 +17,7 @@ module Caramelize
         # new array only containing pages by this name sorted by time asc
         # this does not support renamed pages
         revisions.select { |revision| revision.title == title }
-                 .sort_by(&:time)
+          .sort_by(&:time)
       end
 
       # return an empty array in case this action was not overridden

data/lib/caramelize/input_wiki/wikka_wiki.rb

@@ -1,20 +1,20 @@
 # frozen_string_literal: true
 
-require 'caramelize/filters/add_newline_to_page_end'
-require 'caramelize/filters/camel_case_to_wiki_links'
-require 'caramelize/filters/wikka_to_markdown'
+require "caramelize/filters/add_newline_to_page_end"
+require "caramelize/filters/camel_case_to_wiki_links"
+require "caramelize/filters/wikka_to_markdown"
 
 module Caramelize
   module InputWiki
     class WikkaWiki < Wiki
       include DatabaseConnector
 
-      SQL_PAGES = 'SELECT id, tag, body, time, latest, user, note FROM wikka_pages ORDER BY time;'
-      SQL_AUTHORS = 'SELECT name, email FROM wikka_users;'
+      SQL_PAGES = "SELECT id, tag, body, time, latest, user, note FROM wikka_pages ORDER BY time;"
+      SQL_AUTHORS = "SELECT name, email FROM wikka_users;"
       FUNCTION_PAGES = %w[AdminBadWords AdminPages AdminUsers AdminSpamLog CategoryAdmin CategoryCategory CategoryWiki DatabaseInfo FormattingRules HighScores InterWiki MyChanges MyPages OrphanedPages OwnedPages PageIndex PasswordForgotten RecentChanges RecentlyCommented Sandbox SysInfo TableMarkup TableMarkupReference TextSearch TextSearchExpanded UserSettings WantedPages WikiCategory WikkaInstaller WikkaConfig WikkaDocumentation WikkaMenulets WikkaReleaseNotes].freeze
 
       def initialize(options = {})
-        super(options)
+        super
         @options[:markup] = :wikka
         @options[:filters] << ::Caramelize::AddNewlineToPageEnd
         @options[:filters] << ::Caramelize::WikkaToMarkdown
@@ -24,7 +24,7 @@ module Caramelize
       # after calling this action, titles and @revisions are expected to be filled
       def read_pages
         pages.each do |row|
-          titles << row['tag']
+          titles << row["tag"]
           revisions << Page.new(build_properties(row))
         end
         titles.uniq!
@@ -34,7 +34,7 @@ module Caramelize
       def read_authors
         results = database.query(authors_query)
         results.each do |row|
-          authors[row['name']] = { name: row['name'], email: row['email'] }
+          authors[row["name"]] = {name: row["name"], email: row["email"]}
         end
       end
 
@@ -57,15 +57,15 @@ module Caramelize
       end
 
       def build_properties(row)
-        author = authors[row['user']]
+        author = authors[row["user"]]
         {
-          id: row['id'],
-          title: row['tag'],
-          body: row['body'],
+          id: row["id"],
+          title: row["tag"],
+          body: row["body"],
           markup: :wikka,
-          latest: row['latest'] == 'Y',
-          time: row['time'],
-          message: row['note'],
+          latest: row["latest"] == "Y",
+          time: row["time"],
+          message: row["note"],
           author:
         }
       end

data/lib/caramelize/output_wiki/gollum.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'gollum-lib'
+require "gollum-lib"
 
 module Caramelize
   module OutputWiki
@@ -31,7 +31,7 @@ module Caramelize
 
       def rename_page(page_title, new_title)
         gollum_page = gollum.page(page_title)
-        gollum.rename_page(gollum_page, new_title, { message: 'Rename home page' })
+        gollum.rename_page(gollum_page, new_title, {message: "Rename home page"})
       end
 
       # Commit all revisions of the given history into this gollum-wiki-repository.
@@ -67,7 +67,7 @@ module Caramelize
       end
 
       def gollum
-        @gollum ||= ::Gollum::Wiki.new(wiki_path, { repo_is_bare: true, ref: 'main' })
+        @gollum ||= ::Gollum::Wiki.new(wiki_path, {repo_is_bare: true, ref: "main"})
       end
 
       def initialize_repository

data/lib/caramelize/page.rb

@@ -5,14 +5,14 @@ module Caramelize
     attr_accessor :title, :body, :id, :markup, :latest, :time, :message, :author
 
     def initialize(page = {})
-      @id =      page[:id]
-      @title =   page.fetch(:title, '')
-      @body =    page.fetch(:body, '')
-      @syntax =  page[:markup]
-      @latest =  page[:latest] || false
-      @time =    page.fetch(:time, Time.now)
-      @message = page.fetch(:message, '')
-      @author =  page[:author]
+      @id = page[:id]
+      @title = page.fetch(:title, "")
+      @body = page.fetch(:body, "")
+      @syntax = page[:markup]
+      @latest = page[:latest] || false
+      @time = page.fetch(:time, Time.now)
+      @message = page.fetch(:message, "")
+      @author = page[:author]
     end
 
     def author_email
@@ -24,7 +24,7 @@ module Caramelize
     end
 
     def author # rubocop:todo Lint/DuplicateMethods
-      @author ||= { name: 'Caramelize', email: 'mail@example.com' }
+      @author ||= {name: "Caramelize", email: "mail@example.com"}
     end
 
     def latest?
@@ -32,13 +32,13 @@ module Caramelize
     end
 
     def path
-      return @title unless @title.index('/')
+      return @title unless @title.index("/")
 
       "#{title_pieces.first}/#{title_pieces.last.downcase}"
     end
 
     def title_pieces
-      @title.split('/')
+      @title.split("/")
     end
 
     def set_latest

data/lib/caramelize/services/page_builder.rb

@@ -13,10 +13,10 @@ module Caramelize
           "* [[#{namespace[:name]}|#{namespace[:identifier]}/wiki]]"
         end.prepend(HEADLINE).join("  \n")
 
-        Page.new(title: 'Home',
-                 body:,
-                 message: 'Create Namespace Overview',
-                 latest: true)
+        Page.new(title: "Home",
+          body:,
+          message: "Create Namespace Overview",
+          latest: true)
       end
     end
   end

data/lib/caramelize/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Caramelize
-  VERSION = '1.3.0'
+  VERSION = "1.3.2"
 end

data/lib/caramelize.rb

@@ -1,21 +1,21 @@
 # frozen_string_literal: true
 
-require 'caramelize/version'
-require 'caramelize/page'
-require 'caramelize/database_connector'
-require 'caramelize/filters/add_newline_to_page_end'
-require 'caramelize/filter_processor'
-require 'caramelize/input_wiki/wiki'
-require 'caramelize/input_wiki/media_wiki'
-require 'caramelize/input_wiki/redmine_wiki'
-require 'caramelize/input_wiki/wikka_wiki'
-require 'caramelize/content_transferer'
-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/version"
+require "caramelize/page"
+require "caramelize/database_connector"
+require "caramelize/filters/add_newline_to_page_end"
+require "caramelize/filter_processor"
+require "caramelize/input_wiki/wiki"
+require "caramelize/input_wiki/media_wiki"
+require "caramelize/input_wiki/redmine_wiki"
+require "caramelize/input_wiki/wikka_wiki"
+require "caramelize/content_transferer"
+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"
 
 Encoding.default_external = Encoding::UTF_8
 Encoding.default_internal = Encoding::UTF_8

data/samples/media_wiki.rb

@@ -4,10 +4,10 @@
 
 def input_wiki
   options = {
-    host: '0.0.0.0',
-    username: 'wikiuser',
-    password: 'example',
-    database: 'my_wiki',
+    host: "0.0.0.0",
+    username: "wikiuser",
+    password: "example",
+    database: "my_wiki",
     port: 63_645
   }
   Caramelize::InputWiki::MediaWiki.new(options)

data/spec/lib/caramelize/content_transferer_spec.rb

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

data/spec/lib/caramelize/filter_processor_spec.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
+require "spec_helper"
 
 describe Caramelize::FilterProcessor do
   subject(:processor) { described_class.new(input_wiki) }
 
   let(:filters) { [] }
   let(:input_wiki) { double(filters:) } # rubocop:todo RSpec/VerifiedDoubles
-  let(:body) { 'body' }
+  let(:body) { "body" }
 
   # rubocop:todo RSpec/LeakyConstantDeclaration
   class ReverseFilter # rubocop:todo Lint/ConstantDefinitionInBlock, RSpec/LeakyConstantDeclaration
@@ -21,17 +21,17 @@ describe Caramelize::FilterProcessor do
   end
   # rubocop:enable RSpec/LeakyConstantDeclaration
 
-  describe '#run' do
-    context 'without any filters' do
-      it 'returns same revision body' do
+  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
+    context "with reverse filter" do
       let(:filters) { [ReverseFilter] }
 
-      it 'returns reversed body' do
+      it "returns reversed body" do
         expect(processor.run(body)).to eql body.reverse
       end
     end

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

@@ -1,25 +1,25 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
+require "spec_helper"
 
 describe Caramelize::AddNewlineToPageEnd do
-  describe '#run' do
+  describe "#run" do
     subject(:run) { filter.run }
 
     let(:filter) { described_class.new(body) }
 
-    context 'with newline on body end' do
+    context "with newline on body end" do
       let(:body) { "Here is a sample body\n" }
 
-      it 'adds no newline character' do
+      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' }
+    context "without newline on body end" do
+      let(:body) { "Here is a sample body" }
 
-      it 'adds newline character' do
+      it "adds newline character" do
         expect(run).to eq "Here is a sample body\n"
       end
     end

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

@@ -1,44 +1,42 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
+require "spec_helper"
 
-# rubocop:todo RSpec/SpecFilePathFormat
-describe Caramelize::CamelCaseToWikiLinks do # rubocop:todo RSpec/FilePath, RSpec/SpecFilePathFormat
-  # rubocop:enable RSpec/SpecFilePathFormat
-  describe '#run' do
+describe Caramelize::CamelCaseToWikiLinks do # rubocop:todo 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]]' }
+    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]]'
+      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]]' }
+    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]]'
+      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' }
+    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'
+      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
+    context "with camel case text at document end with newline" do
       let(:body) { "Hier ein CamelCaseExample\n" }
 
-      it 'does wiki link' do
+      it "does wiki link" do
         expect(run).to eq "Hier ein [[CamelCaseExample]]\n"
       end
     end