iruby 0.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 535b2e6920da18e1d6610cda01d192814a5f9595
-  data.tar.gz: 401889f3e858262e478fa15a3c709bcd6d09bd16
+SHA256:
+  metadata.gz: ab064a6f7df94f983b75ff53092fb54f6e9a7cc747e220a2e5b021eac840897e
+  data.tar.gz: c20d21297d688fc7794b4d0813ada1d9762ba38ea0fb3ccd99f9fbe7845ca5e3
 SHA512:
-  metadata.gz: 5d35b89326c32a1dcb52fc2242e366b693ffcac70b3b0ad232233010a6cd1de7c894429c724fb96a766ed35d995465c7b61e3274c7836639a8afd7a9fa56f0e9
-  data.tar.gz: 423d15b33c265bd943b5811fb3993f79d2da741790948f9efdd5890ca0f755f94d9fdb51ee78faf5adfa612a30d031e4014758725322f4fe22fd099c37a093c4
+  metadata.gz: eaf70e7d4ac97a11e03c7c6b5a94f5eb3d1b521ed18332ae510be5872c7faa87fb2814101fff22a8a5019adc8a93915085fb93c1fee5cfec24dd936c57c13fd4
+  data.tar.gz: cbfb04ac1dc3be65aa4c1c83b0701e39d603a439b35119b0bfa11d11467a7e4b3d29f347317b5b2f9cdfecd17fdcaf4b1474513d56b8a730764ff1ee7482cab7

data/.travis.yml

@@ -1,16 +1,41 @@
+sudo: required
+
 language: ruby
 
-rvm:
-  - ruby-head
-  - 2.2.2
-  - 2.1.6
-  - 2.0.0
+services:
+  - docker
 
 before_install:
-  - "sudo apt-get install libzmq3-dev"
-  - "sudo pip install 'ipython[notebook]'"
+  - docker images
+  - rake ci:docker:before_install
+
+install: 
+  - rake ci:docker:install
+  - docker images
+
+after_install:
+  - rake ci:docker:install
+  - docker images
+
+script: rake ci:docker:script
 
-script: bundle exec rake
+matrix:
+  include:
+    - name: "Ruby trunk-nightly"
+      env:
+        - ruby_version=trunk-nightly
+    - name: "Ruby 2.6"
+      env:
+        - ruby_version=2.6.1
+    - name: "Ruby 2.5"
+      env:
+        - ruby_version=2.5.3
+    - name: "Ruby 2.4"
+      env:
+        - ruby_version=2.4.5
+    - name: "Ruby 2.3"
+      env:
+        - ruby_version=2.3.8
 
-notifications:
-  irc: "chat.freenode.net#sciruby"
+  allow_failures:
+    - name: "Ruby trunk-nightly"

data/Gemfile

@@ -13,3 +13,7 @@ group :plot do
   gem 'nyaplot', github: 'sciruby/nyaplot'
 end
 
+group :test do
+  gem 'cztop'
+  gem 'rbczmq'
+end

data/README.md

@@ -1,54 +1,92 @@
-***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/).
-
-![Screenshot](https://cloud.githubusercontent.com/assets/50754/7956845/3fa46df8-09e3-11e5-8641-f5b8669061b5.png)
+[![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)
+[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/RubyData/binder/master?filepath=ruby-data.ipynb)
 
-### Quick start
-The installation instructions are divided according to environments mainly because of ZeroMQ.
+IRuby is a Ruby kernel for [Jupyter project](http://try.jupyter.org/).
 
-#### Ubuntu/Debian
-At first install IPython/Jupyter. I recommend an installation using virtualenv.
+## 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
 
-    sudo apt-get install python3-dev python-virtualenv
-    virtualenv -p python3 venv
-    source venv/bin/activate
-    pip install 'ipython[notebook]'
+### Ubuntu
+Install Jupyter with [Anaconda](https://www.anaconda.com/) (recommended). 
 
-After that, install the Ruby gem.
+#### 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.
 
-    gem install cztop
-    gem install iruby
+```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
+```
 
-Now you can run iruby with:
+#### Setup ZeroMQ on Ubuntu 17.04 to 18.10
+Use official packages.
 
-    iruby notebook
+```shell
+sudo apt install libtool libffi-dev ruby ruby-dev make
+sudo apt install libzmq3-dev libczmq-dev
+```
 
-#### Windows
-At first install IPython/Jupyter. I recommend an installation using [Enthought Canopy](https://www.enthought.com/).
+#### Install CZTop and IRuby
+```shell
+gem install cztop
+gem install iruby --pre
+iruby register --force
+```
 
-Run two commands below:
+### Windows
+Install git and Jupyter with [Anaconda](https://www.anaconda.com/) (recommended). 
+[DevKit](https://rubyinstaller.org/add-ons/devkit.html) is necessary for building RubyGems with native C-based extensions.
 
-    gem install cztop
-    gem install iruby
+Install ZeroMQ. 
+```shell
+pacman -S mingw64/mingw-w64-x86_64-zeromq
+```
 
-Now you can run iruby with:
+```shell
+gem install ffi-rzmq
+gem install iruby --pre
+iruby register --force
+```
 
-    iruby notebook
+### macOS
+Install ruby with rbenv or rvm.
+Install Jupyter with [Anaconda](https://www.anaconda.com/) (recommended). 
 
-#### Mac
-I recommend an installation using [Anaconda](https://store.continuum.io/cshop/anaconda/).
+#### Homebrew
+```shell
+brew install automake gmp libtool wget
+brew install zeromq --HEAD
+brew install czmq --HEAD
+```
 
-After that, run three commands shown below.
+```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
+```
 
-    brew install libtool autoconf automake autogen
-    gem install cztop
-    gem install iruby
+#### MacPorts
+If you are using macports, run the following commands.
 
-#### FreeBSD
+```shell
+port install libtool autoconf automake autogen
+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:
@@ -56,79 +94,72 @@ Therefore we use libzmq3 like the following:
 1. make your ports tree up-to-date.
 2. replace LIBDEPENDS line in ports/net/py-pyzmq/Makefile
 
-    ```shell
-    LIB_DEPENDS=    libzmq.so:${PORTSDIR}/net/libzmq4
-    ```
-    with
-    ```shell
-    LIB_DEPENDS=    libzmq.so:${PORTSDIR}/net/libzmq3
-    ```
+```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
-    ```
+```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
-    ```
-### Installation for jRuby
-
-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
+```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
+
+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
 
+## 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.
 
-### Required dependencies
-
-* IPython/Jupyter >= 3.0.0
-* Ruby >= 2.1.0
-
-If you install IRuby with CZTop, CZMQ >= 4.0.0 is added to the list above.
-
-If you install IRuby with ffi-rzmq, libzmq >= 3.2 is added to the list above.
-
-### Authors
-
+## Authors
 See the [CONTRIBUTORS](CONTRIBUTORS) file.
 
-### License
-
-Copyright © 2013-15, IRuby contributors and the Ruby Science Foundation.
+## License
+Copyright © 2013-19, IRuby contributors and the Ruby Science Foundation.
 
 All rights reserved.
 
-IRuby, along with [SciRuby](http://sciruby.com/), is licensed under the MIT license. See the [LICENSE](LICENSE) file for details.
+IRuby, along with [SciRuby](http://sciruby.com/), is licensed under the MIT license. See the [LICENSE](LICENSE) file.

data/Rakefile

@@ -5,6 +5,8 @@ begin
 rescue Exception
 end
 
+FileList['tasks/**.rake'].each {|f| load f }
+
 Rake::TestTask.new('test') do |t|
   t.libs << 'lib'
   t.libs << 'test'
@@ -13,3 +15,27 @@ Rake::TestTask.new('test') do |t|
 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 \
+    )

data/ci/Dockerfile.main.erb

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

data/ci/requirements.txt

@@ -0,0 +1 @@
+jupyter-console>=6.0.0

data/docker/setup.sh

@@ -0,0 +1,15 @@
+#!/bin/bash
+
+set -ex
+
+apt-get update
+apt-get install -y --no-install-recommends \
+        libczmq-dev \
+        python3 \
+        python3-pip \
+        python3-setuptools \
+        python3-wheel
+
+cd /tmp/iruby
+bundle install --with test --without plot
+pip3 install jupyter

data/docker/test.sh

@@ -0,0 +1,7 @@
+#!/bin/bash
+
+set -ex
+
+cd /tmp/iruby
+bundle install --with test --without plot
+bundle exec rake test

data/iruby.gemspec

@@ -24,8 +24,10 @@ Gem::Specification.new do |s|
 
   s.required_ruby_version = '>= 2.1.0'
 
-  s.add_development_dependency 'rake', '~> 10.4'
-  s.add_development_dependency 'minitest', '~> 5.6'
+  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'