mok2html 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 672a1059796350c2ca98c7f1cd4da526d1579941
-  data.tar.gz: f6dfb30ba91f4de1ee9d32ab9395f9ef08ba60ec
+  metadata.gz: 1e23b6f6138a4925170d9cf76b33cd2d6c9f1c52
+  data.tar.gz: 8b1ab1477dd107cb4f19366d19cdc884ece41afb
 SHA512:
-  metadata.gz: 5048659cf78ca90f8ef2f6745a1c09e9bccde777aedbf13e46558de490c621b28a11f5dc7fe9fb799a2da87206b8a38742e208f3f6e086003625dd31c283b97d
-  data.tar.gz: e4edc8755fd7a2d443b7db87bd9dafe648e73f767bbc5bb2647e9d64ff9e7318b260c317f7f71f5d74dce0b4fda22856ee4439da7291b00dfc0180c705230c65
+  metadata.gz: a4ac12b4c76e67f868c5190fcb9c0b3c3da4ee1eecb64c8f40e47a9d91da4b5ccb829821c1df0b0694df959b5406faec35bc4cedd1b6480cdddbc969d14d90ea
+  data.tar.gz: 016a2b03a55cd670ab5510b4e174ec7042092081b3f7e12ee1b476c9307cca633ffac0044528e6d3501182be8fce0140b4adcbee1710f93358783599f2403ffe

data/Gemfile.lock

@@ -1,14 +1,14 @@
 PATH
   remote: .
   specs:
-    mok2html (0.1.1)
-      mok-parser (>= 0.3.1)
+    mok2html (0.1.2)
+      mok-parser (>= 0.3.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
     mimemagic (0.2.1)
-    mok-parser (0.3.1)
+    mok-parser (0.3.2)
       mimemagic
     rake (10.1.0)
 

data/History.rdoc

@@ -1,3 +1,8 @@
+== 0.1.3 (2013-12-21)
+* new: variable_file と partial_base_directory の設定を追加
+* change: 設定をシステム(/etc/mok)とユーザ(~/.mok)の2箇所で指定できるように
+* change: コマンドラインオプションを整理
+
 == 0.1.2 (2013-12-14)
 ~/.mok2html.yaml が必須になっていたのを、オプションに変更
 

data/RELEASE

@@ -1 +1 @@
-2013-12-14
+2013-12-21

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.1.3

data/bin/mok2html

@@ -7,8 +7,23 @@ require "yaml"
 require "optparse"
 require "mok2html"
 
-# デフォルトの設定値
-options = {:css => "", :js => "", :reference_extension => '.html', :reference_base_directory => "", :media_base_directory => "", :custom_element => "" , :language => 'ja', :config => '~/.mok2html.yaml', :index => true, :quiet => false}
+# デフォルト設定値
+options = {
+  :config              => ["/etc/mok/mok.yaml", "/etc/mok/mok2html.yaml",
+                           "~/.mok/mok.yaml",   "~/.mok/mok2html.yaml"],
+  :css                 => "",
+  :javascript          => "",
+  :reference_extension => ".html",
+  :reference_directory => "",
+  :partial_directory   => "",
+  :media_directory     => "",
+  :variable            => ["/etc/mok/variable.yaml","~/.mok/variable.yaml"],
+  :language            => "ja",
+  :index               => true,
+  :quiet               => false,
+  :custom_element      => "" ,
+}
+options_default = options
 
 # 使い方
 def usage(opt)
@@ -16,47 +31,83 @@ def usage(opt)
   exit 0
 end
 
-def set_config_by_file(file, options)
-  file_path = File.expand_path(file)
-  return options unless  File.exist?(file_path)
-  config = YAML.load_file( file_path )
-  if config
-    options.each do |key,val|
-      options[key.to_sym] = config[key.to_s] unless config[key.to_s].nil?
+# 設定ファイルの読み込み
+def set_config_by_file(files,options)
+  files.each do |file|
+    file_path = File.expand_path(file)
+    next unless  File.file?(file_path)
+    config = YAML.load_file( file_path )
+    if config
+      options.each do |key,val|
+        options[key.to_sym] = config[key.to_s] unless config[key.to_s].nil?
+      end
     end
   end
   options
 end
 
+# 設定内容の表示
+def show_config(options)
+  options.each do |key, val|
+    next if key == :show_config or key == :src_file
+    puts "#{key.to_s.ljust(20)}: #{Array(val).join(',')}"
+  end
+  exit 0
+end
+
+# mok-parser のバージョンを表示
+def mok_parser_version
+  "mok-parser #{Mok::VERSION} (#{Mok::RELEASE})"
+end
+
+# 設定ファイル
+unless ARGV.find {|val| val == "--no-config"}
+  options = set_config_by_file(options[:config], options)
+end
+
 # コマンドラインオプション
 opt = OptionParser.new do |opt|
-  opt.banner = "Usage: mok2html [options] file"
   opt.version = Mok::Mok2Html::VERSION
   opt.release = Mok::Mok2Html::RELEASE
-  opt.on("-c", "--css file[,file,..]", "HTMLに埋め込むスタイルシートを指定") {|f| options[:css] = f}
-  opt.on("-j", "--javascript file[,file,..]", "HTMLに埋め込むJavaScriptを指定") {|f| options[:js] = f}
-  opt.on("-L", "--language LANG", "言語(デフォルトは #{options[:language]} 。ドキュメント側で指定されていればそちらを優先)"){|l| options[:language] = l}
-  opt.on("--[no-]config [file]", "設定ファイルを指定、または設定ファイルを使用しない(デフォルト:~/.mok2html)"){|v| options[:config] = v }
-  opt.on("--[no-]index", "目次を生成する(デフォルトは生成する)"){|v| options[:index] = v }
-  opt.on("--[no-]metadata", "メタ情報を出力しない(デフォルトは出力する)"){|v| options[:metadata] = v }
-  opt.on("-q","--quiet", "本文だけを出力する(ヘッダやフッタは出力しない)"){ options[:quiet] = true }
-  opt.on("-s","--reference_extension string", "リファレンス記法で「.%」を置換する拡張子(デフォルト .html)"){|s| options[:reference_extension] = s }
-  opt.on("-R", "--reference_base_directory directory", "リンク記法((<..>))のファイルを配置する基底ディレクトリ(デフォルト:なし)"){|d| options[:media_base_directory] = d }
-  opt.on("-M", "--media_base_directory directory", "画像や動画などのメディア記法(($..$))のファイルを配置する基底ディレクトリ(デフォルト:なし)"){|d| options[:media_base_directory] = d }
+  opt.on("-c", "--css file[,file,..]", "HTMLに埋め込むスタイルシートを指定(デフォルト:なし)") {|f| options[:css] = f}
+  opt.on("-j", "--javascript file[,file,..]", "HTMLに埋め込むJavaScriptを指定(デフォルト:なし)") {|f| options[:javascript] = f}
+  opt.on("-l", "--language LANG", "言語(デフォルト:#{options[:language]} 。ドキュメント側で指定した場合はそちらを優先)"){|l| options[:language] = l}
+  opt.on("--no-config", "設定ファイル(#{options[:config]})を使用しない"){|v| options[:config] = v }
+  opt.on("--variable file", "ドキュメント内変数((@..@))の外部定義ファイル(デフォルト:なし)"){|v| options[:variable] = v }
+  opt.on("--[no-]index", "目次を生成する/しない(デフォルト:する)"){|v| options[:index] = v }
+  opt.on("--[no-]metadata", "メタ情報を出力する/しない(デフォルト:する)"){|v| options[:metadata] = v }
+  opt.on("-q","--quiet", "ヘッダやフッタを除いた本文のみを出力する(デフォルト:しない)"){ options[:quiet] = true }
+  opt.on("-e","--reference_extension string", "リファレンス修飾((<..>)で最後の「.%」を置換する拡張子(デフォルト:.html)"){|s| options[:reference_extension] = s }
+  opt.on("-R", "--reference_directory directory", "リンク修飾((<..>))のファイルを配置するディレクトリ(デフォルト:なし)"){|d| options[:media_directory] = d }
+  opt.on("-M", "--media_directory directory", "メディア修飾(($..$))で画像や動画などのファイルを配置するディレクトリ(デフォルト:なし)"){|d| options[:media_directory] = d }
+  opt.on("-P", "--partial_directory directory", "部分テンプレート(partial)記法((!..!))のファイルを配置するディレクトリ(デフォルト:変換元ファイルのカレントディレクトリ)"){|d| options[:partial_directory] = d }
   opt.on("--custom_element file", "HTMLタグをカスタマイズするためのRubyファイル)"){|f| options[:custom_element] = f }
-  opt.on("-V","--parser-version", "使用する mok-parser のバージョンを表示"){
-    puts "mok-parser: #{Mok::VERSION} (#{Mok::RELEASE})"
-    exit 0
-  }
-end
-opt.parse!(ARGV)
+  opt.on("-s","--show-config", "現在の設定値を表示"){|flg| options[:show_config] = true }
+  opt.on("-S","--show-config-default", "mok2htmlのデフォルト設定値を表示"){ show_config options_default }
+  opt.on("-v","--version", "mok2htmlのバージョンを表示"){ puts opt.ver ; exit 0 }
+  opt.on("-V","--parser-version", "使用する mok-parser のバージョンを表示"){ puts mok_perser_version ; exit 0 }
+  opt.banner = <<EOL
+#{opt.ver}
 
-usage(opt) unless ARGV[0]
+== Usage
+$ mok2html [options] file
+
+== Description
+"mok2html" is mok document to HTML converter.
+Read more: https://github.com/garin/mok2html
 
-# config file
-options = set_config_by_file(options[:config], options) if options[:config]
+== Parser
+#{mok_parser_version}
+
+== Options
+EOL
+end
+opt.parse!(ARGV)
 
 # main
+options[:src_file] = ARGV[0]
+show_config(options) if options[:show_config] # 設定内容の表示
+usage(opt) unless ARGV[0]
 src = File.open(ARGV[0],"r").readlines
 mok = Mok::Mok2Html.new(src, options)
 puts mok.to_html

data/conf/mok2html.yaml.sample

@@ -0,0 +1,50 @@
+# = mok2html.yaml.sample
+# mok2html 設定ファイルのサンプル
+#
+# == 使い方
+# ~/.mok/mok2html.yaml にファイルを置き、必要な設定を記述します。
+#  $ mkdir ~/.mok
+#  $ cp mok2html.yaml.sample ~/.mok/mok2html.yaml
+#  $ vi ~/.mok2html.yaml
+#
+#
+# == 設定項目
+# コンバート時にHTMLファイルに埋め込むスタイルシート(デフォルト:なし)
+#css:
+#  - "~/doc/mok/css/bootstrap.css"
+#  - "~/doc/mok/css/prettify.css"
+#  - "~/doc/mok/css/_document.css"
+#
+# コンバート時にHTMLファイルに埋め込むjavascript(デフォルト:なし)
+#javascript:
+#  - "~/doc/mok/js/jquery.js"
+#  - "~/doc/mok/js/bootstrap.js"
+#  - "~/doc/mok/js/prettify.js"
+#  - "~/doc/mok/js/prettify_onload.js"
+#
+# リファレンス修飾((<..>)で最後の「.%」を置換する拡張子( デフォルト:.html)
+#reference_extension: ".html"
+#
+# リンク修飾((<..>))のファイルを配置するディレクトリ(デフォルト:なし)
+#reference_directory: ""
+#
+# メディア修飾(($..$))で画像や動画などのファイルを配置す るディレクトリ(デフォルト:なし)
+#media_directory: "/usr/local/media"
+#
+# 部分テンプレート(partial)記法((!..!))のファイルを配置するディレクトリ(デフォルト:変換元ファイルのカレントディレクトリ)
+#partial_directory:
+#
+# HTMLタグをカスタマイズするためのRubyファイル(デフォルト:なし)
+#custom_element: "/home/myname/mok2html/mycustom.rb"
+#
+# ドキュメントのフォーマット(デフォルト:ja)
+#language: "ja"
+#
+# 目次(index)を作成するかどうか(デフォルト: true)
+#index: true
+#
+# メタデータを作成するかどうか(デフォルト: true)
+#metadata: true
+#
+# HTMLヘッダを出力((*しない*))かどうか(デフォルト: false)
+#quiet: false

data/lib/mok2html.rb

@@ -3,6 +3,7 @@
 # See the included file COPYING for details.
 require "mok2html_element"
 require "cgi"
+require "yaml"
 
 module Mok
   class Mok2Html
@@ -13,14 +14,15 @@ module Mok
       @debug = true
 
       # options
-      @css = files_to_str(options[:css])
-      @js  = files_to_str(options[:js])
-      @language = options[:language]
-      @index = options[:index]
-      @metadata = options[:metadata]
-      @quiet = options[:quiet]
-
+      @css        = files_to_str(options[:css])
+      @javascript = files_to_str(options[:javascript])
+      @language   = options[:language]
+      @index      = options[:index]
+      @metadata   = options[:metadata]
+      @quiet      = options[:quiet]
+      options[:variables] = get_variables(files_to_str(options[:variable], true))
       get_customized_element(options[:custom_element]) unless options[:custom_element].empty?
+
       @mok = BlockParser.new(options)
       @metadata = setup_metadata
       @nodes = @mok.parse src
@@ -28,14 +30,23 @@ module Mok
 
     # 複数ファイルの文字列を返す
     # files: ファイルの配列または","区切り文字列
-    def files_to_str(files = [])
+    # ignore: ファイルが存在しない時に無視する
+    def files_to_str(files = [], ignore = false)
       files = files.split(",") unless defined? files.each
       files.map do |f|
         path = File.expand_path(f.strip)
+        unless File.exist? path
+          next if ignore
+        end
         File.open(path).readlines.join + "\n" unless path.empty?
       end.join
     end
 
+    # variables を生成する
+    def get_variables(str = "")
+      YAML.load( str )
+    end
+
     # エレメントのカスタム用ファイルを読み込む
     def get_customized_element(file)
       require File.expand_path(file)
@@ -133,15 +144,19 @@ module Mok
 EOL
       str += css
       str += javascript
+      str += "<title>#{CGI.escapeHTML(@metadata[:subject])}</title>" unless @metadata[:subject].nil?
       str += <<EOL
-  <title>#{CGI.escapeHTML(@metadata[:subject])}</title>
   </head>
 <body>
 EOL
     end
 
     def header_title
-      "<h1>#{CGI.escapeHTML(@metadata[:subject])}</h1>\n"
+      unless @metadata[:subject].nil?
+        "<h1>#{CGI.escapeHTML(@metadata[:subject])}</h1>\n"
+      else
+        ""
+      end
     end
 
     def css
@@ -152,7 +167,7 @@ EOL
 
     def javascript
       str = ""
-      str += %[<script type="text/javascript">#{@js}</script>\n] unless @js.empty?
+      str += %[<script type="text/javascript">#{@javascript}</script>\n] unless @javascript.empty?
       str
     end
 

data/mok2html.gemspec

@@ -17,5 +17,5 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
-  spec.add_dependency('mok-parser', '>=0.3.1')
+  spec.add_dependency('mok-parser', '>=0.3.2')
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mok2html
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - garin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-14 00:00:00.000000000 Z
+date: 2013-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: 0.3.1
+        version: 0.3.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: 0.3.1
+        version: 0.3.2
 description: mok is simple document format
 email:
 - garin54@gmail.com
@@ -71,10 +71,10 @@ files:
 - Rakefile
 - VERSION
 - bin/mok2html
+- conf/mok2html.yaml.sample
 - lib/mok2html.rb
 - lib/mok2html_element.rb
 - mok2html.gemspec
-- mok2html.yaml.sample
 homepage: ''
 licenses:
 - GPLv3

data/mok2html.yaml.sample

@@ -1,45 +0,0 @@
-# = mok2html.yaml.sample
-# mok2html 設定ファイルのサンプルです
-#
-# == 使い方
-# 自身のホームディレクトリに .mok2html.yaml というファイル名で設置して値を編集します
-#   $ cp mok2html.yaml.sample ~/.mok2html.yaml
-#   $ vi ~/.mok2html.yaml
-#
-# == 設定項目
-# コンバート時にHTMLファイルに埋め込むスタイルシート(デフォルト:なし)
-# css:
-#   - "~/doc/mok/css/bootstrap.css"
-#   - "~/doc/mok/css/prettify.css"
-#   - "~/doc/mok/css/_document.css"
-
-# コンバート時にHTMLファイルに埋め込むjavascript(デフォルト:なし)
-# js:
-#   - "~/doc/mok/js/jquery.js"
-#   - "~/doc/mok/js/bootstrap.js"
-#   - "~/doc/mok/js/prettify.js"
-#   - "~/doc/mok/js/prettify_onload.js"
-
-# リファレンス記法の「.%」を変換する拡張子(デフォルト:.html)
-#reference_extension: ".html"
-
-# リンク記法((<..>))のファイルを配置する基底ディレクトリ(デフォルト:なし)
-#reference_base_directory: ""
-
-# 画像やビデオ、音声などを配置するディレクトリ(デフォルト:なし)
-#media_base_directory: "/usr/local/media"
-
-# HTMLタグをカスタマイズするためのRubyファイル(デフォルト:なし)
-#custom_element: "/home/myname/mok2html/mycustom.rb"
-
-# ドキュメントのフォーマット(デフォルト:ja)
-#language: "ja"
-
-# 目次(index)を作成するかどうか(デフォルト: true)
-#index: true
-
-# メタデータを作成するかどうか(デフォルト: true)
-#metadata: true
-
-# HTMLヘッダを出力((*しない*))かどうか(デフォルト: false)
-#quiet: false