bitclust-core 1.2.3 → 1.2.4

data/lib/bitclust/subcommands/setup_command.rb

@@ -25,7 +25,7 @@ module BitClust
         @parser.on('--prepare', 'Prepare config file and checkout repository. Do not create database.') {
           @prepare = true
         }
-        @parser.on('--cleanup', 'Cleanup datebase before create database.') {
+        @parser.on('--cleanup', 'Cleanup database before create database.') {
           @cleanup = true
         }
         @parser.on('--purge', 'Purge all downloaded and generated files and exit.') {

data/lib/bitclust/subcommands/statichtml_command.rb

@@ -67,6 +67,10 @@ module BitClust
           @bitclust_html_base + "/" + filename
         end
 
+        def custom_js_url(filename)
+          @bitclust_html_base + "/" + filename
+        end
+
         def favicon_url
           @bitclust_html_base + "/" + @favicon_url
         end
@@ -94,7 +98,12 @@ module BitClust
 
       def initialize
         if Object.const_defined?(:Encoding)
-          Encoding.default_external = 'utf-8'
+          begin
+            verbose, $VERBOSE = $VERBOSE, false
+            Encoding.default_external = 'utf-8'
+          ensure
+            $VERBOSE = verbose
+          end
         end
         super
         @verbose = true
@@ -104,6 +113,7 @@ module BitClust
         @suffix = ".html"
         @gtm_tracking_id = nil
         @meta_robots_content = ["noindex"]
+        @stop_on_syntax_error = true
         @parser.banner = "Usage: #{File.basename($0, '.*')} statichtml [options]"
         @parser.on('-o', '--outputdir=PATH', 'Output directory') do |path|
           begin
@@ -137,6 +147,9 @@ module BitClust
         @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-stop-on-syntax-error', 'Do not stop on syntax error') do |boolean|
+          @stop_on_syntax_error = boolean
+        end
         @parser.on('--[no-]quiet', 'Be quiet') do |quiet|
           @verbose = !quiet
         end
@@ -180,19 +193,21 @@ module BitClust
                     :verbose => @verbose)
         create_index_html(@outputdir)
         FileUtils.cp(@manager_config[:themedir] + @manager_config[:css_url],
-                     @outputdir.to_s, {:verbose => @verbose, :preserve => true})
+                     @outputdir.to_s, :verbose => @verbose, :preserve => true)
         FileUtils.cp(@manager_config[:themedir] + "syntax-highlight.css",
-                     @outputdir.to_s, {:verbose => @verbose, :preserve => true})
+                     @outputdir.to_s, :verbose => @verbose, :preserve => true)
+        FileUtils.cp(@manager_config[:themedir] + "script.js",
+                     @outputdir.to_s, :verbose => @verbose, :preserve => true)
         FileUtils.cp(@manager_config[:themedir] + @manager_config[:favicon_url],
-                     @outputdir.to_s, {:verbose => @verbose, :preserve => true})
+                     @outputdir.to_s, :verbose => @verbose, :preserve => true)
         Dir.mktmpdir do |tmpdir|
           FileUtils.cp_r(@manager_config[:themedir] + 'images', tmpdir,
-                         {:verbose => @verbose, :preserve => true})
+                         :verbose => @verbose, :preserve => true)
           Dir.glob(File.join(tmpdir, 'images', '/**/.svn')).each do |d|
-            FileUtils.rm_r(d, {:verbose => @verbose})
+            FileUtils.rm_r(d, :verbose => @verbose)
           end
           FileUtils.cp_r(File.join(tmpdir, 'images'), @outputdir.to_s,
-                         {:verbose => @verbose, :preserve => true})
+                         :verbose => @verbose, :preserve => true)
         end
       end
 
@@ -212,6 +227,7 @@ module BitClust
           :canonical_base_url => @canonical_base_url,
           :gtm_tracking_id => @gtm_tracking_id,
           :meta_robots_content => @meta_robots_content,
+          :stop_on_syntax_error => @stop_on_syntax_error,
         }
         @manager_config[:urlmapper] = URLMapperEx.new(@manager_config)
         @urlmapper = @manager_config[:urlmapper]

data/lib/bitclust/syntax_highlighter.rb

@@ -122,17 +122,18 @@ module BitClust
       @stack = []
       @name_buffer = []
       @__lexer.define_singleton_method(:on_parse_error) do |message|
-        raise ParseError.new(filename, self.lineno, self.column, message)
+        raise ParseError.new(filename, self.lineno, self.column, "#{message}\n#{src}")
       end
       @__lexer.define_singleton_method(:compile_error) do |message|
-        raise CompileError.new(filename, self.lineno, self.column, message)
+        raise CompileError.new(filename, self.lineno, self.column, "#{message}\n#{src}")
       end
     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)
+      escaped_token = escape_html(token)
+      data << (style ? "<span class=\"#{style}\">#{escaped_token}</span>" : escaped_token)
       data
     end
 

data/lib/bitclust/version.rb

@@ -1,3 +1,3 @@
 module BitClust
-  VERSION = "1.2.3"
+  VERSION = "1.2.4"
 end

data/test/test_bitclust.rb

@@ -31,7 +31,7 @@ HERE
   end
 
   def search_capi(command, *argv)
-    db = BitClust::FunctionDatabase.new(@tmpdir)
+    _db = BitClust::FunctionDatabase.new(@tmpdir)
     cmd = case command
           when "lookup"
             BitClust::Subcommands::LookupCommand.new

data/test/test_syntax_highlighter.rb

@@ -8,14 +8,14 @@ class TestSyntaxHighlighter < Test::Unit::TestCase
   sub_test_case "syntax error" do
     test "single line" do
       src = "foo(\n"
-      assert_raise(BitClust::SyntaxHighlighter::ParseError.new("-", 1, 5, "syntax error, unexpected end-of-input, expecting ')'")) do
+      assert_raise(BitClust::SyntaxHighlighter::ParseError.new("-", 1, 5, "syntax error, unexpected end-of-input, expecting ')'\n#{src}")) do
         highlight(src)
       end
     end
 
     test "multiple line" do
       src = "a = 1\nfoo(\n"
-      assert_raise(BitClust::SyntaxHighlighter::ParseError.new("-", 2, 5, "syntax error, unexpected end-of-input, expecting ')'")) do
+      assert_raise(BitClust::SyntaxHighlighter::ParseError.new("-", 2, 5, "syntax error, unexpected end-of-input, expecting ')'\n#{src}")) do
         highlight(src)
       end
     end
@@ -64,4 +64,10 @@ class TestSyntaxHighlighter < Test::Unit::TestCase
       assert_equal(expected, highlight(source))
     end
   end
+
+  test 'htmlescape' do
+    source = 'puts /<a>/'
+    expected = '<span class="nb">puts</span> <span class="sr">/&lt;a&gt;/</span>'
+    assert_equal(expected, highlight(source))
+  end
 end

data/theme/default/rurema.svg

@@ -0,0 +1,31 @@
+<?xml version="1.0"?>
+<svg width="16" height="16" viewBox="0 0 16 16" version="1.1" xmlns="http://www.w3.org/2000/svg">
+  <rect x="2" y="1" width="12" height="12" fill="#33a"/>
+
+  <rect x="4" y="2" width="8" height="10" fill="#f00"/>
+  <rect x="3" y="3" width="1" height="8" fill="#000"/>
+  <rect x="5" y="1" width="6" height="1" fill="#000"/>
+  <rect x="12" y="3" width="1" height="8" fill="#000"/>
+  <rect x="5" y="12" width="6" height="1" fill="#000"/>
+
+  <rect x="4" y="2" width="1" height="1" fill="#300"/>
+  <rect x="11" y="2" width="1" height="1" fill="#300"/>
+  <rect x="4" y="11" width="1" height="1" fill="#300"/>
+  <rect x="11" y="11" width="1" height="1" fill="#300"/>
+
+  <rect x="5" y="3" width="1" height="1" fill="#600"/>
+  <rect x="10" y="3" width="1" height="1" fill="#600"/>
+  <rect x="5" y="10" width="1" height="1" fill="#600"/>
+  <rect x="10" y="10" width="1" height="1" fill="#600"/>
+
+  <rect x="6" y="4" width="4" height="6" fill="#000"/>
+  <rect x="7" y="5" width="2" height="4" fill="#f00"/>
+
+  <rect x="2" y="0" width="12" height="1" fill="#000"/>
+  <rect x="14" y="0" width="1" height="14" fill="#000"/>
+  <rect x="2" y="13" width="12" height="1" fill="#000"/>
+  <rect x="1" y="1" width="1" height="14" fill="#000"/>
+  <rect x="2" y="14" width="11" height="1" fill="#ccc"/>
+  <rect x="13" y="14" width="1" height="1" fill="#000"/>
+  <rect x="2" y="15" width="13" height="1" fill="#000"/>
+</svg>

data/theme/default/script.js

@@ -0,0 +1,35 @@
+(function() {
+  window.onload = function() {
+    const elems = document.getElementsByClassName('highlight')
+
+    let tempDiv = document.createElement('div')
+
+    Array.prototype.forEach.call(elems,
+      function(elem) {
+        // sample code without caption
+        tempDiv.innerHTML = elem.innerHTML
+        const caption = tempDiv.getElementsByClassName("caption")[0]
+        if (caption) tempDiv.removeChild(caption)
+
+        // textarea for preserving the copy text
+        const copyText = document.createElement('textarea')
+        copyText.setAttribute('class', 'highlight__copy-text')
+        copyText.innerHTML = tempDiv.textContent.replace(/^\n+/, "").replace(/\n{2,}$/, "\n")
+        elem.appendChild(copyText)
+
+        // COPY button
+        const btn = document.createElement('div')
+        btn.setAttribute('class', 'highlight__copy-button')
+        // btn.textContent = "COPY"
+        elem.insertBefore(btn, elem.firstChild)
+
+        btn.onclick = function(){
+          copyText.select()
+          document.execCommand("copy")
+          btn.classList.add("copied")
+          window.setTimeout(function() { btn.classList.remove("copied") }, 1000)
+        }
+      }
+    )
+  }
+})()

data/theme/default/style.css

@@ -134,6 +134,34 @@ pre.highlight {
     position: relative;
 }
 
+/* for COPY */
+.highlight__copy-button {
+  float: right;
+  margin: 0 -1.1em 0.25em 0.5em;
+  padding: 0.25em 0.5em;
+  background: #DDD;
+  opacity: 0.75;
+  cursor: pointer;
+}
+.highlight__copy-button:hover {
+  background: #EE8;
+  opacity: 1;
+}
+.highlight__copy-button::after {
+  content: "COPY"
+}
+.highlight__copy-button.copied {
+  background: #070;
+  color: white;
+}
+.highlight__copy-button.copied::after {
+  content: "COPIED"
+}
+.highlight__copy-text {
+  position: fixed;
+  left: -1000px;
+}
+
 pre .caption {
     position: absolute;
     top: 0;
@@ -285,6 +313,43 @@ hr {
     height: 1px;
 }
 
+.inline-breadcrumb-list {
+    display: inline-block;
+    list-style-type: none;
+    margin-bottom: 0;
+    margin-top: 0;
+    padding-left: 0;
+}
+
+.inline-breadcrumb-list li {
+    display: inline-block;
+    margin-bottom: 0;
+}
+
+.inline-breadcrumb-list li + li::before {
+    content: ">";
+    padding-left: 0.1rem;
+    padding-right: 0.1rem;
+}
+
+.inline-ancestors-list {
+    display: inline-flex;
+    flex-direction: row-reverse;
+    list-style-type: none;
+    margin-bottom: 0;
+    margin-top: 0;
+    padding-left: 0;
+}
+
+.inline-ancestors-list li {
+    margin-bottom: 0;
+}
+
+.inline-ancestors-list li + li::after {
+    content: "<";
+    padding-right: 0.3rem;
+}
+
 @media print {
     body {
         font-family: osaka,'MS Mincho',serif;

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bitclust-core
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 1.2.4
 platform: ruby
 authors:
 - https://github.com/rurema
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-20 00:00:00.000000000 Z
+date: 2020-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: test-unit
@@ -222,6 +222,8 @@ files:
 - test/test_syntax_highlighter.rb
 - theme/default/images/external.png
 - theme/default/rurema.png
+- theme/default/rurema.svg
+- theme/default/script.js
 - theme/default/style.css
 - theme/default/syntax-highlight.css
 - theme/default/test.css
@@ -251,19 +253,19 @@ signing_key:
 specification_version: 4
 summary: BitClust is a rurema document processor.
 test_files:
-- test/test_nameutils.rb
 - test/run_test.rb
-- test/test_methodsignature.rb
-- test/test_rrdparser.rb
-- test/test_refsdatabase.rb
-- test/test_libraryentry.rb
-- test/test_rdcompiler.rb
+- test/test_nameutils.rb
+- test/test_functiondatabase.rb
+- test/test_bitclust.rb
+- test/test_simplesearcher.rb
 - test/test_functionreferenceparser.rb
 - test/test_runner.rb
-- test/test_syntax_highlighter.rb
-- test/test_bitclust.rb
-- test/test_functiondatabase.rb
+- test/test_refsdatabase.rb
+- test/test_methodsignature.rb
+- test/test_libraryentry.rb
+- test/test_rrdparser.rb
+- test/test_preprocessor.rb
 - test/test_entry.rb
 - test/test_methoddatabase.rb
-- test/test_simplesearcher.rb
-- test/test_preprocessor.rb
+- test/test_rdcompiler.rb
+- test/test_syntax_highlighter.rb