caramelize 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 417340a62045209170bfee46606c4adfdde8789a
-  data.tar.gz: 0bc08549a912380588062337e63942a72b921bde
+SHA256:
+  metadata.gz: f7fe435304327d466829f0dcbe0ab9ed23978da90c0c992f1464d123cffa3965
+  data.tar.gz: f89cdef42b840eff1869081e813cb37f93172fea6a5c7446ffba2685b34aae88
 SHA512:
-  metadata.gz: 031c4e20ef8ed3bdb6f4c4afe7000e2eb7593b2e1558bb49e6c2a311b3d9f038900fe6fc4906b8e0358db530646b97d45a80797fd81727feabb16b44d925d6fe
-  data.tar.gz: 0dba2fc96623470e0823b5601a38f70701908a9b9fbd73514ec2579920456ae3af6e30d9307f3164037cdc1c4a5100ee3d3a924149b729ef81bd740998f2d7cd
+  metadata.gz: 2b1c74be41c73bd7e0f35e4f9441f9bc96a5a6f04e994502b70fec73fda7444e8d7e8e4fb8868d5822d4333e4f3a37b2348f954d8d37064674ee68046e8d6c58
+  data.tar.gz: 3b7a59b339ef5779ab86be0ee4a054f0772f58483db5edee3479d736f355ad4f04bfac06e46fda39319fc431c2003885687666abc0da854b080631484f3bcd10

data/README.md

@@ -1,8 +1,8 @@
 # caramelize
 
-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](gollum)-wiki retaining all your history and gaining the most flexible access to your wiki content.
+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.
 
-In the future more target wikis may be added. For the moment migration is supported for [WikkaWiki](wikka) and [Redmine](redmine)-Wiki.
+In the future more target wikis may be added. For the moment migration is supported for [WikkaWiki](http://wikkawiki.org/) and [Redmine](http://www.redmine.org/)-Wiki.
 
 ## Usage
 
@@ -41,7 +41,6 @@ Creates an example configuration by the given name.
 Executes the given configuration.
 
     $ caramelize --verbose [command]
-    $ caramelize -v [command]
 
 Displays more verbose output to the command line.
 
@@ -49,10 +48,10 @@ Displays more verbose output to the command line.
 
 ### Wiki support
 
-Caramelize comes with direct support for [WikkaWiki](wikka) and [Redmine](redmine)-Wiki.
+Caramelize comes with direct support for [WikkaWiki](http://wikkawiki.org/) and [Redmine](http://www.redmine.org/)-Wiki.
 More custom wikis can be supported by creating a suitable configuration file.
 
-Any imported wiki exports into a [gollum](gollum) git-repository. This is a wiki based around a git-repository. This gives you the flexibility of having all wiki pages exported as physical files, while keeping the history and having an easy and wide-supported way of access by using the wiki server gollum features.
+Any imported wiki exports into a [gollum](https://github.com/github/gollum) git-repository. This is a wiki based around a git-repository. This gives you the flexibility of having all wiki pages exported as physical files, while keeping the history and having an easy and wide-supported way of access by using the wiki server gollum features.
 
 Since wiki software may have special features, that are not common among other wikis, content migration may always have a loss of style or information. Caramelize tries to support the most common features.
 
@@ -76,11 +75,11 @@ Custom import allows you to import data from wikis that are not natively support
 
 For a custom wiki you need to create a `wiki` instance object, that receives the necessary database creditials.
 
-    wiki = Caramelize::Wiki.new({:host => "localhost",
-                    :username => "user",
-                    :database => "database_name",
-                    :password => 'monkey',
-                    :markup => :wikka})
+    wiki = Caramelize::InputWiki::Wiki.new(host: "localhost",
+                                          username: "user",
+                                          database: "database_name",
+                                          password: 'monkey',
+                                          markup: :wikka})
 
 This example ignores custom markup conversion and assumes WikkaWiki-markup.
 
@@ -94,15 +93,15 @@ Once the object is established we need to hook in a method that defines how revi
       		results.each do |row|
         		titles << row["tag"]
         		author = authors[row["user"]]
-		        page = Page.new({: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"]})
+		        page = Page.new({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"]})
        		 revisions << page
       	end
       # titles is the list of all unique page titles contained in the wiki
@@ -150,8 +149,4 @@ to install the new gem right to your system.
 
 ## Copyright
 
-Copyright (c) 2011-2013 Daniel Senff. See LICENSE.md for further details.
-
-[wikka]: http://wikkawiki.org/
-[gollum]: https://github.com/github/gollum
-[redmine]: http://www.redmine.org/
+Copyright (c) 2011-2015 Daniel Senff. See LICENSE.md for further details.

data/bin/caramelize

@@ -1,5 +1,51 @@
 #!/usr/bin/env ruby
 
-require 'caramelize/cli'
+require 'caramelize'
+require 'commander/import'
 
-Caramelize::CLI::CommandParser.new.parse
+# :name is optional, otherwise uses the basename of this executable
+program :name, 'caramelize'
+program :version, Caramelize::VERSION
+program :description, 'TODO'
+program :help, 'Author', 'Daniel Senff <public@danielsenff.de>'
+
+default_command :run
+
+global_option '--verbose'
+
+command :new do |c|
+  c.syntax = 'caramelize create [options]'
+  c.summary = 'Create new configuration'
+  c.description = 'Create a fresh configuration file for caramelize'
+  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')
+    options.default({ config: 'caramel.rb' })
+    FileUtils.cp(File.dirname(__FILE__) + '/../lib/caramelize/caramel.rb',
+                 options.config)
+    say "Created new configuration file: #{optinos.config}"
+  end
+end
+alias_command :create, :new
+
+command :run do |c|
+  c.syntax = 'caramelize run [options]'
+  c.summary = 'Run wiki transfer'
+  c.description = 'Run the wiki content transfer based on the given configuration file'
+  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|
+    time_start = Time.now
+    options.default({ config: 'caramel.rb' })
+    puts options.inspect
+
+    instance_eval(File.read(options.config))
+
+    wiki_options = input_wiki.options.merge(verbose: options.verbose)
+    Caramelize::ContentTransferer.new(input_wiki, wiki_options).execute
+    say "Time required: #{Time.now - time_start} s"
+  end
+end

data/caramelize.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency('mysql2')
-  spec.add_dependency('cmdparse')
+  spec.add_dependency('commander')
   spec.add_dependency('docile')
   spec.add_dependency('ruby-progressbar')
   spec.add_dependency('gollum-lib', '>= 1.0.0') # grit dependency implicit through gollum
@@ -28,6 +28,7 @@ Gem::Specification.new do |spec|
   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"
 end

data/lib/caramelize.rb

@@ -0,0 +1,12 @@
+require 'caramelize/version'
+require 'caramelize/page'
+require 'caramelize/ext'
+require 'caramelize/content_transferer'
+require 'caramelize/filter_processor'
+require 'caramelize/database_connector'
+require 'caramelize/output_wiki/gollum'
+require 'caramelize/services/page_builder'
+require 'caramelize/input_wiki/wiki'
+require 'caramelize/input_wiki/redmine_wiki'
+require 'caramelize/input_wiki/wikkawiki'
+

data/lib/caramelize/caramel.rb

@@ -1,21 +1,22 @@
-require 'caramelize/wiki/wiki'
-require 'caramelize/wiki/wikkawiki'
-require 'caramelize/wiki/redmine_wiki'
+require 'caramelize/input_wiki/wikkawiki'
+require 'caramelize/input_wiki/redmine_wiki'
 
 ## Example caramelize configuration file
 
-# Within this method you can define your own Wiki-Connectors to Wikis not supported by default in this software
+# Within this method you can define your own Wiki-Connectors to Wikis
+# not supported by default in this software
 
 # 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.
-  wiki = Caramelize::Wiki.new({:host => "localhost",
-                    :username => "user",
-                    :database => "database_name",
-                    :password => 'admin_gnihihihi',
-                    :markup => :wikka})
+  options = { host: "localhost",
+              username: "user",
+              database: "database_name",
+              password: 'Picard-Delta-5',
+              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;"
@@ -23,15 +24,16 @@ def customized_wiki
       results.each do |row|
         titles << row["tag"]
         author = @authors[row["user"]]
-        page = Page.new({: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"]})
+        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"]}
+        page = Page.new(properties)
         revisions << page
       end
       titles.uniq!
@@ -48,27 +50,29 @@ end
 def predefined_wiki
 
   # For connection to a WikkaWiki-Database use this Connector
-  #return Caramelize::WikkaWiki.new(:host => "localhost",
-  #      :username => "root",
-  #      :password => "root",
-  #      :database => "wikka")
+  #options = { host: "localhost",
+  #      username: "root",
+  #      password: "root",
+  #      database: "wikka" }
+  #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
-  return Caramelize::RedmineWiki.new(:host => "localhost",
-        :username => "root",
-        :password => "root",
-        :database => "redmine_development")
+  options = { host: "localhost",
+              username: "root",
+              password: "root",
+              database: "redmine_development" }
+  return Caramelize::InputWiki::RedmineWiki.new(options)
 end
 
 
 def input_wiki
+  # comment and uncomment to easily switch between predefined and
+  # costumized Wiki-connectors.
 
-  # comment and uncomment to easily switch between predefined and costumized Wiki-connectors.
   #return customized_wiki
 
   return predefined_wiki
-
-end
+end

data/lib/caramelize/content_transferer.rb

@@ -8,148 +8,115 @@ module Caramelize
   require 'caramelize/ext'
   require 'caramelize/content_transferer'
   require 'caramelize/database_connector'
-  require 'caramelize/gollum_output'
-  require 'caramelize/wiki/redmine_wiki'
-  require 'caramelize/wiki/wikkawiki'
-  require 'caramelize/wiki/wiki'
+  require 'caramelize/output_wiki/gollum'
+  require 'caramelize/input_wiki/redmine_wiki'
+  require 'caramelize/input_wiki/wikkawiki'
 
-  # Controller for the content migration
   class ContentTransferer
+    attr_reader :input_wiki, :options, :filter_processor
 
-    class << self
+    def initialize(input_wiki, options)
+      @input_wiki = input_wiki
+      @options = options
 
-      # Execute the content migration
-      def execute(original_wiki, options={})
-        @options = options
-        @original_wiki = original_wiki
-
-        options[:default_author] = "Caramelize" unless options[:default_author]
-        # see if original wiki markup is among any gollum supported markups
-        options[:markup] = target_markup
-
-        original_wiki.read_authors
-        initialize_page_filters
-        commit_history
-
-        # if wiki needs to convert syntax, do so
-        if verbose?
-          puts "From markup: #{original_wiki.markup.to_s}"
-          puts "To markup: #{markup.to_s}"
-        end
-
-        puts "Latest revisions:" if verbose?
+      options[:default_author] = options.fetch(:default_author, "Caramelize")
+      options[:target_directory] = './wiki-export'
+      options[:markup] = target_markup
+    end
 
-        migrate_markup_on_last_revision
-        create_overview_page_of_namespaces if options[:create_namespace_overview]
-      end
+    def execute
+      input_wiki.read_authors
 
-      private
+      commit_history
 
-      def target_markup
-        output_wiki.supported_markup.index(original_wiki.markup) ? original_wiki.markup : :markdown
+      if verbose?
+        puts "From markup: #{input_wiki.markup.to_s}"
+        puts "To markup: #{target_markup.to_s}"
+        puts "Convert latest revisions:"
       end
 
-      def revisions
-        @revisions ||= original_wiki.read_pages
-      end
-
-      def filters
-        @filters ||= []
-      end
+      migrate_markup_of_latest_revisions
 
-      def initialize_page_filters
-        filters << original_wiki.filters
-        filters.flatten!
-      end
+      puts 'Create Namespace Overview' if verbose?
+      create_overview_page_of_namespaces if options[:create_namespace_overview]
+    end
 
-      def create_overview_page_of_namespaces
-        puts 'Create Namespace Overview' if verbose?
-        output_wiki.create_namespace_overview(original_wiki.namespaces)
-      end
+    private
 
-      def migrate_markup_on_last_revision
-        if original_wiki.convert_markup? markup # is wiki in target markup
+    def target_markup
+      @target_markup ||=
+        needs_conversion_to_target_markup? ? input_wiki.markup : :markdown
+    end
 
+    def needs_conversion_to_target_markup?
+      output_wiki.supported_markup.index(input_wiki.markup)
+    end
 
-        end # end convert_markup?
+    def revisions
+      @revisions ||= input_wiki.read_pages
+    end
 
-        create_progress_bar("Markup filters", original_wiki.latest_revisions.count) unless verbose?
-        original_wiki.latest_revisions.each do |revision|
-          migrate_markup_per_revision(revision)
-        end
-      end
+    def output_wiki
+      @output_wiki ||= OutputWiki::Gollum.new(options[:target_directory])
+    end
 
-      def commit_history
-        # setup progressbar
-        create_progress_bar("Revisions", revisions.count) unless verbose?
-        output_wiki.commit_history(revisions, options) do |page, index|
-          if verbose?
-            puts "(#{index+1}/#{revisions.count}) #{page.time} #{page.title}"
-          else
-            @progress_bar.increment
-          end
-        end
+    def filter_processor
+      @filter_processor ||= FilterProcessor.new(input_wiki)
+    end
 
-      end
+    def verbose?
+      options[:verbose]
+    end
 
-      def original_wiki
-        @original_wiki
-      end
+    def revisions_count
+      revisions.count
+    end
 
-      def verbose?
-        options[:verbosity] == :verbose
-      end
+    def create_overview_page_of_namespaces
+      output_wiki.commit_namespace_overview(input_wiki.namespaces)
+    end
 
-      def markup
-        unless @markup
-          # see if original wiki markup is among any gollum supported markups
-          @markup = output_wiki.supported_markup.index(original_wiki.markup) ? original_wiki.markup : :markdown
-        end
-        @markup
-      end
+    def migrate_markup_of_latest_revisions
+      progress_bar = ProgressBar.create(title: "Markup filters",
+                                        total: revisions_count)
 
-      def options
-        @options
+      input_wiki.latest_revisions.each do |revision|
+        migrate_markup_of_revision(revision, progress_bar)
       end
+    end
 
-      def output_wiki
-        @output_wiki ||= GollumOutput.new('./wiki-export') # TODO make wiki_path an option
-      end
+    def commit_history
+      puts revisions_count
+      progress_bar = ProgressBar.create(title: "Revisions",
+                                        total: revisions_count)
 
-      def migrate_markup_per_revision(revision)
+      output_wiki.commit_history(revisions, options) do |page, index|
         if verbose?
-          puts "Filter source: #{revision.title} #{revision.time}"
+          puts "(#{index + 1}/#{revisions_count}) #{page.time} #{page.title}"
         else
-          @progress_bar.increment
+          progress_bar.increment
         end
-
-        # run filters
-        body_new = run_filters(revision.body)
-
-        unless body_new == revision.body
-          revision.body = body_new
-          revision.author_name = markup
-          revision.time = Time.now
-          revision.author = nil
-
-          # commit as latest page revision
-          output_wiki.commit_revision revision, options[:markup]
-        end
-
       end
+    end
 
-      def run_filters(body)
-        body_new = body
-        filters.each do |filter|
-          body_new = filter.run body_new
-        end
-        body_new
+    def migrate_markup_of_revision(revision, progress_bar)
+      if verbose?
+        puts "Filter source: #{revision.title} #{revision.time}"
+      else
+        progress_bar.increment
       end
 
-      def create_progress_bar(title, total)
-        @progress_bar = ProgressBar.create(title: title, total: total, format: '%a %B %p%% %t')
+      body_new = filter_processor.run(revision.body)
+
+      unless body_new == revision.body
+        revision.body = body_new
+        revision.author_name = target_markup
+        revision.time = Time.now
+        revision.author = nil
+
+        # commit as latest page revision
+        output_wiki.commit_revision(revision, options[:markup])
       end
     end
-
   end
-end
+end