iruby 0.5.0 → 0.7.2

data/lib/iruby/event_manager.rb

@@ -0,0 +1,40 @@
+module IRuby
+  class EventManager
+    def initialize(available_events)
+      @available_events = available_events.dup.freeze
+      @callbacks = available_events.map {|n| [n, []] }.to_h
+    end
+
+    attr_reader :available_events
+
+    def register(event, &block)
+      check_available_event(event)
+      @callbacks[event] << block unless block.nil?
+      block
+    end
+
+    def unregister(event, callback)
+      check_available_event(event)
+      val = @callbacks[event].delete(callback)
+      unless val
+        raise ArgumentError,
+              "Given callable object #{callback} is not registered as a #{event} callback"
+      end
+      val
+    end
+
+    def trigger(event, *args, **kwargs)
+      check_available_event(event)
+      @callbacks[event].each do |fn|
+        fn.call(*args, **kwargs)
+      end
+    end
+
+    private
+
+    def check_available_event(event)
+      return if @callbacks.key?(event)
+      raise ArgumentError, "Unknown event name: #{event}", caller
+    end
+  end
+end

data/lib/iruby/kernel.rb

@@ -1,37 +1,126 @@
 module IRuby
+  ExecutionInfo = Struct.new(:raw_cell, :store_history, :silent)
+
   class Kernel
     RED = "\e[31m"
     RESET = "\e[0m"
 
-    class<< self
+    @events = EventManager.new([:initialized])
+
+    class << self
+      # Return the event manager defined in the `IRuby::Kernel` class.
+      # This event manager can handle the following event:
+      #
+      # - `initialized`: The event occurred after the initialization of
+      #   a `IRuby::Kernel` instance is finished
+      #
+      # @example Registering initialized event
+      #   IRuby::Kernel.events.register(:initialized) do |result|
+      #     STDERR.puts "IRuby kernel has been initialized"
+      #   end
+      #
+      # @see IRuby::EventManager
+      # @see IRuby::Kernel#events
+      attr_reader :events
+
+      # Returns the singleton kernel instance
       attr_accessor :instance
     end
 
+    # Returns a session object
     attr_reader :session
 
-    def initialize(config_file)
+    EVENTS = [
+      :pre_execute,
+      :pre_run_cell,
+      :post_run_cell,
+      :post_execute
+    ].freeze
+
+    def initialize(config_file, session_adapter_name=nil)
       @config = MultiJson.load(File.read(config_file))
       IRuby.logger.debug("IRuby kernel start with config #{@config}")
       Kernel.instance = self
 
-      @session = Session.new(@config)
+      @session = Session.new(@config, session_adapter_name)
       $stdout = OStream.new(@session, :stdout)
       $stderr = OStream.new(@session, :stderr)
 
       init_parent_process_poller
 
+      @events = EventManager.new(EVENTS)
       @execution_count = 0
-      @backend = create_backend
+      @backend = PlainBackend.new
       @running = true
+
+      self.class.events.trigger(:initialized, self)
     end
 
-    def create_backend
-      PryBackend.new
-    rescue Exception => e
-      IRuby.logger.warn "Could not load PryBackend: #{e.message}\n#{e.backtrace.join("\n")}" unless LoadError === e
-      PlainBackend.new
+    # Returns the event manager defined in a `IRuby::Kernel` instance.
+    # This event manager can handle the following events:
+    #
+    # - `pre_execute`: The event occurred before running the code
+    #
+    # - `pre_run_cell`: The event occurred before running the code and
+    #   if the code execution is not silent
+    #
+    # - `post_execute`: The event occurred after running the code
+    #
+    # - `post_run_cell`: The event occurred after running the code and
+    #   if the code execution is not silent
+    #
+    # The callback functions of `pre_run_cell` event must take one argument
+    # to get an `ExecutionInfo` object.
+    # The callback functions of `post_run_cell` event must take one argument
+    # to get the result of the code execution.
+    #
+    # @example Registering post_run_cell event
+    #   IRuby::Kernel.instance.events.register(:post_run_cell) do |result|
+    #     STDERR.puts "The result of the last execution: %p" % result
+    #   end
+    #
+    # @see IRuby::EventManager
+    # @see IRuby::ExecutionInfo
+    # @see IRuby::Kernel.events
+    attr_reader :events
+
+    # Switch the backend (interactive shell) system
+    #
+    # @param backend [:irb,:plain,:pry] Specify the backend name switched to
+    #
+    # @return [true,false] true if the switching succeeds, otherwise false
+    def switch_backend!(backend)
+      name = case backend
+             when String, Symbol
+               name = backend.downcase
+             else
+               name = backend
+             end
+
+      backend_class = case name
+                      when :irb, :plain
+                        PlainBackend
+                      when :pry
+                        PryBackend
+                      else
+                        raise ArgumentError,
+                          "Unknown backend name: %p" % backend
+                      end
+
+      begin
+        new_backend = backend_class.new
+        @backend = new_backend
+        true
+      rescue Exception => e
+        unless LoadError === e
+          IRuby.logger.warn "Could not load #{backend_class}: " +
+                            "#{e.message}\n#{e.backtrace.join("\n")}"
+        end
+        return false
+      end
     end
 
+    # @private
     def run
       send_status :starting
       while @running
@@ -39,6 +128,7 @@ module IRuby
       end
     end
 
+    # @private
     def dispatch
       msg = @session.recv(:reply)
       IRuby.logger.debug "Kernel#dispatch: msg = #{msg}"
@@ -55,6 +145,7 @@ module IRuby
       @session.send(:publish, :error, error_content(e))
     end
 
+    # @private
     def kernel_info_request(msg)
       @session.send(:reply, :kernel_info_reply,
                     protocol_version: '5.0',
@@ -76,15 +167,29 @@ module IRuby
                     status: :ok)
     end
 
+    # @private
     def send_status(status)
       IRuby.logger.debug "Send status: #{status}"
       @session.send(:publish, :status, execution_state: status)
     end
 
+    # @private
     def execute_request(msg)
       code = msg[:content]['code']
-      @execution_count += 1 if msg[:content]['store_history']
-      @session.send(:publish, :execute_input, code: code, execution_count: @execution_count)
+      store_history = msg[:content]['store_history']
+      silent = msg[:content]['silent']
+
+      @execution_count += 1 if store_history
+
+      unless silent
+        @session.send(:publish, :execute_input, code: code, execution_count: @execution_count)
+      end
+
+      events.trigger(:pre_execute)
+      unless silent
+        exec_info = ExecutionInfo.new(code, store_history, silent)
+        events.trigger(:pre_run_cell, exec_info)
+      end
 
       content = {
         status: :ok,
@@ -92,9 +197,10 @@ module IRuby
         user_expressions: {},
         execution_count: @execution_count
       }
+
       result = nil
       begin
-        result = @backend.eval(code, msg[:content]['store_history'])
+        result = @backend.eval(code, store_history)
       rescue SystemExit
         content[:payload] << { source: :ask_exit }
       rescue Exception => e
@@ -103,13 +209,21 @@ module IRuby
         content[:status] = :error
         content[:execution_count] = @execution_count
       end
+
+      unless result.nil? || silent
+        @session.send(:publish, :execute_result,
+                      data: Display.display(result),
+                      metadata: {},
+                      execution_count: @execution_count)
+      end
+
+      events.trigger(:post_execute)
+      events.trigger(:post_run_cell, result) unless silent
+
       @session.send(:reply, :execute_reply, content)
-      @session.send(:publish, :execute_result,
-                    data: Display.display(result),
-                    metadata: {},
-                    execution_count: @execution_count) unless result.nil? || msg[:content]['silent']
     end
 
+    # @private
     def error_content(e)
       rindex = e.backtrace.rindex{|line| line.start_with?(@backend.eval_path)} || -1
       backtrace = SyntaxError === e  && rindex == -1 ? [] : e.backtrace[0..rindex]
@@ -118,12 +232,14 @@ module IRuby
         traceback: ["#{RED}#{e.class}#{RESET}: #{e.message}", *backtrace] }
     end
 
+    # @private
     def is_complete_request(msg)
       # FIXME: the code completeness should be judged by using ripper or other Ruby parser
       @session.send(:reply, :is_complete_reply,
                     status: :unknown)
     end
 
+    # @private
     def complete_request(msg)
       # HACK for #26, only complete last line
       code = msg[:content]['code']
@@ -139,36 +255,43 @@ module IRuby
                     status: :ok)
     end
 
+    # @private
     def connect_request(msg)
       @session.send(:reply, :connect_reply, Hash[%w(shell_port iopub_port stdin_port hb_port).map {|k| [k, @config[k]] }])
     end
 
+    # @private
     def shutdown_request(msg)
       @session.send(:reply, :shutdown_reply, msg[:content])
       @running = false
     end
 
+    # @private
     def history_request(msg)
       # we will just send back empty history for now, pending clarification
       # as requested in ipython/ipython#3806
       @session.send(:reply, :history_reply, history: [])
     end
 
+    # @private
     def inspect_request(msg)
       # not yet implemented. See (#119).
       @session.send(:reply, :inspect_reply, status: :ok, found: false, data: {}, metadata: {})
     end
 
+    # @private
     def comm_open(msg)
       comm_id = msg[:content]['comm_id']
       target_name = msg[:content]['target_name']
       Comm.comm[comm_id] = Comm.target[target_name].new(target_name, comm_id)
     end
 
+    # @private
     def comm_msg(msg)
       Comm.comm[msg[:content]['comm_id']].handle_msg(msg[:content]['data'])
     end
 
+    # @private
     def comm_close(msg)
       comm_id = msg[:content]['comm_id']
       Comm.comm[comm_id].handle_close(msg[:content]['data'])

data/lib/iruby/ostream.rb

@@ -46,6 +46,11 @@ module IRuby
       lines.each { |s| write(s) }
     end
 
+    # Called by irb
+    def set_encoding(extern, intern)
+      a = extern
+    end
+
     private
 
     def build_string

data/lib/iruby/session.rb

@@ -10,6 +10,7 @@ module IRuby
     def initialize(config, adapter_name=nil)
       @config = config
       @adapter = create_session_adapter(config, adapter_name)
+      @last_recvd_msg = nil
 
       setup
       setup_sockets

data/lib/iruby/session_adapter.rb

@@ -10,6 +10,10 @@ module IRuby
         false
       end
 
+      def self.load_requirements
+        # Do nothing
+      end
+
       def initialize(config)
         @config = config
       end
@@ -37,12 +41,14 @@ module IRuby
     require_relative 'session_adapter/ffirzmq_adapter'
     require_relative 'session_adapter/cztop_adapter'
     require_relative 'session_adapter/pyzmq_adapter'
+    require_relative 'session_adapter/test_adapter'
 
     def self.select_adapter_class(name=nil)
       classes = {
         'ffi-rzmq' => SessionAdapter::FfirzmqAdapter,
         'cztop' => SessionAdapter::CztopAdapter,
         # 'pyzmq' => SessionAdapter::PyzmqAdapter
+        'test' => SessionAdapter::TestAdapter,
       }
       if (name ||= ENV.fetch('IRUBY_SESSION_ADAPTER', nil))
         cls = classes[name]

data/lib/iruby/session_adapter/test_adapter.rb

@@ -0,0 +1,49 @@
+require 'iruby/session/mixin'
+
+module IRuby
+  module SessionAdapter
+    class TestAdapter < BaseAdapter
+      include IRuby::SessionSerialize
+
+      DummySocket = Struct.new(:type, :protocol, :host, :port)
+
+      def initialize(config)
+        super
+
+        unless config['key'].empty? || config['signature_scheme'].empty?
+          unless config['signature_scheme'] =~ /\Ahmac-/
+            raise "Unknown signature_scheme: #{config['signature_scheme']}"
+          end
+          digest_algorithm = config['signature_scheme'][/\Ahmac-(.*)\Z/, 1]
+          @hmac = OpenSSL::HMAC.new(config['key'], OpenSSL::Digest.new(digest_algorithm))
+        end
+
+        @send_callback = nil
+        @recv_callback = nil
+      end
+
+      attr_accessor :send_callback, :recv_callback
+
+      def send(sock, data)
+        unless @send_callback.nil?
+          @send_callback.call(sock, unserialize(data))
+        end
+      end
+
+      def recv(sock)
+        unless @recv_callback.nil?
+          serialize(@recv_callback.call(sock))
+        end
+      end
+
+      def heartbeat_loop(sock)
+      end
+
+      private
+
+      def make_socket(type, protocol, host, port)
+        DummySocket.new(type, protocol, host, port)
+      end
+    end
+  end
+end

data/lib/iruby/utils.rb

@@ -4,37 +4,48 @@ module IRuby
       Display.convert(object, options)
     end
 
+    # Display the object
     def display(obj, options = {})
       Kernel.instance.session.send(:publish, :display_data,
                                    data: Display.display(obj, options),
                                    metadata: {}) unless obj.nil?
+      # The next `nil` is necessary to prevent unintentional displaying
+      # the result of Session#send
+      nil
     end
 
+    # Clear the output area
     def clear_output(wait=false)
       Display.clear_output(wait)
     end
 
+    # Format the given object into HTML table
     def table(s, **options)
-      html(HTML.table(s, options))
+      html(HTML.table(s, **options))
     end
 
+    # Treat the given string as LaTeX text
     def latex(s)
       convert(s, mime: 'text/latex')
     end
     alias tex latex
 
+    # Format the given string of TeX equation into LaTeX text
     def math(s)
       convert("$$#{s}$$", mime: 'text/latex')
     end
 
+    # Treat the given string as HTML
     def html(s)
       convert(s, mime: 'text/html')
     end
 
+    # Treat the given string as JavaScript code
     def javascript(s)
       convert(s, mime: 'application/javascript')
     end
 
+    # Treat the given string as SVG text
     def svg(s)
       convert(s, mime: 'image/svg+xml')
     end