iruby 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc4c6b99aa811b7b1e6bf3e845c7dfa023dc26ce929dbc284836081d422c4b5f
-  data.tar.gz: f68c0f62665ec6bb302e460885ca6e54e93f7102b3cdf699cb67143155a6181a
+  metadata.gz: 84f8ef4d7c7ae64831b901c85aa2e978bd07847c5707899bc82f7f3eed17a825
+  data.tar.gz: 2a2b12b2d7da7571a41286b3de58813c8f3173136bc47cd63516254682f76421
 SHA512:
-  metadata.gz: 2de933258f837300d49209e51140276d9373ab6497c716cfe590d8e9e989d89a7e8e12410e4275c20d065e0fdfe1221c88074eb172bcadbab07c58077009d118
-  data.tar.gz: 3dfa8d4abbe218873e42626056d68bc24e2372f153f18316eb152ce08aa1f95c68b301cb41f7cf154ae8b5bb94324e9071296ff67f90325aed5b08dfa123cecd
+  metadata.gz: '079c7183d157d4ca8177ca0025c4a8cfa95bb7cfa1497bfc2d65c9f4b38e00d92d4597ed54557c4ea03cfe56c93ed44768fa17b20fe29957078d8f4074e3f1c3'
+  data.tar.gz: 23a5d31658720706a3e5b2a9db90747e135a5ef473a8eadf554e6ceaa5eab1c0f035ba17161d1c10bcbeb952908b409c4d51144b23c566a15839c3d1574e7da9

data/CHANGES

@@ -1,3 +1,8 @@
+0.6.1 (under development)
+
+  Bug Fixes:
+    * Follow the messages and hooks orders during execute_request processing (@mrkn)
+
 0.6.0 (2021-05-25)
 
   Bug Fixes:

data/lib/iruby/display.rb

@@ -1,10 +1,12 @@
 module IRuby
   module Display
     class << self
+      # @private
       def convert(obj, options)
         Representation.new(obj, options)
       end
 
+      # @private
       def display(obj, options = {})
         obj = convert(obj, options)
         options = obj.options
@@ -37,6 +39,7 @@ module IRuby
         data
       end
 
+      # @private
       def clear_output(wait = false)
         IRuby::Kernel.instance.session.send(:publish, :clear_output, wait: wait)
       end

data/lib/iruby/kernel.rb

@@ -8,10 +8,26 @@ module IRuby
     @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
 
     EVENTS = [
@@ -40,8 +56,35 @@ module IRuby
       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
@@ -49,6 +92,7 @@ module IRuby
       PlainBackend.new
     end
 
+    # @private
     def run
       send_status :starting
       while @running
@@ -56,6 +100,7 @@ module IRuby
       end
     end
 
+    # @private
     def dispatch
       msg = @session.recv(:reply)
       IRuby.logger.debug "Kernel#dispatch: msg = #{msg}"
@@ -72,6 +117,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',
@@ -93,11 +139,13 @@ 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']
       store_history = msg[:content]['store_history']
@@ -134,16 +182,20 @@ module IRuby
         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]
@@ -152,12 +204,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']
@@ -173,36 +227,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/utils.rb

@@ -4,37 +4,45 @@ 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?
     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))
     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

data/lib/iruby/version.rb

@@ -1,3 +1,3 @@
 module IRuby
-  VERSION = '0.6.0'
+  VERSION = '0.6.1'
 end

data/test/iruby/kernel_test.rb

@@ -70,7 +70,7 @@ module IRubyTest
       @kernel.execute_request(msg)
 
       assert_equal({
-                     msg_types: [ "execute_input", "execute_reply", "execute_result" ],
+                     msg_types: [ "execute_input", "execute_result", "execute_reply" ],
                      execute_reply: {
                        status: "ok",
                        user_expressions: {},

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: iruby
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Daniel Mendler
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-25 00:00:00.000000000 Z
+date: 2021-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: data_uri