bitclust-core 1.0.0 → 1.1.0

data/lib/bitclust/rdcompiler.rb

@@ -11,6 +11,8 @@ require 'bitclust/methodsignature'
 require 'bitclust/lineinput'
 require 'bitclust/htmlutils'
 require 'bitclust/textutils'
+require 'bitclust/messagecatalog'
+require 'bitclust/syntax_highlighter'
 require 'stringio'
 
 module BitClust
@@ -20,6 +22,7 @@ module BitClust
 
     include HTMLUtils
     include TextUtils
+    include Translatable
 
     def initialize(urlmapper, hlevel = 1, opt = {})
       @urlmapper = urlmapper
@@ -30,6 +33,7 @@ module BitClust
       @class = nil
       @method = nil
       @option = opt.dup
+      init_message_catalog(@catalog)
     end
 
     def compile(src)
@@ -80,7 +84,7 @@ module BitClust
           @item_stack = []
           item_list($1.size)
           raise "@item_stack should be empty. #{@item_stack.inspect}" unless @item_stack.empty?
-        when %r<\A//emlist\{>
+        when %r<\A//emlist(?:\[(?:[^\[\]]+?)?\]\[\w+?\])?\{>
           emlist
         when /\A:\s/
           dlist
@@ -133,7 +137,7 @@ module BitClust
           raise "@item_stack should be empty. #{@item_stack.inspect}" unless @item_stack.empty?
         when /\A:\s/
           dlist
-        when %r<\A//emlist\{>
+        when %r<\A//emlist(?:\[(?:[^\[\]]+?)?\]\[\w+?\])?\{>
           emlist
         when /\A\s+\S/
           list
@@ -221,7 +225,7 @@ module BitClust
     # empty lines separate paragraphs.
     def dd_with_p
       line '<dd>'
-      while /\A(?:\s|\z)/ =~ @f.peek or %r!\A//emlist\{! =~ @f.peek
+      while /\A(?:\s|\z)/ =~ @f.peek or %r!\A//emlist(?:\[(?:[^\[\]]+?)?\]\[\w+?\])?\{! =~ @f.peek
         case @f.peek
         when /\A$/
           @f.gets
@@ -231,8 +235,8 @@ module BitClust
             line compile_text(line.strip)
           end
           line '</p>'
-        when %r!\A//emlist\{!
-            emlist
+        when %r!\A//emlist(?:\[(?:[^\[\]]+?)?\]\[\w+?\])?\{!
+          emlist
         else
           raise 'must not happen'
         end
@@ -243,14 +247,14 @@ module BitClust
     # empty lines do not separate paragraphs.
     def dd_without_p
       line '<dd>'
-      while /\A[ \t]/ =~ @f.peek or %r!\A//emlist\{! =~ @f.peek
+      while /\A[ \t]/ =~ @f.peek or %r!\A//emlist(?:\[(?:[^\[\]]+?)?\]\[\w+?\])?\{! =~ @f.peek
         case @f.peek
         when  /\A[ \t\z]/
           @f.while_match(/\A[ \t\z]/) do |line|
             line compile_text(line.strip)
           end
-        when %r!\A//emlist\{!
-            emlist
+        when %r!\A//emlist(?:\[(?:[^\[\]]+?)?\]\[\w+?\])?\{!
+          emlist
         end
       end
       line '</dd>'
@@ -261,12 +265,28 @@ module BitClust
     end
 
     def emlist
-      @f.gets   # discard "//emlist{"
-      line '<pre>'
-      @f.until_terminator(%r<\A//\}>) do |line|
-        line escape_html(line.rstrip)
+      command = @f.gets
+      if %r!\A//emlist\[(?<caption>[^\[\]]+?)?\]\[(?<lang>\w+?)\]! =~ command
+        line "<pre class=\"highlight #{lang}\">"
+        line "<span class=\"caption\">#{escape_html(caption)}</span>" if caption
+        line "<code>"
+        src = ""
+        @f.until_terminator(%r<\A//\}>) do |line|
+          src << line
+        end
+        if lang == "ruby"
+          string BitClust::SyntaxHighlighter.new(src).highlight
+        else
+          string src
+        end
+        line '</code></pre>'
+      else
+        line '<pre>'
+        @f.until_terminator(%r<\A//\}>) do |line|
+          line escape_html(line.rstrip)
+        end
+        line '</pre>'
       end
-      line '</pre>'
     end
 
     def list
@@ -294,7 +314,7 @@ module BitClust
     end
 
     def read_paragraph(f)
-      f.span(%r<\A(?!---|=|//emlist\{)\S>)
+      f.span(%r<\A(?!---|=|//emlist(?:\[(?:[^\[\]]+?)?\]\[\w+?\])?\{)\S>)
     end
 
     def see
@@ -349,7 +369,7 @@ module BitClust
     end
 
     def read_entry_paragraph(f)
-      f.span(%r<\A(?!---|=|//emlist\{|@[a-z])\S>)
+      f.span(%r<\A(?!---|=|//emlist(?:\[(?:[^\[\]]+?)?\]\[\w+?\])?\{|@[a-z])\S>)
     end
 
     def method_signature(sig_line, first)

data/lib/bitclust/screen.rb

@@ -285,7 +285,7 @@ module BitClust
 
     def google_tag_manager
       tracking_id = @conf[:gtm_tracking_id]
-      return "" unless tracking_id
+      return "\b" unless tracking_id
       <<-HTML.chomp
 <!-- Global Site Tag (gtag.js) - Google Analytics -->
 <script async src="https://www.googletagmanager.com/gtag/js?id=#{tracking_id}"></script>
@@ -299,6 +299,17 @@ module BitClust
       HTML
     end
 
+    def meta_robots
+      content = @conf[:meta_robots_content]
+      return "\b" unless content
+      return "\b" if content.empty?
+      %Q(<meta name="robots" content="#{content.join(',')}">)
+    end
+
+    def meta_description
+      %Q(<meta name="description" content="">)
+    end
+
     private
 
     def default_encoding

data/lib/bitclust/subcommands/preproc_command.rb

@@ -13,7 +13,7 @@ module BitClust
         @parser.banner = "Usage: #{File.basename($0, '.*')} <file>..."
         @parser.on('--param=KVPAIR', 'Set parameter by key/value pair.') {|pair|
           key, value = pair.split('=', 2)
-          params[key] = value
+          @params[key] = value
         }
       end
 

data/lib/bitclust/subcommands/statichtml_command.rb

@@ -63,6 +63,10 @@ module BitClust
           @bitclust_html_base + "/" + @css_url
         end
 
+        def custom_css_url(filename)
+          @bitclust_html_base + "/" + filename
+        end
+
         def favicon_url
           @bitclust_html_base + "/" + @favicon_url
         end
@@ -99,6 +103,7 @@ module BitClust
         @themedir = srcdir_root + "theme/default"
         @suffix = ".html"
         @gtm_tracking_id = nil
+        @meta_robots_content = ["noindex"]
         @parser.banner = "Usage: #{File.basename($0, '.*')} statichtml [options]"
         @parser.on('-o', '--outputdir=PATH', 'Output directory') do |path|
           begin
@@ -129,6 +134,9 @@ module BitClust
         @parser.on('--tracking-id=ID', 'Google Tag Manager Tracking ID') do |id|
           @gtm_tracking_id = id
         end
+        @parser.on('--meta-robots-content=VALUE1,VALUE2,...', Array, 'HTML <meta> element: <meta name="robots" content="VALUE1,VALUE2..."') do |values|
+          @meta_robots_content = values
+        end
         @parser.on('--[no-]quiet', 'Be quiet') do |quiet|
           @verbose = !quiet
         end
@@ -174,6 +182,8 @@ module BitClust
         create_index_html(@outputdir)
         FileUtils.cp(@manager_config[:themedir] + @manager_config[:css_url],
                      @outputdir.to_s, {:verbose => @verbose, :preserve => true})
+        FileUtils.cp(@manager_config[:themedir] + "syntax-highlight.css",
+                     @outputdir.to_s, {:verbose => @verbose, :preserve => true})
         FileUtils.cp(@manager_config[:themedir] + @manager_config[:favicon_url],
                      @outputdir.to_s, {:verbose => @verbose, :preserve => true})
         Dir.mktmpdir do |tmpdir|
@@ -201,7 +211,8 @@ module BitClust
           :tochm_mode  => true,
           :fs_casesensitive => @fs_casesensitive,
           :canonical_base_url => @canonical_base_url,
-          :gtm_tracking_id => @gtm_tracking_id
+          :gtm_tracking_id => @gtm_tracking_id,
+          :meta_robots_content => @meta_robots_content,
         }
         @manager_config[:urlmapper] = URLMapperEx.new(@manager_config)
         @urlmapper = @manager_config[:urlmapper]

data/lib/bitclust/syntax_highlighter.rb

@@ -0,0 +1,318 @@
+require "ripper"
+require "bitclust/htmlutils"
+
+module BitClust
+  class SyntaxHighlighter < Ripper::Filter
+    include BitClust::HTMLUtils
+
+    COLORS = {
+      CHAR: "sc",                      # ?a
+      __end__: "k",                    # __END__
+      backref: "vg",                   # $` $& $' $1 ...
+      backtick: "sb",                  # `
+      comma: nil,                      # ,
+      comment: "c1",                   # #...
+      const: "no",                     # Const
+      cvar: "vc",                      # @@var
+      embdoc: nil,                     # (=begin) document (=end)
+      embdoc_beg: "cm",                # =begin
+      embdoc_end: nil,                 # =end
+      embexpr_beg: "si",               # #{
+      embexpr_end: "si",               # (#{) }
+      embvar: "n",                     # ("...) # (var")
+      float: "mf",                     # 1.23 (float)
+      gvar: "vg",                      # $var
+      heredoc_beg: "no",               # <<EOS
+      heredoc_end: "no",               # EOS
+      ident: nil,                      # identifier
+      ignored_nl: nil,                 # ignored \n
+      int: "mi",                       # 1 (integer)
+      ivar: "vi",                      # @var
+      kw: "k",                         # keyword
+      label: "ss",                     # label:
+      lbrace: "p",                     # {
+      lbracket: "p",                   # [
+      lparen: "p",                     # (
+      nl: nil,                         # \n
+      op: "o",                         # operator
+      period: "p",                     # .
+      qwords_beg: "sx",                # %w(
+      rbrace: "p",                     # }
+      rbracket: "p",                   # ]
+      regexp_beg: "sr",                # / (regexp/)
+      regexp_end: nil,                 # (/regexp) /
+      rparen: "p",                     # )
+      semicolon: nil,                  # ;
+      sp: nil,                         # space
+      symbeg: "ss",                    # :
+      tlambda: "o",                    # ->
+      tlambeg: "p",                    # (->) {
+      tstring_beg: nil,                # " (string")
+      tstring_content: nil,            # (") string (")
+      tstring_end: nil,                # ("string) "
+      words_beg: "sx",                 # %W(
+      words_sep: nil                   # (%W() )
+    }
+    LABELS = {
+    }
+
+    KEYWORDS = %w[
+      BEGIN END alias begin break case defined\? do else elsif end
+      ensure for if in next redo rescue raise retry return super then
+      undef unless until when while yield
+    ]
+
+    KEYWORDS_PSEUDO = %w[
+      loop include extend raise
+      alias_method attr catch throw private module_function
+      public protected true false nil __FILE__ __LINE__
+    ]
+
+    BUILTINS_G = %w[
+      attr_reader attr_writer attr_accessor
+
+      __id__ __send__ abort ancestors at_exit autoload binding callcc
+      caller catch chomp chop class_eval class_variables clone
+      const_defined\? const_get const_missing const_set constants
+      display dup eval exec exit extend fail fork format freeze
+      getc gets global_variables gsub hash id included_modules
+      inspect instance_eval instance_method instance_methods
+      instance_variable_get instance_variable_set instance_variables
+      lambda load local_variables loop method method_missing
+      methods module_eval name object_id open p print printf
+      private_class_method private_instance_methods private_methods proc
+      protected_instance_methods protected_methods public_class_method
+      public_instance_methods public_methods putc puts raise rand
+      readline readlines require require_relative scan select self send set_trace_func
+      singleton_methods sleep split sprintf srand sub syscall system
+      taint test throw to_a to_s trace_var trap untaint untrace_var warn
+    ]
+
+    BUILTINS_Q = %w[
+      autoload block_given const_defined eql equal frozen
+      include instance_of is_a iterator kind_of method_defined
+      nil private_method_defined protected_method_defined
+      public_method_defined respond_to tainted
+    ]
+
+    BUILTINS_B = %w[chomp chop exit gsub sub]
+
+    def initialize(*args)
+      super
+      @stack = []
+      @name_buffer = []
+    end
+
+    def on_default(event, token, data)
+      event_name = event.to_s.sub(/\Aon_/, "")   # :on_event --> "event"
+      style = COLORS[event_name.to_sym]
+      data << (style ? "<span class=\"#{style}\">#{escape_html(token)}</span>" : token)
+      data
+    end
+
+    def on_embdoc_beg(token, data)
+      style = COLORS[:embdoc_beg]
+      data << "<span class=\"#{style}\">#{token}"
+      data
+    end
+
+    def on_embdoc_end(token, data)
+      data << "#{token}</span>"
+      data
+    end
+
+    def on_ident(token, data)
+      case
+      when @stack.last == :symbol
+        data << "#{token}</span>"
+        @stack.pop
+      when @stack.last == :def
+        @stack.pop
+        data << "<span class=\"nf\">#{token}</span>"
+      when @stack.last == :embexpr
+        data << "<span class=\"n\">#{token}</span>"
+      when @stack.last == :heredoc
+        style = COLORS[:heredoc_beg]
+        data << "<span class=\"#{style}\">#{token}"
+      when @stack.last == :method_call
+        data << "<span class=\"nf\">#{token}</span>"
+        @stack.pop
+      when BUILTINS_G.include?(token)
+        data << "<span class=\"nb\">#{token}</span>"
+      else
+        data << token
+      end
+      data
+    end
+
+    def on_const(token, data)
+      case
+      when @stack.last == :class
+        @name_buffer << token
+      when @stack.last == :module
+        @name_buffer << token
+      else
+        on_default(:on_const, token, data)
+      end
+      data
+    end
+
+    def on_kw(token, data)
+      case
+      when @stack.last == :symbol
+        data << "#{token}</span>"
+        @stack.pop
+      when token == "module"
+        @stack.push(:module)
+        on_default(:on_kw, token, data)
+      when token == "class"
+        @stack.push(:class)
+        on_default(:on_kw, token, data)
+      when token == "def"
+        @stack.push(:def)
+        on_default(:on_kw, token, data)
+      when token == "self"
+        data << "<span class=\"nc\">#{token}</span>"
+      else
+        on_default(:on_kw, token, data)
+      end
+      data
+    end
+
+    def on_period(token, data)
+      @stack.push(:method_call)
+      on_default(:on_period, token, data)
+    end
+
+    def on_op(token, data)
+      case
+      when token == "::" && [:class, :module].include?(@stack.last)
+        @name_buffer << token
+      else
+        on_default(:on_op, token, data)
+      end
+      data
+    end
+
+    def on_sp(token, data)
+      case
+      when @name_buffer.empty?
+        return on_default(:on_sp, token, data)
+      when @stack.last == :module
+        name = @name_buffer.join
+        data << "<span class=\"nn\">#{name}</span>"
+        @stack.pop
+        @name_buffer.clear
+      when @stack.last == :class
+        namespace = @name_buffer.values_at(0..-3).join
+        operator = @name_buffer[-2]
+        name = @name_buffer.last
+        data << "<span class=\"nn\">#{namespace}</span>"
+        data << "<span class=\"o\">#{operator}</span>"
+        data << "<span class=\"nc\">#{name}</span>"
+        @stack.pop
+        @name_buffer.clear
+      end
+      on_default(:on_sp, token, data)
+    end
+
+    def on_nl(token, data)
+      case
+      when @name_buffer.empty?
+        return on_default(:on_nl, token, data)
+      when @stack.last == :module
+        name = @name_buffer.join
+        data << "<span class=\"nn\">#{name}</span>"
+        @stack.pop
+        @name_buffer.clear
+      when @stack.last == :class
+        namespace = @name_buffer.values_at(0..-3).join
+        operator = @name_buffer[-2]
+        name = @name_buffer.last
+        data << "<span class=\"nn\">#{namespace}</span>"
+        data << "<span class=\"o\">#{operator}</span>"
+        data << "<span class=\"nc\">#{name}</span>"
+        @stack.pop
+        @name_buffer.clear
+      end
+      on_default(:on_nl, token, data)
+    end
+
+    def on_regexp_beg(token, data)
+      style = COLORS[:regexp_beg]
+      data << "<span class=\"#{style}\">#{token}"
+      data
+    end
+
+    def on_regexp_end(token, data)
+      data << "#{token}</span>"
+      data
+    end
+
+    def on_symbeg(token, data)
+      style = COLORS[:symbeg]
+      data << "<span class=\"#{style}\">#{token}"
+      @stack << :symbol
+      data
+    end
+
+    def on_tstring_beg(token, data)
+      if token == "'"
+        data << "<span class=\"s1\">#{token}"
+        @stack << :string1
+      else
+        data << "<span class=\"s2\">#{token}</span>"
+        @stack << :string2
+      end
+      data
+    end
+
+    def on_tstring_content(token, data)
+      case
+      when @stack.last == :heredoc
+        data << "<span class=\"sh\">#{escape_html(token)}</span>"
+      when @stack.last == :string1
+        data << escape_html(token)
+      when @stack.last == :string2
+        data << "<span class=\"s2\">#{escape_html(token)}</span>"
+      else
+        on_default(:on_tstring_content, token, data)
+      end
+      data
+    end
+
+    def on_tstring_end(token, data)
+      if token == "'"
+        data << "#{token}</span>"
+      else
+        data << "<span class=\"s2\">#{token}</span>"
+      end
+      @stack.pop
+      data
+    end
+
+    def on_heredoc_beg(token, data)
+      @stack.push(:heredoc)
+      on_default(:on_heredoc_beg, token, data)
+    end
+
+    def on_heredoc_end(token, data)
+      @stack.pop
+      on_default(:on_heredoc_end, token, data)
+    end
+
+    def on_embexpr_beg(token, data)
+      @stack.push(:embexpr)
+      on_default(:on_embexpr_beg, token, data)
+    end
+
+    def on_embexpr_end(token, data)
+      @stack.pop
+      on_default(:on_embexpr_end, token, data)
+    end
+
+    def highlight
+      parse("")
+    end
+  end
+end