binding.repl 0.5.0.1 → 0.6.0

data/ChangeLog.txt

@@ -1,18 +1,32 @@
+== v0.6.0
+   - add Binding.repl.{disable!,enable!}.
+   turn binding.repl.{pry,irb,ripl,auto} into a no-op.
+   closes #8.
+
+== v0.5.1
+   - $CWD/.binding.repl.rc has precendence over $HOME/.binding.repl.rc
+   stupid mistake. $CWD/.binding.repl.rc should be loaded instead of
+   $HOME/.binding.repl.rc if it exists.
+
+   - compare ENV["BINDING_REPL_RC"] as a string.
+   casting with to_i on nil(the default) returns 0.
+   file was never loaded.
+
 == v0.5.0.1
    - documentation fix
    error in documentation
 
 == v0.5.0
    - disable {$HOME,$CWD}/.binding.repl.rc loading
-   set ENV["BINDING_REPL_RC"] = 0 to disable load.
+   set ENV["BINDING_REPL_RC"] = "0" to disable load.
 
 == v0.4.1
    - read {$HOME,$CWD}/.binding.repl.rc as JSON
-   safer.
+   less security concerns than parsing ruby.
 
 == v0.4.0
    - read {$HOME,$CWD}/.binding.ripl.rc on load
-   see README for docs.
+   see README for documentation.
 
 == v0.3.0
    - add Binding.repl.add

data/README.md

@@ -33,13 +33,12 @@ __EXAMPLES__
 class BlogsController < ApplicationController
   def show
     @blog = Blog.find(params[:id])
-    # starts pry, irb, or ripl in the context of 'BlogsController#show'.
     binding.repl.{pry,irb,ripl}
   end
 end
 
 class Bar
-  # auto discover the first available console.
+  # auto discover and start the first available console.
   # default order is: ripl, pry, or irb.
   binding.repl.auto
 
@@ -49,6 +48,20 @@ class Bar
   # remove "irb" from auto discovery
   Binding.repl.auto_load_order -= ["irb"]
 end
+
+class Baz
+  # invoke irb
+  binding.repl.irb
+  Binding.repl.disable!
+
+  # no-op, returns :'binding.repl.disabled' and continues execution.
+  binding.repl.irb
+  binding.repl.ripl
+
+  # invoke pry
+  Binding.repl.enable!
+  binding.repl.pry
+end
 ```
 
 __NOTES__
@@ -75,21 +88,29 @@ 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 JSON file with a single key-value pair.
+directory. It's a very simple JSON file.
 
-let's say amy prefers IRB, so her `$HOME/.binding.repl.rc` would look like this:
+let's say rob & amy are working on some code together. amy prefers
+IRB, so her `$HOME/.binding.repl.rc` would look like this:
 ```javascript
 {
   "auto_load_order": ["irb", "pry", "ripl"]
 }
 ```
 
-let's say rob prefers pry, so his `$HOME/.binding.repl.rc` would look like this:
+rob prefers pry, so his `$HOME/.binding.repl.rc` would look like this:
 ```ruby
 {
   "auto_load_order": ["pry", "ripl", "irb"]
@@ -107,20 +128,6 @@ 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.
-
-
-_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,20 @@ class BindingRepl
   end
 
   def self.version
-    "0.5.0.1"
+    "0.6.0"
+  end
+
+  def self.disabled?
+    @disabled
+  end
+
+  def self.enable!
+    @disabled = false
+    !@disabled
+  end
+
+  def self.disable!
+    @disabled = true
   end
 
   def self.add(console, predicate, runner)
@@ -44,11 +57,14 @@ class BindingRepl
 
   def auto
     load_order = Binding.repl.auto_load_order
+    exit_value = nil
     load_order.each do |console|
       exit_value = invoke_console(console.to_sym, {})
       return exit_value unless invoke_failed?(exit_value)
     end
-    raise LoadError, "failed to load consoles: #{load_order.join(", ")}", []
+    if invoke_failed?(exit_value)
+      raise LoadError, "failed to load consoles: #{load_order.join(", ")}", []
+    end
   end
 
 private
@@ -57,10 +73,14 @@ private
   end
 
   def invoke_failed?(exit_value)
-    exit_value.to_s.start_with? "binding.repl"
+    exit_value = exit_value.to_s
+    exit_value.start_with?("binding.repl") && exit_value != 'binding.repl.disabled'
   end
 
   def invoke_console(console, options)
+    if Binding.repl.disabled?
+      return :'binding.repl.disabled'
+    end
     require_predicate, runner = @lookup[console]
     require_console(console, require_predicate)
     runner.call(@binding, options)
@@ -85,10 +105,10 @@ Binding.class_eval do
   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"
+require_relative "binding.repl/console/pry"
+require_relative "binding.repl/console/irb"
+require_relative "binding.repl/console/ripl"
 
-if ENV["BINDING_REPL_RC"].to_i != 0
+if ENV["BINDING_REPL_RC"] != "0"
   require_relative "binding.repl/rc"
 end

data/lib/binding.repl/rc.rb

@@ -2,14 +2,15 @@ require "json"
 home_rc = File.join ENV["HOME"], ".binding.repl.rc"
 local_rc = File.join Dir.getwd, ".binding.repl.rc"
 
-if File.exists?(home_rc)
-  json = File.read(home_rc)
-end
-if !File.exists?(home_rc) && File.exists?(local_rc)
+if File.exists?(local_rc)
   json = File.read(local_rc)
+else
+  if File.exists?(home_rc)
+    json = File.read(home_rc)
+  end
 end
 
-if local_rc || home_rc
+if json
   options = JSON.parse(json) rescue nil
 end
 if options

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: binding.repl
 version: !ruby/object:Gem::Version
-  version: 0.5.0.1
+  version: 0.6.0
   prerelease: 
 platform: ruby
 authors:
@@ -60,10 +60,10 @@ files:
 - Rakefile
 - binding.repl.gemspec
 - lib/binding.repl.rb
-- lib/binding.repl/irb.rb
-- lib/binding.repl/pry.rb
+- lib/binding.repl/console/irb.rb
+- lib/binding.repl/console/pry.rb
+- lib/binding.repl/console/ripl.rb
 - lib/binding.repl/rc.rb
-- lib/binding.repl/ripl.rb
 homepage: https://github.com/robgleeson/binding.repl
 licenses:
 - MIT
@@ -85,7 +85,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3376741640928486311
+      hash: 1608399329349294521
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23