bitclust-core 0.6.0 → 0.7.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 16a76bb3555a76e8172df8e518012cf5c441bf15
+  data.tar.gz: 98b008bd6df5d144bbb98bfe1cae8757bfe1dffb
+SHA512:
+  metadata.gz: 712c1e7a269282a99cf27af4176d40b9e0337d5533d27aaea190648c0df49232d6114374fa74e3b693f0b8dd000dba5b7360cec8c6885fcb1079cbb139235b8e
+  data.tar.gz: f8e50965325085b78e6b2dc4230d61c597d0d646699984e96adeedccdf322d7cab6cf00bf5dc3bf7f3eb2c45017b9397d9d9bbd3d71056513781f7727b12414c

data/ChangeLog

@@ -1,3 +1,10 @@
+2013-04-12  Kazuhiro NISHIYAMA  <zn@mbf.nifty.com>
+
+	* lib/bitclust/subcommands/setup_command.rb (BitClust::SetupCommand#checkout):
+	use result of system directly instead of calling "svn help" with
+	redirects. because it may cause permission problem on cygwin.
+	see https://twitter.com/higaki/status/322542075927212034
+
 2013-04-06  Sho Hashimoto  <sho-h@netlab.jp>
 
 	* lib/bitclust/nameutils.rb

data/Gemfile

@@ -1,6 +1,7 @@
 source "http://rubygems.org"
 
 gem "rake"
+gem "progressbar"
 
 # Specify your gem's dependencies in bitclust.gemspec
 gemspec :name => "bitclust"

data/bitclust.gemspec

@@ -30,4 +30,5 @@ EOD
   s.add_development_dependency "test-unit-notify"
   s.add_development_dependency "test-unit-rr"
   s.add_runtime_dependency "rack"
+  s.add_runtime_dependency "progressbar"
 end

data/data/bitclust/template.offline/class

@@ -55,7 +55,7 @@
   entries.each do |m|
     m.names.each do |mname|
 %>
-<a href="#<%= m.index_id(mname, false) %>"><%= "#{prefix}#{mname}" %></a>
+<a href="#<%= m.index_id %>"><%= "#{prefix}#{mname}" %></a>
 <%
     end
   end

data/lib/bitclust/crossrubyutils.rb

@@ -40,7 +40,7 @@ module BitClust
       ver.split[1].tr('.', '')
     end
 
-    def get_ruby(version)      
+    def get_ruby(version)
       forall_ruby(ENV['PATH']) do |ruby, |
         v = `#{ruby} -e 'print RUBY_VERSION'`
         patch = `#{ruby} -e 'print RUBY_PATCHLEVEL if defined? RUBY_PATCHLEVEL'`
@@ -50,7 +50,7 @@ module BitClust
       end
       return nil
     end
-    
+
     def build_crossruby_table
       ENV.delete 'RUBYOPT'
       ENV.delete 'RUBYLIB'

data/lib/bitclust/methodentry.rb

@@ -122,8 +122,7 @@ module BitClust
       "#{t == '#' ? '' : t}#{m}"
     end
 
-    def index_id(name, remove_prefix = true)
-      name = name.sub(/^\$/, '') if remove_prefix
+    def index_id
       "#{methodid2typechar(@id)}_#{encodename_fs(name).gsub(/=/, '--')}".upcase
     end
 

data/lib/bitclust/progress_bar.rb

@@ -0,0 +1,7 @@
+
+begin
+  require 'progressbar'
+rescue LoadError
+  require 'bitclust/silent_progress_bar'
+  ProgressBar = BitClust::SilentProgressBar
+end

data/lib/bitclust/rdcompiler.rb

@@ -333,7 +333,7 @@ module BitClust
       # FIXME: check parameters, types, etc.
       sig = MethodSignature.parse(sig_line)
       string %Q(<dt class="method-heading")
-      string %Q( id="#{@method.index_id(sig.name)}") if first
+      string %Q( id="#{@method.index_id}") if first
       string '><code>'
       string @method.klass.name + @method.typemark if @opt
       string escape_html(sig.friendly_string)

data/lib/bitclust/runner.rb

@@ -41,18 +41,30 @@ module BitClust
       @parser.banner = <<-EndBanner
 Usage: #{File.basename($0, '.*')} [global options] <subcommand> [options] [args]
 
-Subcommands:
+Subcommands(for users):
     init        Initialize database.
+    update      Update database.
+    setup       Initialize and update database with default options.
     list        List libraries/classes/methods in database.
     lookup      Lookup a library/class/method from database.
     search      Search classes/methods from database.
+
+Subcommands(for developers):
+    ancestors   Compare class/module's ancestors between Ruby and DB.
+    htmlfile    Generate a static HTML file for test.
     query       Dispatch arbitrary query.
-    update      Update database.
     property    Handle database properties.
-    setup       Initialize and update database with default options.
+    preproc     Preprocess source file.
+    extract     Extract method entries from source file.
+    classes     Display defined classes for all ruby.
+    methods     Display defined methods for all ruby.
+
+Subcommands(for packagers):
+    statichtml  Generate static HTML files.
+    chm         Generate static HTML files for CHM.
 
 Global Options:
-  EndBanner
+      EndBanner
       @parser.on('-d', '--database=PATH', 'Database prefix.') {|path|
         @prefix = path
       }
@@ -71,15 +83,23 @@ Global Options:
         exit 0
       }
       @subcommands = {
-        'init'     => BitClust::Subcommands::InitCommand.new,
-        'list'     => BitClust::Subcommands::ListCommand.new,
-        'lookup'   => BitClust::Subcommands::LookupCommand.new,
-        'search'   => BitClust::Searcher.new,
-        'query'    => BitClust::Subcommands::QueryCommand.new,
-        'update'   => BitClust::Subcommands::UpdateCommand.new,
-        'property' => BitClust::Subcommands::PropertyCommand.new,
-        'setup'    => BitClust::Subcommands::SetupCommand.new,
-        'server'   => BitClust::Subcommands::ServerCommand.new,
+        'init'        => BitClust::Subcommands::InitCommand.new,
+        'list'        => BitClust::Subcommands::ListCommand.new,
+        'lookup'      => BitClust::Subcommands::LookupCommand.new,
+        'search'      => BitClust::Searcher.new,
+        'query'       => BitClust::Subcommands::QueryCommand.new,
+        'update'      => BitClust::Subcommands::UpdateCommand.new,
+        'property'    => BitClust::Subcommands::PropertyCommand.new,
+        'setup'       => BitClust::Subcommands::SetupCommand.new,
+        'server'      => BitClust::Subcommands::ServerCommand.new,
+        'statichtml'  => BitClust::Subcommands::StatichtmlCommand.new,
+        'htmlfile'    => BitClust::Subcommands::HtmlfileCommand.new,
+        'chm'         => BitClust::Subcommands::ChmCommand.new,
+        'ancestors'   => BitClust::Subcommands::AncestorsCommand.new,
+        'preproc'     => BitClust::Subcommands::PreprocCommand.new,
+        'extract'     => BitClust::Subcommands::ExtractCommand.new,
+        'classes'     => BitClust::Subcommands::ClassesCommand.new,
+        'methods'     => BitClust::Subcommands::MethodsCommand.new,
       }
     end
 
@@ -105,26 +125,20 @@ Global Options:
         $stderr.puts cmd.help
         exit 1
       end
-      case name
-      when "setup", "server"
-        db = nil
-      else
-        config = load_config()
-        if config
-          @version ||= config[:default_version]
-          @prefix ||= "#{config[:database_prefix]}-#{@version}"
-        end
-        unless @prefix
-          $stderr.puts "no database given. Use --database option"
-          exit 1
-        end
-        if @capi
-          db = BitClust::FunctionDatabase.new(@prefix)
-        else
-          db = BitClust::MethodDatabase.new(@prefix)
-        end
+      config = load_config()
+      if config
+        @version ||= config[:default_version]
+        @prefix ||= "#{config[:database_prefix]}-#{@version}"
       end
-      cmd.exec(db, argv)
+      unless @prefix
+        $stderr.puts "no database given. Use --database option"
+        exit 1
+      end
+      options = {
+        :prefix => @prefix,
+        :capi   => @capi
+      }
+      cmd.exec(argv, options)
     rescue BitClust::WriterError => err
       raise if $DEBUG
       error err.message

data/lib/bitclust/searcher.rb

@@ -34,34 +34,34 @@ module BitClust
       @target_type = nil
       @listen_url = nil
       @foreground = false
-      @parser = OptionParser.new {|opt|
-        opt.banner = "Usage: #{@name} <pattern>"
+      @parser = OptionParser.new {|parser|
+        parser.banner = "Usage: #{@name} <pattern>"
         unless cmd == 'bitclust'
-          opt.on('-d', '--database=URL', "Database location (default: #{dblocation_name()})") {|loc|
+          parser.on('-d', '--database=URL', "Database location (default: #{dblocation_name()})") {|loc|
             url = (/:/ =~ loc) ? loc : "file://#{File.expand_path(loc)}"
             @dblocation = URI.parse(url)
           }
-          opt.on('--server=URL', 'Spawns BitClust database server and listen URL.  Requires --database option with local path.') {|url|
+          parser.on('--server=URL', 'Spawns BitClust database server and listen URL.  Requires --database option with local path.') {|url|
             require 'bitclust/server'   # require here for speed
             @listen_url = url
           }
-          opt.on('--foreground', 'Do not become daemon (for debug)') {
+          parser.on('--foreground', 'Do not become daemon (for debug)') {
             @foreground = true
           }
         end
-        opt.on('-a', '--all', 'Prints descriptions for all matched entries.') {
+        parser.on('-a', '--all', 'Prints descriptions for all matched entries.') {
           @describe_all = true
         }
-        opt.on('-l', '--line', 'Prints one entry in one line.') {
+        parser.on('-l', '--line', 'Prints one entry in one line.') {
           @linep = true
         }
-        opt.on('-e', '--encoding=ENCODING', 'Select encoding.') {|enc|
+        parser.on('-e', '--encoding=ENCODING', 'Select encoding.') {|enc|
           @encoding = enc
         }
-        opt.on('--class', 'Search class or module.') {
+        parser.on('--class', 'Search class or module.') {
           @target_type = :class
         }
-        opt.on('--version', 'Prints version and quit.') {
+        parser.on('--version', 'Prints version and quit.') {
           if cmd == 'bitclust'
             puts "BitClust -- Next generation reference manual interface"
             exit 1
@@ -70,8 +70,8 @@ module BitClust
             exit 1
           end
         }
-        opt.on('--help', 'Prints this message and quit.') {
-          puts opt.help
+        parser.on('--help', 'Prints this message and quit.') {
+          puts parser.help
           exit 0
         }
       }
@@ -88,7 +88,8 @@ module BitClust
       end
     end
 
-    def exec(db, argv)
+    def exec(argv, options = {})
+      db = nil
       if @listen_url
         spawn_server db
       else

data/lib/bitclust/silent_progress_bar.rb

@@ -0,0 +1,17 @@
+
+module BitClust
+  class SilentProgressBar
+
+    attr_reader :title
+
+    def initialize(title, total, out = $stderr)
+      @title, @total, @out = title, total, out
+    end
+
+    def inc(step = 1)
+    end
+
+    def finish
+    end
+  end
+end

data/lib/bitclust/subcommand.rb

@@ -10,6 +10,14 @@ require 'yaml'
 module BitClust
 
   class Subcommand
+    def initialize
+      @parser = OptionParser.new
+      @parser.on_tail("-h", "--help", "Print this message and quit."){
+        $stderr.puts help
+        exit 0
+      }
+    end
+
     def parse(argv)
       @parser.parse! argv
     end
@@ -18,11 +26,30 @@ module BitClust
       @parser.help
     end
 
+    def exec(argv, options)
+      prefix = options[:prefix]
+      if options[:capi]
+        @db = BitClust::FunctionDatabase.new(prefix)
+      else
+        @db = BitClust::MethodDatabase.new(prefix)
+      end
+    end
+
     # TODO refactor
     def error(message)
       $stderr.puts "#{File.basename($0, '.*')}: error: #{message}"
       exit 1
     end
+
+    def option_error(message)
+      $stderr.puts message
+      $stderr.puts help
+      exit 1
+    end
+
+    def srcdir_root
+      Pathname.new(__FILE__).realpath.dirname.parent.parent
+    end
   end
 end
 

data/lib/bitclust/subcommands/ancestors_command.rb

@@ -0,0 +1,145 @@
+require 'bitclust'
+require 'bitclust/crossrubyutils'
+
+require 'pathname'
+require 'optparse'
+require 'set'
+
+module BitClust
+  module Subcommands
+    class AncestorsCommand < Subcommand
+      include CrossRubyUtils
+
+      def initialize
+        super
+        @prefix = nil
+        @requires = []
+        @version = RUBY_VERSION
+        @all = false
+        @verbose = false
+        @parser.banner = <<-BANNER
+Usage: #{File.basename($0, '.*')} ancestors [-r<lib>] [--ruby=<VER>] --db=PATH <classname>
+       #{File.basename($0, '.*')} ancestors [-r<lib>] [--ruby=<VER>] --db=PATH --all
+NG Sample:
+  $ #{File.basename($0, '.*')} ancestors -rfoo --ruby=1.9.1 --db=./db Foo
+  NG : Foo
+  + FooModule (The Ruby have this class/module in ancestors of the class)
+  - BarModule (The Database have this class/module in ancestors of the class)
+Options:
+        BANNER
+        @parser.on('-d', '--database=PATH', 'Database prefix.') {|path|
+          @prefix = path
+        }
+        @parser.on('-r LIB', 'Requires library LIB') {|lib|
+          @requires.push lib
+        }
+        @parser.on('--ruby=[VER]', "The version of Ruby interpreter"){|ver|
+          @version = ver
+        }
+        @parser.on('-v', '--verbose', 'Show differences'){
+          @verbose = true
+        }
+        @parser.on('--all', 'Check anccestors for all classes'){
+          @all = true
+        }
+      end
+
+      def exec(argv, options)
+        classname = argv[0]
+        db = MethodDatabase.new(@prefix)
+        ruby = get_ruby(@version)
+        if classname && !@all
+          check_ancestors(db, ruby, @requires, classname)
+        else
+          $stderr.puts 'check all...'
+          check_all_ancestors(db, ruby, @requires)
+        end
+      end
+
+      private
+
+      def ancestors(ruby, requires, classname)
+        req = requires.map{|lib|
+          unless '_builtin' == lib
+            "-r#{lib}"
+          else
+            ''
+          end
+        }.join(" ")
+        script = <<-SRC
+          c = #{classname}
+          puts c.ancestors.join("\n")
+        SRC
+        puts "#{ruby} #{req} -e '#{script}'"
+        `#{ruby} #{req} -e '#{script}'`.split
+      end
+
+      def check_ancestors(db, ruby, requires, classname)
+        a = ancestors(ruby, requires, classname)
+        p a
+        begin
+          b = db.fetch_class(classname).ancestors.map(&:name)
+        rescue ClassNotFound => ex
+          $stderr.puts ex.backtrace
+          $stderr.puts "class not found in database : #{classname}"
+          b = []
+        end
+        unless a.to_set == b.to_set
+          puts "NG : #{classname}"
+          puts (a-b).map{|c| "+ #{c}" }.join("\n")
+          puts (b-a).map{|c| "- #{c}" }.join("\n")
+        else
+          puts "OK : #{classname}" if @verbose
+        end
+      end
+
+      def check_all_ancestors(db, ruby, requires)
+        classnames = []
+        requires.each do |lib|
+          classnames.push(*defined_classes(ruby, lib, []))
+        end
+        classnames.each do |classname|
+          check_ancestors(db, ruby, requires, classname)
+        end
+      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