caramelize 1.1.1 → 1.2.0

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?
+        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)
+        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,9 +33,9 @@ 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
@@ -43,13 +45,13 @@ module Caramelize
       def build_page(row_page)
         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']
@@ -63,8 +65,8 @@ module Caramelize
 
       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
@@ -102,17 +104,16 @@ 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'],
-          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
@@ -39,6 +41,10 @@ module Caramelize
         @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_on_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 Callbacks CategoryAdmin CategoryCategory CategoryWiki DatabaseInfo FormattingRules HighScores InterWiki MyChanges MyPages OrphanedPages OwnedPages PageIndex PasswordForgotten RecentChanges RecentlyCommented Sandbox SysInfo 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
@@ -53,15 +63,14 @@ module Caramelize
       def build_properties(row)
         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

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")
+      @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.0'
 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,10 +1,13 @@
+# 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:) }
   let(:body) { 'body' }
-  subject(:processor) { described_class.new(input_wiki) }
 
   class ReverseFilter
     def initialize(body)