PR to track downstream changes in a fork

.formatter.exs

@@ -0,0 +1,5 @@
+# Used by "mix format"
+[
+  line_length: 110,
+  inputs: ["mix.exs", "{config,lib,test}/**/*.{ex,exs}"]
+]

.gitignore

@@ -34,6 +34,7 @@ GitHub.sublime-settings
 .tags_sorted_by_file
 .vagrant
 .DS_Store
+.elixir_ls
 
 # Ignore released binaries
 .deliver

config/.credo.exs

@@ -8,7 +8,7 @@
       checks: [
         {Credo.Check.Design.TagTODO, exit_status: 0},
         {Credo.Check.Readability.MaxLineLength, priority: :low, max_length: 120},
-        {Credo.Check.Readability.Specs, exit_status: 0},
+        {Credo.Check.Readability.Specs, exit_status: 0}
       ]
     }
   ]

config/dogma.exs

@@ -4,10 +4,10 @@ alias Dogma.Rule
 config :dogma,
   rule_set: Dogma.RuleSet.All,
   exclude: [
-    ~r(\Adeps/),
+    ~r(\Adeps/)
   ],
   override: [
-    %Rule.LineLength{ max_length: 120 },
-    %Rule.InfixOperatorPadding{ enabled: false },
-    %Rule.FunctionArity{ max: 5 },
+    %Rule.LineLength{max_length: 120},
+    %Rule.InfixOperatorPadding{enabled: false},
+    %Rule.FunctionArity{max: 5}
   ]

lib/ecto_trail/changelog.ex

@@ -4,13 +4,12 @@ defmodule EctoTrail.Changelog do
   """
   use Ecto.Schema
 
-  @primary_key {:id, :binary_id, autogenerate: true}
   schema Application.fetch_env!(:ecto_trail, :table_name) do
-    field :actor_id, :string
-    field :resource, :string
-    field :resource_id, :string
-    field :changeset, :map
+    field(:actor_id, :string)
+    field(:resource, :string)
+    field(:resource_id, :string)
+    field(:changeset, :map)
 
-    timestamps([type: :utc_datetime, updated_at: false])
+    timestamps(type: :utc_datetime, updated_at: false)
   end
 end

lib/ecto_trail/ecto_trail.ex

@@ -56,10 +56,11 @@ defmodule EctoTrail do
 
       Insert arguments, return and options same as `c:Ecto.Repo.insert/2` has.
       """
-      @spec insert_and_log(struct_or_changeset :: Ecto.Schema.t | Ecto.Changeset.t,
-                           actor_id :: String.T,
-                           opts :: Keyword.t) ::
-            {:ok, Ecto.Schema.t} | {:error, Ecto.Changeset.t}
+      @spec insert_and_log(
+              struct_or_changeset :: Ecto.Schema.t() | Ecto.Changeset.t(),
+              actor_id :: String.T,
+              opts :: Keyword.t()
+            ) :: {:ok, Ecto.Schema.t()} | {:error, Ecto.Changeset.t()}
       def insert_and_log(struct_or_changeset, actor_id, opts \\ []),
         do: EctoTrail.insert_and_log(__MODULE__, struct_or_changeset, actor_id, opts)
 
@@ -68,13 +69,28 @@ defmodule EctoTrail do
 
       Insert arguments, return and options same as `c:Ecto.Repo.update/2` has.
       """
-      @spec update_and_log(changeset :: Ecto.Changeset.t,
-                           actor_id :: String.T,
-                           opts :: Keyword.t) ::
-            {:ok, Ecto.Schema.t} |
-            {:error, Ecto.Changeset.t}
+      @spec update_and_log(
+              changeset :: Ecto.Changeset.t(),
+              actor_id :: String.T,
+              opts :: Keyword.t()
+            ) ::
+              {:ok, Ecto.Schema.t()}
+              | {:error, Ecto.Changeset.t()}
       def update_and_log(changeset, actor_id, opts \\ []),
         do: EctoTrail.update_and_log(__MODULE__, changeset, actor_id, opts)
+
+      @doc """
+      Call `c:Ecto.Repo.delete/2` operation and store deleted objext in a `change_log` table.
+      """
+      @spec delete_and_log(
+              struct_or_changeset :: Ecto.Schema.t() | Ecto.Changeset.t(),
+              actor_id :: String.T,
+              opts :: Keyword.t()
+            ) ::
+              {:ok, Ecto.Schema.t()}
+              | {:error, Ecto.Changeset.t()}
+      def delete_and_log(struct_or_changeset, actor_id, opts \\ []),
+        do: EctoTrail.delete_and_log(__MODULE__, struct_or_changeset, actor_id, opts)
     end
   end
 
@@ -83,47 +99,68 @@ defmodule EctoTrail do
 
   Insert arguments, return and options same as `c:Ecto.Repo.insert/2` has.
   """
-  @spec insert_and_log(repo :: Ecto.Repo.t,
-                       struct_or_changeset :: Ecto.Schema.t | Ecto.Changeset.t,
-                       actor_id :: String.T,
-                       opts :: Keyword.t) ::
-        {:ok, Ecto.Schema.t} | {:error, Ecto.Changeset.t}
+  @spec insert_and_log(
+          repo :: Ecto.Repo.t(),
+          struct_or_changeset :: Ecto.Schema.t() | Ecto.Changeset.t(),
+          actor_id :: String.T,
+          opts :: Keyword.t()
+        ) :: {:ok, Ecto.Schema.t()} | {:error, Ecto.Changeset.t()}
   def insert_and_log(repo, struct_or_changeset, actor_id, opts \\ []) do
-    Multi.new
+    Multi.new()
     |> Multi.insert(:operation, struct_or_changeset, opts)
-    |> run_logging_transaction(repo, struct_or_changeset, actor_id)
+    |> run_logging_transaction(repo, struct_or_changeset, actor_id, 1)
   end
 
   @doc """
   Call `c:Ecto.Repo.update/2` operation and store changes in a `change_log` table.
 
   Insert arguments, return and options same as `c:Ecto.Repo.update/2` has.
   """
-  @spec update_and_log(repo :: Ecto.Repo.t,
-                       changeset :: Ecto.Changeset.t,
-                       actor_id :: String.T,
-                       opts :: Keyword.t) ::
-        {:ok, Ecto.Schema.t} |
-        {:error, Ecto.Changeset.t}
+  @spec update_and_log(
+          repo :: Ecto.Repo.t(),
+          changeset :: Ecto.Changeset.t(),
+          actor_id :: String.T,
+          opts :: Keyword.t()
+        ) ::
+          {:ok, Ecto.Schema.t()}
+          | {:error, Ecto.Changeset.t()}
   def update_and_log(repo, changeset, actor_id, opts \\ []) do
-    Multi.new
+    Multi.new()
     |> Multi.update(:operation, changeset, opts)
-    |> run_logging_transaction(repo, changeset, actor_id)
+    |> run_logging_transaction(repo, changeset, actor_id, 2)
+  end
+
+  @doc """
+   Call `c:Ecto.Repo.delete/2` operation and store deleted objext in a `change_log` table.
+  """
+  @spec delete_and_log(
+          repo :: Ecto.Repo.t(),
+          struct_or_changeset :: Ecto.Schema.t() | Ecto.Changeset.t(),
+          actor_id :: String.T,
+          opts :: Keyword.t()
+        ) ::
+          {:ok, Ecto.Schema.t()}
+          | {:error, Ecto.Changeset.t()}
+  def delete_and_log(repo, struct_or_changeset, actor_id, opts \\ []) do
+    Multi.new()
+    |> Multi.delete(:operation, struct_or_changeset, opts)
+    |> run_logging_transaction(repo, struct_or_changeset, actor_id, 3)
   end
 
-  defp run_logging_transaction(multi, repo, struct_or_changeset, actor_id) do
+  defp run_logging_transaction(multi, repo, struct_or_changeset, actor_id, operation_type) do
     multi
-    |> Multi.run(:changelog, &log_changes(repo, &1, struct_or_changeset, actor_id))
+    |> Multi.run(:changelog, &log_changes(repo, &1, struct_or_changeset, actor_id, operation_type))
     |> repo.transaction()
     |> build_result()
   end
 
   defp build_result({:ok, %{operation: operation}}),
     do: {:ok, operation}
+
   defp build_result({:error, :operation, reason, _changes_so_far}),
     do: {:error, reason}
 
-  defp log_changes(repo, multi_acc, struct_or_changeset, actor_id) do
+  defp log_changes(repo, multi_acc, struct_or_changeset, actor_id, operation_type) do
     %{operation: operation} = multi_acc
     associations = operation.__struct__.__schema__(:associations)
     resource = operation.__struct__.__schema__(:source)
@@ -134,6 +171,7 @@ defmodule EctoTrail do
       |> get_changes()
       |> get_embed_changes(embeds)
       |> get_assoc_changes(associations)
+      |> validate_changes(struct_or_changeset, operation_type)
 
     result =
       %{
@@ -148,25 +186,68 @@ defmodule EctoTrail do
     case result do
       {:ok, changelog} ->
         {:ok, changelog}
+
       {:error, reason} ->
-        Logger.error("Failed to store changes in audit log: #{inspect struct_or_changeset} " <>
-                     "by actor #{inspect actor_id}. Reason: #{inspect reason}")
+        Logger.error(
+          "Failed to store changes in audit log: #{inspect(struct_or_changeset)} " <>
+            "by actor #{inspect(actor_id)}. Reason: #{inspect(reason)}"
+        )
+
         {:ok, reason}
     end
   end
 
+  defp validate_changes(changes, schema, operation_type) do
+    case operation_type do
+      1 ->
+        # this case is entered when the operation type it's an insert operation
+        changes
+
+      2 ->
+        # this case is entered when the operation type it's an update operation
+        changes
+
+      3 ->
+        # this case is entered when the operation type it's a delete operation
+        {_, regreso} =
+          Map.from_struct(schema)
+          |> Map.pop(:__meta__)
+
+        IO.inspect(regreso)
+        remove_empty_assosiations(regreso)
+    end
+  end
+
+  defp remove_empty_assosiations(struct) do
+    Enum.map(struct, fn {key, value} ->
+      {key,
+       if String.contains?(Kernel.inspect(value), "Ecto.Association.NotLoaded") do
+         nil
+       else
+         value
+       end}
+    end)
+    |> Map.new()
+  end
+
   defp get_changes(%Changeset{changes: changes}),
     do: map_custom_ecto_types(changes)
+
   defp get_changes(changes) when is_map(changes),
     do: changes |> Changeset.change(%{}) |> get_changes()
+
   defp get_changes(changes) when is_list(changes),
-    do: changes |> Enum.map_reduce([], fn(ch, acc) -> {nil, List.insert_at(acc, -1, get_changes(ch))} end) |> elem(1)
+    do:
+      changes
+      |> Enum.map_reduce([], fn ch, acc -> {nil, List.insert_at(acc, -1, get_changes(ch))} end)
+      |> elem(1)
 
   defp get_embed_changes(changeset, embeds) do
     Enum.reduce(embeds, changeset, fn embed, changeset ->
       case Map.get(changeset, embed) do
         nil ->
           changeset
+
         embed_changes ->
           Map.put(changeset, embed, get_changes(embed_changes))
       end
@@ -178,6 +259,7 @@ defmodule EctoTrail do
       case Map.get(changeset, assoc) do
         nil ->
           changeset
+
         assoc_changes ->
           Map.put(changeset, assoc, get_changes(assoc_changes))
       end
@@ -204,7 +286,7 @@ defmodule EctoTrail do
       :actor_id,
       :resource,
       :resource_id,
-      :changeset,
+      :changeset
     ])
   end
 end

mix.exs

@@ -4,19 +4,21 @@ defmodule EctoTrail.Mixfile do
   @version "0.2.4"
 
   def project do
-    [app: :ecto_trail,
-     description: description(),
-     package: package(),
-     version: @version,
-     elixir: "~> 1.4",
-     elixirc_paths: elixirc_paths(Mix.env),
-     compilers: [] ++ Mix.compilers,
-     build_embedded: Mix.env == :prod,
-     start_permanent: Mix.env == :prod,
-     deps: deps(),
-     test_coverage: [tool: ExCoveralls],
-     preferred_cli_env: [coveralls: :test],
-     docs: [source_ref: "v#\{@version\}", main: "readme", extras: ["README.md"]]]
+    [
+      app: :ecto_trail,
+      description: description(),
+      package: package(),
+      version: @version,
+      elixir: "~> 1.4",
+      elixirc_paths: elixirc_paths(Mix.env()),
+      compilers: [] ++ Mix.compilers(),
+      build_embedded: Mix.env() == :prod,
+      start_permanent: Mix.env() == :prod,
+      deps: deps(),
+      test_coverage: [tool: ExCoveralls],
+      preferred_cli_env: [coveralls: :test],
+      docs: [source_ref: "v#\{@version\}", main: "readme", extras: ["README.md"]]
+    ]
   end
 
   def description do
@@ -28,24 +30,28 @@ defmodule EctoTrail.Mixfile do
   end
 
   defp elixirc_paths(:test), do: ["lib", "test/support"]
-  defp elixirc_paths(_),     do: ["lib"]
+  defp elixirc_paths(_), do: ["lib"]
 
   defp deps do
-    [{:ecto, "~> 2.1"},
-     {:postgrex, "~> 0.13.2", optional: true},
-     {:dialyxir, "~> 0.5", only: [:dev, :test], runtime: false},
-     {:geo, "~> 1.4", only: [:dev, :test]},
-     {:ex_doc, ">= 0.15.0", only: [:dev, :test]},
-     {:excoveralls, ">= 0.5.0", only: [:dev, :test]},
-     {:dogma, ">= 0.1.12", only: [:dev, :test]},
-     {:credo, ">= 0.5.1", only: [:dev, :test]}]
+    [
+      {:ecto_sql, "~> 3.0"},
+      {:postgrex, ">= 0.14.0"},
+      {:dialyxir, "~> 0.5", only: [:dev, :test], runtime: false},
+      {:geo, "~> 3.0.0", only: [:dev, :test]},
+      {:ex_doc, ">= 0.15.0", only: [:dev, :test]},
+      {:excoveralls, ">= 0.5.0", only: [:dev, :test]},
+      {:dogma, ">= 0.1.12", only: [:dev, :test]},
+      {:credo, ">= 0.5.1", only: [:dev, :test]}
+    ]
   end
 
   defp package do
-    [contributors: ["Nebo #15"],
-     maintainers: ["Nebo #15"],
-     licenses: ["LISENSE.md"],
-     links: %{github: "https://github.com/Nebo15/ecto_trail"},
-     files: ~w(lib LICENSE.md mix.exs README.md)]
+    [
+      contributors: ["Nebo #15"],
+      maintainers: ["Nebo #15"],
+      licenses: ["LISENSE.md"],
+      links: %{github: "https://github.com/Nebo15/ecto_trail"},
+      files: ~w(lib LICENSE.md mix.exs README.md)
+    ]
   end
 end