iruby 0.2.9 → 0.6.1

data/lib/iruby/input/select.rb

@@ -1,24 +1,36 @@
 module IRuby
   module Input
     class Select < Label
-      needs :options
+      needs :options, :default
 
       builder :select do |*args, **params|
         key = :select
         key, *args = args if args.first.is_a? Symbol
 
-        key = unique_key(key)
-        add_field Select.new(key: key, options: args)
+        params[:key] = unique_key(key)
+        params[:options] = args
+        params[:default] ||= false
+
+        unless params[:options].include? params[:default]
+          params[:options] = [nil, *params[:options].compact]
+        end
+
+        add_field Select.new(**params)
       end
 
       def widget_css
-        '.iruby-select { margin-left: 0 !important }'
+        <<-CSS
+          .iruby-select {
+            min-width: 25%;
+            margin-left: 0 !important;
+          }
+        CSS
       end
 
       def widget_js
         <<-JS
           $('.iruby-select').change(function(){
-            $(this).data('iruby-value', 
+            $(this).data('iruby-value',
               $(this).find('option:selected').text()
             );
           });
@@ -26,16 +38,18 @@ module IRuby
       end
 
       def widget_html
-        widget_label do 
-          div class: 'form-control' do 
+        widget_label do
+          div class: 'form-control' do
             params = {
-              class: 'iruby-select', 
+              class: 'iruby-select',
               :'data-iruby-key' => @key,
-              :'data-iruby-value' => @options.first
+              :'data-iruby-value' => @default
             }
-            
-            select **params do 
-              @options.each {|o| option o }
+
+            select **params do
+              @options.each do |o|
+                option o, selected: @default == o
+              end
             end
           end
         end

data/lib/iruby/input/textarea.rb

@@ -9,8 +9,9 @@ module IRuby
       end
 
       def widget_html
-        widget_label do 
+        widget_label do
           textarea(
+            @default,
             rows: @rows,
             :'data-iruby-key' => @key,
             class: 'form-control iruby-field'

data/lib/iruby/input/widget.rb

@@ -9,13 +9,13 @@ module IRuby
       def content; widget_html; end
 
       def self.builder method, &block
-        Builder.instance_eval do 
+        Builder.instance_eval do
           define_method method, &block
         end
       end
 
       def widget_join method, *args
-        strings = args.map do |arg| 
+        strings = args.map do |arg|
           arg.is_a?(String) ? arg : arg.send(method)
         end
         strings.uniq.join("\n")

data/lib/iruby/jupyter.rb

@@ -0,0 +1,77 @@
+module IRuby
+  module Jupyter
+    class << self
+      # User's default kernelspec directory is described here:
+      #     https://jupyter.readthedocs.io/en/latest/projects/jupyter-directories.html
+      def default_data_dir
+        case
+        when windows?
+          appdata = windows_user_appdata
+          if !appdata.empty?
+            File.join(appdata, 'jupyter')
+          else
+            jupyter_config_dir = ENV.fetch('JUPYTER_CONFIG_DIR', File.expand_path('~/.jupyter'))
+            File.join(jupyter_config_dir, 'data')
+          end
+        when apple?
+          File.expand_path('~/Library/Jupyter')
+        else
+          xdg_data_home = ENV.fetch('XDG_DATA_HOME', '')
+          data_home = xdg_data_home[0] ? xdg_data_home : File.expand_path('~/.local/share')
+          File.join(data_home, 'jupyter')
+        end
+      end
+
+      def kernelspec_dir(data_dir=nil)
+        data_dir ||= default_data_dir
+        File.join(data_dir, 'kernels')
+      end
+
+      private
+
+      # returns %APPDATA%
+      def windows_user_appdata
+        require 'fiddle/import'
+        check_windows
+        path = Fiddle::Pointer.malloc(2 * 300) # uint16_t[300]
+        csidl_appdata = 0x001a
+        case call_SHGetFolderPathW(Fiddle::NULL, csidl_appdata, Fiddle::NULL, 0, path)
+        when 0
+          len = (1 ... (path.size/2)).find {|i| path[2*i, 2] == "\0\0" }
+          path = path.to_str(2*len).encode(Encoding::UTF_8, Encoding::UTF_16LE)
+        else
+          ENV.fetch('APPDATA', '')
+        end
+      end
+
+      def call_SHGetFolderPathW(hwnd, csidl, hToken, dwFlags, pszPath)
+        require 'fiddle/import'
+        shell32 = Fiddle::Handle.new('shell32')
+        func = Fiddle::Function.new(
+          shell32['SHGetFolderPathW'],
+          [
+            Fiddle::TYPE_VOIDP,
+            Fiddle::TYPE_INT,
+            Fiddle::TYPE_VOIDP,
+            Fiddle::TYPE_INT,
+            Fiddle::TYPE_VOIDP
+          ],
+          Fiddle::TYPE_INT,
+          Fiddle::Importer.const_get(:CALL_TYPE_TO_ABI)[:stdcall])
+        func.(hwnd, csidl, hToken, dwFlags, pszPath)
+      end
+
+      def check_windows
+        raise 'the current platform is not Windows' unless windows?
+      end
+
+      def windows?
+        /mingw|mswin/ =~ RUBY_PLATFORM
+      end
+
+      def apple?
+        /darwin/ =~ RUBY_PLATFORM
+      end
+    end
+  end
+end

data/lib/iruby/kernel.rb

@@ -1,29 +1,90 @@
 module IRuby
+  ExecutionInfo = Struct.new(:raw_cell, :store_history, :silent)
+
   class Kernel
     RED = "\e[31m"
-    WHITE = "\e[37m"
     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
       @running = true
+
+      self.class.events.trigger(:initialized, self)
     end
 
+    # 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
+
+    # @private
     def create_backend
       PryBackend.new
     rescue Exception => e
@@ -31,6 +92,7 @@ module IRuby
       PlainBackend.new
     end
 
+    # @private
     def run
       send_status :starting
       while @running
@@ -38,8 +100,10 @@ module IRuby
       end
     end
 
+    # @private
     def dispatch
       msg = @session.recv(:reply)
+      IRuby.logger.debug "Kernel#dispatch: msg = #{msg}"
       type = msg[:header]['msg_type']
       raise "Unknown message type: #{msg.inspect}" unless type =~ /comm_|_request\Z/ && respond_to?(type)
       begin
@@ -50,31 +114,54 @@ module IRuby
       end
     rescue Exception => e
       IRuby.logger.debug "Kernel error: #{e.message}\n#{e.backtrace.join("\n")}"
-      @session.send(:publish, :error, error_message(e))
+      @session.send(:publish, :error, error_content(e))
     end
 
+    # @private
     def kernel_info_request(msg)
       @session.send(:reply, :kernel_info_reply,
                     protocol_version: '5.0',
                     implementation: 'iruby',
-                    banner: "IRuby #{IRuby::VERSION}",
                     implementation_version: IRuby::VERSION,
                     language_info: {
                       name: 'ruby',
                       version: RUBY_VERSION,
                       mimetype: 'application/x-ruby',
                       file_extension: '.rb'
-                    })
+                    },
+                    banner: "IRuby #{IRuby::VERSION} (with #{@session.description})",
+                    help_links: [
+                      {
+                        text: "Ruby Documentation",
+                        url:  "https://ruby-doc.org/"
+                      }
+                    ],
+                    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,
@@ -82,84 +169,137 @@ 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
-        content = error_message(e)
+        content = error_content(e)
         @session.send(:publish, :error, content)
+        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
 
-    def error_message(e)
-      { status: :error,
-        ename: e.class.to_s,
+    # @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]
+      { ename: e.class.to_s,
         evalue: e.message,
-        traceback: ["#{RED}#{e.class}#{RESET}: #{e.message}", *e.backtrace.map { |l| "#{WHITE}#{l}#{RESET}" }],
-        execution_count: @execution_count }
+        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']
-      if start = code.rindex("\n")
+      if start = code.rindex(/\s|\R/)
         code = code[start+1..-1]
         start += 1
       end
       @session.send(:reply, :complete_reply,
                     matches: @backend.complete(code),
-                    status: :ok,
                     cursor_start: start.to_i,
-                    cursor_end: msg[:content]['cursor_pos'])
+                    cursor_end: msg[:content]['cursor_pos'],
+                    metadata: {},
+                    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)
-      result = @backend.eval(msg[:content]['code'])
-      @session.send(:reply, :inspect_reply,
-                    status: :ok,
-                    data: Display.display(result),
-                    metadata: {})
-    rescue Exception => e
-      IRuby.logger.warn "Inspection error: #{e.message}\n#{e.backtrace.join("\n")}"
-      @session.send(:reply, :inspect_reply, status: :error)
+      # 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'])
       Comm.comm.delete(comm_id)
     end
+
+    private
+
+    def init_parent_process_poller
+      pid = ENV.fetch('JPY_PARENT_PID', 0).to_i
+      return unless pid > 1
+
+      case RUBY_PLATFORM
+      when /mswin/, /mingw/
+        # TODO
+      else
+        @parent_poller = start_parent_process_pollar_unix
+      end
+    end
+
+    def start_parent_process_pollar_unix
+      Thread.start do
+        IRuby.logger.warn("parent process poller thread started.")
+        loop do
+          begin
+            current_ppid = Process.ppid
+            if current_ppid == 1
+              IRuby.logger.warn("parent process appears to exited, shutting down.")
+              exit!(1)
+            end
+            sleep 1
+          rescue Errno::EINTR
+            # ignored
+          end
+        end
+      end
+    end
   end
 end