mini_readline 0.4.5 → 0.4.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 036a267e5f913c165c795d8eb4d01b7eff0a88f9
-  data.tar.gz: b640e8b80bbde9bdfd152d6f2be76ec8745b137a
+  metadata.gz: 72da0352d9a3adb0946c9902542b9f79f8c01260
+  data.tar.gz: 4025883e28e90d1258818b51c9f30c7c3dc680e6
 SHA512:
-  metadata.gz: b940dda8bd5c0f5c24c2790da4826d88da238504d534446d25f27273b851f25e9999e0288279999cd0c2aeacc4a8114dbbc7863de8ce90413d2f624c4f65dc81
-  data.tar.gz: a0b925c9bb7b1ae802c9de0a8bdd8b2d2f7df4ce4ebe4348f5cdb8ed56261565e64cd991e3fa4707adc988e4e43cae274f0aa2fa55e00900c93c67c8d0c79f09
+  metadata.gz: 17cf75c0a4f72b861b37343b183b2bfa48d61b8db58bf62f35ea4b9335e476f8390e64fb23397ed60df7139364a0d3cc5f795aeeb4579f56d4a701c14bb36002
+  data.tar.gz: e50bd96abeb77a6ecb9baf4784f6482f00fb3c7030d542fa9daae1126c6650529476b03de3612d2ec68811e72c2eccff51ba7ddd562b5d82b0863cea9540c4f4

data/README.md

@@ -63,13 +63,6 @@ The typical way of utilizing this gem is to place the following:
 ```ruby
 require 'mini_readline'
 ```
-By default, the constant Readline is set to the MiniReadline module. If this
-is not desired use the following:
-
-```ruby
-$no_alias_read_line_module = true
-require 'mini_readline'
-```
 
 ### Compatible Mode
 
@@ -96,6 +89,36 @@ and
 MiniReadline.readline('>', false)
 ```
 
+##### Module Aliasing
+
+For enhanced compatibility, the mini_readline gem has the ability to alias
+itself as the readline gem. This ability is subject to the following list
+of conditions.
+
+1) If the global variable $no_alias_read_line_module is set to true before the
+mini_readline gem is required, *no* aliasing will take place.
+```ruby
+$no_alias_read_line_module = true
+require 'mini_readline'
+```
+2) Else, if the global variable $force_alias_read_line_module is set to true
+before the mini_readline gem is required, aliasing *will* take place.
+```ruby
+$force_alias_read_line_module = true
+require 'mini_readline'
+```
+3) Else, if the readline gem is already loaded, *no* aliasing will take place.
+```ruby
+require 'readline'
+require 'mini_readline'
+```
+4) Finally, if none of the above conditions are met, aliasing *will* take place.
+```ruby
+require 'mini_readline'
+```
+Note that if the readline gem is subsequently required after the mini_readline
+gem, it will redefine the Readline constant, generating a warning message on
+$stderr.
 
 ### Native Mode
 

data/lib/mini_readline.rb

@@ -27,8 +27,28 @@ module MiniReadline
   def self.readline(prompt, history = nil)
     @reader.readline(prompt: prompt, history: history)
   end
+
+  #A stub.
+  def self.input=(input)
+    input
+  end
+
+  #A stub.
+  def self.output=(output)
+    output
+  end
+
 end
 
-unless defined?($no_alias_read_line_module) && $no_alias_read_line_module
-    Readline = MiniReadline
+#Optionally: Setup the module alias for Readline
+begin
+  old_stderr = $stderr
+  $stderr = File.open(File::NULL, 'w')
+
+  if !$no_alias_read_line_module&&($force_alias_read_line_module||!defined? Readline)
+      Readline = MiniReadline
+  end
+ensure
+  $stderr.close
+  $stderr = old_stderr
 end

data/lib/mini_readline/version.rb

@@ -1,4 +1,4 @@
 module MiniReadline
   #The current version of the mini_readline gem.
-  VERSION = "0.4.5"
+  VERSION = "0.4.6"
 end

data/{Rakefile → rakefile.rb}

@@ -28,6 +28,17 @@ Rake::TestTask.new do |t|
   t.verbose = false
 end
 
+desc "Fire up an IRB session with mini_readline."
+task :console do
+  require 'irb'
+  require 'irb/completion'
+  $force_alias_read_line_module = true
+  require './lib/mini_readline'
+  puts "Starting an IRB console with mini_readline."
+  ARGV.clear
+  IRB.start
+end
+
 desc "Run a scan for smelly code!"
 task :reek do |t|
   `reek --no-color lib > reek.txt`

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mini_readline
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: 0.4.6
 platform: ruby
 authors:
 - Peter Camilleri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-24 00:00:00.000000000 Z
+date: 2016-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -79,7 +79,6 @@ files:
 - Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
 - lib/mini_readline.rb
 - lib/mini_readline/exceptions.rb
 - lib/mini_readline/options.rb
@@ -125,6 +124,7 @@ files:
 - lib/mini_readline/version.rb
 - mini_readline.gemspec
 - mini_readline.reek
+- rakefile.rb
 - reek.txt
 - sire.rb
 - tests/mini_readline_tests.rb