Supports inline PNG images by sending an appropriate display_data (a) output as base64 encoded, or (b) file based.

Author: piisgaaf

README.md

@@ -146,6 +146,7 @@ iex> Number.Currency.number_to_currency(2034.46)
 Additional resources:
 * [Notebook with Boyle examples](https://github.com/pprzetacznik/IElixir/blob/master/resources/boyle%20example.ipynb)
 * [Notebook with Boyle examples with usage of Matrex library](https://github.com/pprzetacznik/IElixir/blob/master/resources/boyle%20example%20-%20matrex%20installation%20and%20usage.ipynb)
+* [Notebook with inline image examples with usage of Gnuplot library](https://github.com/pprzetacznik/IElixir/blob/master/resources/inlineplot%20example%20-%20gnuplot.ipynb)
 
 ### Developement mode
 

lib/ielixir/sandbox.ex

@@ -8,7 +8,7 @@ defmodule IElixir.Sandbox do
   @typedoc "Execution response"
   @type execution_response :: {
     status :: :ok,
-    result :: :"this is raw html" | :"do not show this result in output" | String.t,
+    result :: :"this is raw html" | :"do not show this result in output" | :"this is an inline image" | {:"this is an inline image",Keyword.t} | String.t,
     stdout :: String.t,
     stderr :: String.t,
     execution_count :: integer}
@@ -168,6 +168,10 @@ defmodule IElixir.Sandbox do
       binding = case result do
          :"do not show this result in output" ->
            binding
+         :"this is an inline image" ->
+           binding
+         {:"this is an inline image",_} ->
+           binding
          _ ->
            binding
            |> Keyword.put(:ans, result)
@@ -220,6 +224,12 @@ defmodule IElixir.Sandbox do
   defp maybe_inspect(result) when result in [:"this is raw html", :"do not show this result in output"] do
     ""
   end
+  defp maybe_inspect(result = {:"this is an inline image",_}) do
+    result
+  end
+  defp maybe_inspect(result = :"this is an inline image") do
+    result
+  end
   defp maybe_inspect(result) do
     inspect(result)
   end

lib/ielixir/socket/iopub.ex

@@ -58,6 +58,14 @@ defmodule IElixir.Socket.IOPub do
     GenServer.cast(IOPub, {:send_html, message, text})
   end
 
+  @doc """
+  Send stream message but with a mime type of IMAGE, so the content
+  is interpolated into the result
+  """
+  def send_image(message, execution_count, image) do
+    GenServer.cast(IOPub, {:send_image, message, execution_count, image})
+  end
+
   @doc """
   Send error message. Send traceback so client can have information about what
   went wrong.
@@ -98,6 +106,31 @@ defmodule IElixir.Socket.IOPub do
     Message.send_message(sock, message, "display_data", content)
     {:noreply, sock}
   end
+  def handle_cast({:send_image, message, execution_count, {:file,kw}}, sock) do
+    try do
+      raw64 = File.read!(kw[:src]) |> Base.encode64
+      content = %{
+        data: %{
+          "image/png" => raw64,
+        },
+      }
+      Message.send_message(sock, message, "display_data", content)
+      {:noreply, sock}
+    rescue
+      error ->
+        traceback = System.stacktrace() |> Enum.map(&"#{inspect &1}")
+        handle_cast({:send_error,message,execution_count,IO.inspect(error),traceback}, sock)
+    end
+  end
+  def handle_cast({:send_image, message, _execution_count, {:raw,raw64}}, sock) do
+    content = %{
+      data: %{
+        "image/png" => raw64,
+      },
+    }
+    Message.send_message(sock, message, "display_data", content)
+    {:noreply, sock}
+  end
 
   def handle_cast({:send_execute_result, message, {text, execution_count}}, sock) do
     content = %{

lib/ielixir/socket/shell.ex

@@ -158,6 +158,13 @@ defmodule IElixir.Socket.Shell do
     IOPub.send_html(response.message, response.output)
     response
   end
+  defp publish_output(response = %{result: {:"this is an inline image",_}}) do
+    response
+  end
+  defp publish_output(response = %{result: :"this is an inline image"}) do
+    IOPub.send_image(response.message, response.count, {:raw, response.output})
+    response
+  end
   defp publish_output(response) do
     IOPub.send_stream(response.message, response.output)
     response
@@ -184,6 +191,13 @@ defmodule IElixir.Socket.Shell do
   defp publish_execute_response(response = %{result: :"this is raw html"}) do
     response
   end
+  defp publish_execute_response(response = %{result: {:"this is an inline image",kw}}) do
+    IOPub.send_image(response.message, response.count, {:file, kw})
+    response
+  end
+  defp publish_execute_response(response = %{result: :"this is an inline image"}) do
+    response
+  end
   defp publish_execute_response(response = %{silent: true}) do
     response
   end

mix.exs

@@ -1,7 +1,7 @@
 defmodule IElixir.Mixfile do
   use Mix.Project
 
-  @version "0.9.15"
+  @version "0.9.16"
 
   def project do
     [app: :ielixir,