ravicious-clothmark 0.1.0 → 0.2.0

data/README.rdoc

@@ -14,27 +14,39 @@ ClothMark uses three awesome gems:
 
 == Usage
 
-There are three commands:
+Basic usage:
 
-* +bbmark+, which converts a file formatted with *BBCode* to HTML file.
-* +bluemark+, which converts a file formatted with *Markdown* to HTML file.
-* +redmark+, which converts a file formatted with *Textile* to HTML file.
+  $ clothmark [input file]
 
-For example:
+It converts an input file to HTML using *Markdown* preprocessor. But you probably want to specify an output file or used preprocessor. Of course you can do this. Look here:
 
-  $ bluemark my_markdown_formatted_file.txt
-  
-It generates the my\_markdown\_formatted\_file\_clothmark.html file. All files will be created in the folder that contains the input file, e.g:
+  $ clothmark [input file] [-o output file] [-m markup language]
 
-  $ bbmark posts/forum_post2
+Quick example:
   
-In this case, the forum\_post2.html file will be created in the _posts_ folder.
+  $ clothmark bb_code.txt -m bbcode -o forum_post.html
+
+It converts the input file (bb_code.txt) to the HTML file (forum_post.html) using BBCode preprocessor.
+
+Wanna see help? No problem.
 
-You can *specify* *an* *output* *file*, just add the second argument:
+  $ clothmark -h
+  Usage: clothmark [options]
+    -h, --help                       Display this screen
+    -i, --input FILE                 Specify input file (if it aren't specified, then first argument will be used)
+    -o, --output FILE                Specify output file
+    -m, --markup LANG                Specify markup language (markdown, textile or bbcode, default is markdown)
 
-  $ redmark textile_rlz new_blog_post.html
+So, there are three arguments:
+* -i or --input which specifies input file. If it isn't typed, then first argument will be used as an input file. This argument is required.
+* -o or --output which specifies output file. You don't have to specify it, because ClothMark generates filename for output file automatically.
+* -m or --markup which specifies markup language. If you don't specify it, then Markdown will be used as a choosed language.
+
+All files will be created in the folder that contains a input file, e.g:
+
+  $ clothmark posts/forum_post2 -m bbcode
   
-It generates the new\_blog\_post.html file.
+In this case, the forum\_post2.html file will be created in the _posts_ folder.
 
 == Note on Patches/Pull Requests
  

data/Rakefile

@@ -15,7 +15,7 @@ begin
     gem.add_dependency('BlueCloth', '>=1.0.0')
     gem.add_dependency('RedCloth', '>=4.2.2')
     gem.add_development_dependency "rspec"
-    gem.executables = ['bbmark', 'bluemark', 'redmark']
+    gem.executables = ['clothmark']
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
 rescue LoadError

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/bin/clothmark

@@ -0,0 +1,60 @@
+#!/usr/bin/env ruby
+
+require "optparse"
+require File.expand_path(File.dirname(__FILE__) + '/../lib/clothmark')
+
+options = {}
+
+optparse = OptionParser.new do |opts|
+
+  opts.on('-h', '--help', 'Display this screen') do
+    puts opts
+    exit
+  end
+  
+  # If input aren't specified, then first arg will be used
+  options[:input] = ARGV.first
+  opts.on('-i', '--input FILE', 'Specify input file (if it aren\'t specified, then first argument will be used)') do |arg|
+    options[:input] = arg
+  end
+
+  # If output aren't specified, then it will be an empty string
+  options[:output] = ""
+  opts.on('-o', '--output FILE', 'Specify output file') do |arg|
+    options[:output] = arg || nil
+  end
+
+  options[:markup] = "markdown"
+  opts.on('-m', '--markup LANG', %w(markdown textile bbcode) ,'Specify markup language (markdown, textile or bbcode, default is markdown)') do |arg|
+    options[:markup] = arg.downcase || "markdown"
+  end
+
+end
+
+begin
+  optparse.parse!
+rescue OptionParser::MissingArgument => e
+    puts e
+    puts "To see help, type:"
+    puts "$ ruby #{__FILE__} -h"
+    exit
+rescue OptionParser::InvalidArgument => e
+    puts e
+    puts "To see accepted arguments, type:"
+    puts "$ ruby #{__FILE__} -h"
+    exit
+end #begin
+
+case options[:markup]
+when 'markdown'
+  @cloth = BlueMark.new(options[:input], options[:output])
+when 'textile'
+  @cloth = RedMark.new(options[:input], options[:output])
+when 'bbcode'
+  @cloth = BBMark.new(options[:input], options[:output])
+end
+
+@cloth.convert
+@cloth.save_to_file
+
+puts "File converted and saved to #{File.expand_path(@cloth.output)}"

data/clothmark.gemspec

@@ -5,14 +5,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{clothmark}
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Rafal Cieslak"]
   s.date = %q{2009-08-19}
+  s.default_executable = %q{clothmark}
   s.description = %q{With ClothMark you can easily convert your files formatted with Markdown, Textile or BBCode to HTML files.}
   s.email = %q{ravicious@gmail.com}
-  s.executables = ["bbmark", "bluemark", "redmark"]
+  s.executables = ["clothmark"]
   s.extra_rdoc_files = [
     "LICENSE",
      "README.rdoc"
@@ -22,9 +23,7 @@ Gem::Specification.new do |s|
      "README.rdoc",
      "Rakefile",
      "VERSION",
-     "bin/bbmark",
-     "bin/bluemark",
-     "bin/redmark",
+     "bin/clothmark",
      "clothmark.gemspec",
      "lib/clothmark.rb",
      "lib/clothmark/markups.rb",

data/lib/clothmark/module.rb

@@ -44,7 +44,11 @@ module ClothMark
   # ClothMark will generate a default filename if user don't want to save output to a specific file.
   def initialize(file, output = nil)
     @file = file
-    @output = output || "#{file.gsub(/(\.[a-z]{3,4})/, '')}_clothmark.html"
+    if (!output || output.empty?)
+      @output = "#{file.gsub(/(\.[a-z]{3,4})/, '')}_clothmark.html"
+    else
+      @output = output
+    end
     @data_for_output = []
   end
   
@@ -57,4 +61,4 @@ module ClothMark
       file.puts FOOTER
     end
   end
-end
+end

data/spec/clothmark/clothmark_spec.rb

@@ -2,13 +2,18 @@ require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
 describe ClothMark do
   before :each do
-    klass = Class.new { include ClothMark }
-    @foo = klass.new('nothing_special.txt')
+    @klass = Class.new { include ClothMark }
+    @foo = @klass.new('nothing_special.txt')
   end
   
   it "should generate valid default 'output' filename" do
     @foo.output.should == 'nothing_special_clothmark.html'
   end
+
+  it "should gets output if it is specified" do
+    @bar = @klass.new('rails.txt', 'rubyonrails.txt')
+    @bar.output.should == 'rubyonrails.txt'
+  end
   
   it "should save data for output to the output file" do
     @foo.data_for_output = ['Donec ultrices tortor non lorem egestas ut pharetra diam vestibulum.',
@@ -41,4 +46,4 @@ describe ClothMark do
     # Remove testfile (output)
     FileUtils.rm(@foo.output)
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ravicious-clothmark
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Rafal Cieslak
@@ -10,7 +10,7 @@ bindir: bin
 cert_chain: []
 
 date: 2009-08-19 00:00:00 -07:00
-default_executable: 
+default_executable: clothmark
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: bb-ruby
@@ -55,9 +55,7 @@ dependencies:
 description: With ClothMark you can easily convert your files formatted with Markdown, Textile or BBCode to HTML files.
 email: ravicious@gmail.com
 executables: 
-- bbmark
-- bluemark
-- redmark
+- clothmark
 extensions: []
 
 extra_rdoc_files: 
@@ -68,9 +66,7 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION
-- bin/bbmark
-- bin/bluemark
-- bin/redmark
+- bin/clothmark
 - clothmark.gemspec
 - lib/clothmark.rb
 - lib/clothmark/markups.rb

data/bin/bbmark

@@ -1,11 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'rubygems'
-require File.expand_path(File.dirname(__FILE__) + '/../lib/clothmark')
-
-input = ARGV[0]
-output = ARGV[1] || nil
-
-@bbmark = BBMark.new(input, output)
-@bbmark.convert
-@bbmark.save_to_file

data/bin/bluemark

@@ -1,12 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'rubygems'
-
-require File.expand_path(File.dirname(__FILE__) + '/../lib/clothmark')
-
-input = ARGV[0]
-output = ARGV[1] || nil
-
-@bluemark = BlueMark.new(input, output)
-@bluemark.convert
-@bluemark.save_to_file

data/bin/redmark

@@ -1,13 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'rubygems'
-
-$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
-require 'clothmark'
-
-input = ARGV[0]
-output = ARGV[1] || nil
-
-@redmark = RedMark.new(input, output)
-@redmark.convert
-@redmark.save_to_file