iruby 0.7.0 → 0.7.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 14aea673b75a6fe8884eff08c52b8831bbcec141df2525ed4c0a877738654271
-  data.tar.gz: 89e5e091e67b7ef85f98ca0cb9ebe65cef0e32aacd75351c81b0c287666939c0
+  metadata.gz: 8e37561d8cd48b57f5ad431cfdf984306e638a262113f2cb741cf3a7d7a8e2e1
+  data.tar.gz: b1cd1da09bd9a6158749225e0097f92442ec5d600ab6f40a6189b50d0f2a4bb6
 SHA512:
-  metadata.gz: 53b824e32c52cbf2893b24310ba4d3c7caa52ec872f36f57644a95bdd139232b4b5e032f161fb86baf94d011964caf9d739a4795af6805fd174360ed866477fa
-  data.tar.gz: ee663bca3c4a67730d73e709c24d827af73e7c58734afe4dffc22c685c909462e9c9113f9548a8f1c8b5ce33b0b94338386b24c07978db547fab1caa21828ea7
+  metadata.gz: 6f70bdf2fa9da79a2e072f8a27ae729f5656a02a1d34a14bdd01287a16bfe257732875fc7a76db3f498cfd25cf49f4a9aa5ce2c82040ec90082bfca5e5d2f4e2
+  data.tar.gz: 789fe4b197775ef1245e96db8ac039a0df166898652c689ce2f66a7eb25db99a5f4806bccb7b76cc52cbdc7c4e6a3749eebda903b586b170842c9630f50af082

data/.github/workflows/ci.yml

@@ -0,0 +1,124 @@
+name: CI
+
+on:
+  push:
+    branches:
+    - master
+  pull_request:
+    types:
+    - opened
+    - synchronize
+    - reopened
+
+jobs:
+  ubuntu:
+    name: Ubuntu
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      fail-fast: false
+      matrix:
+        os:
+        - ubuntu-latest
+        ruby:
+        - "3.0"
+        - "2.7"
+        - "2.6"
+        - "2.5"
+        - "2.4"
+        - "2.3"
+        - debug
+
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        fetch-depth: 1
+
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+
+    - run: rake build
+
+    - name: Install irb for old Ruby
+      if: |
+        matrix.ruby == '2.5' ||
+        matrix.ruby == '2.4' ||
+        matrix.ruby == '2.3'
+      run: |
+        cat <<GEMFILE > Gemfile.irb
+        source 'https://rubygems.org'
+        gem 'irb'
+        GEMFILE
+        BUNDLE_GEMFILE=Gemfile.irb bundle install --jobs 4 --retry 3
+
+    - run: gem install pkg/*.gem
+
+    - run: ruby -r iruby -e "p IRuby::SessionAdapter.select_adapter_class"
+      env:
+        IRUBY_SESSION_ADAPTER: ffi-rzmq
+
+    - name: Install requirements on ubuntu
+      run: |
+        sudo apt update
+        sudo apt install -y --no-install-recommends \
+                 libczmq-dev \
+                 python3 \
+                 python3-pip \
+                 python3-setuptools
+        sudo pip3 install wheel
+        sudo pip3 install -r ci/requirements.txt
+
+    - run: bundle install --jobs 4 --retry 3
+
+    - name: Run tests
+      env:
+        PYTHON: python3
+        ADAPTERS: cztop ffi-rzmq
+      run: |
+        for adapter in $ADAPTERS; do
+          export IRUBY_TEST_SESSION_ADAPTER_NAME=$adapter
+          bundle exec rake test TESTOPTS=-v
+        done
+
+  windows:
+    name: Windows
+    runs-on: windows-latest
+
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        fetch-depth: 1
+
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: "3.0"
+
+    - run: rake build
+
+    - run: gem install pkg/*.gem
+
+    - run: ruby -r iruby -e "p IRuby::SessionAdapter.select_adapter_class"
+      env:
+        IRUBY_SESSION_ADAPTER: ffi-rzmq
+
+  macos:
+    name: macOS
+    runs-on: macos-latest
+
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        fetch-depth: 1
+
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: "3.0"
+
+    - run: rake build
+
+    - run: gem install pkg/*.gem
+
+    - run: ruby -r iruby -e "p IRuby::SessionAdapter.select_adapter_class"
+      env:
+        IRUBY_SESSION_ADAPTER: ffi-rzmq

data/CHANGES.md

@@ -1,3 +1,35 @@
+# 0.7.4 (2021-08-16)
+
+## Enhancements
+
+* Install zeromq library automatically https://github.com/SciRuby/iruby/pull/307, https://github.com/SciRuby/iruby/pull/308 (@mrkn, @kou)
+* Remove pyzmq session adapter (@mrkn)
+* Make cztop session adapter deprecated (@mrkn)
+
+# 0.7.3 (2021-07-08)
+
+## Bug Fixes
+
+* Do not call default renderers when to_iruby_mimebundle is available (@mrkn)
+
+# 0.7.2 (2021-06-23)
+
+## Bug Fixes
+
+* Fix IRuby.table for Ruby >= 2.7 https://github.com/SciRuby/iruby/pull/305 (@topofocus)
+* Fix PlainBackend to include modules https://github.com/SciRuby/iruby/issues/303 (@UliKuch, @mrkn)
+
+# 0.7.1 (2021-06-21)
+
+## Enhancements
+
+* Add support of `to_iruby_mimebundle` format method https://github.com/SciRuby/iruby/pull/304 (@mrkn)
+
+## Bug Fixes
+
+* Prevent unintentional display the result of Session#send (@mrkn)
+* Update display formatter for Gruff::Base to prevent warning (@mrkn)
+
 # 0.7.0 (2021-05-28)
 
 ## Enhancements
@@ -7,9 +39,14 @@
 
 ## Bug Fixes
 
-* Follow the messages and hooks orders during execute_request processing (@mrkn)
 * Fix the handling of image/svg+xml https://github.com/SciRuby/iruby/pull/300, https://github.com/SciRuby/iruby/pull/301 (@kojix2)
 
+# 0.6.1 (2021-05-26)
+
+## Bug Fixes
+
+* Follow the messages and hooks orders during execute_request processing (@mrkn)
+
 # 0.6.0 (2021-05-25)
 
 ## Bug Fixes

data/README.md

@@ -21,67 +21,53 @@ https://mybinder.org/v2/gh/RubyData/binder/master?filepath=../lab
 ### Requirements
 
 * [Jupyter](https://jupyter.org)
-* One of the following is required
-    * [ffi-rzmq](https://github.com/chuckremes/ffi-rzmq) and [libzmq](https://github.com/zeromq/libzmq)
-    * [CZTop](https://gitlab.com/paddor/cztop) and [CZMQ](https://github.com/zeromq/czmq)
 
-If both ffi-rzmq and cztop are installed, ffi-rzmq is used. If you prefer cztop, set the following environment variable.
+The following requirements are automatically installed.
 
-```sh
-export IRUBY_SESSION_ADAPTER="cztop"
-```
+* [ffi-rzmq](https://github.com/chuckremes/ffi-rzmq)
+* [libzmq](https://github.com/zeromq/libzmq)
+
+The following dependencies are optional.
 
 * [Pry][Pry], if you want to use [Pry][Pry] instead of IRB for the code execution backend
-* If you want to install the development version of IRuby from the source code, try [specific_install](https://github.com/rdp/specific_install).
 
-```
-gem specific_install https://github.com/SciRuby/iruby
-```
 
-### Ubuntu
+### Installing Jupyter Notebook and/or JupyterLab
 
-Install Jupyter.
+See the official document to know how to install Jupyter Notebook and/or JupyterLab.
+
+* https://jupyter.readthedocs.io/en/latest/install/notebook-classic.html
+* https://jupyter.readthedocs.io/en/latest/install.html
+
+### Ubuntu
 
 #### Ubuntu 17+
 
 ```shell
 sudo apt install libtool libffi-dev ruby ruby-dev make
-sudo apt install libzmq3-dev libczmq-dev
 
-gem install ffi-rzmq
-gem install iruby --pre
+gem install --user-install iruby
 iruby register --force
 ```
 
 #### Ubuntu 16
 
-CZTop requires CZMQ >= 4.0.0 and ZMQ >= 4.2.0. The official packages for Ubuntu 16.04 don't satisfy these version requrements, so you need to install from source.
+The latest IRuby requires Ruby >= 2.4 while Ubuntu's official Ruby package is version 2.3.
+So you need to install Ruby >= 2.4 by yourself before preparing IRuby.
+We recommend to use rbenv.
 
 ```shell
 sudo apt install libtool libffi-dev ruby ruby-dev make
-sudo apt install git libzmq-dev autoconf pkg-config
-git clone https://github.com/zeromq/czmq
-cd czmq
-./autogen.sh && ./configure && sudo make && sudo make install
-
-gem install cztop
-gem install iruby --pre
+gem install --user-install iruby
 iruby register --force
 ```
 
 ### Windows
 
-Install git and Jupyter.
 [DevKit](https://rubyinstaller.org/add-ons/devkit.html) is necessary for building RubyGems with native C-based extensions.
 
-Install ZeroMQ.
-```shell
-pacman -S mingw64/mingw-w64-x86_64-zeromq
-```
-
 ```shell
-gem install ffi-rzmq
-gem install iruby --pre
+gem install iruby
 iruby register --force
 ```
 
@@ -93,17 +79,7 @@ Install Jupyter.
 #### Homebrew
 
 ```shell
-brew install automake gmp libtool wget
-brew install zeromq --HEAD
-brew install czmq --HEAD
-```
-
-```shell
-# export LIBZMQ_PATH=$(brew --prefix zeromq)/lib
-# export LIBCZMQ_PATH=$(brew --prefix czmq)/lib
-# gem install cztop
-gem install ffi-rzmq
-gem install iruby --pre
+gem install iruby
 iruby register --force
 ```
 
@@ -113,8 +89,8 @@ If you are using macports, run the following commands.
 
 ```shell
 port install libtool autoconf automake autogen
-gem install ffi-rzmq
 gem install iruby
+iruby register --force
 ```
 
 ### Docker
@@ -123,7 +99,7 @@ Try [RubyData Docker Stacks](https://github.com/RubyData/docker-stacks).
 Running jupyter notebook:
 
 ```shell
-docker run -p 8888:8888 rubydata/datascience-notebook
+docker run --rm -it -p 8888:8888 rubydata/datascience-notebook
 ```
 
 ### Installation for JRuby
@@ -131,7 +107,6 @@ docker run -p 8888:8888 rubydata/datascience-notebook
 You can use Java classes in your IRuby notebook.
 
 * JRuby version >= 9.0.4.0
-* cztop gem
 * iruby gem
 
 After installation, make sure that your `env` is set up to use jruby.
@@ -148,6 +123,29 @@ If you have already used IRuby with a different version, you need to generate a
 $ iruby register --force
 ```
 
+### Install the development version of IRuby
+
+**Be careful to use the development version because it is usually unstable.**
+
+If you want to install the development version of IRuby from the source code, try [specific_install](https://github.com/rdp/specific_install).
+
+```
+gem specific_install https://github.com/SciRuby/iruby
+```
+
+### Note for using with CZTop and CZMQ
+
+[CZTop](https://gitlab.com/paddor/cztop) adapter has been deprecated since IRuby version 0.7.4.
+It will be removed after several versions.
+
+If you want to use IRuby with CZTop, you need to install it and [CZMQ](https://github.com/zeromq/czmq).
+
+If both ffi-rzmq and cztop are installed, ffi-rzmq is used. If you prefer cztop, set the following environment variable.
+
+```sh
+export IRUBY_SESSION_ADAPTER="cztop"
+```
+
 ## Backends
 
 There are two backends: PlainBackend and PryBackend.

data/ext/Rakefile

@@ -0,0 +1,19 @@
+task default: :all
+
+task all: [:ensure_zeromq]
+
+task :ensure_zeromq do
+  begin
+    require 'ffi-rzmq'
+  rescue LoadError
+    require 'native-package-installer'
+    unless NativePackageInstaller.install(arch_linux: 'zeromq',
+                                          debian: 'libzmq3-dev',
+                                          freebsd: 'libzmq4',
+                                          homebrew: 'zmq',
+                                          macports: 'zmq',
+                                          redhat: 'zeromq-devel')
+      raise 'Failed to install ZeroMQ'
+    end
+  end
+end

data/iruby.gemspec

@@ -14,6 +14,7 @@ Gem::Specification.new do |s|
   s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
   s.test_files    = s.files.grep(%r{^test/})
   s.require_paths = %w[lib]
+  s.extensions    = %w[ext/Rakefile]
 
   s.required_ruby_version = '>= 2.3.0'
 
@@ -22,9 +23,12 @@ Gem::Specification.new do |s|
   s.add_dependency 'irb'
   s.add_dependency 'mime-types', '>= 3.3.1'
   s.add_dependency 'multi_json', '~> 1.11'
+  s.add_dependency 'native-package-installer'
 
   s.add_development_dependency 'pycall', '>= 1.2.1'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'test-unit'
   s.add_development_dependency 'test-unit-rr'
+
+  s.metadata['msys2_mingw_dependencies'] = 'zeromq'
 end

data/lib/iruby/backend.rb

@@ -40,6 +40,7 @@ module IRuby
       require 'irb/completion'
       IRB.setup(nil)
       @main = TOPLEVEL_BINDING.eval("self").dup
+      init_main_object(@main)
       @workspace = IRB::WorkSpace.new(@main)
       @irb = IRB::Irb.new(@workspace)
       @eval_path = @irb.context.irb_path
@@ -58,6 +59,16 @@ module IRuby
     def complete(code)
       IRB::InputCompletor::CompletionProc.call(code)
     end
+
+    private
+
+    def init_main_object(main)
+      wrapper_module = Module.new
+      main.extend(wrapper_module)
+      main.define_singleton_method(:include) do |*args|
+        wrapper_module.include(*args)
+      end
+    end
   end
 
   class PryBackend

data/lib/iruby/display.rb

@@ -2,6 +2,22 @@ require "set"
 
 module IRuby
   module Display
+    DEFAULT_MIME_TYPE_FORMAT_METHODS = {
+      "text/html" => :to_html,
+      "text/markdown" => :to_markdown,
+      "image/svg+xml" => :to_svg,
+      "image/png" => :to_png,
+      "appliation/pdf" => :to_pdf,
+      "image/jpeg" => :to_jpeg,
+      "text/latex" => [:to_latex, :to_tex],
+      # NOTE: Do not include the entry of "application/json" because
+      #       all objects can respond to `to_json` due to json library
+      # "application/json" => :to_json,
+      "application/javascript" => :to_javascript,
+      nil => :to_iruby,
+      "text/plain" => :inspect
+    }.freeze
+
     class << self
       # @private
       def convert(obj, options)
@@ -24,17 +40,51 @@ module IRuby
           raise 'Invalid mime type' unless exact_mime.include?('/')
         end
 
-        data = {}
-
-        # Render additional representation
-        render(data, obj, exact_mime, fuzzy_mime)
-
-        # IPython always requires a text representation
-        render(data, obj, 'text/plain', nil) unless data['text/plain']
+        data = if obj.respond_to?(:to_iruby_mimebundle)
+                 render_mimebundle(obj, exact_mime, fuzzy_mime)
+               else
+                 {}
+               end
+
+        # Render by additional formatters
+        render_by_registry(data, obj, exact_mime, fuzzy_mime)
+
+        # Render by to_xxx methods
+        default_renderers = if obj.respond_to?(:to_iruby_mimebundle)
+                              # Do not use Hash#slice for Ruby < 2.5
+                              {"text/plain" => DEFAULT_MIME_TYPE_FORMAT_METHODS["text/plain"]}
+                            else
+                              DEFAULT_MIME_TYPE_FORMAT_METHODS
+                            end
+        default_renderers.each do |mime, methods|
+          next if mime.nil? && !data.empty? # for to_iruby
+
+          next if mime && data.key?(mime)   # do not overwrite
+
+          method = Array(methods).find {|m| obj.respond_to?(m) }
+          next if method.nil?
+
+          result = obj.send(method)
+          case mime
+          when nil # to_iruby
+            case result
+            when nil
+              # do nothing
+              next
+            when Array
+              mime, result = result
+            else
+              warn(("Ignore the result of to_iruby method of %p because " +
+                    "it does not return a pair of mime-type and formatted representation") % obj)
+              next
+            end
+          end
+          data[mime] = result
+        end
 
         # As a last resort, interpret string representation of the object
         # as the given mime type.
-        if exact_mime && data.none? { |m, _| exact_mime == m }
+        if exact_mime && !data.key?(exact_mime)
           data[exact_mime] = protect(exact_mime, obj)
         end
 
@@ -67,7 +117,19 @@ module IRuby
         end
       end
 
-      def render(data, obj, exact_mime, fuzzy_mime)
+      private def render_mimebundle(obj, exact_mime, fuzzy_mime)
+        data = {}
+        include_mime = [exact_mime].compact
+        formats, metadata = obj.to_iruby_mimebundle(include: include_mime)
+        formats.each do |mime, value|
+          if fuzzy_mime.nil? || mime.include?(fuzzy_mime)
+            data[mime] = value
+          end
+        end
+        data
+      end
+
+      private def render_by_registry(data, obj, exact_mime, fuzzy_mime)
         # Filter matching renderer by object type
         renderer = Registry.renderer.select { |r| r.match?(obj) }
 
@@ -88,6 +150,8 @@ module IRuby
         # Return first render result which has the right mime type
         renderer.each do |r|
           mime, result = r.render(obj)
+          next if data.key?(mime)
+
           if mime && result && (!exact_mime || exact_mime == mime) && (!fuzzy_mime || mime.include?(fuzzy_mime))
             data[mime] = protect(mime, result)
             break
@@ -98,6 +162,19 @@ module IRuby
       end
     end
 
+    private def render_by_to_iruby(data, obj)
+      if obj.respond_to?(:to_iruby)
+        result = obj.to_iruby
+        mime, rep = case result
+                    when Array
+                      result
+                    else
+                      [nil, result]
+                    end
+        data[mime] = rep
+      end
+    end
+
     class Representation
       attr_reader :object, :options
 
@@ -120,6 +197,60 @@ module IRuby
       end
     end
 
+    class FormatMatcher
+      def initialize(&block)
+        @block = block
+      end
+
+      def call(obj)
+        @block.(obj)
+      end
+
+      def inspect
+        "#{self.class.name}[%p]" % @block
+      end
+    end
+
+    class RespondToFormatMatcher < FormatMatcher
+      def initialize(name)
+        super() {|obj| obj.respond_to?(name) }
+        @name = name
+      end
+
+      attr_reader :name
+
+      def inspect
+        "#{self.class.name}[respond_to?(%p)]" % name
+      end
+    end
+
+    class TypeFormatMatcher < FormatMatcher
+      def initialize(class_block)
+        super() do |obj|
+          begin
+            self.klass === obj
+          # We have to rescue all exceptions since constant autoloading could fail with a different error
+          rescue Exception
+            false
+          end
+        end
+        @class_block = class_block
+      end
+
+      def klass
+        @class_block.()
+      end
+
+      def inspect
+        klass = begin
+                  @class_block.()
+                rescue Exception
+                  @class_block
+                end
+        "#{self.class.name}[%p]" % klass
+      end
+    end
+
     class Renderer
       attr_reader :match, :mime, :priority
 
@@ -147,37 +278,22 @@ module IRuby
         @renderer ||= []
       end
 
-      SUPPORTED_MIMES = %w[
-        text/plain
-        text/html
-        text/latex
-        application/json
-        application/javascript
-        image/png
-        image/jpeg
-        image/svg+xml
-      ]
-
       def match(&block)
-        @match = block
+        @match = FormatMatcher.new(&block)
         priority 0
         nil
       end
 
       def respond_to(name)
-        match { |obj| obj.respond_to?(name) }
+        @match = RespondToFormatMatcher.new(name)
+        priority 0
+        nil
       end
 
       def type(&block)
-        match do |obj|
-          begin
-            block.call === obj
-          # We have to rescue all exceptions since constant autoloading could fail with a different error
-          rescue Exception
-          rescue #NameError
-            false
-          end
-        end
+        @match = TypeFormatMatcher.new(block)
+        priority 0
+        nil
       end
 
       def priority(p)
@@ -275,13 +391,24 @@ module IRuby
         end
       end
 
+      format_magick_image = ->(obj) do
+        format = obj.format || 'PNG'
+        [
+          format == 'PNG' ? 'image/png' : 'image/jpeg',
+          obj.to_blob {|i| i.format = format }
+        ]
+      end
+
       match do |obj|
         defined?(Magick::Image) && Magick::Image === obj ||
           defined?(MiniMagick::Image) && MiniMagick::Image === obj
       end
+      format 'image', &format_magick_image
+
+      type { Gruff::Base }
       format 'image' do |obj|
-        format = obj.format || 'PNG'
-        [format == 'PNG' ? 'image/png' : 'image/jpeg', obj.to_blob { |i| i.format = format }]
+        image = obj.to_image
+        format_magick_image.(obj.to_image)
       end
 
       match do |obj|
@@ -298,39 +425,19 @@ module IRuby
         end
       end
 
-      type { Gruff::Base }
-      format 'image/png', &:to_blob
-
-      respond_to :to_html
-      format 'text/html', &:to_html
-
-      respond_to :to_latex
-      format 'text/latex', &:to_latex
-
-      respond_to :to_tex
-      format 'text/latex', &:to_tex
-
-      respond_to :to_javascript
-      format 'text/javascript', &:to_javascript
-
-      respond_to :to_svg
+      type { Rubyvis::Mark }
       format 'image/svg+xml' do |obj|
-        obj.render if defined?(Rubyvis) && Rubyvis::Mark === obj
+        obj.render
         obj.to_svg
       end
 
-      respond_to :to_iruby
-      format(&:to_iruby)
-
       match { |obj| obj.respond_to?(:path) && obj.method(:path).arity == 0 && File.readable?(obj.path) }
       format do |obj|
         mime = MIME::Types.of(obj.path).first.to_s
-        [mime, File.read(obj.path)] if SUPPORTED_MIMES.include?(mime)
+        if mime && DEFAULT_MIME_TYPE_FORMAT_METHODS.key?(mime)
+          [mime, File.read(obj.path)]
+        end
       end
-
-      type { Object }
-      priority(-1000)
-      format 'text/plain', &:inspect
     end
   end
 end

data/lib/iruby/session/mixin.rb

@@ -23,7 +23,7 @@ module IRuby
       idents, msg_list = frames[0..i-1], frames[i+1..-1]
 
       minlen = 5
-      raise 'malformed message, must have at least #{minlen} elements' unless msg_list.length >= minlen
+      raise "malformed message, must have at least #{minlen} elements" unless msg_list.length >= minlen
       s, header, parent_header, metadata, content, buffers = *msg_list
       raise 'Invalid signature' unless s == sign(msg_list[1..-1])
       {

data/lib/iruby/session_adapter.rb

@@ -40,14 +40,12 @@ 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))
@@ -61,6 +59,9 @@ module IRuby
                   "Session adapter `#{name}` is unavailable"
           end
         end
+        if name == 'cztop'
+          warn "WARNING: cztop was deprecated and will be removed; Use ffi-rzmq, instead."
+        end
         return cls
       end
       classes.each_value do |cls|

data/lib/iruby/utils.rb

@@ -9,6 +9,9 @@ module IRuby
       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
@@ -18,7 +21,7 @@ module IRuby
 
     # 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

data/lib/iruby/version.rb

@@ -1,3 +1,3 @@
 module IRuby
-  VERSION = '0.7.0'
+  VERSION = '0.7.4'
 end

data/test/iruby/backend_test.rb

@@ -8,6 +8,12 @@ module IRubyTest
       assert_equal 3, @plainbackend.eval('1+2', false)
     end
 
+    def test_include_module
+      assert_nothing_raised do
+        @plainbackend.eval("include Math, Comparable", false)
+      end
+    end
+
     def test_complete_req
       assert_includes @plainbackend.complete('req'), 'require'
     end
@@ -26,6 +32,12 @@ module IRubyTest
       assert_equal 3, @prybackend.eval('1+2', false)
     end
 
+    def test_include_module
+      assert_nothing_raised do
+        @prybackend.eval("include Math, Comparable", false)
+      end
+    end
+
     def test_complete_req
       assert_includes @prybackend.complete('req'), 'require'
     end

data/test/iruby/display_test.rb

@@ -0,0 +1,185 @@
+module IRubyTest
+  class DisplayTest < TestBase
+    def setup
+      @object = Object.new
+      @object.instance_variable_set(:@to_html_called, false)
+      @object.instance_variable_set(:@to_markdown_called, false)
+      @object.instance_variable_set(:@to_iruby_called, false)
+      @object.instance_variable_set(:@to_iruby_mimebundle_called, false)
+
+      class << @object
+        attr_reader :to_html_called
+        attr_reader :to_markdown_called
+        attr_reader :to_iruby_called
+        attr_reader :to_iruby_mimebundle_called
+
+        def html
+          "<b>html</b>"
+        end
+
+        def markdown
+          "*markdown*"
+        end
+
+        def inspect
+          "!!! inspect !!!"
+        end
+      end
+    end
+
+    def define_to_html
+      class << @object
+        def to_html
+          @to_html_called = true
+          html
+        end
+      end
+    end
+
+    def define_to_markdown
+      class << @object
+        def to_markdown
+          @to_markdown_called = true
+          markdown
+        end
+      end
+    end
+
+    def define_to_iruby
+      class << @object
+        def to_iruby
+          @to_iruby_called = true
+          ["text/html", "<b>to_iruby</b>"]
+        end
+      end
+    end
+
+    def define_to_iruby_mimebundle
+      class << @object
+        def to_iruby_mimebundle(include: [])
+          @to_iruby_mimebundle_called = true
+          mimes = if include.empty?
+                    ["text/markdown", "application/json"]
+                  else
+                    include
+                  end
+          formats = mimes.map { |mime|
+            result = case mime
+                     when "text/markdown"
+                       "**markdown**"
+                     when "application/json"
+                       %Q[{"mimebundle": "json"}]
+                     end
+            [mime, result]
+          }.to_h
+          metadata = {}
+          return formats, metadata
+        end
+      end
+    end
+
+    def assert_iruby_display(expected)
+      assert_equal(expected,
+                   {
+                     result: IRuby::Display.display(@object),
+                     to_html_called: @object.to_html_called,
+                     to_markdown_called: @object.to_markdown_called,
+                     to_iruby_called: @object.to_iruby_called,
+                     to_iruby_mimebundle_called: @object.to_iruby_mimebundle_called
+                   })
+    end
+
+    sub_test_case("the object cannot handle all the mime types") do
+      def test_display
+        assert_iruby_display({
+                               result: {"text/plain" => "!!! inspect !!!"},
+                               to_html_called: false,
+                               to_markdown_called: false,
+                               to_iruby_called: false,
+                               to_iruby_mimebundle_called: false
+                             })
+      end
+    end
+
+    sub_test_case("the object can respond to to_iruby") do
+      def setup
+        super
+        define_to_iruby
+      end
+
+      def test_display
+        assert_iruby_display({
+                               result: {
+                                 "text/html" => "<b>to_iruby</b>",
+                                 "text/plain" => "!!! inspect !!!"
+                               },
+                               to_html_called: false,
+                               to_markdown_called: false,
+                               to_iruby_called: true,
+                               to_iruby_mimebundle_called: false
+                             })
+      end
+
+      sub_test_case("the object can respond to to_markdown") do
+        def setup
+          super
+          define_to_markdown
+        end
+
+        def test_display
+          assert_iruby_display({
+                                 result: {
+                                   "text/markdown" => "*markdown*",
+                                   "text/plain" => "!!! inspect !!!"
+                                 },
+                                 to_html_called: false,
+                                 to_markdown_called: true,
+                                 to_iruby_called: false,
+                                 to_iruby_mimebundle_called: false
+                               })
+        end
+      end
+
+      sub_test_case("the object can respond to to_html") do
+        def setup
+          super
+          define_to_html
+        end
+
+        def test_display
+          assert_iruby_display({
+                                 result: {
+                                   "text/html" => "<b>html</b>",
+                                   "text/plain" => "!!! inspect !!!"
+                                 },
+                                 to_html_called: true,
+                                 to_markdown_called: false,
+                                 to_iruby_called: false,
+                                 to_iruby_mimebundle_called: false
+                               })
+        end
+
+        sub_test_case("the object can respond to to_iruby_mimebundle") do
+          def setup
+            super
+            define_to_iruby_mimebundle
+          end
+
+          def test_display
+            assert_iruby_display({
+                                   result: {
+                                     "text/markdown" => "**markdown**",
+                                     "application/json" => %Q[{"mimebundle": "json"}],
+                                     "text/plain" => "!!! inspect !!!"
+                                   },
+                                   to_html_called: false,
+                                   to_markdown_called: false,
+                                   to_iruby_called: false,
+                                   to_iruby_mimebundle_called: true
+                                 })
+          end
+        end
+      end
+    end
+  end
+end

data/test/iruby/session_adapter_test.rb

@@ -14,7 +14,6 @@ module IRubyTest
       assert_rr do
         stub(IRuby::SessionAdapter::CztopAdapter).available? { true }
         stub(IRuby::SessionAdapter::FfirzmqAdapter).available? { false }
-        stub(IRuby::SessionAdapter::PyzmqAdapter).available? { false }
 
         cls = IRuby::SessionAdapter.select_adapter_class
         assert_equal IRuby::SessionAdapter::CztopAdapter, cls
@@ -25,25 +24,12 @@ module IRubyTest
       assert_rr do
         stub(IRuby::SessionAdapter::FfirzmqAdapter).available? { true }
         stub(IRuby::SessionAdapter::CztopAdapter).available? { false }
-        stub(IRuby::SessionAdapter::PyzmqAdapter).available? { false }
 
         cls = IRuby::SessionAdapter.select_adapter_class
         assert_equal IRuby::SessionAdapter::FfirzmqAdapter, cls
       end
     end
 
-    def test_select_adapter_class_with_pyzmq
-      omit("pyzmq adapter is disabled")
-      assert_rr do
-        stub(IRuby::SessionAdapter::PyzmqAdapter).available? { true }
-        stub(IRuby::SessionAdapter::FfirzmqAdapter).available? { false }
-        stub(IRuby::SessionAdapter::CztopAdapter).available? { false }
-
-        cls = IRuby::SessionAdapter.select_adapter_class
-        assert_equal IRuby::SessionAdapter::PyzmqAdapter, cls
-      end
-    end
-
     def test_select_adapter_class_with_env
       with_env('IRUBY_SESSION_ADAPTER' => 'cztop') do
         assert_rr do
@@ -72,20 +58,6 @@ module IRubyTest
           end
         end
       end
-
-      with_env('IRUBY_SESSION_ADAPTER' => 'pyzmq') do
-        # pyzmq adapter is disabled
-        #
-        # IRuby::SessionAdapter::PyzmqAdapter.stub :available?, true do
-        #   assert_equal IRuby::SessionAdapter::PyzmqAdapter, IRuby::SessionAdapter.select_adapter_class
-        # end
-        #
-        # IRuby::SessionAdapter::PyzmqAdapter.stub :available?, false do
-        #   assert_raises IRuby::SessionAdapterNotFound do
-        #     IRuby::SessionAdapter.select_adapter_class
-        #   end
-        # end
-      end
     end
   end
 end

data/test/iruby/session_test.rb

@@ -22,9 +22,6 @@ module IRubyTest
                         IRuby::SessionAdapter::CztopAdapter
                       when 'ffi-rzmq'
                         IRuby::SessionAdapter::FfirzmqAdapter
-                      when 'pyzmq'
-                        omit("pyzmq adapter is disabled")
-                        # IRuby::SessionAdapter::PyzmqAdapter
                       else
                         flunk "Unknown session adapter: #{adapter_name.inspect}"
                       end
@@ -37,7 +34,6 @@ module IRubyTest
       assert_rr do
         stub(IRuby::SessionAdapter::CztopAdapter).available? { false }
         stub(IRuby::SessionAdapter::FfirzmqAdapter).available? { false }
-        stub(IRuby::SessionAdapter::PyzmqAdapter).available? { false }
         stub(IRuby::SessionAdapter::TestAdapter).available? { false }
         assert_raises IRuby::SessionAdapterNotFound do
           IRuby::Session.new(@session_config)

data/test/iruby/utils_test.rb

@@ -0,0 +1,25 @@
+module IRubyTest
+  class UtilsTest < TestBase
+    sub_test_case("IRuby.table") do
+      def setup
+        @data = {
+          X: [ 1, 2, 3 ],
+          Y: [ 4, 5, 6 ]
+        }
+      end
+      sub_test_case("without header: option") do
+        def test_table
+          result = IRuby.table(@data)
+          assert_include(result.object, "<th>X</th>")
+        end
+      end
+
+      sub_test_case("with header: false") do
+        def test_table
+          result = IRuby.table(@data, header: false)
+          assert_not_include(result.object, "<th>X</th>")
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: iruby
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.4
 platform: ruby
 authors:
 - Daniel Mendler
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-28 00:00:00.000000000 Z
+date: 2021-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: data_uri
@@ -81,6 +81,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: native-package-installer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pycall
   requirement: !ruby/object:Gem::Requirement
@@ -142,10 +156,11 @@ email:
 - mail@daniel-mendler.de
 executables:
 - iruby
-extensions: []
+extensions:
+- ext/Rakefile
 extra_rdoc_files: []
 files:
-- ".github/workflows/ubuntu.yml"
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - CHANGES.md
 - Gemfile
@@ -158,6 +173,7 @@ files:
 - ci/requirements.txt
 - docker/setup.sh
 - docker/test.sh
+- ext/Rakefile
 - iruby.gemspec
 - lib/iruby.rb
 - lib/iruby/assets/kernel.css
@@ -200,7 +216,6 @@ files:
 - lib/iruby/session_adapter.rb
 - lib/iruby/session_adapter/cztop_adapter.rb
 - lib/iruby/session_adapter/ffirzmq_adapter.rb
-- lib/iruby/session_adapter/pyzmq_adapter.rb
 - lib/iruby/session_adapter/test_adapter.rb
 - lib/iruby/utils.rb
 - lib/iruby/version.rb
@@ -213,6 +228,7 @@ files:
 - test/integration_test.rb
 - test/iruby/backend_test.rb
 - test/iruby/command_test.rb
+- test/iruby/display_test.rb
 - test/iruby/event_manager_test.rb
 - test/iruby/jupyter_test.rb
 - test/iruby/kernel_test.rb
@@ -223,11 +239,13 @@ files:
 - test/iruby/session_adapter/session_adapter_test_base.rb
 - test/iruby/session_adapter_test.rb
 - test/iruby/session_test.rb
+- test/iruby/utils_test.rb
 - test/run-test.rb
 homepage: https://github.com/SciRuby/iruby
 licenses:
 - MIT
-metadata: {}
+metadata:
+  msys2_mingw_dependencies: zeromq
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -243,7 +261,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.0.dev
+rubygems_version: 3.2.23
 signing_key: 
 specification_version: 4
 summary: Ruby Kernel for Jupyter
@@ -252,6 +270,7 @@ test_files:
 - test/integration_test.rb
 - test/iruby/backend_test.rb
 - test/iruby/command_test.rb
+- test/iruby/display_test.rb
 - test/iruby/event_manager_test.rb
 - test/iruby/jupyter_test.rb
 - test/iruby/kernel_test.rb
@@ -262,4 +281,5 @@ test_files:
 - test/iruby/session_adapter/session_adapter_test_base.rb
 - test/iruby/session_adapter_test.rb
 - test/iruby/session_test.rb
+- test/iruby/utils_test.rb
 - test/run-test.rb

data/.github/workflows/ubuntu.yml

@@ -1,62 +0,0 @@
-name: CI
-
-on:
-- push
-- pull_request
-
-jobs:
-  test:
-    name: Test
-    runs-on: ${{ matrix.os }}
-
-    strategy:
-      fail-fast: false
-      matrix:
-        os:
-        - ubuntu-20.04
-        - ubuntu-latest
-        ruby:
-        - 3.0
-        - 2.7
-        - 2.6
-        - 2.5
-        - 2.4
-        - 2.3
-        - debug
-
-    steps:
-    - uses: actions/checkout@v2
-      with:
-        fetch-depth: 1
-
-    - uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: ${{ matrix.ruby }}
-
-    - name: Install requirements on ubuntu
-      run: |
-        sudo apt install -y --no-install-recommends \
-                 libczmq-dev \
-                 python3 \
-                 python3-pip \
-                 python3-setuptools
-        sudo pip3 install wheel
-        sudo pip3 install -r ci/requirements.txt
-
-    - run: gem install bundler
-
-    - run: bundle install --jobs 4 --retry 3
-
-    - name: Run tests
-      env:
-        PYTHON: python3
-        ADAPTERS: cztop ffi-rzmq pyzmq
-      run: |
-        for adapter in $ADAPTERS; do
-          export IRUBY_TEST_SESSION_ADAPTER_NAME=$adapter
-          bundle exec rake test TESTOPTS=-v
-        done
-
-    - run: rake build
-
-    - run: gem install pkg/*.gem

data/lib/iruby/session_adapter/pyzmq_adapter.rb

@@ -1,77 +0,0 @@
-module IRuby
-  module SessionAdapter
-    class PyzmqAdapter < BaseAdapter
-
-      class << self
-        def load_requirements
-          require 'pycall'
-          import_pyzmq
-        end
-
-        def import_pyzmq
-          @zmq = PyCall.import_module('zmq')
-        rescue PyCall::PyError => error
-          raise LoadError, error.message
-        end
-
-        attr_reader :zmq
-      end
-
-      def make_router_socket(protocol, host, port)
-        make_socket(:ROUTER, protocol, host, port)
-      end
-
-      def make_pub_socket(protocol, host, port)
-        make_socket(:PUB, protocol, host, port)
-      end
-
-      def heartbeat_loop(sock)
-        PyCall.sys.path.append(File.expand_path('../pyzmq', __FILE__))
-        heartbeat = PyCall.import_module('iruby.heartbeat')
-        @heartbeat_thread = heartbeat.Heartbeat.new(sock)
-        @heartbeat_thread.start
-      end
-
-      private
-
-      def socket_type(type_symbol)
-        case type_symbol
-        when :ROUTER, :PUB, :REP
-          zmq[type_symbol]
-        else
-          raise ArgumentError, "Unknown ZMQ socket type: #{type_symbol}"
-        end
-      end
-
-      def make_socket(type_symbol, protocol, host, port)
-        type = socket_type(type_symbol)
-        sock = zmq_context.socket(type)
-        bind_socket(sock, protocol, host, port)
-        sock
-      end
-
-      def bind_socket(sock, protocol, host, port)
-        iface = "#{protocol}://#{host}"
-        case protocol
-        when 'tcp'
-          if port <= 0
-            port = sock.bind_to_random_port(iface)
-          else
-            sock.bind("#{iface}:#{port}")
-          end
-        else
-          raise ArgumentError, "Unsupported protocol: #{protocol}"
-        end
-        [sock, port]
-      end
-
-      def zmq_context
-        zmq.Context.instance
-      end
-
-      def zmq
-        self.class.zmq
-      end
-    end
-  end
-end