rb-readline 0.5.0 → 0.5.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 22a7b0650c257f0c07ce2b14614fba15a32ec32d
+  data.tar.gz: 0c7d5218c36eba3fd676f598353608f03986546d
+SHA512:
+  metadata.gz: 95285288724524d3ecf7becb97180f02c624d8b3e04f4db151a5a40a72a04c8518139a40894bc3d413fd952dd3a9558a1c280b4044d234f654cf502e0b9a25bf
+  data.tar.gz: f3dbc801aadabf874b0abbaf35f76b5fc825b4e256e6eebddda2ea7fc6b146fe349c53a5e2ef4c7dc446719b7f28555fc139cf77978ca347b6b93f7fbe3d2414

data/CHANGES

@@ -1,3 +1,13 @@
+=== 0.5.1 / 2014-01-08
+
+* Bugfixes:
+  * Fix double require issues. Fixes #93, #95 [yui-knk]
+  * Use Fiddle to remove deprecation warning of DL. Fixes #90, #87 [Olipro]
+
+* Internal:
+  * Bundler-friendly repository (gemspec and Gemfile) to ease usage
+    and development.
+
 === 0.5.0 / 2013-04-28
 
 * Enhancements:

data/Rakefile

@@ -1,51 +1,14 @@
 require 'rubygems/package_task'
 require 'rake/testtask'
 
-$:.unshift File.join(File.dirname(__FILE__), 'lib')
-require 'rbreadline'
-
-spec = Gem::Specification.new do |s|
-  # basic information
-  s.name        = "rb-readline"
-  s.version     = RbReadline::RB_READLINE_VERSION
-  s.platform    = Gem::Platform::RUBY
-
-  # description and details
-  s.summary     = 'Pure-Ruby Readline Implementation'
-  s.description = "The readline library provides a pure Ruby implementation of the GNU readline C library, as well as the Readline extension that ships as part of the standard library."
-
-  # requirements
-  s.required_ruby_version = ">= 1.8.6"
-  s.required_rubygems_version = ">= 1.3.5"
-
-  # development dependencies
-  s.add_development_dependency 'rake'
-
-  # components, files and paths
-  s.files = FileList["{examples,lib,test}/**/*.rb",
-                      "README.rdoc", "LICENSE", "CHANGES", "Rakefile", "setup.rb"]
-
-  s.require_path = 'lib'
-
-  # documentation
-  s.rdoc_options << '--main'  << 'README.rdoc' << '--title' << 'Rb-Readline - Documentation'
-
-  s.extra_rdoc_files = %w(README.rdoc LICENSE CHANGES)
-
-  # project information
-  s.homepage          = 'http://github.com/luislavena/rb-readline'
-  s.licenses          = ['BSD']
-
-  # author and contributors
-  s.authors     = ['Park Heesob', 'Daniel Berger', 'Luis Lavena']
-  s.email       = ['phasis@gmail.com', 'djberg96@gmail.com', 'luislavena@gmail.com']
-end
+spec = Gem::Specification.load "rb-readline.gemspec"
 
 Gem::PackageTask.new(spec) do |pkg|
-  pkg.need_zip = true
 end
 
 Rake::TestTask.new do |t|
+  t.libs << "test"
+
   t.warning = true
   t.verbose = true
 end
@@ -53,7 +16,7 @@ end
 desc "Install the gem locally"
 task :install => :gem do
   Dir.chdir(File.dirname(__FILE__)) do
-    sh %{gem install --local pkg/#{spec.name}-#{spec.version}}
+    sh %{gem install --local pkg/#{spec.name}-#{spec.version}.gem}
   end
 end
 

data/bench/_rl_adjust_point.rb

@@ -0,0 +1,26 @@
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib/"
+require 'rbreadline'
+require 'benchmark'
+
+N = 100_000
+
+Benchmark.bmbm do |x|
+  x.report do
+    N.times { RbReadline._rl_adjust_point("a", 0) }
+  end
+  x.report do
+    N.times { RbReadline._rl_adjust_point("a", 1) }
+  end
+  x.report do
+    N.times { RbReadline._rl_adjust_point("aaaaaaaaaaaaaaaaaaaaa", 0) }
+  end
+  x.report do
+    N.times { RbReadline._rl_adjust_point("aaaaaaaaaaaaaaaaaaaaa", 40) }
+  end
+  x.report do
+    N.times { RbReadline._rl_adjust_point("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", 0) }
+  end
+  x.report do
+    N.times { RbReadline._rl_adjust_point("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", 40) }
+  end
+end

data/lib/rb-readline.rb

@@ -1,23 +1,18 @@
 # encoding: US-ASCII
 
+# Stub file to conform gem name (rb-readline)
+# It forces require of bundled readline instead of any already existing
+# in your Ruby installation. It will avoid any possible warning caused
+# by double require.
 # Remove any Readline module that has been defined so far. This is primarily to
-# catch cases where GBU Readline has already been required. Unfortunately, it
+# catch cases where GNU Readline has already been required. Unfortunately, it
 # is not without problems - any calls to methods like Readline.completion_proc
 # will need to be re-made.
-if defined? Readline
+if (defined? Readline) && (! defined? RbReadline)
   if $DEBUG
     STDERR.puts "Removing old Readline module - redefined by rb-readline."
   end
   Object.send(:remove_const, :Readline)
-end
-
-# This forces require of bundled readline instead of any already existing
-# in your Ruby installation.
-
-# Stub file to conform gem name (rb-readline)
-# It forces require of bundled readline instead of any already existing
-# in your Ruby installation. It will avoid any possible warning caused
-# by double require.
-unless defined?(RbReadline)
   require File.join(File.dirname(__FILE__), 'readline')
 end
+

data/lib/rbreadline.rb

@@ -8,6 +8,8 @@
 #  Copyright (C) 2009 by Park Heesob phasis@gmail.com
 #
 
+require "rbreadline/version"
+
 class Fixnum
   def ord; self; end
 end
@@ -17,7 +19,6 @@ module RbReadline
 
   RL_LIBRARY_VERSION = "5.2"
   RL_READLINE_VERSION  = 0x0502
-  RB_READLINE_VERSION = "0.5.0"
 
   EOF = "\xFF"
   ESC = "\C-["
@@ -1090,7 +1091,10 @@ module RbReadline
   @current_readline_init_include_level = 0
   @current_readline_init_lineno = 0
 
-  ENV["HOME"] ||= ENV["HOMEDRIVE"]+ENV["HOMEPATH"]
+  ENV["HOME"] ||= "#{ENV["HOMEDRIVE"]}#{ENV["HOMEPATH"]}"
+  if !File.directory? ENV["HOME"]
+    raise RuntimeError.new("HOME environment variable (or HOMEDRIVE and HOMEPATH) must be set and point to a directory")
+  end
 
   @directory = nil
   @filename = nil
@@ -4366,25 +4370,24 @@ module RbReadline
     if RUBY_VERSION < '1.9.1'
       require 'Win32API'
     else
-      require 'dl'
+      require 'fiddle'
       class Win32API
         DLL = {}
-        TYPEMAP = {"0" => DL::TYPE_VOID, "S" => DL::TYPE_VOIDP, "I" => DL::TYPE_LONG}
+        TYPEMAP = {"0" => Fiddle::TYPE_VOID, "S" => Fiddle::TYPE_VOIDP, "I" => Fiddle::TYPE_LONG}
+        CALL_TYPE_TO_ABI = {:stdcall => 1, :cdecl => 1, nil => 1} #Taken from Fiddle::Importer
 
         def initialize(dllname, func, import, export = "0", calltype = :stdcall)
-          @proto = [import].join.tr("VPpNnLlIi", "0SSI").sub(/^(.)0*$/, '\1')
-          handle = DLL[dllname] ||= DL.dlopen(dllname)
-          @func = DL::CFunc.new(handle[func], TYPEMAP[export.tr("VPpNnLlIi", "0SSI")], func, calltype)
+          @proto = import.join.tr("VPpNnLlIi", "0SSI").chomp('0').split('')
+          handle = DLL[dllname] ||= Fiddle.dlopen(dllname)
+          @func = Fiddle::Function.new(handle[func], TYPEMAP.values_at(*@proto), CALL_TYPE_TO_ABI[calltype])
         end
 
         def call(*args)
-          import = @proto.split("")
           args.each_with_index do |x, i|
-            args[i], = [x == 0 ? nil : x].pack("p").unpack("l!*") if import[i] == "S"
-            args[i], = [x].pack("I").unpack("i") if import[i] == "I"
+            args[i], = [x == 0 ? nil : x].pack("p").unpack("l!*") if @proto[i] == "S"
+            args[i], = [x].pack("I").unpack("i") if @proto[i] == "I"
           end
-          ret, = @func.call(args)
-          return ret || 0
+          @func.call(*args).to_i || 0
         end
 
         alias Call call
@@ -8186,7 +8189,7 @@ module RbReadline
     case (c)
     when "\C-W"
       rl_unix_word_rubout(1, c)
-    when "\C-W"
+    when "\C-U"
       rl_unix_line_discard(1, c)
     when RETURN,NEWLINE
       return 0

data/lib/rbreadline/version.rb

@@ -0,0 +1,3 @@
+module RbReadline
+  RB_READLINE_VERSION = "0.5.1"
+end

data/lib/readline.rb

@@ -24,11 +24,16 @@ module Readline
   # Because this is meant as an interactive console interface, they should
   # generally not be redirected.
   #
+  # If you would like to add non-visible characters to the the prompt (for 
+  # example to add colors) you must prepend the character \001 (^A) before 
+  # each sequence of non-visible characters and add the character \002 (^B)
+  # after, otherwise line wrapping may not work properly.
+  #
   # Example:
   #
   #    loop{ Readline.readline('> ') }
   #
-  def readline(prompt, add_history=nil)
+  def readline(prompt = "", add_history = nil)
     if $stdin.closed?
       raise IOError, "stdin closed"
     end

data/rb-readline.gemspec

@@ -0,0 +1,51 @@
+# encoding: UTF-8
+
+libdir = File.join(File.dirname(__FILE__), 'lib')
+$LOAD_PATH.unshift(libdir) unless $LOAD_PATH.include?(libdir)
+
+require "rbreadline/version"
+
+spec = Gem::Specification.new do |s|
+  # basic information
+  s.name        = "rb-readline"
+  s.version     = RbReadline::RB_READLINE_VERSION
+  s.platform    = Gem::Platform::RUBY
+
+  # description and details
+  s.summary     = 'Pure-Ruby Readline Implementation'
+  s.description = "The readline library provides a pure Ruby implementation of the GNU readline C library, as well as the Readline extension that ships as part of the standard library."
+
+  # project information
+  s.homepage          = 'http://github.com/luislavena/rb-readline'
+  s.licenses          = ['BSD']
+
+  # author and contributors
+  s.authors     = ['Park Heesob', 'Daniel Berger', 'Luis Lavena']
+  s.email       = ['phasis@gmail.com', 'djberg96@gmail.com', 'luislavena@gmail.com']
+
+  # requirements
+  s.required_ruby_version = ">= 1.8.6"
+  s.required_rubygems_version = ">= 1.3.5"
+
+  # development dependencies
+  s.add_development_dependency 'rake'
+  s.add_development_dependency "minitest", "~> 5.2"
+
+  # components, files and paths
+  s.files = Dir[
+    "{bench,examples,lib,test}/**/*.rb",
+    "README.rdoc",
+    "LICENSE",
+    "CHANGES",
+    "Rakefile",
+    "rb-readline.gemspec",
+    "setup.rb"
+  ]
+
+  s.require_path = 'lib'
+
+  # documentation
+  s.rdoc_options << '--main'  << 'README.rdoc' << '--title' << 'Rb-Readline - Documentation'
+
+  s.extra_rdoc_files = %w(README.rdoc LICENSE CHANGES)
+end

data/test/test_completion.rb

@@ -1,9 +1,10 @@
-require "test/unit"
-require 'timeout'
+require "minitest/autorun"
 require "readline"
-require "#{File.expand_path(File.dirname(__FILE__))}/filesystem_completion_helper"
 
-class TestCompletion < Test::Unit::TestCase
+require 'timeout'
+require "support/filesystem_completion_helper"
+
+class TestCompletion < Minitest::Test
   include RbReadline
   include FilesystemCompletionHelper
 
@@ -55,10 +56,8 @@ class TestCompletion < Test::Unit::TestCase
   def test__find_completion_word_doesnt_hang_on_completer_quote_character
     set_line_buffer "#{@dir_with_spaces.path}filename\\ w"
 
-    assert_nothing_raised do
-      Timeout::timeout(3) do
-        assert_equal([ "\000", true, "\000" ], _rl_find_completion_word)
-      end
+    Timeout::timeout(3) do
+      assert_equal([ "\000", true, "\000" ], _rl_find_completion_word)
     end
   end
 

data/test/test_filename_completion_proc.rb

@@ -1,10 +1,11 @@
-require 'test/unit'
-require 'fileutils'
+require 'minitest/autorun'
 require 'readline'
+
+require 'fileutils'
 require "rbconfig"
-require "#{File.expand_path(File.dirname(__FILE__))}/filesystem_completion_helper"
+require "support/filesystem_completion_helper"
 
-class TestFilenameCompletionProc < Test::Unit::TestCase
+class TestFilenameCompletionProc < Minitest::Test
   include FilesystemCompletionHelper
 
   def setup

data/test/test_history.rb

@@ -1,15 +1,15 @@
-require "test/unit"
+require "minitest/autorun"
 require "readline"
 
-class TestHistory < Test::Unit::TestCase
+class TestHistory < Minitest::Test
 
   # RbReadline::HISTORY_WORD_DELIMITERS.inspect
   # => " \t\n;&()|<>"
   # RbReadline::HISTORY_QUOTE_CHARACTERS   = "\"'`"
   # => "\"'`"
   def test_history_arg_extract
-    assert_raise(RuntimeError) { RbReadline.history_arg_extract("!", "$", "one two three") }
-    assert_raise(RuntimeError) { RbReadline.history_arg_extract("$", "!", "one two three") }
+    assert_raises(RuntimeError) { RbReadline.history_arg_extract("!", "$", "one two three") }
+    assert_raises(RuntimeError) { RbReadline.history_arg_extract("$", "!", "one two three") }
 
     assert_equal "one", RbReadline.history_arg_extract("$", "$", "one")
     assert_equal "three", RbReadline.history_arg_extract("$", "$", "one two three")

data/test/test_rbreadline.rb

@@ -1,7 +1,7 @@
-require 'test/unit'
+require 'minitest/autorun'
 require 'rbreadline'
 
-class TestRbReadline < Test::Unit::TestCase
+class TestRbReadline < Minitest::Test
   def test_versions
     assert_equal('5.2', RbReadline::RL_LIBRARY_VERSION)
     assert_equal(0x0502, RbReadline::RL_READLINE_VERSION)

data/test/test_readline.rb

@@ -1,7 +1,7 @@
-require 'test/unit'
+require 'minitest/autorun'
 require 'readline'
 
-class TestReadline < Test::Unit::TestCase
+class TestReadline < Minitest::Test
   def setup
     @proc = proc{ |s| ['alpha', 'beta'].grep( /^#{Regexp.escape(s)}/) }
   end
@@ -14,8 +14,12 @@ class TestReadline < Test::Unit::TestCase
     assert_respond_to(Readline, :readline)
   end
 
-  def test_readline_expected_errors
-    assert_raise(ArgumentError){ Readline.readline }
+  def test_readline_with_default_parameters_does_not_error
+    thread = Thread.new { Readline.readline }
+    sleep 0.1
+    assert thread.alive?
+  ensure
+    thread.kill
   end
 
   def test_input_basic
@@ -23,7 +27,8 @@ class TestReadline < Test::Unit::TestCase
   end
 
   def test_input
-    assert_nothing_raised{ Readline.input = $stdin }
+    Readline.input = $stdin
+    assert_equal $stdin, RbReadline.rl_instream
   end
 
   def test_output_basic
@@ -31,7 +36,8 @@ class TestReadline < Test::Unit::TestCase
   end
 
   def test_output
-    assert_nothing_raised{ Readline.output = $stdout }
+    Readline.output = $stdout
+    assert_equal $stdout, RbReadline.rl_outstream
   end
 
   def test_completion_proc_get_basic
@@ -43,7 +49,8 @@ class TestReadline < Test::Unit::TestCase
   end
 
   def test_completion_proc
-    assert_nothing_raised{ Readline.completion_proc = @proc }
+    Readline.completion_proc = @proc
+    assert_equal @proc, Readline.completion_proc
   end
 
   def test_completion_case_fold_get_basic
@@ -59,12 +66,13 @@ class TestReadline < Test::Unit::TestCase
   end
 
   def test_completion_case_fold_changed
-    assert_nothing_raised{ Readline.completion_case_fold = false }
+    Readline.completion_case_fold = false
+    refute Readline.completion_case_fold
   end
 
   def test_completion_proc_expected_errors
-    assert_raise(ArgumentError){ Readline.completion_proc = 1 }
-    assert_raise(ArgumentError){ Readline.completion_proc = 'a' }
+    assert_raises(ArgumentError) { Readline.completion_proc = 1 }
+    assert_raises(ArgumentError) { Readline.completion_proc = 'a' }
   end
 
   def test_vi_editing_mode_basic
@@ -88,7 +96,7 @@ class TestReadline < Test::Unit::TestCase
   end
 
   def test_completion_append_character_set
-    assert_nothing_raised{ Readline.completion_append_character }
+    assert_equal " ", Readline.completion_append_character
   end
 
   def test_completion_append_character
@@ -123,7 +131,9 @@ class TestReadline < Test::Unit::TestCase
   end
 
   def test_basic_word_break_characters_set
-    assert_nothing_raised{ Readline.basic_word_break_characters = " \t\n\"\\'`@$><=|&{(" }
+    chars = " \t\n\"\\'`@$><=|&{("
+    Readline.basic_word_break_characters = chars
+    assert_equal chars, Readline.basic_word_break_characters
   end
 
   def test_basic_quote_characters_get_basic
@@ -131,8 +141,7 @@ class TestReadline < Test::Unit::TestCase
   end
 
   def test_basic_quote_characters_get
-    assert_nothing_raised{ Readline.basic_quote_characters }
-    assert_equal("\"'", Readline.basic_quote_characters)
+    assert_equal "\"'", Readline.basic_quote_characters
   end
 
   def test_basic_quote_characters_set_basic
@@ -140,7 +149,9 @@ class TestReadline < Test::Unit::TestCase
   end
 
   def test_basic_quote_characters_set
-    assert_nothing_raised{ Readline.basic_quote_characters = "\"'" }
+    chars = "\"'"
+    Readline.basic_quote_characters = chars
+    assert_equal chars, Readline.basic_quote_characters
   end
 
   def test_some_character_methods
@@ -181,6 +192,7 @@ class TestReadline < Test::Unit::TestCase
     assert_equal [ "123abc", nil, nil ], Readline.readline_attempted_completion_function("123A", 0, 3)
 
   ensure
+    Readline.completion_case_fold = false
     Readline.module_eval do
       @completion_proc = nil
     end

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rb-readline
 version: !ruby/object:Gem::Version
-  version: 0.5.0
-  prerelease: 
+  version: 0.5.1
 platform: ruby
 authors:
 - Park Heesob
@@ -11,24 +10,36 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-28 00:00:00.000000000 Z
+date: 2014-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5.2'
 description: The readline library provides a pure Ruby implementation of the GNU readline
   C library, as well as the Readline extension that ships as part of the standard
   library.
@@ -43,13 +54,15 @@ extra_rdoc_files:
 - LICENSE
 - CHANGES
 files:
+- bench/_rl_adjust_point.rb
 - examples/example_readline.rb
 - examples/example_readline_with_completion.rb
 - examples/tinyirb.rb
 - lib/rb-readline.rb
+- lib/rbreadline/version.rb
 - lib/rbreadline.rb
 - lib/readline.rb
-- test/filesystem_completion_helper.rb
+- test/support/filesystem_completion_helper.rb
 - test/test_completion.rb
 - test/test_filename_completion_proc.rb
 - test/test_history.rb
@@ -59,10 +72,12 @@ files:
 - LICENSE
 - CHANGES
 - Rakefile
+- rb-readline.gemspec
 - setup.rb
 homepage: http://github.com/luislavena/rb-readline
 licenses:
 - BSD
+metadata: {}
 post_install_message: 
 rdoc_options:
 - --main
@@ -72,21 +87,19 @@ rdoc_options:
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: 1.8.6
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: 1.3.5
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.0.14
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Pure-Ruby Readline Implementation
 test_files: []