iruby 0.4.0 → 0.7.1

data/lib/iruby/session_adapter/test_adapter.rb

@@ -0,0 +1,49 @@
+require 'iruby/session/mixin'
+
+module IRuby
+  module SessionAdapter
+    class TestAdapter < BaseAdapter
+      include IRuby::SessionSerialize
+
+      DummySocket = Struct.new(:type, :protocol, :host, :port)
+
+      def initialize(config)
+        super
+
+        unless config['key'].empty? || config['signature_scheme'].empty?
+          unless config['signature_scheme'] =~ /\Ahmac-/
+            raise "Unknown signature_scheme: #{config['signature_scheme']}"
+          end
+          digest_algorithm = config['signature_scheme'][/\Ahmac-(.*)\Z/, 1]
+          @hmac = OpenSSL::HMAC.new(config['key'], OpenSSL::Digest.new(digest_algorithm))
+        end
+
+        @send_callback = nil
+        @recv_callback = nil
+      end
+
+      attr_accessor :send_callback, :recv_callback
+
+      def send(sock, data)
+        unless @send_callback.nil?
+          @send_callback.call(sock, unserialize(data))
+        end
+      end
+
+      def recv(sock)
+        unless @recv_callback.nil?
+          serialize(@recv_callback.call(sock))
+        end
+      end
+
+      def heartbeat_loop(sock)
+      end
+
+      private
+
+      def make_socket(type, protocol, host, port)
+        DummySocket.new(type, protocol, host, port)
+      end
+    end
+  end
+end

data/lib/iruby/utils.rb

@@ -4,33 +4,48 @@ module IRuby
       Display.convert(object, options)
     end
 
+    # Display the object
     def display(obj, options = {})
       Kernel.instance.session.send(:publish, :display_data,
                                    data: Display.display(obj, options),
                                    metadata: {}) unless obj.nil?
+      # The next `nil` is necessary to prevent unintentional displaying
+      # the result of Session#send
+      nil
     end
 
+    # Clear the output area
+    def clear_output(wait=false)
+      Display.clear_output(wait)
+    end
+
+    # Format the given object into HTML table
     def table(s, **options)
       html(HTML.table(s, options))
     end
 
+    # Treat the given string as LaTeX text
     def latex(s)
       convert(s, mime: 'text/latex')
     end
     alias tex latex
 
+    # Format the given string of TeX equation into LaTeX text
     def math(s)
       convert("$$#{s}$$", mime: 'text/latex')
     end
 
+    # Treat the given string as HTML
     def html(s)
       convert(s, mime: 'text/html')
     end
 
+    # Treat the given string as JavaScript code
     def javascript(s)
       convert(s, mime: 'application/javascript')
     end
 
+    # Treat the given string as SVG text
     def svg(s)
       convert(s, mime: 'image/svg+xml')
     end

data/lib/iruby/version.rb

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

data/run-test.sh

@@ -4,7 +4,7 @@ set -ex
 
 export PYTHON=python3
 
-ADAPTERS="cztop rbczmq ffi-rzmq pyzmq"
+ADAPTERS="cztop ffi-rzmq pyzmq"
 
 for adapter in $ADAPTERS; do
   export IRUBY_TEST_SESSION_ADAPTER_NAME=$adapter

data/test/helper.rb

@@ -0,0 +1,136 @@
+require "iruby"
+require "json"
+require 'multi_json'
+require "pathname"
+require "test/unit"
+require "test/unit/rr"
+require "tmpdir"
+
+
+IRuby.logger = IRuby::MultiLogger.new(*Logger.new(STDERR, level: Logger::Severity::INFO))
+
+module IRubyTest
+  class TestBase < Test::Unit::TestCase
+    def self.startup
+      @__config_dir = Dir.mktmpdir("iruby-test")
+      @__config_path = Pathname.new(@__config_dir) + "config.json"
+      File.write(@__config_path, {
+        control_port: 50160,
+        shell_port: 57503,
+        transport: "tcp",
+        signature_scheme: "hmac-sha256",
+        stdin_port: 52597,
+        hb_port: 42540,
+        ip: "127.0.0.1",
+        iopub_port: 40885,
+        key: "a0436f6c-1916-498b-8eb9-e81ab9368e84"
+      }.to_json)
+
+      @__original_kernel_instance = IRuby::Kernel.instance
+    end
+
+    def self.shutdown
+      FileUtils.remove_entry_secure(@__config_dir)
+    end
+
+    def self.test_config_filename
+      @__config_path.to_s
+    end
+
+    def self.restore_kernel
+      IRuby::Kernel.instance = @__original_kernel_instance
+    end
+
+    def teardown
+      self.class.restore_kernel
+    end
+
+    def with_session_adapter(session_adapter_name)
+      IRuby::Kernel.new(self.class.test_config_filename, session_adapter_name)
+      $stdout = STDOUT
+      $stderr = STDERR
+    end
+
+    def assert_output(stdout=nil, stderr=nil)
+      flunk "assert_output requires a block to capture output." unless block_given?
+
+      out, err = capture_io do
+        yield
+      end
+
+      y = check_assert_output_result(stderr, err, "stderr")
+      x = check_assert_output_result(stdout, out, "stdout")
+
+      (!stdout || x) && (!stderr || y)
+    end
+
+    private
+
+    def capture_io
+      captured_stdout = StringIO.new
+      captured_stderr = StringIO.new
+
+      orig_stdout, $stdout = $stdout, captured_stdout
+      orig_stderr, $stderr = $stderr, captured_stderr
+
+      yield
+
+      return captured_stdout.string, captured_stderr.string
+    ensure
+      $stdout = orig_stdout
+      $stderr = orig_stderr
+    end
+
+    def check_assert_output_result(expected, actual, name)
+      if expected
+        message = "In #{name}"
+        case expected
+        when Regexp
+          assert_match(expected, actual, message)
+        else
+          assert_equal(expected, actual, message)
+        end
+      end
+    end
+
+    def ignore_warning
+      saved, $VERBOSE = $VERBOSE , nil
+      yield
+    ensure
+      $VERBOSE = saved
+    end
+
+    def with_env(env)
+      keys = env.keys
+      saved_values = ENV.values_at(*keys)
+      ENV.update(env)
+      yield
+    ensure
+      if keys && saved_values
+        keys.zip(saved_values) do |k, v|
+          ENV[k] = v
+        end
+      end
+    end
+
+    def windows_only
+      omit('windows only test') unless windows?
+    end
+
+    def apple_only
+      omit('apple only test') unless windows?
+    end
+
+    def unix_only
+      omit('unix only test') if windows? || apple?
+    end
+
+    def windows?
+      /mingw|mswin/ =~ RUBY_PLATFORM
+    end
+
+    def apple?
+      /darwin/ =~ RUBY_PLATFORM
+    end
+  end
+end

data/test/integration_test.rb

@@ -1,4 +1,3 @@
-require 'test_helper'
 require 'pty'
 require 'expect'
 
@@ -33,7 +32,7 @@ class IRubyTest::IntegrationTest < IRubyTest::TestBase
   end
 
   def test_interaction
-    skip "This test too much unstable"
+    omit("This test too much unstable")
 
     write '"Hello, world!"'
     expect '"Hello, world!"'

data/test/iruby/backend_test.rb

@@ -0,0 +1,37 @@
+module IRubyTest
+  class PlainBackendTest < IRubyTest::TestBase
+    def setup
+      @plainbackend = IRuby::PlainBackend.new
+    end
+
+    def test_eval_one_plus_two
+      assert_equal 3, @plainbackend.eval('1+2', false)
+    end
+
+    def test_complete_req
+      assert_includes @plainbackend.complete('req'), 'require'
+    end
+
+    def test_complete_2_dot
+      assert_includes @plainbackend.complete('2.'), '2.even?'
+    end
+  end
+
+  class PryBackendTest < IRubyTest::TestBase
+    def setup
+      @prybackend = IRuby::PryBackend.new
+    end
+
+    def test_eval_one_plus_two
+      assert_equal 3, @prybackend.eval('1+2', false)
+    end
+
+    def test_complete_req
+      assert_includes @prybackend.complete('req'), 'require'
+    end
+
+    def test_complete_2_dot
+      assert_includes @prybackend.complete('2.'), '2.even?'
+    end
+  end
+end

data/test/iruby/command_test.rb

@@ -1,4 +1,3 @@
-require 'test_helper'
 require 'iruby/command'
 
 module IRubyTest

data/test/iruby/display_test.rb

@@ -0,0 +1,188 @@
+module IRubyTest
+  class DisplayTest < TestBase
+    def setup
+      @object = Object.new
+      @object.instance_variable_set(:@to_html_called, false)
+      @object.instance_variable_set(:@to_markdown_called, false)
+      @object.instance_variable_set(:@to_iruby_called, false)
+      @object.instance_variable_set(:@to_iruby_mimebundle_called, false)
+
+      class << @object
+        attr_reader :to_html_called
+        attr_reader :to_markdown_called
+        attr_reader :to_iruby_called
+        attr_reader :to_iruby_mimebundle_called
+
+        def html
+          "<b>html</b>"
+        end
+
+        def markdown
+          "*markdown*"
+        end
+
+        def inspect
+          "!!! inspect !!!"
+        end
+      end
+    end
+
+    def define_to_html
+      class << @object
+        def to_html
+          @to_html_called = true
+          html
+        end
+      end
+    end
+
+    def define_to_markdown
+      class << @object
+        def to_markdown
+          @to_markdown_called = true
+          markdown
+        end
+      end
+    end
+
+    def define_to_iruby
+      class << @object
+        def to_iruby
+          @to_iruby_called = true
+          ["text/html", "<b>to_iruby</b>"]
+        end
+      end
+    end
+
+    def define_to_iruby_mimebundle
+      class << @object
+        def to_iruby_mimebundle(include: [])
+          @to_iruby_mimebundle_called = true
+          mimes = if include.empty?
+                    ["text/html", "text/markdown", "application/json"]
+                  else
+                    include
+                  end
+          formats = mimes.map { |mime|
+            result = case mime
+                     when "text/html"
+                       "<i>html</i>"
+                     when "text/markdown"
+                       "**markdown**"
+                     when "application/json"
+                       %Q[{"mimebundle": "json"}]
+                     end
+            [mime, result]
+          }.to_h
+          metadata = {}
+          return formats, metadata
+        end
+      end
+    end
+
+    def assert_iruby_display(expected)
+      assert_equal(expected,
+                   {
+                     result: IRuby::Display.display(@object),
+                     to_html_called: @object.to_html_called,
+                     to_markdown_called: @object.to_markdown_called,
+                     to_iruby_called: @object.to_iruby_called,
+                     to_iruby_mimebundle_called: @object.to_iruby_mimebundle_called
+                   })
+    end
+
+    sub_test_case("the object cannot handle all the mime types") do
+      def test_display
+        assert_iruby_display({
+                               result: {"text/plain" => "!!! inspect !!!"},
+                               to_html_called: false,
+                               to_markdown_called: false,
+                               to_iruby_called: false,
+                               to_iruby_mimebundle_called: false
+                             })
+      end
+    end
+
+    sub_test_case("the object can respond to to_iruby") do
+      def setup
+        super
+        define_to_iruby
+      end
+
+      def test_display
+        assert_iruby_display({
+                               result: {
+                                 "text/html" => "<b>to_iruby</b>",
+                                 "text/plain" => "!!! inspect !!!"
+                               },
+                               to_html_called: false,
+                               to_markdown_called: false,
+                               to_iruby_called: true,
+                               to_iruby_mimebundle_called: false
+                             })
+      end
+
+      sub_test_case("the object can respond to to_markdown") do
+        def setup
+          super
+          define_to_markdown
+        end
+
+        def test_display
+          assert_iruby_display({
+                                 result: {
+                                   "text/markdown" => "*markdown*",
+                                   "text/plain" => "!!! inspect !!!"
+                                 },
+                                 to_html_called: false,
+                                 to_markdown_called: true,
+                                 to_iruby_called: false,
+                                 to_iruby_mimebundle_called: false
+                               })
+        end
+      end
+
+      sub_test_case("the object can respond to to_html") do
+        def setup
+          super
+          define_to_html
+        end
+
+        def test_display
+          assert_iruby_display({
+                                 result: {
+                                   "text/html" => "<b>html</b>",
+                                   "text/plain" => "!!! inspect !!!"
+                                 },
+                                 to_html_called: true,
+                                 to_markdown_called: false,
+                                 to_iruby_called: false,
+                                 to_iruby_mimebundle_called: false
+                               })
+        end
+
+        sub_test_case("the object can respond to to_iruby_mimebundle") do
+          def setup
+            super
+            define_to_iruby_mimebundle
+          end
+
+          def test_display
+            assert_iruby_display({
+                                   result: {
+                                     "text/html" => "<i>html</i>",
+                                     "text/markdown" => "**markdown**",
+                                     "application/json" => %Q[{"mimebundle": "json"}],
+                                     "text/plain" => "!!! inspect !!!"
+                                   },
+                                   to_html_called: false,
+                                   to_markdown_called: false,
+                                   to_iruby_called: false,
+                                   to_iruby_mimebundle_called: true
+                                 })
+          end
+        end
+      end
+    end
+  end
+end