debugger 1.0.0.rc1 → 1.0.0.rc2

data/.travis.yml

@@ -0,0 +1,4 @@
+before_install: bundle init --gemspec=debugger.gemspec
+before_script: rake compile
+rvm:
+- 1.9.3

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+## 1.0.0.rc2
+* Avoid downloading of ruby source by using debugger-ruby_core_source
+* Fix LocalJumpError caused by using proc in extconf.rb
+* Tests up on CI
+* Rake tasks updated
+
+## 1.0.0.rc1
+* Initial test release with working 1.9.3

data/README.md

@@ -1,10 +1,68 @@
 ## Description
-A fork of ruby-debug19 that works on 1.9.3 and installs easily.
+A fork of ruby-debug19 that works on 1.9.3 and installs easily for rvm/rbenv rubies. 1.9.2 support
+coming...
+
+[![Build Status](https://secure.travis-ci.org/cldwalker/debugger.png?branch=master)](http://travis-ci.org/cldwalker/log_buddy)
+
+## Install
+
+    $ gem install debugger
+
+    # If install fails, try passing headers path
+    $ gem install debugger -- --with-ruby-include=PATH_TO_HEADERS
+
+For Windows install instructions, see OLD\_README.
 
 ## Usage
 
+To use in your Rails app, drop in your Gemfile:
+
+    gem 'debugger'
+
+Wherever you need a debugger, simply:
 ```ruby
 require 'debugger'; debugger
 ```
 
-TODO
+## Reason for Fork
+
+* ruby-debug19 maintainer isn't maintaining:
+  * Despite patches from ruby core, no gem release in 2+ years! - 9/1/09.
+  * Requests to release a known working 1.9.3 version have been ignored.
+  * Doesn't respond to rubyforge issues and doesn't have github issues open.
+* Current install is painful. Requires either [manually downloading gems from rubyforge](
+  http://blog.wyeworks.com/2011/11/1/ruby-1-9-3-and-ruby-debug) and installing with compiler flags
+  or [recompiling
+  ruby](http://blog.sj26.com/post/12146951658/updated-using-ruby-debug-on-ruby-1-9-3-p0).
+* We need a decent ruby debugger for future rubies!
+
+## What's different from ruby-debug19
+
+* Works on 1.9.3 but not 1.9.2 yet
+* Install painlessly for rvm and rbenv rubies i.e. no compiler flags needed
+* Tests are up on travis-ci
+* The gem name matches the module namespace, Debugger, and main required file, debugger.
+* Rake tasks have been updated
+* ruby-debug-base19 and ruby-debug19 are released as one gem
+* No downloading ruby source during install - was behavior of old ruby_core_source dependency
+* Fix LocalJumpError caused by using proc in extconf.rb
+
+## Issues
+Please report them [on github](http://github.com/cldwalker/debugger/issues).
+
+## Contributing
+[See here](http://tagaholic.me/contributing.html) for contribution policies.
+Let's keep this working for the ruby community!
+
+## Credits
+
+* Thanks to the original authors: Kent Sibilev and Mark Moseley
+* Fork started on awesome @relevance fridays!
+
+## TODO
+
+* Add back support for 1.9.2
+  * Doing something stupid simple i.e. copy latest ruby-debug19 that works and require as needed
+* Fix test/test-*.rb
+* Work with others willing to tackle jruby, rubinius or windows support
+* Clean up (merge) lib + cli as separate runtime paths for ruby-debug-base19 and ruby-debug19

data/Rakefile

@@ -1,8 +1,5 @@
-#!/usr/bin/env rake
 # -*- Ruby -*-
-require 'rubygems'
-require 'rake/gempackagetask'
-require 'rake/rdoctask'
+require 'rubygems/package_task'
 require 'rake/testtask'
 require 'rake/extensiontask'
 
@@ -11,7 +8,7 @@ Rake::ExtensionTask.new('ruby_debug')
 SO_NAME = "ruby_debug.so"
 
 # ------- Default Package ----------
-RUBY_DEBUG_VERSION = open("ext/ruby_debug/ruby_debug.c") do |f| 
+RUBY_DEBUG_VERSION = open("ext/ruby_debug/ruby_debug.c") do |f|
   f.grep(/^#define DEBUG_VERSION/).first[/"(.+)"/,1]
 end
 
@@ -24,12 +21,13 @@ COMMON_FILES = FileList[
   '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'] 
+                              'test/cli/commands/*_test.rb',
+                              'test/cli/**/*_test.rb']
+                              # disabled until requires fixed and tests pass
+                              # 'test/test-*.rb']
 CLI_FILES = COMMON_FILES + FileList[
   "cli/**/*",
   'ChangeLog',
@@ -43,8 +41,8 @@ CLI_FILES = COMMON_FILES + FileList[
 ]
 
 BASE_TEST_FILE_LIST = %w(
-  test/base/base.rb 
-  test/base/binding.rb 
+  test/base/base.rb
+  test/base/binding.rb
   test/base/catchpoint.rb)
 BASE_FILES = COMMON_FILES + FileList[
   'ext/ruby_debug/breakpoint.c',
@@ -57,7 +55,7 @@ BASE_FILES = COMMON_FILES + FileList[
 ]
 
 desc "Test everything."
-task :test => :test_base do 
+task :test => :test_base do
   Rake::TestTask.new(:test) do |t|
     t.libs << './ext'
     t.libs << './lib'
@@ -68,7 +66,7 @@ task :test => :test_base do
 end
 
 desc "Test ruby-debug-base."
-task :test_base => :lib do 
+task :test_base => :lib do
   Rake::TestTask.new(:test_base) do |t|
     t.libs << './ext'
     t.libs << './lib'
@@ -95,92 +93,12 @@ file "emacs/rdebug.elc" => ["emacs/elisp-comp", "emacs/rdebug.el"] do
   end
 end
 
-desc "Create a GNU-style ChangeLog via svn2cl"
-task :ChangeLog do
-  system("svn2cl --authors=svn2cl_usermap svn://rubyforge.org/var/svn/ruby-debug/trunk")
-  system("svn2cl --authors=svn2cl_usermap svn://rubyforge.org/var/svn/ruby-debug/trunk/ext -o ext/ChangeLog")
-  system("svn2cl --authors=svn2cl_usermap svn://rubyforge.org/var/svn/ruby-debug/trunk/lib -o lib/ChangeLog")
-end
-
-# Base GEM Specification
-base_spec = Gem::Specification.new do |spec|
-  spec.name = "ruby-debug-base19"
-  
-  spec.homepage = "http://rubyforge.org/projects/ruby-debug19/"
-  spec.summary = "Fast Ruby debugger - core component"
-  spec.description = <<-EOF
-ruby-debug-base19 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
-
-  spec.version = RUBY_DEBUG_VERSION + RUBY_DEBUG_BASE_TEENY
-
-  spec.authors = ["Kent Sibilev", "Mark Moseley"]
-  spec.email = "mark@fast-software.com"
-  spec.platform = Gem::Platform::RUBY
-  spec.require_path = "lib"
-  spec.extensions = ["ext/ruby_debug/extconf.rb"]
-  spec.files = BASE_FILES.to_a  
-
-  spec.required_ruby_version = '>= 1.8.2'
-  spec.date = Time.now
-  spec.rubyforge_project = 'ruby-debug19'
-  spec.add_dependency('ruby_core_source', '>= 0.1.4')
-  spec.add_dependency('linecache19', '>= 0.5.11')
-  
-  spec.test_files = FileList[BASE_TEST_FILE_LIST]
-  
-  # rdoc
-  spec.has_rdoc = true
-  spec.extra_rdoc_files = ['README', 'ext/ruby_debug/ruby_debug.c']
-end
-
-cli_spec = Gem::Specification.new do |spec|
-  spec.name = "ruby-debug19"
-  
-  spec.homepage = "http://rubyforge.org/projects/ruby-debug19/"
-  spec.summary = "Command line interface (CLI) for ruby-debug-base19"
-  spec.description = <<-EOF
-A generic command line interface for ruby-debug.
-EOF
-
-  spec.version = RUBY_DEBUG_VERSION + RUBY_DEBUG_TEENY
-
-  spec.authors = ["Kent Sibilev", "Mark Moseley"]
-  spec.email = "mark@fast-software.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.3.1')
-  spec.add_dependency('linecache19', '>= 0.5.11')
-  spec.add_dependency('ruby-debug-base19', '>= 0.12.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
-
+base_spec = eval(File.read('debugger.gemspec'), binding, 'debugger.gemspec')
 # Rake task to build the default package
-Rake::GemPackageTask.new(base_spec) do |pkg|
-  pkg.need_tar = true
-end
-Rake::GemPackageTask.new(cli_spec) do |pkg|
+Gem::PackageTask.new(base_spec) do |pkg|
   pkg.need_tar = true
 end
 
-task :default => [:package]
-
 # Windows specification
 win_spec = base_spec.clone
 win_spec.extensions = []
@@ -205,17 +123,6 @@ task :win32_gem do
   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__))
-
-  Rake::SshDirPublisher.new("kent@rubyforge.org",
-        "/var/www/gforge-projects/ruby-debug", ruby_debug_path)
-end
-
 desc "Remove built files"
 task :clean do
   cd "ext" do
@@ -228,39 +135,4 @@ task :clean do
   end
 end
 
-# ---------  RDoc Documentation ------
-desc "Generate rdoc documentation"
-Rake::RDocTask.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',
-                          'lib/**/*.rb',
-                          'ext/**/ruby_debug.c',
-                          'README',
-                          'LICENSE')
-end
-
-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
-
-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
+task :default => :test

data/debugger.gemspec

@@ -18,7 +18,10 @@ handling, bindings for stack frames among other things.
   s.extra_rdoc_files = [ "README.md" ]
   s.files = `git ls-files`.split("\n")
   s.extensions << "ext/ruby_debug/extconf.rb"
-  s.add_dependency("columnize", ">= 0.3.1")
-  s.add_dependency("ruby_core_source", ">= 0.1.5")
+  s.executables = ["rdebug"]
+  s.add_dependency "columnize", ">= 0.3.1"
+  s.add_dependency "debugger-ruby_core_source"
   s.add_dependency "debugger-linecache"
+  s.add_development_dependency 'rake', '~> 0.9.2.2'
+  s.add_development_dependency 'rake-compiler', '~> 0.8.0'
 end

data/ext/ruby_debug/extconf.rb

@@ -16,17 +16,17 @@ if RUBY_VERSION < "1.9"
   exit(1)
 end
 
-hdrs = proc {
+hdrs = lambda {
   iseqs = %w[vm_core.h iseq.h]
   begin
     have_struct_member("rb_method_entry_t", "called_id", "method.h") or
     have_struct_member("rb_control_frame_t", "method_id", "method.h")
   end and
   have_header("vm_core.h") and have_header("iseq.h") and have_header("insns.inc") and
-  have_header("insns_info.inc") and have_header("eval_intern.h") or break
+  have_header("insns_info.inc") and have_header("eval_intern.h") or return(false)
   have_type("struct iseq_line_info_entry", iseqs) or
   have_type("struct iseq_insn_info_entry", iseqs) or
-  break
+  return(false)
   if checking_for(checking_message("if rb_iseq_compile_with_option was added an argument filepath")) do
       try_compile(<<SRC)
 #include <ruby.h>
@@ -42,8 +42,8 @@ dir_config("ruby")
 if !Ruby_core_source::create_makefile_with_core(hdrs, "ruby_debug")
   STDERR.print("Makefile creation failed\n")
   STDERR.print("*************************************************************\n\n")
-  STDERR.print("  NOTE: For Ruby 1.9 installation instructions, please see:\n\n")
-  STDERR.print("     http://wiki.github.com/mark-moseley/ruby-debug\n\n")
+  STDERR.print("  NOTE: If your headers were not found, try passing\n")
+  STDERR.print("        --with-ruby-include=PATH_TO_HEADERS      \n\n")
   STDERR.print("*************************************************************\n\n")
   exit(1)
 end

data/lib/debugger/version.rb

@@ -1,3 +1,5 @@
 module Debugger
-  VERSION = '1.0.0.rc1'
+  # TODO: remove version from C ext
+  send :remove_const, :VERSION if const_defined? :VERSION
+  VERSION = '1.0.0.rc2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: debugger
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc1
+  version: 1.0.0.rc2
   prerelease: 6
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-30 00:00:00.000000000 Z
+date: 2012-04-04 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: columnize
@@ -30,13 +30,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.3.1
 - !ruby/object:Gem::Dependency
-  name: ruby_core_source
+  name: debugger-ruby_core_source
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.1.5
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -44,7 +44,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.1.5
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: debugger-linecache
   requirement: !ruby/object:Gem::Requirement
@@ -61,6 +61,38 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2.2
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.0
 description: ! 'debugger 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
@@ -71,18 +103,20 @@ description: ! 'debugger is a fast implementation of the standard Ruby debugger
 
 '
 email: gabriel.horner@gmail.com
-executables: []
+executables:
+- rdebug
 extensions:
 - ext/ruby_debug/extconf.rb
 extra_rdoc_files:
 - README.md
 files:
+- .travis.yml
 - AUTHORS
-- CHANGES
-- ChangeLog
-- INSTALL.SVN
+- CHANGELOG.md
 - LICENSE
 - Makefile.am
+- OLDER_CHANGELOG
+- OLD_CHANGELOG
 - OLD_README
 - README.md
 - Rakefile

data/INSTALL.SVN

@@ -1,154 +0,0 @@
-Building and Installing ruby-debug from rubyforge's Subversion Repository (svn)
-
-The below are Unix-centric instructions. If you have Microsoft Windows see 
-the section on building Microsoft Windows.
-
-
-0. Prerequisites: To build the package you'll need at a minimum:
-
- - Ruby (of course). Currently only version 1.8.6 and above but not 
-   version 1.9.x work.
- - Ruby development headers. This typically includes a file called "ruby.h"
- - A C compiler like GNU C (gcc)
- - Rake
- - Subversion (svn)
-
-If you want to build the documentation and install Emacs files, you'll
-also need:
-
- - a POSIX shell
- - autoconf
- - automake
- - GNU Make
- - texinfo
-
-1. Basic package checkout and installation 
-
-Check out the trunk of repository following the instructions at 
-http://rubyforge.org/scm/?group_id=1900  For example on a Unixy system,
-this may work:
-
-  mkdir ruby-debug
-  cd ruby-debug
-  svn checkout svn://rubyforge.org/var/svn/ruby-debug/trunk trunk
-
-In order to make the Ruby gems, ruby-debug and ruby-debug-base, get
-yourself into the trunk directory after the code has been checked out and run:
-
-  cd trunk # This is the same trunk checked out above.
-  rake package
-
-If all goes well you should have some gem files put in the directory
-pkg. Use the gem command to install that. 
-
-  sudo gem install ruby-debug-*.gem   # See gem help for other possibilities
-
-If all goes well the rdebug script has been installed ruby-debug is
-now ready to run. But if everything goes well you might want to run
-the built-in regression tests to make sure everything is okay.
-See step 3 below.
-
-If the gem install didn't work,'t there may be a problem with your C
-compiler or the Ruby headers are not installed.
-
-2. Trying out without installing. 
-
-You don't have to build a gem file to try out ruby debug. In fact when
-developing new features for ruby-debug, developers often you want to
-try it out *before* installing.  If you have a problem in the latter
-part of step 1 you may want to try this approach since we go into a
-little more detail as to what happens under the covers when you do the
-gem install.
-
-Run (from trunk)
-  rake lib
-
-This creates a Makefile and builds the ruby-debug shared library. (On
-Unix the name is ruby_debug.so).
-
-Once this is done you can run the debugger as you would rdebug using the
-script rdbg.rb. For example (again from trunk)
-
-  ./rdbg.rb ~/my-ruby-program.rb
-
-3. Running the Regression tests
-  
-We've put together some basic tests to make sure ruby-debug is doing
-what we think it should do. To run these (from trunk):
-
-  rake test
-
-If you didn't build the ruby-debug shared library and skipped step 2,
-don't worry "rake test" will do step 2 for you. You should see a line that
-ends something like:
-
-  Finished in 2.767579 seconds.
-
-  12 tests, 35 assertions, 0 failures, 0 errors
-
-The number of seconds, tests, and assertions may be different from the
-above. However you *should* see exactly "0 failures, 0 errors".
-
-4. Building the documentation and testing/installing Emacs files
-
-Of course, I recommend you read the ruby-debug manual that comes with
-the package. If you have the prerequisites described above, run this
-once:
-  sh ./autogen.sh
-
-Then run:
-  ./configure
-  make
-  make test           # Runs Emacs regression tests
-  sudo make install   # Or arrange to do this as root
- 
-
-Microsoft Windows
-
-A problem here seems to be that the "One-click" install is compiled
-using Microsoft Visual Studio C 6 which is not sold anymore and is
-rather old. 
-
-Instead I suggest building via mingw/msys. 
-http://eigenclass.org/hiki.rb?cmd=view&p=cross+compiling+rcovrt&key=mingw has instructions on how to do. Some amendments to these instructions. 
-
-First, those instructions are a little GNU/Linux centric. If you are
-using Ubuntu or Debian, then this should be the easiest to follow the
-instructions. On Ubuntu or Debian there is a mingw3 Debian
-package. Installing that will give you the cross compiler that is a
-prerequisite. Alternatively if you are running MS Windows I notice
-that cygwin also has a mingw package. Or possibly you could use MinGW
-directly. For other OS's you might have to build a cross-compiler,
-i.e. gcc which emits win32 code and can create a win32 DLL.
-
-After you have a cross compiler you need to download the Ruby source
-and basically build a ruby interpreter. The cross-compile.sh script
-works although when I downloaded it, it had lots of blank space at the
-beginning which will mess up the Unix magic interpretation. That is
-remove the blanks in front of "#/bin/sh"
-
-On my system, this script fails in running "make ruby" because the
-fake.rb that got created needed to have a small change:
-
-	    ALT_SEPARATOR = "\"; \
-should be 
-	    ALT_SEPARATOR = "\\"; \
-
-After fixing this, run 
-  make ruby
-Also, I needed to run
-  make rubyw
-
-And then "make install" as indicated. 
-
-Once all of that's in place, the place you want be is in
-ruby-debug/trunk/ext/win32, not ruby-debug/ext. 
-
-So let's say you've installed the cross-compiled install ruby in
-/usr/local/ruby-mingw32/. Here then are the commands to build ruby-debug-base-xxx-mswin32.gem
-
-   cd .../ruby-debug/trunk/ext/win32 
-   ruby -I /usr/local/ruby-mingw32/lib/ruby/1.8/i386-mingw32 ../extconf.rb
-   make # Not rake
-   cd ../..   # back in ruby-debug/trunk
-   rake win32_gem