caramelize 0.1.2 → 1.1.0

data/caramelize.gemspec

@@ -1,29 +1,33 @@
-# -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "caramelize/version"
 
-Gem::Specification.new do |s|
-  s.name        = "caramelize"
-  s.version     = Caramelize::VERSION
-  s.platform    = Gem::Platform::RUBY
-  s.license      = "MIT"
-  s.authors     = ["Daniel Senff"]
-  s.email       = ["mail@danielsenff.de"]
-  s.homepage    = "http://github.com/Dahie/caramelize"
-  s.summary     = %q{Flexible and modular wiki conversion tool}
-  s.description = %q{By defining the connectors from the input wiki you can migrate any wiki to git-based Gollum wiki repositories.}
-  
-  s.bindir = 'bin'
-  
-  s.add_dependency('mysql2')
-  s.add_dependency('cmdparse')
-  s.add_dependency('ruby-progressbar')
-  s.add_dependency('gollum', '>= 1.3.0') # grit dependency implicit through gollum
+Gem::Specification.new do |spec|
+  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.}
 
-  s.rubyforge_project = "caramelize"
+  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"]
 
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ["lib"]
+  spec.add_dependency('commander')
+  spec.add_dependency('gollum-lib')
+  spec.add_dependency('mysql2')
+  spec.add_dependency('ruby-progressbar')
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  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,14 @@
+require 'caramelize/version'
+require 'caramelize/page'
+require 'caramelize/content_transferer'
+require 'caramelize/filter_processor'
+require 'caramelize/database_connector'
+require 'caramelize/health_check'
+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'
+
+Encoding.default_external = Encoding::UTF_8
+Encoding.default_internal = Encoding::UTF_8

data/lib/caramelize/caramel.rb

@@ -1,74 +1,78 @@
-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. 
+
+  # 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;"
-      @revisions, @titles = [], []
       results = database.query(sql)
       results.each do |row|
-        @titles << row["tag"]
+        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"]})
-        @revisions << page
+        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!
-      @revisions
-      
+      titles.uniq!
+      revisions
     end
   end
-  
+
   wiki
 end
 
 
-# if you want to use one of the preset Wiki-Connectors uncomment the connector 
+# 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
-  #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
-  return Caramelize::RedmineWiki.new(:host => "localhost", 
-        :username => "root", 
-        :password => "root",
-        :database => "redmine_development")
+  # 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)
 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
+  return predefined_wiki
+end

data/lib/caramelize/content_transferer.rb

@@ -1,79 +1,136 @@
-#Encoding: UTF-8
-
-require 'gollum'
-require 'grit'
 require 'ruby-progressbar'
 
 module Caramelize
-  autoload :Wiki, 'caramelize/wiki/wiki'
-  autoload :WikkaWiki, 'caramelize/wiki/wikkawiki'
-  autoload :RedmineWiki, 'caramelize/wiki/redmine_wiki'
-  autoload :GollumOutput, 'caramelize/gollum_output'
-  autoload :Author, 'caramelize/author'
-  autoload :Page, 'caramelize/page'
-  
-  # Controller for the content migration
+
+  require 'caramelize/page'
+  require 'caramelize/content_transferer'
+  require 'caramelize/database_connector'
+  require 'caramelize/output_wiki/gollum'
+  require 'caramelize/input_wiki/redmine_wiki'
+  require 'caramelize/input_wiki/wikkawiki'
+
   class ContentTransferer
-    
-    # Execute the content migration
-    def self.execute(original_wiki, options={})
-      
-      options[:markup] = :markdown            if !options[:markup]
-      options[:default_author] = "Caramelize" if !options[:default_author]
-
-      # read page revisions from wiki
-      # store page revisions
-      original_wiki.read_authors
-      @revisions = original_wiki.read_pages
-      # initiate new wiki
-      output_wiki = GollumOutput.new('wiki.git') # TODO make wiki_path an option
-      
-      # setup progressbar
-      progress_revisions = ProgressBar.create(:title => "Revisions", :total => @revisions.count, :format => '%a %B %p%% %t')
-
-      # TODO ask if we should replace existing paths
-
-      # commit page revisions to new wiki
-      output_wiki.commit_history(@revisions, options) do |page, index|
-        if options[:verbosity] == :verbose
-          puts "(#{index+1}/#{@revisions.count}) #{page.time} #{page.title}"
+    attr_reader :input_wiki, :options
+
+    DEFAULT_GOLLUM_HOME_TITLE = 'Home'.freeze
+
+    def initialize(input_wiki, options)
+      @input_wiki = input_wiki
+      @options = options
+
+      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
+
+      migrate_markup_of_latest_revisions
+
+      puts 'Create Namespace Overview' if verbose?
+      create_overview_page_of_namespaces if options[:create_namespace_overview]
+
+      rename_home_page
+    end
+
+    private
+
+    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
+
+    def revisions
+      @revisions ||= input_wiki.read_pages
+    end
+
+    def output_wiki
+      @output_wiki ||= OutputWiki::Gollum.new(options[:target])
+    end
+
+    def filter_processor
+      @filter_processor ||= FilterProcessor.new(input_wiki)
+    end
+
+    def verbose?
+      options[:verbose]
+    end
+
+    def revisions_count
+      revisions.count
+    end
+
+    def latest_revisions_count
+      input_wiki.latest_revisions.count
+    end
+
+    def create_overview_page_of_namespaces
+      output_wiki.commit_namespace_overview(input_wiki.namespaces)
+    end
+
+    def migrate_markup_progress_bar
+      @migrate_markup_progress_bar ||=
+        ProgressBar.create(title: "Markup filters",
+                           total: latest_revisions_count)
+    end
+
+    def commit_history_progress_bar
+      @commit_history_progress_bar ||=
+        ProgressBar.create(title: "Revisions",
+                           total: revisions_count)
+    end
+
+    def migrate_markup_of_latest_revisions
+      input_wiki.latest_revisions.each do |revision|
+        migrate_markup_of_revision(revision)
+      end
+    end
+
+    def commit_history
+      output_wiki.commit_history(revisions, options) do |page, index|
+        if verbose?
+          puts "(#{index + 1}/#{revisions_count}) #{page.time} #{page.title}"
         else
-          progress_revisions.increment
+          commit_history_progress_bar.increment
         end
       end
+    end
 
-      # if wiki needs to convert syntax, do so
-      puts "From markup: " + original_wiki.markup.to_s if options[:verbosity] == :verbose
-      puts "To markup: " + options[:markup].to_s if options[:verbosity] == :verbose
-      if original_wiki.convert_markup? options[:markup] # is wiki in target markup
-        
-        #setup progress for markup conversion
-        progress_markup = ProgressBar.create(:title => "Markup", :total => original_wiki.latest_revisions.count, :format => '%a %B %p%% %t')
-
-        puts "Latest revisions:" if options[:verbosity] == :verbose
-        # take each latest revision
-        for rev in original_wiki.latest_revisions
-          puts "Updated syntax: #{rev.title} #{rev.time}"  if options[:verbosity] == :verbose
-          progress_markup.increment
-          
-          # parse markup & convert to new syntax
-          if options[:markup] == :markdown
-            body_new = original_wiki.to_markdown rev.body
-          else
-            body_new = original_wiki.to_textile rev.body
-          end
-
-          unless body_new.eql? rev.body
-            rev.body = body_new
-            rev.author_name = options[:markup]
-            rev.time = Time.now
-            rev.author = nil
-            
-            # commit as latest page revision
-            output_wiki.commit_revision rev, options[:markup]
-          end
-        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}"
+
+        # commit as latest page revision
+        output_wiki.commit_revision(revision, options[:markup])
       end
-    end # end execute
+    end
+
+    def rename_home_page
+      output_wiki.rename_page(options[:home_page_title], DEFAULT_GOLLUM_HOME_TITLE)
+    end
   end
-end
+end

data/lib/caramelize/database_connector.rb

@@ -2,19 +2,16 @@ require 'mysql2'
 
 module Caramelize
   module DatabaseConnector
-  
+
     def database
-      socket = ["/tmp/mysqld.sock", 
-      "/tmp/mysql.sock", 
+      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
       @client
-      
     end
-    
   end
-  
 end

data/lib/caramelize/filter_processor.rb

@@ -0,0 +1,27 @@
+module Caramelize
+  class FilterProcessor
+    attr_reader :filters, :input_wiki
+
+    def initialize(input_wiki)
+      @filters = []
+      @input_wiki = input_wiki
+
+      initialize_wiki_filters
+    end
+
+    def run(body)
+      body_new = body
+      filters.each do |filter|
+        body_new = filter.new(body_new).run
+      end
+      body_new
+    end
+
+    private
+
+    def initialize_wiki_filters
+      filters << input_wiki.filters
+      filters.flatten!
+    end
+  end
+end