iruby 0.3 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 535b2e6920da18e1d6610cda01d192814a5f9595
-  data.tar.gz: 401889f3e858262e478fa15a3c709bcd6d09bd16
+SHA256:
+  metadata.gz: 14aea673b75a6fe8884eff08c52b8831bbcec141df2525ed4c0a877738654271
+  data.tar.gz: 89e5e091e67b7ef85f98ca0cb9ebe65cef0e32aacd75351c81b0c287666939c0
 SHA512:
-  metadata.gz: 5d35b89326c32a1dcb52fc2242e366b693ffcac70b3b0ad232233010a6cd1de7c894429c724fb96a766ed35d995465c7b61e3274c7836639a8afd7a9fa56f0e9
-  data.tar.gz: 423d15b33c265bd943b5811fb3993f79d2da741790948f9efdd5890ca0f755f94d9fdb51ee78faf5adfa612a30d031e4014758725322f4fe22fd099c37a093c4
+  metadata.gz: 53b824e32c52cbf2893b24310ba4d3c7caa52ec872f36f57644a95bdd139232b4b5e032f161fb86baf94d011964caf9d739a4795af6805fd174360ed866477fa
+  data.tar.gz: ee663bca3c4a67730d73e709c24d827af73e7c58734afe4dffc22c685c909462e9c9113f9548a8f1c8b5ce33b0b94338386b24c07978db547fab1caa21828ea7

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.md

@@ -0,0 +1,203 @@
+# 0.7.0 (2021-05-28)
+
+## Enhancements
+
+* The default backend is changed to IRB (@mrkn)
+* Add IRuby::Kernel#switch_backend! method (@mrkn)
+
+## 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.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,6 +10,8 @@ end
 group :plot do
   gem 'gnuplot'
   gem 'rubyvis'
-  gem 'nyaplot', github: 'sciruby/nyaplot'
 end
 
+group :test do
+  gem 'cztop'
+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,134 +1,184 @@
-***The current master branch and gem version >= 0.2 are compatible with IPython3/Jupyter. If you require IPython2 support, please install an older gem version < 0.2 or use the branch ipython2***
-
 # IRuby
 
-This is a Ruby kernel for IPython/Jupyter and is part of [SciRuby](http://sciruby.com/). You can try it at [try.jupyter.org](http://try.jupyter.org/).
+[![Gem Version](https://badge.fury.io/rb/iruby.svg)](https://badge.fury.io/rb/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)
 
-![Screenshot](https://cloud.githubusercontent.com/assets/50754/7956845/3fa46df8-09e3-11e5-8641-f5b8669061b5.png)
+IRuby is a Ruby kernel for [Jupyter project](http://try.jupyter.org/).
 
-### Quick start
-The installation instructions are divided according to environments mainly because of ZeroMQ.
+## Try IRuby
 
-#### Ubuntu/Debian
-At first install IPython/Jupyter. I recommend an installation using virtualenv.
+You can try IRuby with a sample notebook on Binder (the same link as the banner placed above):
 
-    sudo apt-get install python3-dev python-virtualenv
-    virtualenv -p python3 venv
-    source venv/bin/activate
-    pip install 'ipython[notebook]'
+https://mybinder.org/v2/gh/RubyData/binder/master?filepath=ruby-data.ipynb
 
-After that, install the Ruby gem.
+The following URL launches JupyterLab directly on Binder.
 
-    gem install cztop
-    gem install iruby
+https://mybinder.org/v2/gh/RubyData/binder/master?filepath=../lab
 
-Now you can run iruby with:
+## Installation
 
-    iruby notebook
+### Requirements
 
-#### Windows
-At first install IPython/Jupyter. I recommend an installation using [Enthought Canopy](https://www.enthought.com/).
+* [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)
 
-Run two commands below:
+If both ffi-rzmq and cztop are installed, ffi-rzmq is used. If you prefer cztop, set the following environment variable.
 
-    gem install cztop
-    gem install iruby
+```sh
+export IRUBY_SESSION_ADAPTER="cztop"
+```
 
-Now you can run iruby with:
+* [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).
 
-    iruby notebook
+```
+gem specific_install https://github.com/SciRuby/iruby
+```
 
-#### Mac
-I recommend an installation using [Anaconda](https://store.continuum.io/cshop/anaconda/).
+### Ubuntu
 
-After that, run three commands shown below.
+Install Jupyter.
 
-    brew install libtool autoconf automake autogen
-    gem install cztop
-    gem install iruby
+#### Ubuntu 17+
 
-#### FreeBSD
+```shell
+sudo apt install libtool libffi-dev ruby ruby-dev make
+sudo apt install libzmq3-dev libczmq-dev
 
-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:
+gem install ffi-rzmq
+gem install iruby --pre
+iruby register --force
+```
 
-1. make your ports tree up-to-date.
-2. replace LIBDEPENDS line in ports/net/py-pyzmq/Makefile
+#### Ubuntu 16
 
-    ```shell
-    LIB_DEPENDS=    libzmq.so:${PORTSDIR}/net/libzmq4
-    ```
-    with
-    ```shell
-    LIB_DEPENDS=    libzmq.so:${PORTSDIR}/net/libzmq3
-    ```
-3. install related packages
+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 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
+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.
+[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
+iruby register --force
+```
+
+### macOS
+
+Install ruby with rbenv or rvm.
+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
+iruby register --force
+```
 
-    ```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
-    ```
-### Installation for jRuby
+#### MacPorts
 
-Since jRuby is fully compatible with Ruby version 2.2, it is possible to use iruby with jRuby. 
-It can be helpful if you want to use java classes in your iruby notebook.
-This will require the following software:
-* jRuby version >= 9.0.4.0
+If you are using macports, run the following commands.
+
+```shell
+port install libtool autoconf automake autogen
+gem install ffi-rzmq
+gem install iruby
+```
+
+### Docker
+
+Try [RubyData Docker Stacks](https://github.com/RubyData/docker-stacks). 
+Running jupyter notebook:
+
+```shell
+docker run -p 8888:8888 rubydata/datascience-notebook
+```
+
+### Installation for JRuby
+
+You can use Java classes in your IRuby notebook.
+
+* JRuby version >= 9.0.4.0
 * cztop gem
-* this iruby gem
+* iruby gem
+
+After installation, make sure that your `env` is set up to use jruby.
 
-After installation, make sure that your `env` is set up to jruby.
 ```shell
 $ env ruby -v
 ```
+
 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:
+
+If you have already used IRuby with a different version, you need to generate a new kernel:
+
 ```shell
 $ iruby register --force
 ```
-After that you can use iruby with jRuby in usual way.
 
-### After the installation
+## Backends
 
-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/).
+There are two backends: PlainBackend and PryBackend.
 
+* PlainBackend is the default backend.  It uses [IRB](https://github.com/ruby/irb).
+* PryBackend uses [Pry][Pry].
 
-### Required dependencies
+You can switch the backend to PryBackend by running the code below.
 
-* IPython/Jupyter >= 3.0.0
-* Ruby >= 2.1.0
+```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/).
 
-If you install IRuby with CZTop, CZMQ >= 4.0.0 is added to the list above.
+## Contributing
 
-If you install IRuby with ffi-rzmq, libzmq >= 3.2 is added to the list above.
+Contributions to IRuby are very welcome.
 
-### Authors
+To former contributors
 
-See the [CONTRIBUTORS](CONTRIBUTORS) file.
+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
+## License
 
-Copyright © 2013-15, IRuby contributors and the Ruby Science Foundation.
+Copyright (c) IRuby contributors and the Ruby Science Foundation.
 
-All rights reserved.
+Licensed under the [MIT](LICENSE) license.
 
-IRuby, along with [SciRuby](http://sciruby.com/), is licensed under the MIT license. See the [LICENSE](LICENSE) file for details.
+[Pry]: https://github.com/pry/pry