binding.repl 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8c8ee86e2adcf420c60b05111ce45b43a00343b9
-  data.tar.gz: 117c6da32749481c1cd5436b5f5c43100904c2c7
+  metadata.gz: 881260583be0c5997a75febf99efbf065f60a529
+  data.tar.gz: 986efe28b8769dd1ffeac275eba4498d91450580
 SHA512:
-  metadata.gz: 42a9a9d209908ea84a870c9a655d3227ab98725302f3fa799a37bd193cf980cfdac8f2391220b0f66df47be772a80aebe4802915b35ca7560154b4b3f06023fc
-  data.tar.gz: 993a7b4835312e617d3c9554e3217384fded40b6c048bf63a331d0f55fa20a52ad4cb283000c3081dcdd7badcde57961019a08caa4f3135eb01cac1a95416a20
+  metadata.gz: 676af3d0f78e7b4f26d625a7cbef0658ef1432fda4454316281a734cb7c0caae95efe81f4d61ce033b99ef0e76904935e3dc4921ff2499e73ddfb9c50dd019f7
+  data.tar.gz: bbb6a3e476662d05180eb93cd06cab283b001a62b60ad15580898dcbc11f0b3065f863afd4f2502e8b00cd6072d2ac0d268692973329092cb9aa718f38a5a41b

data/.binding.repl.rc

@@ -1,6 +1,3 @@
-#
-# a sample of what $HOME/.binding.repl.rc might look like.
-# the default lookup order for `binding.repl.auto` can be defined in this file.
-#
+# sample file.
 [auto]
   order = ["irb", "rib", "pry", "ripl"]

data/.travis.yml

@@ -5,8 +5,19 @@ rvm:
   - 1.9.3
   - 2.0.0
   - 2.1.0
+  - ruby-head
   - rbx
   - jruby-19mode
 
+matrix:
+  allow_failures:
+    # TravisCI:
+    # jruby-d19 is not installed - installing.
+    # Searching for binary rubies, this might take some time.
+    # Requested binary installation but no rubies are available to download, consider skipping --binary flag.
+    # Gemset '' does not exist,       'rvm jruby-d19 do rvm gemset create ' first, or append '--create'.
+    # The command "rvm use jruby-d19 --install --binary --fuzzy" failed and exited with 2 during setup.
+    - rvm: jruby-19mode
+
 notifications:
   email: true

data/ChangeLog.txt

@@ -1,22 +1,39 @@
+== v0.10.0 (2014-02-08)
+  - add DELIMITER_REGEXP to BindingRepl::ENV.
+   it is a single reference kept to /[,:]/ which is used when parsing
+   shell environment variable, $auto_order.
+
+  - add BindingRepl::ExitValue
+    binding.repl.{auto,irb,pry,rib,ripl} return an instance of BindingRepl::ExitValue.
+
+  - move from test-unit to minitest (developer-facing change).
+   test suite has been rewritten on top of 'MiniTest::Test' instead of 'Test::Unit::TestCase'.
+   test-unit appears to be semi-deprecated and active development or change happens on 'minitest'.
+   minitest switch was smooth thanks to 'sed' !
+
+  - remove BindingRepl::ENV.disable_rc_file? (developer-facing change)
+   the inverse, BindingRepl::ENV.enable_rc_file?, is the only method binding.repl needs
+   to load the RC file. drop BindingRepl::ENV.disable_rc_file?.
+
+  - update the BindingRepl::LOOKUP hash to use string's as keys. (#23) (developer-facing changes)
+  - rename BindingRepl#invoke_console as BindingRepl#run_console. (developer-facing change)
+  - rename BindingRepl#fail! as BindingRepl#die(). (developer-facing change)
+  - remove BindingRepl.{name,to_s}
+
 == v0.9.0
   - read $HOME/.binding.repl.rc as TOML instead of JSON
   TOML is easy to read and write when compared with JSON. I don't think
   humans like writing JSON too much :) you can get up to speed with TOML
-  at https://github.com/mojombo/toml.
-  closes GH #12.
+  at https://github.com/mojombo/toml. (#12)
 
-  - rename Binding.repl.auto_load_order as Binding.repl.auto_order.
-  closes GH #14.
+  - rename Binding.repl.auto_load_order as Binding.repl.auto_order. (#14)
 
   - rename shell environment variable BINDING_REPL_ORDER as auto_order
   less keys to press, no SHIFT key needed!
   a little background on why I decided to try lowercase.
-  http://pubs.opengroup.org/onlinepubs/7908799/xbd/envvar.html
-  closes GH #15.
+  http://pubs.opengroup.org/onlinepubs/7908799/xbd/envvar.html (#15).
 
-  - rename shell environment variable BINDING_REPL_RC as disable_rc.
-  ditto.
-  closes GH #15.
+  - rename shell environment variable BINDING_REPL_RC as disable_rc. (#15).
 
   - 1.9.2 support
   use of `private_constant` broke binding.repl support on 1.9.2
@@ -72,8 +89,7 @@
    see lib/binding.repl/console/*.rb for examples.
 
 == v0.7.0
-   - catch JSON parse errors when reading .binding.repl.rc
-   closes #7
+   - catch JSON parse errors when reading .binding.repl.rc (#7)
 
    - no longer read from project-local .binding.repl.rc file
    the $BINDING_REPL_ORDER environment variable can be set if you
@@ -81,12 +97,11 @@
 
    - 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.
+   being loaded and takes precendence. (#9)
 
 == v0.6.0
    - add Binding.repl.{disable!,enable!}.
-   turn binding.repl.{pry,irb,ripl,auto} into a no-op.
-   closes #8.
+   turn binding.repl.{pry,irb,ripl,auto} into a no-op. (#8)
 
 == v0.5.1
    - $CWD/.binding.repl.rc has precendence over $HOME/.binding.repl.rc
@@ -126,12 +141,10 @@
    Binding.repl and nowhere else, though.
 
 == v0.2.0
-   - call IRB.setup() once
-   fixes #4
+   - call IRB.setup() once (#4)
 
    - add binding.repl.auto
-   auto discover the first available console.
-   fixes #3
+   auto discover the first available console. (#3)
 
 == v0.1.1.1
    - doc improvements

data/Gemfile

@@ -7,6 +7,7 @@ end
 
 group :test do
   gem "rspec-mocks"
+  gem "minitest"
 end
 
 group :test, :repls do
@@ -17,6 +18,6 @@ group :test, :repls do
 end
 
 platform :rbx do
-  gem "rubysl"
-  gem "rubysl-test-unit"
+  gem "rubysl-irb"
+  gem "rubysl-mutex_m"
 end

data/README.md

@@ -79,44 +79,33 @@ __DOCS__
 
 __DEPENDENCIES__
 
-binding.repl doesn't depend on anything. it's up to you to meet the
-dependencies(pry, irb, rib, and/or ripl). `binding.repl.{ripl,pry,rib,irb}`
-will try to load the appropiate console for you if it looks like it
-hasn't been loaded yet.
+binding.repl doesn't depend on anything but `toml`. it's up to you to meet the
+console dependencies(pry, irb, rib, and/or ripl). `binding.repl.{ripl,pry,rib,irb}`
+will try to load the appropiate console for you if it looks like it hasn't been loaded yet.
 
-__PLATFORM SUPPORT__
+__RUBIES__
 
-should work on all 1.9+ ruby implementations. please open an issue if you find a bug!
+all of them (jruby, MRI, rubinius). 1.9+ and up only, though.
+check [.travis.yml](https://github.com/robgleeson/binding.repl/blob/master/.travis.yml) for a complete list.
 
-__INSTALL__
+__CONTRIBUTE!__
+
+[fork it](https://github.com/robgleeson/binding.repl/fork), clone it, change! <br>
+open a pull request :)
 
+some tips for working on the project:
 ```
-gem install binding.repl
+cd $CLONED_DIR
+bundle install
+rake test # run tests
 ```
 
-__CREDIT__
-
-- [banisterfiend](https://github.com/banister) (John Mair)
-  for pry
-
-- [Kyrylo](https://github.com/kyrylo) (Kyrylo Silin)
-  for his hard work on pry.
-
-Rest of the Pry team(!!):
+__INSTALL__
 
-- [cirwin](https://github.com/conradirwin), Conrad Irwin.
-- [ryanf](https://github.com/rf-), Ryan Fitzgerald.
-- [rking](https://github.com/rking), "rking", on adventures outside programming now.
+```
+gem install binding.repl
+```
 
 __LICENSE__
 
 Public Domain. see UNLICENSE.txt.
-
-
-__CONTRIBUTING__
-
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new E-Note

data/Rakefile

@@ -1,9 +1,9 @@
 require "bundler/gem_tasks"
 require "rake/testtask"
 
-Rake::TestTask.new do |t|
-  t.test_files = FileList["test/*_test.rb"]
-  t.verbose = true
+desc "run tests"
+task :test do
+  Dir["test/*_test.rb"].each { |test| require_relative(test) }
 end
 task :default => :test
 

data/binding.repl.gemspec

@@ -3,8 +3,8 @@ require "./lib/binding.repl/version"
 Gem::Specification.new do |spec|
   spec.name          = "binding.repl"
   spec.version       = BindingRepl.version
-  spec.authors       = ["Robert Gleeson"]
-  spec.email         = ["rob@flowof.info"]
+  spec.authors       = ["Public Domain"]
+  spec.email         = ["robert@flowof.info"]
   spec.description   = "binding.repl: binding.pry for all ruby consoles"
   spec.summary       = spec.description
   spec.homepage      = "https://github.com/robgleeson/binding.repl"

data/lib/binding.repl.rb

@@ -3,16 +3,8 @@ class BindingRepl
   LOOKUP.default = [proc { true }, proc { :'binding.repl.unknown_console' }]
   singleton_class.class_eval { attr_accessor :auto_order }
 
-  def self.name
-    "binding.repl"
-  end
-
-  def self.to_s
-    name
-  end
-
   #
-  # returns when binding.repl is disabled.
+  # returns true when binding.repl is disabled.
   #
   # @return [Boolean]
   #
@@ -54,10 +46,10 @@ class BindingRepl
   # @return [void]
   #
   def self.add(console, initializer, runner)
-    LOOKUP[console] = [initializer, runner]
+    LOOKUP[console.to_s] = [initializer, runner]
     define_method(console) do |options = {}|
-      exit_value = invoke_console(console, options)
-      invoke_failed?(exit_value) ? fail!(console) : exit_value
+      value = run_console(console, options)
+      value.failure? ? die(console) : value
     end
   end
 
@@ -67,48 +59,56 @@ class BindingRepl
   end
 
   def auto
-    load_order, exit_value = Binding.repl.auto_order, nil
-    load_order.each do |console|
-      exit_value = invoke_console(console.to_sym, {})
-      return exit_value unless invoke_failed?(exit_value)
-    end
-    if load_order.empty?
-      raise LoadError, "no consoles found in Binding.repl.auto_order (empty)"
-    elsif invoke_failed?(exit_value)
-      raise LoadError, "no loadable consoles found (searched for #{load_order.join(', ')})"
+    consoles = Binding.repl.auto_order
+    value = run_any_console(consoles)
+    if consoles.empty?
+      raise LoadError, "no consoles available to load. Binding.repl.auto_order is empty"
+    elsif value.nil?
+      consoles_str = consoles.join(", ")
+      raise LoadError, "attempts to require any of the following consoles failed: #{consoles_str}"
+    else
+      value
     end
   end
 
 private
-  def fail!(console)
-    raise LoadError, "the console '#{console}' could not be loaded :("
+  def die(console)
+    raise LoadError, "failed to require '#{console}'"
   end
 
-  def invoke_failed?(exit_value)
-    exit_value = exit_value.to_s
-    exit_value.start_with?("binding.repl") && exit_value != 'binding.repl.disabled'
+  def run_any_console(consoles)
+    consoles.each do |console|
+      value = run_console(console)
+      return value if value.success?
+    end
+    nil
   end
 
-  def invoke_console(console, options)
+  def run_console(console, options = {})
+    console = console.to_s
     if Binding.repl.disabled?
-      return :'binding.repl.disabled'
+      value = BindingRepl::ExitValue.disabled_value
+    else
+      initializer, runner = @lookup[console]
+      initializer.call
+      @lookup[console] = [@lookup.default.at(0), runner]
+      value = runner.call @binding, options
     end
-    initializer, runner = @lookup[console]
-    initializer.call
-    @lookup[console] = [@lookup.default.at(0), runner]
-    runner.call @binding, options
   rescue LoadError
-    :'binding.repl.load_error'
+    value = BindingRepl::ExitValue.load_error_value
+  ensure
+    return BindingRepl::ExitValue.new(value)
   end
 end
+
 require_relative "binding.repl/core_ext/binding"
 require_relative "binding.repl/env"
 require_relative "binding.repl/rcfile"
+require_relative "binding.repl/exit_value"
 require_relative "binding.repl/version"
 require_relative "binding.repl/console/pry"
 require_relative "binding.repl/console/irb"
 require_relative "binding.repl/console/ripl"
 require_relative "binding.repl/console/rib"
-
 BindingRepl::RCFile.load
 BindingRepl.auto_order = BindingRepl::ENV.auto_order

data/lib/binding.repl/env.rb

@@ -1,18 +1,15 @@
 module BindingRepl::ENV
   @env = ::ENV
   DEFAULT_AUTO_ORDER = ["pry", "ripl", "rib", "irb"]
+  DELIMITER_REGEXP = /[:,]/
 
   module_function
   def enable_rc_file?
     @env['disable_rc'] != 'true' and @env['disable_rc'] != '1'
   end
 
-  def disable_rc_file?
-    !enable_rc_file?
-  end
-
   def auto_order
-    env_order = @env['auto_order'].to_s.split /[:,]/
+    env_order = @env['auto_order'].to_s.split(DELIMITER_REGEXP)
     env_order.empty? ? DEFAULT_AUTO_ORDER : env_order
   end
 end

data/lib/binding.repl/exit_value.rb

@@ -0,0 +1,36 @@
+class BindingRepl::ExitValue
+  STATUS_MAP = {
+    :disabled => :'binding.repl.disabled',
+    :unknown_console => :'binding.repl.unknown_console'
+  }
+
+  def self.load_error_value
+    STATUS_MAP[:unknown_console]
+  end
+
+  def self.disabled_value
+    STATUS_MAP[:disabled]
+  end
+
+  attr_reader :object
+
+  def initialize(object)
+    @object = object
+  end
+
+  def success?
+    not failure?
+  end
+
+  def failure?
+    load_error?
+  end
+
+  def disabled?
+    STATUS_MAP[:disabled] == object
+  end
+
+  def load_error?
+    STATUS_MAP[:unknown_console] == object
+  end
+end

data/lib/binding.repl/version.rb

@@ -1,5 +1,5 @@
 class BindingRepl
-  VERSION = "0.9.0".freeze
+  VERSION = "0.10.0".freeze
 
   def self.version
     VERSION

data/test/binding_repl_auto_test.rb

@@ -1,5 +1,5 @@
 require_relative "setup"
-class BindingReplAutoTest < Test::Unit::TestCase
+class BindingReplAutoTest < MiniTest::Test
   include BindingRepl::Mock
   def setup
     @before = BindingRepl.auto_order
@@ -25,13 +25,21 @@ class BindingReplAutoTest < Test::Unit::TestCase
 
   def test_no_matches_on_auto
     BindingRepl.auto_order = []
-    e = assert_raise(LoadError) {binding.repl.auto}
-    assert_equal "no consoles found in Binding.repl.auto_order (empty)", e.message
+    e = assert_raises(LoadError) {binding.repl.auto}
+    assert_equal "no consoles available to load. Binding.repl.auto_order is empty", e.message
   end
 
   def test_no_requireable_console_on_auto
     BindingRepl.auto_order = ["ry", "burp", "orc"]
-    e = assert_raise(LoadError) {binding.repl.auto}
-    assert_equal "no loadable consoles found (searched for ry, burp, orc)", e.message
+    e = assert_raises(LoadError) {binding.repl.auto}
+    assert_equal "attempts to require any of the following consoles failed: ry, burp, orc", e.message
+  end
+
+  def test_auto_on_disable
+    BindingRepl.disable!
+    value = binding.repl.auto
+    assert_equal value.disabled?, true
+  ensure
+    BindingRepl.enable!
   end
 end

data/test/binding_repl_env_test.rb

@@ -1,5 +1,5 @@
 require_relative "setup"
-class BindingReplEnvTest < Test::Unit::TestCase
+class BindingReplEnvTest < MiniTest::Test
   def teardown
     ENV.delete "disable_rc"
     ENV.delete "auto_order"

data/test/binding_repl_irb_test.rb

@@ -1,6 +1,6 @@
 require_relative "setup"
 require "irb"
-class BindingReplIrbTest < Test::Unit::TestCase
+class BindingReplIrbTest < MiniTest::Test
   include BindingRepl::Mock
   def test_irb
     expect_any_instance_of(::IRB::Irb).to receive(:eval_input)

data/test/binding_repl_pry_test.rb

@@ -1,5 +1,5 @@
 require_relative "setup"
-class BindingReplPryTest < Test::Unit::TestCase
+class BindingReplPryTest < MiniTest::Test
   include BindingRepl::Mock
   def test_pry
     expect(Pry).to receive(:start).with(instance_of(Binding), {})

data/test/binding_repl_rcfile_test.rb

@@ -3,7 +3,7 @@ testcase = if defined?(Rubinius)
   # skip Rubinius (breaks with FakeFS).
   Object
 else
-  Test::Unit::TestCase
+  MiniTest::Test
 end
 
 class BindingReplRCFileTest < testcase
@@ -11,6 +11,7 @@ class BindingReplRCFileTest < testcase
   FILENAME = File.basename BindingRepl::RCFile.path
 
   def setup
+    @before = BindingRepl.auto_order
     FakeFS.activate!
     dir = FakeFS::FileSystem.add DIR
     file = FakeFS::FakeFile.new FILENAME, dir
@@ -22,6 +23,7 @@ class BindingReplRCFileTest < testcase
   end
 
   def teardown
+    BindingRepl.auto_order = @before
     FakeFS.deactivate!
   end
 

data/test/binding_repl_rib_test.rb

@@ -1,5 +1,5 @@
 require_relative "setup"
-class BindingReplRibTest < Test::Unit::TestCase
+class BindingReplRibTest < MiniTest::Test
   include BindingRepl::Mock
   def test_rib
     expect(Rib).to receive(:anchor).with(instance_of(Binding), {})

data/test/binding_repl_ripl_test.rb

@@ -1,5 +1,5 @@
 require_relative "setup"
-class BindingReplRiplTest < Test::Unit::TestCase
+class BindingReplRiplTest < MiniTest::Test
   include BindingRepl::Mock
   def test_ripl
     expect(Ripl).to receive(:start).with({binding: instance_of(Binding)})

data/test/setup.rb

@@ -1,4 +1,5 @@
 require "bundler"
-require "test/unit"
 Bundler.require :default, :test
+require "minitest/unit"
+require "minitest/autorun"
 require_relative "support/binding.repl/mock"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: binding.repl
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
-- Robert Gleeson
+- Public Domain
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-05 00:00:00.000000000 Z
+date: 2014-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: toml
@@ -54,7 +54,7 @@ dependencies:
         version: '0'
 description: 'binding.repl: binding.pry for all ruby consoles'
 email:
-- rob@flowof.info
+- robert@flowof.info
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -80,6 +80,7 @@ files:
 - lib/binding.repl/console/ripl.rb
 - lib/binding.repl/core_ext/binding.rb
 - lib/binding.repl/env.rb
+- lib/binding.repl/exit_value.rb
 - lib/binding.repl/rcfile.rb
 - lib/binding.repl/version.rb
 - test/binding_repl_auto_test.rb
@@ -98,11 +99,11 @@ metadata: {}
 post_install_message: |2+
 
     ** binding.repl **
-    Thanks for installing v0.9.0!
+    Thanks for installing v0.10.0!
     Check out ChangeLog.txt to read about what's changed.
 
     ChangeLog.txt
-    https://github.com/robgleeson/binding.repl/blob/v0.9.0/ChangeLog.txt
+    https://github.com/robgleeson/binding.repl/blob/v0.10.0/ChangeLog.txt
 
 rdoc_options: []
 require_paths:
@@ -119,7 +120,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: 'binding.repl: binding.pry for all ruby consoles'
@@ -133,4 +134,3 @@ test_files:
 - test/binding_repl_ripl_test.rb
 - test/setup.rb
 - test/support/binding.repl/mock.rb
-has_rdoc: