bitclust-core 1.7.0 → 1.8.0

data/lib/bitclust/subcommands/methods_command.rb

@@ -29,16 +29,9 @@ module BitClust
           @mode = :diff
           @target = path
         }
-        @parser.on('-c', '') {
-          @content = true
-          require 'bitclust/ridatabase'
-        }
         @parser.on('--ruby=[VER]', "The version of Ruby interpreter"){|version|
           @version = version
         }
-        @parser.on('--ri-database', 'The path of ri database'){|path|
-          @ri_path = path
-        }
       end
 
       def parse(argv)
@@ -67,27 +60,11 @@ module BitClust
           list0 = c.entries + list0
           # @type var list: Array[String]
           list = list0.map {|ent| ent.labels.map {|n| expand_mf(n) } }.flatten
-          if @content
-            ri = @ri_path ? RiDatabase.open(@ri_path, nil) : RiDatabase.open_system_db
-            ri.current_class = c.name
-            mthds = ( ri.singleton_methods + ri.instance_methods )
-            fmt = Formatter.new
-            (keys - list).sort.each do |name|
-              mthd = mthds.find{|m| name == m.fullname }
-              if mthd
-                puts fmt.method_info(mthd.entry)
-              else
-                name = name.sub(/\A\w+#/, '')
-                puts "--- #{name}\n#%todo\n\n"
-              end
-            end
-          else
-            (keys - list).sort.each do |name|
-              puts "-#{name}"
-            end
-            (list - keys).sort.each do |name|
-              puts "+#{name}"
-            end
+          (keys - list).sort.each do |name|
+            puts "-#{name}"
+          end
+          (list - keys).sort.each do |name|
+            puts "+#{name}"
           end
         else
           raise "must not happen: #{@mode.inspect}"

data/lib/bitclust/subcommands/query_command.rb

@@ -19,6 +19,7 @@ module BitClust
       end
 
       def exec(argv, options)
+        super   # @db を用意する(スクリプトからは @db で参照する)
         argv.each do |query|
           # pp eval(query)   # FIXME: causes ArgumentError
           p eval(query)

data/lib/bitclust/subcommands/server_command.rb

@@ -9,6 +9,7 @@ require 'uri'
 
 require 'bitclust'
 require 'bitclust/subcommand'
+require 'bitclust/user_dirs'
 
 module BitClust
   module Subcommands
@@ -50,7 +51,7 @@ module BitClust
         @parser.on('--baseurl=URL', 'The base URL to host.') {|url|
           @baseurl = url
         }
-        @parser.on('--database=PATH', 'MethodDatabase root directory.') {|path|
+        @parser.on('-d', '--database=PATH', 'MethodDatabase root directory.') {|path|
           @dbpath = path
         }
         @parser.on('--srcdir=PATH', 'BitClust source directory.') {|path|
@@ -85,17 +86,20 @@ module BitClust
         }
       end
 
+      # DB はサブコマンド自身の -d/--database か、グローバル --database
+      # (options[:prefix])のどちらでも受ける。runner にはグローバル側を
+      # 要求させない(ancestors と同じ扱い)
+      def needs_database?
+        false
+      end
+
       def parse(argv)
         super
         load_config_file
         set_srcdir(srcdir_root) unless @srcdir
 
         unless @baseurl
-          $stderr.puts "missing base URL.  Use --baseurl or check ~/.bitclust/config"
-          exit 1
-        end
-        unless @dbpath || @autop
-          $stderr.puts "missing database path.  Use --database"
+          $stderr.puts "missing base URL.  Use --baseurl or check the config file (bitclust setup)"
           exit 1
         end
         unless @datadir
@@ -116,6 +120,7 @@ module BitClust
       end
 
       def exec(argv, options)
+        @dbpath = resolve_dbpath(options)
         begin
           require 'webrick'
         rescue LoadError
@@ -210,11 +215,17 @@ module BitClust
         @themedir ||= "#{@srcdir}/theme"
       end
 
+      # サブコマンド側の --database が無ければグローバル --database
+      # (runner の options[:prefix])を使う。--auto のときは不要
+      def resolve_dbpath(options)
+        dbpath = @dbpath || options[:prefix]
+        abort "missing database path.  Use --database (-d)" unless dbpath || @autop
+        dbpath
+      end
+
       def load_config_file
-        home_directory = Pathname(ENV.fetch('HOME'))
-        config_path = home_directory + ".bitclust/config"
-        if config_path.exist?
-          config = YAML.load_file(config_path)
+        config = UserDirs.load_config
+        if config
           @baseurl  ||= config[:baseurl]
           @dbpath   ||= "#{config[:database_prefix]}-#{config[:default_version]}"
           @port     ||= config[:port]

data/lib/bitclust/subcommands/setup_command.rb

@@ -8,6 +8,7 @@ require 'yaml'
 
 require 'bitclust'
 require 'bitclust/subcommand'
+require 'bitclust/user_dirs'
 
 module BitClust
   module Subcommands
@@ -43,7 +44,9 @@ module BitClust
         }
       end
 
-      # DB は ~/.bitclust 配下に自前で作るのでグローバル --database は不要
+      # DB は設定ファイル(UserDirs)が示す場所(既定は $XDG_DATA_HOME/bitclust、
+      # 旧 ~/.bitclust があればそちら)に自前で作るのでグローバル --database
+      # は不要
       def needs_database?
         false
       end
@@ -68,22 +71,37 @@ module BitClust
       private
 
       def purge
-        home_directory = Pathname(ENV.fetch("HOME"))
-        config_dir = home_directory + ".bitclust"
         print "Remove all generated files..."
-        FileUtils.rm_rf(config_dir.to_s)
+        puts
+        [UserDirs.legacy_dir, UserDirs.config_home, UserDirs.data_home, UserDirs.cache_home].each do |dir|
+          next unless dir.exist?
+          FileUtils.rm_rf(dir.to_s)
+          puts "  removed #{dir}"
+        end
         puts "done!"
         exit 0
       end
 
+      # 設定ファイル・DB・doctree checkout の置き場所を選ぶ。既に旧
+      # ~/.bitclust/config があり、まだ XDG 側の設定ファイルが無ければ
+      # 互換のため旧レイアウトを維持する。それ以外は XDG レイアウトを使う
+      def layout
+        legacy_config = UserDirs.legacy_dir + "config"
+        xdg_config = UserDirs.config_home + "config"
+        if legacy_config.exist? && !xdg_config.exist?
+          config_dir = UserDirs.legacy_dir
+          [config_dir + "config", (config_dir + "db").to_s, config_dir + "rubydoc"]
+        else
+          [xdg_config, (UserDirs.data_home + "db").to_s, UserDirs.data_home + "rubydoc"]
+        end
+      end
+
       def prepare
-        home_directory = Pathname(ENV.fetch("HOME")).expand_path
-        config_dir = home_directory + ".bitclust"
-        config_dir.mkpath
-        config_path = config_dir + "config"
-        rubydoc_dir = config_dir + "rubydoc"
+        config_path, database_prefix, rubydoc_dir = layout
+        config_path.dirname.mkpath
+        rubydoc_dir.dirname.mkpath
         @config = {
-          :database_prefix => (config_dir + "db").to_s,
+          :database_prefix => database_prefix,
           :encoding        => "utf-8",
           :versions        => @versions,
           :default_version => @versions.max,

data/lib/bitclust/syntax_highlighter.rb

@@ -161,9 +161,6 @@ module BitClust
         data << "<span class=\"nf\">#{token}</span>"
       when @stack.last == :embexpr
         data << "<span class=\"n\">#{token}</span>"
-      when @stack.last == :heredoc
-        style = COLORS[:heredoc_beg]
-        data << "<span class=\"#{style}\">#{token}"
       when @stack.last == :method_call
         data << "<span class=\"nf\">#{token}</span>"
         @stack.pop
@@ -192,6 +189,48 @@ module BitClust
       data
     end
 
+    # on_symbeg が開いた <span class="ss"> を、シンボルの末尾トークン
+    # (HTML エスケープ済み)を添えて閉じ、@stack の :symbol を外す。
+    # on_ident/on_const/on_kw は自前で閉じるので、それ以外の
+    # 末尾になりうるトークン(ivar/cvar/gvar/backtick/op/文字列終端)から呼ぶ
+    def close_symbol_span(token, data)
+      data << "#{escape_html(token)}</span>"
+      @stack.pop
+      data
+    end
+
+    def on_ivar(token, data)
+      if @stack.last == :symbol
+        close_symbol_span(token, data)
+      else
+        on_default(:on_ivar, token, data)
+      end
+    end
+
+    def on_cvar(token, data)
+      if @stack.last == :symbol
+        close_symbol_span(token, data)
+      else
+        on_default(:on_cvar, token, data)
+      end
+    end
+
+    def on_gvar(token, data)
+      if @stack.last == :symbol
+        close_symbol_span(token, data)
+      else
+        on_default(:on_gvar, token, data)
+      end
+    end
+
+    def on_backtick(token, data)
+      if @stack.last == :symbol
+        close_symbol_span(token, data)
+      else
+        on_default(:on_backtick, token, data)
+      end
+    end
+
     def on_kw(token, data)
       case
       when @stack.last == :symbol
@@ -221,6 +260,8 @@ module BitClust
 
     def on_op(token, data)
       case
+      when @stack.last == :symbol
+        close_symbol_span(token, data)
       when token == "::" && [:class, :module].include?(_ = @stack.last)
         @name_buffer << token
       when token == "<<" && @stack.last == :class
@@ -312,7 +353,7 @@ module BitClust
 
     def on_symbeg(token, data)
       style = COLORS[:symbeg]
-      data << "<span class=\"#{style}\">#{token}"
+      data << "<span class=\"#{style}\">#{escape_html(token)}"
       @stack << :symbol
       data
     end
@@ -336,14 +377,34 @@ module BitClust
         data << escape_html(token)
       when @stack.last == :string2
         data << "<span class=\"s2\">#{escape_html(token)}</span>"
+      when @stack.last == :symbol
+        data << escape_html(token)
       else
         on_default(:on_tstring_content, token, data)
       end
       data
     end
 
+    # "a": / 'b': 形式のシンボルキー。開いている文字列の span を
+    # 文字列終端と同じ流儀で閉じる
+    def on_label_end(token, data)
+      case @stack.last
+      when :string1
+        data << "#{escape_html(token)}</span>"
+        @stack.pop
+      when :string2
+        data << "<span class=\"s2\">#{escape_html(token)}</span>"
+        @stack.pop
+      else
+        on_default(:on_label_end, token, data)
+      end
+      data
+    end
+
     def on_tstring_end(token, data)
       case
+      when @stack.last == :symbol
+        data << "#{escape_html(token)}</span>"
       when token == "'"
         data << "#{token}</span>"
       when %i[qwords words qsymbols symbols].include?(_ = @stack.last)

data/lib/bitclust/user_dirs.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+#
+# ユーザーごとの設定ファイル・DB・キャッシュの置き場所。
+# XDG Base Directory(XDG_CONFIG_HOME / XDG_DATA_HOME / XDG_CACHE_HOME、
+# 未設定なら ~/.config ~/.local/share ~/.cache)配下の bitclust/ を使い、
+# 従来の ~/.bitclust は互換のため読み取りの fallback として残す。
+
+require 'pathname'
+require 'yaml'
+
+module BitClust
+  module UserDirs
+    module_function
+
+    def home
+      Pathname(ENV.fetch('HOME')).expand_path
+    end
+
+    # 従来の置き場所(bitclust setup が 1.7 まで作っていた場所)
+    def legacy_dir
+      home + '.bitclust'
+    end
+
+    def config_home
+      xdg_dir('XDG_CONFIG_HOME', '.config')
+    end
+
+    def data_home
+      xdg_dir('XDG_DATA_HOME', File.join('.local', 'share'))
+    end
+
+    def cache_home
+      xdg_dir('XDG_CACHE_HOME', '.cache')
+    end
+
+    # 設定ファイルの候補(優先順)
+    def config_candidates
+      [config_home + 'config', legacy_dir + 'config']
+    end
+
+    # 存在する設定ファイル。XDG の場所を先に見て、無ければ従来の
+    # ~/.bitclust/config。どちらも無ければ nil
+    def config_file
+      config_candidates.find(&:exist?)
+    end
+
+    # 設定ファイルを読む。無ければ nil
+    def load_config
+      path = config_file
+      path ? YAML.load_file(path) : nil
+    end
+
+    # 環境変数が絶対パスならそれを、無ければ HOME 直下の既定を使う
+    # (XDG の仕様では相対パスの指定は無視する)
+    def xdg_dir(env_key, default_subdir)
+      value = ENV[env_key]
+      base = (value && Pathname(value).absolute?) ? Pathname(value) : home + default_subdir
+      base + 'bitclust'
+    end
+    private_class_method :xdg_dir
+  end
+end

data/lib/bitclust/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module BitClust
-  VERSION = "1.7.0"
+  VERSION = "1.8.0"
 end

data/test/test_chm_command.rb

@@ -0,0 +1,22 @@
+require 'test/unit'
+require 'bitclust'
+require 'bitclust/subcommands/chm_command'
+
+class TestChmSitemap < Test::Unit::TestCase
+  def test_to_html_builds_nested_sitemap
+    root = BitClust::Subcommands::ChmCommand::Sitemap.new('Ruby', 'doc/index.html')
+    child = BitClust::Subcommands::ChmCommand::Sitemap::Content.new('Array <=> & "q"', 'class/-array.html')
+    root << child
+    html = root.to_html
+    assert_match(%r{<param name="Name" value="Ruby">}, html)
+    assert_match(%r{<param name="Local" value="doc/index.html">}, html)
+    assert_match(%r{<UL>.*Array &lt;=&gt; &amp; &quot;q&quot;.*</UL>}m, html)
+  end
+
+  def test_to_html_without_children_has_no_ul
+    leaf = BitClust::Subcommands::ChmCommand::Sitemap::Content.new('Leaf')
+    html = leaf.to_html
+    assert_not_match(/<UL>/, html)
+    assert_not_match(/Local/, html)
+  end
+end

data/test/test_epub_command.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+require 'test/unit'
+require 'test/unit/rr'
+require 'tmpdir'
+require 'bitclust'
+require 'bitclust/subcommands/epub_command'
+require 'bitclust/generators/epub'
+
+# `bitclust epub` は常に失敗していた:
+#
+# 1) --catalog=PATH は @catalogdir に保存されるが、exec は（定義されていない
+#    ため常に nil の）@catalog をジェネレータへ渡していた。ジェネレータは
+#    それを statichtml へ --catalog=（空文字列）として渡し、
+#    Pathname.new("").realpath が Errno::ENOENT で失敗する。
+# 2) @catalogdir の既定値が nil だったので、--catalog を指定しない限り
+#    `bitclust epub -o DIR` は必ず失敗していた
+#    （chm_command / statichtml_command と同じく、既定は同梱の
+#    data/bitclust/catalog にすべき）。
+class TestEPUBCommandCatalog < Test::Unit::TestCase
+  def test_default_catalogdir_is_the_bundled_catalog
+    cmd = BitClust::Subcommands::EPUBCommand.new
+    cmd.parse([])
+    expected = cmd.srcdir_root + "data/bitclust/catalog"
+    assert_equal(expected, cmd.instance_variable_get(:@catalogdir))
+    assert_true(expected.directory?, "#{expected} must exist so --catalog can be omitted")
+  end
+
+  def test_catalog_option_overrides_the_default
+    Dir.mktmpdir do |dir|
+      cmd = BitClust::Subcommands::EPUBCommand.new
+      cmd.parse(["--catalog=#{dir}"])
+      assert_equal(Pathname.new(dir).realpath, cmd.instance_variable_get(:@catalogdir))
+    end
+  end
+
+  def capture_generator_options(cmd)
+    captured = nil
+    fake_generator = Object.new
+    stub(fake_generator).generate { nil }
+    stub(BitClust::Generators::EPUB).new {|opts| captured = opts; fake_generator }
+    cmd.exec([], { :prefix => nil, :capi => false })
+    captured
+  end
+
+  def test_exec_passes_the_default_catalogdir_to_the_generator
+    cmd = BitClust::Subcommands::EPUBCommand.new
+    cmd.parse([])
+    opts = capture_generator_options(cmd)
+    assert_equal(cmd.instance_variable_get(:@catalogdir), opts[:catalog])
+  end
+
+  def test_exec_passes_the_overridden_catalogdir_to_the_generator
+    Dir.mktmpdir do |dir|
+      cmd = BitClust::Subcommands::EPUBCommand.new
+      cmd.parse(["--catalog=#{dir}"])
+      opts = capture_generator_options(cmd)
+      assert_equal(Pathname.new(dir).realpath, opts[:catalog])
+    end
+  end
+end