readline-ng 0.0.4 → 0.0.5

data/.rvmrc

@@ -4,7 +4,7 @@
 # development environment upon cd'ing into the directory
 
 # First we specify our desired <ruby>[@<gemset>], the @gemset name is optional.
-environment_id="ruby-1.9.3-p0"
+environment_id="ruby-1.9.3-p125"
 
 #
 # Uncomment following line if you want options to be set only for given project.
@@ -65,7 +65,7 @@ fi
 if [[ $- == *i* ]] # check for interactive shells
 then
     echo "Using: $(tput setaf 2)$GEM_HOME$(tput sgr0)" # show the user the ruby and gemset they are using in green
-else 
+else
 	echo "Using: $GEM_HOME" # don't use colors in interactive shells
 fi
 

data/Gemfile

@@ -0,0 +1,2 @@
+source :rubygems
+gemspec

data/README

@@ -2,3 +2,15 @@ Readline-NG is /not/ a drop in replacement for readline.
 
 It addresses a very specific need I had inside a twitter client, but
 hopefully it's of use to someone else, too.
+
+Readline relies on being able to poll for input often, leading to a
+hideously inefficient event loop, but generally
+
+    reader = ReadlineNG::Reader.new
+    loop do
+        reader.tick
+        reader.each_line do |line|
+            # Handle full line of input
+            reader.puts_above("user input #{line}")
+        end
+    end

data/lib/readline-ng.rb

@@ -2,7 +2,7 @@ module ReadlineNG
 
   VERSION_MAJOR = 0
   VERSION_MINOR = 0
-  VERSION_PATCH = 4
+  VERSION_PATCH = 5
   VERSION = "#{VERSION_MAJOR}.#{VERSION_MINOR}.#{VERSION_PATCH}"
 
   CONTROL_BS  = "\x08"
@@ -12,8 +12,6 @@ module ReadlineNG
 
   KB_BS  = "\x7F"
   KB_CR  = "\x0d"
-  KB_LEFT   = "LEFT" # XXX PLACEHOLDERS
-  KB_RIGHT  = "RIGHT"
 
   BLANK  = " "
 
@@ -21,39 +19,29 @@ module ReadlineNG
 
     @@initialized = false
 
-    # TODO Arrange for the terminal to be in raw mode etc.
     # XXX This probably needs to be a singleton, having more than one doesn't
     # make a whole lot of sense, although potentially giving out rope is not a
     # terrible idea here
 
-    attr_accessor :lines, :visible, :polling_resolution
+    attr_accessor :lines, :visible
 
+    # A third party dev can overload filter to implement their own actions
     def filter
     end
 
-    def initialize(visible=true, opts = {})
+    def initialize(visible=true)
       @buf = ""
-      @ind = 0
       @visible = visible
       @lines = []
-      @polling_resolution = opts[:polling_resolution] || 20
       if @@initialized
         STDERR.puts "A ReadlineNG reader is already instanciated, expect weirdness"
       else
         @@initialized = true
       end
 
-      stty_saved = `stty -g`
-      `stty -echo raw`
+      setup
       at_exit do
-        `stty #{stty_saved}`
-      end
-    end
-
-    def sleep(n)
-      (n * polling_resolution).times do
-        tick
-        sleep 1.0/polling_resolution
+        teardown
       end
     end
 
@@ -68,7 +56,7 @@ module ReadlineNG
 
     def tick
       t = STDIN.read_nonblock(128)
-      process(t)
+      t.each_char { |c| process(c) }
       filter # Expect a 3rd party dev to override this
 
       raise Interrupt if @buf.include?(CONTROL_INT)
@@ -103,46 +91,35 @@ module ReadlineNG
       when KB_BS
         @buf.chop!
         backspace
-      when KB_LEFT
-        unless @ind == 0
-          _print CONTROL_BS
-          @ind -= 1
-        end
-      when KB_RIGHT
-        unless @ind == @buf.length
-          _print @buf[@ind]
-          @ind += 1
-        end
       else
-        @buf.insert(@ind, c)
-        @ind += 1
-        if @ind == @buf.length
-          _print c
-        else
-          # TODO Only backspace to the new character
-          redraw
-        end
+        @buf += c
+        _print c
       end
     end
 
     def backspace(n=1)
-      print CONTROL_BS*n,BLANK*n,CONTROL_BS*n
+      _print CONTROL_BS*n,BLANK*n,CONTROL_BS*n
     end
 
-    def redraw
-      backspace(@buf.length)
-      _print(@buf)
+    def _print(*c)
+      print *c if visible
     end
 
-    def _print(c)
-      print c if visible
+    def _puts(*c)
+      puts *c if visible
     end
 
-    def _puts(c)
-      puts c if visible
+    def setup
+      @stty_saved = `stty -g`
+      `stty -echo raw`
+    end
+
+    def teardown
+      `stty #{@stty_saved}`
     end
 
 
+
   end
 end
 

data/readline-ng.gemspec

@@ -11,6 +11,8 @@ Gem::Specification.new do |s|
   s.summary     = "Essentially, readline++"
   s.description = s.summary
 
+  s.add_development_dependency 'rspec'
+
   s.files         = `git ls-files`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]

data/spec/readline-ng_spec.rb

@@ -0,0 +1,62 @@
+require 'readline-ng'
+require 'mocha'
+
+# Hook to reset internal state between runs
+module ReadlineNG
+  class Reader
+    def self.initialized=(v)
+      @@initialized = v
+    end
+  end
+end
+
+describe ReadlineNG do
+
+  before(:each) do
+    @reader = ReadlineNG::Reader.new
+    @reader.visible = false
+  end
+
+  after(:each) do
+    @reader.send(:teardown)
+    ReadlineNG::Reader.initialized = false
+  end
+
+  it "should only return full lines of input" do
+    STDIN.stub(:read_nonblock).and_return("in", "put", "\r")
+    @reader.tick # gets "in"
+    @reader.lines.should be_empty
+    @reader.tick # gets "put"
+    @reader.lines.should be_empty
+    @reader.tick # gets "\r"
+    @reader.line.should == "input"
+  end
+
+  it "should handle newlines in amongst inputs" do
+    STDIN.stub(:read_nonblock).and_return("in", "put\racros", "slines\r...")
+    @reader.tick # gets "in"
+    @reader.lines.should be_empty
+    @reader.tick # gets "put\racros"
+    @reader.tick # gets "slines\r..."
+    @reader.lines.should == ["input", "acrosslines"]
+  end
+
+  it "should call a filter method if defined" do
+    STDIN.stub(:read_nonblock).and_return("in", "put")
+    @reader.expects(:filter).twice
+    @reader.tick
+    @reader.tick
+  end
+
+  it "should let the user backspace out errors" do
+    STDIN.stub(:read_nonblock).and_return("in", "put", "\x7F"*3, "tro\r")
+    @reader.get_line.should == "intro"
+  end
+
+  it "should not fall over trying to backspace an empty buffer" do
+    STDIN.stub(:read_nonblock).and_return("in", "\x7F"*8, "input\r")
+    @reader.get_line.should == "input"
+  end
+
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: readline-ng
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,19 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-19 00:00:00.000000000 Z
-dependencies: []
+date: 2012-02-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &7211240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *7211240
 description: Essentially, readline++
 email:
 - richo@psych0tik.net
@@ -19,11 +30,11 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .rvmrc
+- Gemfile
 - README
 - lib/readline-ng.rb
 - readline-ng.gemspec
-- test/newline.rb
-- test/test_helper.rb
+- spec/readline-ng_spec.rb
 homepage: http://github.com/richoH/readline-ng
 licenses: []
 post_install_message: 
@@ -44,7 +55,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.16
 signing_key: 
 specification_version: 3
 summary: Essentially, readline++

data/test/newline.rb

@@ -1,11 +0,0 @@
-#!/usr/bin/env ruby
-require './lib/readline-ng'
-
-puts "Should output"
-puts "line1\nline2"
-puts ""
-
-reader = ReadlineNG::Reader.new
-
-reader.puts_above("line1\nline2")
-