RubyGems - bitclust-core - Versions diffs - 0.9.1 → 0.9.2 - Mend

bitclust-core 0.9.1 → 0.9.2

Files changed (12) hide show

checksums.yaml +4 -4
data/README +1 -1
data/bitclust.gemspec +3 -4
data/data/bitclust/template.offline/layout +3 -0
data/lib/bitclust/classentry.rb +11 -11
data/lib/bitclust/rdcompiler.rb +9 -1
data/lib/bitclust/screen.rb +46 -0
data/lib/bitclust/subcommands/setup_command.rb +6 -1
data/lib/bitclust/subcommands/statichtml_command.rb +10 -1
data/lib/bitclust/version.rb +1 -1
data/test/test_rdcompiler.rb +26 -2
metadata +10 -10

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 813fd0a958a2ff7b7f259e9b5062320fe4843e83
-  data.tar.gz: 3bf8717df91192350fb707e2786e562cbc348d7c
+  metadata.gz: 225e62375e6846b326301d1189046131860d338a
+  data.tar.gz: 3971f2a4f69e7e961b4bd9383ca3dd1314206a78
 SHA512:
-  metadata.gz: 429bcf55db96845ff5a694c28c034f1467aa3e545c95f2aa6a5d49956211c604aef052efd13c760a4094d3e4aa1fb55e4d6e9ee219457420d2ad15fc1c7f8d8c
-  data.tar.gz: 2d3fb710287a7ccc05a007c399633ac3a583f2e48644ccb6346d93315251798810940ad0f4921b15e87bca2a62d639eb7596046752f02956d2440981bcf44027
+  metadata.gz: ac99e00ae2d24e250c754408433cdcdc1265993c8cedb90054db22acb8af9a245a5cc57a22ef215b6fe561a2928d3285fca6b44eb533c08b602e6835dea1c0aa
+  data.tar.gz: cfb571a4a3c54fdc54864fbc089048cf69cd9102b8bd0c45f93fc73f13459b73b49a872e1993e3cf7aa955a779a84503e4d4513d9ffb77d2c0c15ecadc142680

data/README CHANGED Viewed

@@ -5,7 +5,7 @@ About
 -----
   BitClust is the Next-Generation Ruby reference manual interface.
-  For more details, see https://bugs.ruby-lang.org/projects/rurema/wiki/BitClust .
+  For more details, https://github.com/rurema/doctree/wiki/BitClust .
 License

data/bitclust.gemspec CHANGED Viewed

@@ -1,6 +1,5 @@
 # -*- encoding: utf-8 -*-
 $:.push File.expand_path("../lib", __FILE__)
-require 'rake'
 require "bitclust/version"
 Gem::Specification.new do |s|
@@ -17,9 +16,9 @@ EOD
   s.rubyforge_project = ""
-  s.files         = FileList["ChangeLog", "Gemfile", "README", "Rakefile", "bitclust.gemspec",
-                             "data/**/*", "lib/**/*.rb", "theme/**/*"].exclude("*~")
-  s.test_files    = FileList["test/**/*.rb"].exclude("*~")
+  s.files         = Dir["ChangeLog", "Gemfile", "README", "Rakefile", "bitclust.gemspec",
+                        "data/**/*", "lib/**/*.rb", "theme/**/*"].reject {|f| f =~ /.*~/ }
+  s.test_files    = Dir["test/**/*.rb"].reject {|f| f =~ /.*~/ }
   s.executables   = ["bitclust"]
   s.require_paths = ["lib"]

data/data/bitclust/template.offline/layout CHANGED Viewed

@@ -5,6 +5,9 @@
   <meta http-equiv="Content-Language" content="ja-JP">
   <link rel="stylesheet" type="text/css" href="<%=h css_url() %>">
   <link rel="icon" type="image/png" href="<%=h favicon_url() %>">
+  <% if @conf[:canonical_base_url] %>
+  <link rel="canonical" href="<%= canonical_url() %>">
+  <% end %>
   <title><%=h @title %> (Ruby <%=h ruby_version %>)</title>
 </head>
 <body>

data/lib/bitclust/classentry.rb CHANGED Viewed

@@ -214,13 +214,13 @@ module BitClust
     end
     def included_modules
-      list = ancestors().select {|c| c.module? }
+      list = ancestors().select(&:module?)
       list.delete self
       list
     end
     def extended_modules
-      ancestors().select {|c| c.class? }.map {|c| c.extended }.flatten
+      ancestors().select(&:class?).map(&:extended).flatten
     end
     def entries(level = 0)
@@ -254,7 +254,7 @@ module BitClust
       mf = []
       c = []; v = []
       added = []
-      entries(level).sort_by{|e| e.name}.each do |m|
+      entries(level).sort_by(&:name).each do |m|
         case m.kind
         when :defined, :redefined
           case m.type
@@ -280,42 +280,42 @@ module BitClust
     def singleton_methods(level = 0)
       # FIXME: inheritance
-      entries(level).select {|m| m.singleton_method? }.sort_by {|entry| entry.sort_key }
+      entries(level).select(&:singleton_method?).sort_by(&:sort_key)
     end
     def public_singleton_methods(level = 0)
       # FIXME: inheritance
-      entries(level).select {|m| m.public_singleton_method? }.sort_by {|entry| entry.sort_key }
+      entries(level).select(&:public_singleton_method?).sort_by(&:sort_key)
     end
     def instance_methods(level = 0)
       # FIXME: inheritance
-      entries(level).select {|m| m.instance_method? }.sort_by {|entry| entry.sort_key }
+      entries(level).select(&:instance_method?).sort_by(&:sort_key)
     end
     def private_singleton_methods(level = 0)
       # FIXME: inheritance
-      entries(level).select {|m| m.private_singleton_method? }.sort_by {|entry| entry.sort_key }
+      entries(level).select(&:private_singleton_method?).sort_by(&:sort_key)
     end
     def public_instance_methods(level = 0)
       # FIXME: inheritance
-      entries(level).select {|m| m.public_instance_method? }.sort_by {|entry| entry.sort_key }
+      entries(level).select(&:public_instance_method?).sort_by(&:sort_key)
     end
     def private_instance_methods(level = 0)
       # FIXME: inheritance
-      entries(level).select {|m| m.private_instance_method? }.sort_by {|entry| entry.sort_key }
+      entries(level).select(&:private_instance_method?).sort_by(&:sort_key)
     end
     alias private_methods   private_instance_methods
     def constants(level = 0)
-      entries(level).select {|m| m.constant? }.sort_by {|entry| entry.sort_key }
+      entries(level).select(&:constant?).sort_by(&:sort_key)
     end
     def special_variables
-      entries().select {|m| m.special_variable? }.sort_by {|entry| entry.sort_key }
+      entries().select(&:special_variable?).sort_by(&:sort_key)
     end
     def singleton_method?(name, inherit = true)

data/lib/bitclust/rdcompiler.rb CHANGED Viewed

@@ -170,7 +170,6 @@ module BitClust
     def item_list(level = 0, indent = true)
       open_tag = nil
       close_tag = nil
-      pattern = nil
       case @f.peek
       when /\A(\s+)\*\s/
         open_tag  =  "<ul>"
@@ -428,6 +427,8 @@ module BitClust
         rfc_link(arg)
       when 'ruby-list', 'ruby-dev', 'ruby-ext', 'ruby-talk', 'ruby-core'
         blade_link(type, arg)
+      when 'feature', 'bug'
+        bugs_link(type, arg)
       else
         "[[#{escape_html(link)}]]"
       end
@@ -517,6 +518,13 @@ module BitClust
       %Q(<a class="external" href="#{escape_html(url)}">#{escape_html("#{m[1]}(#{m[2]})")}</a>)
     end
+    BUGS_URL = "https://bugs.ruby-lang.org/issues/%s"
+    def bugs_link(type, id)
+      url = sprintf(BUGS_URL, id)
+      %Q(<a class="external" href="#{escape_html(url)}">[#{type}##{id}]</a>)
+    end
     def rdoc_url(method_id, version)
       cname, tmark, mname, libname = methodid2specparts(method_id)
       tchar = typemark2char(tmark) == 'i' ? 'i' : 'c'

data/lib/bitclust/screen.rb CHANGED Viewed

@@ -166,6 +166,10 @@ module BitClust
       raise unless %r!\A[-\w/]+\z! =~ name
       "#{@cgi_url}/#{name}"
     end
+    def canonical_url(current_url)
+      current_url
+    end
   end
@@ -327,6 +331,14 @@ module BitClust
       @urlmapper.favicon_url
     end
+    def current_url
+      raise NotImplementedError, "Must implement this method in subclass"
+    end
+    def canonical_url
+      @urlmapper.canonical_url(current_url)
+    end
     def opensearchdescription_url
       @urlmapper.opensearchdescription_url
     end
@@ -452,6 +464,10 @@ module BitClust
     def body
       run_template('library-index')
     end
+    def current_url
+      @urlmapper.library_index_url
+    end
   end
   class LibraryScreen < EntryBoundScreen
@@ -473,6 +489,10 @@ module BitClust
       draw_treed_entries(roots, tree, &block)
     end
+    def current_url
+      @urlmapper.library_url(@entry.name)
+    end
     private
     def draw_treed_entries(entries, tree, indent = 0, &block)
@@ -487,6 +507,10 @@ module BitClust
     def body
       run_template('class-index')
     end
+    def current_url
+      @urlmapper.class_url(@entries.first.name)
+    end
   end
   class OpenSearchDescriptionScreen < TemplateScreen
@@ -529,6 +553,10 @@ module BitClust
     def body
       run_template('class')
     end
+    def current_url
+      @urlmapper.class_url(@entry.name)
+    end
   end
   class MethodScreen < TemplateScreen
@@ -549,18 +577,32 @@ module BitClust
     def body
       run_template('method')
     end
+    def current_url
+      ent = @entries.first
+      spec = ent ? ent.spec_string : ""
+      @urlmapper.method_url(spec)
+    end
   end
   class FunctionScreen < EntryBoundScreen
     def body
       run_template('function')
     end
+    def current_url
+      @urlmapper.function_url(@entry.name)
+    end
   end
   class FunctionIndexScreen < IndexScreen
     def body
       run_template('function-index')
     end
+    def current_url
+      @urlmapper.function_index_url
+    end
   end
   class DocScreen < EntryBoundScreen
@@ -581,5 +623,9 @@ module BitClust
       h = {:force => true, :catalog => message_catalog() }.merge(@conf)
       RDCompiler.new(@urlmapper, @hlevel, h)
     end
+    def current_url
+      @urlmapper.document_url(@entry.name)
+    end
   end
 end

data/lib/bitclust/subcommands/setup_command.rb CHANGED Viewed

@@ -19,7 +19,8 @@ module BitClust
         @prepare = nil
         @cleanup = nil
         @purge = nil
-        @versions = ["2.0.0", "2.1.0", "2.2.0"]
+        @versions = ["2.1.0", "2.2.0", "2.3.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
@@ -33,6 +34,9 @@ module BitClust
         @parser.on('--versions=V1,V2,...', "Specify versions. [#{@versions.join(',')}]") {|versions|
           @versions = versions.split(",")
         }
+        @parser.on('--no-update', 'Do not update document repository') {
+          @update = false
+        }
       end
       def exec(argv, options)
@@ -112,6 +116,7 @@ module BitClust
         succeeded = false
         if (rubydoc_dir + ".git").exist?
+          return unless @update
           Dir.chdir(rubydoc_dir) do
             succeeded = system("git", "pull", "--rebase")
           end

data/lib/bitclust/subcommands/statichtml_command.rb CHANGED Viewed

@@ -27,6 +27,7 @@ module BitClust
           @bitclust_html_base = ""
           @suffix = h[:suffix]
           @fs_casesensitive = h[:fs_casesensitive]
+          @canonical_base_url = h[:canonical_base_url]
         end
         def library_url(name)
@@ -74,6 +75,10 @@ module BitClust
           @bitclust_html_base + "/function/#{html_filename("index", @suffix)}"
         end
+        def canonical_url(current_url)
+          (@canonical_base_url + "/#{current_url}").sub(@bitclust_html_base, "").sub(/([^:])\/\/+/, "\\1/")
+        end
         def encodename_package(str)
           if @fs_casesensitive
             encodename_url(str)
@@ -117,6 +122,9 @@ module BitClust
         @parser.on('--fs-casesensitive', 'Filesystem is case-sensitive') do
           @fs_casesensitive = true
         end
+        @parser.on('--canonical-base-url=URL', 'Canonical base URL') do |url|
+          @canonical_base_url = url
+        end
         @parser.on('--[no-]quiet', 'Be quiet') do |quiet|
           @verbose = !quiet
         end
@@ -187,7 +195,8 @@ module BitClust
           :favicon_url => 'rurema.png',
           :cgi_url     => '',
           :tochm_mode  => true,
-          :fs_casesensitive => @fs_casesensitive
+          :fs_casesensitive => @fs_casesensitive,
+          :canonical_base_url => @canonical_base_url
         }
         @manager_config[:urlmapper] = URLMapperEx.new(@manager_config)
         @urlmapper = @manager_config[:urlmapper]

data/lib/bitclust/version.rb CHANGED Viewed

@@ -1,3 +1,3 @@
 module BitClust
-  VERSION = "0.9.1"
+  VERSION = "0.9.2"
 end

data/test/test_rdcompiler.rb CHANGED Viewed

@@ -526,6 +526,28 @@ HERE
 </li>
 </ol>
+HERE
+    assert_compiled_source(expected, src)
+  end
+  def test_olist_ulist
+    src = <<HERE
+  (1) aaa
+  (1) bbb
+  (1) ccc
+    * xxx
+    * yyy
+HERE
+    expected = <<HERE
+<ol>
+<li>aaa</li>
+<li>bbb</li>
+<li>ccc<ul>
+<li>xxx</li>
+<li>yyy</li>
+</ul>
+</li>
+</ol>
 HERE
     assert_compiled_source(expected, src)
   end
@@ -564,7 +586,9 @@ HERE
        "continuity"          => ['[[c:String]][[c:String]]', '<a href="dummy/class/String">String</a><a href="dummy/class/String">String</a>'],
        "constant"            => ['[[m:File::SEPARATOR]]', '<a href="dummy/method/File/c/SEPARATOR">File::SEPARATOR</a>'],
        "url"                 => ['[[url:http://i.loveruby.net]]', '<a class="external" href="http://i.loveruby.net">http://i.loveruby.net</a>'],
-       "ruby-list"           => ['[[ruby-list:12345]]', '<a class="external" href="http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-list/12345">[ruby-list:12345]</a>'],)
+       "ruby-list"           => ['[[ruby-list:12345]]', '<a class="external" href="http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-list/12345">[ruby-list:12345]</a>'],
+       "bugs.r-l.o feature"  => ['[[feature:12345]]', '<a class="external" href="https://bugs.ruby-lang.org/issues/12345">[feature#12345]</a>'],
+       "bugs.r-l.o bug"      => ['[[bug:12345]]', '<a class="external" href="https://bugs.ruby-lang.org/issues/12345">[bug#12345]</a>'],)
   def test_bracket_link(data)
     target, expected = data
     assert_equal(expected, @c.send(:compile_text, target), target)
@@ -575,7 +599,7 @@ HERE
        "ref class"       => ['[[ref:c:Hoge#frag]]',       '<a href="dummy/class/Hoge#frag">.*</a>'],
        "ref special var" => ['[[ref:m:$~#frag]]',         '<a href="dummy/method/Kernel/v/=7e#frag">.*</a>'],
        "ref library"     => ['[[ref:lib:jcode#frag]]',    '<a href="dummy/library/jcode#frag">.*</a>'],
-       "ref class"       => ['[[ref:c:Hoge]]',            'compileerror'],
+       "ref class error" => ['[[ref:c:Hoge]]',            'compileerror'],
        "ref ref"         => ['[[ref:ref:hoge/bar#frag]]', 'compileerror'],)
   def test_bracket_link_doc(data)
     target, expected = data

metadata CHANGED Viewed

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bitclust-core
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.9.2
 platform: ruby
 authors:
 - http://bugs.ruby-lang.org/projects/rurema
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-08-21 00:00:00.000000000 Z
+date: 2016-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: test-unit
@@ -239,23 +239,23 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: ''
-rubygems_version: 2.5.1
+rubygems_version: 2.6.4
 signing_key:
 specification_version: 4
 summary: BitClust is a rurema document processor.
 test_files:
+- test/test_preprocessor.rb
 - test/run_test.rb
-- test/test_bitclust.rb
 - test/test_entry.rb
+- test/test_methoddatabase.rb
 - test/test_functiondatabase.rb
+- test/test_refsdatabase.rb
+- test/test_bitclust.rb
 - test/test_functionreferenceparser.rb
-- test/test_libraryentry.rb
-- test/test_methoddatabase.rb
 - test/test_methodsignature.rb
+- test/test_rrdparser.rb
+- test/test_simplesearcher.rb
 - test/test_nameutils.rb
-- test/test_preprocessor.rb
 - test/test_rdcompiler.rb
-- test/test_refsdatabase.rb
-- test/test_rrdparser.rb
 - test/test_runner.rb
-- test/test_simplesearcher.rb
+- test/test_libraryentry.rb