bitclust-core 0.5.0

data/standalone.rb

@@ -0,0 +1,193 @@
+#!/usr/bin/ruby -Ku
+#
+# $Id$
+#
+# Stand-alone BitClust server based on WEBrick
+#
+
+require 'uri'
+require 'webrick'
+require 'optparse'
+require 'pathname'
+
+def srcdir_root
+  Pathname.new(__FILE__).realpath.dirname.cleanpath
+end
+
+params = {
+  :Port => 10080
+}
+baseurl = nil
+dbpath = nil
+srcdir = libdir = datadir = themedir = theme = templatedir = nil
+encoding = 'utf-8'   # encoding of view
+set_srcdir = lambda {|path|
+  srcdir = path
+  datadir ||= "#{srcdir}/data/bitclust"
+  themedir ||= "#{srcdir}/theme"
+  libdir ||= "#{srcdir}/lib"
+}
+
+debugp = false
+autop = false
+browser = nil
+pid_file = nil
+capi = false
+
+parser = OptionParser.new
+parser.banner = "#{$0} [--bind-address=ADDR] [--port=NUM] --baseurl=URL --database=PATH [--srcdir=PATH] [--datadir=PATH] [--themedir=PATH] [--debug] [--auto] [--browser=BROWSER] [--pid-file=PATH] [--capi]"
+parser.on('--bind-address=ADDR', 'Bind address') {|addr|
+  params[:BindAddress] = addr
+}
+parser.on('--port=NUM', 'Listening port number') {|num|
+  params[:Port] = num.to_i
+}
+parser.on('--baseurl=URL', 'The base URL to host.') {|url|
+  baseurl = url
+}
+parser.on('--database=PATH', 'MethodDatabase root directory.') {|path|
+  dbpath = path
+}
+parser.on('--srcdir=PATH', 'BitClust source directory.') {|path|
+  set_srcdir.call path
+}
+parser.on('--datadir=PATH', 'BitClust data directory.') {|path|
+  datadir = path
+}
+parser.on('--templatedir=PATH', 'Template directory.') {|path|
+  templatedir = path
+}
+parser.on('--themedir=PATH', 'BitClust theme directory.') {|path|
+  themedir = path
+}
+parser.on('--theme=THEME', 'BitClust theme.') {|th|
+  theme = th
+}
+parser.on('--[no-]debug', 'Debug mode.') {|flag|
+  debugp = flag
+}
+parser.on('--[no-]auto', 'Auto mode.') {|flag|
+  autop = flag
+}
+parser.on('--browser=BROWSER', 'Open with the browser.') {|path|
+  browser = path
+}
+parser.on('--pid-file=PATH', 'Write pid of the daemon to the specified file.') {|path|
+  pid_file = path
+}
+parser.on('--help', 'Prints this message and quit.') {
+  puts parser.help
+  exit 0
+}
+parser.on('--capi', 'see also FunctionDatabase.') {|path|
+  capi = true
+}
+begin
+  parser.parse!
+rescue OptionParser::ParseError => err
+  $stderr.puts err.message
+  $stderr.puts parser.help
+  exit 1
+end
+
+set_srcdir.call srcdir_root unless srcdir
+
+unless baseurl
+  $stderr.puts "missing base URL.  Use --baseurl"
+  exit 1
+end
+unless dbpath || autop
+  $stderr.puts "missing database path.  Use --database"
+  exit 1
+end
+unless datadir
+  $stderr.puts "missing datadir.  Use --datadir"
+  exit 1
+end
+unless themedir
+  $stderr.puts "missing themedir.  Use --themedir"
+  exit 1
+end
+if pid_file
+  if File.exist?(pid_file)
+    $stderr.puts "There is still #{pid_file}.  Is another process running?"
+    exit 1
+  end
+  pid_file = File.expand_path(pid_file)
+end
+
+$LOAD_PATH.unshift libdir
+require 'bitclust/app'
+
+if debugp
+  params[:Logger] = WEBrick::Log.new($stderr, WEBrick::Log::DEBUG)
+  params[:AccessLog] = [
+    [ $stderr, WEBrick::AccessLog::COMMON_LOG_FORMAT  ],
+    [ $stderr, WEBrick::AccessLog::REFERER_LOG_FORMAT ],
+    [ $stderr, WEBrick::AccessLog::AGENT_LOG_FORMAT   ],
+  ]
+else
+  params[:Logger] = WEBrick::Log.new($stderr, WEBrick::Log::INFO)
+  params[:AccessLog] = []
+end
+basepath = URI.parse(baseurl).path
+server = WEBrick::HTTPServer.new(params)
+
+if autop
+  app = BitClust::App.new(
+    :dbpath => Dir.glob("db-*"),
+    :baseurl => baseurl,
+    :datadir => datadir,
+    :templatedir => templatedir,
+    :theme => theme,
+    :encoding => encoding,
+    :capi => capi
+    )
+  app.interfaces.each do |version, interface|
+    server.mount File.join(basepath, version), interface
+  end
+  server.mount(File.join(basepath, '/'), app)
+else
+  viewpath = File.join(basepath, 'view')
+  app = BitClust::App.new(
+    :viewpath => viewpath,
+    :dbpath => dbpath,
+    :baseurl => baseurl,
+    :datadir => datadir,
+    :templatedir => templatedir,
+    :theme => theme,
+    :encoding => encoding,
+    :capi => capi
+    )
+  app.interfaces.each do |viewpath, interface|
+    server.mount viewpath, interface
+  end
+  # Redirect from '/' to "#{viewpath}/"
+  server.mount('/', app)
+end
+
+server.mount File.join(basepath, 'theme/'), WEBrick::HTTPServlet::FileHandler, themedir
+
+if debugp
+  trap(:INT) { server.shutdown }
+else
+  WEBrick::Daemon.start do
+    trap(:TERM) {
+      server.shutdown
+      begin
+        File.unlink pid_file if pid_file
+      rescue Errno::ENOENT
+      end
+    }
+    File.open(pid_file, 'w') {|f| f.write Process.pid } if pid_file
+  end
+end
+exit if $".include?("exerb/mkexy.rb")
+if autop && !browser
+  case RUBY_PLATFORM
+  when /mswin(?!ce)|mingw|cygwin|bccwin/
+    browser = "start"
+  end
+end
+system("#{browser} http://localhost:#{params[:Port]}/") if browser
+server.start

data/test/run_test.rb

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+require 'pathname'
+
+gem 'test-unit'
+require 'test/unit'
+require 'test/unit/notify'
+require 'test/unit/rr'
+
+base_dir = Pathname.new(__FILE__).dirname.expand_path
+top_dir = (base_dir + '..').expand_path
+lib_dir = top_dir + 'lib'
+
+$LOAD_PATH.unshift(lib_dir.to_s)
+
+exit Test::Unit::AutoRunner.run(true, base_dir)

data/test/test_bitclust.rb

@@ -0,0 +1,81 @@
+require 'bitclust'
+require 'bitclust/subcommand'
+require 'stringio'
+require 'tmpdir'
+require 'fileutils'
+
+class TestBitClust < Test::Unit::TestCase
+  def setup
+    @tmpdir = Dir.mktmpdir
+    src = "#{@tmpdir}/function/public_func"
+    @srcdir = Dir.mkdir File.dirname(src)
+    File.open(src, 'w') do |file|
+      file.puts <<'HERE'
+filename=test.c
+macro=false
+private=false
+type=VALUE
+name=public_func
+params=()
+
+
+This is public function.
+HERE
+    end
+
+    @out = StringIO.new
+  end
+
+  def teardown
+    FileUtils.rm_r(@tmpdir, :force => true)
+  end
+
+  def search_capi(command, *argv)
+    db = BitClust::FunctionDatabase.new(@tmpdir)
+    cmd = case command
+          when "lookup"
+            BitClust::LookupCommand.new
+          when "list"
+            BitClust::ListCommand.new
+          else
+            raise "must not happen! command=#{command}"
+          end
+    @out.string = ""
+    $stdout = @out
+    begin
+      cmd.parse(argv)
+      cmd.exec(db, argv)
+    ensure
+      $stdout = STDOUT
+    end
+    @out.string
+  end
+
+  def test_list
+    assert_equal("public_func\n", search_capi("list", "--function"))
+  end
+
+  def test_lookup
+    assert_equal(<<-EOS, search_capi("lookup", "--function=public_func").chomp)
+kind: function
+header: VALUE public_func()
+filename: test.c
+
+
+This is public function.
+    EOS
+  end
+
+  def test_lookup_html
+    assert_equal(<<-EOS, search_capi("lookup", "--function=public_func", "--html").chomp)
+<dl>
+<dt>kind</dt><dd>function</dd>
+<dt>header</dt><dd>VALUE public_func()</dd>
+<dt>filename</dt><dd>test.c</dd>
+</dl>
+<p>
+This is public function.
+</p>
+    EOS
+  end
+end

data/test/test_entry.rb

@@ -0,0 +1,39 @@
+require 'bitclust'
+require 'test/unit'
+
+class TestClassEntry < Test::Unit::TestCase
+  def setup
+    s = <<HERE
+= class Hoge
+alias HogeHoge
+alias HogeHogeHoge
+== Class Methods
+--- hoge
+= class Bar < Hoge
+== Class Methods
+--- bar
+HERE
+    @lib, = BitClust::RRDParser.parse(s, 'hoge')
+  end
+
+  def test_entries
+    assert_equal(['bar', 'hoge'],
+                 @lib.fetch_class("Bar").entries(1).map{|e| e.name}.sort)
+  end
+
+  def test_aliases
+    assert_equal(['HogeHoge', 'HogeHogeHoge'],
+                 @lib.fetch_class("Hoge").aliases.map{|e| e.name}.sort)
+  end
+
+  def test_aliasof
+    assert_equal(nil, @lib.fetch_class("Hoge").aliasof)
+    assert_equal("Hoge", @lib.fetch_class("HogeHoge").aliasof.name)
+  end
+
+  def test_realname
+    assert_equal('Hoge', @lib.fetch_class("Hoge").realname)
+    assert_equal('Hoge', @lib.fetch_class("HogeHoge").realname)
+  end
+end
+

data/test/test_functiondatabase.rb

@@ -0,0 +1,55 @@
+require 'test/unit'
+require 'bitclust'
+require 'bitclust/functiondatabase'
+require 'tmpdir'
+require 'fileutils'
+
+class TesFunctionDatabase < 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 func1()
+
+some text
+
+--- VALUE func2()
+
+some text
+HERE
+    end
+    @db = BitClust::FunctionDatabase.new(prefix)
+    @db.transaction {
+      @db.update_by_file(src, src)
+    }
+  end
+
+  def teardown
+    Dir.chdir @pwd
+    FileUtils.rm_r(@tmpdir, :force => true)
+  end
+
+  def test_search_functions__function
+    result = @db.search_functions('func1')
+    assert_not_nil result.first
+    assert_equal 1, result.size
+    assert_equal 'func1', result.first.name
+  end
+
+  def test_search_functions__functions
+    result = @db.search_functions('func')
+    assert_not_nil result.first
+    assert_equal 2, result.size
+    assert_equal %w[func1 func2], result.map(&:name)
+  end
+
+  def test_search_functions__nonexistent
+    assert_raise(BitClust::FunctionNotFound) do
+      @db.search_functions('nonexistent')
+    end
+  end
+end

data/test/test_libraryentry.rb

@@ -0,0 +1,31 @@
+require 'bitclust'
+require 'test/unit'
+require 'bitclust/libraryentry'
+
+class TestLibraryEntry < Test::Unit::TestCase
+  include BitClust
+
+  def setup
+    s = <<DOC
+require hoge/bar
+require hoge/baz
+require hoge/bar
+
+= class Hoge
+== Class Methods
+--- hoge
+= class Bar < Hoge
+== Class Methods
+--- bar
+DOC
+    @lib_entry, @db = BitClust::RRDParser.parse(s, 'hoge')
+    @sublibrary = LibraryEntry.new(@db, 'testsub')
+  end
+
+  def test_sublibrary
+    @lib_entry.sublibrary(@sublibrary)
+    assert_equal(['testsub'], @lib_entry.sublibraries.map(&:name))
+    @lib_entry.sublibrary(@sublibrary)
+    assert_equal(['testsub'], @lib_entry.sublibraries.map(&:name))
+  end
+end

data/test/test_methoddatabase.rb

@@ -0,0 +1,81 @@
+require 'test/unit'
+require 'bitclust'
+require 'bitclust/methoddatabase'
+
+class TestMethodDatabase < Test::Unit::TestCase
+  def setup
+    @prefix = 'db'
+    @root = 'src'
+    setup_files
+    @db = BitClust::MethodDatabase.new(@prefix)
+    # init database
+    @db.init
+    @db.transaction {
+      [
+       %w[version 1.9.1],
+       %w[encoding utf-8]
+      ].each do |k,v|
+        @db.propset(k, v)
+      end
+    }
+    # update database
+    @db.transaction {
+      @db.update_by_stdlibtree(@root)
+    }
+  end
+
+  def teardown
+    FileUtils.rm_r([@prefix, @root], :force => true)
+  end
+
+  def test_search_methods__method
+    result = @db.search_methods(BitClust::MethodNamePattern.new(nil, nil, 'at_exit'))
+    assert_not_nil result.records.first.entry
+    assert_equal 1, result.records.size
+    assert_equal 'at_exit', result.records.first.entry.name
+  end
+
+  def test_search_methods__methods
+    result = @db.search_methods(BitClust::MethodNamePattern.new(nil, nil, 'foo'))
+    assert_not_nil result.records.first.entry
+    assert_equal 2, result.records.size
+    assert_equal %w[Foo Bar], result.records.map(&:entry).map(&:klass).map(&:name)
+    assert_equal 'foo', result.records.first.entry.name
+  end
+
+  def test_search_methods__constant
+    result = @db.search_methods(BitClust::MethodNamePattern.new(nil, nil, 'AAA'))
+    assert_not_nil result.records.first.entry
+    assert_equal 1, result.records.size
+    assert_equal 'AAA', result.records.first.entry.name
+  end
+
+  private
+  def setup_files
+    FileUtils.mkdir_p("#{@root}/_builtin")
+    File.open("#{@root}/LIBRARIES", 'w+') do |file|
+      file.puts '_builtin'
+    end
+    File.open("#{@root}/_builtin.rd", 'w+') do |file|
+      file.puts <<'HERE'
+description
+
+= class Foo < Object
+desctiption
+== Instance Methods
+--- foo
+== Constants
+--- AAA
+= class Bar < Object
+== Instance Methods
+--- foo
+= module Kernel
+description
+== Module Functions
+--- at_exit{ ... } -> Proc
+aaa
+
+HERE
+    end
+  end
+end