iruby 0.4.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ab064a6f7df94f983b75ff53092fb54f6e9a7cc747e220a2e5b021eac840897e
-  data.tar.gz: c20d21297d688fc7794b4d0813ada1d9762ba38ea0fb3ccd99f9fbe7845ca5e3
+  metadata.gz: 11ac6e3f7e6588a384c9f149d6c3fe4060b7cea7d1ff6461c3ea1acc8cadebf6
+  data.tar.gz: 4c57af32989ee7a9d7671220647279f727021d9e6d29f9d40bf1bed0e0fc4ec0
 SHA512:
-  metadata.gz: eaf70e7d4ac97a11e03c7c6b5a94f5eb3d1b521ed18332ae510be5872c7faa87fb2814101fff22a8a5019adc8a93915085fb93c1fee5cfec24dd936c57c13fd4
-  data.tar.gz: cbfb04ac1dc3be65aa4c1c83b0701e39d603a439b35119b0bfa11d11467a7e4b3d29f347317b5b2f9cdfecd17fdcaf4b1474513d56b8a730764ff1ee7482cab7
+  metadata.gz: a1d623a6b5b4e46c2845048241fa6abfd535d72e648fd431f42c21c7f895f72f29b2443d74339342e83c5017040ff5f55ff4b0442909649b1ef0afb452c0ba20
+  data.tar.gz: '0394ca9c46e802a2532534058acc3af98c6e93e62a60cc035977af441c61145cfda13b224f8f1da1a8b90b48159f6aa858da7c939db2fed4f4329dcd5f2e9ea0'

data/.github/workflows/ubuntu.yml

@@ -0,0 +1,69 @@
+name: CI
+
+on:
+  push:
+    branches:
+    - master
+  pull_request:
+    types:
+    - opened
+    - synchronize
+    - reopened
+
+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 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: 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.md

@@ -0,0 +1,219 @@
+# 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
+
+* The default backend is changed to IRB (@mrkn)
+* Add IRuby::Kernel#switch_backend! method (@mrkn)
+
+## Bug Fixes
+
+* 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
+
+* Fix the handling of application/javascript https://github.com/SciRuby/iruby/issues/292, https://github.com/SciRuby/iruby/pull/294 (@kylekyle, @mrkn)
+
+## Enhancements
+
+* Add the `initialized` event in `IRuby::Kernel` class https://github.com/SciRuby/iruby/pull/168, https://github.com/SciRuby/iruby/pull/296 (@Yuki-Inoue, @mrkn)
+* Add the following four events https://github.com/SciRuby/iruby/pull/295 (@mrkn):
+  * `pre-execute` -- occurs before every code execution
+  * `pre-run-cell` -- occurs before every non-silent code execution
+  * `post-execute` -- occurs after every code execution
+  * `post-run-cell` -- occurs after every non-silent code execution
+* Replace Bond with IRB in PlainBackend https://github.com/SciRuby/iruby/pull/276, https://github.com/SciRuby/iruby/pull/297 (@cfis, @mrkn)
+
+# 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)
+
+(TBD)
+
+# 0.3 (2017-03-26)
+
+## Bug Fixes
+
+* Disable Jupyter keyboard manager for all popups made using IRuby.popup (@kylekyle).
+* Fix Iruby/Input date values bug that set date fields to whatever the last date value was (@kylekyle).
+* Fix a bug where time strings put into prompter would give an 'out of range' error (@kylekyle).
+
+## Enhancements
+
+* Improvements to IRuby dependency detection using `Bundler::Dependencies#specs` (@kou).
+* Use less memory forcing pry to store only the last 3 commands in memory (@kylekyle).
+* Use bigger z-index that is used accross all browsers (@kylekyle).
+* Ability to input date values as DateTime objects in IRuby/Input (@kylekyle).
+* Add option to have check boxes checked by default (@kylekyle).
+* Option for multi-select in drop down menus in the prompter (@kylekyle).
+* Add support for multiple widgets using `IRuby::Input::Multiple` (@kylekyle).
+* Calender icon for date selector icon (@kylekyle).
+* Add support for Numo/NArray (@zalt50).
+* Text now only completes after a space (@zalt50).
+* Remove the DONTWAIT flag when receiving a message (@cloud-oak).
+* Add support for CZTop (@kou).
+
+# 0.2.9 (2016-05-02)
+  
+## Bug Fixes
+
+* Fix an error where a NoMethodError was being raised where a table rendered using an Array of Hashes has more than `maxcols` columns. (@CGamesPlay)
+* Patch PryBackend to throw unterminated string and unexpected end-of-file syntax errors (@kylekyle)
+
+## Enhnacements
+
+* Add an IRuby::Input class which provides widgets for getting inputs from users. (@kylekyle)
+* Add data_uri dependency (@kylekyle)
+* Added a clear_output display function (@mrkn)
+* Doc fixes for installation (@kozo2, @generall)
+
+# 0.2.8 (2015-12-06)
+
+* Add compatibility with ffi-rzmq
+* Windows support
+
+# 0.2.7 (2015-07-02)
+
+* Fix problem with autoloaded constants in Display, problem with sciruby gem
+
+# 0.2.6 (2015-06-21)
+
+* Check registered kernel and Gemfile to prevent gem loading problems
+* Support to_tex method for the rendering
+
+# 0.2.5 (2015-06-07)
+
+* Fix #29, empty signatures
+* Move iruby utils to IRuby::Utils module
+* Add IRuby.tex alias for IRuby.latex
+* Remove example notebooks from gem
+
+# 0.2.4 (2015-06-02)
+
+* Better exception handling
+* Fix ctrl-C issue #17
+* Fix timeout issue #19
+
+# 0.2.3 (2015-05-31)
+
+* Fix notebook indentation
+* Fix tab completion for multiple lines
+
+# 0.2.2 (2015-05-26)
+
+* Support history variables In, Out, _, _i etc
+* Internal refactoring and minor bugfixes
+
+# 0.2.1 (2015-05-26)
+
+* Copy Ruby logo to kernel specification
+
+# 0.2.0 (2015-05-25)
+
+* Dropped IPython2 support
+* Dropped Ruby < 2.0.0 support
+* Supports and requires now IPython3/Jupyter
+* Switch from ffi-rzmq to rbczmq
+* Added IRuby::Conn (experimental, to be used by widgets)
+* iruby register/unregister commands to register IRuby kernel in Jupyter
+
+# 0.1.13 (2014-08-19)
+
+* Improved IRuby.table, supports :maxrows and :maxcols
+* IRuby#javascript workaround (https://github.com/ipython/ipython/issues/6259)
+
+# 0.1.12 (2014-08-01)
+
+* IRuby#table add option maxrows
+* powerful display system with format and datatype registry, see #25
+* Add IRuby#javascript
+* Add IRuby#svg
+
+# 0.1.11 (2014-07-08)
+
+* Push binding if pry binding stack is empty
+
+# 0.1.10 (2014-07-08)
+
+* Fix #19 (pp)
+* Handle exception when symlink cannot be created
+* Fix dependencies and Pry backend
+
+# 0.1.9 (2014-02-28)
+
+* Check IPython version
+
+# 0.1.7/0.1.8
+
+* Bugfixes #11, #12, #13
+
+# 0.1.6 (2013-10-11)
+
+* Print Matrix and GSL::Matrix as LaTeX
+* Add check for Pry version
+
+# 0.1.5 (2013-10-03)
+
+* Implement a rich display system
+* Fix error output
+
+# 0.1.4 (2013-10-03)
+
+* Extract display handler from kernel
+* Always return a text/plain response
+
+# 0.1.3 (2013-10-03)
+
+* Implement missing request handlers
+* Detect if Bundler is running and set kernel_cmd appropriately
+* Improve Pry integration
+* Add support for the gems gnuplot, gruff, rmagick and mini_magick
+
+# 0.1.2 (2013-10-02)
+
+* Support for Pry added
+* Launch `iruby console` if plain `iruby` is started
+
+# 0.1.0 (2013-10-02)
+
+* Cleanup and rewrite of some parts

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)
 
-```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
+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"
 ```
 
-#### Setup ZeroMQ on Ubuntu 17.04 to 18.10
-Use official packages.
+* [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
+
+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
@@ -146,20 +148,37 @@ If you have already used IRuby with a different version, you need to generate a
 $ iruby register --force
 ```
 
+## Backends
+
+There are two backends: PlainBackend and PryBackend.
+
+* 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.
+
+```ruby
+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)
 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.
+
+Licensed under the [MIT](LICENSE) license.
 
-IRuby, along with [SciRuby](http://sciruby.com/), is licensed under the MIT license. See the [LICENSE](LICENSE) file.
+[Pry]: https://github.com/pry/pry