caramelize 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d6068cd942a85fdcb01d1ebbeb4ce0099ed42d39fd1bd6945979d25766aeecc
-  data.tar.gz: dfedd3d78aaa4dde06807bdd8df064f044830b5caa0e2579ada4c7e6a170ddaf
+  metadata.gz: cb93f32560a4999584cc9e883655f867ed7f02bdffc4ef9a7088a5c44e68b29b
+  data.tar.gz: a3ae3187dc3a45c831daa833e991692f7c7108c8967da53efcafb2a4330dbadc
 SHA512:
-  metadata.gz: f2c84686c76e783a8c782e5cf4fbfd27cb0e971a17dc306c04b5d35990418d8a97d1e24a20a51e83949d315b2e1915c38d21940bae9605823ed0eb9716300926
-  data.tar.gz: efc71348b1350752111fb4770997589489ced69d84e4b8714e38d31e0bd668df9ae3d917ff8c73abbaa0842b297acf09485ec1bbe30b02096c65baaa239826cc
+  metadata.gz: 0da855d0680a06673e8ad2b98734ee8fe4d04063ebd40e5b5a3b37cd1f7446fd4ea10502e349dfc1e27787b8f395b976f870595e7622e1524a2504f9676000a4
+  data.tar.gz: 886e63abc962ee8e830d12efc632bd832000ca70951081e9cfb185fabba1f40711db6574ef2df40b2c8c946f5ae61ef06f51877a66288eef9f9ef431c4237937

data/.rubocop.yml

@@ -0,0 +1,29 @@
+require:
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  NewCops: enable
+  Exclude:
+    - 'vendor/**/*'
+    - 'spec/fixtures/**/*'
+    - 'tmp/**/*'
+    - '.git/**/*'
+    - 'bin/*'
+    - '*.cmlz'
+  TargetRubyVersion: 3.1
+  SuggestExtensions: false
+
+
+Style/Documentation:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styledocumentation
+
+Metrics/BlockLength:
+  Enabled: false
+
+Layout/LineLength:
+  Enabled: false
+
+RSpec/NestedGroups:
+  Enabled: false

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in testgem.gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    caramelize (1.1.1)
+    caramelize (1.2.0)
       commander
       gollum-lib
       mysql2
@@ -13,10 +13,10 @@ GEM
     ast (2.4.2)
     byebug (11.1.3)
     coderay (1.1.3)
-    commander (4.6.0)
-      highline (~> 2.0.0)
+    commander (5.0.0)
+      highline (~> 3.0.0)
     crass (1.0.6)
-    diff-lcs (1.5.0)
+    diff-lcs (1.5.1)
     ffi (1.16.3)
     formatador (1.1.0)
     gemojione (4.3.3)
@@ -47,7 +47,7 @@ GEM
       guard (~> 2.1)
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
-    highline (2.0.3)
+    highline (3.0.1)
     json (2.7.1)
     language_server-protocol (3.17.0.3)
     listen (3.8.0)
@@ -58,20 +58,20 @@ GEM
       nokogiri (>= 1.12.0)
     lumberjack (1.2.10)
     method_source (1.0.0)
-    mime-types (3.5.1)
+    mime-types (3.5.2)
       mime-types-data (~> 3.2015)
     mime-types-data (3.2023.1205)
     mini_portile2 (2.8.5)
     mysql2 (0.5.5)
     nenv (0.3.0)
-    nokogiri (1.15.5)
+    nokogiri (1.16.0)
       mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
     notiffany (0.1.3)
       nenv (~> 0.1)
       shellany (~> 0.0)
-    parallel (1.23.0)
-    parser (3.2.2.4)
+    parallel (1.24.0)
+    parser (3.3.0.5)
       ast (~> 2.4.1)
       racc
     pry (0.14.2)
@@ -83,7 +83,7 @@ GEM
     rb-fsevent (0.11.2)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
-    regexp_parser (2.8.3)
+    regexp_parser (2.9.0)
     rexml (3.2.6)
     rouge (3.30.0)
     rspec (3.12.0)
@@ -99,11 +99,11 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.1)
-    rubocop (1.58.0)
+    rubocop (1.60.2)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.2.2.4)
+      parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
@@ -112,6 +112,16 @@ GEM
       unicode-display_width (>= 2.4.0, < 3.0)
     rubocop-ast (1.30.0)
       parser (>= 3.2.1.0)
+    rubocop-capybara (2.20.0)
+      rubocop (~> 1.41)
+    rubocop-factory_bot (2.25.1)
+      rubocop (~> 1.41)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.26.1)
+      rubocop (~> 1.40)
+      rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
     ruby-progressbar (1.13.0)
     rugged (1.7.1)
     shellany (0.0.1)
@@ -135,6 +145,8 @@ DEPENDENCIES
   rake
   rspec
   rubocop
+  rubocop-rake
+  rubocop-rspec
 
 BUNDLED WITH
-   2.4.22
+   2.5.5

data/README.md

@@ -1,6 +1,6 @@
 # Caramelize
 
-[![Build Status](https://travis-ci.org/dahie/caramelize.svg?branch=master)](https://travis-ci.org/dahie/caramelize) [![Maintainability](https://api.codeclimate.com/v1/badges/7fe3ef34e09ba8133424/maintainability)](https://codeclimate.com/github/Dahie/caramelize/maintainability)
+[![Maintainability](https://api.codeclimate.com/v1/badges/7fe3ef34e09ba8133424/maintainability)](https://codeclimate.com/github/Dahie/caramelize/maintainability)
 
 Caramelize is a compact and flexible wiki content migration tool. It is intended for easily transfering content from otherwise rare supported legacy wikis. With caramelize you can create your own export configurations and migrate your data into a git-based [gollum](https://github.com/github/gollum)-wiki retaining all your history and gaining the most flexible access to your wiki content.
 
@@ -107,8 +107,7 @@ Once the object is established we need to hook in a method that defines how revi
                             latest:  row["latest"] == "Y",
                             time:    row["time"],
                             message: row["note"],
-                            author:  author,
-                            author_name: row["user"]})
+                            author:  author})
        		 revisions << page
       	end
       # titles is the list of all unique page titles contained in the wiki

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rspec/core/rake_task'
 require 'bundler/gem_tasks'
 
@@ -7,4 +9,4 @@ RSpec::Core::RakeTask.new(:spec) do |task|
   task.rspec_opts = ['--color', '--format', 'documentation']
 end
 
-task :default => :spec
+task default: :spec

data/bin/caramelize

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'caramelize'
 require 'commander/import'
@@ -20,10 +21,10 @@ command :new do |c|
   c.option '--config STRING', String, 'The config file (default: caramel.rb)'
   c.example 'Create a fresh config file as "caramel.rb"', 'caramelize create'
   c.example 'Create a fresh config file as "config.rb"', 'caramelize create --config config.rb'
-  c.action do |args, options|
-    target_file ||= (options.config || 'caramel.rb')
+  c.action do |_args, options|
+    target_file || options.config || 'caramel.rb'
     options.default({ config: 'caramel.rb' })
-    FileUtils.cp(File.dirname(__FILE__) + '/../lib/caramelize/caramel.rb',
+    FileUtils.cp("#{File.dirname(__FILE__)}/../lib/caramelize/#{target_file}",
                  options.config)
     say "Created new configuration file: #{options.config}"
   end
@@ -37,7 +38,7 @@ command :run do |c|
   c.option '--config STRING', String, 'The config file (default: caramel.rb)'
   c.example 'Run transfer for "caramel.rb"', 'caramelize run'
   c.example 'Run transfer for "config.rb"', 'caramelize run --config config.rb'
-  c.action do |args, options|
+  c.action do |_args, options|
     time_start = Time.now
     options.default({ config: 'caramel.rb', target: 'wiki-export' })
 
@@ -63,7 +64,7 @@ command :doctor do |c|
   c.description = 'Run health-check'
   c.option '--target STRING', String, 'The target path to Gollum git repository (default: wiki-export)'
   c.example 'Run transfer for "caramel.rb"', 'caramelize doctor'
-  c.action do |args, options|
+  c.action do |_args, options|
     options.default(target: 'wiki-export')
 
     if File.exist?(options.target)

data/caramelize.gemspec

@@ -1,33 +1,37 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "caramelize/version"
+require 'caramelize/version'
 
 Gem::Specification.new do |spec|
-  spec.name        = "caramelize"
+  spec.name        = 'caramelize'
   spec.version     = Caramelize::VERSION
-  spec.license      = "MIT"
-  spec.authors     = ["Daniel Senff"]
-  spec.email       = ["mail@danielsenff.de"]
-  spec.homepage    = "http://github.com/Dahie/caramelize"
-  spec.summary     = %q{Flexible and modular wiki conversion tool}
-  spec.description = %q{With Caramelize you can migrate any wiki to git-based Gollum wiki repositories.}
+  spec.license = 'MIT'
+  spec.authors     = ['Daniel Senff']
+  spec.email       = ['mail@danielsenff.de']
+  spec.homepage    = 'http://github.com/Dahie/caramelize'
+  spec.summary     = 'Flexible and modular wiki conversion tool'
+  spec.description = 'With Caramelize you can migrate any wiki to git-based Gollum wiki repositories.'
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 3.1'
 
   spec.add_dependency('commander')
   spec.add_dependency('gollum-lib')
   spec.add_dependency('mysql2')
   spec.add_dependency('ruby-progressbar')
 
-  spec.add_development_dependency "bundler", "~> 2"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec"
-  spec.add_development_dependency "byebug"
-  spec.add_development_dependency "rubocop"
-  spec.add_development_dependency "guard"
-  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency 'bundler', '~> 2'
+  spec.add_development_dependency 'byebug'
+  spec.add_development_dependency 'guard'
+  spec.add_development_dependency 'guard-rspec'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-rake'
+  spec.add_development_dependency 'rubocop-rspec'
+  spec.metadata['rubygems_mfa_required'] = 'true'
 end

data/lib/caramelize/caramel.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'caramelize/input_wiki/wikkawiki'
 require 'caramelize/input_wiki/redmine_wiki'
 
@@ -8,31 +10,29 @@ require 'caramelize/input_wiki/redmine_wiki'
 
 # Note, if you want to activate this, you need to uncomment the line below.
 def customized_wiki
-
   # This example is a reimplementation of the WikkaWiki-Connector.
   # To connect to WikkaWiki, I suggest to use the predefined Connector below.
-  options = { host: "localhost",
-              username: "user",
-              database: "database_name",
+  options = { host: 'localhost',
+              username: 'user',
+              database: 'database_name',
               password: 'Picard-Delta-5',
-              markup: :wikka}
+              markup: :wikka }
   wiki = Caramelize::InputWiki::Wiki.new(options)
   wiki.instance_eval do
     def read_pages
-      sql = "SELECT id, tag, body, time, latest, user, note FROM wikka_pages ORDER BY time;"
+      sql = 'SELECT id, tag, body, time, latest, user, note FROM wikka_pages ORDER BY time;'
       results = database.query(sql)
       results.each do |row|
-        titles << row["tag"]
-        author = @authors[row["user"]]
-        properties = { 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"]}
+        titles << row['tag']
+        author = @authors[row['user']]
+        properties = { id: row['id'],
+                       title: row['tag'],
+                       body: row['body'],
+                       markup: 'wikka',
+                       latest: row['latest'] == 'Y',
+                       time: row['time'],
+                       message: row['note'],
+                       author: }
         page = Page.new(properties)
         revisions << page
       end
@@ -44,35 +44,31 @@ def customized_wiki
   wiki
 end
 
-
 # if you want to use one of the preset Wiki-Connectors uncomment the connector
 # and edit the database logins accordingly.
 def predefined_wiki
-
   # For connection to a WikkaWiki-Database use this Connector
-  #options = { host: "localhost",
+  # options = { host: "localhost",
   #      username: "root",
   #      password: "root",
   #      database: "wikka" }
-  #return Caramelize::InputWiki::WikkaWiki.new(options)
-
+  # return Caramelize::InputWiki::WikkaWiki.new(options)
 
   # For connection to a Redmine-Database use this Connector
   # Additional options:
   # :create_namespace_overview => true/false (Default: true)  -  Creates a new wikipage at /home as root page for Gollum wiki
-  options = { host: "localhost",
-              username: "root",
-              password: "root",
-              database: "redmine_development" }
-  return Caramelize::InputWiki::RedmineWiki.new(options)
+  options = { host: 'localhost',
+              username: 'root',
+              password: 'root',
+              database: 'redmine_development' }
+  Caramelize::InputWiki::RedmineWiki.new(options)
 end
 
-
 def input_wiki
   # comment and uncomment to easily switch between predefined and
   # costumized Wiki-connectors.
 
-  #return customized_wiki
+  # return customized_wiki
 
-  return predefined_wiki
+  predefined_wiki
 end

data/lib/caramelize/content_transferer.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
+
 require 'ruby-progressbar'
 
 module Caramelize
-
   require 'caramelize/page'
   require 'caramelize/content_transferer'
   require 'caramelize/database_connector'
@@ -12,37 +13,37 @@ module Caramelize
   class ContentTransferer
     attr_reader :input_wiki, :options
 
-    DEFAULT_GOLLUM_HOME_TITLE = 'Home'.freeze
+    DEFAULT_GOLLUM_HOME_TITLE = 'Home'
+    DEFAULT_AUTHOR_NAME = 'Caramelize'
+    DEFAULT_AUTHOR_EMAIL = 'caramelize@example.com'
 
     def initialize(input_wiki, options)
       @input_wiki = input_wiki
       @options = options
 
-      options[:default_author] = options.fetch(:default_author, "Caramelize")
+      options[:default_author] = options.fetch(:default_author, 'Caramelize')
       options[:markup] = target_markup
     end
 
     def execute
       input_wiki.read_authors
-
       commit_history
-
-      if verbose?
-        puts "From markup: #{input_wiki.markup.to_s}"
-        puts "To markup: #{target_markup.to_s}"
-        puts "Convert latest revisions:"
-      end
+      print_meta_data if verbose?
 
       migrate_markup_of_latest_revisions
 
-      puts 'Create Namespace Overview' if verbose?
       create_overview_page_of_namespaces if options[:create_namespace_overview]
 
-      rename_home_page
+      rename_home_page if options[:home_page_title]
     end
 
     private
 
+    def print_meta_data
+      puts "From markup: #{input_wiki.markup}"
+      puts "To markup: #{target_markup}"
+    end
+
     def target_markup
       @target_markup ||=
         needs_conversion_to_target_markup? ? input_wiki.markup : :markdown
@@ -77,29 +78,47 @@ module Caramelize
     end
 
     def create_overview_page_of_namespaces
+      puts 'Create Namespace Overview' if verbose?
       output_wiki.commit_namespace_overview(input_wiki.namespaces)
     end
 
     def migrate_markup_progress_bar
       @migrate_markup_progress_bar ||=
-        ProgressBar.create(title: "Markup filters",
+        ProgressBar.create(title: 'Markup filters',
                            total: latest_revisions_count)
     end
 
     def commit_history_progress_bar
       @commit_history_progress_bar ||=
-        ProgressBar.create(title: "Revisions",
+        ProgressBar.create(title: 'Revisions',
                            total: revisions_count)
     end
 
     def migrate_markup_of_latest_revisions
+      puts 'Convert latest revisions:' if verbose?
       input_wiki.latest_revisions.each do |revision|
+        if input_wiki.excluded_pages.include?(revision.title)
+          puts "Exclude Page: #{revision.title}" if verbose?
+          next
+        end
+
+        if verbose?
+          puts "Filter source: #{revision.title} #{revision.time}"
+        else
+          migrate_markup_progress_bar.increment
+        end
+
         migrate_markup_of_revision(revision)
       end
     end
 
     def commit_history
       output_wiki.commit_history(revisions, options) do |page, index|
+        if input_wiki.excluded_pages.include?(page.title)
+          puts "Exclude Page: #{page.title}" if verbose?
+          next
+        end
+
         if verbose?
           puts "(#{index + 1}/#{revisions_count}) #{page.time} #{page.title}"
         else
@@ -109,27 +128,27 @@ module Caramelize
     end
 
     def migrate_markup_of_revision(revision)
-      if verbose?
-        puts "Filter source: #{revision.title} #{revision.time}"
-      else
-        migrate_markup_progress_bar.increment
-      end
-
       body_new = filter_processor.run(revision.body)
 
-      unless body_new == revision.body
-        revision.body = body_new
-        revision.author_name = 'Caramelize'
-        revision.time = Time.now
-        revision.author = nil
-        revision.message = "Markup of '#{revision.title}' converted to #{target_markup}"
+      return if body_new == revision.body
 
-        # commit as latest page revision
-        output_wiki.commit_revision(revision, options[:markup])
-      end
+      message = "Markup of '#{revision.title}' converted to #{target_markup}"
+
+      # commit as latest page revision
+      output_wiki.commit_revision(build_revision_metadata(revision, body_new, message), options[:markup])
+    end
+
+    def build_revision_metadata(revision, body_new, message)
+      revision.body = body_new
+      revision.author = { name: DEFAULT_AUTHOR_NAME, email: DEFAULT_AUTHOR_EMAIL }
+      revision.time = Time.now
+      revision.message = message
+
+      revision
     end
 
     def rename_home_page
+      puts "Rename page #{options[:home_page_title]} to #{DEFAULT_GOLLUM_HOME_TITLE}" if verbose?
       output_wiki.rename_page(options[:home_page_title], DEFAULT_GOLLUM_HOME_TITLE)
     end
   end

data/lib/caramelize/database_connector.rb

@@ -1,16 +1,16 @@
+# frozen_string_literal: true
+
 require 'mysql2'
 
 module Caramelize
   module DatabaseConnector
-
     def database
-      socket = ["/tmp/mysqld.sock",
-      "/tmp/mysql.sock",
-      "/var/run/mysqld/mysqld.sock",
-      "/opt/local/var/run/mysql5/mysqld.sock",
-      "/var/lib/mysql/mysql.sock"].detect{|socket| File.exist?(socket)  }
-      @options[:socket] = socket
-      @client = Mysql2::Client.new(@options) unless @client
+      @options[:socket] = ['/tmp/mysqld.sock',
+                           '/tmp/mysql.sock',
+                           '/var/run/mysqld/mysqld.sock',
+                           '/opt/local/var/run/mysql5/mysqld.sock',
+                           '/var/lib/mysql/mysql.sock'].detect { |socket| File.exist?(socket) }
+      @client ||= Mysql2::Client.new(@options)
       @client
     end
   end

data/lib/caramelize/filter_processor.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Caramelize
   class FilterProcessor
     attr_reader :filters, :input_wiki

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