ripl-readline-em 0.2.0 → 0.2.1

data/.gemspec

@@ -1,7 +1,7 @@
 # -*- encoding: utf-8 -*-
 require 'rubygems' unless Object.const_defined?(:Gem)
 $:.push File.dirname(__FILE__) + "/lib"
-require 'ripl/readline/em'
+require 'ripl/readline/em/version'
  
 Gem::Specification.new do |s|
   s.name        = "ripl-readline-em"

data/README.rdoc

@@ -11,5 +11,37 @@ Install the gem with:
 
 == Usage
 
-    :include: ./examples/ripl_readline_em.rb
-
+    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/examples/custom_binding.rb

@@ -0,0 +1,19 @@
+require 'eventmachine'
+require 'ripl/readline/em'
+
+class Shell
+
+  def set_name(name)
+    @name = name
+  end
+
+  def greet
+    puts "Hello, #{@name}"
+  end
+
+end
+
+EventMachine.run do
+  Ripl.start :binding => Shell.new.instance_eval { binding }
+  EventMachine.watch_stdin Ripl::Readline::EmInput
+end

data/examples/readline_callback_em.rb

@@ -0,0 +1,44 @@
+# This example uses readline directly without going through ripl.  This is not
+# the primary goal of this library, but a useful side effect of extending the
+# Readline api.
+
+require 'readline/callback.rb'
+require 'eventmachine'
+
+module Handler
+  def initialize
+    Readline::callback_handler_install('> ') do |line|
+      if line =~ /(quit|exit)/
+        EventMachine::stop_event_loop
+      else
+        puts "have a line: #{line}"
+      end
+    end
+  end
+
+  def notify_readable
+    Readline.callback_read_char
+  end
+
+  def unbind
+    Readline.callback_handler_remove
+  end
+end
+
+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
+
+  conn = EventMachine.watch $stdin, Handler
+  conn.notify_readable = true
+end

data/lib/readline/callback.rb

@@ -30,6 +30,14 @@ module Readline
     # as-is functions
     attach_function :forced_update_display, :rl_forced_update_display, [], :void
 
+    # ruby 1.8 doesn't expose readline's line buffer
+    unless Readline.respond_to?(:line_buffer)
+      attach_variable :rl_line_buffer, :string
+      def line_buffer
+        ::Readline::Callback.rl_line_buffer
+      end
+    end
+ 
     if editline?
       def set_prompt(*args)
         # noop; rl_set_prompt isn't exported by EditLine

data/lib/ripl/readline/em.rb

@@ -3,12 +3,11 @@ require 'readline/callback'
 require 'ripl'
 require 'ripl/readline'
 require 'ripl/readline/eminput'
+require 'ripl/readline/em/version'
 
 module Ripl
   module Readline
     module Em
-      VERSION = '0.2.0'
-
       def get_input
         history << @input
         @input

data/lib/ripl/readline/em/version.rb

@@ -0,0 +1,7 @@
+module Ripl
+  module Readline
+    module Em
+      VERSION = '0.2.1'
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ripl-readline-em
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-02 00:00:00.000000000Z
+date: 2012-02-18 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ripl
-  requirement: &8372840 !ruby/object:Gem::Requirement
+  requirement: &21057440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 0.4.2
   type: :runtime
   prerelease: false
-  version_requirements: *8372840
+  version_requirements: *21057440
 - !ruby/object:Gem::Dependency
   name: eventmachine
-  requirement: &8372300 !ruby/object:Gem::Requirement
+  requirement: &21106660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *8372300
+  version_requirements: *21106660
 - !ruby/object:Gem::Dependency
   name: ffi
-  requirement: &8371620 !ruby/object:Gem::Requirement
+  requirement: &21106200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *8371620
+  version_requirements: *21106200
 description: Run EventMachine code in a ripl shell asynchronously with readline editing
   and completion
 email: pat@polycrystal.org
@@ -53,6 +53,7 @@ extra_rdoc_files:
 - README.rdoc
 - LICENSE.txt
 files:
+- lib/ripl/readline/em/version.rb
 - lib/ripl/readline/em.rb
 - lib/ripl/readline/eminput.rb
 - lib/readline/callback.rb
@@ -60,6 +61,8 @@ files:
 - README.rdoc
 - examples/readline_callback.rb
 - examples/ripl_readline_em.rb
+- examples/readline_callback_em.rb
+- examples/custom_binding.rb
 - Rakefile
 - .gemspec
 homepage: http://github.com/pmahoney/ripl-readline-em