RubyGems - mok2html - Versions diffs - 0.1.0 - Mend

mok2html 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (17) hide show

data/Gemfile.lock ADDED Viewed

@@ -0,0 +1,21 @@
+PATH
+  remote: .
+  specs:
+    mok2html (0.1.0)
+      mok-parser (>= 0.3.0)
+GEM
+  remote: https://rubygems.org/
+  specs:
+    mimemagic (0.2.1)
+    mok-parser (0.3.0)
+      mimemagic
+    rake (10.1.0)
+PLATFORMS
+  ruby
+DEPENDENCIES
+  bundler (~> 1.3)
+  mok2html!
+  rake

data/History.rdoc ADDED Viewed

@@ -0,0 +1,35 @@
+== 0.1.0 (2013-12-12)
+* プロジェクト名を raf2html から mok2html に変更
+* new: 新しいQUITE構文の追加
+* change: Referenceエレメントの拡張子オプション名を extension から reference_extension に変更
+* change: Quoteエレメントの名前をPreformatに変更
+== 0.0.8 (2013-12-10)
+* new: Reference の 拡張子書式(.%) に対応(@options[:extension])
+* new: LabelLink エレメントに対応
+* new: エレメント(タグ)をカスタマイズできる機能を追加
+* new: スタイルシート指定のオプション(--css)にショートネーム(-c)を追加
+* new: javascript を読み込むコマンドラインオプションを追加
+* new: Quote クラスに出力に google prettify のコードを追加
+* change: IMAGE エレメントを廃止して、MEDIA エレメントに対応
+* change: メタデータの項目を変更
+* change: manuedo の出力フォーマットを変更
+* change: css, javascript, custom_element オプションのデフォルト値を nil から ""(empty) に変更
+* fix: Label エレメントのリンクが name ではなく href になっていたのを修正
+== 0.0.7 (2013-12-05)
+* Variable に対応
+== 0.0.6 (2013-12-05)
+* 設定ファイル(~/.raf2html.yaml)を追加
+== 0.0.5 (2013-12-04)
+* kbd書式 ((%...%)) に対応
+* code書式 (({...})) に対応
+== 0.0.4 (2013-12-03)
+* minar fix
+== 0.0.3 2013-12-01
+* raf-parser プロジェクトから独立

data/LICENSE.txt ADDED Viewed

@@ -0,0 +1,14 @@
+Copyright (C) garin <garin54@gmail.com> 2013
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+You should have received a copy of the GNU General Public License
+along with Foobar.  If not, see <http://www.gnu.org/licenses/>.

data/README.rdoc ADDED Viewed

@@ -0,0 +1,36 @@
+= mok2html
+"mok2html" is mok document convert to HTML.
+== Require
+* ruby-2.0.0p353 or later
+== Installation
+  // package install
+  $ gem install mok2html
+== Getting Started
+=== Edit mok document
+  $ vi mydoc.mok
+  = This is My document
+  mok is simple document format.
+format manutal : http://garin.jp/doc/mok/mok (this page is japanese)
+=== to HTML
+  $ mok2html mydoc.mok
+  <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+  ...
+  <h1>This is My document</h1> ...
+  <p>mok is simple document format.<br /></p>
+  ...
+=== Print Help
+  $ mok2html --help
+== Read more
+Official Web Site : http://garin.jp/doc/mok/mok2html (this page is japanese)
+== Copyright
+Copyright (c) 2011-2013 garin. See LICENSE.txt for
+further details.

data/RELEASE ADDED Viewed

	@@ -0,0 +1 @@
1	+ 2013-12-12

data/Rakefile ADDED Viewed

	@@ -0,0 +1 @@
1	+ require "bundler/gem_tasks"

data/VERSION ADDED Viewed

	@@ -0,0 +1 @@
1	+ 0.1.0

data/bin/mok2html ADDED Viewed

@@ -0,0 +1,58 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+# Copyright (C) garin <garin54@gmail.com> 2011-2013
+# See the included file COPYING for details.
+$:.unshift File.join(File.dirname(__FILE__), "../lib")
+require "yaml"
+require "optparse"
+require "mok2html"
+# 設定ファイル
+CONFIG_FILE="~/.mok2html.yaml"
+config_file_path = File.expand_path(CONFIG_FILE)
+# デフォルトの設定値
+options = {:css => "", :js => "", :reference_extension => '.html', :media_directory => "", :custom_element => "" , :language => 'ja', :index => true, :quiet => false}
+# 設定ファイルの読み込み
+if File.exist?(config_file_path)
+  config = YAML.load_file( config_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
+# 使い方
+def usage(opt)
+  puts opt.help
+  exit 0
+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", "HTMLに埋め込むスタイルシートを指定") {|f| options[:css] = f}
+  opt.on("-j", "--javascript file", "HTMLに埋め込むJavaScriptを指定") {|f| options[:js] = f}
+  opt.on("-L", "--language LANG", "言語(デフォルトは #{options[:language]} 。ドキュメント側で指定されていればそちらを優先)"){|l| options[:language] = l}
+  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("-m", "--media_directory directory", "画像や動画などのメディアファイルを配置する基底ディレクトリ"){|d| options[:media_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)
+usage(opt) unless ARGV[0]
+# main
+src = File.open(ARGV[0],"r").readlines
+mok = Mok::Mok2Html.new(src, options)
+puts mok.to_html

data/lib/mok2html.rb ADDED Viewed

@@ -0,0 +1,157 @@
+# -*- coding: utf-8 -*-
+# Copyright (C) garin <garin54@gmail.com> 2011
+# See the included file COPYING for details.
+require "mok2html_element"
+require "cgi"
+module Mok
+  class Mok2Html
+    VERSION = File.readlines(File.join(File.dirname(__FILE__),"../VERSION"))[0].strip
+    RELEASE = File.readlines(File.join(File.dirname(__FILE__),"../RELEASE"))[0].strip
+    def initialize(src, options = {})
+      @debug = true
+      # options
+      @css = File.open(File.expand_path(options[:css])).readlines.to_s unless options[:css].empty?
+      @js  = File.open(File.expand_path(options[:js])).readlines.to_s unless options[:js].empty?
+      @language = options[:language]
+      @index = options[:index]
+      @metadata = options[:metadata]
+      @quiet = options[:quiet]
+      get_customized_element(options[:custom_element]) unless options[:custom_element].empty?
+      @mok = BlockParser.new(options)
+      @metadata = setup_metadata
+      @nodes = @mok.parse src
+    end
+    # エレメントのカスタム用ファイルを読み込む
+    def get_customized_element(file)
+      require File.expand_path(file)
+    end
+    def setup_metadata
+      metadata = @mok.metadata
+      metadata[:language] = @language if metadata[:language].nil?
+      metadata
+    end
+    def to_html
+      html = ""
+      html += header unless @quiet
+      html += header_title
+      html += metadata if @metadata
+      html += index if @index
+      html += body
+      html += footnote
+      html += footer unless @quiet
+      html
+    end
+    def body
+      @nodes.map do |node| node.apply end.join
+    end
+    def index
+      return "" if @mok.index[:head].nil?
+      str = "<div id='mok-index'>"
+      level_pre = 1
+      @mok.index[:head].each_with_index do |h,i|
+        next if h[:level] == 1 or h[:level] == 6
+        if h[:level] == 5
+          str += %[<div class="nonum"><a href="#mok-head#{h[:level]}-#{i+1}"><span class="space" />#{h[:title]}</a></div>\n]
+        else
+          str += index_terminate(h[:level], level_pre)
+          str += "<li><a href='#mok-head#{h[:level]}-#{i+1}'>#{h[:index]}#{h[:title]}</a>\n"
+          level_pre = h[:level]
+        end
+      end
+      str += index_terminate(2, level_pre) + "</ul>"
+      str += "</div>"
+      str
+    end
+    def index_terminate(level, level_pre)
+      str = ""
+      case level <=> level_pre
+      when 1
+        (level - level_pre).times do
+          str += "<ul>"
+        end
+      when -1
+        (level_pre - level).times do
+          str += "</ul></li>"
+        end
+      else
+        str += "</li>"
+      end
+      str
+    end
+    def metadata
+      str = "<div id='mok-metadata'>"
+      str += %[<div>#{CGI.escapeHTML(@metadata[:description])}</div>] unless @metadata[:description].nil?
+      str += %[<ul class="list-inline">]
+      %w{ author create update publisher version tag }.each do |m|
+        str += %[<li><strong>#{m}</strong>:#{CGI.escapeHTML(@metadata[m.to_sym])}</li>] unless @metadata[m.to_sym].nil?
+      end
+      str += "</ul>"
+      str += "</div>"
+      str
+    end
+    def footnote
+      return "" if @mok.inline_index[:footnote].nil?
+      str = "<div id='mok-footnote'>"
+      @mok.inline_index[:footnote].each_with_index do |f,i|
+        str += "<a id='mok-footnote-#{i+1}' class='footnote' />"
+        str += "<a href='#mok-footnote-#{i+1}-reverse' class='footnote-reverse'>*#{i+1}</a>"
+        str += " #{f[:content].map{|c| c.apply}}<br />"
+      end
+      str += "</div>"
+      str
+    end
+    def header
+      str = <<EOL
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="#{@metadata[:language]}">
+  <head>
+  <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+EOL
+      str += css
+      str += javascript
+      str += <<EOL
+  <title>#{@metadata[:subject]}</title>
+  </head>
+<body>
+EOL
+    end
+    def header_title
+      "<h1>#{@metadata[:subject]}</h1>\n"
+    end
+    def css
+      str = ""
+      str += %[<style type="text/css"><!--\n#{@css}\n--></style>\n] unless @css.nil?
+      str
+    end
+    def javascript
+      str = ""
+      str += %[<script type="text/javascript">#{@js}</script>\n] unless @js.nil?
+      str
+    end
+    def footer
+      str = "\n"
+      str += "<div id='rights'>#{@metadata[:rights]}</div>\n" unless @metadata[:rights].nil?
+      str += "</body>\n</html>"
+      str
+    end
+  end
+end

data/lib/mok2html_element.rb ADDED Viewed

@@ -0,0 +1,236 @@
+# -*- coding: utf-8 -*-
+# Copyright (C) garin <garin54@gmail.com> 2011-2013
+# See the included file COPYING for details.
+require 'bundler/setup'
+require 'mok-parser'
+module Mok
+  class Element
+    def newline_to_br(str)
+      str.gsub("\n", "<br />\n")
+    end
+    # @inline_parser.parse の配列を文字列に変換する
+    def inline_parse_to_str(array)
+      str = ""
+      array.each do |obj|
+        str += obj.apply
+      end
+      str
+    end
+  end
+  # ----- Blocks
+  class WhiteLine < Element
+    def apply
+      "\n"
+    end
+  end
+  class PlainTextBlock < Element
+    def apply
+      @contents.map {|c| c.apply }
+    end
+  end
+  class HeadLine < Element
+    # @contents = [level, title, id, index]
+    def apply
+      return "" if @contents[0] == 1
+      str = ""
+      str += "<h#{@contents[0]} id='mok-head#{@contents[0]}-#{@contents[2]}'>"
+      str += "<a id='#{@contents[1].to_code}'></a>"
+      str += " #{@contents[3]}" unless @contents[0] == 1 or @contents[0] == 5 or @contents[0] == 6
+      str += "#{@contents[1]}</h#{@contents[0]}>\n"
+      str
+    end
+  end
+  class Paragraph  < Element
+    def apply
+      "<p>#{@contents.map{|c| c.apply}}</p>\n"
+    end
+  end
+  class Quote < Element
+    def apply
+      "<blockquote>#{@contents.map{|c|c.apply}}</blockquote>\n"
+    end
+  end
+  class Preformat < Element
+    def apply
+      %[<pre class="prettyprint linenums">#{CGI.escapeHTML(@contents.join)}</pre>\n]
+    end
+  end
+  class ItemList < Element
+    def apply
+      return "" if @contents.empty?
+      type = :dummy
+      str = "<ul>\n"
+      @contents.each do |item|
+        type_pre = type
+        case item
+        when :INDENT
+          type = :indent
+          str += "\n<ul>\n"
+        when :DEDENT
+          type = :dedent
+          str += "</li>\n" if type_pre == :item
+          str += "</ul>\n</li>\n"
+        else
+          type = :item
+          str += "</li>\n" if type_pre == :item
+          str += "<li>#{item.apply}"
+        end
+      end
+      str += "\n</li>"  if type == :item
+      str += "\n</ul>\n"
+      str
+    end
+  end
+  class NumList < Element
+    def apply
+      str = "<ol>\n"
+      @contents.map do |item|
+        if item == :INDENT
+          str += "<ol>\n"
+        elsif item == :DEDENT
+          str += "</ol>\n"
+        else
+          str += "<li>#{item.apply}</li>\n"
+        end
+      end
+      str += "</ol>\n"
+      str
+    end
+  end
+  class Desc < Element
+    # @contents = [title, lines]
+    def apply
+      str = %[<dl id="#{@contents[0].to_code}">\n<dt>#{@contents[0]}</dt>\n]
+      str += "<dd>#{inline_parse_to_str(@contents[1])}</dd>\n" unless inline_parse_to_str(@contents[1]).empty?
+      str += "</dl>"
+      str
+    end
+  end
+  class Table < Element
+    def apply
+      str = %[<table class="table table-hover">]
+      @contents.each do |line|
+        str += "\n<tr>"
+        line.each do |item|
+          if item =~ /^\s*\*/
+            str += "<th>#{item.sub(/^\s*\*/, "").sub(/\*\s*$/,"")}</th>"
+          else
+            str += "<td>#{item}</td>"
+          end
+        end
+        str += "\n</tr>"
+      end
+      str += "\n</table>"
+      str
+    end
+  end
+  # --- Blocks end
+  # --- Inlines
+  class Label < Element
+    # @contents = [label, title]
+    def apply
+      %[<a name="#{@contents[0]}" id="#{@contents[0]}">#{@contents[1]}</a>]
+    end
+  end
+  class LabelLink < Element
+    # @contents = [label, title]
+    def apply
+      %[<a href="##{@contents[0]}">#{@contents[1]}</a>]
+    end
+  end
+  class Reference < Element
+    def apply
+      %[<a href="#{@contents[1]}" title="#{@contents[1]}">#{@contents[0]}</a>]
+    end
+  end
+  class Plain < Element
+    def apply
+      "#{newline_to_br(CGI.escapeHTML(@contents.join))}"
+    end
+  end
+  class Emphasis       < Element
+    def apply
+      "<strong>#{@contents.map{|c| c.apply}}</strong>"
+    end
+  end
+  class Italic       < Element
+    def apply
+      "<em>#{@contents.map{|c| c.apply}}</em>"
+    end
+  end
+  class Strike       < Element
+    def apply
+      "<del>#{@contents.map{|c| c.apply}}</del>"
+    end
+  end
+  class Code       < Element
+    def apply
+      "<code>#{@contents.map{|c| c.apply}}</code>"
+    end
+  end
+  class Kbd       < Element
+    def apply
+      "<kbd>#{@contents.map{|c| c.apply}}</kbd>"
+    end
+  end
+  class Verb       < Element
+    def apply
+      "#{@contents}"
+    end
+  end
+  class Manuedo       < Element
+    def apply
+      %{<span class="manuedo">[#{@contents.map{|c| c.apply}}]</span>}
+    end
+  end
+  class Ruby       < Element
+    def apply
+      "<ruby><rb>#{@contents[0]}</rb><rp>(</rp><rt>#{@contents[1]}</rt><rp>)</rp></ruby>"
+    end
+  end
+  class Variable       < Element
+    def apply
+      "#{@contents}"
+    end
+  end
+  class Footnote       < Element
+    def apply
+      "<a href='#mok-footnote-#{@contents[1]}' name='mok-footnote-#{@contents[1]}-reverse' title='#{@contents[0].map {|c| c.apply}}' class='footnote-reverse'><sup><small>*#{@contents[1]}</small></sup></a>"
+    end
+  end
+  class Media       < Element
+    def apply
+      # @contents = [Name, Mime::MediaType, Mime::SubType]
+      case @contents[1]
+      when 'image'
+        %[<a href="#{@contents[0]}"><img src="#{@contents[0]}" alt="#{@contents[0]}" class="img-rounded img-responsive" /></a>]
+      when 'video'
+        %[<video src="#{@contents[0]}" controls></video>]
+      when 'audio'
+        %[<audio src="#{@contents[0]}" controls></audio>]
+      else
+        %[<a href="#{@contents[0]}">#{@contents[0].split("/").last}</a>]
+      end
+    end
+  end
+end

data/mok2html.gemspec ADDED Viewed

@@ -0,0 +1,21 @@
+# coding: utf-8
+Gem::Specification.new do |spec|
+  spec.name          = "mok2html"
+  spec.version       = `cat VERSION`
+  spec.authors       = ["garin"]
+  spec.email         = ["garin54@gmail.com"]
+  spec.description   = %q{mok is simple document format}
+  spec.summary       = %q{mok is simple document format}
+  spec.homepage      = ""
+  spec.license       = "GPLv3"
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_dependency('mok-parser', '>=0.3.0')
+end

data/mok2html.yaml.sample ADDED Viewed

@@ -0,0 +1,35 @@
+# = mok2html.yaml.sample
+# mok2html 設定ファイルのサンプルです
+#
+# == 使い方
+# 自身のホームディレクトリに .mok2html.yaml というファイル名で設置して値を編集します
+#   $ cp mok2html.yaml.sample ~/.mok2html.yaml
+#   $ vi ~/.mok2html.yaml
+#
+# == 設定項目
+# コンバート時にHTMLファイルに埋め込むスタイルシート(デフォルト:"")
+#css: "~/mok2html.css"
+# コンバート時にHTMLファイルに埋め込むjavascript(デフォルト:"")
+#js: "~/mok2html.js"
+# リファレンス記法の「.%」を変換する拡張子(デフォルト:.html)
+#reference_extension: ".html"
+# 画像やビデオ、音声などを配置するディレクトリ(デフォルト:"")
+#media_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