iruby 0.2.7 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 993862535344a6f784ec1d905f239764b9c80d07
-  data.tar.gz: bc6916ae5072c89afa89d3bca5f6575458232aa4
+SHA256:
+  metadata.gz: 1576475a17c04bbdc5080fede4710cf609c9cfb1268f692e8a11653095c2902b
+  data.tar.gz: 46c737c267739a44dc2a7a9d4ccd5c8d3fcf89fda1b4163e74d941bd0740ec44
 SHA512:
-  metadata.gz: f7c6302c618a2a6cba11836c79e3e9a3aa7d4a6da7fde6c3f334e584c40dfa63454bfa32996c92e3db9035c87300a6c1e0326bde56732a4710062a6bd922fcd9
-  data.tar.gz: c953ad387205dfb3addc05154bc78ea806756a90408d7732b71fef731b8099c521a8b5878963eed57a4d0085b5ef6c1b6f24d08e65c39423202ebc2167fc2a81
+  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,65 @@
+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:
+    * 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

data/Gemfile

@@ -10,6 +10,8 @@ end
 group :plot do
   gem 'gnuplot'
   gem 'rubyvis'
-  gem 'nyaplot', github: 'domitry/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,48 +1,169 @@
-***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)
+
+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
+
+### 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.
+
+```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).
+
+```
+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
+```
+
+#### 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.
 
-![Screenshot](https://cloud.githubusercontent.com/assets/50754/7956845/3fa46df8-09e3-11e5-8641-f5b8669061b5.png)
+```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
 
-### Quick start
+gem install cztop
+gem install iruby --pre
+iruby register --force
+```
 
-At first install IPython/Jupyter. I recommend an installation using virtualenv.
+### Windows
 
-    apt-get install python3-dev virtualenv libzmq3-dev
-    virtualenv -p python3 venv
-    source venv/bin/activate
-    pip install 'ipython[notebook]'
+Install git and Jupyter.
+[DevKit](https://rubyinstaller.org/add-ons/devkit.html) is necessary for building RubyGems with native C-based extensions.
 
-After that, install the Ruby gem.
+Install ZeroMQ.
+```shell
+pacman -S mingw64/mingw-w64-x86_64-zeromq
+```
 
-    gem install iruby
+```shell
+gem install ffi-rzmq
+gem install iruby --pre
+iruby register --force
+```
 
-Now you can run iruby with:
+### macOS
 
-    iruby
-    iruby notebook
+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
+```
+
+#### MacPorts
+
+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
+* iruby gem
+
+After installation, make sure that your `env` is set up to use 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:
+
+```shell
+$ 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
 
-### Required dependencies
-
-* IPython/Jupyter >= 3.0.0
-* libzmq >= 3.2
-* Ruby >= 2.1.0
-
-### Authors
+Contributions to IRuby are very welcome.
 
-See the [CONTRIBUTORS](CONTRIBUTORS) file.
+To former contributors
 
-### License
+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. 
 
-Copyright © 2013-15, IRuby contributors and the Ruby Science Foundation.
+## License
 
-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 for details.
+Licensed under the [MIT](LICENSE) license.

data/Rakefile

@@ -1,15 +1,41 @@
-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
 
-Rake::TestTask.new('test') do |t|
-  t.libs << 'lib'
-  t.libs << 'test'
-  t.test_files = FileList['test/**/*_test.rb']
-  t.verbose = true
+FileList['tasks/**.rake'].each {|f| load f }
+
+desc "Run tests"
+task :test do
+  cd(base_dir) do
+    ruby("test/run-test.rb")
+  end
 end
 
 task default: 'test'
+
+namespace :docker do
+  def root_dir
+    @root_dir ||= File.expand_path("..", __FILE__)
+  end
+
+  task :build do
+    container_name = "iruby_build"
+    image_name = "mrkn/iruby"
+    sh "docker", "run",
+       "--name", container_name,
+       "-v", "#{root_dir}:/tmp/iruby",
+       "rubylang/ruby", "/bin/bash", "/tmp/iruby/docker/setup.sh"
+    sh "docker", "commit", container_name, image_name
+    sh "docker", "rm", container_name
+  end
+
+  task :test do
+    root_dir = File.expand_path("..", __FILE__)
+    sh "docker", "run", "-it", "--rm",
+       "-v", "#{root_dir}:/tmp/iruby",
+       "mrkn/iruby", "/bin/bash", "/tmp/iruby/docker/test.sh"
+  end
+end

data/ci/Dockerfile.base.erb

@@ -0,0 +1,41 @@
+FROM rubylang/ruby:<%= ruby_version %>-bionic
+
+ADD ci/requirements.txt /tmp
+
+RUN apt-get update \
+    && apt-get install -y --no-install-recommends \
+               libczmq-dev \
+               python3 \
+               python3-pip \
+               python3-setuptools \
+               libpython3.6 \
+    && pip3 install wheel \
+    && pip3 install -r /tmp/requirements.txt \
+    && rm -f /tmp/requirements.txt
+
+# ZeroMQ version 4.1.6 and CZMQ version 3.0.2 for rbczmq
+RUN apt-get update \
+    && apt-get install -y --no-install-recommends \
+               build-essential \
+               file \
+               wget \
+    && cd /tmp \
+    && wget https://github.com/zeromq/zeromq4-1/releases/download/v4.1.6/zeromq-4.1.6.tar.gz \
+    && wget https://archive.org/download/zeromq_czmq_3.0.2/czmq-3.0.2.tar.gz \
+    && tar xf zeromq-4.1.6.tar.gz \
+    && tar xf czmq-3.0.2.tar.gz \
+    && \
+    ( \
+        cd zeromq-4.1.6 \
+        && ./configure \
+        && make install \
+    ) \
+    && \
+    ( \
+        cd czmq-3.0.2 \
+        && wget -O 1.patch https://github.com/zeromq/czmq/commit/2594d406d8ec6f54e54d7570d7febba10a6906b2.diff \
+        && wget -O 2.patch https://github.com/zeromq/czmq/commit/b651cb479235751b22b8f9a822a2fc6bc1be01ab.diff \
+        && cat *.patch | patch -p1 \
+        && ./configure \
+        && make install \
+    )