binding.repl 0.6.0 → 0.7.0

data/ChangeLog.txt

@@ -1,3 +1,15 @@
+== v0.7.0
+   - catch JSON parse errors when reading .binding.repl.rc
+   closes #7
+
+   - no longer read from project-local .binding.repl.rc file
+   the $BINDING_REPL_ORDER environment variable can be set if you
+   want to override the settings defined by $HOME/.binding.repl.rc
+
+   - read shell env var $BINDING_REPL_ORDER
+   set of $BINDING_REPL_ORDER stops the .binding.repl.rc file from
+   being loaded and takes precendence. closes #9.
+
 == v0.6.0
    - add Binding.repl.{disable!,enable!}.
    turn binding.repl.{pry,irb,ripl,auto} into a no-op.

data/README.md

@@ -29,14 +29,20 @@ consoles (if I missed one, open an issue or send an e-note :)).
 
 __EXAMPLES__
 
+_Rails_
+
 ```ruby
 class BlogsController < ApplicationController
   def show
     @blog = Blog.find(params[:id])
-    binding.repl.{pry,irb,ripl}
+    binding.repl.{pry,irb,ripl,auto}
   end
 end
+```
 
+_Auto discovery_
+
+```ruby
 class Bar
   # auto discover and start the first available console.
   # default order is: ripl, pry, or irb.
@@ -48,7 +54,11 @@ class Bar
   # remove "irb" from auto discovery
   Binding.repl.auto_load_order -= ["irb"]
 end
+```
+
+_Enable/disable at runtime_
 
+```ruby
 class Baz
   # invoke irb
   binding.repl.irb
@@ -88,32 +98,25 @@ class Foo
 end
 ```
 
-_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
-hasn't been loaded yet.
-
 _WORKING WITH TEAMS_
 
 people working in teams might have different choices for what ruby
 console they like to use and __binding.repl__ tries to accomondate by
-reading a `.binding.repl.rc` file from $HOME or the current working
-directory. It's a very simple JSON file.
+reading a `.binding.repl.rc` file from $HOME or by setting a shell
+environment variable. `binding.repl.rc` is a simple JSON file.
 
 let's say rob & amy are working on some code together. amy prefers
-IRB, so her `$HOME/.binding.repl.rc` would look like this:
+ripl, so her `$HOME/.binding.repl.rc` would look like this:
 ```javascript
 {
-  "auto_load_order": ["irb", "pry", "ripl"]
+  "auto_load_order": ["ripl", "irb"]
 }
 ```
 
 rob prefers pry, so his `$HOME/.binding.repl.rc` would look like this:
 ```ruby
 {
-  "auto_load_order": ["pry", "ripl", "irb"]
+  "auto_load_order": ["pry", "irb"]
 }
 ```
 
@@ -122,12 +125,32 @@ they can use `binding.repl.auto`:
 
 ```ruby
 class Foo
-  # starts "irb" in the context of Foo for amy.
-  # starts "pry" in the context of Foo for rob.
+  # starts "irb" in the context of Foo for amy. fall back console is "irb".
+  # starts "pry" in the context of Foo for rob. fall back console is "irb".
   binding.repl.auto
 end
 ```
 
+_SHELL ENVIRONMENT VARIABLES_
+
+binding.repl can be configured with a couple of shell environment variables.
+
+```bash
+# disable trying to read $HOME/.binding.repl.rc
+export BINDING_REPL_RC=0
+
+# set the 'auto' load order
+# takes precendence over $HOME/.binding.repl.rc when set
+export BINDING_REPL_ORDER=pry,irb
+```
+
+_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
+hasn't been loaded yet.
+
 __INSTALL__
 
 ruby 1.9+ only.

data/lib/binding.repl.rb

@@ -18,7 +18,7 @@ class BindingRepl
   end
 
   def self.version
-    "0.6.0"
+    "0.7.0"
   end
 
   def self.disabled?
@@ -56,8 +56,7 @@ class BindingRepl
   end
 
   def auto
-    load_order = Binding.repl.auto_load_order
-    exit_value = nil
+    load_order, exit_value = Binding.repl.auto_load_order, nil
     load_order.each do |console|
       exit_value = invoke_console(console.to_sym, {})
       return exit_value unless invoke_failed?(exit_value)
@@ -92,8 +91,6 @@ private
     already_required = predicate.call
     if !already_required
       require(console.to_s)
-      # IRB hack.
-      IRB.setup(nil) if console == :irb
     end
   end
 end
@@ -108,7 +105,4 @@ end
 require_relative "binding.repl/console/pry"
 require_relative "binding.repl/console/irb"
 require_relative "binding.repl/console/ripl"
-
-if ENV["BINDING_REPL_RC"] != "0"
-  require_relative "binding.repl/rc"
-end
+require_relative "binding.repl/rc"

data/lib/binding.repl/console/irb.rb

@@ -1,7 +1,13 @@
 predicate = lambda do
   defined?(IRB)
 end
+
+irb_setup = false
 runner = lambda do |binding, options|
+  unless irb_setup
+    IRB.setup(nil)
+    irb_setup = true
+  end
   irb = IRB::Irb.new IRB::WorkSpace.new(binding)
   IRB.conf[:MAIN_CONTEXT] = irb.context
   trap("SIGINT") { irb.signal_handle }

data/lib/binding.repl/rc.rb

@@ -1,18 +1,24 @@
-require "json"
-home_rc = File.join ENV["HOME"], ".binding.repl.rc"
-local_rc = File.join Dir.getwd, ".binding.repl.rc"
+module Binding.repl::RC
+  module_function
+  def home_rc
+    File.join ENV["HOME"], ".binding.repl.rc"
+  end
 
-if File.exists?(local_rc)
-  json = File.read(local_rc)
-else
-  if File.exists?(home_rc)
-    json = File.read(home_rc)
+  def safe_load
+    if File.readable?(home_rc)
+      blob = File.read(home_rc)
+      rc = JSON.parse File.read(home_rc)
+      Binding.repl.auto_load_order = rc["auto_load_order"]
+    end
+  rescue StandardError => e
+    warn "binding.repl: '#{home_rc}' read failed (#{e.class}): #{e.message}"
   end
 end
 
-if json
-  options = JSON.parse(json) rescue nil
+if ENV["BINDING_REPL_ORDER"].nil? && ENV["BINDING_REPL_RC"] != "0"
+  require "json"
+  Binding.repl::RC.safe_load
 end
-if options
-  Binding.repl.auto_load_order = options["auto_load_order"]
+if ENV.has_key?("BINDING_REPL_ORDER")
+  Binding.repl.auto_load_order = ENV["BINDING_REPL_ORDER"].split /[:,]/
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: binding.repl
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-29 00:00:00.000000000 Z
+date: 2013-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -85,7 +85,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1608399329349294521
+      hash: -334178767323369465
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23