bitclust-core 0.8.0 → 0.9.0

data/lib/bitclust/rrdparser.rb

@@ -180,10 +180,10 @@ module BitClust
       f.skip_blank_lines
       read_extends f
       f.skip_blank_lines
-      @context.klass.source = f.break(/\A=|\A---/).join('').rstrip
+      @context.klass.source = f.break(/\A==?[^=]|\A---/).join('').rstrip
       @context.visibility = :public
       @context.type = :singleton_method
-      read_entries f
+      read_level2_blocks f
     end
 
     def read_aliases(f)
@@ -194,15 +194,21 @@ module BitClust
 
     def read_includes(f, reopen = false)
       f.while_match(/\Ainclude\s/) do |line|
-        tty_warn "#{line.location}: dynamic include is not implemented yet" if reopen
-        @context.include line.split[1]          unless reopen # FIXME
+        if reopen
+          @context.dynamic_include(line.split[1])
+        else
+          @context.include(line.split[1])
+        end
       end
     end
 
     def read_extends(f, reopen = false)
       f.while_match(/\Aextend\s/) do |line|
-        tty_warn "#{line.location}: dynamic extend is not implemented yet" if reopen
-        @context.extend line.split[1]           unless reopen # FIXME
+        if reopen
+          @context.dynamic_extend(line.split[1])
+        else
+          @context.extend(line.split[1])
+        end
       end
     end
 
@@ -403,6 +409,14 @@ module BitClust
         @klass.extend @db.get_class(name)
       end
 
+      def dynamic_include(name)
+        @klass.dynamic_include(@db.get_class(name), @library)
+      end
+
+      def dynamic_extend(name)
+        @klass.dynamic_extend(@db.get_class(name), @library)
+      end
+
       # Add a alias +name+ to the alias list.
       def alias(name)
         @db.open_class(name) do |c|

data/lib/bitclust/runner.rb

@@ -62,6 +62,7 @@ Subcommands(for developers):
 
 Subcommands(for packagers):
     statichtml  Generate static HTML files.
+    epub        Generate EPUB file.
     chm         Generate static HTML files for CHM.
 
 Global Options:
@@ -96,6 +97,7 @@ Global Options:
         'statichtml'  => BitClust::Subcommands::StatichtmlCommand.new,
         'htmlfile'    => BitClust::Subcommands::HtmlfileCommand.new,
         'chm'         => BitClust::Subcommands::ChmCommand.new,
+        'epub'        => BitClust::Subcommands::EPUBCommand.new,
         'ancestors'   => BitClust::Subcommands::AncestorsCommand.new,
         'preproc'     => BitClust::Subcommands::PreprocCommand.new,
         'extract'     => BitClust::Subcommands::ExtractCommand.new,

data/lib/bitclust/screen.rb

@@ -392,8 +392,8 @@ module BitClust
       rdcompiler().compile_method(m, opt)
     end
 
-    def compile_function(f)
-      compile_rd(f.source)
+    def compile_function(f, opt = nil)
+      rdcompiler().compile_function(f, opt)
     end
 
     def compile_rd(src)
@@ -565,6 +565,14 @@ module BitClust
 
   class DocScreen < EntryBoundScreen
 
+    def breadcrumb_title
+      if /ascii/ =~ @conf[:encoding]
+        @entry.name
+      else
+        @entry.title
+      end
+    end
+
     def body
       run_template('doc')
     end

data/lib/bitclust/searcher.rb

@@ -98,6 +98,10 @@ module BitClust
       end
     end
 
+    def help
+      @parser.help
+    end
+
     private
 
     def server_mode_check(argv)

data/lib/bitclust/subcommands/epub_command.rb

@@ -0,0 +1,68 @@
+require 'fileutils'
+require 'date'
+
+require 'bitclust'
+require 'bitclust/subcommand'
+require 'bitclust/generators/epub'
+
+module BitClust
+  module Subcommands
+    class EPUBCommand < Subcommand
+      def initialize
+        super
+        @verbose = true
+        @catalogdir = nil
+        @templatedir = srcdir_root + "data/bitclust/template.epub"
+        @themedir = srcdir_root + "theme/default"
+        @filename = "rurema-#{Date.today}.epub"
+        @keep = false
+        @parser.banner = "Usage: #{File.basename($0, '.*')} epub [options]"
+        @parser.on('-o', '--outputdir=PATH', 'Output directory') do |path|
+          begin
+            @outputdir = Pathname.new(path).realpath
+          rescue Errno::ENOENT
+            FileUtils.mkdir_p(path, :verbose => @verbose)
+            retry
+          end
+        end
+        @parser.on('-f', '--filename=FILENAME',
+                   "Filename of generated EPUB file [#{@filename}]") do |filename|
+          @filename = filename
+        end
+        @parser.on('--[no-]keep', 'Keep all generated files (for debug) [false]') do |keep|
+          @keep = keep
+        end
+        @parser.on('--catalog=PATH', 'Catalog directory') do |path|
+          @catalogdir = Pathname.new(path).realpath
+        end
+        @parser.on('--templatedir=PATH', 'Template directory') do |path|
+          @templatedir = Pathname.new(path).realpath
+        end
+        @parser.on('--themedir=PATH', 'Theme directory') do |path|
+          @themedir = Pathname.new(path).realpath
+        end
+        @parser.on('--fs-casesensitive', 'Filesystem is case-sensitive') do
+          @fs_casesensitive = true
+        end
+        @parser.on('--[no-]quiet', 'Be quiet') do |quiet|
+          @verbose = !quiet
+        end
+      end
+
+      def exec(argv, options)
+        generator = BitClust::Generators::EPUB.new(:prefix           => options[:prefix],
+                                                   :capi             => options[:capi],
+                                                   :outputdir        => @outputdir,
+                                                   :catalog          => @catalog,
+                                                   :templatedir      => @templatedir,
+                                                   :themedir         => @themedir,
+                                                   :fs_casesensitive => @fs_casesensitive,
+                                                   :verbose          => @verbose,
+                                                   :keep             => @keep,
+                                                   :filename         => @filename)
+        generator.generate
+      end
+    end
+  end
+
+end

data/lib/bitclust/subcommands/methods_command.rb

@@ -137,6 +137,19 @@ module BitClust
               puts "#{classname}\#{m}"
             end
           SCRIPT
+        when 'ARGF'
+          script = <<-SCRIPT
+            c = #{classname}.class
+            c.singleton_methods(false).each do |m|
+              puts "\#{c.to_s}.\#{m}"
+            end
+            c.instance_methods(false).each do |m|
+              puts "\#{c.to_s}\\#\#{m}"
+            end
+            c.ancestors.map {|mod| mod.constants }.inject {|r,n| r - n }.each do |m|
+              puts "\#{c.to_s}::\#{m}"
+            end
+          SCRIPT
         else
           script = <<-SCRIPT
             #{avoid_tracer}

data/lib/bitclust/subcommands/setup_command.rb

@@ -19,7 +19,7 @@ module BitClust
         @prepare = nil
         @cleanup = nil
         @purge = nil
-        @versions = ["1.8.7", "1.9.3", "2.0.0"]
+        @versions = ["2.0.0", "2.1.0", "2.2.0"]
         @parser.banner = "Usage: #{File.basename($0, '.*')} setup [options]"
         @parser.on('--prepare', 'Prepare config file and checkout repository. Do not create database.') {
           @prepare = true
@@ -64,7 +64,7 @@ module BitClust
       end
 
       def prepare
-        home_directory = Pathname(ENV["HOME"])
+        home_directory = Pathname(ENV["HOME"]).expand_path
         config_dir = home_directory + ".bitclust"
         config_dir.mkpath
         config_path = config_dir + "config"

data/lib/bitclust/subcommands/statichtml_command.rb

@@ -7,6 +7,7 @@
 require 'fileutils'
 
 require 'bitclust'
+require 'bitclust/nameutils'
 require 'bitclust/subcommand'
 require 'bitclust/progress_bar'
 require 'bitclust/silent_progress_bar'
@@ -14,54 +15,69 @@ require 'bitclust/silent_progress_bar'
 module BitClust
   module Subcommands
     class StatichtmlCommand < Subcommand
+      include NameUtils
+
       class URLMapperEx < URLMapper
+        include NameUtils
+
+        attr_accessor :bitclust_html_base
+
+        def initialize(h)
+          super
+          @bitclust_html_base = ""
+          @suffix = h[:suffix]
+        end
+
         def library_url(name)
           if name == '/'
-            $bitclust_html_base + "/library/index.html"
+            @bitclust_html_base + "/library/#{html_filename("index", @suffix)}"
           else
-            $bitclust_html_base + "/library/#{encodename_package(name)}.html"
+            @bitclust_html_base + "/library/#{html_filename(encodename_package(name), @suffix)}"
           end
         end
 
         def class_url(name)
-          $bitclust_html_base + "/class/#{encodename_package(name)}.html"
+          @bitclust_html_base + "/class/#{html_filename(encodename_package(name), @suffix)}"
         end
 
         def method_url(spec)
           cname, tmark, mname = *split_method_spec(spec)
-          $bitclust_html_base +
-            "/method/#{encodename_package(cname)}/#{typemark2char(tmark)}/#{encodename_package(mname)}.html"
+          filename = html_filename(encodename_package(mname), @suffix)
+          @bitclust_html_base +
+            "/method/#{encodename_package(cname)}/#{typemark2char(tmark)}/#{filename}"
         end
 
         def function_url(name)
-          $bitclust_html_base + "/function/#{name.empty? ? 'index' : name}.html"
+          filename = html_filename(name.empty? ? 'index' : name, @suffix)
+          @bitclust_html_base + "/function/#{filename}"
         end
 
         def document_url(name)
-          $bitclust_html_base + "/doc/#{encodename_package(name)}.html"
+          filename = html_filename(encodename_package(name), @suffix)
+          @bitclust_html_base + "/doc/#{filename}"
         end
 
         def css_url
-          $bitclust_html_base + "/" + @css_url
+          @bitclust_html_base + "/" + @css_url
         end
 
         def favicon_url
-          $bitclust_html_base + "/" + @favicon_url
+          @bitclust_html_base + "/" + @favicon_url
         end
 
         def library_index_url
-          $bitclust_html_base + "/library/index.html"
+          @bitclust_html_base + "/library/#{html_filename("index", @suffix)}"
         end
 
         def function_index_url
-          $bitclust_html_base + "/function/index.html"
+          @bitclust_html_base + "/function/#{html_filename("index", @suffix)}"
         end
 
         def encodename_package(str)
-          if $fs_casesensitive
-            NameUtils.encodename_url(str)
+          if @fs_casesensitive
+            encodename_url(str)
           else
-            NameUtils.encodename_fs(str)
+            encodename_fs(str)
           end
         end
       end
@@ -75,6 +91,7 @@ module BitClust
         @catalogdir = nil
         @templatedir = srcdir_root + "data/bitclust/template.offline"
         @themedir = srcdir_root + "theme/default"
+        @suffix = ".html"
         @parser.banner = "Usage: #{File.basename($0, '.*')} statichtml [options]"
         @parser.on('-o', '--outputdir=PATH', 'Output directory') do |path|
           begin
@@ -93,8 +110,11 @@ module BitClust
         @parser.on('--themedir=PATH', 'Theme directory') do |path|
           @themedir = Pathname.new(path).realpath
         end
+        @parser.on('--suffix=SUFFIX', 'Suffix for each (X)HTML file [.html]') do |suffix|
+          @suffix = suffix
+        end
         @parser.on('--fs-casesensitive', 'Filesystem is case-sensitive') do
-          $fs_casesensitive = true
+          @fs_casesensitive = true
         end
         @parser.on('--[no-]quiet', 'Be quiet') do |quiet|
           @verbose = !quiet
@@ -128,14 +148,14 @@ module BitClust
           create_html_entries("capi", fdb.functions, manager, fdb)
         end
 
-        $bitclust_html_base = '..'
-        create_file(@outputdir + 'library/index.html',
+        @urlmapper.bitclust_html_base = '..'
+        create_file(@outputdir + "library/#{html_filename("index", @suffix)}",
                     manager.library_index_screen(db.libraries.sort, {:database => db}).body,
                     :verbose => @verbose)
-        create_file(@outputdir + 'class/index.html',
+        create_file(@outputdir + "class/#{html_filename("index", @suffix)}",
                     manager.class_index_screen(db.classes.sort, {:database => db}).body,
                     :verbose => @verbose)
-        create_file(@outputdir + 'function/index.html',
+        create_file(@outputdir + "function/#{html_filename("index", @suffix)}",
                     manager.function_index_screen(fdb.functions.sort, { :database => fdb }).body,
                     :verbose => @verbose)
         create_index_html(@outputdir)
@@ -159,7 +179,7 @@ module BitClust
       def create_manager_config
         @manager_config = {
           :catalogdir  => @catalogdir,
-          :suffix      => '.html',
+          :suffix      => @suffix,
           :templatedir => @templatedir,
           :themedir    => @themedir,
           :css_url     => 'style.css',
@@ -168,6 +188,7 @@ module BitClust
           :tochm_mode  => true
         }
         @manager_config[:urlmapper] = URLMapperEx.new(@manager_config)
+        @urlmapper = @manager_config[:urlmapper]
       end
 
       def create_html_entries(title, entries, manager, db)
@@ -203,11 +224,12 @@ module BitClust
       end
 
       def create_index_html(outputdir)
-        path = outputdir + 'index.html'
+        index_filename = html_filename("index", @suffix)
+        path = outputdir + index_filename
         File.open(path, 'w'){|io|
           io.write <<HERE
-<meta http-equiv="refresh" content="0; URL=doc/index.html">
-<a href="doc/index.html">Go</a>
+<meta http-equiv="refresh" content="0; URL=doc/#{index_filename}">
+<a href="doc/#{index_filename}">Go</a>
 HERE
         }
       end
@@ -216,8 +238,8 @@ HERE
         e = entry.is_a?(Array) ? entry.sort.first : entry
         case e.type_id
         when :library, :class, :doc
-          $bitclust_html_base = '..'
-          path = outputdir + e.type_id.to_s + (encodename_package(e.name) + '.html')
+          @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
@@ -230,19 +252,19 @@ HERE
 
       def create_html_method_file(method_name, entries, manager, outputdir, db)
         path = nil
-        $bitclust_html_base = '../../..'
+        @urlmapper.bitclust_html_base = '../../..'
         e = entries.sort.first
         name = method_name.sub(e.klass.name + e.typemark, "")
         path = outputdir + e.type_id.to_s + encodename_package(e.klass.name) +
-          e.typechar + (encodename_package(name) + '.html')
+          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)
         path = nil
-        $bitclust_html_base = '..'
-        path = outputdir + entry.type_id.to_s + (entry.name + '.html')
+        @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
@@ -265,10 +287,10 @@ HERE
       end
 
       def encodename_package(str)
-        if $fs_casesensitive
-          NameUtils.encodename_url(str)
+        if @fs_casesensitive
+          encodename_url(str)
         else
-          NameUtils.encodename_fs(str)
+          encodename_fs(str)
         end
       end
     end

data/lib/bitclust/version.rb

@@ -1,3 +1,3 @@
 module BitClust
-  VERSION = "0.8.0"
+  VERSION = "0.9.0"
 end

data/test/test_functiondatabase.rb

@@ -1,6 +1,6 @@
 require 'test/unit'
 require 'bitclust'
-require 'bitclust/database/functiondatabase'
+require 'bitclust/functiondatabase'
 require 'tmpdir'
 require 'fileutils'
 
@@ -22,7 +22,7 @@ some text
 some text
 HERE
     end
-    @db = BitClust::Database::FunctionDatabase.new(prefix)
+    @db = BitClust::FunctionDatabase.new(prefix)
     @db.transaction {
       @db.update_by_file(src, src)
     }
@@ -48,7 +48,7 @@ HERE
   end
 
   def test_search_functions__nonexistent
-    assert_raise(BitClust::Database::FunctionNotFound) do
+    assert_raise(BitClust::FunctionNotFound) do
       @db.search_functions('nonexistent')
     end
   end

data/test/test_functionreferenceparser.rb

@@ -0,0 +1,51 @@
+require 'test/unit'
+require 'bitclust'
+require 'bitclust/functionreferenceparser'
+
+class TestFunctionReferenceParser < Test::Unit::TestCase
+  def setup
+    prefix = 'db'
+    src = "test.rd"
+
+    @pwd = Dir.pwd
+    Dir.chdir(@tmpdir = Dir.mktmpdir)
+    File.open(src, 'w') do |file|
+      file.puts <<'HERE'
+--- VALUE func()
+#@since 2.0.0
+some text 1
+#@else
+some text 2
+#@end
+HERE
+    end
+    @path = File.join(@tmpdir, src)
+    @db = BitClust::FunctionDatabase.new(prefix)
+    @parser = BitClust::FunctionReferenceParser.new(@db)
+  end
+
+  def teardown
+    Dir.chdir @pwd
+    FileUtils.rm_r(@tmpdir, :force => true)
+  end
+
+  data("1.9.3" => {
+         :version   => "1.9.3",
+         :expected  => ["some text 2\n"],
+       },
+       "2.0.0" => {
+         :version   => "2.0.0",
+         :expected  => ["some text 1\n"],
+       },
+       "2.1.0" => {
+         :version   => "2.1.0",
+         :expected  => ["some text 1\n"],
+       })
+  def test_parse_file(data)
+    @db.transaction {
+      result =
+        @parser.parse_file(@path, "test.c", {"version" => data[:version]})
+      assert_equal data[:expected], result.collect(&:source)
+    }
+  end
+end

data/test/test_methoddatabase.rb

@@ -50,12 +50,25 @@ class TestMethodDatabase < Test::Unit::TestCase
     assert_equal 'AAA', result.records.first.entry.name
   end
 
+  def test_dynamic_include
+    assert_equal(["BazA"],
+                 @db.get_class("A").dynamically_included.map{|m| m.name})
+    assert_equal(["BazB"],
+                 @db.get_class("B").dynamically_included.map{|m| m.name})
+  end
+
   private
   def setup_files
     FileUtils.mkdir_p("#{@root}/_builtin")
+
     File.open("#{@root}/LIBRARIES", 'w+') do |file|
       file.puts '_builtin'
+      file.puts 'dyn_include_open_a'
+      file.puts 'dyn_include_reopen_a'
+      file.puts 'dyn_include_reopen_b'
+      file.puts 'dyn_include_open_b'
     end
+
     File.open("#{@root}/_builtin.rd", 'w+') do |file|
       file.puts <<'HERE'
 description
@@ -77,5 +90,25 @@ aaa
 
 HERE
     end
+
+    File.open("#{@root}/dyn_include_open_a.rd", 'w+') do |file|
+      file.puts "= class A"
+    end
+
+    File.open("#{@root}/dyn_include_reopen_a.rd", 'w+') do |file|
+      file.puts "= module BazA"
+      file.puts "= reopen A"
+      file.puts "include BazA"
+    end
+
+    File.open("#{@root}/dyn_include_open_b.rd", 'w+') do |file|
+      file.puts "= class B"
+    end
+
+    File.open("#{@root}/dyn_include_reopen_b.rd", 'w+') do |file|
+      file.puts "= module BazB"
+      file.puts "= reopen B"
+      file.puts "include BazB"
+    end
   end
 end

data/test/test_nameutils.rb

@@ -340,6 +340,19 @@ class TestNameUtils < Test::Unit::TestCase
     assert_equal(expected, decodename_url(target))
   end
 
+  data("Array"    => ["Array",      "Array"],
+       "String"   => ["String",     "String"],
+       "index"    => ["index",      "index"],
+       "*"        => ["2A",         "*"],
+       "**"       => ["2A-2A",      "**"],
+       "<=>"      => ["3C-3D-3E",   "<=>"],
+       "open-uri" => ["open-2Duri", "open-uri"],
+       "net.http" => ["net.http",   "net.http"])
+  def test_encodename_rdocurl(data)
+    expected, target = data
+    assert_equal(expected, encodename_rdocurl(target))
+  end
+
   data("Array"      => ["-array",        "Array"],
        "String"     => ["-string",       "String"],
        "CGI"        => ["-c-g-i",        "CGI"],