ruby-debug-completion 0.1.0

data/.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require 'rubygems' unless Object.const_defined?(:Gem)
+require File.dirname(__FILE__) + "/lib/ruby-debug/completion"
+ 
+Gem::Specification.new do |s|
+  s.name        = "ruby-debug-completion"
+  s.version     = Debugger::Completion::VERSION
+  s.authors     = ["Gabriel Horner"]
+  s.email       = "gabriel.horner@gmail.com"
+  s.homepage    = "http://github.com/cldwalker/ruby-debug-completion"
+  s.summary = "Mission: autocomplete ruby-debug"
+  s.description =  "Provides ruby-debug command and subcommand completion with a completion system more powerful than irb's, compliments of bond."
+  s.required_rubygems_version = ">= 1.3.6"
+  s.rubyforge_project = 'tagaholic'
+  s.add_dependency 'bond', '>= 0.2.2'
+  s.files = Dir.glob(%w[{lib,test}/**/*.rb bin/* [A-Z]*.{txt,rdoc} ext/**/*.{rb,c} **/deps.rip]) + %w{Rakefile .gemspec}
+  s.extra_rdoc_files = ["README.rdoc", "LICENSE.txt"]
+  s.license = 'MIT'
+end

data/CHANGELOG.rdoc

@@ -0,0 +1,2 @@
+== 0.1.0
+** Initial release!

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT LICENSE
+
+Copyright (c) 2010 Gabriel Horner
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,107 @@
+== Description
+
+Provides ruby-debug command and subcommand completion with a completion system
+more powerful than irb's, compliments of {bond}[http://github.com/cldwalker/bond].
+
+== Install
+
+Install the gem with:
+
+    sudo gem install ruby-debug-completion
+
+== Setup
+
+Add this after your `require 'ruby-debug'` line:
+
+    require 'ruby-debug/completion'
+
+Or if you like to debug with one-liners:
+
+    require 'ruby-debug/completion'; debugger
+
+Or if using rdebug:
+
+    rdebug -r ruby-debug/completion FILE
+
+== Usage
+
+In a ruby program gone far far astray:
+
+    (rdb:1) [TAB]
+    backtrace  delete     enable     help       next       quit       show       trace
+    break      disable    eval       info       p          reload     source     undisplay
+    catch      display    exit       irb        pp         restart    step       up
+    condition  down       finish     list       ps         save       thread     var
+    continue   edit       frame      method     putl       set        tmate      where
+
+Note: This default completion also autocompletes instance variables and local variables in the
+current debugger binding.
+
+What info does ruby-debug provide?
+
+    (rdb:1) info [TAB]
+    args                display             global_variables    locals              thread
+    breakpoints         file                instance_variables  program             threads
+    catch               files               line                stack               variables
+ 
+    (rdb: 1) info d[TAB]
+    (rdb: 1) info display
+
+What settings can I change?
+
+    (rdb:1) set [TAB]
+    annotate             autolist             forcestep            linetrace            width
+    args                 basename             fullpath             linetrace+           
+    autoeval             callstyle            history              listsize             
+    autoirb              debuggertesting      keep-frame-bindings  trace                
+
+    (rdb:1) set d[TAB]
+    (rdb:1) set debuggertesting
+
+Since I have autoeval on, can I autocomplete as if I were in irb?
+
+    (rdb:1) com[TAB]
+    (rdb:1) completion_toggle
+
+    (rdb:1) [TAB]
+    Display all 347 possibilities? (y or n)
+
+    (rdb:1) De[TAB]
+    (rdb:1) Debugger
+    (rdb:1) Debugger.[TAB]
+    Display all 137 possibilities? (y or n)
+
+    (rdb:1) require 'ab[TAB]
+    (rdb:1) require 'abbrev.rb'
+
+Huh? Argument autocompletion?
+See {bond}[http://github.com/cldwalker/bond] for all that you can autocomplete.
+
+Can I go back to basic ruby-debug completion?
+
+    # Invoke completion_toggle again
+    (rdb:1)  ct     # alias for completion_toggle
+    (rdb:1) [TAB]
+    backtrace  delete     enable     help       next       quit       show       trace
+    break      disable    eval       info       p          reload     source     undisplay
+    catch      display    exit       irb        pp         restart    step       up
+    condition  down       finish     list       ps         save       thread     var
+    continue   edit       frame      method     putl       set        tmate      where
+
+Please, can I just quit quickly without a prompt?
+
+    (rdb:1) q [TAB]
+    (rdb:1) q unconditionally
+
+== Limitations
+
+This gem doesn't have ruby-debug as a dependency since ruby-debug is split across two gems
+(ruby-debug and ruby-debug19), dependent on ruby versions. This gem will work with either one.
+
+== Todo
+
+* Completion of local variable methods
+
+== Bugs/Issues
+
+Please report them {on github}[http://github.com/cldwalker/ruby-debug-completion/issues].

data/Rakefile

@@ -0,0 +1,35 @@
+require 'rake'
+require 'fileutils'
+
+def gemspec
+  @gemspec ||= eval(File.read('.gemspec'), binding, '.gemspec')
+end
+
+desc "Build the gem"
+task :gem=>:gemspec do
+  sh "gem build .gemspec"
+  FileUtils.mkdir_p 'pkg'
+  FileUtils.mv "#{gemspec.name}-#{gemspec.version}.gem", 'pkg'
+end
+
+desc "Install the gem locally"
+task :install => :gem do
+  sh %{gem install pkg/#{gemspec.name}-#{gemspec.version}}
+end
+
+desc "Generate the gemspec"
+task :generate do
+  puts gemspec.to_ruby
+end
+
+desc "Validate the gemspec"
+task :gemspec do
+  gemspec.validate
+end
+
+desc 'Run tests'
+task :test do |t|
+  sh 'bacon -q -Ilib -I. test/*_test.rb'
+end
+
+task :default => :test

data/deps.rip

@@ -0,0 +1 @@
+bond >=0.2.2

data/lib/ruby-debug/completion.rb

@@ -0,0 +1,76 @@
+require 'ruby-debug'
+require 'bond'
+
+module Debugger
+  module Completion
+    extend self
+    VERSION = '0.1.0'
+    COMMANDS = [ "backtrace", "break", "catch", "condition", "continue",
+      "delete", "disable", "display", "down", "edit", "enable", "eval", "exit",
+        "finish", "frame", "help", "info", "irb", "list", "method", "next",
+        "p", "pp", "ps", "putl", "quit", "reload", "restart", "save", "set",
+        "show", "source", "step", "thread", "tmate", "trace", "undisplay",
+        "up", "var", "where"
+    ]
+    COMMANDS << ['jump'] if RUBY_VERSION >= '1.9'
+
+    def start
+      Bond.start(:default_mission=>lambda {|e| Debugger::Completion.default_action }) do
+        complete(:methods=>%w{catch cat}) { objects_of(Class).select {|e| e < StandardError } }
+        complete(:methods=>%w{disable enable}) { %w{breakpoints display} }
+        complete(:methods=>['help', 'h']) { Debugger::Completion.commands }
+        complete(:method=>'info') { %w{args breakpoints catch display file files} +
+          %w{global_variables instance_variables line locals program stack thread} +
+          %w{threads variables}
+        }
+        complete(:methods=>%w{set show}) { %w{annotate args autoeval autolist autoirb} +
+          %w{basename callstyle debuggertesting forcestep fullpath history} +
+          %w{keep-frame-bindings linetrace+ linetrace listsize trace width}
+        }
+        complete(:methods=>%w{quit exit q}) { %w{unconditionally} }
+        complete(:methods=>%w{save source}, :action=>:files)
+        complete(:methods=>%w{thread th}) { %w{list stop resume switch current} }
+        complete(:methods=>%w{trace tr}) { %w{on off var} }
+        complete(:methods=>%w{var v}) { %w{class const global instance local} }
+      end
+    end
+
+    def commands; COMMANDS; end
+
+    def default_action
+      completions = commands + ['completion_toggle']
+      if @irb_completion
+        eval_string = "methods | private_methods | local_variables | " +
+          "self.class.constants | instance_variables"
+        completions += debugger_eval(eval_string) | Object.constants |
+          Bond::DefaultMission::ReservedWords
+      else
+        completions += debugger_eval("local_variables | instance_variables")
+      end
+      completions
+    end
+
+    def debugger_eval(string)
+      bdg = (cmd = first_object(Debugger::Command)) ? cmd.send(:get_binding) : TOPLEVEL_BINDING
+      eval string, bdg
+    end
+
+    def first_object(klass)
+      ObjectSpace.each_object(klass) {|e| return e }
+    end
+
+    def toggle_irb_completion
+      @irb_completion = !@irb_completion
+    end
+
+    module Command
+      def completion_toggle
+        Completion.toggle_irb_completion
+      end
+      alias_method :ct, :completion_toggle
+    end
+  end
+end
+
+Object.send :include, Debugger::Completion::Command
+Debugger::Completion.start

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification 
+name: ruby-debug-completion
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Gabriel Horner
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-20 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bond
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 0
+        - 2
+        - 2
+        version: 0.2.2
+  type: :runtime
+  version_requirements: *id001
+description: Provides ruby-debug command and subcommand completion with a completion system more powerful than irb's, compliments of bond.
+email: gabriel.horner@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- LICENSE.txt
+files: 
+- lib/ruby-debug/completion.rb
+- LICENSE.txt
+- CHANGELOG.rdoc
+- README.rdoc
+- deps.rip
+- Rakefile
+- .gemspec
+has_rdoc: true
+homepage: http://github.com/cldwalker/ruby-debug-completion
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 23
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: tagaholic
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: "Mission: autocomplete ruby-debug"
+test_files: []
+