debugger-completion 1.0.0

data/.gemspec

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

data/CHANGELOG.md

@@ -0,0 +1,18 @@
+## 1.0.0
+* Renamed gem to debugger-completion
+* Only to be used on debugger (and thus 1.9)
+* Dropped support for ruby-debug
+
+## 0.2.1
+** Ensure clean completion setup with Bond.restart
+** Play nicely with Bond completion in ruby consoles
+
+## 0.2.0
+** Autocomplete local and instance variable methods
+** Ensure completions are based on current binding
+
+## 0.1.1
+** Rescue unexpected errors from Debugger::Command#get_binding
+
+## 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.md

@@ -0,0 +1,146 @@
+## Description
+
+Provides debugger with command and command arguments completion compliments of
+[bond](http://github.com/cldwalker/bond).
+
+## Install
+
+Install the gem with:
+
+    gem install debugger-completion
+
+## Setup
+
+To have debugger automatically use this gem:
+
+    echo "eval require 'debugger/completion'" >> ~/.rdebugrc
+
+Or to require in a script or application, place after your `require 'debugger'` line:
+
+    require 'debugger/completion'
+
+Or if you like to debug with one-liners:
+
+    require 'debugger/completion'; debugger
+
+Or if using rdebug:
+
+    rdebug -r debugger/completion FILE
+
+To start manually in environments with bond completion already setup i.e. irb:
+
+    require 'debugger/completion'
+    Debugger::Completion.start
+
+## Usage
+
+Let's autocomplete instance and local variables of the current binding as well as debugger
+commands:
+
+       186    end
+       187
+       188    def render
+       189      body = []
+       190      require 'debugger'; debugger
+    => 191      unless @rows.length ## 0
+       192        setup_field_lengths
+       193        body += render_header
+       194        body += render_rows
+       195        body += render_footer
+
+    (rdb:1) [TAB]
+    @fields            condition          finish             ps                 thread
+    @filter_classes    continue           frame              putl               tmate
+    @headers           delete             help               quit               trace
+    @options           disable            info               reload             undisplay
+    @rows              display            irb                restart            up
+    backtrace          down               list               save               var
+    body               edit               method             set                where
+    break              enable             next               show
+    catch              eval               p                  source
+    completion_toggle  exit               pp                 step
+
+    (rdb:1) ca[TAB]
+    (rdb:1) catch
+
+    (rdb:1) @fie[TAB]
+    (rdb:1) @fields
+
+    (rdb:1) bo[TAB]
+    (rdb:1) body
+
+Autocomplete methods of local and instance variables:
+
+    (rdb:1) @filter_classes.[TAB]
+    Display all 150 possibilities? (y or n)
+
+    (rdb:1) body.[TAB]
+    Display all 168 possibilities? (y or n)
+
+
+Autocomplete debugger command arguments:
+
+    # What info does debugger 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, why not autocomplete as if I'm in irb?
+
+    # Execute command provided by this gem
+    (rdb:1) completion_toggle  # also aliased to ct
+
+    # irb-like completion has been enabled
+    (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 debugger completion?
+
+    # Invoke completion_toggle again
+    (rdb:1)  completion_toggle
+
+    (rdb:1) [TAB]
+    @fields            condition          finish             ps                 thread
+    @filter_classes    continue           frame              putl               tmate
+    @headers           delete             help               quit               trace
+    @options           disable            info               reload             undisplay
+    @rows              display            irb                restart            up
+    backtrace          down               list               save               var
+    body               edit               method             set                where
+    break              enable             next               show
+    catch              eval               p                  source
+    completion_toggle  exit               pp                 step
+
+Please, can I just quit quickly without a prompt?
+
+    (rdb:1) q [TAB]
+    (rdb:1) q unconditionally
+
+## Bugs/Issues
+
+Please report them [on github](http://github.com/cldwalker/debugger-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,2 @@
+bond >=0.4.2
+debugger ~>1.1

data/lib/debugger/completion.rb

@@ -0,0 +1,70 @@
+require 'debugger'
+require 'bond'
+
+module Debugger
+  module Completion
+    extend self
+    VERSION = '1.0.0'
+    COMMANDS = [ "backtrace", "break", "catch", "condition", "continue",
+      "delete", "disable", "display", "down", "edit", "enable", "eval", "exit",
+        "finish", "frame", "help", "info", "irb", "jump", "list", "method", "next",
+        "p", "pp", "ps", "putl", "quit", "reload", "restart", "save", "set",
+        "show", "source", "step", "thread", "tmate", "trace", "undisplay",
+        "up", "var", "where"
+    ]
+
+    def start
+      Bond.restart(:eval_binding=>lambda { Debugger::Completion.current_binding },
+                 :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']
+      completions += @irb_completion ? Bond::DefaultMission.completions + Object.constants :
+        Bond::Mission.current_eval("local_variables | instance_variables")
+      completions - ['__dbg_verbose_save']
+    end
+
+    def current_binding
+      (cmd = first_object(Debugger::Command)) && cmd.send(:get_binding) rescue nil
+    end
+
+    def first_object(klass)
+      ObjectSpace.each_object(klass) {|e| return e }
+      nil
+    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 unless Bond.started?

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: debugger-completion
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Gabriel Horner
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bond
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.4.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.4.2
+- !ruby/object:Gem::Dependency
+  name: debugger
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+description: Provides debugger with command and command arguments completion, compliments
+  of bond.
+email: gabriel.horner@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE.txt
+files:
+- lib/debugger/completion.rb
+- LICENSE.txt
+- CHANGELOG.md
+- README.md
+- deps.rip
+- Rakefile
+- .gemspec
+homepage: http://github.com/cldwalker/debugger-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
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: ! 'Mission: autocomplete debugger'
+test_files: []