Merge pull request #80 from esl/allow-typecheck-erl-files

Support typechecking for erlang files from  `src/` directory

Author: Premwoik

.gitignore

@@ -25,8 +25,11 @@ gradient-*.tar
 # Temporary files, for example, from tests.
 /tmp/
 
-# Beam files compiled from examples
+# Elixir beam files compiled from examples
 test/examples/_build/
 
+# Erlang beam files compiled from examples
+test/examples/erlang/_build/
+
 # MacOS DS_Store
 .DS_Store

lib/gradient.ex

@@ -23,7 +23,8 @@ defmodule Gradient do
   def type_check_file(file, opts \\ []) do
     opts = Keyword.put(opts, :return_errors, true)
 
-    with {:ok, forms} <- ElixirFileUtils.get_forms(file) do
+    with {:ok, forms} <- ElixirFileUtils.get_forms(file),
+         {:elixir, _} <- wrap_language_name(forms) do
       forms = maybe_specify_forms(forms, opts)
 
       case maybe_gradient_check(forms, opts) ++ maybe_gradualizer_check(forms, opts) do
@@ -36,6 +37,12 @@ defmodule Gradient do
           :error
       end
     else
+      {:erlang, forms} ->
+        opts = Keyword.put(opts, :return_errors, false)
+        case maybe_gradualizer_check(forms, opts) do
+          :nok -> :error
+          _ -> :ok
+        end
       error ->
         Logger.error("Can't load file - #{inspect(error)}")
         :error
@@ -74,6 +81,14 @@ defmodule Gradient do
     end
   end
 
+  defp wrap_language_name([{:attribute, _, :file, {file_name, _}} | _] = forms) do
+    if :string.str(file_name, '.erl') > 0 do
+      {:erlang, forms}
+    else
+      {:elixir, forms}
+    end
+  end
+
   defp put_code_path(forms, opts) do
     case opts[:code_path] do
       nil ->

test/examples/erlang/test.erl

@@ -0,0 +1,9 @@
+-module(test).
+
+-export([positive/1]).
+
+-spec positive(integer()) -> ok | error.
+positive(A) when A > 0 ->
+    ok;
+positive(_) ->
+    error.

test/examples/erlang/test_err.erl

@@ -0,0 +1,9 @@
+-module(test_err).
+
+-export([positive/1]).
+
+-spec positive(integer()) -> integer().
+positive(A) when A > 0 ->
+    ok;
+positive(_) ->
+    error.

test/gradient_test.exs

@@ -1,4 +1,31 @@
 defmodule GradientTest do
   use ExUnit.Case
   doctest Gradient
+
+  import Gradient.TestHelpers
+  import ExUnit.CaptureIO
+
+  test "typecheck erlang beam" do
+    # typecheck file with errors
+    path = "test/examples/erlang/_build/test_err.beam"
+    erl_path = "test/examples/erlang/test_err.erl"
+    io_data = capture_io(fn -> assert :error = Gradient.type_check_file(path) end)
+    assert String.contains?(io_data, erl_path)
+    # typecheck correct file
+    capture_io(fn ->
+      assert :ok = Gradient.type_check_file("test/examples/erlang/_build/test.beam")
+    end)
+  end
+
+  test "typecheck elixir beam" do
+    # typecheck file with errors
+    path = "test/examples/_build/Elixir.WrongRet.beam"
+    ex_path = "test/examples/type/wrong_ret.ex"
+    io_data = capture_io(fn -> assert :error = Gradient.type_check_file(path) end)
+    assert String.contains?(io_data, ex_path)
+    # typecheck correct file
+    capture_io(fn ->
+      assert :ok = Gradient.type_check_file("test/examples/_build/Elixir.Basic.beam")
+    end)
+  end
 end

test/test_helper.exs

@@ -1,5 +1,6 @@
 defmodule ExamplesCompiler do
   @build_path "test/examples/_build/"
+  @erl_build_path "test/examples/erlang/_build/"
 
   @version_step 0.01
 
@@ -24,6 +25,20 @@ defmodule ExamplesCompiler do
     end
   end
 
+  def erl_compile(pattern) do
+    case File.mkdir(@erl_build_path) do
+      :ok ->
+        pattern
+        |> Path.wildcard()
+        |> Enum.each(fn p ->
+          :compile.file(to_charlist(p), [:debug_info, {:outdir, to_charlist(@erl_build_path)}])
+        end)
+
+      _ ->
+        :error
+    end
+  end
+
   def excluded_version_tags do
     case @version do
       1.11 ->
@@ -58,4 +73,6 @@ end
 ExamplesCompiler.compile("test/examples/**/*.ex")
 exlcude = ExamplesCompiler.excluded_version_tags()
 
+ExamplesCompiler.erl_compile("test/examples/erlang/**/*.erl")
+
 ExUnit.start(exclude: exlcude)