cleanup rubocop and add pandoc to gh test action

Author: Dahie

.github/workflows/main.yml

@@ -11,6 +11,8 @@ jobs:
     - uses: actions/checkout@v3
     # - name: Set up Redis
     #   uses: zhulik/redis-action@1.1.0
+    - name: Set up Pandoc
+      uses: siacodelabs/setup-pandoc@v1
     - name: Install Ruby and gems
       uses: ruby/setup-ruby@v1
       with:

.rubocop.yml

@@ -1,3 +1,5 @@
+inherit_from: .rubocop_todo.yml
+
 require:
   - rubocop-rake
   - rubocop-rspec

.rubocop_todo.yml

@@ -0,0 +1,55 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2024-03-03 10:06:52 UTC using RuboCop version 1.60.2.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Configuration parameters: AllowedMethods, AllowedPatterns.
+Lint/NestedMethodDefinition:
+  Exclude:
+    - 'lib/caramelize/filters/textile_to_markdown.rb'
+
+# Offense count: 2
+# Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes.
+Metrics/AbcSize:
+  Max: 79
+
+# Offense count: 1
+# Configuration parameters: CountComments, CountAsOne.
+Metrics/ClassLength:
+  Max: 118
+
+# Offense count: 1
+# Configuration parameters: AllowedMethods, AllowedPatterns.
+Metrics/CyclomaticComplexity:
+  Max: 9
+
+# Offense count: 2
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
+Metrics/MethodLength:
+  Max: 102
+
+# Offense count: 1
+# Configuration parameters: AllowedMethods, AllowedPatterns.
+Metrics/PerceivedComplexity:
+  Max: 9
+
+# Offense count: 2
+# Configuration parameters: Include, CustomTransform, IgnoreMethods, SpecSuffixOnly.
+# Include: **/*_spec*rb*, **/spec/**/*
+RSpec/FilePath:
+  Exclude:
+    - 'spec/lib/caramelize/filters/add_newline_to_page_end_spec.rb'
+    - 'spec/lib/caramelize/filters/mediawiki_to_markdown_spec.rb'
+
+# Offense count: 2
+# Configuration parameters: Include, CustomTransform, IgnoreMethods, IgnoreMetadata.
+# Include: **/*_spec.rb
+RSpec/SpecFilePathFormat:
+  Exclude:
+    - '**/spec/routing/**/*'
+    - 'spec/lib/caramelize/filters/add_newline_to_page_end_spec.rb'
+    - 'spec/lib/caramelize/filters/mediawiki_to_markdown_spec.rb'

lib/caramelize/caramel.rb

@@ -9,8 +9,7 @@
 # not supported by default in this software
 
 # Note, if you want to activate this, you need to uncomment the line below.
-# rubocop:todo Metrics/MethodLength
-def customized_wiki # rubocop:todo Metrics/AbcSize, Metrics/MethodLength
+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',
@@ -20,8 +19,7 @@ def customized_wiki # rubocop:todo Metrics/AbcSize, Metrics/MethodLength
               markup: :wikka }
   wiki = Caramelize::InputWiki::Wiki.new(options)
   wiki.instance_eval do
-    # rubocop:todo Metrics/MethodLength
-    def read_pages # rubocop:todo Metrics/AbcSize, Metrics/MethodLength
+    def read_pages
       sql = 'SELECT id, tag, body, time, latest, user, note FROM wikka_pages ORDER BY time;'
       results = database.query(sql)
       results.each do |row|
@@ -41,12 +39,10 @@ def read_pages # rubocop:todo Metrics/AbcSize, Metrics/MethodLength
       titles.uniq!
       revisions
     end
-    # rubocop:enable Metrics/MethodLength
   end
 
   wiki
 end
-# rubocop:enable Metrics/MethodLength
 
 # if you want to use one of the preset Wiki-Connectors uncomment the connector
 # and edit the database logins accordingly.

lib/caramelize/content_transferer.rb

@@ -10,7 +10,7 @@ module Caramelize
   require 'caramelize/input_wiki/redmine_wiki'
   require 'caramelize/input_wiki/wikka_wiki'
 
-  class ContentTransferer # rubocop:todo Metrics/ClassLength
+  class ContentTransferer
     attr_reader :input_wiki, :options
 
     DEFAULT_GOLLUM_HOME_TITLE = 'Home'
@@ -94,8 +94,7 @@ def commit_history_progress_bar
                            total: revisions_count)
     end
 
-    # rubocop:todo Metrics/MethodLength
-    def migrate_markup_of_latest_revisions # rubocop:todo Metrics/AbcSize, Metrics/MethodLength
+    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)
@@ -112,10 +111,8 @@ def migrate_markup_of_latest_revisions # rubocop:todo Metrics/AbcSize, Metrics/M
         migrate_markup_of_revision(revision)
       end
     end
-    # rubocop:enable Metrics/MethodLength
 
-    # rubocop:todo Metrics/MethodLength
-    def commit_history # rubocop:todo Metrics/AbcSize, Metrics/MethodLength
+    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?
@@ -129,7 +126,6 @@ def commit_history # rubocop:todo Metrics/AbcSize, Metrics/MethodLength
         end
       end
     end
-    # rubocop:enable Metrics/MethodLength
 
     def migrate_markup_of_revision(revision)
       body_new = filter_processor.run(revision.body)

lib/caramelize/health_checks/orphaned_pages_check.rb

@@ -18,7 +18,7 @@ def check
 
       private
 
-      def check_page(page) # rubocop:todo Metrics/MethodLength
+      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)

lib/caramelize/input_wiki/media_wiki.rb

@@ -85,7 +85,7 @@ def pages
         @pages ||= database.query(pages_query)
       end
 
-      def build_properties(row) # rubocop:todo Metrics/MethodLength
+      def build_properties(row)
         author = authors[row['actor_user']] || { name: 'Anonymous', email: 'anonymous@example.com' }
         {
           id: row['rev_id'],

lib/caramelize/input_wiki/redmine_wiki.rb

@@ -40,8 +40,7 @@ def read_authors
 
       private
 
-      # rubocop:todo Metrics/MethodLength
-      def build_page(row_page) # rubocop:todo Metrics/AbcSize, Metrics/MethodLength
+      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
@@ -61,7 +60,6 @@ def build_page(row_page) # rubocop:todo Metrics/AbcSize, Metrics/MethodLength
           revisions << page
         end
       end
-      # rubocop:enable Metrics/MethodLength
 
       def add_projects_as_namespaces
         projects.each do |row_project|
@@ -103,7 +101,7 @@ def wikis
         @wikis ||= database.query(wikis_query)
       end
 
-      def build_properties(title, row_content) # rubocop:todo Metrics/MethodLength
+      def build_properties(title, row_content)
         author = authors.fetch(row_content['author_id'], nil)
         {
           id: row_content['id'],

lib/caramelize/input_wiki/wikka_wiki.rb

@@ -56,7 +56,7 @@ def pages
         @pages ||= database.query(pages_query)
       end
 
-      def build_properties(row) # rubocop:todo Metrics/MethodLength
+      def build_properties(row)
         author = authors[row['user']]
         {
           id: row['id'],