iruby 0.8.0 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e413c79b6abf037b0f2052ee0eed3c5176cdbcce91432330c02a6fabfd1bed2
-  data.tar.gz: c3d551239522d942ef1356f831a48e50bdadc233d0ceb0b8ba3e95a48017902b
+  metadata.gz: 4f389a45d763afc30ae093cb65b479b727bde7f1a4ecf04246329f56099ec280
+  data.tar.gz: 16dc91aaba973d5b0e8cc4c2d9444266c9c8f479704a5394103a732f2f70ba01
 SHA512:
-  metadata.gz: 3e3782105ba5ea49520760220fd88acab086c58600f73be2c74c822be08a7ec094e18e75084ea8bd676486d473f92ad37a40c72b9ebc64325fea1649c40edab3
-  data.tar.gz: 2ed1524ee160602a494192bc3b8734c7f416aa3ae4beb24a3a541852bde3d565938a2ffb43916b4112c7f215cdef1509f1e5326a960b22d213575fa95c3229c6
+  metadata.gz: a2fcf2691c1f795abad87a5bfe174f17dd49980c11a6ffc1c3fc665e4345cf14caf3be273ff6123224864d261b9b6b730c9bd16907dcd535d2a168ce07f6763a
+  data.tar.gz: 523123ce6314e0f5e5e49dc0156dd00e6d3aac45b49af8780009df1977c7edd3306388ed2b3375a315ed5267da0c2311a6da21bbd0fffae58ef8fe19a8079ce6

data/.github/workflows/ci.yml

@@ -3,10 +3,7 @@ name: CI
 on:
   push:
   pull_request:
-    types:
-      - opened
-      - synchronize
-      - reopened
+  workflow_dispatch:
 
 jobs:
   ubuntu:
@@ -19,11 +16,14 @@ jobs:
         os:
           - ubuntu-latest
         ruby:
+          - "3.4"
           - "3.3"
           - "3.2"
           - "3.1"
           - "3.0"
           - "2.7"
+          - "2.6"
+          - "2.5"
           - debug
 
     steps:
@@ -37,17 +37,41 @@ jobs:
 
       - run: rake build
 
-      - name: Install ffi 1.6 for old Ruby
+      - name: Install ffi (if Ruby 2.7)
         if: |
           matrix.ruby == '2.7'
         run: |
           cat <<GEMFILE > Gemfile.irb
           source 'https://rubygems.org'
-          gem 'ffi', '~> 1.6'
+          gem 'ffi'
           GEMFILE
           BUNDLE_GEMFILE=Gemfile.irb bundle install --jobs 4 --retry 3
 
-      - run: gem install pkg/*.gem
+      - name: Install ffi 1.6.x (if Ruby 2.6)
+        if: |
+          matrix.ruby == '2.6'
+        run: |
+          cat <<GEMFILE > Gemfile.irb
+          source 'https://rubygems.org'
+          gem 'ffi', '~> 1.6.0'
+          GEMFILE
+          BUNDLE_GEMFILE=Gemfile.irb bundle install --jobs 4 --retry 3
+
+      - name: Install ffi 1.6.x and irb < 1.4.3 (if Ruby 2.5)
+        if: |
+          matrix.ruby == '2.5'
+        run: |
+          cat <<GEMFILE > Gemfile.irb
+          source 'https://rubygems.org'
+          gem 'ffi', '~> 1.6.0'
+          gem 'irb', '< 1.4.3'
+          GEMFILE
+          BUNDLE_GEMFILE=Gemfile.irb bundle install --jobs 4 --retry 3
+
+      - name: Install IRuby gem
+        run: |
+          gem install rubygems-requirements-system
+          gem install pkg/*.gem
 
       - run: ruby -r iruby -e "p IRuby::SessionAdapter.select_adapter_class"
         env:
@@ -112,7 +136,7 @@ jobs:
 
       - run: rake build
 
-      - run: gem install pkg/*.gem
+      - run: gem install rubygems-requirements-system pkg/*.gem
 
       - run: ruby -r iruby -e "p IRuby::SessionAdapter.select_adapter_class"
         env:

data/CHANGES.md

@@ -1,3 +1,21 @@
+# 0.8.2 (2025-04-10)
+
+* Update CI to refresh apt packages before installing IRuby gem by @kojix2 in https://github.com/SciRuby/iruby/pull/367
+* Fix missing `OStream#closed?` method by @RobinDaugherty in https://github.com/SciRuby/iruby/pull/368
+* Use rubygems-requirements-system to install system dependencies automatically by @kou in https://github.com/SciRuby/iruby/pull/369
+* Various typo corrections by @kojix2 in https://github.com/SciRuby/iruby/pull/370
+* Minor changes to README by @kojix2 in https://github.com/SciRuby/iruby/pull/371
+
+# 0.8.1 (2025-02-16)
+
+* Add support for jupyter widgets by @matt-do-it in https://github.com/SciRuby/iruby/pull/350
+* Suppress "literal string will be frozen in the future" warning by @tikkss in https://github.com/SciRuby/iruby/pull/353
+* Fix warnings in project by @simpl1g in https://github.com/SciRuby/iruby/pull/356
+* restore support for IRB <= v1.13.0 by @sealocal in https://github.com/SciRuby/iruby/pull/358
+* Restore ruby 2.6 and 2.5 in CI by @sealocal in https://github.com/SciRuby/iruby/pull/359
+* Add Ruby 3.4 to CI by @kojix2 in https://github.com/SciRuby/iruby/pull/360
+* Fix NoMethodError in backend by @edsinclair in https://github.com/SciRuby/iruby/pull/364
+
 # 0.8.0 (2024-07-28)
 
 * Hide output on assignment by @ankane in https://github.com/SciRuby/iruby/pull/312

data/Gemfile

@@ -1,4 +1,7 @@
 source 'https://rubygems.org'
+
+plugin 'rubygems-requirements-system'
+
 gemspec
 
 group :pry do
@@ -15,3 +18,8 @@ end
 group :test do
   gem 'cztop'
 end
+
+# Tests are failing on Ruby 3.3 because warnings related to OpenStruct are being written to the standard error output.
+# This is being captured by Open3.capture2e and then mistakenly parsed as JSON.
+# This gem can be removed when json gem is updated
+gem 'ostruct'

data/README.md

@@ -4,7 +4,7 @@
 [![Build Status](https://github.com/SciRuby/iruby/workflows/CI/badge.svg)](https://github.com/SciRuby/iruby/actions)
 [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/RubyData/binder/master?filepath=ruby-data.ipynb)
 
-IRuby is a Ruby kernel for [Jupyter project](http://try.jupyter.org/).
+IRuby is a Ruby kernel for [Jupyter project](https://jupyter.org/).
 
 ## Try IRuby
 
@@ -20,54 +20,44 @@ The following URL launches JupyterLab directly on Binder.
 
 ### Requirements
 
-* [Jupyter](https://jupyter.org)
+- [Jupyter](https://jupyter.org)
 
 The following requirements are automatically installed.
 
-* [ffi-rzmq](https://github.com/chuckremes/ffi-rzmq)
-* [libzmq](https://github.com/zeromq/libzmq)
+- [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
+- [Pry][Pry], if you want to use [Pry][Pry] instead of IRB for the code execution backend
 
 ### Installing Jupyter Notebook and/or JupyterLab
 
 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>
+- <https://jupyter.readthedocs.io/en/latest/install/notebook-classic.html>
+- <https://jupyter.readthedocs.io/en/latest/install.html>
 
 ### Ubuntu
 
-#### Ubuntu 17+
+#### Ubuntu 22.04+
 
 ```shell
 sudo apt install libtool libffi-dev ruby ruby-dev make
 
-gem install --user-install iruby
-iruby register --force
-```
-
-#### Ubuntu 16
-
-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
+gem install --user-install rubygems-requirements-system
 gem install --user-install iruby
 iruby register --force
 ```
 
 ### Fedora
 
-#### Fedora 36
+#### Fedora 40+
 
 ```shell
 sudo dnf install ruby ruby-dev make zeromq-devel
 
+gem install --user-install rubygems-requirements-system
 gem install --user-install iruby
 iruby register --force
 ```
@@ -89,6 +79,7 @@ Install Jupyter.
 #### Homebrew
 
 ```shell
+gem install rubygems-requirements-system
 gem install iruby
 iruby register --force
 ```
@@ -99,6 +90,7 @@ If you are using macports, run the following commands.
 
 ```shell
 port install libtool autoconf automake autogen
+gem install rubygems-requirements-system
 gem install iruby
 iruby register --force
 ```
@@ -116,8 +108,8 @@ docker run --rm -it -p 8888:8888 rubydata/datascience-notebook
 
 You can use Java classes in your IRuby notebook.
 
-* JRuby version >= 9.0.4.0
-* iruby gem
+- JRuby version >= 9.0.4.0
+- iruby gem
 
 After installation, make sure that your `env` is set up to use jruby.
 
@@ -160,8 +152,8 @@ export IRUBY_SESSION_ADAPTER="cztop"
 
 There are two backends: PlainBackend and PryBackend.
 
-* PlainBackend is the default backend.  It uses [IRB](https://github.com/ruby/irb).
-* PryBackend uses [Pry][Pry].
+- PlainBackend is the default backend. It uses [IRB](https://github.com/ruby/irb).
+- PryBackend uses [Pry][Pry].
 
 You can switch the backend to PryBackend by running the code below.
 
@@ -171,9 +163,9 @@ IRuby::Kernel.instance.switch_backend!(:pry)
 
 ## Notebooks
 
-Take a look at the [example notebook](http://nbviewer.ipython.org/urls/raw.github.com/SciRuby/sciruby-notebooks/master/getting_started.ipynb)
+Take a look at the [example notebook](https://nbviewer.jupyter.org/urls/raw.github.com/SciRuby/sciruby-notebooks/master/getting_started.ipynb)
 and the [collection of notebooks](https://github.com/SciRuby/sciruby-notebooks/) which includes a Dockerfile to create a containerized installation of iruby
-and other scientific gems. You can find the prebuild image at [dockerhub](https://registry.hub.docker.com/u/minad/sciruby-notebooks/).
+and other scientific gems.
 
 ## Contributing
 

data/iruby.gemspec

@@ -15,7 +15,6 @@ Gem::Specification.new do |s|
   s.executables   = %w[iruby]
   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'
 
@@ -25,12 +24,21 @@ Gem::Specification.new do |s|
   s.add_dependency 'logger'
   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'
 
+  [
+    ['arch_linux', 'zeromq'],
+    ['debian', 'libzmq3-dev'],
+    ['freebsd', 'libzmq4'],
+    ['homebrew', 'zmq'],
+    ['macports', 'zmq'],
+  ].each do |platform, package|
+    s.requirements << "system: libzmq: #{platform}: #{package}"
+  end
+
   s.metadata['msys2_mingw_dependencies'] = 'zeromq'
 end

data/lib/iruby/application.rb

@@ -225,7 +225,7 @@ module IRuby
       end
 
       if ipython_dir
-        File.join(ipython_dir, 'kerenels')
+        File.join(ipython_dir, 'kernels')
       else
         Jupyter.kernelspec_dir
       end
@@ -265,7 +265,7 @@ module IRuby
       opts.on(
         "--display-name=VALUE", String,
         "Specify the display name for the kernelspec. This is helpful when you have multiple IRuby kernels."
-      ) {|v| kernel_display_name = v }
+      ) {|v| params.display_name = v }
 
       # TODO: --profile
       # TODO: --prefix

data/lib/iruby/backend.rb

@@ -50,6 +50,7 @@ module IRuby
       @irb = IRB::Irb.new(@workspace)
       @eval_path = @irb.context.irb_path
       IRB.conf[:MAIN_CONTEXT] = @irb.context
+      @completor = IRB::RegexpCompletor.new if defined? IRB::RegexpCompletor # IRB::VERSION >= 1.8.2
     end
 
     def eval_binding
@@ -57,12 +58,23 @@ module IRuby
     end
 
     def eval(code, store_history)
-      @irb.context.evaluate(@irb.build_statement(code), 0)
+      @irb.context.evaluate(parse_code(code), 0)
       @irb.context.last_value unless IRuby.silent_assignment && assignment_expression?(code)
     end
 
+    def parse_code(code)
+      return code if Gem::Version.new(IRB::VERSION) < Gem::Version.new('1.13.0')
+      return @irb.parse_input(code) if @irb.respond_to?(:parse_input)
+      return @irb.build_statement(code) if @irb.respond_to?(:build_statement)
+    end
+
     def complete(code)
-      IRB::InputCompletor::CompletionProc.call(code)
+      if @completor
+        # preposing and postposing never used, so they are empty, pass only target as code
+        @completor.completion_candidates('', code, '', bind: @workspace.binding)
+      else
+        IRB::InputCompletor::CompletionProc.call(code)
+      end
     end
 
     private

data/lib/iruby/comm.rb

@@ -13,17 +13,17 @@ module IRuby
       @target_name, @comm_id = target_name, comm_id
     end
 
-    def open(**data)
-      Kernel.instance.session.send(:publish, :comm_open, comm_id: @comm_id, data: data, target_name: @target_name)
+    def open(metadata = nil, **data)
+      Kernel.instance.session.send(:publish, :comm_open, metadata, comm_id: @comm_id, data: data, target_name: @target_name)
       Comm.comm[@comm_id] = self
     end
 
-    def send(**data)
-      Kernel.instance.session.send(:publish, :comm_msg, comm_id: @comm_id, data: data)
+    def send(metadata = nil, **data)
+      Kernel.instance.session.send(:publish, :comm_msg, metadata, comm_id: @comm_id, data: data)
     end
 
-    def close(**data)
-      Kernel.instance.session.send(:publish, :comm_close, comm_id: @comm_id, data: data)
+    def close(metadata = nil, **data)
+      Kernel.instance.session.send(:publish, :comm_close, metadata, comm_id: @comm_id, data: data)
       Comm.comm.delete(@comm_id)
     end
 

data/lib/iruby/display.rb

@@ -7,7 +7,7 @@ module IRuby
       "text/markdown" => :to_markdown,
       "image/svg+xml" => :to_svg,
       "image/png" => :to_png,
-      "appliation/pdf" => :to_pdf,
+      "application/pdf" => :to_pdf,
       "image/jpeg" => :to_jpeg,
       "text/latex" => [:to_latex, :to_tex],
       # NOTE: Do not include the entry of "application/json" because
@@ -113,14 +113,14 @@ module IRuby
         if FORCE_TEXT_TYPES.include?(mime)
           true
         else
-          MIME::Type.new(mime).ascii?
+          MIME::Type.new("content-type" => mime).ascii?
         end
       end
 
       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, _metadata = obj.to_iruby_mimebundle(include: include_mime)
         formats.each do |mime, value|
           if fuzzy_mime.nil? || mime.include?(fuzzy_mime)
             data[mime] = value
@@ -407,7 +407,6 @@ module IRuby
 
       type { Gruff::Base }
       format 'image' do |obj|
-        image = obj.to_image
         format_magick_image.(obj.to_image)
       end
 

data/lib/iruby/formatter.rb

@@ -90,7 +90,7 @@ module IRuby
         rows2 = rows[-maxrows / 2 + 1..-1]
       end
 
-      table = '<table>'
+      table = +'<table>'
 
       if header1 && options[:header] != false
         table << '<tr>' << header1.map {|k| "<th>#{cell k}</th>" }.join

data/lib/iruby/ostream.rb

@@ -11,6 +11,10 @@ module IRuby
       @session = nil
     end
 
+    def closed?
+      @session.nil?
+    end
+
     def flush
     end
 
@@ -48,7 +52,7 @@ module IRuby
 
     # Called by irb
     def set_encoding(extern, intern)
-      a = extern
+      extern
     end
 
     private

data/lib/iruby/session/mixin.rb

@@ -4,10 +4,10 @@ module IRuby
 
     private
 
-    def serialize(idents, header, content)
+    def serialize(idents, header, metadata = nil, content)
       msg = [MultiJson.dump(header),
              MultiJson.dump(@last_recvd_msg ? @last_recvd_msg[:header] : {}),
-             '{}',
+             MultiJson.dump(metadata || {}),
              MultiJson.dump(content || {})]
       frames = ([*idents].compact.map(&:to_s) << DELIM << sign(msg)) + msg
       IRuby.logger.debug "Sent #{frames.inspect}"

data/lib/iruby/session.rb

@@ -70,7 +70,7 @@ module IRuby
       end
     end
 
-    def send(socket_type, message_type, content)
+    def send(socket_type, message_type, metadata = nil, content)
       sock = check_socket_type(socket_type)
       idents = if socket_type == :reply && @last_recvd_msg
                  @last_recvd_msg[:idents]
@@ -85,7 +85,7 @@ module IRuby
         session:  @session_id,
         version:  '5.0'
       }
-      @adapter.send(sock, serialize(idents, header, content))
+      @adapter.send(sock, serialize(idents, header, metadata, content))
     end
 
     def recv(socket_type)

data/lib/iruby/session_adapter.rb

@@ -60,7 +60,7 @@ module IRuby
           end
         end
         if name == 'cztop'
-          warn "WARNING: cztop was deprecated and will be removed; Use ffi-rzmq, instead."
+          warn "WARNING: cztop is deprecated and will be removed; Use ffi-rzmq instead."
         end
         return cls
       end

data/lib/iruby/version.rb

@@ -1,3 +1,3 @@
 module IRuby
-  VERSION = '0.8.0'
+  VERSION = '0.8.2'
 end

data/run-test.sh

@@ -4,7 +4,7 @@ set -ex
 
 export PYTHON=python3
 
-ADAPTERS="cztop ffi-rzmq pyzmq"
+ADAPTERS="cztop ffi-rzmq"
 
 for adapter in $ADAPTERS; do
   export IRUBY_TEST_SESSION_ADAPTER_NAME=$adapter

data/test/integration_test.rb

@@ -38,7 +38,7 @@ class IRubyTest::IntegrationTest < IRubyTest::TestBase
   end
 
   def test_interaction
-    omit("This test too much unstable")
+    omit("This test is too unstable")
 
     write '"Hello, world!"'
     expect '"Hello, world!"'

data/test/iruby/application/kernel_test.rb

@@ -83,7 +83,7 @@ module IRubyTest::ApplicationTests
 
         add_kernel_options("--log=#{log_file}", boot_file)
 
-        out, status = Open3.capture2e(*iruby_command("console"), in: :close)
+        _out, status = Open3.capture2e(*iruby_command("console"), in: :close)
         assert status.success?
         assert_path_exist log_file
         assert_match(/\bINFO -- bootfile: !!! LOG MESSAGE FROM BOOT FILE !!!$/, File.read(log_file))

data/test/iruby/application/register_test.rb

@@ -61,7 +61,7 @@ puts "Fake Jupyter"
       test("a new IRuby kernel `#{DEFAULT_KERNEL_NAME}` will be installed in JUPYTER_DATA_DIR") do
         assert_path_not_exist @kernel_json
 
-        out, status = Open3.capture2e(*iruby_command("register"))
+        _out, status = Open3.capture2e(*iruby_command("register"))
         assert status.success?
         assert_path_exist @kernel_json
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: iruby
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.2
 platform: ruby
 authors:
 - Daniel Mendler
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-07-28 00:00:00.000000000 Z
+date: 2025-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: data_uri
@@ -95,20 +95,6 @@ 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
@@ -170,8 +156,7 @@ email:
 - mail@daniel-mendler.de
 executables:
 - iruby
-extensions:
-- ext/Rakefile
+extensions: []
 extra_rdoc_files: []
 files:
 - ".github/workflows/ci.yml"
@@ -187,7 +172,6 @@ files:
 - docker/setup.sh
 - docker/test.sh
 - exe/iruby
-- ext/Rakefile
 - iruby.gemspec
 - lib/iruby.rb
 - lib/iruby/application.rb
@@ -281,8 +265,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-requirements: []
-rubygems_version: 3.5.11
+requirements:
+- 'system: libzmq: arch_linux: zeromq'
+- 'system: libzmq: debian: libzmq3-dev'
+- 'system: libzmq: freebsd: libzmq4'
+- 'system: libzmq: homebrew: zmq'
+- 'system: libzmq: macports: zmq'
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: Ruby Kernel for Jupyter

data/ext/Rakefile

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