caramelize 0.2.0 → 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 417340a62045209170bfee46606c4adfdde8789a
+  data.tar.gz: 0bc08549a912380588062337e63942a72b921bde
+SHA512:
+  metadata.gz: 031c4e20ef8ed3bdb6f4c4afe7000e2eb7593b2e1558bb49e6c2a311b3d9f038900fe6fc4906b8e0358db530646b97d45a80797fd81727feabb16b44d925d6fe
+  data.tar.gz: 0dba2fc96623470e0823b5601a38f70701908a9b9fbd73514ec2579920456ae3af6e30d9307f3164037cdc1c4a5100ee3d3a924149b729ef81bd740998f2d7cd

data/.gitignore

@@ -1,55 +1,23 @@
-wiki.git
-
-# rcov generated
-coverage
-
-# rdoc generated
-rdoc
-
-# yard generated
-doc
-.yardoc
-
-# bundler
+*.gem
+*.rbc
 .bundle
+.config
+.yardoc
 Gemfile.lock
-*.gem
-
-# jeweler generated
-pkg/*
-
-# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore: 
-#
-# * Create a file at ~/.gitignore
-# * Include files you want ignored
-# * Run: git config --global core.excludesfile ~/.gitignore
-#
-# After doing this, these files will be ignored in all your git projects,
-# saving you from having to 'pollute' every project you touch with them
-#
-# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
-#
-# For MacOS:
-#
-.DS_Store
-
-# For TextMate
-#*.tmproj
-#tmtags
-
-# For Komodo Edit
-#*.komodoproject
-
-# For emacs:
-#*~
-#\#*
-#.\#*
-
-# For vim:
-#*.swp
-
-# For redcar:
-#.redcar
-
-# For rubinius:
-#*.rbc
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+wiki.git

data/Gemfile

@@ -1,4 +1,4 @@
-source "http://rubygems.org"
+source 'https://rubygems.org'
 
-# Specify your gem's dependencies in caramelize.gemspec
-gemspec
+# Specify your gem's dependencies in testgem.gemspec
+gemspec

data/LICENSE.md

@@ -1,4 +1,4 @@
-Copyright (c) 2011 Daniel Senff
+Copyright (c) 2015 Daniel Senff
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

data/README.md

@@ -9,25 +9,25 @@ In the future more target wikis may be added. For the moment migration is suppor
 ### Installation
 
     $ gem install caramelize
-    
+
 Install the latest release of caramelize using RubyGems.
 
 ### Use
 
-    $ caramelize create 
+    $ caramelize create
 
 Creates a template configuration file "caramel.rb". This includes documentation on how to use the preset Wiki-connectors and how to write addition customized connectors. More about this below.
 
-    $ caramelize run 
-    
+    $ caramelize run
+
 Will start the wiki migration based on the configuration file. These are either found in predefined paths (./caramel.rb, ./config.rb, …), or passed as argument, as below.
 
     $ caramelize help
-    
+
 Returns help information.
 
 	$ caramelize version
-	
+
 Returns version and release information.
 
 ### Options
@@ -42,7 +42,7 @@ Executes the given configuration.
 
     $ caramelize --verbose [command]
     $ caramelize -v [command]
-    
+
 Displays more verbose output to the command line.
 
 ## Content migration
@@ -50,14 +50,14 @@ Displays more verbose output to the command line.
 ### Wiki support
 
 Caramelize comes with direct support for [WikkaWiki](wikka) and [Redmine](redmine)-Wiki.
-More custom wikis can be supported by creating a suitable configuration file. 
+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.
 
 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.
 
 * Page meta data
-  * title 
+  * title
   * content body
   * author name
   * author email address
@@ -65,7 +65,7 @@ Since wiki software may have special features, that are not common among other w
   * revisions
 * Markup conversion to markdown
   * limited to "simple" formatting, excluding complex formats such as tables
-  * conversion using regular expressions -> somewhat easy to learn and extend  
+  * conversion using regular expressions -> somewhat easy to learn and extend
 
 ### Configuration recipes
 
@@ -76,24 +76,24 @@ 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', 
+    wiki = Caramelize::Wiki.new({:host => "localhost",
+                    :username => "user",
+                    :database => "database_name",
+                    :password => 'monkey',
                     :markup => :wikka})
 
-This example ignores custom markup conversion and assumes WikkaWiki-markup. 
+This example ignores custom markup conversion and assumes WikkaWiki-markup.
 
 Once the object is established we need to hook in a method that defines how revisions are read from the database and how they are processed.
 
     wiki.instance_eval do
     	def read_pages
       		sql = "SELECT id, tag, body, time, latest, user, note FROM wikka_pages ORDER BY time;"
-      		@revisions, @titles = [], []
+      		revisions, titles = [], []
       		results = database.query(sql)
       		results.each do |row|
-        		@titles << row["tag"]
-        		author = @authors[row["user"]]
+        		titles << row["tag"]
+        		author = authors[row["user"]]
 		        page = Page.new({:id => row["id"],
                             :title =>   row["tag"],
                             :body =>    row["body"],
@@ -103,15 +103,15 @@ Once the object is established we need to hook in a method that defines how revi
                             :message => row["note"],
                             :author =>  author,
                             :author_name => row["user"]})
-       		 @revisions << page
+       		 revisions << page
       	end
       # titles is the list of all unique page titles contained in the wiki
-      @titles.uniq!
+      titles.uniq!
       # revisions is the list of all revisions ordered by date
-      @revisions
+      revisions
     end
 
-In the end the `wiki` instance needs the `@titles` and `@revisions` filled.
+In the end the `wiki` instance needs the `titles` and `revisions` filled.
 
 Some wikis don't have all necessary metadata saved in the revision. In this case additional database queries are necessary. **The configuration recipe is pure ruby code, that is included on execution. This gives you alot of freedom in writing your configuration, but also a lot of power to break things for yourself. Be advised.**
 
@@ -127,8 +127,8 @@ Clone or fork this repository and start building.
 
     $ git clone git@github.com:Dahie/caramelize.git
     $ gem build caramelize.gemspec
-    
-Now to build and package the gem do 
+
+Now to build and package the gem do
 
     $ rake build
 
@@ -139,7 +139,7 @@ or
 to install the new gem right to your system.
 
 ## Contributing to caramelize
- 
+
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
 * Fork the project

data/Rakefile

@@ -1 +1,10 @@
-require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
+
+# Default directory to look in is `/specs`
+# Run with `rake spec`
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = ['--color', '--format', 'nested']
+end
+
+task :default => :spec

data/bin/caramelize

@@ -1,12 +1,5 @@
 #!/usr/bin/env ruby
 
-	# If we are given filenames, convert each file 
-	
 require 'caramelize/cli'
-begin
-  Caramelize::CLI::CommandParser.new.parse
-rescue
-  puts "An error has occurred:\n  " + $!.message
-  puts $!.backtrace if $DEBUG
-  exit(-1)
-end
+
+Caramelize::CLI::CommandParser.new.parse

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'
+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{By defining the connectors from the input wiki you can migrate any wiki to git-based Gollum wiki repositories.}
 
-  s.add_dependency('mysql2')
-  s.add_dependency('cmdparse')
-  s.add_dependency('ruby-progressbar')
-  s.add_dependency('gollum-lib', '>= 1.0.0') # grit dependency implicit through gollum
+  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.rubyforge_project = "caramelize"
+  spec.add_dependency('mysql2')
+  spec.add_dependency('cmdparse')
+  spec.add_dependency('docile')
+  spec.add_dependency('ruby-progressbar')
+  spec.add_dependency('gollum-lib', '>= 1.0.0') # grit dependency implicit through gollum
 
-  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_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "byebug"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-rspec"
 end

data/lib/caramelize/caramel.rb

@@ -1,4 +1,3 @@
-#Encoding: UTF-8
 require 'caramelize/wiki/wiki'
 require 'caramelize/wiki/wikkawiki'
 require 'caramelize/wiki/redmine_wiki'
@@ -9,21 +8,20 @@ require 'caramelize/wiki/redmine_wiki'
 
 # 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', 
+  wiki = Caramelize::Wiki.new({:host => "localhost",
+                    :username => "user",
+                    :database => "database_name",
+                    :password => 'admin_gnihihihi',
                     :markup => :wikka})
   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"],
@@ -34,43 +32,43 @@ def customized_wiki
                             :message => row["note"],
                             :author =>  author,
                             :author_name => row["user"]})
-        @revisions << page
+        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", 
+  #return Caramelize::WikkaWiki.new(:host => "localhost",
   #      :username => "root",
-  #      :password => "root", 
+  #      :password => "root",
   #      :database => "wikka")
-  
-  
+
+
   # 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", 
+  # :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")
 end
 
 
 def input_wiki
-  
+
   # comment and uncomment to easily switch between predefined and costumized Wiki-connectors.
   #return customized_wiki
-  
+
   return predefined_wiki
 
 end

data/lib/caramelize/cli.rb

@@ -1,16 +1,12 @@
-#Encoding: UTF-8
 require 'cmdparse'
 require 'caramelize/version'
 
 module Caramelize
-  autoload :ContentTransferer, 'caramelize/content_transferer'
+  require 'caramelize/content_transferer'
   module CLI
-    
-    # Namespace for all classes that act as CLI commands.
-    autoload :RunCommand, 'caramelize/cli/run_command'
-    autoload :CreateCommand, 'caramelize/cli/create_command'
-    
-  
+    require 'caramelize/cli/run_command'
+    require 'caramelize/cli/create_command'
+
     # This is the command parser class used for handling the webgen command line interface. After
     # creating an instance, the inherited #parse method can be used for parsing the command line
     # arguments and executing the requested command.
@@ -20,7 +16,7 @@ module Caramelize
       attr_reader :verbosity
 
       # Create a new CommandParser class. T
-      def initialize 
+      def initialize
         super(true)
         @verbosity = :normal
 
@@ -44,33 +40,44 @@ module Caramelize
         possible_files |= KNOWN_CONFIG_LOCATIONS
         possible_files.detect{|f| File.exists?(f)}
       end
-      
+
       # Utility method for sub-commands to transfer wiki contents
-      def transfer_content config_file = ""
+      def transfer_content(config_file = "")
         time_start = Time.now
-        
+
         file = detect_configuration_file config_file
-        puts "Read config file: #{file}" if @verbosity == :verbose
-        if file && File.exists?(file)
-          instance_eval(File.read(file))
-          original_wiki = input_wiki
-          
-          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 "Read config file: #{file}" if verbose?
+
+        unless file && File.exists?(file)
           puts "No config file found."
+          return false
         end
-        
+
+        commence_transfer file
+
+        puts "Time required: #{Time.now - time_start} s" if verbose?
+      end
+
+      def commence_transfer(file)
+        #load file
+        #original_wiki = Configuration.instance.input_wiki
+        instance_eval(File.read(file))
+        original_wiki = input_wiki
+
+        options = original_wiki.options
+        options[:verbosity] = @verbosity
+        ContentTransferer.execute(original_wiki, options)
+      end
+
+      def verbose?
+        @verbosity == :verbose
       end
 
       # :nodoc:
       def parse(argv = ARGV)
         Caramelize::CLI.constants.select {|c| c =~ /.+Command$/ }.each do |c|
-          self.add_command(Caramelize::CLI.const_get(c).new, (c.to_s == 'RunCommand' ? false : false)) # set runcommand as default
+          # set runcommand as default
+          self.add_command(Caramelize::CLI.const_get(c).new, (c.to_s == 'RunCommand' ? false : false))
         end
         super
       end