iruby 0.7.3 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ea24babb0bbbb88c3a3bacfbb2ca4438903d9cffa1e6609976e066cfa3e72ff5
-  data.tar.gz: 428513fab78f77f82632f3d66cbd2dc6a81344ea781c213164af038530ecf90e
+  metadata.gz: 7e413c79b6abf037b0f2052ee0eed3c5176cdbcce91432330c02a6fabfd1bed2
+  data.tar.gz: c3d551239522d942ef1356f831a48e50bdadc233d0ceb0b8ba3e95a48017902b
 SHA512:
-  metadata.gz: 1d451a1d683ef25e3f1beeb235db1a2c082199b1a3196b3fa3c1468c505f2d7406931cdc03f678ee0b792f8b7fdf7ffe75979e9f5c2e1470c83a9c8cc1f7fc05
-  data.tar.gz: 2ff9d61912037029eb3b6c087d129cee9b4473f825b51a492e165ee40e0370c46bc2b41159f8f8510f0e083c1c2bb200c46b6fa1ea18c5d11f4e12bf5c61416b
+  metadata.gz: 3e3782105ba5ea49520760220fd88acab086c58600f73be2c74c822be08a7ec094e18e75084ea8bd676486d473f92ad37a40c72b9ebc64325fea1649c40edab3
+  data.tar.gz: 2ed1524ee160602a494192bc3b8734c7f416aa3ae4beb24a3a541852bde3d565938a2ffb43916b4112c7f215cdef1509f1e5326a960b22d213575fa95c3229c6

data/.github/workflows/ci.yml

@@ -0,0 +1,119 @@
+name: CI
+
+on:
+  push:
+  pull_request:
+    types:
+      - opened
+      - synchronize
+      - reopened
+
+jobs:
+  ubuntu:
+    name: Ubuntu
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      fail-fast: false
+      matrix:
+        os:
+          - ubuntu-latest
+        ruby:
+          - "3.3"
+          - "3.2"
+          - "3.1"
+          - "3.0"
+          - "2.7"
+          - debug
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 1
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+
+      - run: rake build
+
+      - name: Install ffi 1.6 for old Ruby
+        if: |
+          matrix.ruby == '2.7'
+        run: |
+          cat <<GEMFILE > Gemfile.irb
+          source 'https://rubygems.org'
+          gem 'ffi', '~> 1.6'
+          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@v4
+        with:
+          fetch-depth: 1
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "ruby"
+
+      - 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@v4
+        with:
+          fetch-depth: 1
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "ruby"
+
+      - 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,31 @@
+# 0.8.0 (2024-07-28)
+
+* Hide output on assignment by @ankane in https://github.com/SciRuby/iruby/pull/312
+* Introduce the new Application classes by @mrkn in https://github.com/SciRuby/iruby/pull/317
+* Fix Gnuplot issues in Ruby 2.7 (#321) by @kojix2 in https://github.com/SciRuby/iruby/pull/322
+* Add Ruby3.1 to CI by @kojix2 in https://github.com/SciRuby/iruby/pull/323
+* Update README.md by @marek-witkowski in https://github.com/SciRuby/iruby/pull/324
+* ci: upgrade actions/checkout by @kojix2 in https://github.com/SciRuby/iruby/pull/325
+* Add Ruby 3.2 to CI for ubuntu by @petergoldstein in https://github.com/SciRuby/iruby/pull/327
+* Default to true for `store_history` if not in silent mode by @gartens in https://github.com/SciRuby/iruby/pull/330
+* Add Ruby 3.3 to CI for Ubuntu by @kojix2 in https://github.com/SciRuby/iruby/pull/331
+* Remove Ruby 2.3 and 2.4 from CI by @kojix2 in https://github.com/SciRuby/iruby/pull/332
+* Fix typos by @kojix2 in https://github.com/SciRuby/iruby/pull/335
+* Format README.md and ci.yml by @kojix2 in https://github.com/SciRuby/iruby/pull/337
+* Fix PlainBackend for irb v1.13.0 by @zalt50 in https://github.com/SciRuby/iruby/pull/339
+* Added `date` to header by @ebababi in https://github.com/SciRuby/iruby/pull/342
+* Update CI Configuration for IRuby by @kojix2 in https://github.com/SciRuby/iruby/pull/344
+* Add logger and Remove base64 to Fix CI Tests by @kojix2 in https://github.com/SciRuby/iruby/pull/345
+* Update CI trigger configuration by @kojix2 in https://github.com/SciRuby/iruby/pull/346
+
+# 0.7.4 (2021-08-18)
+
+## 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

data/README.md

@@ -10,78 +10,74 @@ IRuby is a Ruby kernel for [Jupyter project](http://try.jupyter.org/).
 
 You can try IRuby with a sample notebook on Binder (the same link as the banner placed above):
 
-https://mybinder.org/v2/gh/RubyData/binder/master?filepath=ruby-data.ipynb
+<https://mybinder.org/v2/gh/RubyData/binder/master?filepath=ruby-data.ipynb>
 
 The following URL launches JupyterLab directly on Binder.
 
-https://mybinder.org/v2/gh/RubyData/binder/master?filepath=../lab
+<https://mybinder.org/v2/gh/RubyData/binder/master?filepath=../lab>
 
 ## Installation
 
 ### 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
-```
+### Installing Jupyter Notebook and/or JupyterLab
 
-### Ubuntu
+See the official document to know how to install Jupyter Notebook and/or JupyterLab.
 
-Install Jupyter.
+* <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
+### Fedora
 
-Install git and Jupyter.
-[DevKit](https://rubyinstaller.org/add-ons/devkit.html) is necessary for building RubyGems with native C-based extensions.
+#### Fedora 36
 
-Install ZeroMQ.
 ```shell
-pacman -S mingw64/mingw-w64-x86_64-zeromq
+sudo dnf install ruby ruby-dev make zeromq-devel
+
+gem install --user-install iruby
+iruby register --force
 ```
 
+### Windows
+
+[DevKit](https://rubyinstaller.org/add-ons/devkit.html) is necessary for building RubyGems with native C-based extensions.
+
 ```shell
-gem install ffi-rzmq
-gem install iruby --pre
+gem install iruby
 iruby register --force
 ```
 
@@ -93,17 +89,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,17 +99,17 @@ 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
 
-Try [RubyData Docker Stacks](https://github.com/RubyData/docker-stacks). 
+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,13 +117,12 @@ 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.
 
 ```shell
-$ env ruby -v
+env ruby -v
 ```
 
 If you use RVM, it is enough to switch the current version to jruby.
@@ -145,7 +130,30 @@ If you use RVM, it is enough to switch the current version to jruby.
 If you have already used IRuby with a different version, you need to generate a new kernel:
 
 ```shell
-$ iruby register --force
+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
@@ -173,7 +181,7 @@ Contributions to IRuby are very welcome.
 
 To former contributors
 
-In February 2021, [IRuby became the canonical repository](https://github.com/SciRuby/iruby/issues/285) and is no longer a fork from [minrk/iruby](https://github.com/minrk/iruby). Please fork from this repository again before making pull requests. 
+In February 2021, [IRuby became the canonical repository](https://github.com/SciRuby/iruby/issues/285) and is no longer a fork from [minrk/iruby](https://github.com/minrk/iruby). Please fork from this repository again before making pull requests.
 
 ## License
 

data/Rakefile

@@ -9,8 +9,9 @@ FileList['tasks/**.rake'].each {|f| load f }
 
 desc "Run tests"
 task :test do
+  test_opts = ENV.fetch("TESTOPTS", "").split
   cd(base_dir) do
-    ruby("test/run-test.rb")
+    ruby("test/run-test.rb", *test_opts)
   end
 end
 

data/exe/iruby

@@ -0,0 +1,7 @@
+#! /usr/bin/env ruby
+require "iruby"
+require "iruby/application"
+
+app = IRuby::Application.instance
+app.setup
+app.run

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

@@ -11,20 +11,26 @@ Gem::Specification.new do |s|
   s.license       = 'MIT'
 
   s.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
-  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.bindir        = "exe"
+  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'
 
   s.add_dependency 'data_uri', '~> 0.1'
   s.add_dependency 'ffi-rzmq'
   s.add_dependency 'irb'
+  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'
+
+  s.metadata['msys2_mingw_dependencies'] = 'zeromq'
 end