caramelize 0.1.2 → 0.2.0

data/Rakefile

@@ -1,9 +1 @@
-require 'bundler'
-require 'rdoc/task'
-
-Bundler::GemHelper.install_tasks
-
-Rake::RDocTask.new do |rd|
-  rd.main = "README.rdoc"
-  rd.rdoc_files.include( "lib/**/*.rb")
-end
+require "bundler/gem_tasks"

data/caramelize.gemspec

@@ -14,11 +14,11 @@ Gem::Specification.new do |s|
   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
+  s.add_dependency('gollum-lib', '>= 1.0.0') # grit dependency implicit through gollum
 
   s.rubyforge_project = "caramelize"
 

data/lib/caramelize/caramel.rb

@@ -1,3 +1,4 @@
+#Encoding: UTF-8
 require 'caramelize/wiki/wiki'
 require 'caramelize/wiki/wikkawiki'
 require 'caramelize/wiki/redmine_wiki'
@@ -37,7 +38,6 @@ def customized_wiki
       end
       @titles.uniq!
       @revisions
-      
     end
   end
   
@@ -57,6 +57,8 @@ def predefined_wiki
   
   
   # For connection to a Redmine-Database use this Connector
+  # Additional options:
+  # :create_namespace_home => 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",

data/lib/caramelize/cli.rb

@@ -39,8 +39,9 @@ module Caramelize
 
       # Finds the configuration file, if it exists in a known location.
       def detect_configuration_file(config_path = nil)
-        possible_files = KNOWN_CONFIG_LOCATIONS
+        possible_files = []
         possible_files << config_path if config_path
+        possible_files |= KNOWN_CONFIG_LOCATIONS
         possible_files.detect{|f| File.exists?(f)}
       end
       
@@ -51,13 +52,14 @@ module Caramelize
         file = detect_configuration_file config_file
         puts "Read config file: #{file}" if @verbosity == :verbose
         if file && File.exists?(file)
-          instance_eval(File.read(file), file || '<eval>')
+          instance_eval(File.read(file))
           original_wiki = input_wiki
           
-          ContentTransferer.execute(original_wiki, {:verbosity => @verbosity})
+          options = original_wiki.options
+          options[:verbosity] = @verbosity
+          ContentTransferer.execute(original_wiki, options)
           
           time_end = Time.now
-          
           puts "Time required: #{time_end - time_start} s" if @verbosity == :verbose
         else
           puts "No config file found."

data/lib/caramelize/content_transferer.rb

@@ -1,6 +1,6 @@
 #Encoding: UTF-8
 
-require 'gollum'
+require 'gollum-lib'
 require 'grit'
 require 'ruby-progressbar'
 
@@ -17,8 +17,6 @@ module Caramelize
     
     # 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
@@ -28,6 +26,9 @@ module Caramelize
       # 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')
 
@@ -42,38 +43,55 @@ module Caramelize
         end
       end
 
+
+      # TODO reorder interwiki links: https://github.com/gollum/gollum/wiki#bracket-tags
+
+      # init list of filters to perform on the latest wiki pages
+      filters = []
+
+      original_wiki.filters.each do |filter|
+        filters << filter
+      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
+
+
+      end # end convert_markup?
+
+      puts "Latest revisions:" if options[:verbosity] == :verbose
+
+      #setup progress for markup conversion
+        progress_markup = ProgressBar.create(:title => "Markup filters", :total => original_wiki.latest_revisions.count, :format => '%a %B %p%% %t')
+
+      # 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
         
-        #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
+        # run filters
+        body_new = rev.body
+        filters.each do |filter|
+          body_new = filter.run body_new
+        end
+
+        unless body_new.eql? rev.body
+          rev.body = body_new
+          rev.author_name = options[:markup]
+          rev.time = Time.now
+          rev.author = nil
           
-          # 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
+          # commit as latest page revision
+          output_wiki.commit_revision rev, options[:markup]
         end
       end
+      
+
+      if options[:create_namespace_home]
+        output_wiki.create_namespace_home(original_wiki.namespaces)
+      end
     end # end execute
   end
 end

data/lib/caramelize/ext.rb

@@ -1,4 +1,4 @@
-require 'gollum'
+require 'gollum-lib'
 
 module Gollum
   class Committer

data/lib/caramelize/filters/swap_wiki_links.rb

@@ -0,0 +1,20 @@
+#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
+
+      body.gsub!(/\[\[(\S+)\|(.+?)\]\]/, '[[\2|\1]]')
+      body.gsub!(/\[\[([\w\s-]*)\]\]/) do |s|
+      	if $1
+      		t = $1.dup
+      		s = '[[' +t + "|"+ $1.gsub(' ', '_') + "]]"
+      	end
+      end
+
+      body
+    end
+  end
+end

data/lib/caramelize/filters/trac_to_markdown.rb

@@ -0,0 +1,42 @@
+#Encoding: UTF-8
+module Caramelize
+  class Trac2Markdown
+
+    def run body
+      body = body.dup
+      body.gsub!(/\r/, '')
+      body.gsub!(/\{\{\{([^\n]+?)\}\}\}/, '@\1@')
+      body.gsub!(/\{\{\{\n#!([^\n]+?)(.+?)\}\}\}/m, '<pre><code class="\1">\2</code></pre>')
+      body.gsub!(/\{\{\{(.+?)\}\}\}/m, '<pre>\1</pre>')
+      # macro
+      body.gsub!(/\[\[BR\]\]/, '')
+      body.gsub!(/\[\[PageOutline.*\]\]/, '{{toc}}')
+      body.gsub!(/\[\[Image\((.+?)\)\]\]/, '!\1!')
+      # header
+      body.gsub!(/=====\s(.+?)\s=====/, "== #{'\1'} ==\n\n")
+      body.gsub!(/====\s(.+?)\s====/,   "=== #{'\1'} ===\n\n")
+      body.gsub!(/===\s(.+?)\s===/,     "==== #{'\1'} ====\n\n")
+      body.gsub!(/==\s(.+?)\s==/,       "===== #{'\1'} =====\n\n")
+      body.gsub!(/=\s(.+?)\s=[\s\n]*/,  "====== #{'\1'} ======\n\n")
+      # table
+      body.gsub!(/\|\|/,  "|")
+      # link
+      body.gsub!(/\[(http[^\s\[\]]+)\s([^\[\]]+)\]/, ' "\2":\1' )
+      body.gsub!(/\[([^\s]+)\s(.+)\]/, ' [[\1 | \2]] ')
+      body.gsub!(/([^"\/\!])(([A-Z][a-z0-9]+){2,})/, ' \1[[\2]] ')
+      body.gsub!(/\!(([A-Z][a-z0-9]+){2,})/, '\1')
+      # text decoration
+      body.gsub!(/'''(.+)'''/, '*\1*')
+      body.gsub!(/''(.+)''/, '_\1_')
+      body.gsub!(/`(.+)`/, '@\1@')
+      # itemize
+      body.gsub!(/^\s\s\s\*/, '***')
+      body.gsub!(/^\s\s\*/, '**')
+      body.gsub!(/^\s\*/, '*')
+      body.gsub!(/^\s\s\s\d\./, '###')
+      body.gsub!(/^\s\s\d\./, '##')
+      body.gsub!(/^\s\d\./, '#')
+      body
+    end
+  end
+end

data/lib/caramelize/{wiki/wikka_converter.rb → filters/wikka_to_markdown.rb}

@@ -1,8 +1,9 @@
+#Encoding: UTF-8
 module Caramelize
-  module WikkaConverter
+  class Wikka2Markdown
     
     # take an input stream and convert all wikka syntax to markdown syntax
-    def to_markdown body
+    def run body
       body = body.dup
       body.gsub!(/(======)(.*?)(======)/ ) {|s| '# ' + $2 } #h1
       body.gsub!(/(=====)(.*?)(=====)/) {|s| '## ' + $2 }   #h2

data/lib/caramelize/gollum_output.rb

@@ -3,7 +3,7 @@
 module Caramelize
   class GollumOutput
     
-    def supported_markup 
+    def supported_markup
       [:markdown, :textile]
     end
     
@@ -16,14 +16,14 @@ module Caramelize
     
     # 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) 
+    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
+        author.name = page.author_name ? page.author_name : "Caramelize"
         author.email = "mail@example.com"
       end
       
@@ -44,13 +44,23 @@ module Caramelize
     
     # Commit all revisions of the given history into this gollum-wiki-repository.
     def commit_history(revisions, options={}, &block)
-      options[:markup] = :markdown if options[:markup].nil? # target markup
+      options[:markup] = :markdown if !options[:markup] # target markup
       revisions.each_with_index do |page, index|
         # call debug output from outside
         block.call(page, index) if block_given?
         commit_revision(page, options[:markup])
       end
     end
+
+    def create_namespace_home namespaces, options={}
+      options[:markup] = :markdown if options[:markup].nil? # target markup
+      body = "## Overview of namespaces" + "\n" + "\n"
+      namespaces.each do |namespace|
+        body << "* [[#{namespace[:name]}|#{namespace[:identifier]}/Wiki]]  \n" # change wiki as configurable default home
+      end
+      page = Page.new({:title => "Home", :body => body, :message => 'Create Namespace Home', :latest => true })
+      commit_revision(page, options[:markup])
+    end
     
   end
 end

data/lib/caramelize/page.rb

@@ -5,12 +5,12 @@ module Caramelize
   
     def initialize page={}
       @id =      page[:id]
-      @title =   page[:title]
-      @body =    page[:body]
+      @title =   page[:title] ? page[:title] : ""
+      @body =    page[:body] ? page[:body] : ""
       @syntax =  page[:markup]
-      @latest =  page[:latest]
-      @time =    page[:time]
-      @message = page[:message]
+      @latest =  page[:latest] ? page[:latest] : false
+      @time =    page[:time] ? page[:time] : Time.now
+      @message = page[:message] ? page[:message] : ""
       @author =  page[:author]
       @author_name =  page[:author_name]
     end

data/lib/caramelize/version.rb

@@ -1,3 +1,3 @@
 module Caramelize
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

data/lib/caramelize/wiki/redmine_wiki.rb

@@ -1,21 +1,57 @@
 #Encoding: UTF-8
 module Caramelize
   autoload :DatabaseConnector, 'caramelize/database_connector'
+  autoload :SwapWikiLinks, 'caramelize/filters/swap_wiki_links'
   
   class RedmineWiki < Wiki
     include DatabaseConnector
     
+    def initialize options={}
+      super(options)
+      @options[:markup] = :textile
+      @options[:create_namespace_home] = true unless @options[:create_namespace_home]
+      @options[:swap_interwiki_links] = true
+      @options[:filters] << Caramelize::SwapWikiLinks.new
+    end
     
     # after calling this action, I expect the @titles and @revisions to be filled
     def read_pages
-      sql = "SELECT id, title FROM wiki_pages;"
       @revisions = []
       @titles = []
       @latest_revisions = {}
-      results_pages = database.query(sql)
+
+      # get all projects
+      results_projects = database.query("SELECT id, identifier, name FROM projects;")
+      results_projects.each do |row_project|
+        #collect all namespaces
+        @namespaces << {:identifier => row_project["identifier"], :name => row_project["name"]}
+      end
+
+      # get all wikis
+      results_wikis = database.query("SELECT id, project_id FROM wikis;")
+
+      # get all lemmas
+      results_pages = database.query("SELECT id, title, wiki_id FROM wiki_pages;")
       results_pages.each do |row_page|
         results_contents = database.query("SELECT * FROM wiki_content_versions WHERE page_id='#{row_page["id"]}' ORDER BY updated_on;")
-        title = row_page["title"]
+
+        # get wiki for page
+        wiki_row = nil
+        project_row = nil
+        results_wikis.each do |wiki|
+          wiki_row = wiki if wiki["id"] == row_page["wiki_id"]
+        end
+
+        if wiki_row
+          # get project from wiki-id
+          results_projects.each do |project|
+            project_row = project if project["id"] == wiki_row["project_id"]
+          end
+        end
+
+        project_identifier = project_row ? project_row["identifier"] + '/' : ""
+
+        title = project_identifier + row_page["title"]
         @titles << title
         
         results_contents.each do |row_content|
@@ -36,8 +72,7 @@ module Caramelize
       @titles.uniq!
       @latest_revisions.each { |rev| rev[1].set_latest }
       @revisions.sort! { |a,b| a.time <=> b.time }
-      
-      
+
       # TODO find latest revision for each limit
       
       @revisions
@@ -56,5 +91,5 @@ module Caramelize
       end
       @authors
     end
-  end    
+  end
 end

data/lib/caramelize/wiki/wiki.rb

@@ -1,11 +1,14 @@
+#Encoding: UTF-8
 module Caramelize
   autoload :DatabaseConnector, 'caramelize/database_connector'
   class Wiki
     include DatabaseConnector
-    attr_accessor :revisions, :wiki_title, :titles, :description
+    attr_accessor :revisions, :wiki_title, :titles, :description, :namespaces, :options
     
     def initialize options={}
       @options = options
+      @options[:filters] = []
+      @namespaces = []
     end
     
     def revisions_by_title title
@@ -20,10 +23,15 @@ module Caramelize
     def read_authors
       return []
     end
+
     
     def convert_markup? to_markup
       markup != to_markup
     end
+
+    def filters
+      @options[:filters]
+    end
     
     def latest_revisions
       @latest_revisions = []
@@ -37,5 +45,6 @@ module Caramelize
     def markup
       @options[:markup]
     end
+
   end
 end

data/lib/caramelize/wiki/wikkawiki.rb

@@ -1,15 +1,16 @@
 #Encoding: UTF-8
 module Caramelize
   autoload :DatabaseConnector, 'caramelize/database_connector'
-  autoload :WikkaConverter, 'caramelize/wiki/wikka_converter'
+  autoload :Wikka2Markdown, 'caramelize/filters/wikka_to_markdown'
   
   class WikkaWiki < Wiki
     include DatabaseConnector
-    include WikkaConverter
     
     def initialize options={}
       super(options)
-      options[:markup] = :wikka
+      @options[:markup] = :wikka
+      @options[:swap_interwiki_links] = false
+      @options[:filters] << Caramelize::Wikka2Markdown.new
     end
 
     # after calling this action, I expect the @titles and @revisions to be filled

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: caramelize
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-13 00:00:00.000000000 Z
+date: 2013-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mysql2
@@ -60,13 +60,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: gollum
+  name: gollum-lib
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -74,7 +74,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: 1.0.0
 description: By defining the connectors from the input wiki you can migrate any wiki
   to git-based Gollum wiki repositories.
 email:
@@ -100,13 +100,15 @@ files:
 - lib/caramelize/content_transferer.rb
 - lib/caramelize/database_connector.rb
 - lib/caramelize/ext.rb
+- lib/caramelize/filters/swap_wiki_links.rb
+- lib/caramelize/filters/trac_to_markdown.rb
+- lib/caramelize/filters/wikka_to_markdown.rb
 - lib/caramelize/gollum_output.rb
 - lib/caramelize/page.rb
 - lib/caramelize/version.rb
 - lib/caramelize/wiki/redmine_wiki.rb
 - lib/caramelize/wiki/trac_converter.rb
 - lib/caramelize/wiki/wiki.rb
-- lib/caramelize/wiki/wikka_converter.rb
 - lib/caramelize/wiki/wikkawiki.rb
 - test/helper.rb
 - test/test_caramelize.rb