rubysl-readline 0.0.1 → 1.0.0

data/lib/readline.rb

@@ -0,0 +1 @@
+require "rubysl/readline"

data/lib/rubysl/readline.rb

@@ -0,0 +1,2 @@
+require "readline/readline"
+require "rubysl/readline/version"

data/lib/{rubysl-readline → rubysl/readline}/version.rb

@@ -1,5 +1,5 @@
 module RubySL
   module Readline
-    VERSION = "0.0.1"
+    VERSION = "1.0.0"
   end
 end

data/rubysl-readline.gemspec

@@ -1,22 +1,24 @@
-# -*- encoding: utf-8 -*-
-require File.expand_path('../lib/rubysl-readline/version', __FILE__)
+# coding: utf-8
+require './lib/rubysl/readline/version'
 
-Gem::Specification.new do |gem|
-  gem.authors       = ["Brian Shirai"]
-  gem.email         = ["brixen@gmail.com"]
-  gem.description   = %q{Ruby Standard Library - readline}
-  gem.summary       = %q{Ruby Standard Library - readline}
-  gem.homepage      = ""
+Gem::Specification.new do |spec|
+  spec.name          = "rubysl-readline"
+  spec.version       = RubySL::Readline::VERSION
+  spec.authors       = ["Brian Shirai"]
+  spec.email         = ["brixen@gmail.com"]
+  spec.description   = %q{Ruby standard library readline.}
+  spec.summary       = %q{Ruby standard library readline.}
+  spec.homepage      = "https://github.com/rubysl/rubysl-readline"
+  spec.license       = "BSD"
 
-  gem.files         = `git ls-files`.split($\)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.name          = "rubysl-readline"
-  gem.require_paths = ["lib"]
-  gem.version       = RubySL::Readline::VERSION
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.extensions    = ["ext/rubysl/readline/extconf.rb"]
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
 
-  gem.add_runtime_dependency "redcard", "~> 1.0"
-
-  gem.add_development_dependency "rake",  "~> 10.0"
-  gem.add_development_dependency "mspec", "~> 1.5"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "mspec", "~> 1.5"
+  spec.add_development_dependency "rubysl-prettyprint", "~> 1.0"
 end

data/spec/basic_quote_characters_spec.rb

@@ -0,0 +1,18 @@
+process_is_foreground do
+  with_feature :readline do
+    require 'readline'
+
+    describe "Readline.basic_quote_characters" do
+      it "returns not nil" do
+        Readline.basic_quote_characters.should_not be_nil
+      end
+    end
+
+    describe "Readline.basic_quote_characters=" do
+      it "returns the passed string" do
+        Readline.basic_quote_characters = "test"
+        Readline.basic_quote_characters.should == "test"
+      end
+    end
+  end
+end

data/spec/basic_word_break_characters_spec.rb

@@ -0,0 +1,18 @@
+process_is_foreground do
+  with_feature :readline do
+    require 'readline'
+
+    describe "Readline.basic_word_break_characters" do
+      it "returns not nil" do
+        Readline.basic_word_break_characters.should_not be_nil
+      end
+    end
+
+    describe "Readline.basic_word_break_characters=" do
+      it "returns the passed string" do
+        Readline.basic_word_break_characters = "test"
+        Readline.basic_word_break_characters.should == "test"
+      end
+    end
+  end
+end

data/spec/completer_quote_characters_spec.rb

@@ -0,0 +1,18 @@
+process_is_foreground do
+  with_feature :readline do
+    require 'readline'
+
+    describe "Readline.completer_quote_characters" do
+      it "returns nil" do
+        Readline.completer_quote_characters.should be_nil
+      end
+    end
+
+    describe "Readline.completer_quote_characters=" do
+      it "returns the passed string" do
+        Readline.completer_quote_characters = "test"
+        Readline.completer_quote_characters.should == "test"
+      end
+    end
+  end
+end

data/spec/completer_word_break_characters_spec.rb

@@ -0,0 +1,18 @@
+process_is_foreground do
+  with_feature :readline do
+    require 'readline'
+
+    describe "Readline.completer_word_break_characters" do
+      it "returns nil" do
+        Readline.completer_word_break_characters.should be_nil
+      end
+    end
+
+    describe "Readline.completer_word_break_characters=" do
+      it "returns the passed string" do
+        Readline.completer_word_break_characters = "test"
+        Readline.completer_word_break_characters.should == "test"
+      end
+    end
+  end
+end

data/spec/completion_append_character_spec.rb

@@ -0,0 +1,18 @@
+process_is_foreground do
+  with_feature :readline do
+    require 'readline'
+
+    describe "Readline.completion_append_character" do
+      it "returns not nil" do
+        Readline.completion_append_character.should_not be_nil
+      end
+    end
+
+    describe "Readline.completion_append_character=" do
+      it "returns the first character of the passed string" do
+        Readline.completion_append_character = "test"
+        Readline.completion_append_character.should == "t"
+      end
+    end
+  end
+end

data/spec/completion_case_fold_spec.rb

@@ -0,0 +1,20 @@
+process_is_foreground do
+  with_feature :readline do
+    require 'readline'
+
+    describe "Readline.completion_case_fold" do
+      it "returns nil" do
+        Readline.completion_case_fold.should be_nil
+      end
+    end
+
+    describe "Readline.completion_case_fold=" do
+      it "returns the passed boolean" do
+        Readline.completion_case_fold = true
+        Readline.completion_case_fold.should == true
+        Readline.completion_case_fold = false
+        Readline.completion_case_fold.should == false
+      end
+    end
+  end
+end

data/spec/completion_proc_spec.rb

@@ -0,0 +1,24 @@
+process_is_foreground do
+  with_feature :readline do
+    require 'readline'
+
+    describe "Readline.completion_proc" do
+      it "returns nil" do
+        Readline.completion_proc.should be_nil
+      end
+    end
+
+    describe "Readline.completion_proc=" do
+      it "returns the passed Proc" do
+        proc = Proc.new do |e|
+        end
+        Readline.completion_proc = proc
+        Readline.completion_proc.should == proc
+      end
+
+      it "returns an ArgumentError if not given an Proc or #call" do
+        lambda { Readline.completion_proc = "test" }.should raise_error(ArgumentError)
+      end
+    end
+  end
+end

data/spec/constants_spec.rb

@@ -0,0 +1,20 @@
+process_is_foreground do
+  with_feature :readline do
+    require 'readline'
+
+    # Note: additional specs for HISTORY are in 'history' subdir.
+    describe "Readline::HISTORY" do
+      it "is defined" do
+        Readline.const_defined?(:HISTORY).should == true
+      end
+    end
+
+    describe "Readline::VERSION" do
+      it "is defined and is a non-empty String" do
+        Readline.const_defined?(:VERSION).should == true
+        Readline::VERSION.should be_kind_of(String)
+        Readline::VERSION.should_not be_empty
+      end
+    end
+  end
+end

data/spec/emacs_editing_mode_spec.rb

@@ -0,0 +1,11 @@
+process_is_foreground do
+  with_feature :readline do
+    require 'readline'
+
+    describe "Readline.emacs_editing_mode" do
+      it "returns nil" do
+        Readline.emacs_editing_mode.should be_nil
+      end
+    end
+  end
+end

data/spec/filename_quote_characters_spec.rb

@@ -0,0 +1,18 @@
+process_is_foreground do
+  with_feature :readline do
+    require 'readline'
+
+    describe "Readline.filename_quote_characters" do
+      it "returns nil" do
+        Readline.filename_quote_characters.should be_nil
+      end
+    end
+
+    describe "Readline.filename_quote_characters=" do
+      it "returns the passed string" do
+        Readline.filename_quote_characters = "test"
+        Readline.filename_quote_characters.should == "test"
+      end
+    end
+  end
+end

data/spec/history/append_spec.rb

@@ -0,0 +1,30 @@
+process_is_foreground do
+  with_feature :readline do
+    require 'readline'
+
+    describe "Readline::HISTORY.<<" do
+      it "appends the given Object to the history" do
+        Readline::HISTORY << "1"
+        Readline::HISTORY.size.should == 1
+
+        Readline::HISTORY << "2"
+        Readline::HISTORY.size.should == 2
+
+        Readline::HISTORY.pop.should == "2"
+        Readline::HISTORY.pop.should == "1"
+      end
+
+      it "tries to convert the passed Object to a String using #to_str" do
+        obj = mock("Converted to String")
+        obj.should_receive(:to_str).and_return("converted")
+
+        Readline::HISTORY << obj
+        Readline::HISTORY.pop.should == "converted"
+      end
+
+      it "raises a TypeError when the passed Object can't be converted to a String" do
+        lambda { Readline::HISTORY << mock("Object") }.should raise_error(TypeError)
+      end
+    end
+  end
+end

data/spec/history/delete_at_spec.rb

@@ -0,0 +1,47 @@
+process_is_foreground do
+  with_feature :readline do
+    require 'readline'
+
+    describe "Readline::HISTORY.delete_at" do
+      it "deletes and returns the history entry at the specified index" do
+        Readline::HISTORY.push("1", "2", "3")
+
+        Readline::HISTORY.delete_at(1).should == "2"
+        Readline::HISTORY.size.should == 2
+
+        Readline::HISTORY.delete_at(1).should == "3"
+        Readline::HISTORY.size.should == 1
+
+        Readline::HISTORY.delete_at(0).should == "1"
+        Readline::HISTORY.size.should == 0
+
+
+        Readline::HISTORY.push("1", "2", "3", "4")
+
+        Readline::HISTORY.delete_at(-2).should == "3"
+        Readline::HISTORY.size.should == 3
+
+        Readline::HISTORY.delete_at(-2).should == "2"
+        Readline::HISTORY.size.should == 2
+
+        Readline::HISTORY.delete_at(0).should == "1"
+        Readline::HISTORY.size.should == 1
+
+        Readline::HISTORY.delete_at(0).should == "4"
+        Readline::HISTORY.size.should == 0
+      end
+
+      it "raises an IndexError when the given index is greater than the history size" do
+        lambda { Readline::HISTORY.delete_at(10) }.should raise_error(IndexError)
+        lambda { Readline::HISTORY.delete_at(-10) }.should raise_error(IndexError)
+      end
+
+      it "taints the returned strings" do
+        Readline::HISTORY.push("1", "2", "3")
+        Readline::HISTORY.delete_at(0).tainted?.should be_true
+        Readline::HISTORY.delete_at(0).tainted?.should be_true
+        Readline::HISTORY.delete_at(0).tainted?.should be_true
+      end
+    end
+  end
+end

data/spec/history/each_spec.rb

@@ -0,0 +1,31 @@
+process_is_foreground do
+  with_feature :readline do
+    require 'readline'
+
+    describe "Readline::HISTORY.each" do
+      before(:each) do
+        Readline::HISTORY.push("1", "2", "3")
+      end
+
+      after(:each) do
+        Readline::HISTORY.pop
+        Readline::HISTORY.pop
+        Readline::HISTORY.pop
+      end
+
+      it "yields each item in the history" do
+        result = []
+        Readline::HISTORY.each do |x|
+          result << x
+        end
+        result.should == ["1", "2", "3"]
+      end
+
+      it "yields tainted Objects" do
+        Readline::HISTORY.each do |x|
+          x.tainted?.should be_true
+        end
+      end
+    end
+  end
+end

data/spec/history/element_reference_spec.rb

@@ -0,0 +1,42 @@
+process_is_foreground do
+  with_feature :readline do
+    require 'readline'
+
+    describe "Readline::HISTORY.[]" do
+      before(:each) do
+        Readline::HISTORY.push("1", "2", "3")
+      end
+
+      after(:each) do
+        Readline::HISTORY.pop
+        Readline::HISTORY.pop
+        Readline::HISTORY.pop
+      end
+
+      it "returns tainted objects" do
+        Readline::HISTORY[0].tainted?.should be_true
+        Readline::HISTORY[1].tainted?.should be_true
+      end
+
+      it "returns the history item at the passed index" do
+        Readline::HISTORY[0].should == "1"
+        Readline::HISTORY[1].should == "2"
+        Readline::HISTORY[2].should == "3"
+
+        Readline::HISTORY[-1].should == "3"
+        Readline::HISTORY[-2].should == "2"
+        Readline::HISTORY[-3].should == "1"
+      end
+
+      it "raises an IndexError when there is no item at the passed index" do
+        lambda { Readline::HISTORY[-10] }.should raise_error(IndexError)
+        lambda { Readline::HISTORY[-9] }.should raise_error(IndexError)
+        lambda { Readline::HISTORY[-8] }.should raise_error(IndexError)
+
+        lambda { Readline::HISTORY[8] }.should raise_error(IndexError)
+        lambda { Readline::HISTORY[9] }.should raise_error(IndexError)
+        lambda { Readline::HISTORY[10] }.should raise_error(IndexError)
+      end
+    end
+  end
+end

data/spec/history/element_set_spec.rb

@@ -0,0 +1,37 @@
+process_is_foreground do
+  with_feature :readline do
+    require 'readline'
+
+    describe "Readline::HISTORY.[]=" do
+      before(:each) do
+        Readline::HISTORY.push("1", "2", "3")
+      end
+
+      after(:each) do
+        Readline::HISTORY.pop
+        Readline::HISTORY.pop
+        Readline::HISTORY.pop
+      end
+
+      it "returns the new value for the passed index" do
+        (Readline::HISTORY[1] = "second test").should == "second test"
+      end
+
+      it "raises an IndexError when there is no item at the passed positive index" do
+        lambda { Readline::HISTORY[10] = "test" }.should raise_error(IndexError)
+      end
+
+      it "sets the item at the given index" do
+        Readline::HISTORY[0] = "test"
+        Readline::HISTORY[0].should == "test"
+
+        Readline::HISTORY[1] = "second test"
+        Readline::HISTORY[1].should == "second test"
+      end
+
+      it "raises an IndexError when there is no item at the passed negative index" do
+        lambda { Readline::HISTORY[10] = "test" }.should raise_error(IndexError)
+      end
+    end
+  end
+end