caramelize 0.2.0 → 0.3.0

data/lib/caramelize/cli/create_command.rb

@@ -1,5 +1,5 @@
-#Encoding: UTF-8
 require 'caramelize/cli'
+require 'fileutils'
 
 module Caramelize::CLI
 
@@ -25,28 +25,12 @@ module Caramelize::CLI
 
     # Create a caramelize config file.
     def execute(args)
-      begin
-        
-        # create dummy config file
-        target_file = @config_file.nil? ? "caramel.rb" : @config_file 
-        
-        
-        #puts args[0]
-        require 'fileutils'
-        
-        FileUtils.cp(File.dirname(__FILE__) +"/../caramel.rb", target_file)
-        
-      rescue
-        #require 'fileutils'
-        #FileUtils.rm_rf(args[0])
-        raise
-      end
+      # create dummy config file
+      target_file = @config_file.nil? ? "caramel.rb" : @config_file
+      FileUtils.cp(File.dirname(__FILE__) +"/../caramel.rb", target_file)
       if commandparser.verbosity == :normal
         puts "Created new configuration file: #{target_file}"
-        #puts paths.sort.join("\n")
       end
     end
-    
   end
-  
 end

data/lib/caramelize/content_transferer.rb

@@ -1,97 +1,155 @@
-#Encoding: UTF-8
-
 require 'gollum-lib'
 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'
-  
+
+  require 'caramelize/page'
+  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'
+
   # Controller for the content migration
   class ContentTransferer
-    
-    # Execute the content migration
-    def self.execute(original_wiki, options={})
-      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
-      
-      # see if original wiki markup is among any gollum supported markups
-      options[:markup] = output_wiki.supported_markup.index(original_wiki.markup) ? original_wiki.markup : :markdown
-
-      # 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}"
-        else
-          progress_revisions.increment
+
+    class << self
+
+      # 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?
+
+        migrate_markup_on_last_revision
+        create_overview_page_of_namespaces if options[:create_namespace_overview]
       end
 
+      private
+
+      def target_markup
+        output_wiki.supported_markup.index(original_wiki.markup) ? original_wiki.markup : :markdown
+      end
 
-      # TODO reorder interwiki links: https://github.com/gollum/gollum/wiki#bracket-tags
+      def revisions
+        @revisions ||= original_wiki.read_pages
+      end
 
-      # init list of filters to perform on the latest wiki pages
-      filters = []
+      def filters
+        @filters ||= []
+      end
 
-      original_wiki.filters.each do |filter|
-        filters << filter
+      def initialize_page_filters
+        filters << original_wiki.filters
+        filters.flatten!
       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
+      def create_overview_page_of_namespaces
+        puts 'Create Namespace Overview' if verbose?
+        output_wiki.create_namespace_overview(original_wiki.namespaces)
+      end
 
+      def migrate_markup_on_last_revision
+        if original_wiki.convert_markup? markup # is wiki in target markup
 
-      end # end convert_markup?
 
-      puts "Latest revisions:" if options[:verbosity] == :verbose
+        end # end convert_markup?
 
-      #setup progress for markup conversion
-        progress_markup = ProgressBar.create(:title => "Markup filters", :total => original_wiki.latest_revisions.count, :format => '%a %B %p%% %t')
+        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
 
-      # take each latest revision
-      for rev in original_wiki.latest_revisions
-        puts "Filter source: #{rev.title} #{rev.time}"  if options[:verbosity] == :verbose
-        progress_markup.increment
-        
-        # run filters
-        body_new = rev.body
-        filters.each do |filter|
-          body_new = filter.run body_new
+      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
 
-        unless body_new.eql? rev.body
-          rev.body = body_new
-          rev.author_name = options[:markup]
-          rev.time = Time.now
-          rev.author = nil
-          
+      end
+
+      def original_wiki
+        @original_wiki
+      end
+
+      def verbose?
+        options[:verbosity] == :verbose
+      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 options
+        @options
+      end
+
+      def output_wiki
+        @output_wiki ||= GollumOutput.new('./wiki-export') # TODO make wiki_path an option
+      end
+
+      def migrate_markup_per_revision(revision)
+        if verbose?
+          puts "Filter source: #{revision.title} #{revision.time}"
+        else
+          @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 rev, options[:markup]
+          output_wiki.commit_revision revision, options[:markup]
         end
+
       end
-      
 
-      if options[:create_namespace_home]
-        output_wiki.create_namespace_home(original_wiki.namespaces)
+      def run_filters(body)
+        body_new = body
+        filters.each do |filter|
+          body_new = filter.run body_new
+        end
+        body_new
       end
-    end # end execute
+
+      def create_progress_bar(title, total)
+        @progress_bar = ProgressBar.create(title: title, total: total, format: '%a %B %p%% %t')
+      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/filters/remove_table_tab_line_endings.rb

@@ -0,0 +1,11 @@
+module Caramelize
+  class RemoveTableTabLineEndings
+
+    # take an input stream and convert all wikka syntax to markdown syntax
+    def run body
+      migrated_body = body.dup
+      migrated_body.gsub!(/\|[\t ]*\r?[\n]/, "|\n")
+      migrated_body
+    end
+  end
+end

data/lib/caramelize/filters/swap_wiki_links.rb

@@ -1,20 +1,22 @@
-#Encoding: UTF-8
 module Caramelize
   class SwapWikiLinks
 
     # take an input stream and convert all wikka syntax to markdown syntax
     def run body
-      body = body.dup
+      migrated_body = body.dup
 
-      body.gsub!(/\[\[(\S+)\|(.+?)\]\]/, '[[\2|\1]]')
-      body.gsub!(/\[\[([\w\s-]*)\]\]/) do |s|
-      	if $1
-      		t = $1.dup
-      		s = '[[' +t + "|"+ $1.gsub(' ', '_') + "]]"
-      	end
+      migrated_body.gsub!(/\[\[(\S+)\|(.+?)\]\]/, '[[\2|\1]]')
+      migrated_body.gsub!(/\[\[([\w\s\.]*)\]\]/) do |s|
+        if $1
+          s = $1
+          t = $1.dup
+          t.gsub!(' ', '_')
+          t.gsub!(/\./, '')
+          s = "[[#{s}|#{t}]]"
+        end
       end
 
-      body
+      migrated_body
     end
   end
 end

data/lib/caramelize/filters/wikka_to_markdown.rb

@@ -1,7 +1,6 @@
-#Encoding: UTF-8
 module Caramelize
   class Wikka2Markdown
-    
+
     # take an input stream and convert all wikka syntax to markdown syntax
     def run body
       body = body.dup
@@ -9,17 +8,18 @@ module Caramelize
       body.gsub!(/(=====)(.*?)(=====)/) {|s| '## ' + $2 }   #h2
       body.gsub!(/(====)(.*?)(====)/) {|s| '### ' + $2 }   #h3
       body.gsub!(/(===)(.*?)(===)/) {|s| '#### ' + $2 }   #h4
-  
+
       body.gsub!(/(\*\*)(.*?)(\*\*)/) {|s| '**' + $2 + '**' }   #bold
       body.gsub!(/(\/\/)(.*?)(\/\/)/) {|s| '_' + $2 + '_' }   #italic
       #str.gsub!(/(===)(.*?)(===)/) {|s| '`' + $2 + '`'}   #code
       body.gsub!(/(__)(.*?)(__)/) {|s| '<u>' + $2 + '</u>'}   #underline
       body.gsub!(/(---)/, '  ')   #forced linebreak
-      
+
       #body.gsub!(/(.*?)(\n\t-)(.*?)/) {|s| $1 + $3 }   #list
-      
+
       body.gsub!(/(\t-)(.*)/, '*\2')    # unordered list
       body.gsub!(/(~-)(.*)/, '*\2')     # unordered list
+      body.gsub!(/(    -)(.*)/, '*\2')     # unordered list
       # TODO ordered lists
 
       # TODO images: ({{image)(url\=?)?(.*)(}})
@@ -29,10 +29,10 @@ module Caramelize
 
       body.gsub!(/(\[\[)(\w+)\s(.+?)(\]\])/, '[[\3|\2]]')
       #body.gsub!(/\[\[(\w+)\s(.+)\]\]/, ' [[\1 | \2]] ')
-      
-      
+
+
       # TODO more syntax conversion for links and images
-      
+
       body
     end
   end

data/lib/caramelize/gollum_output.rb

@@ -1,49 +1,35 @@
-#Encoding: UTF-8
-
+require 'caramelize/ext'
 module Caramelize
   class GollumOutput
-    
+
     def supported_markup
       [:markdown, :textile]
     end
-    
+
     # Initialize a new gollum-wiki-repository at the given path.
-    def initialize wiki_path
+    def initialize(new_wiki_path)
       # TODO use sanitized name as wiki-repository-title
-      repo = Grit::Repo.init(wiki_path) unless File.exists?(wiki_path)
-      @gollum = Gollum::Wiki.new(wiki_path)
+      @wiki_path = new_wiki_path
+      initialize_repository
     end
-    
+
+    def wiki_path
+      @wiki_path
+    end
+
     # Commit the given page into the gollum-wiki-repository.
     # Make sure the target markup is correct before calling this method.
     def commit_revision(page, markup)
-      message = page.message.empty? ? "Edit in page #{page.title}" : page.message
-        
-      if page.author
-        author = page.author
-      else
-        author = Author.new
-        author.name = page.author_name ? page.author_name : "Caramelize"
-        author.email = "mail@example.com"
-      end
-      
-      commit = {:message => message,
-               :name => author.name,
-               :email => author.email,
-               :authored_date => page.time,
-               :committed_date => page.time
-      }
-      
-      gollum_page = @gollum.page(page.title)
+      gollum_page = gollum.page(page.title)
       if gollum_page
-        @gollum.update_page(gollum_page, gollum_page.name, gollum_page.format, page.body, commit)
+        gollum.update_page(gollum_page, gollum_page.name, gollum_page.format, page.body, build_commit(page))
       else
-        @gollum.write_page(page.title, markup, page.body, commit)
+        gollum.write_page(page.title, markup, page.body, build_commit(page))
       end
     end
-    
+
     # Commit all revisions of the given history into this gollum-wiki-repository.
-    def commit_history(revisions, options={}, &block)
+    def commit_history(revisions, options = {}, &block)
       options[:markup] = :markdown if !options[:markup] # target markup
       revisions.each_with_index do |page, index|
         # call debug output from outside
@@ -52,15 +38,42 @@ module Caramelize
       end
     end
 
-    def create_namespace_home namespaces, options={}
-      options[:markup] = :markdown if options[:markup].nil? # target markup
-      body = "## Overview of namespaces" + "\n" + "\n"
+    def create_namespace_overview(namespaces)
+      body = "## Overview of namespaces\n\n"
       namespaces.each do |namespace|
-        body << "* [[#{namespace[:name]}|#{namespace[:identifier]}/Wiki]]  \n" # change wiki as configurable default home
+        # TODO change wiki as configurable default home
+        # TODO support other markup syntaxes
+        body << "* [[#{namespace[:name]}|#{namespace[:identifier]}/Wiki]]  \n"
       end
-      page = Page.new({:title => "Home", :body => body, :message => 'Create Namespace Home', :latest => true })
-      commit_revision(page, options[:markup])
+      page = Page.new(title: "Home",
+                      body: body,
+                      message: 'Create Namespace Overview',
+                      latest: true)
+      commit_revision(page, :markdown)
+      page
     end
-    
+
+
+    private
+
+    def gollum
+      @gollum ||= Gollum::Wiki.new(wiki_path)
+    end
+
+    def initialize_repository
+      # TODO ask if we should replace existing paths
+      Grit::Repo.init(wiki_path) unless File.exists?(wiki_path)
+    end
+
+    def build_commit(page)
+      message = page.message.empty? ? "Edit in page #{page.title}" : page.message
+
+      { message: message,
+        name: page.author_name,
+        email: page.author_email,
+        authored_date: page.time,
+        committed_date: page.time }
+    end
+
   end
 end