mdpage 0.0.2 → 0.0.3

data/.gitignore

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

data/.travis.yml

@@ -1,4 +1,3 @@
-rvm:
-- 1.8.7
-- 1.9.2
-- 1.9.3
+rvm:
+- 1.9.2
+- 1.9.3

data/ChangeLog.md

@@ -0,0 +1,15 @@
+# mdpage change log
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+## 0.0.3
+- custom template option
+- fix gemspec dependency
+
+## 0.0.2
+- namespace changed MdPage to MdPage::Page
+- added method **MdPage::Page.to_html_objects** which return path and htmldata as Hash objects.
+
+## 0.0.1
+- just release.
+- Usage:
+    mdpage <file1> <file2> ....
+

data/Gemfile

@@ -1,7 +1,8 @@
-# A sample Gemfile
-source "https://rubygems.org"
-
-# gem "rails"
-gem 'rdiscount'
-gem 'rake'
-gem 'rspec'
+# A sample Gemfile
+source "https://rubygems.org"
+
+# gem "rails"
+gem 'rdiscount'
+gem 'rake'
+gem 'test-unit'
+gem 'shoulda'

data/LICENSE

@@ -1,22 +1,22 @@
-Copyright (c) 2012 Masahiro Arakane
-
-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.
+Copyright (c) 2012 Masahiro Arakane
+
+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

@@ -1,14 +1,31 @@
-# mdpage : html generater for markdown files.
-[![Build Status](https://secure.travis-ci.org/arafine/mdpage.png?branch=master)](http://travis-ci.org/arafine/mdpage)
-
-## Usage
-    mdpage <file1> <file2>...
-files encoding should be **UTF-8**.
-
-## Dependency
-:default  
-  - rdiscount  
-
-:development  
-  - rspec
-  - rake
+# mdpage : html generater for markdown files.
+[![Build Status](https://secure.travis-ci.org/arafine/mdpage.png?branch=master)](http://travis-ci.org/arafine/mdpage)
+
+## Usage
+    mdpage <file1> <file2>...
+
+    options:
+      -h, --help            : show this messages
+      -t, --template <name> : use custom template <name>.html.erb under ~/.mdpage/
+      -v, --version         : show version infomation
+
+- all files encodings should be **UTF-8**.
+- if you use template option, set your template file to ~/.mdpage
+- naming convention of the custom template file: **name**.html.erb
+
+### Custom template example
+template files should have two variables.
+- @page[:title]    : First match line which start with "# ", will be set to @page[:title].
+- @page[:contents] : Compiled markdown contents will be set to @page[:contents].
+
+#### example
+    $ cat ~/.mdpage/hoge.html.erb
+
+## Dependency
+:default  
+  - rdiscount  (markdown parser)
+
+:development  
+  - rake
+  - test-unit
+  - shoulda

data/Rakefile

@@ -1,21 +1,20 @@
-#!/usr/bin/env rake
-
-require 'rubygems'
-require 'bundler/gem_tasks'
-require 'bundler'
-
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
-
-require 'rspec/core'
-require 'rspec/core/rake_task'
-
-task :default => :spec
-
-desc "Run all specs in spec directory"
-RSpec::Core::RakeTask.new(:spec)
+#!/usr/bin/env rake
+
+require 'rubygems'
+require 'bundler/gem_tasks'
+require 'bundler'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+task :test do
+  $:.unshift(File.dirname(__FILE__) + "/test")
+  require "test_helper"
+end
+
+task :default => :test

data/bin/mdpage

@@ -1,14 +1,31 @@
-#!/usr/bin/env ruby
-# Usage: mdpage [<file>...]
-# Convert one or more Markdown files to styled html files.
-
-if (ARGV.include? '--help') || (ARGV.include? '-h')
-  File.read(__FILE__).split("\n").grep(/^# /).each do |line|
-    puts line[2..-1]
-  end
-  exit
-end
-
-require 'mdpage'
-MdPage::Page.new(ARGV).to_html_files
-puts "Done!"
+#!/usr/bin/env ruby
+
+$:.unshift(File.dirname(__FILE__) + "/../lib")
+require 'mdpage'
+require "mdpage/optparser"
+require "mdpage/version"
+
+MdPage::OptParser.new do |opt|
+  opt.on('-h', '--help')     {|v| puts opt.help; exit}
+  opt.on('-t name', '--template name') {|n| opt.template_name = n if n}
+  opt.on('-v', '--version')  {|v| puts "MdPage::VERSION => #{MdPage::VERSION}"; exit}
+
+  begin
+    opt.parse!(ARGV)
+    if ARGV.empty?
+      puts opt.help
+      exit 0
+    end
+    unless opt.template_name
+      MdPage::Page.new(ARGV).to_html_files
+    else
+      MdPage::Page.new(ARGV).set_template(opt.template_name).to_html_files
+    end
+    puts "Done!"
+  rescue OptionParser::InvalidOption => e
+    MdPage::OptionError.new(e.message)
+    puts opt.help
+    exit 3
+  end
+end
+

data/lib/mdpage.rb

@@ -1,50 +1,6 @@
-require "rdiscount"
-require "erb"
-
-module MdPage
-  class Page
-    attr_reader :argv, :path_check, :doc, :result
-
-    def initialize(argv)
-      @argv = argv
-      check_results = @argv.map {|av| File.exist? av}
-      @path_check = check_results.include?(false) ? false : true
-      tpl_path = File.dirname(__FILE__) + "/mdpage/default.html.erb"
-      @template = File.open(tpl_path, "r:utf-8") {|f| f.read}
-      @doc = Hash.new
-      @result = nil
-    end
-
-    def md2html(file)
-      begin
-        raw_contents = File.open(file, "r:utf-8") {|f| f.read}
-      rescue
-        raise "#{file} encoding should be UTF-8."
-      end
-      raw_contents =~ /^.*#\s?(.+)\n.+/
-      @doc[:title] = $1 || ''
-      contents = RDiscount.new(raw_contents).to_html
-      return contents
-    end
-
-    def to_html_files
-      path_data = to_html_objects
-      path_data.each do |k, v|
-        File.open(k, "w:utf-8") {|f| f.write v}
-      end
-      @result = true
-    end
-
-    def to_html_objects
-      erb = ERB.new(@template)
-      html_objects = Hash.new
-      @argv.each do |file|
-        @doc[:contents] = md2html(file)
-        html = erb.result(binding)
-        out_path = File.expand_path(file) + ".html"
-        html_objects.store(out_path, html)
-      end
-      return html_objects
-    end
-  end
-end
+require "rdiscount"
+require "erb"
+
+module MdPage
+  require "mdpage/page"
+end

data/lib/mdpage/default.html.erb

@@ -1,54 +1,54 @@
-<!DOCTYPE html>
-<html>
-  <head>
-    <meta charset='utf-8'>
-    <title><%= @doc[:title] %></title>
-    <style type="text/css">
-      body {
-        font: 14px Helvetica, arial, freesans, clean, Meiryo, sans-serif;
-        margin: 0;
-        padding: 0;
-        line-height: 1.4em;
-      }
-      div#markdown-body {
-        width: 880px;
-        margin: 0 auto;
-      }
-      #markdown-body h1, #markdown-body h2 {
-        border-bottom: 1px solid #ccc;
-      }
-      #markdown-body h3, #markdown-body h4 {
-        border-left: 2px solid #ccc;
-        padding-left: 3px;
-      }
-      #markdown-body table {
-        border-collapse: collapse;
-        border: 1px solid #eee;
-      }
-      #markdown-body table thead {
-        background: #eee;
-      }
-      #markdown-body th, #markdown-body td {
-        padding: 2px 3px;
-        border: 1px solid #ccc;
-      }
-      #markdown-body blockquote {
-        background: #eee;
-        border-left: 4px double #ccc;
-        margin: 5px 40px;
-        padding: 8px;
-      }
-      #markdown-body pre {
-        background: #efefef;
-        border: 1px solid #e7e7e7;
-        border-radius: 3px;
-        padding: 14px;
-      }
-    </style>
-  </head>
-  <body>
-    <div id="markdown-body">
-<%= @doc[:contents] %>
-    </div>
-  </body>
-</html>
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset='utf-8'>
+    <title><%= @page[:title] %></title>
+    <style type="text/css">
+      body {
+        font: 14px Helvetica, arial, freesans, clean, Meiryo, sans-serif;
+        margin: 0;
+        padding: 0;
+        line-height: 1.4em;
+      }
+      div#markdown-body {
+        width: 880px;
+        margin: 0 auto;
+      }
+      #markdown-body h1, #markdown-body h2 {
+        border-bottom: 1px solid #ccc;
+      }
+      #markdown-body h3, #markdown-body h4 {
+        border-left: 2px solid #ccc;
+        padding-left: 3px;
+      }
+      #markdown-body table {
+        border-collapse: collapse;
+        border: 1px solid #eee;
+      }
+      #markdown-body table thead {
+        background: #eee;
+      }
+      #markdown-body th, #markdown-body td {
+        padding: 2px 3px;
+        border: 1px solid #ccc;
+      }
+      #markdown-body blockquote {
+        background: #eee;
+        border-left: 4px double #ccc;
+        margin: 5px 40px;
+        padding: 8px;
+      }
+      #markdown-body pre {
+        background: #efefef;
+        border: 1px solid #e7e7e7;
+        border-radius: 3px;
+        padding: 14px;
+      }
+    </style>
+  </head>
+  <body>
+    <div id="markdown-body">
+<%= @page[:contents] %>
+    </div>
+  </body>
+</html>

data/lib/mdpage/optparser.rb

@@ -0,0 +1,25 @@
+module MdPage
+  require "optparse"
+
+  class OptParser < OptionParser
+    attr_reader :help
+    attr_accessor :template_name
+
+    def initialize
+      @template_name
+      @help = <<-HELP
+  Usage:
+    -h, --help            : show this messages
+    -t, --template <name> : use custom template <name>.html.erb under ~/.mdpage/
+    -v, --version         : show version infomation
+      HELP
+      super
+    end
+  end
+
+  class OptionError
+    def initialize(message)
+      $stderr.puts "!!! " << message << " !!!"
+    end
+  end
+end

data/lib/mdpage/page.rb

@@ -0,0 +1,58 @@
+module MdPage
+  class Page
+    attr_reader :argv, :path_check, :doc, :result
+
+    def initialize(argv)
+      @argv = argv
+      check_results = @argv.map {|av| File.exist? av}
+      @path_check = check_results.include?(false) ? false : true
+      tpl_path = File.dirname(__FILE__) + "/default.html.erb"
+      @template = File.open(tpl_path, "r:utf-8") {|f| f.read}
+      @page = Hash.new
+      @result = nil
+    end
+
+    def md2html(file)
+      begin
+        raw_contents = File.open(file, "r:utf-8") {|f| f.read}
+      rescue
+        raise "#{file} encoding should be UTF-8."
+      end
+      raw_contents =~ /^.*#\s?(.+)\n.+/
+      @page[:title] = $1 || ''
+      contents = RDiscount.new(raw_contents).to_html
+      return contents
+    end
+
+    def to_html_files
+      path_data = to_html_objects
+      path_data.each do |k, v|
+        File.open(k, "w:utf-8") {|f| f.write v}
+      end
+      @result = true
+    end
+
+    def to_html_objects
+      erb = ERB.new(@template)
+      html_objects = Hash.new
+      @argv.each do |file|
+        @page[:contents] = md2html(file)
+        html = erb.result(binding)
+        out_path = File.expand_path(file) + ".html"
+        html_objects.store(out_path, html)
+      end
+      return html_objects
+    end
+
+    def set_template(template_name)
+      begin
+        home = ENV["HOME"]
+        template_path = "#{home}/.mdpage/#{template_name}.html.erb"
+        @template = File.open(template_path, "r:utf-8") {|f| f.read}
+        return self
+      rescue 
+        raise "Missing template: #{template_path}"
+      end
+    end
+  end
+end

data/lib/mdpage/version.rb

@@ -1,3 +1,3 @@
-module MdPage
-  VERSION = "0.0.2"
-end
+module MdPage
+  VERSION = "0.0.3"
+end

data/mdpage.gemspec

@@ -1,19 +1,20 @@
-require File.expand_path('../lib/mdpage/version', __FILE__)
-
-Gem::Specification.new do |gem|
-  gem.authors       = ["Masahiro Arakane"]
-  gem.email         = ["arafine@me.com"]
-  gem.description   = <<-DESC
-                        Simple styled document generator for markdown files
-                        Usage:
-                          mdpage <file1> <file2> ...
-                      DESC
-  gem.summary       = %q{Simple styled document generator for markdown files}
-  gem.homepage      = "https://github.com/arafine/mdpage.git"
-  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.name          = "mdpage"
-  gem.require_paths = ["lib"]
-  gem.version       = MdPage::VERSION
-end
+require File.expand_path('../lib/mdpage/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Masahiro Arakane"]
+  gem.email         = ["arafine@me.com"]
+  gem.description   = <<-DESC
+                        Simple styled document generator for markdown files
+                        Usage:
+                          mdpage <file1> <file2> ...
+                      DESC
+  gem.summary       = %q{Simple styled document generator for markdown files}
+  gem.homepage      = "https://github.com/arafine/mdpage.git"
+  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.name          = "mdpage"
+  gem.require_paths = ["lib"]
+  gem.version       = MdPage::VERSION
+  gem.add_dependency('rdiscount', '>=1.6.8')
+end

data/test/sample.md

@@ -0,0 +1,6 @@
+# sample.md
+this file encoding is "UTF-8"
+
+## ハローワールド
+Hello World!
+

data/test/sample2.md

@@ -0,0 +1,6 @@
+# sample2.md
+this file encoding is "UTF-8"
+
+## ハローワールド
+Hello World!
+

data/test/sample_cp932.md

@@ -0,0 +1,6 @@
+# sample_cp932.md
+this file encoding is "ccp932"
+
+## �n���[���[���h
+Hello World!
+

data/test/test_helper.rb

@@ -0,0 +1,9 @@
+$:.unshift(File.dirname(__FILE__) + "/../lib")
+
+require "test/unit"
+require "shoulda"
+require "mdpage"
+
+test_files = %w[
+  test_mdpage
+].each {|tf| require tf}

data/test/test_mdpage.rb

@@ -0,0 +1,25 @@
+class MdPageTest < Test::Unit::TestCase
+  context 'MdPage::Page' do
+    setup do
+      cur_dir = File.dirname(__FILE__)
+      exist_files  = ["#{cur_dir}/sample.md", "#{cur_dir}/sample2.md"]
+      unexist_file = ["#{cur_dir}/hoge.md"]
+      invalid_file = ["#{cur_dir}/sample_cp932.md"]
+      @mdp_exist    = MdPage::Page.new(exist_files)
+      @mdp_unexist  = MdPage::Page.new(unexist_file)
+      @mdp_invalid  = MdPage::Page.new(invalid_file)
+    end
+
+    context 'when initialize' do
+      should '@path_check is true' do
+        assert_true @mdp_exist.path_check
+        assert_true @mdp_invalid.path_check
+      end
+      should '@path_check is false' do
+        assert_false @mdp_unexist.path_check
+      end
+    end
+
+  end
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mdpage
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-06 00:00:00.000000000 Z
-dependencies: []
+date: 2012-06-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rdiscount
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.6.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.6.8
 description: ! "                        Simple styled document generator for markdown
   files\n                        Usage:\n                          mdpage <file1>
   <file2> ...\n"
@@ -23,6 +39,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .travis.yml
+- ChangeLog.md
 - Gemfile
 - LICENSE
 - README.md
@@ -30,12 +47,15 @@ files:
 - bin/mdpage
 - lib/mdpage.rb
 - lib/mdpage/default.html.erb
+- lib/mdpage/optparser.rb
+- lib/mdpage/page.rb
 - lib/mdpage/version.rb
 - mdpage.gemspec
-- spec/.gitignore
-- spec/mdpage_spec.rb
-- spec/sample.md
-- spec/sample2.md
+- test/sample.md
+- test/sample2.md
+- test/sample_cp932.md
+- test/test_helper.rb
+- test/test_mdpage.rb
 homepage: https://github.com/arafine/mdpage.git
 licenses: []
 post_install_message: 
@@ -61,8 +81,9 @@ signing_key:
 specification_version: 3
 summary: Simple styled document generator for markdown files
 test_files:
-- spec/.gitignore
-- spec/mdpage_spec.rb
-- spec/sample.md
-- spec/sample2.md
+- test/sample.md
+- test/sample2.md
+- test/sample_cp932.md
+- test/test_helper.rb
+- test/test_mdpage.rb
 has_rdoc: 

data/spec/.gitignore

@@ -1,2 +0,0 @@
-Gemfile.lock
-mdpage-*.gem

data/spec/mdpage_spec.rb

@@ -1,61 +0,0 @@
-$:.unshift(File.dirname(__FILE__) + "/../lib")
-require "mdpage"
-require "rspec"
-
-describe MdPage::Page do
-  before(:each) do
-    files = [
-      "#{File.dirname(__FILE__)}/sample.md"
-    ]
-    files2 = [
-      "#{File.dirname(__FILE__)}/sample.md",
-      "#{File.dirname(__FILE__)}/sample2.md"
-    ]
-    @mdp = MdPage::Page.new(files)
-    @mdp_invalid_enc = MdPage::Page.new(files2)
-  end
-
-  context 'path_chekc should be return true' do
-    it "as init with file path as Array" do
-      argv = ["#{File.dirname(__FILE__)}/sample.md"]
-      mdp = MdPage::Page.new(argv)
-      mdp.path_check.should == true
-    end
-
-    it "as init with invalid file path" do
-      argv = ["#{File.dirname(__FILE__)}/faff/sample.md"]
-      mdp = MdPage::Page.new(argv)
-      mdp.path_check.should == false
-    end
-
-    it "as init with one or more valid file path" do
-      argv = [
-        "#{File.dirname(__FILE__)}/sample.md",
-        "#{File.dirname(__FILE__)}/sample2.md"
-      ]
-      mdp = MdPage::Page.new(argv)
-      mdp.path_check.should == true
-    end
-
-    it "as init with one or more invalid file path" do
-      argv = [
-        "#{File.dirname(__FILE__)}/sample.md",
-        "#{File.dirname(__FILE__)}/rere/sample2.md"
-      ]
-      mdp = MdPage::Page.new(argv)
-      mdp.path_check.should == false
-    end
-  end
-
-  context 'Generating html objects' do
-    it "should be return Hash" do
-      @mdp.to_html_objects.class.should == Hash.new.class
-    end
-
-    it "result should be true as generate html files" do
-      @mdp.to_html_files
-      @mdp.result.should == true
-    end
-  end
-end
-

data/spec/sample.md

@@ -1,33 +0,0 @@
-# mdpage
-mdpage is a styled html generator for markdown files.
-
-## \*.md files should be encoded "utf-8"
-mdpage processes to assume utf-8 character encoding of the file.
-
-## customize
-if exist ~/.mdpage/default.html.erb , mdpage use your template.
-  
-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 
-  
-## Default css style
-
-# h1
-## h2
-### h3
-#### h4
-##### h5
-###### h6
-
-p
-
-table style|header|
------------|------|
-td         |td
-
->block quote
->block quote
-
-    def code_tag
-      puts "Hello mdpage"
-    end
-

data/spec/sample2.md

@@ -1,6 +0,0 @@
-# this is sample.md
-hgoehgoehgoeg
-
-## encoded cp932
-���{��
-