markdown2html 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c58ccbbf29dbe8b0c286da5989b8a4a1fe0cc3a0
-  data.tar.gz: a2b449be63e38c82297e23564fa99977757dd7cf
+  metadata.gz: 2d86e3ec1e255b2db0b3def7be33646bd8f6b4d1
+  data.tar.gz: 57ca287284b5d5e7e2bb9d4a05fdaf090b264b2d
 SHA512:
-  metadata.gz: 040de566967f41ede08ccd795a6677d78d46c5896859300b6410ff00242ee3eb69766eb31c4d889f6ac62ac277dc0c1308a700efc94959d613d6ffe5af259066
-  data.tar.gz: e8a21f79b2583845a893aa054c4b8251cda8b6fa356ff749fce26b7906cdce38e99dd872251d4dee6ffba49a655f2a5419a6209bdefd9c7ab4abd1a9b1153f90
+  metadata.gz: b9d4ad9ae30094affd2563cba10d060becd48c18cfd03511eb2c6a7027b14346307bc7ee1545007064f12e4a2b1a688fe443a5904ecd7ed577bdf58eefa51c80
+  data.tar.gz: 56700beb424e4ebfa20d82fef081cd3faa97d7915814e7891b89fd8465251c75f202364f22d4f436aeb402582e82dd86e2b8fdd7a50c5fd23f3a0d60f448bd69

data/README.md

@@ -1,25 +1,30 @@
-#Markdown2Html
+# Markdown2Html
 
-##Overview
+## Overview
 
-Convert local markdown files or wikis from git repositories to html.
+Convert local markdown files or entire GitHub wikis to html.
 
-##Installation
+## Installation
 
 ```bash
-  $ gem install markdown2html
+  gem install markdown2html
 ```
 
-##Usage
+## Usage
 
-Local conversion:
+### Local conversion
 
 ```bash
+  markdown2html file.md
   markdown2html file1.md file2.md ...
 ```
 
-Download and convert a GitHub wiki:
+The html file will be created in the same directory with a similar name and the `.html` extension.
+
+### GitHub wiki
 
 ```bash
   markdown2html plataformatec/devise
 ```
+
+This command clones the wiki in the current directory and then it converts each md file on it to html.

data/Rakefile

@@ -1 +1,9 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/**/test*.rb']
+end
+
+task :default => [:test]

data/bin/markdown2html

@@ -1,14 +1,7 @@
 #!/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
@@ -21,14 +14,13 @@ elsif ARGV.any? {|f| f =~ /\.md$/}
   ARGV.each do |file|
     next unless file =~ /\.md$/
     puts "Converting #{file}..."
-    Markdown2Html::Processor.convert_file(file, :output_directory => output_directory)
+    Markdown2Html::Processor.convert_file(file)
   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"
@@ -36,14 +28,8 @@ else
     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)
+    Markdown2Html::Processor.convert_file(file, :repository => repository)
   end
 end

data/lib/markdown2html/processor.rb

@@ -1,15 +1,15 @@
 require 'markdown2html/link_filter'
+require 'html/pipeline'
 
 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|
+        File.open(target_filename(source_filename), '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)
@@ -19,17 +19,8 @@ module Markdown2Html
 
     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
+    def self.target_filename(source_filename)
+      source_filename.gsub(/md$/, 'html').downcase
     end
   end
 end

data/markdown2html.gemspec

@@ -4,12 +4,13 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |gem|
   gem.name          = 'markdown2html'
-  gem.version       = '0.1.0'
+  gem.version       = '0.1.2'
   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.license       = 'MIT'
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
@@ -18,5 +19,6 @@ Gem::Specification.new do |gem|
 
   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'
+  gem.add_development_dependency 'minitest', '~> 5.8', '>= 5.8.3'
+  gem.add_development_dependency 'rake', '~> 10.4', '>= 10.4.2'
 end

data/test/lib/markdown2html/test_link_filter.rb

@@ -0,0 +1,18 @@
+require 'test_helper'
+
+class TestMarkdown2Html < Minitest::Test
+  def test_fixes_links_to_implicit_pages
+    source = '[[Another-Local-Page]]'
+    assert_equal '<a href="another-local-page.html">Another-Local-Page</a>', Markdown2Html::LinkFilter.new(source, nil).call
+  end
+
+  def test_fixes_explicit_links
+    source = '<a href="https://github.com/user/repo/wiki/Another-Local-Page">Another-Local-Page</a>'
+    assert_equal '<a href="another-local-page.html">Another-Local-Page</a>', Markdown2Html::LinkFilter.new(source, 'user/repo').call
+  end
+
+  def test_leaves_links_to_github_pages_untouched
+    source = '<a href="https://github.com/user/repo/wiki/_pages">Pages</a>'
+    assert_equal source, Markdown2Html::LinkFilter.new(source, 'user/repo').call
+  end
+end

data/test/lib/markdown2html/test_processor.rb

@@ -0,0 +1,20 @@
+require 'test_helper'
+require 'tempfile'
+
+class TestProcessor < Minitest::Test
+  def test_ignores_non_md_files
+    assert_nil Markdown2Html::Processor.convert_file('file.txt')
+  end
+
+  def test_converts_to_html_and_sets_the_correct_filename
+    source = Tempfile.new(['source', '.md'])
+    source.write('# The Source')
+    source.close
+
+    Markdown2Html::Processor.convert_file(source.path)
+
+    File.open(source.path.gsub(/md$/, 'html').downcase, 'r') do |target|
+      assert_equal '<h1>The Source</h1>', target.readline
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'minitest/autorun'
+require 'minitest/pride'
+require 'markdown2html'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: markdown2html
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Alf Cora
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-01 00:00:00.000000000 Z
+date: 2015-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: html-pipeline
@@ -51,25 +51,45 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.6.9
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.12'
+        version: '5.8'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.12.0
+        version: 5.8.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.12'
+        version: '5.8'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.12.0
+        version: 5.8.3
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.4.2
 description: Convert markdown files and wikis to html.
 email:
 - alfius@protonmail.com
@@ -80,7 +100,6 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - Gemfile
-- LICENSE.txt
 - README.md
 - Rakefile
 - bin/markdown2html
@@ -89,10 +108,12 @@ files:
 - lib/markdown2html/processor.rb
 - license.txt
 - markdown2html.gemspec
-- spec/lib/markdown2html/link_filter_spec.rb
-- spec/spec_helper.rb
+- test/lib/markdown2html/test_link_filter.rb
+- test/lib/markdown2html/test_processor.rb
+- test/test_helper.rb
 homepage: https://github.com/alfonsocora/markdown2html
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -115,5 +136,6 @@ 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
+- test/lib/markdown2html/test_link_filter.rb
+- test/lib/markdown2html/test_processor.rb
+- test/test_helper.rb

data/LICENSE.txt

@@ -1,22 +0,0 @@
-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/spec/lib/markdown2html/link_filter_spec.rb

@@ -1,18 +0,0 @@
-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

@@ -1,9 +0,0 @@
-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