RubyGems - raf2html - Versions diffs - 0.0.7 → 0.0.8 - Mend

raf2html 0.0.7 → 0.0.8

Files changed (12) hide show

checksums.yaml CHANGED

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2c0f881fc66a26aebd0b0dd0409b158bcd891da1
-  data.tar.gz: a2d16367519ffd3ba72505b4f2220763b2f9b860
+  metadata.gz: a919fa589de9a092cfc4d6b7e4b1a4d85df8cdb8
+  data.tar.gz: c4285b4b83fccbb44060bdf0d2658df06fa8792c
 SHA512:
-  metadata.gz: 7bbe06c4e3caeccc441150fce387eb5e4a3beee77df5651813a766d378b2986b75a5ad7554cfb6894dd2c35611fa968428a2f7234e4245a8e08d0fea0a8a6a4b
-  data.tar.gz: 29930453f32b03224af31b5b0b403008269cca3a032489acff4c1812f0284c4a243fb471994d8eab27122f53449df17dbfd604124d21ecf6649a7838f160734a
+  metadata.gz: 163ae6e6b0b468e5d03ed5cd6e870979908f2298f36a802ce4046f303a45aa5ee6b8a923522c242799eb98d0210605a2ab20a0f4aa833ddcb66de2add86ebd2b
+  data.tar.gz: b3409ac7fce9355ba030cf9ffd176d06c29a015b4cd61cfae67b5a87de7c1b333f7fc63e848404d671d0c76bb2d7e6d57a067b72fd384f13ebd96ead390779ff

data/Gemfile.lock CHANGED

@@ -1,13 +1,15 @@
 PATH
   remote: .
   specs:
-    raf2html (0.0.7)
-      raf-parser (>= 0.2.2)
+    raf2html (0.0.8)
+      raf-parser (>= 0.2.3)
 GEM
   remote: https://rubygems.org/
   specs:
-    raf-parser (0.2.2)
+    mimemagic (0.2.1)
+    raf-parser (0.2.3)
+      mimemagic
     rake (10.1.0)
 PLATFORMS

data/History.rdoc CHANGED

@@ -1,3 +1,19 @@
+== 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)を追加

data/README.rdoc CHANGED

@@ -1,27 +1,32 @@
 = raf2html
-"raf2html" is raf(simple document format) convert to HTML format.
-refer to : http://garin.jp/doc/raf/raf (this page is japanese)
+"raf2html" is raf document convert to HTML.
-== INSTALLATION
-  // check ruby version
-  $ ruby -v
-  ruby 2.0.0p353 (2013-11-22 revision 43784) [x86_64-linux]
+== Require
+* ruby-2.0.0p353 or later
-  // raf2html gem package install
+== Installation
+  // package install
   $ gem install raf2html
-== UTILITIES
-=== raf2html
-raf format to HTML format conveter.
+== Getting Started
+=== Edit raf document
-+ Usage
-  // edit
   $ vi mydoc.raf
   = This is My document
   raf is simple document format.
-  // to html
-  $ raf2html mydoc.raf > mydoc.html
+format manutal : http://garin.jp/doc/raf/raf (this page is japanese)
+=== to HTML
+  $ raf2html mydoc.raf
+  <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+  ...
+  <h1>This is My document</h1> ...
+  <p>raf is simple document format.<br /></p>
+  ...
+=== Print Help
+  $ raf2html --help
 == Read more
 Official Web Site : http://garin.jp/doc/raf/raf (this page is japanese)

data/RELEASE CHANGED

	@@ -1 +1 @@
1	- 2013-12-04
1	+ 2013-12-10

data/VERSION CHANGED

	@@ -1 +1 @@
1	- 0.0.7
1	+ 0.0.8

data/bin/raf2html CHANGED

@@ -12,7 +12,7 @@ CONFIG_FILE="~/.raf2html.yaml"
 config_file_path = File.expand_path(CONFIG_FILE)
 # デフォルトの設定値
-options = {:css => nil, :language => 'ja', :index => true, :quiet => false}
+options = {:css => "", :js => "", :extension => '.html', :media_directory => "", :custom_element => "" , :language => 'ja', :index => true, :quiet => false}
 # 設定ファイルの読み込み
 if File.exist?(config_file_path)
@@ -35,11 +35,19 @@ opt = OptionParser.new do |opt|
   opt.banner = "Usage: raf2html [options] file"
   opt.version = Raf::Raf2Html::VERSION
   opt.release = Raf::Raf2Html::RELEASE
-  opt.on("--css file", "スタイルシートのファイルを指定") {|f| options[:css] = f}
+  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","--extension string", "リファレンス記法で「.%」を置換する拡張子(デフォルト .html)"){|s| options[: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", "使用する raf-parser のバージョンを表示"){
+    puts "raf-parser: #{Raf::VERSION} (#{Raf::RELEASE})"
+    exit 0
+  }
 end
 opt.parse!(ARGV)
 usage(opt) unless ARGV[0]

data/lib/raf2html.rb CHANGED

@@ -13,17 +13,24 @@ module Raf
       @debug = true
       # options
-      @css = File.open(File.expand_path(options[:css])).readlines.to_s unless options[:css].nil?
+      @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]
-      @raf = BlockParser.new
+      get_customized_element(options[:custom_element]) unless options[:custom_element].empty?
+      @raf = BlockParser.new(options)
       @metadata = setup_metadata
       @nodes = @raf.parse src
     end
+    # エレメントのカスタム用ファイルを読み込む
+    def get_customized_element(file)
+      require File.expand_path(file)
+    end
     def setup_metadata
       metadata = @raf.metadata
       metadata[:language] = @language if metadata[:language].nil?
@@ -54,7 +61,7 @@ module Raf
         next if h[:level] == 1 or h[:level] == 6
         if h[:level] == 5
-          str += "<div class=><a href='#raf-head#{h[:level]}-#{i+1}'><span class='space' />#{h[:title]}</a></div>\n"
+          str += %[<div class="nonum"><a href="#raf-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='#raf-head#{h[:level]}-#{i+1}'>#{h[:index]}#{h[:title]}</a>\n"
@@ -87,7 +94,7 @@ module Raf
       str = "<div id='raf-metadata'>"
       str += %[<div>#{CGI.escapeHTML(@metadata[:description])}</div>] unless @metadata[:description].nil?
       str += %[<ul class="list-inline">]
-      %w{ creator date update publisher version contributer revision tag }.each do |m|
+      %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>"
@@ -116,6 +123,7 @@ module Raf
   <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
 EOL
       str += css
+      str += javascript
       str += <<EOL
   <title>#{@metadata[:subject]}</title>
   </head>
@@ -128,13 +136,14 @@ EOL
     end
     def css
-#      str = <<EOL
-#<link href="screen.css" rel="stylesheet" type="text/css" media="screen" />
-#<link href="handheld.css" rel="stylesheet" type="text/css" media="handheld" />
-#<link href="print.css" rel="stylesheet" type="text/css" media="print" />
-      #EOL
       str = ""
-      str += %%<style type="text/css"><!--\n#{@css}\n--></style>\n% unless @css.nil?
+      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

data/lib/raf2html_element.rb CHANGED

@@ -54,7 +54,7 @@ module Raf
   class Quote < Element
     def apply
-      "<pre>#{CGI.escapeHTML(@contents.join)}</pre>\n"
+      %[<pre class="prettyprint linenums">#{CGI.escapeHTML(@contents.join)}</pre>\n]
     end
   end
@@ -136,7 +136,14 @@ module Raf
   class Label < Element
     # @contents = [label, title]
     def apply
-      "<a href='##{@contents[0]}' id='#{@contents[0]}'>#{@contents[1]}</a>"
+      %[<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
@@ -185,7 +192,7 @@ module Raf
   class Manuedo       < Element
     def apply
-      "<span class='manuedo'>/#{@contents.map{|c| c.apply}}/</span>"
+      %{<span class="manuedo">[#{@contents.map{|c| c.apply}}]</span>}
     end
   end
   class Ruby       < Element
@@ -205,9 +212,19 @@ module Raf
     end
   end
-  class Image       < Element
+  class Media       < Element
     def apply
-      "<img src='#{@contents}' />"
+      # @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/raf2html.gemspec CHANGED

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

data/raf2html.yaml.sample CHANGED

@@ -7,13 +7,29 @@
 #   $ vi ~/.raf2html.yaml
 #
 # == 設定項目
-# コンバート時にHTMLファイルに埋め込むスタイルシート(デフォルト:nil)
-# css: "~/raf2html.css"
+# コンバート時にHTMLファイルに埋め込むスタイルシート(デフォルト:"")
+#css: "~/raf2html.css"
+# コンバート時にHTMLファイルに埋め込むjavascript(デフォルト:"")
+#js: "~/raf2html.js"
+# リファレンス記法の「.%」を変換する拡張子(デフォルト:.html)
+#extension: ".html"
+# 画像やビデオ、音声などを配置するディレクトリ(デフォルト:"")
+#media_directory: "/usr/local/media"
+# HTMLタグをカスタマイズするためのRubyファイル(デフォルト:"")
+#custom_element: "/home/myname/raf2html/mycustom.rb"
 # ドキュメントのフォーマット(デフォルト:ja)
-language: "ja"
+#language: "ja"
 # 目次(index)を作成するかどうか(デフォルト: true)
-index: true
+#index: true
 # メタデータを作成するかどうか(デフォルト: true)
-metadata: true
+#metadata: true
 # HTMLヘッダを出力"しない"かどうか(デフォルト: false)
-quiet: false
+#quiet: false

metadata CHANGED

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: raf2html
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - garin
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2013-12-04 00:00:00.000000000 Z
+date: 2013-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: 0.2.2
+        version: 0.2.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: 0.2.2
+        version: 0.2.3
 description: raf is simple document format
 email:
 - garin54@gmail.com