bitclust-core 1.2.3 → 1.2.4

data/data/bitclust/template.offline/method

@@ -1,16 +1,59 @@
 <%
     entry = @entries.sort.first
-    @title = "#{entry.type_label} #{entry.label}"
+    @title = entry.label
     @description = entry.description
 %>
-<p>
-<%= manual_home_link() %>
-&gt; <a href="<%= library_index_url() %>"><%= _('All Libraries') %></a>
-&gt; <%= friendly_library_link(entry.library.name) %>
-&gt; <%= class_link(entry.klass.name, _(entry.klass.type.to_s + ' %s', entry.klass.name)) %>
-&gt; <% if entry.typename == :special_variable %>$<% end %><%=h entry.name %>
-<% unless entry.really_public? %>(<%= entry.visibility %>)<% end %>
-</p>
+<% if @conf[:canonical_base_url] %>
+<script type="application/ld+json">
+<%=
+  breadcrumb_json_ld(
+    [
+      {
+        name: manual_home_name,
+        url: absolute_url_to(@urlmapper.document_url('index'))
+      },
+      {
+        name: _('All Libraries'),
+        url: absolute_url_to(library_index_url),
+      },
+      {
+        name: friendly_library_name(entry.library.name),
+        url: absolute_url_to(@urlmapper.library_url(entry.library.name))
+      },
+      {
+        name: _("#{entry.klass.type} %s", entry.klass.name),
+        url: absolute_url_to(@urlmapper.class_url(entry.klass.name))
+      },
+      {
+        name: %Q<#{'$' if entry.typename == :special_variable}#{entry.name}#{" (#{entry.visibility})" unless entry.really_public?}>,
+        url: canonical_url
+      }
+    ]
+  )
+%>
+</script>
+<% end %>
+<header>
+  <nav>
+    <ol class="inline-breadcrumb-list">
+      <li>
+        <%= manual_home_link() %>
+      </li>
+      <li>
+        <a href="<%= library_index_url() %>"><%= _('All Libraries') %></a>
+      </li>
+      <li>
+        <%= friendly_library_link(entry.library.name) %>
+      </li>
+      <li>
+        <%= class_link(entry.klass.name, _(entry.klass.type.to_s + ' %s', entry.klass.name)) %>
+      </li>
+      <li>
+        <% if entry.typename == :special_variable %>$<% end %><%=h entry.name %> <% unless entry.really_public? %>(<%= entry.visibility %>)<% end %>
+      </li>
+    </ol>
+  </nav>
+</header>
 
 <% headline_init %>
 <%= headline("#{entry.type_label} #{entry.label}") %>
@@ -25,4 +68,3 @@
     headline_pop
 %>
 </dl>
-

data/lib/bitclust/classentry.rb

@@ -39,6 +39,7 @@ module BitClust
     attr_reader :id
 
     def ==(other)
+      return false if self.class != other.class
       @id == other.id
     end
 

data/lib/bitclust/completion.rb

@@ -499,6 +499,7 @@ $cm_comb_m += 1
       end
 
       def ==(other)
+        return false if self.class != other.class
         @idstring == other.idstring
       end
 

data/lib/bitclust/docentry.rb

@@ -28,6 +28,7 @@ module BitClust
     attr_reader :id
 
     def ==(other)
+      return false if self.class != other.class
       @id == other.id
     end
 

data/lib/bitclust/libraryentry.rb

@@ -35,6 +35,7 @@ module BitClust
         @link_checked = false
       end
       init_properties
+      @all_classes = nil
     end
 
     attr_reader :id, :name
@@ -42,6 +43,7 @@ module BitClust
     alias label name
 
     def ==(other)
+      return false if self.class != other.class
       @id == other.id
     end
 
@@ -217,5 +219,5 @@ module BitClust
         @db.dirty_library self
       end
     end
- end
+  end
 end

data/lib/bitclust/methodentry.rb

@@ -29,6 +29,7 @@ module BitClust
     attr_reader :id
 
     def ==(other)
+      return false if self.class != other.class
       @id == other.id
     end
 
@@ -101,7 +102,7 @@ module BitClust
     }
 
     def inspect
-      c, t, m, lib = methodid2specparts(@id)
+      c, t, _m, _lib = methodid2specparts(@id)
       "\#<method #{c}#{t}#{names().join(',')}>"
     end
 
@@ -114,12 +115,12 @@ module BitClust
     end
 
     def label
-      c, t, m, lib = methodid2specparts(@id)
+      c, t, m, _lib = methodid2specparts(@id)
       "#{t == '$' ? '' : c}#{t}#{m}"
     end
 
     def short_label
-      c, t, m, lib = methodid2specparts(@id)
+      _c, t, m, _lib = methodid2specparts(@id)
       "#{t == '#' ? '' : t}#{m}"
     end
 
@@ -128,7 +129,7 @@ module BitClust
     end
 
     def labels
-      c, t, m, lib = methodid2specparts(@id)
+      c, t, _m, _lib = methodid2specparts(@id)
       names().map {|name| "#{c}#{t}#{name}" }
     end
 

data/lib/bitclust/methodid.rb

@@ -93,6 +93,7 @@ module BitClust
     end
 
     def ==(other)
+      return false if self.class != other.class
       @klass == other.klass and
       @type == other.type and
       @method == other.method

data/lib/bitclust/nameutils.rb

@@ -67,7 +67,7 @@ module BitClust
     end
 
     def methodid2specstring(id)
-      c, t, m, lib = *split_method_id(id)
+      c, t, m, _lib = *split_method_id(id)
       classid2name(c) + typechar2mark(t) + decodename_url(m)
     end
 
@@ -77,32 +77,32 @@ module BitClust
     end
 
     def methodid2libid(id)
-      c, t, m, lib = *split_method_id(id)
+      _c, _t, _m, lib = *split_method_id(id)
       lib
     end
 
     def methodid2classid(id)
-      c, t, m, lib = *split_method_id(id)
+      c, _t, _m, _lib = *split_method_id(id)
       c
     end
 
     def methodid2typechar(id)
-      c, t, m, lib = *split_method_id(id)
+      _c, t, _m, _lib = *split_method_id(id)
       t
     end
 
     def methodid2typename(id)
-      c, t, m, lib = *split_method_id(id)
+      _c, t, _m, _lib = *split_method_id(id)
       typechar2name(t)
     end
 
     def methodid2typemark(id)
-      c, t, m, lib = *split_method_id(id)
+      _c, t, _m, _lib = *split_method_id(id)
       typechar2mark(t)
     end
 
     def methodid2mname(id)
-      c, t, m, lib = *split_method_id(id)
+      _c, _t, m, _lib = *split_method_id(id)
       decodename_url(m)
     end
 

data/lib/bitclust/preprocessor.rb

@@ -86,7 +86,7 @@ module BitClust
             file = $1.strip
             basedir = File.dirname(line.location.file)
             @buf.concat Preprocessor.process("#{basedir}/#{file}", @params)
-          rescue Errno::ENOENT => err
+          rescue Errno::ENOENT => _err
             raise WrongInclude, "#{line.location}: \#@include'ed file not exist: #{file}"
           end
         when /\A\#@since\b/
@@ -321,7 +321,7 @@ module BitClust
             file = $1.strip
             basedir = File.dirname(line.location.file)
             @buf.concat LineCollector.process("#{basedir}/#{file}")
-          rescue Errno::ENOENT => err
+          rescue Errno::ENOENT => _err
             raise WrongInclude, "#{line.location}: \#@include'ed file not exist: #{file}"
           end
         else

data/lib/bitclust/rdcompiler.rb

@@ -229,9 +229,9 @@ module BitClust
         case @f.peek
         when /\A$/
           @f.gets
-        when  /\A[ \t\z]/
+        when  /\A[ \t]/
           line '<p>'
-          line compile_text(text_node_from_lines(@f.span(/\A[ \t\z]/)))
+          line compile_text(text_node_from_lines(@f.span(/\A[ \t]/)))
           line '</p>'
         when %r!\A//emlist(?:\[(?:[^\[\]]+?)?\]\[\w+?\])?\{!
           emlist
@@ -247,8 +247,8 @@ module BitClust
       line '<dd>'
       while /\A[ \t]/ =~ @f.peek or %r!\A//emlist(?:\[(?:[^\[\]]+?)?\]\[\w+?\])?\{! =~ @f.peek
         case @f.peek
-        when  /\A[ \t\z]/
-          line compile_text(text_node_from_lines(@f.span(/\A[ \t\z]/)))
+        when  /\A[ \t]/
+          line compile_text(text_node_from_lines(@f.span(/\A[ \t]/)))
         when %r!\A//emlist(?:\[(?:[^\[\]]+?)?\]\[\w+?\])?\{!
           emlist
         end
@@ -260,6 +260,11 @@ module BitClust
       "<dt>#{s}</dt>"
     end
 
+    def stop_on_syntax_error?
+      return true unless @option.key?(:stop_on_syntax_error)
+      @option[:stop_on_syntax_error]
+    end
+
     def emlist
       command = @f.gets
       if %r!\A//emlist\[(?<caption>[^\[\]]+?)?\]\[(?<lang>\w+?)\]! =~ command
@@ -276,7 +281,11 @@ module BitClust
             string BitClust::SyntaxHighlighter.new(src, filename).highlight
           rescue BitClust::SyntaxHighlighter::Error => ex
             $stderr.puts ex.message
-            exit(false)
+            if stop_on_syntax_error?
+              exit(false)
+            else
+              string src
+            end
           end
         else
           string src
@@ -319,7 +328,7 @@ module BitClust
 
     def see
       header = @f.gets
-      cmd = header.slice!(/\A\@\w+/)
+      header.slice!(/\A\@\w+/)
       body = [header] + @f.span(/\A\s+\S/)
       line '<p>'
       line '[SEE_ALSO] ' + compile_text(text_node_from_lines(body))
@@ -328,7 +337,7 @@ module BitClust
 
     def todo
       header = @f.gets
-      cmd = header.slice!(/\A\@\w+/)
+      header.slice!(/\A\@\w+/)
       body = header
       line '<p class="todo">'
       line '[TODO]' + body
@@ -544,7 +553,7 @@ module BitClust
     end
 
     def rdoc_url(method_id, version)
-      cname, tmark, mname, libname = methodid2specparts(method_id)
+      cname, tmark, mname, _libname = methodid2specparts(method_id)
       tchar = typemark2char(tmark) == 'i' ? 'i' : 'c'
       cname = cname.split(".").first
       cname = cname.gsub('::', '/')

data/lib/bitclust/requesthandler.rb

@@ -207,7 +207,7 @@ module BitClust
     end
 
     def defined_type?
-      type, param = parse_path_info()
+      type, _param = parse_path_info()
       case type
       when 'library', 'class', 'method', 'function', 'search', 'opensearchdescription'
         true
@@ -217,7 +217,7 @@ module BitClust
     end
 
     def type_id
-      type, param = parse_path_info()
+      type, _param = parse_path_info()
       type.intern if type
     end
 
@@ -256,7 +256,7 @@ module BitClust
     private
 
     def type_param
-      type, param = parse_path_info()
+      _type, param = parse_path_info()
       return nil unless param
       return nil if param.empty?
       param

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

@@ -14,7 +14,6 @@ require 'bitclust/lineinput'
 require 'bitclust/parseutils'
 require 'bitclust/nameutils'
 require 'bitclust/exception'
-require 'bitclust/methoddatabase'
 
 module BitClust
 

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
 
@@ -415,8 +417,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 +458,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/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/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