markdown2html 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c58ccbbf29dbe8b0c286da5989b8a4a1fe0cc3a0
+  data.tar.gz: a2b449be63e38c82297e23564fa99977757dd7cf
+SHA512:
+  metadata.gz: 040de566967f41ede08ccd795a6677d78d46c5896859300b6410ff00242ee3eb69766eb31c4d889f6ac62ac277dc0c1308a700efc94959d613d6ffe5af259066
+  data.tar.gz: e8a21f79b2583845a893aa054c4b8251cda8b6fa356ff749fce26b7906cdce38e99dd872251d4dee6ffba49a655f2a5419a6209bdefd9c7ab4abd1a9b1153f90

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 markdown2html.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,25 @@
+#Markdown2Html
+
+##Overview
+
+Convert local markdown files or wikis from git repositories to html.
+
+##Installation
+
+```bash
+  $ gem install markdown2html
+```
+
+##Usage
+
+Local conversion:
+
+```bash
+  markdown2html file1.md file2.md ...
+```
+
+Download and convert a GitHub wiki:
+
+```bash
+  markdown2html plataformatec/devise
+```

data/Rakefile

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

data/bin/markdown2html

@@ -0,0 +1,49 @@
+#!/usr/bin/env ruby
+
+require 'html/pipeline'
+require 'markdown2html'
+
+# 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 '  markdown2html file.md'
+  puts '  markdown2html file1.md file2.md ...'
+  puts '  markdown2html plataformatec/devise'
+elsif ARGV.any? {|f| f =~ /\.md$/}
+  # file mode
+  ARGV.each do |file|
+    next unless file =~ /\.md$/
+    puts "Converting #{file}..."
+    Markdown2Html::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}..."
+    Markdown2Html::Processor.convert_file(file, :output_directory => output_directory, :repository => repository)
+  end
+end

data/lib/markdown2html/link_filter.rb

@@ -0,0 +1,33 @@
+module Markdown2Html
+  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

data/lib/markdown2html/processor.rb

@@ -0,0 +1,35 @@
+require 'markdown2html/link_filter'
+
+module Markdown2Html
+  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 = Markdown2Html::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

data/lib/markdown2html.rb

@@ -0,0 +1 @@
+require 'markdown2html/processor'

data/license.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 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/markdown2html.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |gem|
+  gem.name          = 'markdown2html'
+  gem.version       = '0.1.0'
+  gem.authors       = ['Alf Cora']
+  gem.email         = ['alfius@protonmail.com']
+  gem.description   = %q{Convert markdown files and wikis to html.}
+  gem.summary       = %q{Convert local markdown files or wikis from git repositories to html.}
+  gem.homepage      = 'https://github.com/alfonsocora/markdown2html'
+
+  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', '~> 2.2', '>= 2.2.2'
+  gem.add_runtime_dependency 'github-markdown', '~> 0.6', '>= 0.6.9'
+  gem.add_development_dependency 'rspec', '~> 2.12', '>= 2.12.0'
+end

data/spec/lib/markdown2html/link_filter_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe Markdown2Html::LinkFilter do
+  it 'should fix links to implicit pages' do
+    source = '[[Another-Local-Page]]'
+    Markdown2Html::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>'
+    Markdown2Html::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>'
+    Markdown2Html::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 'markdown2html'
+
+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,119 @@
+--- !ruby/object:Gem::Specification
+name: markdown2html
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alf Cora
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: html-pipeline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+- !ruby/object:Gem::Dependency
+  name: github-markdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.9
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+description: Convert markdown files and wikis to html.
+email:
+- alfius@protonmail.com
+executables:
+- markdown2html
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/markdown2html
+- lib/markdown2html.rb
+- lib/markdown2html/link_filter.rb
+- lib/markdown2html/processor.rb
+- license.txt
+- markdown2html.gemspec
+- spec/lib/markdown2html/link_filter_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/alfonsocora/markdown2html
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Convert local markdown files or wikis from git repositories to html.
+test_files:
+- spec/lib/markdown2html/link_filter_spec.rb
+- spec/spec_helper.rb