100% test coverage (#246)

Author: jiegillet

README.md

@@ -29,14 +29,6 @@ Running `bin/elixir_analyzer` on a system with Elixir/Erlang/OTP installed
 ```text
   Usage:
     $ elixir_analyzer <exercise-slug> <path the folder containing the solution> <path to folder for output> [options]
-
-  You may also pass the following options:
-    --skip-analysis                       flag skips running the static analysis
-    --output-file <filename>
-
-  You may also test only individual files :
-    (assuming analyzer tests are compiled for the named module)
-    $ exercism_analyzer --analyze-file <full-path-to-.ex>:<module-name>
 ```
 
 ### via IEX

lib/elixir_analyzer.ex

@@ -29,18 +29,14 @@ defmodule ElixirAnalyzer do
 
   * `exercise` is which exercise is submitted to determine proper analysis
 
-  * `path` is the path (ending with a '/') to the submitted solution
+  * `input_path` is the path to the submitted solution
+
+  * `output_path` is the path to the output folder
 
   * `opts` is a Keyword List of options, see **options**
 
   ## Options
 
-  * `:exercise` - name of the exercise, defaults to the `exercise` parameter
-
-  * `:path` - path to the submitted solution, defaults to the `path` parameter
-
-  * `:output_path` - path to write file output, defaults to the `path` parameter
-
   * `:output_file`, - specifies the name of the output_file, defaults to
     `@output_file` (`analysis.json`)
 
@@ -52,8 +48,6 @@ defmodule ElixirAnalyzer do
 
   * `:puts_summary` - boolean flag if an analysis should print the summary of the
     analysis to stdio, defaults to `true`
-
-  Any arbitrary keyword-value pair can be passed to `analyze_exercise/3` and these options may be used the other consuming code.
   """
   @spec analyze_exercise(String.t(), String.t(), String.t(), keyword()) :: Submission.t()
   def analyze_exercise(exercise, input_path, output_path, opts \\ []) do
@@ -147,14 +141,14 @@ defmodule ElixirAnalyzer do
       }
     rescue
       e in File.Error ->
-        Logger.warning("Unable to decode 'config.json'", error_message: e.message)
+        Logger.warning("Unable to read config file #{e.path}", error_message: e.reason)
 
         submission
         |> Submission.halt()
         |> Submission.set_halt_reason("Analysis skipped, not able to read solution config.")
 
       e in Jason.DecodeError ->
-        Logger.warning("Unable to decode 'config.json'", error_message: e.message)
+        Logger.warning("Unable to decode 'config.json'", data: e.data)
 
         submission
         |> Submission.halt()
@@ -256,7 +250,7 @@ defmodule ElixirAnalyzer do
 
     submission =
       submission
-      |> submission.analysis_module.analyze(submission.source)
+      |> submission.analysis_module.analyze()
       |> Submission.set_analyzed(true)
 
     Logger.info("Analyzing code complete")

lib/elixir_analyzer/cli.ex

@@ -6,22 +6,19 @@ defmodule ElixirAnalyzer.CLI do
   @usage """
   Usage:
 
-    $ elixir_analyzer <exercise-name> <input path> <output path>  [options]
+    $ elixir_analyzer <exercise-name> <input path> <output path> [options]
 
   You may also pass the following options:
-    --skip-analysis                       flag skips running the static analysis
-    --output-file <filename>
-
-  You may also test only individual files :
-    (assuming analyzer tests are compiled for the named module)
-
-    $ exercism_analyzer --analyze-file <full-path-to-.ex>:<module-name>
+    --help                          see this message
+    --output-file <filename>        output file name (default: analysis.json)
+    --no-write-results              doesn't write to JSON file
+    --no-puts-summary               doesn't print summary to stdio
   """
 
   @options [
-    {{:skip_analyze, :boolean}, false},
     {{:output_file, :string}, "analysis.json"},
-    {{:analyze_file, :string}, nil},
+    {{:write_results, :boolean}, true},
+    {{:puts_summary, :boolean}, true},
     {{:help, :boolean}, false}
   ]
 
@@ -30,45 +27,27 @@ defmodule ElixirAnalyzer.CLI do
     args |> parse_args() |> process()
   end
 
-  def parse_args(args) do
-    options = %{
-      :output_file => "analysis.json"
-    }
+  defp parse_args(args) do
+    default_ops = for({{key, _}, val} <- @options, do: {key, val}, into: %{})
 
-    cmd_opts =
-      OptionParser.parse(args,
-        strict: for({o, _} <- @options, do: o)
-      )
+    cmd_opts = OptionParser.parse(args, strict: for({o, _} <- @options, do: o))
 
     case cmd_opts do
       {[help: true], _, _} ->
         :help
 
-      {[analyze_file: target], _, _} ->
-        [full_path, module] = String.split(target, ":", trim: true)
-        path = Path.dirname(full_path)
-        file = Path.basename(full_path)
-        {Enum.into([module: module, file: file], options), "undefined", path}
-
       {opts, [exercise, input_path, output_path], _} ->
-        {Enum.into(opts, options), exercise, input_path, output_path}
+        {Enum.into(opts, default_ops), exercise, input_path, output_path}
     end
   rescue
     _ -> :help
   end
 
-  def process(:help), do: IO.puts(@usage)
+  defp process(:help), do: IO.puts(@usage)
 
-  def process({options, exercise, input_path, output_path}) do
-    opts = get_default_options(options)
-    ElixirAnalyzer.analyze_exercise(exercise, input_path, output_path, opts)
-  end
+  defp process({options, exercise, input_path, output_path}) do
+    opts = Map.to_list(options)
 
-  defp get_default_options(options) do
-    @options
-    |> Enum.reduce(options, fn {{option, _}, default}, acc ->
-      Map.put_new(acc, option, default)
-    end)
-    |> Map.to_list()
+    ElixirAnalyzer.analyze_exercise(exercise, input_path, output_path, opts)
   end
 end

lib/elixir_analyzer/exercise_test.ex

@@ -22,7 +22,7 @@ defmodule ElixirAnalyzer.ExerciseTest do
 
       import unquote(__MODULE__)
       @before_compile unquote(__MODULE__)
-      @dialyzer no_match: {:do_analyze, 2}
+      @dialyzer no_match: {:do_analyze, 1}
     end
   end
 
@@ -51,19 +51,20 @@ defmodule ElixirAnalyzer.ExerciseTest do
     check_source_tests = Enum.map(check_source_data, &CheckSourceCompiler.compile(&1, source))
 
     quote do
-      @spec analyze(Submission.t(), Source.t()) :: Submission.t()
-      def analyze(%Submission{} = submission, %Source{code_string: code_string} = source) do
+      @spec analyze(Submission.t()) :: Submission.t()
+      def analyze(%Submission{source: %Source{code_string: code_string} = source} = submission) do
         case Code.string_to_quoted(code_string) do
           {:ok, code_ast} ->
             source = %{source | code_ast: code_ast}
-            do_analyze(submission, source)
+            submission = %{submission | source: source}
+            do_analyze(submission)
 
           {:error, e} ->
             append_analysis_failure(submission, e)
         end
       end
 
-      defp do_analyze(%Submission{} = submission, %Source{code_ast: code_ast} = source) do
+      defp do_analyze(%Submission{source: %Source{code_ast: code_ast} = source} = submission) do
         results =
           Enum.concat([
             unquote(feature_tests),

lib/elixir_analyzer/exercise_test/assert_call/compiler.ex

@@ -150,10 +150,9 @@ defmodule ElixirAnalyzer.ExerciseTest.AssertCall.Compiler do
   """
   @spec matching_function_call?(
           Macro.t(),
-          nil | AssertCall.function_signature(),
+          AssertCall.function_signature(),
           %{[atom] => [atom] | keyword()}
         ) :: boolean()
-  def matching_function_call?(_node, nil, _), do: false
 
   # For erlang libraries: :math._ or :math.pow
   def matching_function_call?(
@@ -209,22 +208,6 @@ defmodule ElixirAnalyzer.ExerciseTest.AssertCall.Compiler do
 
   def matching_function_call?(_, _, _), do: false
 
-  @doc """
-  compare a node to the function_signature, looking for a match for a called function
-  """
-  @spec matching_function_def?(Macro.t(), AssertCall.function_signature()) :: boolean()
-  def matching_function_def?(_node, nil), do: false
-
-  def matching_function_def?(
-        {def_type, _, [{name, _, _args}, [do: {:__block__, _, [_ | _]}]]},
-        {_module_path, name}
-      )
-      when def_type in ~w[def defp]a do
-    true
-  end
-
-  def matching_function_def?(_, _), do: false
-
   @doc """
   node is a module definition
   """
@@ -237,13 +220,10 @@ defmodule ElixirAnalyzer.ExerciseTest.AssertCall.Compiler do
   def extract_module_name({:defmodule, _, [{:__aliases__, _, name}, [do: _]]}),
     do: name
 
-  def extract_module_name(_), do: nil
-
   @doc """
   node is a function definition
   """
-  def function_def?({def_type, _, [{name, _, _}, [do: _]]})
-      when is_atom(name) and def_type in ~w[def defp]a do
+  def function_def?({def_type, _, [_, [do: _]]}) when def_type in ~w[def defp]a do
     true
   end
 
@@ -260,8 +240,6 @@ defmodule ElixirAnalyzer.ExerciseTest.AssertCall.Compiler do
       when is_atom(name) and def_type in ~w[def defp]a,
       do: name
 
-  def extract_function_name(_), do: nil
-
   @doc """
   compare the name of the function to the function signature, if they match return true
   """

lib/elixir_analyzer/exercise_test/common_checks/function_capture.ex

@@ -54,13 +54,13 @@ defmodule ElixirAnalyzer.ExerciseTest.CommonChecks.FunctionCapture do
     depth = depth - 1
 
     functions =
-      if depth == 0 and wrong_use? and actual_function?(name) and name not in @exceptions do
+      if depth <= 0 and wrong_use? and actual_function?(name) and name not in @exceptions do
         [{:&, name, length(args)} | functions]
       else
         functions
       end
 
-    {node, %{capture_depth: depth - 1, functions: functions}}
+    {node, %{capture_depth: depth, functions: functions}}
   end
 
   # fn -> foo end

lib/elixir_analyzer/exercise_test/feature.ex

@@ -53,10 +53,16 @@ defmodule ElixirAnalyzer.ExerciseTest.Feature do
     feature_data = %{feature_data | meta: Map.to_list(feature_data.meta)}
     feature_data = Map.to_list(feature_data)
 
+    unless Keyword.has_key?(feature_data, :comment) do
+      raise "Comment must be defined for each feature test"
+    end
+
     quote do
       # Check if the feature is unique
-      case Enum.filter(@feature_tests, fn {_data, forms} ->
-             forms == unquote(Macro.escape(feature_forms))
+      case Enum.filter(@feature_tests, fn {data, forms} ->
+             {Keyword.get(data, :find), Keyword.get(data, :depth), forms} ==
+               {Keyword.get(unquote(feature_data), :find),
+                Keyword.get(unquote(feature_data), :depth), unquote(Macro.escape(feature_forms))}
            end) do
         [{data, _forms} | _] ->
           raise FeatureError,

lib/elixir_analyzer/quote_util.ex

@@ -68,15 +68,6 @@ defmodule ElixirAnalyzer.QuoteUtil do
     end)
   end
 
-  @doc """
-  Performs a depth-first, pre-order traversal of quoted expressions.
-  With depth provided to a function
-  """
-  @spec prewalk(Macro.t(), (Macro.t(), non_neg_integer -> Macro.t())) :: Macro.t()
-  def prewalk(ast, fun) when is_function(fun, 2) do
-    elem(prewalk(ast, nil, fn x, nil, d -> {fun.(x, d), nil} end), 0)
-  end
-
   @doc """
   Performs a depth-first, pre-order traversal of quoted expressions
   using an accumulator.
@@ -86,22 +77,4 @@ defmodule ElixirAnalyzer.QuoteUtil do
   def prewalk(ast, acc, fun) when is_function(fun, 3) do
     traverse_with_depth(ast, acc, fun, fn x, a, _d -> {x, a} end)
   end
-
-  @doc """
-  Performs a depth-first, post-order traversal of quoted expressions.
-  """
-  @spec postwalk(Macro.t(), (Macro.t(), non_neg_integer -> Macro.t())) :: Macro.t()
-  def postwalk(ast, fun) when is_function(fun, 2) do
-    elem(postwalk(ast, nil, fn x, nil, d -> {fun.(x, d), nil} end), 0)
-  end
-
-  @doc """
-  Performs a depth-first, post-order traversal of quoted expressions
-  using an accumulator.
-  """
-  @spec postwalk(Macro.t(), any, (Macro.t(), any, non_neg_integer -> {Macro.t(), any})) ::
-          {Macro.t(), any}
-  def postwalk(ast, acc, fun) when is_function(fun, 3) do
-    traverse_with_depth(ast, acc, fn x, a, _d -> {x, a} end, fun)
-  end
 end