Allow Inspect.Algebra.to_doc/2 Options To Be Overriden (#5)

* [WORK-289] Inspect.Algebra.to_doc/1 Options Can Be Overriden

* [WORK-289] Pull Request Suggestions Added

- Default `structs` value now is `false`
- Pattern matching used by the test compares with expected struct.
- Removed branch statement.

Author: Legrandk

lib/snapshy.ex

@@ -179,11 +179,7 @@ defmodule Snapshy do
 
   defp serialize(value) do
     value
-    |> Inspect.Algebra.to_doc(%Inspect.Opts{
-      limit: :infinity,
-      printable_limit: :infinity,
-      pretty: true
-    })
+    |> Inspect.Algebra.to_doc(inspect_options())
     |> Inspect.Algebra.group()
     |> Inspect.Algebra.format(80)
     |> Enum.join()
@@ -195,6 +191,22 @@ defmodule Snapshy do
     term
   end
 
+  defp inspect_options do
+    opts = default_inspect_options()
+      |> Keyword.merge(Application.get_env(:snapshy, :serialize_inspect_options, []))
+
+    struct(Inspect.Opts, opts)
+  end
+
+  defp default_inspect_options do
+    [
+      limit: :infinity,
+      printable_limit: :infinity,
+      pretty: true,
+      structs: false
+    ]
+  end
+
   #############################################################################
   #  Filename calculation                                                     #
   #############################################################################

test/unit/snapshy_test.exs

@@ -24,6 +24,59 @@ defmodule SnapshyTest do
     match_snapshot(%Struct{key: "different_value"})
   end
 
+  test "saved file can be evaluated for opaque structs when serialize structs option is false (default)", %{test: test_name} do
+    snap_filename = snap_file_for_test(test_name)
+
+    assert File.exists?(snap_filename) == false
+
+    original_serialized_inspect_options = Application.get_env(:snapshy, :serialize_inspect_options, [])
+
+    opaque_struct = %Struct{key: Version.parse!("1.2.3")}
+
+    match_snapshot(opaque_struct)
+
+    assert {:ok, serialized_value} = File.read(snap_filename)
+
+    assert {^opaque_struct, []} = Code.eval_string(serialized_value, [], __ENV__)
+
+    assert File.rm(snap_filename)
+
+    Application.put_env(:snapshy, :serialize_inspect_options, original_serialized_inspect_options)
+  end
+
+  test "saved file cannot be evaluated for opaque structs when serialize structs option is true", %{test: test_name} do
+    snap_filename = snap_file_for_test(test_name)
+
+    assert File.exists?(snap_filename) == false
+
+    original_serialized_inspect_options = Application.get_env(:snapshy, :serialize_inspect_options, [])
+
+    Application.put_env(:snapshy, :serialize_inspect_options, [structs: true])
+
+    opaque_struct = %Struct{key: Version.parse!("1.2.3")}
+
+    match_snapshot(opaque_struct)
+
+    assert {:ok, serialized_value} = File.read(snap_filename)
+
+    assert_raise TokenMissingError, fn ->
+      assert {^opaque_struct, []} = Code.eval_string(serialized_value, [], __ENV__)
+    end
+
+    assert File.rm(snap_filename)
+
+    Application.put_env(:snapshy, :serialize_inspect_options, original_serialized_inspect_options)
+  end
+
+  defp snap_file_for_test(test_name) do
+    [
+      "test/__snapshots__/unit/snapshy_test/",
+      Atom.to_string(test_name) |> String.replace(" ", "_"),
+      ".snap"
+    ]
+    |> Enum.join()
+  end
+
   describe "test_snapshot" do
     setup do
       [key: :value]