readline-ng 0.0.5 → 0.0.6

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+gemfile: Gemfile.travis
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3

data/Gemfile.travis

@@ -0,0 +1,8 @@
+source :rubygems
+
+group :test do
+  gem "rake"
+  gem "rspec"
+  gem "mocha"
+end
+

data/README.md

@@ -0,0 +1,21 @@
+## Readline ng
+
+[![Build Status](https://secure.travis-ci.org/richoH/readline-ng.png?branch=master)](http://travis-ci.org/richoH/readline-ng)
+
+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
+```ruby
+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/Rakefile

@@ -0,0 +1,9 @@
+require 'rake'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = "spec/*_spec.rb"
+end
+
+desc 'Default: run specs'
+task :default => :spec

data/lib/readline-ng.rb

@@ -2,7 +2,7 @@ module ReadlineNG
 
   VERSION_MAJOR = 0
   VERSION_MINOR = 0
-  VERSION_PATCH = 5
+  VERSION_PATCH = 6
   VERSION = "#{VERSION_MAJOR}.#{VERSION_MINOR}.#{VERSION_PATCH}"
 
   CONTROL_BS  = "\x08"
@@ -13,6 +13,9 @@ module ReadlineNG
   KB_BS  = "\x7F"
   KB_CR  = "\x0d"
 
+  KB_LEFT  = "\x25"
+  KB_RIGHT = "\x27"
+
   BLANK  = " "
 
   class Reader
@@ -23,16 +26,18 @@ module ReadlineNG
     # make a whole lot of sense, although potentially giving out rope is not a
     # terrible idea here
 
-    attr_accessor :lines, :visible
+    attr_accessor :lines, :visible, :polling_resolution
 
     # A third party dev can overload filter to implement their own actions
     def filter
     end
 
-    def initialize(visible=true)
+    def initialize(visible=true, opts = {})
       @buf = ""
+      @index = 0
       @visible = visible
       @lines = []
+      @polling_resolution = opts[:polling_resolution] || 20
       if @@initialized
         STDERR.puts "A ReadlineNG reader is already instanciated, expect weirdness"
       else
@@ -45,6 +50,13 @@ module ReadlineNG
       end
     end
 
+    def wait(n)
+      (n * polling_resolution).times do
+        tick
+        sleep 1.0/polling_resolution
+      end
+    end
+
     def puts_above(string)
       if visible
         backspace(@buf.length)
@@ -58,14 +70,6 @@ module ReadlineNG
       t = STDIN.read_nonblock(128)
       t.each_char { |c| process(c) }
       filter # Expect a 3rd party dev to override this
-
-      raise Interrupt if @buf.include?(CONTROL_INT)
-
-      a = @buf.split("\r")
-      return if a.empty? && @buf.empty?
-      @buf = @buf[-1] == "\r" ? "" : a.pop
-
-      @lines += a
     rescue Errno::EAGAIN
       nil
     end
@@ -87,16 +91,48 @@ module ReadlineNG
     private
 
     def process(c)
+      # TODO This method is getting monolithic, think about how to modularise it
       case c
+      when "\r"
+        @lines += [@buf]
+        reset
+      when CONTROL_INT
+        raise Interrupt
       when KB_BS
-        @buf.chop!
-        backspace
+        if @buf.chop!
+          @index -= 1
+          backspace
+        end
+      when KB_LEFT
+        if @buf and @index != 0
+          @index -= 1
+        end
+      when KB_RIGHT
+        if @buf and @index < @buf.length
+          @index -= 1
+        end
       else
-        @buf += c
-        _print c
+        @buf = @buf.insert(@index, c)
+        @index += 1
+        if @index == @buf.length
+          _print c
+        else
+          redraw
+        end
       end
     end
 
+    def reset
+      @index, @buf = 0, ""
+    end
+
+    def redraw
+      # TODO We can get away with only going back as far as index, I should
+      # think
+      backspace(@buf.length)
+      _print @buf
+    end
+
     def backspace(n=1)
       _print CONTROL_BS*n,BLANK*n,CONTROL_BS*n
     end
@@ -118,8 +154,6 @@ module ReadlineNG
       `stty #{@stty_saved}`
     end
 
-
-
   end
 end
 

data/readline-ng.gemspec

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

data/spec/readline-ng_spec.rb

@@ -58,5 +58,25 @@ describe ReadlineNG do
     @reader.get_line.should == "input"
   end
 
+  it "should respect the left key" do
+    STDIN.stub(:read_nonblock).and_return("asdf", "\x25"*2, "__\r")
+    @reader.get_line.should == "as__df"
+  end
+
+  it "should not allow the user to left before an empty buffer" do
+    STDIN.stub(:read_nonblock).and_return("\x25"*2, "__", "\x25"*2, "\r")
+    @reader.get_line.should == "__"
+  end
+
+  it "should respect the right key" do
+    STDIN.stub(:read_nonblock).and_return("asdf", "\x25"*2, "__", "\x27", "++\r" )
+    @reader.get_line.should == "as_++_df"
+  end
+
+  it "should not allow the user to right after an empty buffer" do
+    STDIN.stub(:read_nonblock).and_return("\x27"*2, "__", "\x27"*2, "\r")
+    @reader.get_line.should == "__"
+  end
+
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: readline-ng
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-22 00:00:00.000000000 Z
+date: 2012-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &7211240 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,44 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *7211240
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  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: 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'
 description: Essentially, readline++
 email:
 - richo@psych0tik.net
@@ -30,8 +67,11 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .rvmrc
+- .travis.yml
 - Gemfile
-- README
+- Gemfile.travis
+- README.md
+- Rakefile
 - lib/readline-ng.rb
 - readline-ng.gemspec
 - spec/readline-ng_spec.rb
@@ -55,7 +95,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.16
+rubygems_version: 1.8.19
 signing_key: 
 specification_version: 3
 summary: Essentially, readline++

data/README

@@ -1,16 +0,0 @@
-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