ruby-debug-base 0.10.4-java → 0.10.5.rc1-java

data/Rakefile

@@ -1,174 +1,296 @@
-require 'rake'
+#!/usr/bin/env rake
+# -*- Ruby -*-
 require 'rubygems'
-require 'rake/clean'
-require 'rake/gempackagetask'
+require 'rubygems/package_task'
+require 'rdoc/task'
 require 'rake/testtask'
-require 'rake/rdoctask'
+require 'rake/extensiontask'
+require 'rake/javaextensiontask'
 
-GEM_NAME='ruby-debug-base'
-GEM_VERSION='0.10.4'
+$:.push File.expand_path("../lib", __FILE__)
+require "ruby-debug-base/version"
 
-RUBY_DEBUG_JAR='ext/ruby_debug.jar'
+SO_NAME = "ruby_debug.so"
+ROOT_DIR = File.dirname(__FILE__)
 
-CLEAN.include('ext')
-CLEAN.include('lib/ruby_debug.jar')
-
-DIST_FILES = FileList[
+# ------- Default Package ----------
+COMMON_FILES = FileList[
   'AUTHORS',
+  'CHANGES',
+  'LICENSE',
+  'README',
+  'Rakefile',
+]                        
+
+CLI_TEST_FILE_LIST = FileList['test/cli/commands/unit/*.rb',
+                              'test/cli/commands/*_test.rb', 
+                              'test/cli/**/*_test.rb', 
+                              'test/test-*.rb'] 
+CLI_FILES = COMMON_FILES + FileList[
+  "cli/**/*",
   'ChangeLog',
-  'lib/linecache.rb',
-  'lib/linecache-ruby.rb',
+  'bin/*',
+  'doc/rdebug.1',
+  'test/rdebug-save.1',
+  'test/**/data/*.cmd',
+  'test/**/data/*.right',
+  'test/**/example/*.rb',
+  'test/config.yaml',
+  'test/**/*.rb',
+  'rdbg.rb',
+   CLI_TEST_FILE_LIST
+]
+
+BASE_TEST_FILE_LIST = FileList['test/base/*.rb']
+
+BASE_FILES = COMMON_FILES + FileList[
+  'ext/breakpoint.c',
+  'ext/extconf.rb',
+  'ext/ruby_debug.c',
+  'ext/ruby_debug.h',
+  'ext/win32/*',
   'lib/ruby-debug-base.rb',
-  'lib/ruby_debug.jar',
-  'lib/tracelines.rb',
-  'MIT-LICENSE',
-  'Rakefile',
-  'README'
+  'lib/ruby-debug-base/version.rb',
+  BASE_TEST_FILE_LIST,
 ]
 
-BASE_TEST_FILE_LIST = %w(
-  test/base/base.rb
-  test/base/binding.rb 
-  test/base/catchpoint.rb)
+ext = File.join(ROOT_DIR, 'ext')
 
-task :default => :package
+desc "Test everything."
+Rake::TestTask.new(:test) do |t|
+  t.libs += %W(#{ROOT_DIR}/lib #{ROOT_DIR}/cli)
+  t.libs << ext if File.exist?(ext)
+  t.test_files = CLI_TEST_FILE_LIST
+  t.options = '--verbose' if $VERBOSE
+  t.ruby_opts << "--debug" if defined?(JRUBY_VERSION)
+end
 
-CLI_TEST_FILE_LIST = 'test/test-*.rb'
+task :test => :test_base if File.exist?(ext)
 
 desc "Test ruby-debug-base."
-task :test_base => :lib do
-  Rake::TestTask.new(:test_base) do |t|
-    t.libs << './ext'
-    t.libs << './lib'
-    t.test_files = FileList[BASE_TEST_FILE_LIST]
-    t.verbose = true
-  end
+Rake::TestTask.new(:test_base) do |t|
+  t.libs += ['./ext', './lib']
+  t.test_files = FileList[BASE_TEST_FILE_LIST]
+  t.options = '--verbose' if $VERBOSE
+  t.ruby_opts << "--debug" if defined?(JRUBY_VERSION)
 end
 
-desc "Test everything."
-task :test => :test_base do 
-  Rake::TestTask.new(:test) do |t|
-    t.libs << './ext'
-    t.libs << './lib'
-    t.libs << './cli'
-    t.pattern = CLI_TEST_FILE_LIST
-    t.verbose = true
-  end
+if defined?(JRUBY_VERSION)
+  task :test_base => 'jruby:compile:java'
+else
+  task :test_base => :compile
+end
+
+desc "Test everything - same as test."
+task :check => :test
+
+desc "Create a GNU-style ChangeLog via svn2cl"
+task :ChangeLog do
+  system('git log --pretty --numstat --summary     | git2cl >     ChangeLog')
+  system('git log --pretty --numstat --summary ext | git2cl > ext/ChangeLog')
+  system('git log --pretty --numstat --summary lib | git2cl > lib/ChangeLog')
 end
 
-desc "Helps to setup the project to be able to run tests"
-task :prepare_tests do
-  # needed to run CLI test. Unable to use svn:externals yet:
-  #   http://subversion.tigris.org/issues/show_bug.cgi?id=937
+# Base GEM Specification
+base_spec = Gem::Specification.new do |spec|
+  spec.name = "ruby-debug-base"
   
-  # rdbg.rb
-  sh "svn cat svn://rubyforge.org/var/svn/ruby-debug/tags/ruby-debug-#{GEM_VERSION}/rdbg.rb > rdbg.rb" unless File.exists?('rdbg.rb')
-
-  # runner.sh
-  runner = 'runner.sh'
-  sh "svn cat svn://rubyforge.org/var/svn/ruby-debug/tags/ruby-debug-#{GEM_VERSION}/runner.sh > #{runner}" unless File.exists?(runner)
-  text = File.read('runner.sh')
-  File.open(runner, 'w') {|f| f.write(text.gsub(/-ruby/ , '-jruby --debug'))}
-  File.chmod(0755, runner)
-
-  File.open('test/config.private.yaml', 'w') do |f|
-    f.write <<EOF
-# either should be on the $PATH or use full path
-ruby: jruby
-
-# possibility to specify interpreter parameters
-ruby_params: --debug
+  spec.homepage = "http://rubyforge.org/projects/ruby-debug/"
+  spec.summary = "Fast Ruby debugger - core component"
+  spec.description = <<-EOF
+ruby-debug is a fast implementation of the standard Ruby debugger debug.rb.
+It is implemented by utilizing a new Ruby C API hook. The core component 
+provides support that front-ends can build on. It provides breakpoint 
+handling, bindings for stack frames among other things.
 EOF
-  end
 
-  # - prepare default customized test/config.private.yaml suitable for JRuby
-  # - tweak test suite to be able to pass for jruby-debug-base which does not
-  #   support e.g. TraceLineNumbers yet.
-  sh "patch -p0 < patch-#{GEM_VERSION}.diff"
+  spec.version = Debugger::VERSION
+
+  spec.author = "Kent Sibilev"
+  spec.email = "ksibilev@yahoo.com"
+  spec.platform = Gem::Platform::RUBY
+  spec.require_path = "lib"
+  spec.extensions = ["ext/extconf.rb"]
+  spec.files = BASE_FILES.to_a  
+
+  spec.required_ruby_version = '>= 1.8.2'
+  spec.date = Time.now
+  spec.rubyforge_project = 'ruby-debug'
+  spec.add_dependency('linecache', '>= 0.3')
+  spec.add_development_dependency('rake-compiler')
+
+  spec.test_files = FileList[BASE_TEST_FILE_LIST]
+  
+  # rdoc
+  spec.has_rdoc = true
+  spec.extra_rdoc_files = ['README', 'ext/ruby_debug.c']
 end
 
-desc "Create the core ruby-debug shared library extension"
-task :lib do
-  compile_java
-  make_jar
+cli_spec = Gem::Specification.new do |spec|
+  spec.name = "ruby-debug"
+  
+  spec.homepage = "http://rubyforge.org/projects/ruby-debug/"
+  spec.summary = "Command line interface (CLI) for ruby-debug-base"
+  spec.description = <<-EOF
+A generic command line interface for ruby-debug.
+EOF
+
+  spec.version = Debugger::VERSION
+
+  spec.author = "Kent Sibilev"
+  spec.email = "ksibilev@yahoo.com"
+  spec.platform = Gem::Platform::RUBY
+  spec.require_path = "cli"
+  spec.bindir = "bin"
+  spec.executables = ["rdebug"]
+  spec.files = CLI_FILES.to_a
+
+  spec.required_ruby_version = '>= 1.8.2'
+  spec.date = Time.now
+  spec.rubyforge_project = 'ruby-debug'
+  spec.add_dependency('columnize', '>= 0.1')
+  spec.add_dependency('ruby-debug-base', "~> #{Debugger::VERSION}.0")
+  
+  # FIXME: work out operational logistics for this
+  # spec.test_files = FileList[CLI_TEST_FILE_LIST]
+
+  # rdoc
+  spec.has_rdoc = true
+  spec.extra_rdoc_files = ['README']
 end
 
-file RUBY_DEBUG_JAR => :lib
+# Rake task to build the default package
+Gem::PackageTask.new(base_spec) do |pkg|
+  pkg.need_tar = true
+end
+Gem::PackageTask.new(cli_spec) do |pkg|
+  pkg.need_tar = true
+end
 
-spec = Gem::Specification.new do |s|
-  s.platform = "java"
-  s.summary  = "Java implementation of Fast Ruby Debugger"
-  s.name     = GEM_NAME
-  s.version  = GEM_VERSION
-  s.require_path = 'lib'
-  s.files    = DIST_FILES
-  s.description = <<-EOF
-Java extension to make fast ruby debugger run on JRuby.
-It is the same what ruby-debug-base is for native Ruby.
-EOF
-  s.author   = 'debug-commons team'
-  s.homepage = 'http://rubyforge.org/projects/debug-commons/'
-  s.has_rdoc = true
-  s.rubyforge_project = 'debug-commons'
+Rake::ExtensionTask.new('ruby_debug', base_spec) do |t|
+  t.ext_dir = "ext"
 end
 
-gem_name = "#{GEM_NAME}-#{GEM_VERSION}-#{spec.platform}.gem"
+task :default => :test
+
+# Windows specification
+win_spec = base_spec.clone
+win_spec.extensions = []
+## win_spec.platform = Gem::Platform::WIN32 # deprecated
+win_spec.platform = 'mswin32'
+win_spec.files += ["lib/#{SO_NAME}"]
 
-desc "Build the gem file #{gem_name}"
-task :gem => :lib do
-  gem_task = Rake::GemPackageTask.new(spec)
+desc "Create Windows Gem"
+task :win32_gem do
+  # Copy the win32 extension the top level directory
   current_dir = File.expand_path(File.dirname(__FILE__))
-  source = File.join(current_dir, RUBY_DEBUG_JAR)
-  target = File.join(current_dir, "lib", "ruby_debug.jar")
+  source = File.join(current_dir, "ext", "win32", SO_NAME)
+  target = File.join(current_dir, "lib", SO_NAME)
   cp(source, target)
-  # Create the gem, then move it to pkg.
-  Gem::Builder.new(spec).build
-  gem_file = "#{spec.name}-#{spec.version}-#{spec.platform}.gem"
-  mv(gem_task.gem_file, "pkg/#{gem_task.gem_file}")
-  # Delete the temporary target
-  rm target
-end
 
-desc 'Build all the packages'
-task :package => :gem
+  # Create the gem, then move it to pkg.
+  Gem::Builder.new(win_spec).build
+  gem_file = "#{win_spec.name}-#{win_spec.version}-#{win_spec.platform}.gem"
+  mv(gem_file, "pkg/#{gem_file}")
 
-Rake::RDocTask.new do |t|
-  t.main = 'README'
-  t.rdoc_files.include 'README'
+  # Remove win extension from top level directory.
+  rm(target)
 end
 
+desc "Publish ruby-debug to RubyForge."
+task :publish do 
+  require 'rake/contrib/sshpublisher'
+  
+  # Get ruby-debug path.
+  ruby_debug_path = File.expand_path(File.dirname(__FILE__))
 
-desc "Create a GNU-style ChangeLog via svn2cl"
-task :ChangeLog do
-  system("svn2cl --authors=svn2cl_usermap svn://rubyforge.org/var/svn/debug-commons/jruby-debug/trunk")
+  Rake::SshDirPublisher.new("kent@rubyforge.org",
+        "/var/www/gforge-projects/ruby-debug", ruby_debug_path)
 end
 
-# Builds classpath containing needed JRuby's jars (like jruby.jar).
-def jruby_classpath
-  begin
-    require 'java'
-    classpath = java.lang.System.getProperty('java.class.path')
-  rescue LoadError
+desc "Remove built files"
+task :clean do
+  cd "ext" do
+    if File.exists?("Makefile")
+      sh "make clean"
+      rm  "Makefile"
+    end
+    derived_files = Dir.glob(".o") + Dir.glob("*.so")
+    rm derived_files unless derived_files.empty?
   end
+  rm 'lib/ruby_debug.jar' if File.exists?("lib/ruby_debug.jar")
+end
 
-  unless classpath
-    classpath = FileList["#{ENV['JRUBY_HOME']}/lib/*.jar"].join(File::PATH_SEPARATOR)
-  end
+# ---------  RDoc Documentation ------
+desc "Generate rdoc documentation"
+RDoc::Task.new("rdoc") do |rdoc|
+  rdoc.rdoc_dir = 'doc/rdoc'
+  rdoc.title    = "ruby-debug"
+  # Show source inline with line numbers
+  rdoc.options << "--inline-source" << "--line-numbers"
+  # Make the readme file the start page for the generated html
+  rdoc.options << '--main' << 'README'
+  rdoc.rdoc_files.include('bin/**/*',
+                          'cli/ruby-debug/commands/*.rb',
+                          'cli/ruby-debug/*.rb',
+                          'lib/**/*.rb',
+                          'ext/**/ruby_debug.c',
+                          'README',
+                          'LICENSE')
+end
 
-  classpath ? "-cp #{classpath}" : ""
+desc "Publish the release files to RubyForge."
+task :rubyforge_upload do
+  `rubyforge login`
+  release_command = "rubyforge add_release #{PKG_NAME} #{PKG_NAME} '#{PKG_NAME}-#{PKG_VERSION}' pkg/#{PKG_NAME}-#{PKG_VERSION}.gem"
+  puts release_command
+  system(release_command)
 end
 
-# Compiles Java classes into the pkg/classes directory.
-def compile_java
-  mkdir_p "pkg/classes"
-  sh "javac -Xlint -Xlint:-serial -g -target 1.5 -source 1.5 -d pkg/classes #{jruby_classpath} #{FileList['src/**/*.java'].join(' ')}"
+PKG_NAME      = 'ruby-debug'
+desc "Publish the release files to RubyForge."
+task :rubyforge_upload do
+  `rubyforge login`
+  for pkg_name in ['ruby-debug', 'ruby-debug-base'] do
+    pkg_file_name = "#{pkg_name}-#{pkg_version}"
+    release_command = "rubyforge add_release ruby-debug #{pkg_name} '#{pkg_file_name}' pkg/#{pkg_file_name}.gem"
+    puts release_command
+    system(release_command)
+  end
 end
 
-def make_jar
-  require 'fileutils'
-  ext = File.join(File.dirname(__FILE__), 'ext')
-  FileUtils.mkdir_p(ext)
-  separator = File::ALT_SEPARATOR || File::SEPARATOR
-  sh "jar cf #{RUBY_DEBUG_JAR} -C pkg#{separator}classes ."
+def install_gem(spec, *opts)
+  args = ['gem', 'install', "pkg/#{spec.name}-#{spec.version}.gem"] + opts
+  args.unshift 'sudo' unless 0 == Process.uid || ENV['rvm_path']
+  system(*args)
 end
 
+desc 'Install locally'
+task :install => :package do
+  Dir.chdir(File::dirname(__FILE__)) do
+    # ri and rdoc take lots of time
+    install_gem(base_spec, '--no-ri', '--no-rdoc')
+    install_gem(cli_spec, '--no-ri', '--no-rdoc')
+  end
+end    
+
+task :install_full => :package do
+  Dir.chdir(File::dirname(__FILE__)) do
+    install_gem(base_spec)
+    install_gem(cli_spec)
+  end
+end    
+
+namespace :jruby do
+  jruby_spec = base_spec.clone
+  jruby_spec.platform   = "java"
+  jruby_spec.files      = jruby_spec.files.reject {|f| f =~ /^ext/ }
+  jruby_spec.files     += ['lib/ruby_debug.jar']
+  jruby_spec.extensions = []
+
+  Gem::PackageTask.new(jruby_spec) {}
+
+  Rake::JavaExtensionTask.new('ruby_debug') do |t|
+    t.ext_dir = "src"
+  end
+end

data/ext/extconf.rb

@@ -0,0 +1,23 @@
+require "mkmf"
+
+if RUBY_VERSION >= "1.9"
+  STDERR.print("Ruby version #{RUBY_VERSION} is too new\n")
+  exit(1)
+elsif RUBY_VERSION >= "1.8"
+  if RUBY_RELEASE_DATE < "2005-03-22"
+    STDERR.print("Ruby release date #{RUBY_RELEASE_DATE} is too old\n")
+    exit(1)
+  end
+else
+  STDERR.print("Ruby version is not compatible for this version.\n")
+  exit(1)
+end
+
+# Allow use customization of compile options. For example, the
+# following lines could be put in config_options to to turn off
+# optimization:
+#   $CFLAGS='-fPIC -fno-strict-aliasing -g3 -ggdb -O2 -fPIC'
+config_file = File.join(File.dirname(__FILE__), 'config_options.rb')
+load config_file if File.exist?(config_file)
+
+create_makefile("ruby_debug")