ripl-readline-em 0.1.0

data/.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+require 'rubygems' unless Object.const_defined?(:Gem)
+$:.push File.dirname(__FILE__) + "/lib"
+require 'ripl/readline/em'
+ 
+Gem::Specification.new do |s|
+  s.name        = "ripl-readline-em"
+  s.version     = Ripl::Readline::Em::VERSION
+  s.authors     = ["Patrick Mahoney"]
+  s.email       = "pat@polycrystal.org"
+  s.homepage    = "http://github.com/pmahoney/ripl-readline-em"
+  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.extra_rdoc_files = ["README.rdoc", "LICENSE.txt"]
+  s.license = 'MIT'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT LICENSE
+
+Copyright (c) 2011 Patrick Mahoney
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,34 @@
+== Description
+
+Run EventMachine code in a ripl shell asynchronously with readline
+editing and completion.  Uses FFI to access the alternate Readline
+callback interface.
+
+== Install
+Install the gem with:
+
+    gem install ripl-readline-em
+
+== Usage
+
+    require 'ripl/readline/em'
+
+    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

@@ -0,0 +1,35 @@
+require 'rake'
+require 'fileutils'
+
+def gemspec
+  @gemspec ||= eval(File.read('.gemspec'), binding, '.gemspec')
+end
+
+desc "Build the gem"
+task :gem => :gemspec do
+  sh "gem build .gemspec"
+  FileUtils.mkdir_p 'pkg'
+  FileUtils.mv "#{gemspec.name}-#{gemspec.version}.gem", 'pkg'
+end
+
+desc "Install the gem locally"
+task :install => :gem do
+  sh %{gem install pkg/#{gemspec.name}-#{gemspec.version}}
+end
+
+desc "Generate the gemspec"
+task :generate do
+  puts gemspec.to_ruby
+end
+
+desc "Validate the gemspec"
+task :gemspec do
+  gemspec.validate
+end
+
+desc 'Run tests'
+task :test do |t|
+  sh 'bacon -q -Ilib -I. test/**_test.rb'
+end
+
+task :default => :test

data/lib/readline/callback.rb

@@ -0,0 +1,74 @@
+require 'ffi'
+
+module Readline
+  # An alternate, callback-based interface to Readline for use in a
+  # larger event loop.
+  #
+  # Used FFI for access to the Readline C library.  The Readline
+  # module (Ruby core) is extended with this module.
+  #
+  # See http://cnswww.cns.cwru.edu/php/chet/readline/readline.html#SEC41
+  module Callback
+    extend FFI::Library
+
+    ffi_lib 'readline'
+
+    callback :rl_vcpfunc_t, [:string], :void
+    attach_function :rl_callback_handler_install, [:string, :rl_vcpfunc_t], :void
+    attach_function :rl_callback_read_char, [], :void
+    attach_function :rl_callback_handler_remove, [], :void
+
+    # as-is functions
+
+    attach_function :set_prompt, :rl_set_prompt, [:string], :int
+
+    # 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
+    # complete line of input has been entered.
+    #
+    # A reference to the handler is saved in an instance variable so
+    # that it will not be garbage collected.  Subsequent calls to
+    # #handler_install will displace this reference.  A call to
+    # #handler_remove will remove the reference.
+    #
+    # @param [String] prompt
+    #
+    # @yield [String] a handler taking the text of the line as the sole
+    # argument, called when a complete line of input has been entered.
+    def callback_handler_install(prompt = nil, &block)
+      raise ArgumentError, 'block is required' unless block
+      @rl_callback_handler = block
+      rl_callback_handler_install(prompt, block)
+    end
+
+    # When keyboard input is available (determined by, e.g. calling
+    # select on $stdin), this method should be called.  If that
+    # character completes the line, the block registered by
+    # #callback_handler_install will be called.  Before calling the
+    # handler function, the terminal settings are reset to the values
+    # they had before calling #callback_handler_install. If the
+    # handler function returns, the terminal settings are modified for
+    # 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
+
+    # Restore the terminal to its initial state and remove the line
+    # handler. This may be called from within a callback as well as
+    # independently. If the handler installed by #handler_install does
+    # not exit the program, either this function or the function
+    # referred to by the value of rl_deprep_term_function (not sure what
+    # that translates to in Ruby) should be called before the program
+    # exits to reset the terminal settings.
+    def callback_handler_remove
+      rl_callback_handler_remove
+      @rl_callback_handler = nil
+    end
+  end
+end
+
+module Readline
+  extend Callback
+end

data/lib/readline_cb.rb

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

data/lib/ripl/readline/em.rb

@@ -0,0 +1,96 @@
+require 'eventmachine'
+require 'readline/callback'
+require 'ripl'
+require 'ripl/readline'
+
+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'
+
+      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
+      end
+    end
+  end
+end
+
+Ripl::Shell.include Ripl::Readline::Em
+class Ripl::Shell
+  def loop
+    loop_override
+  end
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: ripl-readline-em
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Patrick Mahoney
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-25 00:00:00.000000000 -06:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ripl
+  requirement: &8353400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.4.2
+  type: :runtime
+  prerelease: false
+  version_requirements: *8353400
+- !ruby/object:Gem::Dependency
+  name: eventmachine
+  requirement: &8352820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *8352820
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: &8314360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        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
+description: Run EventMachine code in a ripl shell asynchronously with readline editing
+  and completion
+email: pat@polycrystal.org
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+- LICENSE.txt
+files:
+- lib/ripl/readline/em.rb
+- lib/readline_cb.rb
+- lib/readline/callback.rb
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- .gemspec
+has_rdoc: true
+homepage: http://github.com/pmahoney/ripl-readline-em
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: A ripl plugin to run readline within eventmachine
+test_files: []