ripl-readline-em 0.1.0 → 0.2.0

data/.gemspec

@@ -12,14 +12,10 @@ Gem::Specification.new do |s|
   s.summary     = "A ripl plugin to run readline within eventmachine"
   s.description =  "Run EventMachine code in a ripl shell asynchronously with readline editing and completion"
   s.required_rubygems_version = ">= 1.3.6"
-
   s.add_dependency 'ripl', '>= 0.4.2'
   s.add_dependency 'eventmachine'
   s.add_dependency 'ffi'
-
-  s.add_development_dependency 'bacon', '>= 1.1.0'
-
-  s.files = Dir.glob(%w[lib/**/*.rb [A-Z]*.{txt,rdoc}]) + %w{Rakefile .gemspec}
+  s.files = Dir.glob(%w[lib/**/*.rb [A-Z]*.{txt,rdoc} examples/**/*.rb]) + %w{Rakefile .gemspec}
   s.extra_rdoc_files = ["README.rdoc", "LICENSE.txt"]
   s.license = 'MIT'
 end

data/README.rdoc

@@ -11,24 +11,5 @@ Install the gem with:
 
 == Usage
 
-    require 'ripl/readline/em'
+    :include: ./examples/ripl_readline_em.rb
 
-    EventMachine.run do
-      EventMachine.add_periodic_timer(2) do
-        # example writing output while line is being edited
-        puts "#{Time.now}"
-        Readline.refresh_line
-      end
-
-      Ripl.start  # exiting ripl shell shuts down EventMachine
-    end
-
-Writing output to stdout writes over the current input line.  A call
-to Readline.refresh_line fixes things up, but a copy of the prompt and
-any input text follows along with the line of output. I suspect this
-isn't the best way...
-
-== Todo
-
-Improve technique of being able to write output without messing up the
-input line.

data/Rakefile

@@ -29,7 +29,7 @@ end
 
 desc 'Run tests'
 task :test do |t|
-  sh 'bacon -q -Ilib -I. test/**_test.rb'
+  sh 'bacon -q -Ilib -I. test/*_test.rb'
 end
 
 task :default => :test

data/examples/readline_callback.rb

@@ -0,0 +1,14 @@
+require 'readline/callback.rb'
+
+Readline::callback_handler_install('> ') do |line|
+  puts "have a line: #{line}"
+end
+
+begin
+  loop do
+    select [$stdin]
+    Readline::callback_read_char
+  end
+ensure
+  Readline::callback_handler_remove
+end

data/examples/ripl_readline_em.rb

@@ -0,0 +1,34 @@
+require 'eventmachine'
+require 'ripl/readline/em'
+
+EventMachine.run do
+  EventMachine.add_periodic_timer(2) do
+    # Example of writing output while line is being edited.
+    #
+    # See also http://stackoverflow.com/questions/1512028/gnu-readline-how-do-clear-the-input-line
+    print "\b \b" * Readline.line_buffer.size
+    print "\r"
+    begin
+      puts "#{Time.now}"
+    ensure
+      Readline.forced_update_display
+    end
+  end
+
+  # Start up Ripl, but it will not receive any user input
+  Ripl.start
+
+  # Watch stdin for input, sending it to Ripl as entered (including editing,
+  # history and completion).
+  #
+  # Default behavior is to call EventMachine.stop_event_loop when the shell is
+  # exited.  Modify this behavior by passing a hash with an `:on_exit` entry,
+  # either nil or a Proc that will be run on exit instead of the default.
+  EventMachine.watch_stdin Ripl::Readline::EmInput
+
+  # -or-
+  # EventMachine.watch_stdin Ripl::Readline::EmInput, :on_exit => nil
+
+  # Yet another option is to create your own handler module, include
+  # Ripl::Readline::EmInput, and override the `on_exit` method.
+end

data/lib/readline/callback.rb

@@ -1,4 +1,5 @@
 require 'ffi'
+require 'readline'
 
 module Readline
   # An alternate, callback-based interface to Readline for use in a
@@ -11,7 +12,15 @@ module Readline
   module Callback
     extend FFI::Library
 
-    ffi_lib 'readline'
+    def self.editline?
+      @__is_editline__ ||= (Readline::VERSION rescue nil).to_s[/editline/i]
+    end
+
+    if editline?
+      ffi_lib 'edit'
+    else
+      ffi_lib 'readline'
+    end
 
     callback :rl_vcpfunc_t, [:string], :void
     attach_function :rl_callback_handler_install, [:string, :rl_vcpfunc_t], :void
@@ -19,8 +28,15 @@ module Readline
     attach_function :rl_callback_handler_remove, [], :void
 
     # as-is functions
+    attach_function :forced_update_display, :rl_forced_update_display, [], :void
 
-    attach_function :set_prompt, :rl_set_prompt, [:string], :int
+    if editline?
+      def set_prompt(*args)
+        # noop; rl_set_prompt isn't exported by EditLine
+      end
+    else
+      attach_function :set_prompt, :rl_set_prompt, [:string], :int
+    end
 
     # Set up the terminal for readline I/O and display the initial
     # expanded value of prompt. Save the value of `block` to call when a
@@ -51,7 +67,6 @@ module Readline
     # Readline's use again. EOF is indicated by calling handler with a
     # NULL line.
     def callback_read_char
-      $stderr.puts "reading char"
       rl_callback_read_char
     end
 

data/lib/ripl/readline/em.rb

@@ -2,95 +2,29 @@ require 'eventmachine'
 require 'readline/callback'
 require 'ripl'
 require 'ripl/readline'
+require 'ripl/readline/eminput'
 
 module Ripl
   module Readline
     module Em
-      module InputHandler
-        def notify_readable
-          $stderr.puts "is readable"
-          ::Readline.callback_read_char
-          $stderr.puts "done"
-        end
-
-        def unbind
-          $stderr.puts "unbind!"
-          ::Readline.callback_handler_remove
-        end
-      end
-    end
-  end
-end
-
-module Ripl
-  module Readline
-    module Em
-      VERSION = '0.1.0'
+      VERSION = '0.2.0'
 
       def get_input
         history << @input
         @input
       end
 
-      def redisplay
-        ::Readline.set_prompt(Ripl.shell.prompt)
-        ::Readline.refresh_line
-      end
-
-      def handle_line(line)
-        catch(:normal_exit) do
-          catch(:ripl_exit) do
-            throw :ripl_exit unless line # line = nil implies EOF
-
-            $stderr.puts "have line #{line}"
-
-            Ripl.shell.input = line
-            Ripl.shell.loop_once
-            redisplay
-            throw :normal_exit
-          end
-
-          # If we got here, it means :ripl_exit was caught
-          ::Readline.callback_handler_remove
-          after_loop
-        end
-      end
-
-      def loop_override
-        before_loop
-
-        ::Readline.callback_handler_install do |line|
-          EventMachine.next_tick { handle_line(line) }
-        end
-
-        # is hardcoded $stdin always appropriate?
-        conn = EventMachine.watch $stdin, InputHandler
-        conn.notify_readable = true
-        
-        redisplay
-      end
-
-      def before_loop
-        super
-        trap('SIGINT') { handle_interrupt }
-      end
-
-      def after_loop
-        super
-        EventMachine.stop_event_loop
-      end
-
-      def handle_interrupt
-        super
-        redisplay
+      def async_loop
+        # no-op; functionality is done asynchronously
       end
     end
   end
 end
 
 Ripl::Shell.include Ripl::Readline::Em
+
 class Ripl::Shell
   def loop
-    loop_override
+    async_loop
   end
 end

data/lib/ripl/readline/eminput.rb

@@ -0,0 +1,69 @@
+module EventMachine
+  # Convenience method to add a watch on `STDIN` and set
+  # notify_readable to `true`.
+  #
+  # See EventMachine.watch
+  def self.watch_stdin(handler, *args)
+    conn = EventMachine.watch $stdin, handler, *args
+    conn.notify_readable = true
+    conn
+  end
+end
+
+module Ripl
+  module Readline
+    module EmInput
+      def initialize(opts = {})
+        super()
+        @on_exit = opts[:on_exit] || proc { EventMachine.stop_event_loop }
+        handler_install
+        Ripl.shell.before_loop
+        trap('SIGINT') { handle_interrupt }
+      end
+
+      def notify_readable
+        ::Readline.callback_read_char
+      end
+
+      def unbind
+        super
+        ::Readline.callback_handler_remove
+        Ripl.shell.after_loop
+        on_exit
+      end
+
+      def on_exit
+        @on_exit.call if @on_exit
+      end
+
+      def receive_line(line)
+        catch(:normal_exit) do
+          catch(:ripl_exit) do
+            throw :ripl_exit unless line # line = nil implies EOF
+
+            Ripl.shell.input = line
+            Ripl.shell.loop_once
+            handler_install   # EditLine requires handler be
+                              # reinstalled for each line.
+                              # Seems harmless for Readline
+            throw :normal_exit
+          end
+          detach              # :ripl_exit
+        end
+        # :normal_exit
+      end
+
+      def handle_interrupt
+        ::Readline.callback_handler_remove
+        puts
+        handler_install
+      end
+
+      def handler_install
+        ::Readline.callback_handler_install(Ripl.shell.prompt) do |line|
+          EventMachine.next_tick { receive_line(line) }
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ripl-readline-em
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-25 00:00:00.000000000 -06:00
-default_executable: 
+date: 2011-12-02 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ripl
-  requirement: &8353400 !ruby/object:Gem::Requirement
+  requirement: &8372840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +21,10 @@ dependencies:
         version: 0.4.2
   type: :runtime
   prerelease: false
-  version_requirements: *8353400
+  version_requirements: *8372840
 - !ruby/object:Gem::Dependency
   name: eventmachine
-  requirement: &8352820 !ruby/object:Gem::Requirement
+  requirement: &8372300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *8352820
+  version_requirements: *8372300
 - !ruby/object:Gem::Dependency
   name: ffi
-  requirement: &8314360 !ruby/object:Gem::Requirement
+  requirement: &8371620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,18 +43,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *8314360
-- !ruby/object:Gem::Dependency
-  name: bacon
-  requirement: &8313560 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 1.1.0
-  type: :development
-  prerelease: false
-  version_requirements: *8313560
+  version_requirements: *8371620
 description: Run EventMachine code in a ripl shell asynchronously with readline editing
   and completion
 email: pat@polycrystal.org
@@ -66,13 +54,14 @@ extra_rdoc_files:
 - LICENSE.txt
 files:
 - lib/ripl/readline/em.rb
-- lib/readline_cb.rb
+- lib/ripl/readline/eminput.rb
 - lib/readline/callback.rb
 - LICENSE.txt
 - README.rdoc
+- examples/readline_callback.rb
+- examples/ripl_readline_em.rb
 - Rakefile
 - .gemspec
-has_rdoc: true
 homepage: http://github.com/pmahoney/ripl-readline-em
 licenses:
 - MIT
@@ -94,7 +83,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: A ripl plugin to run readline within eventmachine

data/lib/readline_cb.rb

@@ -1,37 +0,0 @@
-require 'readline/alt'
-
-module Readline::Alt::Demo
-  class << self
-    # Demonstration method to read a line of input using the callback
-    # functions rather than a direct call to Readline#readline.
-    def readline(prompt = nil)
-      readline_string = nil
-
-      Readline.handler_install(prompt) do |str|
-        readline_string = str
-      end
-
-      begin
-        Readline.read_char until readline_string
-      ensure
-        Readline.handler_remove
-      end
-
-      readline_string
-    end
-  end
-end
-
-#line = Readline::Alt::Demo.readline('> ')
-#puts "READ A LINE::: #{line.inspect}"
-
-require 'ripl/readline/em'
-
-EventMachine.run do
-  EventMachine.add_periodic_timer(2) do
-    puts "#{Time.now} alive!"
-    Readline.refresh_line
-  end
-
-  Ripl.start
-end