iruby 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ab064a6f7df94f983b75ff53092fb54f6e9a7cc747e220a2e5b021eac840897e
-  data.tar.gz: c20d21297d688fc7794b4d0813ada1d9762ba38ea0fb3ccd99f9fbe7845ca5e3
+  metadata.gz: 1576475a17c04bbdc5080fede4710cf609c9cfb1268f692e8a11653095c2902b
+  data.tar.gz: 46c737c267739a44dc2a7a9d4ccd5c8d3fcf89fda1b4163e74d941bd0740ec44
 SHA512:
-  metadata.gz: eaf70e7d4ac97a11e03c7c6b5a94f5eb3d1b521ed18332ae510be5872c7faa87fb2814101fff22a8a5019adc8a93915085fb93c1fee5cfec24dd936c57c13fd4
-  data.tar.gz: cbfb04ac1dc3be65aa4c1c83b0701e39d603a439b35119b0bfa11d11467a7e4b3d29f347317b5b2f9cdfecd17fdcaf4b1474513d56b8a730764ff1ee7482cab7
+  metadata.gz: 0225f7c54c11dc9668d6bbceff3dac9ba6e1d32e041355ab429b7f6b0bc204f8050f3420dfede65474614c259e7dba346db051f5414be5fb1fd2dffd9b5de894
+  data.tar.gz: 803cbe952a48614e1d7aeefef51f772c4420aeb07bf63a679384147fe12f10469380d733834126d206342a2c6a01d7d57d6202b8d64bd90921cd3825684d22c3

data/.github/workflows/ubuntu.yml

@@ -0,0 +1,62 @@
+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/CHANGES

@@ -1,3 +1,27 @@
+0.5.0 (2021-03-25)
+
+  Bug Fixes:
+    * Fix Jupyter console crashes issue https://github.com/SciRuby/iruby/pull/210 (@kojix2)
+    * Fix syntax highlighting issue on Jpyter Lab https://github.com/SciRuby/iruby/issues/224 (@kojix2)
+    * Fix interoperability issue with ruby-git https://github.com/SciRuby/iruby/pull/139 (@habemus-papadum)
+    * Fix the issue of `$stderr.write` that cannot handle multiple arguments https://github.com/SciRuby/iruby/issues/206 (@kojix2)
+    * Remove a buggy `inspect_request` implementation https://github.com/SciRuby/iruby/pull/119 (@LunarLanding)
+    * Fix uninitialized constant `Fiddle` caused in initialization phase https://github.com/SciRuby/iruby/issues/264 (@MatthewSteen, @kjoix2)
+    * Fix the issue on displaying a table https://github.com/SciRuby/iruby/pull/281 (@ankane)
+
+  Enhancements:
+    * Add `IRuby.clear_output` method https://github.com/SciRuby/iruby/pull/220 (@kojix2)
+    * Make backtrace on exception simplify and more appropriate for code in a cell https://github.com/SciRuby/iruby/pull/249 (@zheng-yongping)
+    * Make syntax error message more appropriate https://github.com/SciRuby/iruby/pull/251 (@zheng-yongping)
+    * Remove top-level `In` and `Out` constants https://github.com/SciRuby/iruby/pull/229 (@kojix2)
+    * Use text/plain for the default format of `Numo::NArray` objects https://github.com/SciRuby/iruby/pull/255 (@kojix2)
+    * Use ffi-rzmq as the default ZeroMQ adapter https://github.com/SciRuby/iruby/pull/256 (@kojix2)
+    * Drop rbczmq support https://github.com/SciRuby/iruby/pull/260 (@rstammer)
+    * Add ruby-vips image support https://github.com/SciRuby/iruby/pull/279 (@ankane)
+    * Replace mimemagic with mime-types https://github.com/SciRuby/iruby/pull/291 (@mrkn)
+
+0.4.0 (2019-07-31)
+
 0.3 (2017-03-26)
 
   Bug Fixes:

data/Gemfile

@@ -10,10 +10,8 @@ end
 group :plot do
   gem 'gnuplot'
   gem 'rubyvis'
-  gem 'nyaplot', github: 'sciruby/nyaplot'
 end
 
 group :test do
   gem 'cztop'
-  gem 'rbczmq'
 end

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2013-2015 IRuby contributors and the Ruby Science Foundation
+Copyright (c) 2013 - present IRuby contributors and the Ruby Science Foundation
 
 MIT License
 

data/README.md

@@ -1,52 +1,80 @@
 # IRuby
 
 [![Gem Version](https://badge.fury.io/rb/iruby.svg)](https://badge.fury.io/rb/iruby)
-[![Build Status](https://travis-ci.org/SciRuby/iruby.svg?branch=master)](https://travis-ci.org/SciRuby/iruby)
+[![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/).
 
+## Try IRuby
+
+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
+
+The following URL launches JupyterLab directly on Binder.
+
+https://mybinder.org/v2/gh/RubyData/binder/master?filepath=../lab
+
 ## Installation
-How to set up [ZeroMQ](http://zeromq.org/) depends on your environment.
-You can use one of the following libraries. 
-* [CZTop](https://gitlab.com/paddor/cztop) and [CZMQ](https://github.com/zeromq/czmq) >= 4.0.0
-* [ffi-rzmq](https://github.com/chuckremes/ffi-rzmq) and [libzmq
-](https://github.com/zeromq/libzmq) >= 3.2
 
-### Ubuntu
-Install Jupyter with [Anaconda](https://www.anaconda.com/) (recommended). 
+### Requirements
 
-#### Setup ZeroMQ on Ubuntu 16.04
-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.
+* [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.
+
+```sh
+export IRUBY_SESSION_ADAPTER="cztop"
+```
+
+* We recommend the [Pry](https://github.com/pry/pry) backend for full functionality.
+* If you want to install the latest version of IRuby from the source code, try [specific_install](https://github.com/rdp/specific_install).
 
-```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 specific_install https://github.com/SciRuby/iruby
+```
+
+### Ubuntu
 
-#### Setup ZeroMQ on Ubuntu 17.04 to 18.10
-Use official packages.
+Install Jupyter.
+
+#### 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
+iruby register --force
 ```
 
-#### Install CZTop and IRuby
+#### 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.
+
 ```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
 iruby register --force
 ```
 
 ### Windows
-Install git and Jupyter with [Anaconda](https://www.anaconda.com/) (recommended). 
+
+Install git and Jupyter.
 [DevKit](https://rubyinstaller.org/add-ons/devkit.html) is necessary for building RubyGems with native C-based extensions.
 
-Install ZeroMQ. 
+Install ZeroMQ.
 ```shell
 pacman -S mingw64/mingw-w64-x86_64-zeromq
 ```
@@ -58,10 +86,12 @@ iruby register --force
 ```
 
 ### macOS
+
 Install ruby with rbenv or rvm.
-Install Jupyter with [Anaconda](https://www.anaconda.com/) (recommended). 
+Install Jupyter.
 
 #### Homebrew
+
 ```shell
 brew install automake gmp libtool wget
 brew install zeromq --HEAD
@@ -78,6 +108,7 @@ iruby register --force
 ```
 
 #### MacPorts
+
 If you are using macports, run the following commands.
 
 ```shell
@@ -86,47 +117,18 @@ gem install ffi-rzmq
 gem install iruby
 ```
 
-### FreeBSD
-At first install IPython/Jupyter. 
-There is a pyzmq ports (ports/net/py-pyzmq) which depends on libzmq4, however, it doesn't works with ipython.
-Therefore we use libzmq3 like the following:
+### Docker
 
-1. make your ports tree up-to-date.
-2. replace LIBDEPENDS line in ports/net/py-pyzmq/Makefile
+Try [RubyData Docker Stacks](https://github.com/RubyData/docker-stacks). 
+Running jupyter notebook:
 
 ```shell
-LIB_DEPENDS=    libzmq.so:${PORTSDIR}/net/libzmq4
-```
-with
-```shell
-LIB_DEPENDS=    libzmq.so:${PORTSDIR}/net/libzmq3
-```
-3. install related packages
-
-```shell
-sudo pkg install libzmq3 py27-qt4-gui py27-pexpect-3.3 py27-qt4-svg py27-pygments py27-Jinja2 py27-tornado py27-jsonschema
-```
-4. make install using ports
-
-```shell
-cd /usr/ports/net/py-pyzmq
-sudo make install
-cd /usr/ports/devel/ipython
-sudo make install
-```
-Then, install IRuby and related ports and gems.
-```shell
-sudo pkg install rubygem-mimemagic
-sudo gem install ffi-rzmq  # install ffi, ffi-rzmq-core and ffi-rzmq
-git clone https://github.com/SciRuby/iruby.git
-cd iruby
-gem build iruby.gemspec
-sudo gem install iruby-0.2.7.gem
+docker run -p 8888:8888 rubydata/datascience-notebook
 ```
 
 ### Installation for JRuby
 
-You can use Java classes in your IRuby notebook. 
+You can use Java classes in your IRuby notebook.
 
 * JRuby version >= 9.0.4.0
 * cztop gem
@@ -147,19 +149,21 @@ $ iruby register --force
 ```
 
 ## Notebooks
+
 Take a look at the [example notebook](http://nbviewer.ipython.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/).
 
 ## Contributing
-We welcome contributions from everyone.
 
-## Authors
-See the [CONTRIBUTORS](CONTRIBUTORS) file.
+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. 
 
 ## License
-Copyright © 2013-19, IRuby contributors and the Ruby Science Foundation.
 
-All rights reserved.
+Copyright (c) IRuby contributors and the Ruby Science Foundation.
 
-IRuby, along with [SciRuby](http://sciruby.com/), is licensed under the MIT license. See the [LICENSE](LICENSE) file.
+Licensed under the [MIT](LICENSE) license.

data/Rakefile

@@ -1,17 +1,17 @@
-require 'rake/testtask'
+require "bundler/gem_helper"
 
-begin
-  require 'bundler/gem_tasks'
-rescue Exception
-end
+base_dir = File.join(File.dirname(__FILE__))
+
+helper = Bundler::GemHelper.new(base_dir)
+helper.install
 
 FileList['tasks/**.rake'].each {|f| load f }
 
-Rake::TestTask.new('test') do |t|
-  t.libs << 'lib'
-  t.libs << 'test'
-  t.test_files = FileList['test/**/*_test.rb']
-  t.verbose = true
+desc "Run tests"
+task :test do
+  cd(base_dir) do
+    ruby("test/run-test.rb")
+  end
 end
 
 task default: 'test'

data/ci/Dockerfile.main.erb

@@ -1,8 +1,6 @@
 FROM iruby-test-base:ruby-<%= ruby_version %>
 
-RUN gem install cztop \
-    && gem install rbczmq -- --with-system-libs
-
+RUN gem install cztop
 RUN mkdir -p /iruby
 ADD . /iruby
 WORKDIR /iruby

data/iruby.gemspec

@@ -1,36 +1,30 @@
-# coding: utf-8
 require_relative 'lib/iruby/version'
-require 'date'
 
 Gem::Specification.new do |s|
   s.name          = 'iruby'
-  s.date          = Date.today.to_s
   s.version       = IRuby::VERSION
   s.authors       = ['Daniel Mendler', 'The SciRuby developers']
   s.email         = ['mail@daniel-mendler.de']
-  s.summary       = 'Ruby Kernel for Jupyter/IPython'
-  s.description   = 'A Ruby kernel for Jupyter/IPython frontends (e.g. notebook). Try it at try.jupyter.org.'
+  s.summary       = 'Ruby Kernel for Jupyter'
+  s.description   = 'A Ruby kernel for Jupyter environment. Try it at try.jupyter.org.'
   s.homepage      = 'https://github.com/SciRuby/iruby'
   s.license       = 'MIT'
 
-  s.files         = `git ls-files`.split($/)
+  s.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   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.require_paths = %w[lib]
 
-  m = "Consider installing the optional dependencies to get additional functionality:\n"
-  File.read('Gemfile').scan(/gem\s+'(.*?)'/) { m << "  * #{$1}\n" }
-  s.post_install_message = m << "\n"
+  s.required_ruby_version = '>= 2.3.0'
 
-  s.required_ruby_version = '>= 2.1.0'
+  s.add_dependency 'bond', '~> 0.5'
+  s.add_dependency 'data_uri', '~> 0.1'
+  s.add_dependency 'ffi-rzmq'
+  s.add_dependency 'mime-types', '>= 3.3.1'
+  s.add_dependency 'multi_json', '~> 1.11'
 
-  s.add_development_dependency 'rake'
-  s.add_development_dependency 'minitest'
-  s.add_development_dependency 'ffi-rzmq'
   s.add_development_dependency 'pycall', '>= 1.2.1'
-
-  s.add_runtime_dependency 'bond', '~> 0.5'
-  s.add_runtime_dependency 'multi_json', '~> 1.11'
-  s.add_runtime_dependency 'mimemagic', '~> 0.3'
-  s.add_runtime_dependency 'data_uri', '~> 0.1'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'test-unit'
+  s.add_development_dependency 'test-unit-rr'
 end

data/lib/iruby.rb

@@ -1,4 +1,4 @@
-require 'mimemagic'
+require 'mime/types'
 require 'multi_json'
 require 'securerandom'
 require 'openssl'
@@ -24,11 +24,7 @@ if ENV.fetch('IRUBY_OLD_SESSION', false)
     begin
       require 'iruby/session/cztop'
     rescue LoadError
-      begin
-        require 'iruby/session/rbczmq'
-      rescue LoadError
-        STDERR.puts "You should install ffi-rzmq, cztop, or rbczmq before running iruby notebook. See README."
-      end
+      STDERR.puts "Please install ffi-rzmq or cztop before running iruby. See README."
     end
   end
 else

data/lib/iruby/backend.rb

@@ -1,6 +1,5 @@
 module IRuby
   In, Out = [nil], [nil]
-  ::In, ::Out = In, Out
 
   module History
     def eval(code, store_history)
@@ -33,15 +32,17 @@ module IRuby
   end
 
   class PlainBackend
+    attr_reader :eval_path
     prepend History
 
     def initialize
       require 'bond'
       Bond.start(debug: true)
+      @eval_path = '(iruby)'
     end
 
     def eval(code, store_history)
-      TOPLEVEL_BINDING.eval(code)
+      TOPLEVEL_BINDING.eval(code, @eval_path, 1)
     end
 
     def complete(code)
@@ -50,28 +51,41 @@ module IRuby
   end
 
   class PryBackend
+    attr_reader :eval_path
     prepend History
 
     def initialize
       require 'pry'
-      Pry.memory_size = 3 
+      Pry.memory_size = 3
       Pry.pager = false # Don't use the pager
       Pry.print = proc {|output, value|} # No result printing
       Pry.exception_handler = proc {|output, exception, _| }
+      @eval_path = Pry.eval_path
       reset
     end
 
     def eval(code, store_history)
+      Pry.current_line = 1
       @pry.last_result = nil
       unless @pry.eval(code)
         reset
         raise SystemExit
       end
-      unless @pry.eval_string.empty?
+
+      # Pry::Code.complete_expression? return false
+      if !@pry.eval_string.empty?
         syntax_error = @pry.eval_string
         @pry.reset_eval_string
-        @pry.evaluate_ruby syntax_error
+        @pry.evaluate_ruby(syntax_error)
+
+      # Pry::Code.complete_expression? raise SyntaxError
+      # evaluate again for current line number
+      elsif @pry.last_result_is_exception? &&
+              @pry.last_exception.is_a?(SyntaxError) &&
+              @pry.last_exception.is_a?(Pry::UserError)
+         @pry.evaluate_ruby(code)
       end
+
       raise @pry.last_exception if @pry.last_result_is_exception?
       @pry.push_initial_binding unless @pry.current_binding # ensure that we have a binding
       @pry.last_result