binding.repl 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
----
-SHA1:
-  metadata.gz: c545da807e38567cab20601c50fdd8ffd36f8fad
-  data.tar.gz: 623dd1a001140557e2f1ee8821bf2d0630fe5384
-SHA512:
-  metadata.gz: ceb58d6786c6d564cea9b3f9c37ef251b4494d1f9547b2a18e7c202ab7d6f02cfb200c2da165156b3e239a10528c5d06b11024d28670f896e534d287ff2b27b1
-  data.tar.gz: d211a14e759a9d1cf1a5c747bdd38ba9dc3178c1512de577bb5d0f6b2315110b779f2d28d7b73b9a98f8a2cc4857d86781e003b9c25a707c71384b5abaa92540
+--- 
+SHA1: 
+  metadata.gz: cffcaf44dd2b6fa21dc2193251407a26f8bbd8be
+  data.tar.gz: 992180899557219bc351a42762061616c19e7242
+SHA512: 
+  metadata.gz: 4d27fb0d57feb67ba74c351043d3512b6a9edc942d607a95a1f0fdf0069d6d4b75e8017b3b15a017491c77d8b6d15ebbe6a68077fd465f25a9d88594fabbc750
+  data.tar.gz: 405ccf998fc7816a63033e694170058eddb2dd3a0d7a83bd9a5172a2d62a5bcf82584e073d1f94896b7c7d46510db7d43cc29984bade4406e624036fa2730a03

data/.pryrc

@@ -1,3 +1,2 @@
-ENV["BINDING_REPL_RC"] = "0"
-require "bundler/setup"
-require "binding.repl"
+require "bundler"
+Bundler.require :default

data/ChangeLog.txt

@@ -1,3 +1,8 @@
+== v1.0.1 (2014-02-10)
+  - BindingRepl::ENV.auto_order is lazy loaded and not on 'require'.
+  - remove sample file ".binding.repl.rc" from repository and rubygem. (forgot in v1.0.0)
+  - remove BindingRepl::ENV.enable_rc_file? (forgot in v1.0.0)
+
 == v1.0.0 (2014-02-09)
   - add binding.repl!
   a shortcut to `binding.repl.auto`. (#26)

data/doc/disableatruntime.md

@@ -1,20 +1,23 @@
-__ENABLE/DISABLE AT RUNTIME__
+__ENABLE OR DISABLE AT RUNTIME__
 
-binding.repl can be enabled or disabled at runtime. by default, it is enabled.
-to disable, you'd write something like:
+binding.repl can be enabled or disabled at runtime. <br>
+the default state is 'enabled'.
+
+__DISABLE__
 
 ```ruby
 class Foo
-  Binding.repl.disable!
-  binding.repl.irb # does nothing. execution continues.
+  BindingRepl.disable!
+  value = binding.repl.irb
+  p value.disabled? # => true
 end
 ```
 
-it can be re-enabled just as easily:
+__ENABLE__
 
 ```ruby
 class Foo
-  Binding.repl.enable!
-  binding.repl.irb # opens an IRB session inside class 'Foo'
+  BindingRepl.enable!
+  value = binding.repl.irb # opens irb on 'Foo'.
 end
 ```

data/doc/runtimeoptions.md

@@ -1,42 +1,46 @@
 __RUNTIME OPTIONS__
 
-__pry__
+_pry_
 
-pry can be started with options that are forwarded to [Pry.start(…)](http://rubydoc.info/github/banister/pry/Pry#start-class_method) (API docs).
+[pry](https://github.com/pry/pry) supports a large number of options for runtime configuration. <br>
+a full list of options are available at [Pry.start(…) (API Docs)](http://rubydoc.info/github/banister/pry/Pry#start-class_method)
 
 ```ruby
-class Foo
+class Person
   binding.repl.pry quiet: true
 end
 ```
 
-__ripl__
+_rib_
 
-ripl can be started with options that are forwarded to `Ripl.start(…)`.
-unfortunately, `Ripl.start(…)` has no API documentation.
-check out [its github page](https://github.com/cldwalker/ripl) for more information.
+[rib](https://github.com/godfat/rib) is a little less well known ruby repl that binding.repl supports since v0.8.0. <br>
+a full list of options are available at [Rib.anchor(…) (API Docs)](http://rdoc.info/github/godfat/rib/Rib/Anchor/Imp#anchor-instance_method)
 
 ```ruby
-class Foo
-  binding.repl.ripl riplrc: false
+class Alien
+  binding.repl.rib prompt: ">> ", result_prompt: "# => "
 end
 ```
 
-__rib__
-
-[rib](https://github.com/godfat/rib) is a little less well known ruby console that binding.repl
-supports since v0.8.0. it can be configured to change the prompt and the prefix inserted before
-a return value.
+_ripl_
 
-rib can be started with options that are forwarded to
-[Rib.anchor(…)](http://rdoc.info/github/godfat/rib/Rib/Anchor/Imp#anchor-instance_method) (API docs).
+[ripl](https://github.com/cldwalker/ripl) supports (some) runtime configuration. <br>
+I couldn't find API docs for `Ripl.start(..)`, so I recommend checking out the github
+page to learn more.
 
 ```ruby
-class Foo
-  binding.repl.rib prompt: ">> ", result_prompt: "# => "
+class Sink
+  binding.repl.ripl riplrc: false
 end
 ```
 
-__irb__
+_note about irb_
 
-binding.repl doesn't implement any runtime options for IRB.
+binding.repl doesn't implement runtime options for IRB because it wasn't immediately obvious
+how IRB is configured at runtime (it looks like `IRB.conf` might be used)
+
+```ruby
+class Car
+  binding.repl.irb
+end
+```

data/lib/binding.repl.rb

@@ -1,7 +1,15 @@
 class BindingRepl
   LOOKUP = {}
   LOOKUP.default = [proc { true }, proc { :'binding.repl.unknown_console' }]
-  singleton_class.class_eval { attr_accessor :auto_order }
+  DEFAULT_AUTO_ORDER = ["pry", "ripl", "rib", "irb"].freeze
+
+  def self.auto_order=(list)
+    @auto_order = list
+  end
+
+  def self.auto_order
+    @auto_order or BindingRepl::ENV.auto_order or DEFAULT_AUTO_ORDER
+  end
 
   #
   # returns true when binding.repl is disabled.
@@ -74,10 +82,10 @@ class BindingRepl
   #   returns an instance of {BindingRepl::ExitValue} when the repl has exited.
   #
   def auto
-    consoles = Binding.repl.auto_order
+    consoles = BindingRepl.auto_order
     value = run_any_console(consoles)
     if consoles.empty?
-      raise LoadError, "no consoles available to load. Binding.repl.auto_order is empty"
+      raise LoadError, "no consoles available to load. BindingRepl.auto_order is empty"
     elsif value.nil?
       consoles_str = consoles.join(", ")
       raise LoadError, "attempts to require any of the following consoles failed: #{consoles_str}"
@@ -101,7 +109,7 @@ private
 
   def run_console(console, options = {})
     console = console.to_s
-    if Binding.repl.disabled?
+    if BindingRepl.disabled?
       value = BindingRepl::ExitValue.disabled_value
     else
       initializer, runner = @lookup[console]
@@ -115,7 +123,6 @@ private
     return BindingRepl::ExitValue.new(value)
   end
 end
-
 require_relative "binding.repl/core_ext/binding"
 require_relative "binding.repl/env"
 require_relative "binding.repl/exit_value"
@@ -124,4 +131,3 @@ 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.auto_order = BindingRepl::ENV.auto_order

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

@@ -8,4 +8,4 @@ runner = lambda do |binding, options|
   trap("SIGINT") { irb.signal_handle }
   catch(:IRB_EXIT) { irb.eval_input }
 end
-Binding.repl.add :irb, initializer, runner
+BindingRepl.add :irb, initializer, runner

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

@@ -4,4 +4,4 @@ end
 runner = lambda do |binding, options|
   binding.pry(options)
 end
-Binding.repl.add :pry, initializer, runner
+BindingRepl.add :pry, initializer, runner

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

@@ -5,4 +5,4 @@ end
 runner = lambda do |binding, options|
   Rib.anchor binding, options
 end
-Binding.repl.add :rib, initializer, runner
+BindingRepl.add :rib, initializer, runner

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

@@ -4,4 +4,4 @@ end
 runner = lambda do |binding, options|
   Ripl.start options.merge(binding: binding)
 end
-Binding.repl.add :ripl, initializer, runner
+BindingRepl.add :ripl, initializer, runner

data/lib/binding.repl/core_ext/binding.rb

@@ -4,7 +4,7 @@ class Binding
   end
 
   def repl
-    Binding.repl.new(self)
+    BindingRepl.new(self)
   end
 
   def repl!

data/lib/binding.repl/env.rb

@@ -1,15 +1,10 @@
 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 auto_order
-    env_order = @env['auto_order'].to_s.split(DELIMITER_REGEXP)
-    env_order.empty? ? DEFAULT_AUTO_ORDER : env_order
+    list = @env['auto_order'].to_s.split(DELIMITER_REGEXP)
+    list.empty? ? nil : list
   end
+  module_function :auto_order
 end

data/lib/binding.repl/version.rb

@@ -1,5 +1,5 @@
 class BindingRepl
-  VERSION = "1.0.0".freeze
+  VERSION = "1.0.1".freeze
   def self.version
     VERSION
   end

data/test/binding_repl_auto_test.rb

@@ -26,7 +26,7 @@ class BindingReplAutoTest < MiniTest::Test
   def test_no_matches_on_auto
     BindingRepl.auto_order = []
     e = assert_raises(LoadError) {binding.repl.auto}
-    assert_equal "no consoles available to load. Binding.repl.auto_order is empty", e.message
+    assert_equal "no consoles available to load. BindingRepl.auto_order is empty", e.message
   end
 
   def test_no_requireable_console_on_auto

data/test/binding_repl_env_test.rb

@@ -1,26 +1,12 @@
 require_relative "setup"
 class BindingReplEnvTest < MiniTest::Test
   def teardown
-    ENV.delete "disable_rc"
     ENV.delete "auto_order"
   end
 
-  def test_default_of_enable_rc_file?
-    assert_equal true, BindingRepl::ENV.enable_rc_file?
-  end
-
-  def test_disable_of_rc_file_with_true
-    ENV["disable_rc"] = 'true'
-    assert_equal false, BindingRepl::ENV.enable_rc_file?
-  end
-
-  def test_disable_of_rc_file_with_one
-    ENV["disable_rc"] = '1'
-    assert_equal false, BindingRepl::ENV.enable_rc_file?
-  end
-
-  def test_default_of_auto_order
-    assert_equal BindingRepl::ENV::DEFAULT_AUTO_ORDER, BindingRepl.auto_order
+  def test_unset_auto_order_shell_var
+    ENV["auto_order"] = nil
+    assert_equal nil, BindingRepl::ENV.auto_order
   end
 
   def test_auto_order_defined_by_shell

data/test/binding_repl_test.rb

@@ -0,0 +1,24 @@
+require_relative "setup"
+class BindingReplTest < MiniTest::Test
+  def setup
+    @before = BindingRepl.auto_order.dup
+  end
+
+  def teardown
+    BindingRepl.auto_order = @before
+  end
+
+  def test_default_return_value_of_auto_order
+    assert_equal BindingRepl::DEFAULT_AUTO_ORDER, BindingRepl.auto_order
+  end
+
+  def test_set_of_new_auto_order
+    BindingRepl.auto_order = ["a", "b"]
+    assert_equal ["a", "b"], BindingRepl.auto_order
+  end
+
+  def test_set_of_nil_on_auto_order
+    BindingRepl.auto_order = nil
+    assert_equal BindingRepl::DEFAULT_AUTO_ORDER, BindingRepl.auto_order
+  end
+end

metadata

@@ -1,26 +1,30 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: binding.repl
-version: !ruby/object:Gem::Version
-  version: 1.0.0
+version: !ruby/object:Gem::Version 
+  version: 1.0.1
 platform: ruby
-authors:
+authors: 
 - Public Domain
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-09 00:00:00.000000000 Z
+
+date: 2014-02-10 00:00:00 Z
 dependencies: []
+
 description: binding.repl can start a number of different ruby consoles at runtime
-email:
+email: 
 - robert@flowof.info
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
-- ".binding.repl.rc"
-- ".gitignore"
-- ".pryrc"
-- ".travis.yml"
+
+files: 
+- .gitignore
+- .pryrc
+- .travis.yml
 - ChangeLog.txt
 - Gemfile
 - README.md
@@ -46,6 +50,7 @@ files:
 - test/binding_repl_pry_test.rb
 - test/binding_repl_rib_test.rb
 - test/binding_repl_ripl_test.rb
+- test/binding_repl_test.rb
 - test/binding_test.rb
 - test/isolation/lazy_irb_require_test.rb
 - test/isolation/lazy_pry_require_test.rb
@@ -54,39 +59,40 @@ files:
 - test/setup.rb
 - test/support/binding.repl/rspec_mocks.rb
 homepage: https://github.com/robgleeson/binding.repl
-licenses:
+licenses: 
 - Public Domain
 metadata: {}
-post_install_message: |2
-    == binding.repl v1.0.0
-    ChangeLog.txt:
-    https://github.com/robgleeson/binding.repl/blob/v1.0.0/ChangeLog.txt
+
+post_install_message: "  == binding.repl v1.0.1\n  ChangeLog.txt:\n  https://github.com/robgleeson/binding.repl/blob/v1.0.1/ChangeLog.txt\n"
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
-  requirements:
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
   - - ">="
-    - !ruby/object:Gem::Version
+    - !ruby/object:Gem::Version 
       version: 1.9.2
-required_rubygems_version: !ruby/object:Gem::Requirement
-  requirements:
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
   - - ">="
-    - !ruby/object:Gem::Version
-      version: '0'
+    - !ruby/object:Gem::Version 
+      version: "0"
 requirements: []
+
 rubyforge_project: 
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: binding.repl can start a number of different ruby consoles at runtime
-test_files:
+test_files: 
 - test/binding_repl_auto_test.rb
 - test/binding_repl_env_test.rb
 - test/binding_repl_irb_test.rb
 - test/binding_repl_pry_test.rb
 - test/binding_repl_rib_test.rb
 - test/binding_repl_ripl_test.rb
+- test/binding_repl_test.rb
 - test/binding_test.rb
 - test/isolation/lazy_irb_require_test.rb
 - test/isolation/lazy_pry_require_test.rb
@@ -94,3 +100,4 @@ test_files:
 - test/isolation/lazy_ripl_require_test.rb
 - test/setup.rb
 - test/support/binding.repl/rspec_mocks.rb
+has_rdoc: 

data/.binding.repl.rc

@@ -1,3 +0,0 @@
-# sample file.
-[auto]
-  order = ["irb", "rib", "pry", "ripl"]