bitclust-core 1.2.1 → 1.2.6

data/lib/bitclust/ridatabase.rb

@@ -71,6 +71,7 @@ class Ent
   attr_reader :entry
 
   def ==(other)
+    return false if self.class != other.class
     @name == other.name
   end
 
@@ -121,7 +122,7 @@ class RiMethodEntry < Ent
   end
 
   def fullname
-    c, t, m = @entry.fullname.split(/([\.\#])/, 2)
+    c, t = @entry.fullname.split(/([\.\#])/, 2)
     "#{c}#{t}#{@name}"
   end
 end

data/lib/bitclust/rrdparser.rb

@@ -10,11 +10,11 @@
 require 'bitclust/compat'
 require 'bitclust/preprocessor'
 require 'bitclust/methodid'
+require 'bitclust/methoddatabase'
 require 'bitclust/lineinput'
 require 'bitclust/parseutils'
 require 'bitclust/nameutils'
 require 'bitclust/exception'
-require 'bitclust/methoddatabase'
 
 module BitClust
 
@@ -70,7 +70,7 @@ module BitClust
 
     def parse_file(path, libname, params = {})
       fopen(path, 'r:UTF-8') {|f|
-        return parse(f, libname, params)
+        return parse(f, libname, params).tap { |lib| lib.source_location = Location.new(path, 1) }
       }
     end
 
@@ -114,18 +114,14 @@ module BitClust
         type, name, superclass = *parse_level1_header(line)
         case type
         when 'class'
-          @context.define_class name, (superclass || 'Object')
+          @context.define_class name, (superclass || 'Object'), location: line.location
           read_class_body f
         when 'module'
           parse_error "superclass given for module", line  if superclass
-          @context.define_module name
+          @context.define_module name, location: line.location
           read_class_body f
         when 'object'
-          if superclass
-            # FIXME
-            tty_warn "#{line.location}: singleton object class not implemented yet"
-          end
-          @context.define_object name
+          @context.define_object name, superclass, location: line.location
           read_object_body f
         when 'reopen'
           @context.reopen_class name
@@ -353,29 +349,31 @@ module BitClust
         @library.sublibrary @db.get_library(libname)
       end
 
-      def define_class(name, supername)
+      def define_class(name, supername, location: nil)
         if @db.properties['version'] >= "1.9.0"
           top = 'BasicObject'
         else
           top = 'Object'
         end
         superclass = (name == top ? nil : @db.get_class(supername))
-        register_class :class, name, superclass
+        register_class :class, name, superclass, location: location
       end
 
-      def define_module(name)
-        register_class :module, name, nil
+      def define_module(name, location: nil)
+        register_class :module, name, nil, location: location
       end
 
-      def define_object(name)
-        register_class :object, name, nil
+      def define_object(name, singleton_object_class, location: nil)
+        singleton_object_class = @db.get_class(singleton_object_class) if singleton_object_class
+        register_class :object, name, singleton_object_class, location: location
       end
 
-      def register_class(type, name, superclass)
+      def register_class(type, name, superclass, location: nil)
         @klass = @db.open_class(name) {|c|
           c.type = type
           c.superclass = superclass
           c.library = @library
+          c.source_location = location
           @library.add_class c
         }
         @kind = :defined
@@ -452,10 +450,11 @@ module BitClust
       def define_method(chunk)
         id = method_id(chunk)
         @db.open_method(id) {|m|
-          m.names      = chunk.names.sort
-          m.kind       = @kind
-          m.visibility = @visibility || :public
-          m.source     = chunk.source
+          m.names           = chunk.names.sort
+          m.kind            = chunk.source.match?(/^@undef$/) ? :undefined : @kind
+          m.visibility      = @visibility || :public
+          m.source          = chunk.source
+          m.source_location = chunk.source.location
           case @kind
           when :added, :redefined
             @library.add_method m

data/lib/bitclust/screen.rb

@@ -13,7 +13,9 @@ require 'bitclust/htmlutils'
 require 'bitclust/nameutils'
 require 'bitclust/messagecatalog'
 require 'erb'
+require 'json'
 require 'stringio'
+require 'uri'
 
 module BitClust
 
@@ -185,7 +187,7 @@ module BitClust
     private
 
     def preproc(template)
-      template.gsub(/^\.include ([\w\-]+)/) { load($1.untaint) }.untaint
+      template.gsub(/^\.include ([\w\-]+)/) { load($1) }
     end
   end
 
@@ -366,6 +368,10 @@ module BitClust
       @urlmapper.canonical_url(current_url)
     end
 
+    def edit_url(location)
+      @urlmapper.edit_url(location)
+    end
+
     def opensearchdescription_url
       @urlmapper.opensearchdescription_url
     end
@@ -394,8 +400,11 @@ module BitClust
       @hlevel -= 1
     end
 
-    def headline(str)
-      "<h#{@hlevel}>#{escape_html(str)}</h#{@hlevel}>"
+    def headline(str, edit_url: nil)
+      edit_link = edit_url ? <<~HTML : ''
+        <span class="permalink">[<a href="#{edit_url}">edit</a>]</span>
+      HTML
+      "<h#{@hlevel}>#{escape_html(str)}</h#{@hlevel}>" + edit_link
     end
 
     def headline_noescape(str)
@@ -415,8 +424,12 @@ module BitClust
       end
     end
 
+    def manual_home_name
+      _('Ruby %s Reference Manual', ruby_version())
+    end
+
     def manual_home_link
-      document_link('index', _('Ruby %s Reference Manual', ruby_version()))
+      document_link('index', manual_home_name)
     end
 
     def friendly_library_link(id)
@@ -452,6 +465,28 @@ module BitClust
         yield sigs, body
       end
     end
+
+    def breadcrumb_json_ld(items)
+      {
+        '@context': 'http://schema.org',
+        '@type': 'BreadcrumbList',
+        'itemListElement' => items.map.with_index(1) do |item, index|
+          {
+            '@type' => 'ListItem',
+            'item' => item[:url],
+            'name' => item[:name],
+            'position' => index
+          }
+        end
+      }.to_json
+    end
+
+    def absolute_url_to(path)
+      ::URI.join(
+        canonical_url,
+        path
+      )
+    end
   end
 
   class IndexScreen < TemplateScreen

data/lib/bitclust/silent_progress_bar.rb

@@ -3,13 +3,17 @@ module BitClust
   # Null-object version of ProgressBar.
   class SilentProgressBar
 
-    attr_reader :title
+    attr_accessor :title
 
-    def initialize(title, total, out = $stderr)
-      @title, @total, @out = title, total, out
+    def self.create(output: $stderr, title:, total:)
+      self.new(output: output, title: title, total: total)
     end
 
-    def inc(step = 1)
+    def initialize(output:, title:, total:)
+      @title, @total, @output = title, total, output
+    end
+
+    def increment
     end
 
     def finish

data/lib/bitclust/simplesearcher.rb

@@ -13,7 +13,7 @@ module BitClust
       pat = to_pattern(pat)
       return [] if pat.empty? or /\A\s+\z/ =~ pat
       cname, type, mname = parse_method_spec_pattern(pat)
-      ret = cs = ms = []
+      cs = ms = []
       if cname and not cname.empty?
         if mname
           ms = find_class_method(db, cname, type, mname)

data/lib/bitclust/subcommand.rb

@@ -52,6 +52,15 @@ module BitClust
     def srcdir_root
       Pathname.new(__FILE__).realpath.dirname.parent.parent
     end
+
+    def align_progress_bar_title(title)
+      size = title.size
+      if size > 14
+        title[0..13]
+      else
+        title + ' ' * (14 - size)
+      end
+    end
   end
 end
 

data/lib/bitclust/subcommands/chm_command.rb

@@ -176,7 +176,7 @@ EOS
           end
 
           entries = db.docs + db.libraries.sort + db.classes.sort + methods.values.sort
-          pb = ProgressBar.new('entry', entries.size)
+          pb = ProgressBar.create(title: 'entry', total: entries.size)
           entries.each do |c|
             filename = create_html_file(c, manager, @outputdir, db)
             @html_files << filename
@@ -206,8 +206,8 @@ EOS
                   Sitemap::Content.new("#{e.klass.name}#{e.typemark}#{name} (#{e.library.name})", filename)
               end
             end
-            pb.title.replace(e.name)
-            pb.inc
+            pb.title = align_progress_bar_title(e.name)
+            pb.increment
           end
           pb.finish
         end

data/lib/bitclust/subcommands/methods_command.rb

@@ -102,7 +102,7 @@ module BitClust
       ORDER = { '.' => 1, '#' => 2, '::' => 3 }
 
       def m_order(m)
-        m, t, c = *m.reverse.split(/(\#|\.|::)/, 2)
+        m, t = *m.reverse.split(/(\#|\.|::)/, 2)
         [ORDER[t] || 0, m.reverse]
       end
 

data/lib/bitclust/subcommands/server_command.rb

@@ -27,7 +27,12 @@ module BitClust
         @srcdir = @datadir = @themedir = @theme = @templatedir = nil
         @encoding = 'utf-8'   # encoding of view
         if Object.const_defined?(:Encoding)
-          Encoding.default_external = @encoding
+          begin
+            verbose, $VERBOSE = $VERBOSE, false
+            Encoding.default_external = @encoding
+          ensure
+            $VERBOSE = verbose
+          end
         end
 
         @debugp = false

data/lib/bitclust/subcommands/setup_command.rb

@@ -19,13 +19,13 @@ module BitClust
         @prepare = nil
         @cleanup = nil
         @purge = nil
-        @versions = ["2.1.0", "2.2.0", "2.3.0", "2.4.0"]
+        @versions = ["2.4.0", "2.5.0", "2.6.0"]
         @update = true
         @parser.banner = "Usage: #{File.basename($0, '.*')} setup [options]"
         @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

@@ -28,6 +28,7 @@ module BitClust
           @suffix = h[:suffix]
           @fs_casesensitive = h[:fs_casesensitive]
           @canonical_base_url = h[:canonical_base_url]
+          @edit_base_url = h[:edit_base_url]
         end
 
         def library_url(name)
@@ -67,6 +68,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
@@ -83,6 +88,10 @@ module BitClust
           (@canonical_base_url + "/#{current_url}").sub(@bitclust_html_base, "").sub(/([^:])\/\/+/, "\\1/")
         end
 
+        def edit_url(location)
+          "#{@edit_base_url}/#{location.file}#L#{location.line}".sub(/([^:])\/\/+/, "\\1/")
+        end
+
         def encodename_package(str)
           if @fs_casesensitive
             encodename_url(str)
@@ -94,7 +103,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 +118,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
@@ -131,12 +146,18 @@ module BitClust
         @parser.on('--canonical-base-url=URL', 'Canonical base URL') do |url|
           @canonical_base_url = url
         end
+        @parser.on('--edit-base-url=URL', 'Edit base URL') do |url|
+          @edit_base_url = url
+        end
         @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-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
@@ -165,7 +186,6 @@ module BitClust
         end
 
         fdb.transaction do
-          functions = {}
           create_html_entries("capi", fdb.functions, manager, fdb)
         end
 
@@ -181,19 +201,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
 
@@ -211,42 +233,46 @@ module BitClust
           :tochm_mode  => true,
           :fs_casesensitive => @fs_casesensitive,
           :canonical_base_url => @canonical_base_url,
+          :edit_base_url => @edit_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]
       end
 
       def create_html_entries(title, entries, manager, db)
+        title = align_progress_bar_title(title)
         original_title = title.dup
         if @verbose
-          progressbar = ProgressBar.new(title, entries.size)
+          progressbar = ProgressBar.create(title: title, total: entries.size)
         else
-          progressbar = SilentProgressBar.new(title, entries.size)
+          progressbar = SilentProgressBar.create(title: title, total: entries.size)
         end
         entries.each do |entry|
           create_html_file(entry, manager, @outputdir, db)
-          progressbar.title.replace([entry].flatten.first.name)
-          progressbar.inc
+          progressbar.title = align_progress_bar_title([entry].flatten.first.name)
+          progressbar.increment
         end
-        progressbar.title.replace(original_title)
+        progressbar.title = original_title
         progressbar.finish
       end
 
       def create_html_methods(title, methods, manager, db)
+        title = align_progress_bar_title(title)
         original_title = title.dup
         if @verbose
-          progressbar = ProgressBar.new(title, methods.size)
+          progressbar = ProgressBar.create(title: title, total: methods.size)
         else
-          progressbar = SilentProgressBar.new(title, methods.size)
+          progressbar = SilentProgressBar.create(title: title, total: methods.size)
         end
         methods.each do |method_name, method_entries|
           create_html_method_file(method_name, method_entries, manager, @outputdir, db)
-          progressbar.title.replace(method_name)
-          progressbar.inc
+          progressbar.title = align_progress_bar_title(method_name)
+          progressbar.increment
         end
-        progressbar.title.replace(original_title)
+        progressbar.title = original_title
         progressbar.finish
       end
 
@@ -268,7 +294,6 @@ HERE
           @urlmapper.bitclust_html_base = '..'
           path = outputdir + e.type_id.to_s + html_filename(encodename_package(e.name), @suffix)
           create_html_file_p(entry, manager, path, db)
-          path.relative_path_from(outputdir).to_s
         when :function
           create_html_function_file(entry, manager, outputdir, db)
         else
@@ -285,7 +310,6 @@ HERE
         path = outputdir + e.type_id.to_s + encodename_package(e.klass.name) +
           e.typechar + html_filename(encodename_package(name), @suffix)
         create_html_file_p(entries, manager, path, db)
-        path.relative_path_from(outputdir).to_s
       end
 
       def create_html_function_file(entry, manager, outputdir, db)
@@ -293,7 +317,6 @@ HERE
         @urlmapper.bitclust_html_base = '..'
         path = outputdir + entry.type_id.to_s + html_filename(entry.name, @suffix)
         create_html_file_p(entry, manager, path, db)
-        path.relative_path_from(outputdir).to_s
       end
 
       def create_html_file_p(entry, manager, path, db)