binding.repl 0.1.1.1 → 0.3.0

data/ChangeLog.txt

@@ -1,3 +1,23 @@
+== v0.3.0
+   - add Binding.repl.add
+   add a ruby console to binding.repl
+
+   - add lib/binding.repl/{pry,irb,ripl}.rb
+   individual files for each console that use Binding.repl.add
+
+   - modularize design, cleanup internals
+   the anonymous class is gone because constant lookup rules are a
+   pain with anonymous classes. The class we create is available at
+   Binding.repl and nowhere else, though.
+
+== v0.2.0
+   - call IRB.setup() once
+   fixes #4
+
+   - add binding.repl.auto
+   auto discover the first available console.
+   fixes #3
+
 == v0.1.1.1
    - doc improvements
 

data/README.md

@@ -8,7 +8,7 @@
 __DESCRIPTION__
 
 __binding.repl__ can start a number of different ruby consoles at runtime.
-IRB, ripl, and Pry(of course!) can be invoked at runtime in any context
+IRB, ripl, and pry(of course!) can be invoked at runtime in any context
 that an instance of `Binding` closes over.
 
 I owe all credit to John Mair([banisterfiend](https://github.com/banister)),
@@ -29,27 +29,36 @@ consoles (if I missed one, open an issue or send an e-note :)).
 __EXAMPLES__
 
 ```ruby
-class Foo
-  binding.repl.pry   # invoke pry in context of "Foo"
-  binding.repl.ripl  # invoke ripl in context of "Foo"
-  binding.repl.irb   # invoke irb in context of "Foo"
-end
-
-class BlogsController < ActionController::Base
-  def index
+class BlogsController < ApplicationController
+  def show
     @blog = Blog.find(params[:id])
+    # invoke pry,irb, or ripl in the context of the 'show' method.
     binding.repl.{pry,irb,ripl}
   end
 end
+
+class Bar
+  # auto discover the first available console.
+  # default order is: ripl, pry, or irb.
+  binding.repl.auto
+
+  # change default load order
+  Binding.repl.auto_load_order = %w(pry ripl irb)
+
+  # remove "irb" from auto discovery
+  Binding.repl.auto_load_order -= ["irb"]
+end
 ```
 
 __NOTES__
 
-_CAVAETS_
+_CONFIGURATION_
 
-Ripl and Pry can be customized by passing a set of key-value pairs but
-IRB cannot. ripl can be invoked with options that are forwarded to
-`Ripl.start(…)`:  
+ripl and pry can be customized by passing a set of key-value pairs but
+IRB isn't as straight forward to configure and I haven't implemented
+any customization options for it yet.
+
+ripl can be invoked with options that are forwarded to `Ripl.start(…)`:
 
 ```ruby
 class Foo
@@ -57,7 +66,7 @@ class Foo
 end
 ```
 
-Pry can be configured in the same way. options are forwarded to `Pry.start(…)`:
+pry can be configured in the same way. options are forwarded to `Pry.start(…)`:
 
 ```ruby
 class Foo
@@ -65,6 +74,8 @@ class Foo
 end
 ```
 
+_RIPL & IRB_
+
 I have only used Ripl once(to write this library) and I don't use IRB
 much anymore. If I can improve support for either please let me know
 via an issue or pull request/e-note.
@@ -72,9 +83,9 @@ via an issue or pull request/e-note.
 
 _DEPENDENCIES_
 
-binding.repl doesn't depend on anything. it's up to you to meet the 
-dependencies(pry, irb, and/or ripl). `binding.repl.{ripl,pry,irb}` 
-will try to load the appropiate console for you if it looks like it 
+binding.repl doesn't depend on anything. it's up to you to meet the
+dependencies(pry, irb, and/or ripl). `binding.repl.{ripl,pry,irb}`
+will try to load the appropiate console for you if it looks like it
 hasn't been loaded yet.
 
 __INSTALL__
@@ -87,10 +98,10 @@ gem install binding.repl
 
 __CREDIT__
 
-- [banisterfiend](https://github.com/banister) (John Mair)  
+- [banisterfiend](https://github.com/banister) (John Mair)
   for pry
 
-- [Kyrylo](https://github.com/kyrylo) (Kyrylo Silin)  
+- [Kyrylo](https://github.com/kyrylo) (Kyrylo Silin)
   for his hard work on pry.
 
 Rest of the Pry team(!!):

data/binding.repl.gemspec

@@ -5,9 +5,9 @@ Gem::Specification.new do |spec|
   spec.version       = Binding.repl.version
   spec.authors       = ["Robert Gleeson"]
   spec.email         = ["rob@flowof.info"]
-  spec.description   = "binding.repl provides the same binding.pry interface to all ruby consoles"
-  spec.summary       = "binding.repl provides the same binding.pry interface to all ruby consoles"
-  spec.homepage      = ""
+  spec.description   = "binding.repl: binding.pry for all ruby consoles"
+  spec.summary       = spec.description
+  spec.homepage      = "https://github.com/robgleeson/binding.repl"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)

data/lib/binding.repl.rb

@@ -1,54 +1,90 @@
-klass = Class.new do
-  self.const_set :BindingMixin, Module.new {
+class BindingRepl
+  module BindingMixin
     def repl
       Binding.repl.new(self)
     end
-  }
+  end
+
+  LOOKUP = {}
+  LOOKUP.default = [proc { true }, proc { :'binding.repl.unknown_console' }]
+  private_constant :LOOKUP
+
+  def self.name
+    "binding.repl"
+  end
+
+  def self.inspect
+    name
+  end
 
   def self.version
-    "0.1.1.1"
+    "0.3.0"
   end
 
-  def initialize(binding)
-    @binding = binding
+  def self.add(console, predicate, runner)
+    LOOKUP[console] = [predicate, runner]
+    define_method(console) do |options = {}|
+      exit_value = invoke_console(console, options)
+      error?(exit_value) ? fail!(console) : exit_value
+    end
   end
 
-  def pry(options = {})
-    safe_require "pry", defined?(Pry)
-    @binding.pry options
+  def self.auto_load_order=(order)
+    @auto_load_order = order
   end
 
-  def ripl(options = {})
-    safe_require "ripl", defined?(Ripl)
-    Ripl.start options.merge(:binding => @binding)
+  def self.auto_load_order
+    @auto_load_order
   end
 
-  def irb(options = nil)
-    # Insane API, but here it is (IRB.start() doesn't take binding).
-    safe_require "irb", defined?(IRB)
-    IRB.setup(nil)
-    irb = IRB::Irb.new IRB::WorkSpace.new(@binding)
-    IRB.conf[:IRB_RC].call(irb.context) if IRB.conf[:IRB_RC]
-    IRB.conf[:MAIN_CONTEXT] = irb.context
-    trap("SIGINT") do
-      irb.signal_handle
-    end
-    catch(:IRB_EXIT) do
-      irb.eval_input
+  def initialize(binding)
+    @binding = binding
+    @lookup = LOOKUP
+  end
+
+  def auto
+    load_order = Binding.repl.auto_load_order
+    load_order.each do |console|
+      exit_value = invoke_console(console.to_sym, {})
+      return exit_value unless error?(exit_value)
     end
+    raise LoadError, "failed to load consoles: #{load_order.join(", ")}", []
   end
 
 private
-  def safe_require(lib, already_loaded)
-    unless already_loaded
-      require(lib)
+  def fail!(console)
+    raise LoadError, "the console '#{console}' could not be loaded. is #{console} installed?", []
+  end
+
+  def error?(exit_value)
+    exit_value.to_s.start_with? "binding.repl"
+  end
+
+  def invoke_console(console, options)
+    require_predicate, runner = @lookup[console]
+    require_console(console, require_predicate)
+    runner.call(@binding, options)
+  rescue LoadError
+    :'binding.repl.load_error'
+  end
+
+  def require_console(console, predicate)
+    already_required = predicate.call
+    if !already_required
+      require(console.to_s)
+      # IRB hack.
+      IRB.setup(nil) if console == :irb
     end
-  rescue LoadError => e
-    raise e, "the ruby console '#{lib}' could not be loaded. is '#{lib}' installed?"
   end
 end
 
+klass = BindingRepl
+Object.send :remove_const, :BindingRepl
 Binding.class_eval do
   define_singleton_method(:repl) { klass }
-  include Binding.repl::BindingMixin
+  include klass::BindingMixin
+  repl.auto_load_order = %w(ripl pry irb)
 end
+require_relative "binding.repl/pry"
+require_relative "binding.repl/irb"
+require_relative "binding.repl/ripl"

data/lib/binding.repl/irb.rb

@@ -0,0 +1,10 @@
+predicate = lambda do
+  defined?(IRB)
+end
+runner = lambda do |binding, options|
+  irb = IRB::Irb.new IRB::WorkSpace.new(binding)
+  IRB.conf[:MAIN_CONTEXT] = irb.context
+  trap("SIGINT") { irb.signal_handle }
+  catch(:IRB_EXIT) { irb.eval_input }
+end
+Binding.repl.add :irb, predicate, runner

data/lib/binding.repl/pry.rb

@@ -0,0 +1,7 @@
+predicate = lambda do
+  defined?(Pry)
+end
+runner = lambda do |binding, options|
+  binding.public_send :pry, options
+end
+Binding.repl.add :pry, predicate, runner

data/lib/binding.repl/ripl.rb

@@ -0,0 +1,7 @@
+predicate = lambda do
+  defined?(Ripl)
+end
+runner = lambda do |binding, options|
+  Ripl.start options.merge(binding: binding)
+end
+Binding.repl.add :ripl, predicate, runner

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: binding.repl
 version: !ruby/object:Gem::Version
-  version: 0.1.1.1
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-26 00:00:00.000000000 Z
+date: 2013-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -43,7 +43,7 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: binding.repl provides the same binding.pry interface to all ruby consoles
+description: ! 'binding.repl: binding.pry for all ruby consoles'
 email:
 - rob@flowof.info
 executables: []
@@ -59,7 +59,10 @@ files:
 - Rakefile
 - binding.repl.gemspec
 - lib/binding.repl.rb
-homepage: ''
+- lib/binding.repl/irb.rb
+- lib/binding.repl/pry.rb
+- lib/binding.repl/ripl.rb
+homepage: https://github.com/robgleeson/binding.repl
 licenses:
 - MIT
 post_install_message: 
@@ -80,11 +83,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3088308682955123081
+      hash: 2298799895627227771
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: binding.repl provides the same binding.pry interface to all ruby consoles
+summary: ! 'binding.repl: binding.pry for all ruby consoles'
 test_files: []