RubyGems - bitclust-core - Versions diffs - 0.6.0 → 0.7.0 - Mend

bitclust-core 0.6.0 → 0.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (34) hide show

checksums.yaml +7 -0
data/ChangeLog +7 -0
data/Gemfile +1 -0
data/bitclust.gemspec +1 -0
data/data/bitclust/template.offline/class +1 -1
data/lib/bitclust/crossrubyutils.rb +2 -2
data/lib/bitclust/methodentry.rb +1 -2
data/lib/bitclust/progress_bar.rb +7 -0
data/lib/bitclust/rdcompiler.rb +1 -1
data/lib/bitclust/runner.rb +46 -32
data/lib/bitclust/searcher.rb +14 -13
data/lib/bitclust/silent_progress_bar.rb +17 -0
data/lib/bitclust/subcommand.rb +27 -0
data/lib/bitclust/subcommands/ancestors_command.rb +145 -0
data/lib/bitclust/subcommands/chm_command.rb +268 -0
data/lib/bitclust/subcommands/classes_command.rb +73 -0
data/lib/bitclust/subcommands/extract_command.rb +55 -0
data/lib/bitclust/subcommands/htmlfile_command.rb +105 -0
data/lib/bitclust/subcommands/init_command.rb +29 -30
data/lib/bitclust/subcommands/list_command.rb +39 -41
data/lib/bitclust/subcommands/lookup_command.rb +71 -73
data/lib/bitclust/subcommands/methods_command.rb +159 -0
data/lib/bitclust/subcommands/preproc_command.rb +35 -0
data/lib/bitclust/subcommands/property_command.rb +47 -48
data/lib/bitclust/subcommands/query_command.rb +12 -18
data/lib/bitclust/subcommands/server_command.rb +180 -182
data/lib/bitclust/subcommands/setup_command.rb +85 -89
data/lib/bitclust/subcommands/statichtml_command.rb +276 -0
data/lib/bitclust/subcommands/update_command.rb +39 -41
data/lib/bitclust/version.rb +1 -1
data/test/test_bitclust.rb +1 -1
data/test/test_rdcompiler.rb +1 -1
data/test/test_runner.rb +7 -14
metadata +120 -114

data/lib/bitclust/subcommands/chm_command.rb ADDED Viewed

@@ -0,0 +1,268 @@
+# -*- coding: utf-8 -*-
+require 'bitclust'
+require 'bitclust/subcommand'
+require 'fileutils'
+# TODO Remove this line when we drop 1.8 support
+require 'kconv'
+require 'bitclust/progress_bar'
+module BitClust
+  module Subcommands
+    class ChmCommand < Subcommand
+      HHP_SKEL = <<EOS
+[OPTIONS]
+Compatibility=1.1 or later
+Compiled file=refm.chm
+Contents file=refm.hhc
+Default Window=titlewindow
+Default topic=doc/index.html
+Display compile progress=No
+Error log file=refm.log
+Full-text search=Yes
+Index file=refm.hhk
+Language=0x411 日本語 (日本)
+Title=Rubyリファレンスマニュアル
+[WINDOWS]
+titlewindow="Rubyリファレンスマニュアル","refm.hhc","refm.hhk","doc/index.html","doc/index.html",,,,,0x21420,,0x387e,,,,,,,,0
+[FILES]
+<%= @html_files.join("\n") %>
+EOS
+      HHC_SKEL = <<EOS
+<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">
+<HTML>
+<HEAD>
+</HEAD>
+<BODY>
+<UL><% [:library].each do |k| %>
+<%= @sitemap[k].to_html %>
+<% end %></UL>
+</BODY>
+</HTML>
+EOS
+      HHK_SKEL = <<EOS
+<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">
+<HTML>
+<HEAD>
+</HEAD>
+<BODY>
+<UL><% @index_contents.sort.each do |content| %>
+<%= content.to_html %>
+<% end %></UL>
+</BODY>
+</HTML>
+EOS
+      class Sitemap
+        def initialize(name, local = nil)
+          @name = name
+          @contents = Content.new(name, local)
+        end
+        def method_missing(name, *args, &block)
+          @contents.send(name, *args, &block)
+        end
+        class Content
+          include Enumerable
+          include ERB::Util
+          def initialize(name, local = nil)
+            @name = name
+            @local = local
+            @contents = []
+          end
+          attr_reader :name, :local, :contents
+          def [](index)
+            @contents[index]
+          end
+          def <<(content)
+            @contents << content
+          end
+          def <=>(other)
+            @name <=> other.name
+          end
+          def each
+            @contents.each do |content|
+              yield content
+            end
+          end
+          def to_html
+            str = "<LI> <OBJECT type=\"text/sitemap\">\n"
+            str << "        <param name=\"Name\" value=\"<%=h @name%>\">\n"
+            if @local
+              str << "        <param name=\"Local\" value=\"<%=@local%>\">\n"
+            end
+            str << "        </OBJECT>\n"
+            unless contents.empty?
+              str << "<UL>\n"
+              @contents.each do |content|
+                str << content.to_html
+              end
+              str << "</UL>\n"
+            end
+            ERB.new(str).result(binding)
+          end
+        end
+      end
+      class URLMapperEx < URLMapper
+        def library_url(name)
+          if name == '/'
+            "/library/index.html"
+          else
+            "/library/#{encodename_fs(name)}.html"
+          end
+        end
+        def class_url(name)
+          "/class/#{encodename_fs(name)}.html"
+        end
+        def method_url(spec)
+          cname, tmark, mname = *split_method_spec(spec)
+          "/method/#{encodename_fs(cname)}/#{typemark2char(tmark)}/#{encodename_fs(mname)}.html"
+        end
+        def document_url(name)
+          "/doc/#{encodename_fs(name)}.html"
+        end
+      end
+      def initialize
+        super
+        @sitemap = {
+          :library => Sitemap.new('ライブラリ', 'library/index.html'),
+        }
+        @sitemap[:library] << Sitemap::Content.new('標準ライブラリ', 'library/_builtin.html')
+        @sitemap[:library] << Sitemap::Content.new('添付ライブラリ')
+        @stdlibs = {}
+        @index_contents = []
+        @parser.banner = "Usage: #{File.basename($0, '.*')} chm [options]"
+        @parser.on('-o', '--outputdir=PATH', 'Output directory') do |path|
+          begin
+            @outputdir = Pathname.new(path).realpath
+          rescue Errno::ENOENT
+            FileUtils.mkdir_p(path, :verbose => true)
+            retry
+          end
+        end
+      end
+      def exec(argv, options)
+        create_manager_config
+        prefix = options[:prefix]
+        db = MethodDatabase.new(prefix.to_s)
+        manager = ScreenManager.new(@manager_config)
+        @html_files = []
+        db.transaction do
+          methods = {}
+          db.methods.each do |entry|
+            method_name = entry.klass.name + entry.typemark + entry.name
+            (methods[method_name] ||= []) << entry
+          end
+          entries = db.docs + db.libraries.sort + db.classes.sort + methods.values.sort
+          pb = ProgressBar.new('entry', entries.size)
+          entries.each do |c|
+            filename = create_html_file(c, manager, @outputdir, db)
+            @html_files << filename
+            e = c.is_a?(Array) ? c.sort.first : c
+            case e.type_id
+            when :library
+              content = Sitemap::Content.new(e.name.to_s, filename)
+              if e.name.to_s != '_builtin'
+                @sitemap[:library][1] << content
+                @stdlibs[e.name.to_s] = content
+              end
+              @index_contents << Sitemap::Content.new(e.name.to_s, filename)
+            when :class
+              content = Sitemap::Content.new(e.name.to_s, filename)
+              if e.library.name.to_s == '_builtin'
+                @sitemap[:library][0] << content
+              else
+                @stdlibs[e.library.name.to_s] << content
+              end
+              @index_contents << Sitemap::Content.new("#{e.name} (#{e.library.name})", filename)
+            when :method
+              e.names.each do |e_name|
+                name = e.typename == :special_variable ? "$#{e_name}" : e_name
+                @index_contents <<
+                  Sitemap::Content.new("#{name} (#{e.library.name} - #{e.klass.name})", filename)
+                @index_contents <<
+                  Sitemap::Content.new("#{e.klass.name}#{e.typemark}#{name} (#{e.library.name})", filename)
+              end
+            end
+            pb.title.replace(e.name)
+            pb.inc
+          end
+          pb.finish
+        end
+        @html_files.sort!
+        create_file(@outputdir + 'refm.hhp', HHP_SKEL, true)
+        create_file(@outputdir + 'refm.hhc', HHC_SKEL, true)
+        create_file(@outputdir + 'refm.hhk', HHK_SKEL, true)
+        create_file(@outputdir + 'library/index.html', manager.library_index_screen(db.libraries.sort, {:database => db}).body)
+        create_file(@outputdir + 'class/index.html', manager.class_index_screen(db.classes.sort, {:database => db}).body)
+        FileUtils.cp(@manager_config[:themedir] + @manager_config[:css_url],
+                     @outputdir.to_s, {:verbose => true, :preserve => true})
+      end
+      private
+      def create_manager_config
+        @manager_config = {
+          :baseurl     => 'http://example.com/',
+          :suffix      => '.html',
+          :templatedir => srcdir_root + 'data'+ 'bitclust' + 'template',
+          :themedir    => srcdir_root + 'theme' + 'default',
+          :css_url     => 'style.css',
+          :cgi_url     => '',
+          :tochm_mode  => true
+        }
+        @manager_config[:urlmapper] = URLMapperEx.new(@manager_config)
+      end
+      def create_html_file(entry, manager, outputdir, db)
+        html = manager.entry_screen(entry, {:database => db}).body
+        e = entry.is_a?(Array) ? entry.sort.first : entry
+        path = case e.type_id
+               when :library, :class, :doc
+                 outputdir + e.type_id.to_s + (NameUtils.encodename_fs(e.name) + '.html')
+               when :method
+                 outputdir + e.type_id.to_s + NameUtils.encodename_fs(e.klass.name) +
+                   e.typechar + (NameUtils.encodename_fs(e.name) + '.html')
+               else
+                 raise
+               end
+        FileUtils.mkdir_p(path.dirname) unless path.dirname.directory?
+        path.open('w') do |f|
+          f.write(html)
+        end
+        path.relative_path_from(outputdir).to_s
+      end
+      def create_file(path, skel, sjis_flag = false)
+        $stderr.print("creating #{path} ...")
+        str = ERB.new(skel).result(binding)
+        # TODO Use String#encode when we drop 1.8 support
+        str = str.tosjis if sjis_flag
+        path.open('w') do |f|
+          f.write(str)
+        end
+        $stderr.puts(" done.")
+      end
+    end
+  end
+end

data/lib/bitclust/subcommands/classes_command.rb ADDED Viewed

@@ -0,0 +1,73 @@
+require 'pathname'
+require 'optparse'
+require 'bitclust/crossrubyutils'
+module BitClust
+  module Subcommands
+    class ClassesCommand < Subcommand
+      include CrossRubyUtils
+      def initialize
+        super
+        @rejects = []
+        @verbose = false
+        @parser.banner = "Usage: #{File.basename($0, '.*')} [-r<lib>] <lib>"
+        @parser.on('-r', '--reject=LIB', 'Reject library LIB') {|lib|
+          @rejects.concat lib.split(',')
+        }
+        @parser.on('-v', '--verbose', 'Show all ruby version.') {
+          @verbose = true
+        }
+      end
+      def parse(argv)
+        super
+        option_error('wrong number of arguments') unless argv.size == 1
+      end
+      def exec(argv, options)
+        lib = argv[0]
+        print_crossruby_table {|ruby| defined_classes(ruby, lib, @rejects) }
+      end
+      def defined_classes(ruby, lib, rejects)
+        script = <<-SCRIPT
+          def class_extent
+            result = []
+            ObjectSpace.each_object(Module) do |c|
+              result.push c
+            end
+            result
+          end
+          %w(#{rejects.join(" ")}).each do |lib|
+            begin
+              require lib
+            rescue LoadError
+            end
+          end
+          if "#{lib}" == "_builtin"
+            class_extent().each do |c|
+              puts c
+            end
+          else
+            before = class_extent()
+            begin
+              require "#{lib}"
+            rescue LoadError
+              $stderr.puts "\#{RUBY_VERSION} (\#{RUBY_RELEASE_DATE}): library not exist: #{lib}"
+              exit
+            end
+            after = class_extent()
+            (after - before).each do |c|
+              puts c
+            end
+          end
+        SCRIPT
+        output = `#{ruby} -e '#{script}'`
+        output.split
+      end
+    end
+  end
+end

data/lib/bitclust/subcommands/extract_command.rb ADDED Viewed

@@ -0,0 +1,55 @@
+require 'pathname'
+require 'optparse'
+require 'bitclust'
+require 'bitclust/subcommand'
+module BitClust
+  module Subcommands
+    class ExtractCommand < Subcommand
+      def initialize
+        super
+        @parser.banner = "Usage: #{File.basename($0, '.*')} <file>..."
+        @parser.on('-c', '--check-only', 'Check syntax and output status.') {
+          @check_only = true
+        }
+      end
+      def exec(argv, options)
+        success = true
+        argv.each do |path|
+          begin
+            lib = RRDParser.parse_stdlib_file(path)
+            if @check_only
+              $stderr.puts "#{path}: OK"
+            else
+              show_library lib
+            end
+          rescue WriterError => err
+            raise if $DEBUG
+            $stderr.puts "#{File.basename($0, '.*')}: FAIL: #{err.message}"
+            success = false
+          end
+        end
+        exit success
+      end
+      def show_library(lib)
+        puts "= Library #{lib.name}"
+        lib.classes.each do |c|
+          puts "#{c.type} #{c.name}"
+          c.each do |m|
+            puts "\t* #{m.klass.name}#{m.typemark}#{m.names.join(',')}"
+          end
+        end
+        unless lib.methods.empty?
+          puts "Additional Methods:"
+          lib.methods.each do |m|
+            puts "\t* #{m.klass.name}#{m.typemark}#{m.names.join(',')}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bitclust/subcommands/htmlfile_command.rb ADDED Viewed

@@ -0,0 +1,105 @@
+# Copyright (c) 2006-2007 Minero Aoki
+#
+# This program is free software.
+# You can distribute/modify this program under the Ruby License.
+#
+require 'bitclust'
+require 'bitclust/subcommand'
+module BitClust
+  module Subcommands
+    class HtmlfileCommand < Subcommand
+      def initialize
+        super
+        @target = nil
+        @templatedir = srcdir_root + "data/bitclust/template.offline"
+        @baseurl = "file://" + srcdir_root.to_s
+        @version = "2.0.0"
+        @parser.banner = "Usage: #{File.basename($0, '.*')} htmlfile [options] rdfile"
+        @parser.on('--target=NAME', 'Compile NAME to HTML.') {|name|
+          @target = name
+        }
+        @parser.on('--force', '-f', 'Force to use rd_file template.') {|name|
+          @rd_file = true
+        }
+        @parser.on('--ruby_version=VER', '--ruby=VER', 'Set Ruby version') {|version|
+          @version = version
+        }
+        @parser.on('--baseurl=URL', 'Base URL of generated HTML') {|url|
+          @baseurl = url
+        }
+        @parser.on('--templatedir=PATH', 'Template directory') {|path|
+          @templatedir = path
+        }
+      end
+      def exec(argv, options)
+        db = MethodDatabase.dummy({'version' => @version})
+        if options[:prefix]
+          db = MethodDatabase.new(options[:prefix])
+        end
+        @capi = options[:capi]
+        target_file = argv[0]
+        options = { 'version' => @version }
+        manager = ScreenManager.new(:templatedir => @templatedir,
+                                    :base_url => @baseurl,
+                                    :cgi_url => @baseurl,
+                                    :default_encoding => 'utf-8')
+        unless @rd_file
+          begin
+            if @capi
+              lib = FunctionReferenceParser.parse_file(target_file, options)
+              unless @target
+                raise NotImplementedError, "generating a C API html without --target=NAME is not implemented yet."
+              end
+            else
+              lib = RRDParser.parse_stdlib_file(target_file, options)
+            end
+            entry = @target ? lookup(lib, @target) : lib
+            puts manager.entry_screen(entry, { :database => db }).body
+            return
+          rescue ParseError => ex
+            $stderr.puts ex.message
+            $stderr.puts ex.backtrace[0], ex.backtrace[1..-1].map{|s| "\tfrom " + s}
+          end
+        end
+        begin
+          entry = DocEntry.new(db, target_file)
+          source = Preprocessor.read(target_file, options)
+          entry.source = source
+          puts manager.doc_screen(entry, { :database => db }).body
+        rescue WriterError => ex
+          $stderr.puts ex.message
+          exit 1
+        end
+      end
+      private
+      def lookup(lib, key)
+        case
+        when @capi && NameUtils.functionname?(key)
+          lib.find {|func| func.name == key}
+        when NameUtils.method_spec?(key)
+          spec = MethodSpec.parse(key)
+          if spec.constant?
+            begin
+              lib.fetch_class(key)
+            rescue UserError
+              lib.fetch_methods(spec)
+            end
+          else
+            lib.fetch_methods(spec)
+          end
+        when NameUtils.classname?(key)
+          lib.fetch_class(key)
+        else
+          raise InvalidKey, "wrong search key: #{key.inspect}"
+        end
+      end
+    end
+  end
+end