RubyGems - madowu - Versions diffs - 0.0.2 → 0.0.3 - Mend

madowu 0.0.2 → 0.0.3

Files changed (29) hide show

checksums.yaml +4 -4
data/CHANGES +20 -1
data/Gemfile +3 -3
data/VERSION +1 -1
data/bin/dirmap +33 -9
data/bin/madowu +7 -3
data/bin/tex2image +72 -0
data/doc/.dirmap.md +9 -0
data/doc/.gitignore +2 -0
data/doc/Rakefile +109 -0
data/doc/index.md +166 -0
data/doc/madowu.css +624 -0
data/example/.gitignore +2 -0
data/example/Rakefile +71 -36
data/example/eq.tex +9 -0
data/example/index.md +3 -0
data/example/madowu.css +11 -2
data/example/subdir/Rakefile +109 -0
data/example/subdir/madowu.css +624 -0
data/example/subdir/subdir2/Rakefile +109 -0
data/example/subdir/subdir2/madowu.css +624 -0
data/example/tex2image/.gitignore +2 -0
data/example/tex2image/eq.tex +9 -0
data/lib/madowu/directorymapper.rb +9 -9
data/lib/madowu/htmlgenerator.rb +52 -18
data/madowu.gemspec +26 -13
data/test/test_directorymapper.rb +24 -15
data/test/test_htmlgenerator.rb +106 -41
metadata +31 -17

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 842434c81b4af71f9c00d84b50b2a73c390431ec
-  data.tar.gz: b787fd00346ef0fc5f825b28fbadf03640b7e4fd
+  metadata.gz: e3caa7db7adf2f71986d61b394cfed755b9e7bf8
+  data.tar.gz: 3d92c808e7a437ec6e6002c84de71e4eebf205ce
 SHA512:
-  metadata.gz: f467f49afb17e46c71e2ffaa50b617b3e55d5e7973e28b5553550376217ae9e6eecd48d0fc75bcd6bd1a6866d2fbc800395fd1435fc19f98864a0a5e479a7579
-  data.tar.gz: 93fd286befa44549ea9e76a0431ea28c40540a840dd133dd03966a9fc5ff46bfe668d541d352eca9ed86c579f4a950dd42211a4c2c1eab221e3c7f1f189a83b5
+  metadata.gz: 951ddcc593d512e5494804a424b7fd1c1247d529db51bad07a8f514eb622237dc3985aa4a7efd043b9e7d43bef4a85146a54b04b47acb079e8434b91752ba297
+  data.tar.gz: 9604056e05272c4fdc943a1cede76b53107604b572265b50a58d2b3dde76b2210b0d0e414916b133f619377e9a41285074ebfd86eedc380827edfed7cbe2dc0c

data/CHANGES CHANGED Viewed

@@ -1,6 +1,25 @@
 = THIS_GEM changelog
-== Master (for 0.0.3)
+== Master (for 0.0.4)
+== Version 0.0.3 [2016-02-26]
+* bin/
+    * modify 'madowu' command
+        * add -O (--outline-selflink) option.
+        * remove '--side-map' option.
+        * modify '--side=file' to deal with Markdown format file instead of HTML.
+        * modify '--outline' to outputs layering itemization.
+    * add 'tex2image' command
+    * modify 'bin/dirmap' command to outputs Markdown format.
+* 'example/Rakefile'
+    * add 'subdir' target
+    * modify target from **/*.md to *.md in default target
+    * add 'tex2image' target
+    * modify 'default' target to include 'tex2image' target
+    * modify 'md2html' target to detect file existence change.
+    * modify html files to depend on .dirmap.md updated.
+* doc/ is included( in Japanese).
+* lib/htmlgenerator.rb, <HTML> header to <html> in HtmlGenerator.generate
 == Version 0.0.2 [2015-10-20]
 * Add -C (--charset) option and default encoding is set to be 'us-ascii'

data/Gemfile CHANGED Viewed

@@ -6,9 +6,9 @@ source "http://rubygems.org"
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
 group :development do
+  gem "test-unit", "~> 3.1"
   gem "rdoc", "~> 4.2"
-  gem "bundler", "~> 1.0"
+  gem "bundler", "~> 1.11"
   gem "jeweler", "~> 2.0"
-  gem "simplecov", "~> 0"
-  gem "test-unit", "~> 3.1"
+  gem "simplecov", "~> 0.11"
 end

data/VERSION CHANGED Viewed

	@@ -1 +1 @@
1	- 0.0.2
1	+ 0.0.3

data/bin/dirmap CHANGED Viewed

@@ -1,30 +1,54 @@
 #! /usr/bin/env ruby
 # coding: utf-8
+DEFAULT_OUTFILE = '.dirmap.md'
 require "optparse"
 require "pathname"
 require "pp"
 require "madowu"
 ### option analysis
-OPTIONS = {}
+options = {}
 op = OptionParser.new
 op.banner = [
-  "Usage: #{File.basename("#{__FILE__}")} dir_path",
-  "   Note that indicate directory, not file."
+  "Usage: #{File.basename("#{__FILE__}")} [dir_path]",
+  "   Note that indicate directory, not file.",
+  "   Default 'dirpath' is '.'"
 ].join("\n")
-#op.on("-a"    , "--aho"    , "descriptionA"){    OPTIONS[:aho] = true}
-#op.on("-b val", "--bak=val", "descriptionB"){|v| OPTIONS[:bak] = v}
-#op.parse!(ARGV)
+op.on("-v"    , "--verbose"    , "Output to stdout too"){ options[:verbose] = true}
+op.on("-f"    , "--force"      , "Force output"){ options[:force] = true}
+#op.on("-a"    , "--aho"    , "descriptionA"){    options[:aho] = true}
+#op.on("-b val", "--bak=val", "descriptionB"){|v| options[:bak] = v}
+op.parse!(ARGV)
-unless ARGV.size == 1
+if ARGV.size > 1
   puts op.banner
   exit
 end
-unless FileTest.directory? ARGV[0]
+dir = ARGV[0] || '.'
+unless FileTest.directory? dir
   puts op.banner
   exit
 end
-puts Madowu::DirectoryMapper.dirmap(ARGV[0])
+def should_update?(options, outfile, new_contents)
+  return true if options[:force]
+  return true unless FileTest.exist? outfile
+  old_contents = File.open(outfile, "r").readlines.map{|i| i.chomp}
+  return false if old_contents == new_contents
+  return true
+end
+outfile = DEFAULT_OUTFILE
+contents = Madowu::DirectoryMapper.dirmap(dir)
+if should_update?(options, outfile, contents)
+  io = File.open(outfile, 'w')
+  io.puts contents
+  puts contents if options[:verbose]
+end

data/bin/madowu CHANGED Viewed

@@ -15,13 +15,17 @@ OPTIONS = {}
 op = OptionParser.new
 op.banner = [
   "Usage: #{File.basename("#{__FILE__}")} [options] foo.md",
-  "      You can see help with '#{File.basename("#{__FILE__}")} --help'.",
+  "       You can see help with '#{File.basename("#{__FILE__}")} --help'.",
 ].join("\n")
 op.on("-c css_file", "--css=file", "Indicate css file"){|v| OPTIONS[:css] = v}
 op.on("-C charset", "--charset=str", "Indicate charset like 'UTF-8'"){|v| OPTIONS[:charset] = v}
 op.on("-o"    , "--outline"    , "Embed outline"){    OPTIONS[:outline] = true}
-op.on("-d"    , "--dirmap-side", "Embed sideber of directory map"){OPTIONS[:dirmap] = true}
-op.on("-s file"    , "--side", "Read file for sidebar"){|v|OPTIONS[:sidebar] = v}
+op.on("-O"    , "--outline-selflink", "Embed outline with link to the line"){
+  OPTIONS[:outline] = true
+  OPTIONS[:selflink] = true
+}
+#op.on("-d"    , "--dirmap-side", "Embed sideber of directory map"){OPTIONS[:dirmap] = true}
+op.on("-s file"    , "--side=md_file", "Read Markdown file for sidebar"){|v|OPTIONS[:sidebar] = v}
 op.on("-m markdown"    , "--markdown=command", "Indicate Markdown command"){|v| OPTIONS[:markdown] = v}
 op.parse!(ARGV)

data/bin/tex2image ADDED Viewed

@@ -0,0 +1,72 @@
+#! /usr/bin/env ruby
+# coding: utf-8
+#
+# TODO
+#   完結した tex としてコンパイル
+#   document 環境としてコンパイル
+#   equation 環境としてコンパイル
+#   eqnarray 環境としてコンパイル。開始式番号指定
+DEFAULT_DENSITY = 150
+USAGE = <<HERE
+  Usage: #{File.basename("#{__FILE__}")} tex_file
+  Default:
+    - Output png image.
+    - Density for conversion is #{DEFAULT_DENSITY}.
+HERE
+LATEX    = 'latexmk'
+CONVERT = 'convert'
+require "optparse"
+require "pp"
+require "pathname"
+require "fileutils"
+## option analysis
+options = {}
+op = OptionParser.new
+op.banner = USAGE
+op.on("-j"    , "--jpg"    , "Output jpg image, alternative to png."){ options[:img] = :jpg}
+op.on("-d val", "--density=val", "Set density for raster conversion"){|v| options[:density] = v}
+op.parse!(ARGV)
+options[:img] ||= :png
+img_ext = options[:img].to_s
+density = DEFAULT_DENSITY
+density = options[:density].to_i if options[:density]
+def execute(commands)
+  commands.each do |c|
+    puts c
+    system c
+  end
+end
+if ARGV.empty?
+  puts "Need one tex file in argument. Exit."
+  puts USAGE
+  exit
+end
+tex_file = ARGV[0]
+dvi_file = Pathname(tex_file).sub_ext(".dvi").to_s
+img_file = Pathname(tex_file).sub_ext(".#{img_ext}").to_s
+commands = []
+commands << "#{LATEX} #{tex_file} > /dev/null"
+commands << "#{CONVERT} -trim -density #{density}x#{density} #{dvi_file} #{img_file}"
+execute(commands)
+commands = []
+trash_exts = [ 'aux', 'dvi', 'fdb_latexmk', 'fls', 'log']
+trash_exts.each do |ext|
+  file = Pathname(tex_file).sub_ext(".#{ext}").to_s
+  FileUtils.rm file if File.exist? file
+end

data/doc/.dirmap.md ADDED Viewed

@@ -0,0 +1,9 @@
+Parent directory:
+* [../](../)
+Current directory:
+* [Rakefile](Rakefile)
+* [index.html](index.html) (Madowu, MArkDOWn to markUp)
+* [madowu.css](madowu.css)

data/doc/.gitignore ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ *.html
2	+ **/.dirmap.md

data/doc/Rakefile ADDED Viewed

@@ -0,0 +1,109 @@
+# coding: utf-8
+# Rakefile for Markdown documents.
+DIRMAP_MD = '.dirmap.md'
+ENCODING = "UTF-8"
+HTML2PDF = "wkhtmltopdf"
+TEX2IMAGE = "tex2image"
+HTML2PDF_OPTIONS = "-B 1cm -L 1.5cm -R 1.5cm -T 1.5cm -s A4 --encoding #{ENCODING} "
+CONVERT_COMMAND = "convert -alpha deactivate -density 150x150"
+require "pp"
+require "fileutils"
+require "pathname"
+## .dirmap.md
+# dirmap コマンドは必ず実行なので task タスク。
+# これを file にすると存在するときに実行されない。
+# 生成物の .dirmap.md から task タスクへの依存を設定すると、
+# .dirmap.md に依存する file タスクに「必ず実行」が伝播して必ず実行になってしまう。
+# DIRMAP_MD というファイルに対する file タスクへの依存として扱うことで、
+# .dirmap.md に依存する file タスクに「必ず実行」が伝播するのを防いでいる。
+desc "update .dirmap.md if directory changed."
+file DIRMAP_MD => :dirmap_command
+task :dirmap_command do
+  sh "dirmap"
+end
+## *.html
+md_files = FileList["*.md"]
+html_files = md_files.ext("html")
+html_tasks = []
+html_files.each do |html_file|
+  md_file = html_file.ext("md")
+  md_path = Pathname.new( md_file)
+  dirpath = md_path.dirname
+  src = FileList[md_file, DIRMAP_MD]
+  file html_file => [DIRMAP_MD, md_file] do
+    sh "madowu -O -s .dirmap.md -c madowu.css -C UTF-8 #{md_file}"
+  end
+  html_tasks << html_file
+end
+desc "make *.html from *.md"
+task :md2html => [DIRMAP_MD, * html_tasks]
+desc "make *.pdf from *.html"
+pdf_files = html_files.ext("pdf")
+task :html2pdf => FileList[pdf_files]
+pdf_files.each do |pdf_file|
+  html_file = pdf_file.ext("html")
+  file pdf_file => html_file do
+    sh "#{HTML2PDF} #{HTML2PDF_OPTIONS} #{html_file} #{pdf_file}"
+  end
+end
+desc "make .png from .eps."
+eps_files = FileList["*.eps"]
+png_files = eps_files.ext("png")
+task :eps2png => FileList[png_files]
+png_files.each do |png_file|
+    eps_file = png_file.ext("eps")
+    t = [eps_file]
+    file png_file => t do
+        sh "#{CONVERT_COMMAND} #{eps_file} #{png_file}"
+    end
+end
+desc "make *.png from *.tex"
+tex_files = FileList["*.tex"]
+png_files = tex_files.ext("png")
+task :tex2png => FileList[png_files]
+png_files.each do |png_file|
+  tex_file = png_file.ext("tex")
+  file png_file => tex_file do
+    #pp png_file, tex_file; exit
+    sh "#{TEX2IMAGE} #{tex_file}"
+  end
+end
+# recursive だと、サブディレクトリの Rakefile も
+# recursive ターゲットを持っているという前提が必要。
+desc "execute 'rake' in all subdirs with Rakefile"
+rakefiles = FileList["**/Rakefile"]
+dirs = rakefiles.map{|path| Pathname.new(path).dirname.to_s}
+dirs.delete_if {|i| i == '.' }
+dirs.map!{|path| File.absolute_path(path)}
+task :subdir do
+  dirs.each do |dir|
+    Dir.chdir dir
+    system "rake"
+  end
+end
+task :all => [:md2html, :subdir]
+task :pdf => :html2pdf
+#task :default => [:tree, :tex2png, :eps2png]
+task :default => [:md2html, :tex2png, :eps2png]
+require "rake/clean"
+CLEAN.include( [
+  html_files,
+  pdf_files,
+])

data/doc/index.md ADDED Viewed

@@ -0,0 +1,166 @@
+<!-- vim:syntax=markdown
+-->
+# Madowu, MArkDOWn to markUp
+「まどう」と読みます。
+Markdown で書かれたドキュメントを、
+ヘッダフッタ付きのちゃんとした HTML にします。
+なお、このページは madowu によって生成されています。
+## インストール
+    gem install madowu
+## 基本的な動作
+一つの md ファイルを受け取り、
+拡張子を html に変更したファイルを生成します。
+元々存在しても、確認なしに上書きします。
+`madowu *.md` のように 複数ファイルを一度に扱えるようにはしていません。
+今のところ、これは make や rake が分担すべき仕事だと考えています。
+## HTML head の title 要素
+HTML ではファイルで表現される文書のタイトルを
+head 要素の title 要素で指定しますが、
+markdown ではこれを指定する方法がありません。
+Madowu では、md ファイル内で現れる最初の見出し(「#」で始まる行。レベルは1と限らない)
+をページ全体のタイトルとして扱います。
+すなわち、Madowu ではファイル内に h1 要素を生成するレベル1 の
+「#」が 1つだけであり、これが全ての見出しの中で最初に出現することを想定しています。
+## オプション
+    madowu -h
+でヘルプが出ます。
+### -o オプション, outline を埋め込む
+見出しをまとめた outline を body の先頭に埋め込みます。
+markdown 処理されたマークアップテキストに、さらにアンカーとリンクを追加します。
+スタイルシートを適切に準備しておけば幸せになれるでしょう。
+example/madowu.css を参考にされると良いでしょう。
+また、一度 example で rake を実行し、
+ブラウザで生成された html 群を見てみると良いと思います。
+### -O オプション, タイトル行そのものをその行へのリンクにする。
+-o の機能に追加して、タイトル行そのものをその行へのリンクにします。
+### -d オプション, sidebar にディレクトリマップを埋め込む
+ファイルが存在するディレクトリ周囲のファイルへのリンクをまとめ、sidebar に配置します。
+親ディレクトリ、同一ディレクトリ内のエントリの2種類に分類します。
+ディレクトリへのリンクに関しては、index.html or index.md があれば index.html
+へのリンクを作り、存在しなければ ディレクトリ自体にリンクします。
+同一ディレクトリのファイルは、`foo.md` は `foo.html` になるものとして、html の名前でリンクを生成します。
+また、md もしくは html ファイルでタイトル相当の情報があれば、
+これを 括弧内で補助的に表示します。
+これも、
+スタイルシートを適切に準備しておけば幸せになれるでしょう。
+### -c オプション, css ファイル指定
+html 表示に適用するスタイルシートのパスを指定します。
+元となる markdown ファイルのパスと指定された css ファイルのパスとの
+相対パスに変換して埋め込みます。
+### -C オプション, charset 指定
+HTML ヘッダで指定するファイルの文字エンコーディングを指定します。
+指定しない場合のデフォルト値は US-ASCII です。
+### -s オプション
+サイドバーに埋め込む内容のファイルを指定します。
+このファイルを Markdown 処理して埋め込みます。
+### -m オプション
+使用する markdown コマンドを指定します。
+方言を含む markdown like な処理系を指定することも可能です。
+## 支援コマンド
+### tex2image
+LaTeX の出力を画像にします。
+数式の貼り込みなどに便利だと思います。
+デフォルトでは png 形式で書き出します。
+* -j, --jpg オプション。png ではなく、jpg 形式で書き出します。
+* -d, --density=val オプション。解像度を指定します。
+### dirmap
+親子関係で隣接したディレクトリへのリンクを表す .dirmap.md ファイルを Markdown
+形式で書き出します。
+.dirmap.md と内容に変更がなければ書き出さず、タイムスタンプを維持します。
+## example
+ウェブサイトのように、ディレクトリ丸々 markdown から html に変換するような場合に
+使える Rakefile のサンプルが example/ 以下にあります。
+とりあえず rake して生成される index.html と
+他の html を見るとだいたい感じがつかめると思います。
+<!--
+### ディレクトリ更新の追従
+この Rakefile では html ファイル生成が md ファイルのみに依存するようになっている
+ため、
+ディレクトリへのファイルの追加・削除のみがあった場合には自動的にそれを補うように
+更新されません。
+そのため、このような目的のためには手動で強制的に html を生成する必要があります。
+#### このような仕様になっている理由
+ディレクトリに依存するとして Rakefile を記述すると、追加・削除がなくとも、
+どれか一つのファイルを更新する度にディレクトリ内のファイルが全て madowu 処理
+されることになります。
+ディレクトリ内のファイルエントリが変更されなければディレクトリのタイムスタンプ
+は本来更新されないのですが、
+vim や emacs は foo.swp のようなスワップファイルを生成・削除するため、
+ディレクトリのタイムスタンプが更新されてしまいます。
+ファイル編集は通常エディタで行うことが想定されますので、
+この挙動は受け入れるべきです。
+そのため、1つのファイルを更新すると同時にディレクトリの更新時刻も更新され、
+そのディレクトリに依存する全ての html ファイルの更新が必要と判断されるということになります。
+ところが、このような挙動は多数の `*.md` ファイルが存在するディレクトリで
+1つのファイルを更新しても、
+rake をかけるたびに全てのファイルを更新することになり、
+確認しながらの編集がストレスフルなものとなってしまいます。
+このデメリットが
+ディレクトリ更新を自動的に補足するメリットよりも大きいと判断したため、
+example/Rakefile ではディレクトリのタイムスタンプは見ない、
+という仕様に今のところなっています。
+.dirmap.html のようなファイルを生成して
+これを読み込むようにもしてみたことがありますが、
+この場合もディレクトリの更新時刻が更新されます。
+毎回 .dirmap.html が更新されるので、毎回全てのファイルが更新されてしまいます。
+.dirmap.html を生成しておいて、
+ファイル内容をチェックし、変更があればこれを更新、というのは一つの手かもしれません。
+しかし、挙動が複雑な割に得られるメリットが少ない気がします。
+-->
+### 再帰的なターゲッティング
+この Rakefile では `**.md` のように
+1つの Rakefile で再帰的にターゲッティングしていますが、
+運用によってはこのようにせず、各ディレクトリで Rakefile を配置する方が良いかもしれません。
+## 関連プログラム
+freestyle wiki からのデータ移動を考えている方は、
+tefil に同梱してある fswiki2md が少し便利かもしれません。
+<script>
+  (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+  (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+  m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+  })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
+  ga('create', 'UA-68497868-1', 'auto');
+  ga('send', 'pageview');
+</script>