markup 0.1.2

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 James Wilding
+
+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.markdown

@@ -0,0 +1,40 @@
+# markup
+
+Markup is a small (ie tiny) command line tool for converting Markdown to HTML.
+
+## Installation
+
+	$ sudo gem install markup --source http://gemcutter.org
+
+## Usage
+
+	$ markup README.markdown
+	Created README.html
+
+	$ cat README.html
+	<h1>markup</h1>
+	
+	<p>Markup is a small.... etc
+	
+By default markup outputs to {sourcefile_name}.html, but you can specify a different filename using the -o option:
+
+	$ markup README.markdown -o instructions.html
+	
+Overwrite existing output using the -F option (this will clobber existing files so be careful):
+
+	$ markup README.markdown -F
+
+## Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2009 James Wilding. See LICENSE for details.

data/bin/markup

@@ -0,0 +1,45 @@
+#!/usr/bin/env ruby
+require 'optparse'
+
+# Command line tool for producing HTML from Markdown files. 
+# Requires rubygems and RDiscount (gem install rdiscount).
+#
+# Usage: markup source_file.markdown [-o output_file] [-F]
+#
+# For help, use markup --help
+
+options = {}
+script  = File.basename($0) 
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: #{script} source_file [options]"
+  
+  opts.on '-o', '--output', 'Output file [FILE]' do |file|
+    options[:output] = file
+  end
+  
+  opts.on '-F', '--force', 'Overwrite output file' do |force|
+    options[:force] = force
+  end
+end.parse!
+
+unless input = ARGV.first
+  puts "Please specify a source file"
+  exit 1
+end
+
+begin
+  require 'rubygems'
+  require File.dirname(__FILE__) + '/../lib/markup'
+  
+  runner = Markup::Runner.new(input, options)
+  output = runner.output_filename
+
+  runner.generate_html!
+rescue Markup::Runner::OutputExists
+  puts "Output file #{output} exists: use #{script} -o to specify another"
+  exit 1
+else
+  puts "Created #{output}"
+  exit 0
+end

data/lib/markup.rb

@@ -0,0 +1,38 @@
+require 'rdiscount'
+
+module Markup
+  class Runner
+    
+    class OutputExists < StandardError; end
+    
+    def initialize(source, options = {})
+      @source  = source
+      @options = options
+    end
+    
+    def generate_html!
+      if output_file_exists? && should_not_overwrite_output_file?
+        raise OutputExists, output_filename
+      else
+        File.open(output_filename, 'w') { |f| f.write(html_output) }
+      end
+    end    
+    
+    def output_filename
+      @options[:output] || File.basename(@source, '.*') + '.html'
+    end
+    
+    private
+    def html_output
+      RDiscount.new(File.read(@source)).to_html
+    end
+    
+    def output_file_exists?
+      File.file?(output_filename)
+    end
+    
+    def should_not_overwrite_output_file?
+      !@options[:force]            
+    end
+  end
+end

data/test/markup_test.rb

@@ -0,0 +1,76 @@
+require 'test_helper'
+require 'fileutils'
+
+class MarkupTest < Test::Unit::TestCase
+  
+  include FileUtils
+  
+  def setup
+    @source = File.dirname(__FILE__) + '/../README.markdown'
+    @output = File.dirname(__FILE__) + '/output.html'
+    clear_output_file!
+  end
+  
+  context '#output_filename' do
+    context 'with no options' do
+      should 'set output filename to input filename + "html"' do
+        runner   = Markup::Runner.new(@source)
+        expected = 'README.html'
+        actual   = runner.output_filename
+
+        assert_equal expected, actual
+      end          
+    end
+    
+    context 'with options[:output] set' do
+      should 'use options[:output] as output filename' do
+        runner   = Markup::Runner.new(@source, :output => 'instructions.html')
+        expected = 'instructions.html'
+        actual   = runner.output_filename
+        
+        assert_equal expected, actual
+      end
+    end
+  end
+  
+  context '#generate_html!' do    
+    context 'when options[:force] != true' do
+      should 'raise an exception if the output file exists' do
+        assert_raise(Markup::Runner::OutputExists) do
+          Markup::Runner.new(@source, :output => @output).generate_html!
+        end
+      end
+      
+      should 'create output file if it does not exist' do
+        new_output = File.dirname(__FILE__) + '/new_output.html'
+        assert !File.file?(new_output)
+        
+        Markup::Runner.new(@source, :output => new_output).generate_html!
+        assert File.file?(new_output)
+        
+        rm(new_output) if File.file?(new_output)
+      end      
+    end
+    
+    context 'when options[:force] == true' do
+      should 'raise no exceptions, even when output file exists' do
+        assert_nothing_raised do
+          Markup::Runner.new(@source, :output => @output, :force => true).generate_html!          
+        end
+      end
+      
+      should 'overwrite contents of output file if it exists' do        
+        old_contents = File.read(@output)
+        Markup::Runner.new(@source, :output => @output, :force => true).generate_html!
+        new_contents = File.read(@output)
+        
+        assert new_contents != old_contents
+        assert new_contents =~ /^<h1>/, "New content doesn't seem to contain any HTML"
+      end      
+    end
+  end
+  
+  def clear_output_file!
+    File.open(@output, 'w') { |f| f.write nil }
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'redgreen'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'markup'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification 
+name: markup
+version: !ruby/object:Gem::Version 
+  version: 0.1.2
+platform: ruby
+authors: 
+- James Wilding
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-16 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rdiscount
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.3.5
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: redgreen
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Small command line tool that reads Markdown files and outputs HTML
+email: james@jameswilding.net
+executables: 
+- markup
+- markup
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- bin/markup
+- lib/markup.rb
+- LICENSE
+- README.markdown
+has_rdoc: true
+homepage: http://github.com/jameswilding/markup
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Command line Markdown-to-HTML conversion
+test_files: 
+- test/markup_test.rb
+- test/test_helper.rb