caramelize 0.1.2 → 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 033fa149f2fd6a1823143125c966ea4ce7ea45b4106dec98762f4764db0b3c09
+  data.tar.gz: 80c47ef70453d79d01979f9fada6987d4f91cc4101aae488d4b5cba21841016e
+SHA512:
+  metadata.gz: aed7b973e815bc6680210aef38f3519e6d46d45c10efd095126cce67edcd6d64cbd46bfd31b03cc68abf0f60bd8be57bf948d687f874a78fc8e37cb9a4a812a1
+  data.tar.gz: f9e3d0d1c1ba24c73d7f13699f71fb9d1abfb0022c9b42a5ed94a241bd88a09aab93f43bb69ba622f8e03a0ba1d85b92b97c7be1a7545a50886ce06536891203

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/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+ - 2.6
+before_install:
+  - gem install bundler

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+ advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+ address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at public@danielsenff.de. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

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

@@ -1,33 +1,40 @@
-# caramelize
+# 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.
+[![Build Status](https://travis-ci.org/dahie/caramelize.svg?branch=master)](https://travis-ci.org/dahie/caramelize) [![Maintainability](https://api.codeclimate.com/v1/badges/7fe3ef34e09ba8133424/maintainability)](https://codeclimate.com/github/Dahie/caramelize/maintainability)
 
-In the future more target wikis may be added. For the moment migration is supported for [WikkaWiki](wikka) and [Redmine](redmine)-Wiki.
+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](http://wikkawiki.org/) and [Redmine](http://www.redmine.org/)-Wiki.
 
 ## Usage
 
 ### 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 doctor
+
+Can be used to assess the quality of your wiki conversion. It'll help you see
+how many wiki links may be broken and how many pages were orphaned.
+
     $ caramelize help
-    
+
 Returns help information.
 
 	$ caramelize version
-	
+
 Returns version and release information.
 
 ### Options
@@ -41,23 +48,22 @@ 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.
 
 ## Content migration
 
 ### 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. 
+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.
 
 * Page meta data
-  * title 
+  * title
   * content body
   * author name
   * author email address
@@ -65,7 +71,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,42 +82,42 @@ 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. 
+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"]]
-		        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
+        		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
       	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 +133,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 +145,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
@@ -150,8 +156,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/Rakefile

@@ -1,9 +1,10 @@
-require 'bundler'
-require 'rdoc/task'
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
 
-Bundler::GemHelper.install_tasks
+# Default directory to look in is `/specs`
+# Run with `rake spec`
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = ['--color', '--format', 'documentation']
+end
 
-Rake::RDocTask.new do |rd|
-  rd.main = "README.rdoc"
-  rd.rdoc_files.include( "lib/**/*.rb")
-end
+task :default => :spec

data/bin/caramelize

@@ -1,12 +1,75 @@
 #!/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
+require 'caramelize'
+require 'commander/import'
+
+# :name is optional, otherwise uses the basename of this executable
+program :name, 'caramelize'
+program :version, Caramelize::VERSION
+program :description, 'With Caramelize you can migrate any wiki to git-based Gollum wiki repositories.'
+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: #{options.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', target: 'wiki-export' })
+
+    instance_eval(File.read(options.config))
+
+    target = options.target
+
+    if File.exists?(target)
+      answer = agree("#{target} already exists. Overwrite with fresh repository?")
+      FileUtils.rm_rf(target) if answer
+    end
+
+    wiki_options = input_wiki.options.merge(verbose: options.verbose,
+                                            target: options.target)
+    Caramelize::ContentTransferer.new(input_wiki, wiki_options).execute
+    say "Time required: #{Time.now - time_start} s"
+  end
+end
+
+command :doctor do |c|
+  c.syntax = 'caramelize doctor [options]'
+  c.summary = 'Run wiki transfer'
+  c.description = 'Run health-check'
+  c.option '--target STRING', String, 'The target path to Gollum git repository (default: wiki-export)'
+  c.example 'Run transfer for "caramel.rb"', 'caramelize doctor'
+  c.action do |args, options|
+    options.default(target: 'wiki-export')
+
+    if File.exists?(options.target)
+      Caramelize::HealthCheck.new(options.target).execute
+    else
+      say("No wiki repositry found in directory #{options.target}")
+    end
+  end
+end