caramelize 1.1.1 → 1.2.1

data/lib/caramelize/filters/add_newline_to_page_end.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Caramelize
+  module Filter
+    class AddNewlineToPageEnd
+      def initialize(body)
+        @body = body
+      end
+
+      # take an input stream and convert all wikka syntax to markdown syntax
+      def run
+        return @body if @body[@body.length - 1] == "\n"
+
+        migrated_body = @body.dup
+
+        migrated_body << "\n"
+
+        migrated_body
+      end
+    end
+  end
+end

data/lib/caramelize/filters/camel_case_to_wiki_links.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Caramelize
+  class CamelCaseToWikiLinks
+    def initialize(body)
+      @body = body
+    end
+
+    # take an input stream and convert all wikka syntax to markdown syntax
+    def run
+      migrated_body = @body.dup
+
+      migrated_body.gsub!(/([^\[\|\w\S])([A-Z]\w+[A-Z]\w+)([^\]])/) { "#{::Regexp.last_match(1)}#{format_link(::Regexp.last_match(2))}#{::Regexp.last_match(3)}" }
+
+      migrated_body
+    end
+
+    private
+
+    def format_link(link)
+      link.gsub!(' ', '_')
+      link.gsub!('.', '')
+      "[[#{link}]]"
+    end
+  end
+end

data/lib/caramelize/filters/remove_table_tab_line_endings.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
+
 module Caramelize
   class RemoveTableTabLineEndings
-
     def initialize(body)
       @body = body
     end
@@ -8,7 +9,7 @@ module Caramelize
     # take an input stream and convert all wikka syntax to markdown syntax
     def run
       migrated_body = @body.dup
-      migrated_body.gsub!(/\|[\t ]*\r?[\n]/, "|\n")
+      migrated_body.gsub!(/\|[\t ]*\r?\n/, "|\n")
       migrated_body
     end
   end

data/lib/caramelize/filters/swap_wiki_links.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Caramelize
   class SwapWikiLinks
     def initialize(body)
@@ -8,8 +10,8 @@ module Caramelize
     def run
       migrated_body = @body.dup
 
-      migrated_body.gsub!(/\[\[(\S+)\|(.+?)\]\]/) { format_link($2, $1) }
-      migrated_body.gsub!(/\[\[([\w\s\-\.]*)\]\]/) { format_link($1, $1.dup) }
+      migrated_body.gsub!(/\[\[(\S+)\|(.+?)\]\]/) { format_link(::Regexp.last_match(2), ::Regexp.last_match(1)) }
+      migrated_body.gsub!(/\[\[([\w\s\-.]*)\]\]/) { format_link(::Regexp.last_match(1), ::Regexp.last_match(1).dup) }
 
       migrated_body
     end
@@ -19,7 +21,7 @@ module Caramelize
     def format_link(label, link)
       link.downcase!
       link.gsub!(' ', '_')
-      link.gsub!(/\./, '')
+      link.gsub!('.', '')
       "[[#{label}|#{link}]]"
     end
   end

data/lib/caramelize/filters/wikka_to_markdown.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Caramelize
   class Wikka2Markdown
     attr_reader :source_body
@@ -7,7 +9,7 @@ module Caramelize
     end
 
     def run
-      # TODO images: ({{image)(url\=?)?(.*)(}})
+      # TODO: images: ({{image)(url\=?)?(.*)(}})
       # markdown: ![Tux, the Linux mascot](/assets/images/tux.png)
 
       replace_headlines
@@ -15,49 +17,53 @@ module Caramelize
       replace_lists
       replace_wiki_links
       replace_links
+      replace_inline_code
       replace_code_block
 
       target_body
     end
 
     def replace_headlines
-      target_body.gsub!(/(======)(.*?)(======)/ ) {|s| '# ' + $2 } #h1
-      target_body.gsub!(/(=====)(.*?)(=====)/) {|s| '## ' + $2 }   #h2
-      target_body.gsub!(/(====)(.*?)(====)/) {|s| '### ' + $2 }   #h3
-      target_body.gsub!(/(===)(.*?)(===)/) {|s| '#### ' + $2 }   #h4
-      target_body.gsub!(/(==)(.*?)(==)/) {|s| '##### ' + $2 }   #h5
+      target_body.gsub!(/(======)(.*?)(======)/) { |_s| "# #{::Regexp.last_match(2)}" } # h1
+      target_body.gsub!(/(=====)(.*?)(=====)/) { |_s| "## #{::Regexp.last_match(2)}" } # h2
+      target_body.gsub!(/(====)(.*?)(====)/) { |_s| "### #{::Regexp.last_match(2)}" } # h3
+      target_body.gsub!(/(===)(.*?)(===)/) { |_s| "#### #{::Regexp.last_match(2)}" } # h4
+      target_body.gsub!(/(==)(.*?)(==)/) { |_s| "##### #{::Regexp.last_match(2)}" } # h5
     end
 
     def replace_formatting
-      target_body.gsub!(/(\*\*)(.*?)(\*\*)/) {|s| '**' + $2 + '**' }   #bold
-      target_body.gsub!(/(\/\/)(.*?)(\/\/)/, '*\2*') #italic
-      target_body.gsub!(/(__)(.*?)(__)/) {|s| '<u>' + $2 + '</u>'}   #underline
-      target_body.gsub!(/(---)/, '  ')   #forced linebreak
+      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
     end
 
     def replace_lists
-      target_body.gsub!(/(\t-\s?)(.*)/, '* \2')    # unordered list
-      target_body.gsub!(/(~-\s?)(.*)/, '* \2')     # unordered list
-      target_body.gsub!(/(    -\s?)(.*)/, '* \2')     # unordered list
+      target_body.gsub!(/(\t-\s?)(.*)/, '- \2')    # unordered list
+      target_body.gsub!(/(~-\s?)(.*)/, '- \2')     # unordered list
+      target_body.gsub!(/(    -\s?)(.*)/, '- \2')     # unordered list
 
       target_body.gsub!(/(~1\)\s?)(.*)/, '1. \2')     # unordered list
       # TODO ordered lists
     end
 
     def replace_wiki_links
-      target_body.gsub!(/[\[]{2}(\w+)[\s|](.+?)[\]]{2}/, '[[\2|\1]]')
+      target_body.gsub!(/\[{2}(\w+)[\s|](.+?)\]{2}/, '[[\2|\1]]')
     end
 
     def replace_links
-      target_body.gsub!(/[\[]{2}((\w+):[\S][^\| ]*)[\| ](.*)[\]]{2}/,
-                 '[\3](\1)')
-      target_body.gsub!(/[\[]{2}((\w+):.*)[\]]{2}/, '<\1>')
+      target_body.gsub!(/\[{2}((\w+):\S[^| ]*)[| ](.*)\]{2}/,
+                        '[\3](\1)')
+      target_body.gsub!(/\[{2}((\w+):.*)\]{2}/, '<\1>')
+    end
+
+    def replace_inline_code
+      target_body.gsub!(/(%%)(.*?)(%%)/) { |_s| "`#{::Regexp.last_match(2)}`" } # h1
     end
 
     def replace_code_block
-      target_body.gsub!(/^%%\s(.*?)%%\s?/m) do
-        $1.gsub(/^/, '    ')
-      end
+      target_body.gsub!(/^%%\(?(\w+)\)?\s(.*?)%%\s?/m) { "```#{::Regexp.last_match(1)}\n#{::Regexp.last_match(2)}```\n" }
+      target_body.gsub!(/^%%\s(.*?)%%\s?/m) { "```\n#{::Regexp.last_match(1)}```\n" }
     end
 
     def target_body

data/lib/caramelize/health_check.rb

@@ -1,85 +1,23 @@
+# frozen_string_literal: true
+
 module Caramelize
   class HealthCheck
     attr_reader :wiki_path, :options
 
-    DEFAULT_GOLLUM_HOME_TITLE = 'Home'.freeze
-
-    def initialize(wiki_path, options={})
+    def initialize(wiki_path, options = {})
       @wiki_path = wiki_path
       @options = options
     end
 
     def execute
-      #puts page_paths.sort.inspect
-
-      check_pages
-
-      #puts intra_wiki_paths.sort.inspect
-
-      puts "\n # Pages not linked within Wiki:"
-      puts page_paths_without_intra_wiki_path.sort.inspect
+      HealthChecks::HomePageCheck.new(gollum).check
+      HealthChecks::OrphanedPagesCheck.new(gollum).check
     end
 
     private
 
-    def files
-      @files ||= Dir.glob([wiki_path, '**/*.md'].join('/'))
-    end
-
-    def file_names
-      files.map do |file|
-        file.gsub("#{wiki_path}/", '').split('.').first
-      end
-    end
-
-    def check_pages
-      pages.each do |page|
-        puts "\n## #{page.path}"
-        check_page(page)
-      end
-    end
-
-    def check_page(page)
-      intra_wiki_links = intra_wiki_links(page.text_data)
-      available = 0
-      intra_wiki_links.each do |link|
-        intra_wiki_link = page.path.split('/').first == page.path ? link : [page.path.split('/').first, link].join('/')
-        if !page_paths.include?(intra_wiki_link)
-          puts "#{intra_wiki_link} expected, but missing"
-        else
-          available += 1
-          intra_wiki_paths << intra_wiki_link
-        end
-      end
-      puts "#{available}/#{intra_wiki_links.count} available"
-    end
-
-    def intra_wiki_links(body)
-      body.scan(/\[\[(.+\|)?(\S+)\]\]/).map { |match| match[1] }.uniq
-    end
-
-    def pages
-      gollum.pages
-    end
-
-    def page_paths
-      pages.map(&:path).map { |path| path.split('.').first }
-    end
-
-    def intra_wiki_paths
-      @intra_wiki_paths ||= []
-    end
-
-    def page_paths_without_intra_wiki_path
-      page_paths - intra_wiki_paths
-    end
-
-    def check_home_page
-      puts "Home.md missing" if File.exist?('wiki-export/Home.md')
-    end
-
     def gollum
-      @gollum ||= ::Gollum::Wiki.new(wiki_path)
+      @gollum ||= ::Gollum::Wiki.new(wiki_path, { ref: 'main' })
     end
   end
 end

data/lib/caramelize/health_checks/home_page_check.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Caramelize
+  module HealthChecks
+    class HomePageCheck
+      attr_reader :gollum
+
+      def initialize(gollum)
+        @gollum = gollum
+      end
+
+      def check
+        puts 'Home.md missing' unless has_home_page?
+      end
+
+      private
+
+      def has_home_page? # rubocop:todo Naming/PredicateName
+        gollum.file('Home')
+      end
+    end
+  end
+end

data/lib/caramelize/health_checks/orphaned_pages_check.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Caramelize
+  module HealthChecks
+    class OrphanedPagesCheck
+      attr_reader :gollum, :all_intra_wiki_paths, :intra_wiki_paths
+
+      def initialize(gollum)
+        @gollum = gollum
+        @intra_wiki_paths = []
+        @all_intra_wiki_paths = []
+      end
+
+      def check
+        puts "\n # Pages not linked within Wiki:"
+        puts page_paths_without_intra_wiki_path.sort.inspect
+      end
+
+      private
+
+      def check_page(page) # rubocop:todo Metrics/MethodLength
+        0.tap do |available_count|
+          page.intra_wiki_links.each do |intra_wiki_path|
+            if page_paths.include?(intra_wiki_path)
+              available_count += 1
+              intra_wiki_paths << intra_wiki_path
+            else
+              puts "#{intra_wiki_path} expected, but missing"
+            end
+          end
+          puts "#{available_count}/#{intra_wiki_links.count} available"
+        end
+      end
+
+      def page_paths
+        pages.map(&:path).map { |path| path.split('.').first }
+      end
+
+      def check_pages
+        pages.map do |page|
+          check_page(page)
+        end
+      end
+
+      def pages
+        @pages ||= gollum.pages.map do |gollum_page|
+          HealthChecks::Page.new(gollum_page)
+        end
+      end
+
+      def page_paths_without_intra_wiki_path
+        page_paths - intra_wiki_paths
+      end
+    end
+  end
+end

data/lib/caramelize/health_checks/page.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Caramelize
+  module HealthChecks
+    class Page
+      attr_reader :gollum_page
+
+      def initialize(gollum_page)
+        @gollum_page = gollum_page
+      end
+
+      def intra_wiki_links
+        gollum_page.text_data.scan(/\[\[(.+\|)?(\S+)\]\]/).map do |match|
+          link = match[1]
+          filename == path ? link : [filename, link].join('/')
+        end.uniq
+      end
+
+      def filename
+        path.split('/').first
+      end
+
+      def path
+        gollum_page.path
+      end
+    end
+  end
+end

data/lib/caramelize/input_wiki/redmine_wiki.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'caramelize/input_wiki/wiki'
 require 'caramelize/filters/swap_wiki_links'
 require 'caramelize/filters/remove_table_tab_line_endings'
@@ -23,7 +25,7 @@ module Caramelize
           build_page(row_page)
         end
         titles.uniq!
-        revisions.sort! { |a,b| a.time <=> b.time }
+        revisions.sort! { |a, b| a.time <=> b.time }
 
         revisions
       end
@@ -31,25 +33,26 @@ module Caramelize
       def read_authors
         results = database.query(authors_query)
         results.each do |row|
-          authors[row["id"]] = OpenStruct.new(id: row["id"],
-                                              name: row["login"],
-                                              email: row["mail"])
+          authors[row['id']] = { id: row['id'],
+                                 name: row['login'],
+                                 email: row['mail'] }
         end
         authors
       end
 
       private
 
-      def build_page(row_page)
+      # rubocop:todo Metrics/MethodLength
+      def build_page(row_page) # rubocop:todo Metrics/AbcSize, Metrics/MethodLength
         results_contents = database.query(single_page_query(row_page['id']))
 
-        wiki = wikis.select{ |row| row['id'] == row_page['wiki_id'] }.first
+        wiki = wikis.select { |row| row['id'] == row_page['wiki_id'] }.first
 
         project_identifier = ''
 
         if wiki
-          project = projects.select{ |row| row['id'] == wiki['project_id'] }.first
-          project_identifier = project['identifier'] + '/'
+          project = projects.select { |row| row['id'] == wiki['project_id'] }.first
+          project_identifier = "#{project['identifier']}/"
         end
 
         title = project_identifier + row_page['title']
@@ -60,11 +63,12 @@ module Caramelize
           revisions << page
         end
       end
+      # rubocop:enable Metrics/MethodLength
 
       def add_projects_as_namespaces
         projects.each do |row_project|
-          namespace = OpenStruct.new(identifier: row_project['identifier'],
-                                     name: row_project['name'])
+          namespace = { identifier: row_project['identifier'],
+                        name: row_project['name'] }
           namespaces << namespace
         end
       end
@@ -101,18 +105,17 @@ module Caramelize
         @wikis ||= database.query(wikis_query)
       end
 
-      def build_properties(title, row_content)
-        author = authors.fetch(row_content["author_id"], nil)
+      def build_properties(title, row_content) # rubocop:todo Metrics/MethodLength
+        author = authors.fetch(row_content['author_id'], nil)
         {
           id: row_content['id'],
-          title: title,
+          title:,
           body: row_content['data'],
           markup: :textile,
           latest: false,
           time: row_content['updated_on'],
           message: row_content['comments'],
-          author: author,
-          author_name: author.name
+          author:
         }
       end
     end

data/lib/caramelize/input_wiki/wiki.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Caramelize
   module InputWiki
     class Wiki
@@ -5,7 +7,7 @@ module Caramelize
 
       attr_accessor :revisions, :wiki_title, :titles, :description, :namespaces, :options
 
-      def initialize(options={})
+      def initialize(options = {})
         @options = options
         @options[:filters] = []
         @namespaces = []
@@ -15,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 { |x,y| x.time <=> y.time }
+                 .sort { |x, y| x.time <=> y.time }
       end
 
       # return an empty array in case this action was not overridden
@@ -23,7 +25,7 @@ module Caramelize
         []
       end
 
-      def namespaces
+      def namespaces # rubocop:todo Lint/DuplicateMethods
         @namespaces ||= {}
       end
 
@@ -31,14 +33,18 @@ module Caramelize
         @authors ||= {}
       end
 
-      def revisions
+      def revisions # rubocop:todo Lint/DuplicateMethods
         @revisions ||= []
       end
 
-      def titles
+      def titles # rubocop:todo Lint/DuplicateMethods
         @titles ||= []
       end
 
+      def excluded_pages
+        []
+      end
+
       def convert_markup?(to_markup)
         markup != to_markup
       end

data/lib/caramelize/input_wiki/wikkawiki.rb

@@ -1,4 +1,8 @@
+# frozen_string_literal: true
+
 require 'caramelize/database_connector'
+require 'caramelize/filters/add_newline_to_page_end'
+require 'caramelize/filters/camel_case_to_wiki_links'
 require 'caramelize/filters/wikka_to_markdown'
 
 module Caramelize
@@ -6,13 +10,16 @@ module Caramelize
     class WikkaWiki < Wiki
       include DatabaseConnector
 
-      SQL_PAGES = 'SELECT id, tag, body, time, latest, user, note FROM wikka_pages ORDER BY time;'.freeze
-      SQL_AUTHORS = 'SELECT name, email FROM wikka_users;'.freeze
+      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)
         @options[:markup] = :wikka
+        @options[:filters] << Caramelize::AddNewlineOnPageEnd
         @options[:filters] << Caramelize::Wikka2Markdown
+        @options[:filters] << Caramelize::CamelCaseToWikiLinks
       end
 
       # after calling this action, titles and @revisions are expected to be filled
@@ -23,7 +30,7 @@ module Caramelize
           revisions << page
         end
         titles.uniq!
-        #revisions.sort! { |a,b| a.time <=> b.time }
+        # revisions.sort! { |a,b| a.time <=> b.time }
 
         revisions
       end
@@ -31,11 +38,14 @@ module Caramelize
       def read_authors
         results = database.query(authors_query)
         results.each do |row|
-          authors[row['name']] = OpenStruct.new(name:  row['name'],
-                                                email: row['email'] )
+          authors[row['name']] = { name: row['name'], email: row['email'] }
         end
       end
 
+      def excluded_pages
+        FUNCTION_PAGES
+      end
+
       private
 
       def pages_query
@@ -50,18 +60,17 @@ module Caramelize
         @pages ||= database.query(pages_query)
       end
 
-      def build_properties(row)
+      def build_properties(row) # rubocop:todo Metrics/MethodLength
         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"],
-          author: author,
-          author_name: row["user"]
+          latest: row['latest'] == 'Y',
+          time: row['time'],
+          message: row['note'],
+          author:
         }
       end
     end

data/lib/caramelize/output_wiki/gollum.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
+
 require 'gollum-lib'
 
 module Caramelize
   module OutputWiki
     class Gollum
-
       attr_reader :wiki_path
 
       SUPPORTED_TARGET_MARKUP =
@@ -11,9 +12,9 @@ module Caramelize
 
       # Initialize a new gollum-wiki-repository at the given path.
       def initialize(new_wiki_path)
-        # TODO use sanitized name as wiki-repository-title
+        # TODO: use sanitized name as wiki-repository-title
         @wiki_path = new_wiki_path
-        initialize_repository
+        initialize_repository unless File.exist?(wiki_path)
       end
 
       # Commit the given page into the gollum-wiki-repository.
@@ -28,9 +29,9 @@ module Caramelize
         end
       end
 
-      def rename_page(page_title, rename)
+      def rename_page(page_title, new_title)
         gollum_page = gollum.page(page_title)
-        gollum.rename_page(gollum_page, rename, { 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.
@@ -53,8 +54,8 @@ module Caramelize
       def build_commit(page)
         {
           message: page.commit_message,
-          name: page.author.name,
-          email: page.author.email,
+          name: page.author_name,
+          email: page.author_email,
           time: page.time
         }
       end
@@ -66,13 +67,12 @@ module Caramelize
       end
 
       def gollum
-        @gollum ||= ::Gollum::Wiki.new(wiki_path, {repo_is_bare: true})
+        @gollum ||= ::Gollum::Wiki.new(wiki_path, { repo_is_bare: true, ref: 'main' })
       end
 
       def initialize_repository
-        return if File.exist?(wiki_path)
         Dir.mkdir(wiki_path)
-        #::Gollum::Git::Repo.new(wiki_path, { is_bare: true })
+        # ::Gollum::Git::Repo.new(wiki_path, { is_bare: true })
         ::Gollum::Git::Repo.init(wiki_path)
       end
     end