mamemose 0.2.1 → 0.3.0

data/README.md

@@ -9,19 +9,25 @@ mamemose: Markdown memo server
 - Markdown など軽量マークアップ言語で書かれたドキュメントを
   コマンド操作無しで勝手に HTML に変換してくれる
     - Sphinx などをそのまま使うのはコマンドを打つ手間があるので嫌だった
+- ローカルに余計なファイルができてほしくない
+    - Markdown から静的な HTML ファイルを生成するのは嬉しくない。
+      邪魔なファイルが増えるし、変換が自動化されていたとしても
+      何かの拍子に Markdown ファイルと HTML ファイルの同期が取れなくなりそうな気もする。
 - 複数マシンで内容を共有できる (Dropbox 等を使ってもよい)
+- マルチプラットフォーム (少なくとも Mac, Linux は必須)
 - 使い慣れたエディタを使える
 - 検索できる
-- できれば GitHub Flavored Markdown でシンタックスハイライトもしてほしい
-- できれば LaTeX で数式も書きたい
+- GitHub Flavored Markdown でシンタックスハイライトもしてほしい
+- LaTeX で数式も書きたい
 
 環境
 ----
 
+- Ruby 製
 - おもに Mac OS X 10.8 上の Ruby 1.9.3 でテスト
 - Ruby 1.8.7 でも動くようにした
-- Linux はおそらく大丈夫
-- Windows も、こないだ Cygwin 上で試したら動いたのでたぶん動くと思う
+- Linux は大丈夫
+- Windows も Cygwin 上でなら動くことは確認した
 
 インストール方法
 ----
@@ -39,13 +45,15 @@ $ gem install mamemose
 使い方
 ----
 
-設定ファイル (後述) を書いたら以下で起動
+設定ファイル (後述) を書いたら以下で起動。
+もしかしたら `~/.gem/*/bin` とか `/Library/Ruby/Gems/1.8/*/bin` あたりに
+パスを通す必要があるかも。
 
 ```bash
 $ mamemose &> /dev/null &
 ```
 
-ブラウザから
+するとローカルで HTTP サーバが立ち上がります。その後ブラウザから
 
 ```
 http://localhost:PORT/
@@ -54,12 +62,28 @@ http://localhost:PORT/
 にアクセスすればおｋ
 
 `DOCUMENT_ROOT` 以下の Markdown で書かれたテキストを勝手にHTMLに変換して表示します。
-一覧ページでは Markdown ドキュメントの1行目をタイトルとして読み込みます。
-
 `DOCUMENT_ROOT` を Dropbox 以下のディレクトリに指定しておけば、どのマシンからでも
 メモにアクセスできるようになります。
 
-文字コードは UTF-8 で書くようにしてください。
+- 一覧ページでは Markdown ドキュメントの1行目をタイトルとして読み込みます。
+- 文字コードは UTF-8 で書くようにしてください。
+- コマンドラインオプションは `mamemose help` で出ます。一応。
+
+### 一時ファイル閲覧
+
+一時的に `DOCUMENT_ROOT` で指定したディレクトリ以外にあるファイルを
+ブラウザで Markdown プレビューする機能があります。
+
+```bash
+$ mamemose s /path/to/file 8000
+```
+
+などとして `localhost:8000` にアクセスすると、
+`/path/to/file` を Mamemose サーバでレンダリングした HTML をブラウザから
+見ることができます。
+これによって GitHub などに置く Markdown ファイルを push する前に
+試しにブラウザから見ることができ、
+レンダリングの崩れなどがないかチェックできます。
 
 ### シンタックスハイライト
 
@@ -245,5 +269,12 @@ Jim     |   47
 Harry   |   32
 ```
 
-- 定義リストを書きたいんだけど
+- 定義リスト、 definition list, dl を書きたいんだけど
     - 無理らしいです。 HTML 直接書いてください。
+
+その他
+----
+
+ブログ的なエントリ
+
+- <http://daimatz.hateblo.jp/entry/2012/12/01/152725>

data/bin/mamemose

@@ -4,4 +4,31 @@ $:.unshift File.expand_path("../../lib", __FILE__)
 
 load 'mamemose.rb'
 
-Mamemose::Server.new.start
+require 'rubygems'
+require 'thor'
+
+class Mamemose::CLI < Thor
+  desc "server", "run the mamemose server"
+  desc "server filename port", "run the mamemose server for specified file"
+  def server(filename=nil, port=nil)
+    mamemose = Mamemose::Server.new(port)
+    if !filename && !port
+      mamemose.start
+    elsif filename && port
+      mamemose.file(filename)
+    else
+      puts "please specify filename and port"
+    end
+  end
+
+  desc "s", "alias of server"
+  alias :s :server
+
+  desc "version", "print version"
+  def version
+    puts Mamemose::VERSION
+  end
+end
+
+args = ARGV == [] ? ["s"] : ARGV
+Mamemose::CLI.start(args)

data/lib/mamemose/version.rb

@@ -1,3 +1,3 @@
 module Mamemose
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

data/lib/mamemose.rb

@@ -35,8 +35,13 @@ class HTMLwithSyntaxHighlighter < Redcarpet::Render::XHTML
 end
 
 class Mamemose::Server
-  def initialize
-    @server = WEBrick::HTTPServer.new({ :Port => PORT })
+  def initialize(port)
+    @server = WEBrick::HTTPServer.new({ :Port => port ? port.to_i : PORT })
+    trap(:INT){@server.shutdown}
+    trap(:TERM){@server.shutdown}
+  end
+
+  def start
     @server.mount_proc('/') do |req, res|
       res['Cache-Control'] = 'no-cache, no-store, must-revalidate'
       res['Pragma'] = 'no-cache'
@@ -47,23 +52,30 @@ class Mamemose::Server
       elsif File.directory?(fullpath(req.path)) then
         res = req_index(req, res)
       elsif File.exists?(fullpath(req.path))
-        res = req_file(req, res)
+        res = req_file(fullpath(req.path), res, false)
       else
         res.status = WEBrick::HTTPStatus::RC_NOT_FOUND
       end
     end
 
-    trap(:INT){@server.shutdown}
-    trap(:TERM){@server.shutdown}
+    @server.start
   end
 
-  def start
+  def file(filename)
+    @server.mount_proc('/') do |req, res|
+      res['Cache-Control'] = 'no-cache, no-store, must-revalidate'
+      res['Pragma'] = 'no-cache'
+      res['Expires'] = '0'
+      res = req_file(File.absolute_path(filename), res, true)
+      res.content_type = CONTENT_TYPE
+    end
+
     @server.start
   end
 
 private
 
-  def header_html(title, path, q="")
+  def header_html(title, path)
     html = <<HTML
 <!DOCTYPE HTML>
 <html>
@@ -214,6 +226,10 @@ function copy(text) {
 <body>
 #{CUSTOM_BODY}
 HTML
+    return html
+  end
+
+  def search_form(path, q="")
     link_str = ""
     uri = ""
     path.split('/').each do |s|
@@ -231,7 +247,7 @@ HTML
 <input type="submit" value="search" />
 </form>
 HTML
-    return html + "<div id=\"header\">#{link_str}#{search_form}</div>"
+    return "<div id=\"header\">#{link_str}#{search_form}</div>"
   end
 
   def footer_html(filepath=nil)
@@ -272,7 +288,10 @@ HTML
       value.each {|v| body += link_list(v[0], v[1])}
     end
 
-    res.body = header_html(title, uri(path), q) + markdown(body) + footer_html
+    res.body = header_html(title, uri(path))\
+             + search_form(uri(path), q)\
+             + markdown(body)\
+             + footer_html
     res.content_type = CONTENT_TYPE
     return res
   end
@@ -302,22 +321,27 @@ HTML
       body += File.read(index)
     end
 
-    res.body = header_html(title, req.path) + markdown(body) + footer_html(index)
+    res.body = header_html(title, req.path)\
+             + search_form(uri(req.path))\
+             + markdown(body)\
+             + footer_html(index)
     res.content_type = CONTENT_TYPE
     return res
   end
 
-  def req_file(req, res)
-    filename = fullpath(req.path)
+  def req_file(filename, res, fileonly)
     open(filename) do |file|
-      if markdown?(req.path)
+      if markdown?(filename)
         str = file.read
         title = get_title(filename, str)
-        res.body = header_html(title, req.path) + markdown(str) + footer_html(fullpath(req.path))
+        body = header_html(title, filename)
+        body += search_form(uri(filename)) if !fileonly
+        body += markdown(str) + footer_html(filename)
+        res.body = body
         res.content_type = CONTENT_TYPE
       else
         res.body = file.read
-        res.content_type = WEBrick::HTTPUtils.mime_type(req.path, WEBrick::HTTPUtils::DefaultMimeTypes)
+        res.content_type = WEBrick::HTTPUtils.mime_type(filename, WEBrick::HTTPUtils::DefaultMimeTypes)
         res.content_length = File.stat(filename).size
       end
     end

data/mamemose.gemspec

@@ -17,4 +17,5 @@ Gem::Specification.new do |gem|
 
   gem.add_dependency "redcarpet", ">= 2.2.0"
   gem.add_dependency "htmlentities", ">= 4.3.0"
+  gem.add_dependency "thor"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mamemose
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-24 00:00:00.000000000 Z
+date: 2013-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redcarpet
@@ -43,6 +43,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 4.3.0
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Markdown memo server
 email:
 - dai@daimatz.net
@@ -82,7 +98,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Markdown memo server