iruby 0.3 → 0.4.0

data/lib/iruby/session_adapter/ffirzmq_adapter.rb

@@ -0,0 +1,55 @@
+module IRuby
+  module SessionAdapter
+    class FfirzmqAdapter < BaseAdapter
+      def self.load_requirements
+        require 'ffi-rzmq'
+      end
+
+      def send(sock, data)
+        data.each_with_index do |part, i|
+          sock.send_string(part, i == data.size - 1 ? 0 : ZMQ::SNDMORE)
+        end
+      end
+
+      def recv(sock)
+        msg = []
+        while msg.empty? || sock.more_parts?
+          begin
+            frame = ''
+            rc = sock.recv_string(frame)
+            ZMQ::Util.error_check('zmq_msg_recv', rc)
+            msg << frame
+          rescue
+          end
+        end
+        msg
+      end
+
+      def heartbeat_loop(sock)
+        @heartbeat_device = ZMQ::Device.new(sock, sock)
+      end
+
+      private
+
+      def make_socket(type, protocol, host, port)
+        case type
+        when :ROUTER, :PUB, :REP
+          type = ZMQ.const_get(type)
+        else
+          if ZMQ.const_defined?(type)
+            raise ArgumentError, "Unsupported ZMQ socket type: #{type_symbol}"
+          else
+            raise ArgumentError, "Invalid ZMQ socket type: #{type_symbol}"
+          end
+        end
+        zmq_context.socket(type).tap do |sock|
+          sock.bind("#{protocol}://#{host}:#{port}")
+        end
+      end
+
+      def zmq_context
+        @zmq_context ||= ZMQ::Context.new
+      end
+    end
+  end
+end

data/lib/iruby/session_adapter/pyzmq_adapter.rb

@@ -0,0 +1,76 @@
+module IRuby
+  module SessionAdapter
+    class PyzmqAdapter < BaseAdapter
+      def self.load_requirements
+        require 'pycall'
+        @zmq = PyCall.import_module('zmq')
+      rescue PyCall::PyError => error
+        raise LoadError, error.message
+      end
+
+      class << self
+        attr_reader :zmq
+      end
+
+      def make_router_socket(protocol, host, port)
+        make_socket(:ROUTER, protocol, host, port)
+      end
+
+      def make_pub_socket(protocol, host, port)
+        make_socket(:PUB, protocol, host, port)
+      end
+
+      def make_pub_socket(protocol, host, port)
+        make_socket(:REP, protocol, host, port)
+      end
+
+      def heartbeat_loop(sock)
+        PyCall.sys.path.append(File.expand_path('../pyzmq', __FILE__))
+        heartbeat = PyCall.import_module('iruby.heartbeat')
+        @heartbeat_thread = heartbeat.Heartbeat.new(sock)
+        @heartbeat_thread.start
+      end
+
+      private
+
+      def socket_type(type_symbol)
+        case type_symbol
+        when :ROUTER, :PUB, :REP
+          zmq[type_symbol]
+        else
+          raise ArgumentError, "Unknown ZMQ socket type: #{type_symbol}"
+        end
+      end
+
+      def make_socket(type_symbol, protocol, host, port)
+        type = socket_type(type_symbol)
+        sock = zmq_context.socket(type)
+        bind_socket(sock, protocol, host, port)
+        sock
+      end
+
+      def bind_socket(sock, protocol, host, port)
+        iface = "#{protocol}://#{host}"
+        case protocol
+        when 'tcp'
+          if port <= 0
+            port = sock.bind_to_random_port(iface)
+          else
+            sock.bind("#{iface}:#{port}")
+          end
+        else
+          raise ArgumentError, "Unsupported protocol: #{protocol}"
+        end
+        [sock, port]
+      end
+
+      def zmq_context
+        zmq.Context.instance
+      end
+
+      def zmq
+        self.class.zmq
+      end
+    end
+  end
+end

data/lib/iruby/session_adapter/rbczmq_adapter.rb

@@ -0,0 +1,33 @@
+module IRuby
+  module SessionAdapter
+    class RbczmqAdapter < BaseAdapter
+      def self.load_requirements
+        require 'rbczmq'
+      end
+
+      def send(sock, data)
+        sock.send_message(ZMQ::Message(*data))
+      end
+
+      def recv(sock)
+        sock.recv_message
+      end
+
+      def heartbeat_loop(sock)
+        ZMQ.proxy(sock, sock)
+      end
+
+      private
+
+      def make_socket(type, protocol, host, port)
+        zmq_context.socket(type).tap do |sock|
+          sock.bind("#{protocol}://#{host}:#{port}")
+        end
+      end
+
+      def zmq_context
+        @zmq_context ||= ZMQ::Context.new
+      end
+    end
+  end
+end

data/lib/iruby/utils.rb

@@ -7,8 +7,7 @@ module IRuby
     def display(obj, options = {})
       Kernel.instance.session.send(:publish, :display_data,
                                    data: Display.display(obj, options),
-                                   metadata: {},
-                                   source: 'ruby') unless obj.nil?
+                                   metadata: {}) unless obj.nil?
     end
 
     def table(s, **options)

data/lib/iruby/version.rb

@@ -1,3 +1,3 @@
 module IRuby
-  VERSION = '0.3'
+  VERSION = '0.4.0'
 end

data/run-test.sh

@@ -0,0 +1,12 @@
+#! /bin/bash
+
+set -ex
+
+export PYTHON=python3
+
+ADAPTERS="cztop rbczmq ffi-rzmq pyzmq"
+
+for adapter in $ADAPTERS; do
+  export IRUBY_TEST_SESSION_ADAPTER_NAME=$adapter
+  bundle exec rake test TESTOPTS=-v
+done

data/tasks/ci.rake

@@ -0,0 +1,65 @@
+namespace :ci do
+  namespace :docker do
+    def ruby_version
+      @ruby_version ||= ENV['ruby_version']
+    end
+
+    def ruby_image_name
+      @ruby_image_name ||= "rubylang/ruby:#{ruby_version}-bionic"
+    end
+
+    def iruby_test_base_image_name
+      @iruby_test_base_image_name ||= "iruby-test-base:ruby-#{ruby_version}"
+    end
+
+    def iruby_test_image_name
+      @docker_image_name ||= begin
+                               "sciruby/iruby-test:ruby-#{ruby_version}"
+                             end
+    end
+
+    def docker_image_found?(image_name)
+      image_id = `docker images -q #{image_name}`.chomp
+      image_id.length > 0
+    end
+
+    directory 'tmp'
+
+    desc "Build iruby-test-base docker image"
+    task :build_test_base_image => 'tmp' do
+      unless docker_image_found?(iruby_test_base_image_name)
+        require 'erb'
+        dockerfile_content = ERB.new(File.read('ci/Dockerfile.base.erb')).result(binding)
+        File.write('tmp/Dockerfile', dockerfile_content)
+        sh 'docker', 'build', '-t', iruby_test_base_image_name, '-f', 'tmp/Dockerfile', '.'
+      end
+    end
+
+    desc "Pull docker image of ruby"
+    task :pull_ruby_image do
+      sh 'docker', 'pull', ruby_image_name
+    end
+
+    desc "Build iruby-test docker image"
+    task :build_test_image => 'tmp' do
+      require 'erb'
+      dockerfile_content = ERB.new(File.read('ci/Dockerfile.main.erb')).result(binding)
+      File.write('tmp/Dockerfile', dockerfile_content)
+      sh 'docker', 'build', '-t', iruby_test_image_name, '-f', 'tmp/Dockerfile', '.'
+    end
+
+    desc 'before_install script for CI with Docker'
+    task :before_install => :pull_ruby_image
+    task :before_install => :build_test_base_image
+
+    desc 'install script for CI with Docker'
+    task :install => :build_test_image
+
+    desc 'main script for CI with Docker'
+    task :script do
+      volumes = ['-v', "#{Dir.pwd}:/iruby"] if ENV['attach_pwd']
+      sh 'docker', 'run', '--rm', '-it', *volumes,
+         iruby_test_image_name, 'bash', 'run-test.sh'
+    end
+  end
+end

data/test/integration_test.rb

@@ -1,40 +1,52 @@
 require 'test_helper'
-require 'open3'
+require 'pty'
 require 'expect'
 
-class IntegrationTest < IRubyTest
+class IRubyTest::IntegrationTest < IRubyTest::TestBase
   def setup
-    @stdin, @stdout, @stderr, @process = Open3.popen3('bin/iruby')
+    $expect_verbose = false # make true if you want to dump the output of iruby console
+
+    @in, @out, pid = PTY.spawn('bin/iruby --simple-prompt')
+    @waiter = Thread.start { Process.waitpid(pid) }
     expect 'In [', 30
     expect '1'
     expect ']:'
   end
 
   def teardown
-    @stdin.close
-    @stdout.close
-    @stderr.close
-    @process.kill
+    @in.close
+    @out.close
+    @waiter.join
   end
 
   def write(input)
-    @stdin.puts input
+    @out.puts input
   end
 
-  def expect(pattern, timeout = 1)
-    assert @stdout.expect(pattern, timeout), "#{pattern} expected"
+  def expect(pattern, timeout = 10)
+    assert @in.expect(pattern, timeout), "#{pattern} expected, but timeout"
+  end
+
+  def wait_prompt
+    expect 'In ['
+    expect ']:'
   end
 
   def test_interaction
+    skip "This test too much unstable"
+
     write '"Hello, world!"'
     expect '"Hello, world!"'
 
+    wait_prompt
     write 'puts "Hello!"'
     expect 'Hello!'
 
+    wait_prompt
     write '12 + 12'
     expect '24'
 
+    wait_prompt
     write 'ls'
     expect 'self.methods'
   end

data/test/iruby/command_test.rb

@@ -0,0 +1,208 @@
+require 'test_helper'
+require 'iruby/command'
+
+module IRubyTest
+  class CommandTest < TestBase
+    def test_with_empty_argv
+      with_env('JUPYTER_DATA_DIR' => nil,
+               'IPYTHONDIR' => nil) do
+        assert_output(nil, /\A\z/) do
+          @command = IRuby::Command.new([])
+          kernel_dir = File.join(IRuby::Jupyter.kernelspec_dir, 'ruby')
+          assert_equal(kernel_dir, @command.kernel_dir)
+          assert_equal(File.join(kernel_dir, 'kernel.json'), @command.kernel_file)
+        end
+      end
+    end
+
+    def test_with_JUPYTER_DATA_DIR
+      Dir.mktmpdir do |tmpdir|
+        with_env('JUPYTER_DATA_DIR' => tmpdir,
+                 'IPYTHONDIR' => nil) do
+          assert_output(nil, /\A\z/) do
+            @command = IRuby::Command.new([])
+            kernel_dir = File.join(tmpdir, 'kernels', 'ruby')
+            assert_equal(kernel_dir, @command.kernel_dir)
+            assert_equal(File.join(kernel_dir, 'kernel.json'), @command.kernel_file)
+          end
+        end
+      end
+    end
+
+    def test_with_IPYTHONDIR
+      Dir.mktmpdir do |tmpdir|
+        with_env('JUPYTER_DATA_DIR' => nil,
+                 'IPYTHONDIR' => tmpdir) do
+          assert_output(nil, /IPYTHONDIR is deprecated\. Use JUPYTER_DATA_DIR instead\./) do
+            @command = IRuby::Command.new([])
+            kernel_dir = File.join(tmpdir, 'kernels', 'ruby')
+            assert_equal(kernel_dir, @command.kernel_dir)
+            assert_equal(File.join(kernel_dir, 'kernel.json'), @command.kernel_file)
+          end
+        end
+      end
+    end
+
+    def test_with_JUPYTER_DATA_DIR_and_IPYTHONDIR
+      Dir.mktmpdir do |tmpdir|
+        Dir.mktmpdir do |tmpdir2|
+          with_env('JUPYTER_DATA_DIR' => tmpdir,
+                   'IPYTHONDIR' => tmpdir2) do
+            assert_output(nil, /both JUPYTER_DATA_DIR and IPYTHONDIR are supplied; IPYTHONDIR is ignored\./) do
+              @command = IRuby::Command.new([])
+              kernel_dir = File.join(tmpdir, 'kernels', 'ruby')
+              assert_equal(kernel_dir, @command.kernel_dir)
+              assert_equal(File.join(kernel_dir, 'kernel.json'), @command.kernel_file)
+            end
+          end
+        end
+      end
+    end
+
+    def test_with_ipython_dir_option
+      Dir.mktmpdir do |tmpdir|
+        with_env('JUPYTER_DATA_DIR' => nil,
+                 'IPYTHONDIR' => nil) do
+          assert_output(nil, /--ipython-dir is deprecated\. Use JUPYTER_DATA_DIR environment variable instead\./) do
+            @command = IRuby::Command.new(%W[--ipython-dir=#{tmpdir}])
+            kernel_dir = File.join(tmpdir, 'kernels', 'ruby')
+            assert_equal(kernel_dir, @command.kernel_dir)
+            assert_equal(File.join(kernel_dir, 'kernel.json'), @command.kernel_file)
+          end
+        end
+      end
+    end
+
+    def test_with_JUPYTER_DATA_DIR_and_ipython_dir_option
+      Dir.mktmpdir do |tmpdir|
+        Dir.mktmpdir do |tmpdir2|
+          with_env('JUPYTER_DATA_DIR' => tmpdir,
+                   'IPYTHONDIR' => nil) do
+            assert_output(nil, /both JUPYTER_DATA_DIR and --ipython-dir are supplied; --ipython-dir is ignored\./) do
+              @command = IRuby::Command.new(%W[--ipython-dir=#{tmpdir2}])
+              kernel_dir = File.join(tmpdir, 'kernels', 'ruby')
+              assert_equal(kernel_dir, @command.kernel_dir)
+              assert_equal(File.join(kernel_dir, 'kernel.json'), @command.kernel_file)
+            end
+          end
+        end
+      end
+    end
+
+    def test_register_when_there_is_kernel_in_ipython_dir
+      Dir.mktmpdir do |tmpdir|
+        Dir.mktmpdir do |tmpdir2|
+          with_env('JUPYTER_DATA_DIR' => nil,
+                   'IPYTHONDIR' => nil,
+                   'HOME' => tmpdir2) do
+            ignore_warning do
+              @command = IRuby::Command.new(["register", "--ipython-dir=~/.ipython"])
+              assert_equal("#{tmpdir2}/.ipython/kernels/ruby/kernel.json", @command.kernel_file)
+              @command.run
+              assert(File.file?("#{tmpdir2}/.ipython/kernels/ruby/kernel.json"))
+            end
+          end
+
+          with_env('JUPYTER_DATA_DIR' => nil,
+                   'IPYTHONDIR' => nil,
+                   'HOME' => tmpdir2) do
+            @command = IRuby::Command.new(["register"])
+            assert_output(nil, /IRuby kernel file already exists in the deprecated IPython's data directory\.\nUsing --force, you can replace the old kernel file with the new one in Jupyter's data directory\./) do
+              @command.run
+            end
+            assert(File.file?(File.join(@command.ipython_kernel_dir, 'kernel.json')))
+            refute(File.file?(@command.kernel_file))
+
+            @command = IRuby::Command.new(["register", "--force"])
+            assert_output(nil, nil) do
+              @command.run
+            end
+            refute(File.exist?(@command.ipython_kernel_dir))
+            assert(File.file?(@command.kernel_file))
+          end
+        end
+      end
+    end
+
+    def test_register_and_unregister_with_JUPYTER_DATA_DIR
+      Dir.mktmpdir do |tmpdir|
+        Dir.mktmpdir do |tmpdir2|
+          with_env('JUPYTER_DATA_DIR' => tmpdir,
+                   'IPYTHONDIR' => nil,
+                   'HOME' => tmpdir2) do
+            assert_output(nil, nil) do
+              @command = IRuby::Command.new(['register'])
+              kernel_dir = File.join(tmpdir, 'kernels', 'ruby')
+              kernel_file = File.join(kernel_dir, 'kernel.json')
+              assert(!File.file?(kernel_file))
+
+              @command.run
+              assert(File.file?(kernel_file))
+
+              @command = IRuby::Command.new(['unregister'])
+              @command.run
+              assert(!File.file?(kernel_file))
+            end
+          end
+        end
+      end
+    end
+
+    def test_register_and_unregister_with_JUPYTER_DATA_DIR_when_there_is_kernel_in_ipython_dir
+      Dir.mktmpdir do |tmpdir|
+        Dir.mktmpdir do |tmpdir2|
+          with_env('HOME' => tmpdir2) do
+            ignore_warning do
+              @command = IRuby::Command.new(["register", "--ipython-dir=~/.ipython"])
+              assert_equal("#{tmpdir2}/.ipython/kernels/ruby/kernel.json", @command.kernel_file)
+              @command.run
+              assert(File.file?("#{tmpdir2}/.ipython/kernels/ruby/kernel.json"))
+            end
+          end
+
+          with_env('JUPYTER_DATA_DIR' => tmpdir,
+                   'IPYTHONDIR' => nil,
+                   'HOME' => tmpdir2) do
+            @command = IRuby::Command.new(["register"])
+            assert_output(nil, /IRuby kernel file already exists in the deprecated IPython's data directory\.\nUsing --force, you can replace the old kernel file with the new one in Jupyter's data directory\./) do
+              @command.run
+            end
+            assert(File.file?(File.join(@command.ipython_kernel_dir, 'kernel.json')))
+            refute(File.file?(@command.kernel_file))
+
+            @command = IRuby::Command.new(["register", "--force"])
+            assert_output(nil, nil) do
+              @command.run
+            end
+            refute(File.file?(File.join(@command.ipython_kernel_dir, 'kernel.json')))
+            assert(File.file?(@command.kernel_file))
+          end
+        end
+      end
+    end
+
+    def test_register_and_unregister_with_IPYTHONDIR
+      Dir.mktmpdir do |tmpdir|
+        Dir.mktmpdir do |tmpdir2|
+          with_env('JUPYTER_DATA_DIR' => nil,
+                   'IPYTHONDIR' => tmpdir,
+                   'HOME' => tmpdir2) do
+            ignore_warning do
+              @command = IRuby::Command.new(['register'])
+              kernel_dir = File.join(tmpdir, 'kernels', 'ruby')
+              kernel_file = File.join(kernel_dir, 'kernel.json')
+              assert(!File.file?(kernel_file))
+
+              @command.run
+              assert(File.file?(kernel_file))
+
+              @command = IRuby::Command.new(['unregister'])
+              @command.run
+              assert(!File.file?(kernel_file))
+            end
+          end
+        end
+      end
+    end
+  end
+end