raf 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4ef425f171fb1428d84f05600664075ccd486eb9
-  data.tar.gz: 3a34f1507f9d623723aff59b15ce1e5998ef4b8e
+  metadata.gz: c185ed73d5d2fe3fed31aa048c256b458cdef61d
+  data.tar.gz: 0f728c67524f41bd3fa44adbd571b95444a24552
 SHA512:
-  metadata.gz: cc6503f3a492c31334c8e3a9cf7f75b0fc8c21fdd6b71349e948fba1ad5b71aa23efcd69f0c1a2cf7b58dd798ef5134e37583a3f429d6f77adee2462f1f36c43
-  data.tar.gz: 49c818d4053e7f257afb84e774b9cbebe22eba46b52c05e7f76dd5f8641d6e2a0fe3aff7040f349f3787175c682c3ee38c9ee3fe9e76a6c0e263aa8c369a6b60
+  metadata.gz: 6c264951405f105cf060dd463c45ef91a3cd2901fbae978ee1e913a1cb2b3d496d6d969b7008673ffcc052480b35f4c50734b1a8c7309eded18097b391fede3f
+  data.tar.gz: f588eecc9d45853a027822ca9034091f0965cf11419a40ff188fad8c2a32b5e925730169f2b5f2519aa6ad51901e390d7559586b0386d074ff525298bf9be62a

data/Gemfile

@@ -1,4 +1,4 @@
 source 'https://rubygems.org'
-
+ruby '2.0.0'
 # Specify your gem's dependencies in raf.gemspec
 gemspec

data/README.rdoc

@@ -2,14 +2,33 @@
 "raf" is simple document format.
 refer to : http://garin.jp/doc/raf/raf (this page is japanese)
 
-== install
+== INSTALLATION
   // check ruby version
   $ ruby -v
   ruby 2.0.0p353 (2013-11-22 revision 43784) [x86_64-linux]
 
-  // raf gem package install 
+  // raf gem package install
   $ gem install raf
 
+== UTILITIES
+=== raf
+print raf format version.
+
+=== raf2html
+Raf format to HTML format conveter.
+
++ Usage
+  // edit
+  $ vi mydoc.raf
+  = This is My document
+  raf is simple document format.
+
+  // to html
+  $ raf2html mydoc.raf > mydoc.html
+
+== Read more
+Official Web Site : http://garin.jp/doc/raf/raf (this page is japanese)
+
 == Copyright
 Copyright (c) 2011-2013 garin. See LICENSE.txt for
 further details.

data/RELEASE

@@ -0,0 +1 @@
+2013-11-26

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/bin/raf

@@ -0,0 +1,19 @@
+#!/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 "raf"
+require "optparse"
+
+opt = OptionParser.new do |opt|
+  opt.version = Raf::VERSION
+  opt.release = Raf::RELEASE
+  opt.banner  = <<EOL
+"raf" is simple document format.
+Read more: https://github.com/garin/raf
+EOL
+end
+
+opt.parse!(ARGV)
+puts opt.help

data/bin/raf2html

@@ -1,15 +1,21 @@
 #!/usr/bin/env ruby
-# -*- encoding: utf-8 -*-
-# Copyright (C) garin <garin54@gmail.com> 2011
+# -*- 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 "optparse"
 require "raf2html"
 
+def usage(opt)
+  puts opt.help
+  exit 0
+end
+
 options = {:css => nil, :language => 'ja', :index => true, :quiet => false}
 opt = OptionParser.new do |opt|
-  opt.release = "2011-04-07"
-  opt.version = "0.0.2"
+  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("-L", "--language LANG", "言語(デフォルトは #{options[:language]} 。ドキュメント側で指定されていればそちらを優先)"){|l| options[:language] = l}
   opt.on("--[no-]index", "目次を生成する(デフォルトは生成する)"){|v| options[:index] = v }
@@ -17,6 +23,7 @@ opt = OptionParser.new do |opt|
   opt.on("-q","--quiet", "本文だけを出力する(ヘッダやフッタは出力しない)"){ options[:quiet] = true }
 end
 opt.parse!(ARGV)
+usage(opt) unless ARGV[0]
 src = File.open(ARGV[0],"r").readlines
 raf = Raf::Raf2Html.new(src, options)
 puts raf.to_html

data/lib/raf.rb

@@ -0,0 +1,7 @@
+# -*- coding: utf-8 -*-
+# Copyright (C) garin <garin54@gmail.com> 2011-2013
+# See the included file COPYING for details.
+module Raf
+  VERSION = File.readlines(File.join(File.dirname(__FILE__),"../VERSION"))[0].strip
+  RELEASE = File.readlines(File.join(File.dirname(__FILE__),"../RELEASE"))[0].strip
+end

data/lib/raf2html.rb

@@ -6,6 +6,9 @@ require "cgi"
 
 module Raf
   class Raf2Html
+    VERSION="0.0.2"
+    RELEASE="2011-04-07"
+
     def initialize(src, options = {})
       @debug = true
 
@@ -18,7 +21,7 @@ module Raf
 
       @raf = BlockParser.new
       @metadata = setup_metadata
-      @nodes = @raf.parse src.map {|s| CGI.escapeHTML(s) }
+      @nodes = @raf.parse src
     end
 
     def setup_metadata

data/lib/raf2html_element.rb

@@ -147,7 +147,7 @@ module Raf
 
   class Plain < Element
     def apply
-      "#{newline_to_br(@contents.join(""))}"
+      "#{newline_to_br(CGI.escapeHTML(@contents.join))}"
     end
   end
 

data/lib/rafinlineparser.ry

@@ -1,7 +1,7 @@
 # Copyright (C) garin <garin54@gmail.com> 2011
 # See the included file COPYING for details.
 class InlineParser
-  token EM_OPEN EM_CLOSE ITALIC_OPEN ITALIC_CLOSE STRIKE_OPEN STRIKE_CLOSE LABEL_OPEN LABEL_CLOSE REFERENCE_OPEN REFERENCE_CLOSE VERB_OPEN VERB_CLOSE ERB_OPEN ERB_CLOSE FOOTNOTE_OPEN FOOTNOTE_CLOSE RUBY_OPEN RUBY_CLOSE IMAGE_OPEN IMAGE_CLOSE MANUEDO_OPEN MANUEDO_CLOSE  BAR QUOTE SLASH BACK_SLASH OTHER
+  token EM_OPEN EM_CLOSE ITALIC_OPEN ITALIC_CLOSE STRIKE_OPEN STRIKE_CLOSE LABEL_OPEN LABEL_CLOSE REFERENCE_OPEN REFERENCE_CLOSE VERB_OPEN VERB_CLOSE ERB_OPEN ERB_CLOSE HERB_OPEN FOOTNOTE_OPEN FOOTNOTE_CLOSE RUBY_OPEN RUBY_CLOSE IMAGE_OPEN IMAGE_CLOSE MANUEDO_OPEN MANUEDO_CLOSE OTHER
   options no_result_var
   rule
   content :
@@ -10,7 +10,6 @@ class InlineParser
   elements : elements element { val[0].push(val[1]) }
            | element          { val }
 
-
   element  : emphasis
            | italic
            | strike
@@ -21,6 +20,7 @@ class InlineParser
            | image
            | verb
            | erb
+           | herb
            | manuedo
            | normal_strings
 
@@ -34,15 +34,10 @@ class InlineParser
                Footnote.new([val[1], @index[:footnote].size])
                }
 
-
   # --- inline end
 
   # --- image
   image_string : OTHER
-              | QUOTE
-              | BAR
-              | SLASH
-              | BACK_SLASH
               | EM_OPEN
               | EM_CLOSE
               | ITALIC_OPEN
@@ -55,6 +50,7 @@ class InlineParser
               | MANUEDO_CLOSE
               | ERB_OPEN
               | ERB_CLOSE
+              | HERB_OPEN
               | REFERENCE_OPEN
               | REFERENCE_CLOSE
               | LABEL_OPEN
@@ -72,10 +68,6 @@ class InlineParser
   # --- image end
   # --- ruby
   ruby_string : OTHER
-              | QUOTE
-              | BAR
-              | SLASH
-              | BACK_SLASH
               | EM_OPEN
               | EM_CLOSE
               | ITALIC_OPEN
@@ -88,6 +80,7 @@ class InlineParser
               | MANUEDO_CLOSE
               | ERB_OPEN
               | ERB_CLOSE
+              | HERB_OPEN
               | REFERENCE_OPEN
               | REFERENCE_CLOSE
               | LABEL_OPEN
@@ -112,6 +105,9 @@ class InlineParser
   erb      : ERB_OPEN verb_string  ERB_CLOSE {
              e = ERB.new("<%= #{val[1]} %>")
              Plain.new(e.result) }
+  herb     : HERB_OPEN verb_string  ERB_CLOSE {
+             e = ERB.new("<% #{val[1]} %>")
+             Plain.new(e.result) }
   # --- erb end
   # --- manuedo
   manuedo  : MANUEDO_OPEN content MANUEDO_CLOSE { Manuedo.new(val[1]) }
@@ -120,10 +116,7 @@ class InlineParser
 
   # --- label
   label_string : OTHER { val[0] }
-               | QUOTE { val[0] }
-               | BAR   { val[0] }
-               | SLASH { val[0] }
-               | BACK_SLASH { val[0] }
+
 
   label_strings :  label_strings label_string { val.join }
                 |  label_string { val[0] }
@@ -139,10 +132,6 @@ class InlineParser
   # --- labe end
   # --- reference : start
   reference_string : OTHER { val[0] }
-                   | QUOTE { val[0] }
-                   | BAR   { val[0] }
-                   | SLASH { val[0] }
-                   | BACK_SLASH { val[0] }
 
   reference_strings :  reference_strings reference_string { val.join }
                     |  reference_string { val[0] }
@@ -156,10 +145,6 @@ class InlineParser
   # --- reference : end
   # --- verb
   verb_string : OTHER
-              | QUOTE
-              | BAR
-              | SLASH
-              | BACK_SLASH
               | EM_OPEN
               | EM_CLOSE
               | ITALIC_OPEN
@@ -172,6 +157,7 @@ class InlineParser
               | MANUEDO_CLOSE
               | ERB_OPEN
               | ERB_CLOSE
+              | HERB_OPEN
               | REFERENCE_OPEN
               | REFERENCE_CLOSE
               | LABEL_OPEN
@@ -193,10 +179,6 @@ class InlineParser
                  | normal_strings normal_string {  Plain.new([val[0].contents, val[1]]) }
 
   normal_string : OTHER { val[0] }
-                | QUOTE { val[0] }
-                | BAR   { val[0] }
-                | SLASH { val[0] }
-                | BACK_SLASH { val[0] }
   # --- normal end
 
 ---- inner
@@ -232,7 +214,6 @@ IMAGE_OPEN_RE = /\A#{Regexp.quote(IMAGE_OPEN)}/
 IMAGE_CLOSE = '$))'
 IMAGE_CLOSE_RE = /\A#{Regexp.quote(IMAGE_CLOSE)}/
 
-
 LABEL_OPEN = '((>'
 LABEL_OPEN_RE = /\A#{Regexp.quote(LABEL_OPEN)}/
 LABEL_CLOSE = '<))'
@@ -243,15 +224,14 @@ LABEL_HTML_OPEN_RE = /\A#{Regexp.quote(LABEL_HTML_OPEN)}/
 LABEL_HTML_CLOSE = '&lt;))'
 LABEL_HTML_CLOSE_RE = /\A#{Regexp.quote(LABEL_HTML_CLOSE)}/
 
-
 REFERENCE_OPEN = '((<'
 REFERENCE_OPEN_RE = /\A#{Regexp.quote(REFERENCE_OPEN)}/
 REFERENCE_CLOSE = '>))'
 REFERENCE_CLOSE_RE = /\A#{Regexp.quote(REFERENCE_CLOSE)}/
 
-REFERENCE_HTML_OPEN = '((&lt;'
+REFERENCE_HTML_OPEN = '((<'
 REFERENCE_HTML_OPEN_RE = /\A#{Regexp.quote(REFERENCE_HTML_OPEN)}/
-REFERENCE_HTML_CLOSE = '&gt;))'
+REFERENCE_HTML_CLOSE = '>))'
 REFERENCE_HTML_CLOSE_RE = /\A#{Regexp.quote(REFERENCE_HTML_CLOSE)}/
 
 VERB_OPEN = "(('"
@@ -264,27 +244,21 @@ MANUEDO_OPEN_RE = /\A#{Regexp.quote(MANUEDO_OPEN)}/
 MANUEDO_CLOSE = "/))"
 MANUEDO_CLOSE_RE = /\A#{Regexp.quote(MANUEDO_CLOSE)}/
 
-ERB_OPEN = "&lt;%="
+ERB_OPEN = "<%="
 ERB_OPEN_RE = /\A#{Regexp.quote(ERB_OPEN)}/
-ERB_CLOSE = "%&gt;"
+ERB_CLOSE = "%>"
 ERB_CLOSE_RE = /\A#{Regexp.quote(ERB_CLOSE)}/
 
-BAR = "|"
-BAR_RE = /\A#{Regexp.quote(BAR)}/
-QUOTE = '"'
-QUOTE_RE = /\A#{Regexp.quote(QUOTE)}/
-SLASH = "/"
-SLASH_RE = /\A#{Regexp.quote(SLASH)}/
-BACK_SLASH = "\\"
-BACK_SLASH_RE = /\A#{Regexp.quote(BACK_SLASH)}/
+HERB_OPEN = "<%"
+HERB_OPEN_RE = /\A#{Regexp.quote(HERB_OPEN)}/
+
 # URL = "URL:"
 # URL_RE = /\A#{Regexp.quote(URL)}/
 
 #other_re_mode = Regexp::EXTENDED
 other_re_mode = Regexp::MULTILINE
 OTHER_RE = Regexp.new(
-                      "\\A.+?(?=#{Regexp.quote(EM_OPEN)}|#{Regexp.quote(EM_CLOSE)}|#{Regexp.quote(ITALIC_OPEN)}|#{Regexp.quote(ITALIC_CLOSE)}|#{Regexp.quote(STRIKE_OPEN)}|#{Regexp.quote(STRIKE_CLOSE)}|#{Regexp.quote(FOOTNOTE_OPEN)}|#{Regexp.quote(FOOTNOTE_CLOSE)}|#{Regexp.quote(RUBY_OPEN)}|#{Regexp.quote(RUBY_CLOSE)}|#{Regexp.quote(IMAGE_OPEN)}|#{Regexp.quote(IMAGE_CLOSE)}|#{Regexp.quote(LABEL_OPEN)}|#{Regexp.quote(LABEL_CLOSE)}|#{Regexp.quote(LABEL_HTML_OPEN)}|#{Regexp.quote(LABEL_HTML_CLOSE)}|#{Regexp.quote(REFERENCE_OPEN)}|#{Regexp.quote(REFERENCE_CLOSE)}|#{Regexp.quote(REFERENCE_HTML_OPEN)}|#{Regexp.quote(REFERENCE_HTML_CLOSE)}|#{Regexp.quote(MANUEDO_OPEN)}|#{Regexp.quote(MANUEDO_CLOSE)}|#{Regexp.quote(VERB_OPEN)}|#{Regexp.quote(VERB_CLOSE)}|#{Regexp.quote(ERB_OPEN)}|#{Regexp.quote(ERB_CLOSE)}|#{Regexp.quote(BAR)}|#{Regexp.quote(QUOTE)}|#{Regexp.quote(SLASH)}|#{Regexp.quote(BACK_SLASH)})", other_re_mode)
-
+                      "\\A.+?(?=#{Regexp.quote(EM_OPEN)}|#{Regexp.quote(EM_CLOSE)}|#{Regexp.quote(ITALIC_OPEN)}|#{Regexp.quote(ITALIC_CLOSE)}|#{Regexp.quote(STRIKE_OPEN)}|#{Regexp.quote(STRIKE_CLOSE)}|#{Regexp.quote(FOOTNOTE_OPEN)}|#{Regexp.quote(FOOTNOTE_CLOSE)}|#{Regexp.quote(RUBY_OPEN)}|#{Regexp.quote(RUBY_CLOSE)}|#{Regexp.quote(IMAGE_OPEN)}|#{Regexp.quote(IMAGE_CLOSE)}|#{Regexp.quote(LABEL_OPEN)}|#{Regexp.quote(LABEL_CLOSE)}|#{Regexp.quote(LABEL_HTML_OPEN)}|#{Regexp.quote(LABEL_HTML_CLOSE)}|#{Regexp.quote(REFERENCE_OPEN)}|#{Regexp.quote(REFERENCE_CLOSE)}|#{Regexp.quote(REFERENCE_HTML_OPEN)}|#{Regexp.quote(REFERENCE_HTML_CLOSE)}|#{Regexp.quote(MANUEDO_OPEN)}|#{Regexp.quote(MANUEDO_CLOSE)}|#{Regexp.quote(VERB_OPEN)}|#{Regexp.quote(VERB_CLOSE)}|#{Regexp.quote(ERB_OPEN)}|#{Regexp.quote(ERB_CLOSE)}|#{Regexp.quote(HERB_OPEN)})", other_re_mode)
 
 def parse(src)
   @src = StringScanner.new(Array(src).join)
@@ -404,22 +378,10 @@ def next_token
     puts "i: ERB_CLOSE: #{ret}" if @view_token_type
     @pre << ret
     [:ERB_CLOSE, ret]
-  elsif ret = @src.scan(BAR_RE)
-    puts "i: BAR: #{ret}" if @view_token_type
-    @pre << ret
-    [:BAR, ret]
-  elsif ret = @src.scan(QUOTE_RE)
-    puts "i: QUOTE: #{ret}" if @view_token_type
-    @pre << ret
-    [:QUOTE, ret]
-  elsif ret = @src.scan(SLASH_RE)
-    puts "i: SLASH: #{ret}" if @view_token_type
-    @pre << ret
-    [:SLASH, ret]
-  elsif ret = @src.scan(BACK_SLASH_RE)
-    puts "i: BACK_SLASH: #{ret}" if @view_token_type
+  elsif ret = @src.scan(HERB_OPEN_RE)
+    puts "i: HERB_OPEN: #{ret}" if @view_token_type
     @pre << ret
-    [:BACK_SLASH, ret]
+    [:HERB_OPEN, ret]
   elsif ret = @src.scan(OTHER_RE)
     puts "i: OTHER_RE: #{ret}" if @view_token_type
     @pre << ret