gollum-export 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in gollum-export.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Alfonso Cora
+
+MIT License
+
+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:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,38 @@
+#Gollum Export
+
+##Overview
+
+This gem includes the `gollum-export` command that allows converting local markdown files to html. It also includes a switch to download and convert a full wiki from a github repo.
+
+##Installation
+
+```bash
+  $ gem install gollum-export
+```
+
+##Usage
+
+Local conversion:
+
+```bash
+  gollum-export file1.md file2.md ...
+```
+
+Download and convert a github wiki:
+
+```bash
+  gollum-export plataformatec/devise
+```
+
+##License
+
+(The MIT License)
+
+Copyright (c) 2012 Alfonso Cora
+
+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:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/gollum-export

@@ -0,0 +1,48 @@
+#!/usr/bin/env ruby
+
+require 'html/pipeline'
+require 'gollum-export'
+
+# get the output directory parameter
+output_directory = nil
+if o_index = ARGV.index('-o')
+  output_directory = ARGV[o_index + 1]
+end
+
+# detect mode
+if ARGV.length == 0
+  # help mode
+  puts 'Usage:'
+  puts '  gollum-export plataformatec/devise'
+  puts '  gollum-export file1.md file2.md ...'
+elsif ARGV.any? {|f| f =~ /\.md$/}
+  # file mode
+  ARGV.each do |file|
+    next unless file =~ /\.md$/
+    puts "Converting #{file}..."
+    Gollum::Export::Processor.convert_file(file, :output_directory => output_directory)
+  end
+else
+  # github mode
+  repository = ARGV[0]
+  wiki_repository = "#{repository}.wiki"
+  directory = wiki_repository.split('/')[1]
+  output_directory ||= "#{directory}_html"
+
+  unless Dir.exists?(directory)
+    clone_command = "git clone git://github.com/#{wiki_repository}.git"
+    puts "> #{clone_command}"
+    fail unless system(clone_command)
+  end
+
+  unless Dir.exists?(output_directory)
+    mkdir_command = "mkdir #{output_directory}"
+    puts "> #{mkdir_command}"
+    fail unless system(mkdir_command)
+  end
+
+  Dir.glob("#{directory}/**/*.md").each do |file|
+    puts "Converting #{file}..."
+    Gollum::Export::Processor.convert_file(file, :output_directory => output_directory, :repository => repository)
+  end
+end

data/gollum-export.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gollum/export/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "gollum-export"
+  gem.version       = Gollum::Export::VERSION
+  gem.authors       = ["Alfonso Cora"]
+  gem.email         = ["acora6@gmail.com"]
+  gem.description   = %q{This gem includes the `gollum-export` command that allows converting local markdown files to html. It also includes a switch to download and convert a full wiki from a github repo.}
+  gem.summary       = %q{Downloads Gollum wikis and converts them to HTML}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_runtime_dependency 'html-pipeline', '~> 0.0.6'
+  gem.add_development_dependency 'rspec', '~> 2.12.0'
+end

data/lib/gollum-export.rb

@@ -0,0 +1,2 @@
+require "gollum/export/version"
+require 'gollum/export/processor'

data/lib/gollum/export/link_filter.rb

@@ -0,0 +1,35 @@
+module Gollum
+  module Export
+    class LinkFilter
+      def initialize(source, repository)
+        @source = source
+        @repository = repository
+      end
+
+      def call
+        @result = @source.gsub(/\[\[.*\]\]/) do |page_name|
+          page_name.gsub!(/[\[\]]/, '')
+          link = page_name_to_path(page_name)
+          "<a href=\"#{link}\">#{page_name}</a>"
+        end
+
+        if @repository
+          @result.gsub!(/"(https:\/\/github.com\/#{@repository}\/wiki\/)(.*)"/) do |explicit_link|
+            url, path = $1, $2
+
+            next explicit_link if path =~ /^_pages/
+
+            explicit_link.gsub!(url, '')
+            explicit_link.gsub!(path, page_name_to_path(path))
+          end
+        end
+
+        @result
+      end
+
+      def page_name_to_path(page_name)
+        "#{page_name.downcase.gsub(/\s/,'-').gsub(':', '%3A')}.html"
+      end
+    end
+  end
+end

data/lib/gollum/export/processor.rb

@@ -0,0 +1,37 @@
+require 'gollum/export/link_filter'
+
+module Gollum
+  module Export
+    class Processor
+      def self.convert_file(source_filename, options={})
+        return unless source_filename =~ /\.md$/
+
+        output_directory = options.fetch(:output_directory, nil)
+        repository = options.fetch(:repository, nil)
+
+        File.open(source_filename, 'r') do |source_file|
+          File.open(target_filename(source_filename, output_directory), 'w') do |target_file|
+            md_filter = HTML::Pipeline::MarkdownFilter.new(source_file.read)
+            link_filter = Gollum::Export::LinkFilter.new(md_filter.call, repository)
+            target_file.write(link_filter.call)
+          end
+        end
+      end
+
+      private
+
+      def self.target_filename(source_filename, output_directory=nil)
+        # sanitize final slash
+        if output_directory && !(output_directory =~ /\/$/)
+          output_directory += '/'
+        end
+
+        if output_directory
+          output_directory + source_filename.gsub(/^.*\//, '')
+        else
+          source_filename
+        end.gsub(/md$/, 'html').downcase
+      end
+    end
+  end
+end

data/lib/gollum/export/version.rb

@@ -0,0 +1,5 @@
+module Gollum
+  module Export
+    VERSION = "0.0.1"
+  end
+end

data/spec/lib/gollum/export/link_filter_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe Gollum::Export::LinkFilter do
+  it 'should fix links to implicit pages' do
+    source = '[[Another-Local-Page]]'
+    Gollum::Export::LinkFilter.new(source, nil).call.should == '<a href="another-local-page.html">Another-Local-Page</a>'
+  end
+
+  it 'should fix explicit links' do
+    source = '<a href="https://github.com/user/repo/wiki/Another-Local-Page">Another-Local-Page</a>'
+    Gollum::Export::LinkFilter.new(source, 'user/repo').call.should == '<a href="another-local-page.html">Another-Local-Page</a>'
+  end
+
+  it 'should leave links to github pages untouched' do
+    source = '<a href="https://github.com/user/repo/wiki/_pages">Pages</a>'
+    Gollum::Export::LinkFilter.new(source, 'user/repo').call.should == source
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'bundler/setup'
+require 'rspec'
+require 'gollum-export'
+
+Dir[File.expand_path("support/*", File.dirname(__FILE__))].each {|f| require f}
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: gollum-export
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Alfonso Cora
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: html-pipeline
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.6
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+description: This gem includes the `gollum-export` command that allows converting
+  local markdown files to html. It also includes a switch to download and convert
+  a full wiki from a github repo.
+email:
+- acora6@gmail.com
+executables:
+- gollum-export
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/gollum-export
+- gollum-export.gemspec
+- lib/gollum-export.rb
+- lib/gollum/export/link_filter.rb
+- lib/gollum/export/processor.rb
+- lib/gollum/export/version.rb
+- spec/lib/gollum/export/link_filter_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Downloads Gollum wikis and converts them to HTML
+test_files:
+- spec/lib/gollum/export/link_filter_spec.rb
+- spec/spec_helper.rb