Merge pull request #12 from izelnakri/custom-originator-params

Custom originator params
izelnakri · Mar 16, 2017 · 92d9714 · 92d9714
2 parents 2c08bce + 21fdd16
commit 92d9714
Show file tree

Hide file tree

Showing 16 changed files with 118 additions and 59 deletions.
diff --git a/README.md b/README.md
@@ -103,7 +103,7 @@ The library source code is minimal and well tested. It is suggested to read the
 
   ```elixir
     def deps do
-      [{:paper_trail, "~> 0.6.0"}]
+      [{:paper_trail, "~> 0.7.0"}]
     end
   ```
 
@@ -116,7 +116,7 @@ The library source code is minimal and well tested. It is suggested to read the
 
   3. install and compile your dependency:
 
-  ```mix deps.get && mix deps.compile```
+  ```mix deps.get && mix compile```
 
   4. run this command to generate the migration:
 
@@ -160,22 +160,26 @@ PaperTrail.insert(new_user_changeset, origin: "facebook_registration")
 ```
 
 ### Originator relationships
-You can specify setter/originator relationship to paper_trail versions with ```originator_id``` assignment. This feature is only possible by specifying `:originator` keyword list for your application configuration:
+You can specify setter/originator relationship to paper_trail versions with ```originator``` assignment. This feature is only possible by specifying `:originator` keyword list for your application configuration:
 
 ```elixir
   # in your config/config.exs
   config :paper_trail, originator: [name: :user, model: YourApp.User]
   # For most applications originator should be the user since models can be updated/created/deleted by several users.
 ```
 
-Then originator name could be used for querying and preloading however originator setting must be done via originator_id:
+Then originator name could be used for querying and preloading. Originator setting must be done via ```:originator``` or originator name that is defined in the paper_trail configuration:
 
 ```elixir
 user = create_user()
-PaperTrail.insert(changeset, originator_id: user.id)
-{:ok, result} = PaperTrail.update(edit_changeset, originator_id: user.id)
+# all these set originator_id's for the version records
+PaperTrail.insert(changeset, originator: user)
+{:ok, result} = PaperTrail.update(edit_changeset, originator: user)
+# or you can use :user in the params instead of :originator if this is your config:
+# paper_trail originator: [name: :user, model: YourApplication.User]
+{:ok, result} = PaperTrail.update(edit_changeset, user: user)
 result[:version] |> Repo.preload(:user) |> Map.get(:user) # we can access the user who made the change from the version thanks to originator relationships!
-PaperTrail.delete(edit_changeset, originator_id: user.id)
+PaperTrail.delete(edit_changeset, user: user)
 ```
 
 Also make sure you have the foreign-key constraint in the database and in your version migration file.
@@ -263,7 +267,7 @@ edited_company = Company.changeset(company, %{name: "Acme Inc."}) |> PaperTrail.
 Additionally, you can put a null constraint on ```origin``` column, you should always put an ```origin``` reference to describe who makes the change. This is important for big applications because a model can change from many sources.
 
 ### Storing version meta data
-You might want to add some meta data that doesn't belong to ``originator_id`` and ``origin`` fields. Such data could be stored in one object named ```meta``` in paper_trail versions. Meta field could be passed as the second optional parameter to PaperTrail.insert/2, PaperTrail.update/2, PaperTrail.delete/2 functions:
+You might want to add some meta data that doesn't belong to ``originator`` and ``origin`` fields. Such data could be stored in one object named ```meta``` in paper_trail versions. Meta field could be passed as the second optional parameter to PaperTrail.insert/2, PaperTrail.update/2, PaperTrail.delete/2 functions:
 
 ```elixir
 company = Company.changeset(%Company{}, %{name: "Acme Inc."})
@@ -274,7 +278,7 @@ edited_company = Company.changeset(company, %{name: "Acme LLC"})
 # or even with an originator:
 user = create_user()
 deleted_company = Company.changeset(edited_company, %{})
-  |> PaperTrail.delete(origin: "worker:github", originator: user.id, meta: %{slug: "acme-llc", important: true})
+  |> PaperTrail.delete(origin: "worker:github", originator: user, meta: %{slug: "acme-llc", important: true})
 ```
 
 ## Suggestions

diff --git a/config/test.exs b/config/test.exs
@@ -2,7 +2,7 @@ use Mix.Config
 
 config :paper_trail, ecto_repos: [PaperTrail.Repo]
 
-config :paper_trail, repo: PaperTrail.Repo
+config :paper_trail, repo: PaperTrail.Repo, originator: [name: :user, model: User]
 
 config :paper_trail, PaperTrail.Repo,
   adapter: Ecto.Adapters.Postgres,

diff --git a/doc/404.html b/doc/404.html
@@ -5,7 +5,7 @@
     <meta http-equiv="x-ua-compatible" content="ie=edge">
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
     <meta name="generator" content="ExDoc v0.14.5">
-    <title>404 – paper_trail v0.6.3</title>
+    <title>404 – paper_trail v0.7.0</title>
     <link rel="stylesheet" href="dist/app-a07cea761b.css" />
 
       <link rel="canonical" href="https://hexdocs.pm/paper_trail/404.html" />
@@ -28,7 +28,7 @@ <h1 class="sidebar-projectName">
         paper_trail
       </h1>
       <h2 class="sidebar-projectVersion">
-        v0.6.3
+        v0.7.0
       </h2>
     </div>
 

diff --git a/doc/Mix.Tasks.Papertrail.Install.html b/doc/Mix.Tasks.Papertrail.Install.html
@@ -5,7 +5,7 @@
     <meta http-equiv="x-ua-compatible" content="ie=edge">
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
     <meta name="generator" content="ExDoc v0.14.5">
-    <title>Mix.Tasks.Papertrail.Install – paper_trail v0.6.3</title>
+    <title>Mix.Tasks.Papertrail.Install – paper_trail v0.7.0</title>
     <link rel="stylesheet" href="dist/app-a07cea761b.css" />
 
       <link rel="canonical" href="https://hexdocs.pm/paper_trail/Mix.Tasks.Papertrail.Install.html" />
@@ -28,7 +28,7 @@ <h1 class="sidebar-projectName">
         paper_trail
       </h1>
       <h2 class="sidebar-projectVersion">
-        v0.6.3
+        v0.7.0
       </h2>
     </div>
 
@@ -60,7 +60,7 @@ <h2 class="sidebar-projectVersion">
 
 
       <h1>
-        <small class="visible-xs">paper_trail v0.6.3</small>
+        <small class="visible-xs">paper_trail v0.7.0</small>
         Mix.Tasks.Papertrail.Install
 
 

diff --git a/doc/PaperTrail.Migration.html b/doc/PaperTrail.Migration.html
@@ -5,7 +5,7 @@
     <meta http-equiv="x-ua-compatible" content="ie=edge">
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
     <meta name="generator" content="ExDoc v0.14.5">
-    <title>PaperTrail.Migration – paper_trail v0.6.3</title>
+    <title>PaperTrail.Migration – paper_trail v0.7.0</title>
     <link rel="stylesheet" href="dist/app-a07cea761b.css" />
 
       <link rel="canonical" href="https://hexdocs.pm/paper_trail/PaperTrail.Migration.html" />
@@ -28,7 +28,7 @@ <h1 class="sidebar-projectName">
         paper_trail
       </h1>
       <h2 class="sidebar-projectVersion">
-        v0.6.3
+        v0.7.0
       </h2>
     </div>
 
@@ -60,7 +60,7 @@ <h2 class="sidebar-projectVersion">
 
 
       <h1>
-        <small class="visible-xs">paper_trail v0.6.3</small>
+        <small class="visible-xs">paper_trail v0.7.0</small>
         PaperTrail.Migration
 
 

diff --git a/doc/PaperTrail.RepoClient.html b/doc/PaperTrail.RepoClient.html
@@ -5,7 +5,7 @@
     <meta http-equiv="x-ua-compatible" content="ie=edge">
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
     <meta name="generator" content="ExDoc v0.14.5">
-    <title>PaperTrail.RepoClient – paper_trail v0.6.3</title>
+    <title>PaperTrail.RepoClient – paper_trail v0.7.0</title>
     <link rel="stylesheet" href="dist/app-a07cea761b.css" />
 
       <link rel="canonical" href="https://hexdocs.pm/paper_trail/PaperTrail.RepoClient.html" />
@@ -28,7 +28,7 @@ <h1 class="sidebar-projectName">
         paper_trail
       </h1>
       <h2 class="sidebar-projectVersion">
-        v0.6.3
+        v0.7.0
       </h2>
     </div>
 
@@ -60,7 +60,7 @@ <h2 class="sidebar-projectVersion">
 
 
       <h1>
-        <small class="visible-xs">paper_trail v0.6.3</small>
+        <small class="visible-xs">paper_trail v0.7.0</small>
         PaperTrail.RepoClient
 
 

diff --git a/doc/PaperTrail.Version.html b/doc/PaperTrail.Version.html
@@ -5,7 +5,7 @@
     <meta http-equiv="x-ua-compatible" content="ie=edge">
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
     <meta name="generator" content="ExDoc v0.14.5">
-    <title>PaperTrail.Version – paper_trail v0.6.3</title>
+    <title>PaperTrail.Version – paper_trail v0.7.0</title>
     <link rel="stylesheet" href="dist/app-a07cea761b.css" />
 
       <link rel="canonical" href="https://hexdocs.pm/paper_trail/PaperTrail.Version.html" />
@@ -28,7 +28,7 @@ <h1 class="sidebar-projectName">
         paper_trail
       </h1>
       <h2 class="sidebar-projectVersion">
-        v0.6.3
+        v0.7.0
       </h2>
     </div>
 
@@ -60,7 +60,7 @@ <h2 class="sidebar-projectVersion">
 
 
       <h1>
-        <small class="visible-xs">paper_trail v0.6.3</small>
+        <small class="visible-xs">paper_trail v0.7.0</small>
         PaperTrail.Version
 
 

diff --git a/doc/PaperTrail.VersionQueries.html b/doc/PaperTrail.VersionQueries.html
@@ -5,7 +5,7 @@
     <meta http-equiv="x-ua-compatible" content="ie=edge">
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
     <meta name="generator" content="ExDoc v0.14.5">
-    <title>PaperTrail.VersionQueries – paper_trail v0.6.3</title>
+    <title>PaperTrail.VersionQueries – paper_trail v0.7.0</title>
     <link rel="stylesheet" href="dist/app-a07cea761b.css" />
 
       <link rel="canonical" href="https://hexdocs.pm/paper_trail/PaperTrail.VersionQueries.html" />
@@ -28,7 +28,7 @@ <h1 class="sidebar-projectName">
         paper_trail
       </h1>
       <h2 class="sidebar-projectVersion">
-        v0.6.3
+        v0.7.0
       </h2>
     </div>
 
@@ -60,7 +60,7 @@ <h2 class="sidebar-projectVersion">
 
 
       <h1>
-        <small class="visible-xs">paper_trail v0.6.3</small>
+        <small class="visible-xs">paper_trail v0.7.0</small>
         PaperTrail.VersionQueries
 
 

diff --git a/doc/PaperTrail.html b/doc/PaperTrail.html
@@ -5,7 +5,7 @@
     <meta http-equiv="x-ua-compatible" content="ie=edge">
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
     <meta name="generator" content="ExDoc v0.14.5">
-    <title>PaperTrail – paper_trail v0.6.3</title>
+    <title>PaperTrail – paper_trail v0.7.0</title>
     <link rel="stylesheet" href="dist/app-a07cea761b.css" />
 
       <link rel="canonical" href="https://hexdocs.pm/paper_trail/PaperTrail.html" />
@@ -28,7 +28,7 @@ <h1 class="sidebar-projectName">
         paper_trail
       </h1>
       <h2 class="sidebar-projectVersion">
-        v0.6.3
+        v0.7.0
       </h2>
     </div>
 
@@ -60,7 +60,7 @@ <h2 class="sidebar-projectVersion">
 
 
       <h1>
-        <small class="visible-xs">paper_trail v0.6.3</small>
+        <small class="visible-xs">paper_trail v0.7.0</small>
         PaperTrail
 
 
@@ -85,7 +85,7 @@ <h2>
     </h2>
     <div class="summary-row">
   <div class="summary-signature">
-    <a href="#delete/2">delete(struct, options \\ [origin: nil, meta: nil, originator_id: nil])</a>
+    <a href="#delete/2">delete(struct, options \\ [origin: nil, meta: nil, originator: nil])</a>
   </div>
 
     <div class="summary-synopsis"><p>Deletes a record from the database with a related version insertion in one transaction</p>
@@ -139,7 +139,7 @@ <h2>
 </div>
 <div class="summary-row">
   <div class="summary-signature">
-    <a href="#insert/2">insert(changeset, options \\ [origin: nil, meta: nil, originator_id: nil])</a>
+    <a href="#insert/2">insert(changeset, options \\ [origin: nil, meta: nil, originator: nil])</a>
   </div>
 
     <div class="summary-synopsis"><p>Inserts a record to the database with a related version insertion in one transaction</p>
@@ -148,7 +148,7 @@ <h2>
 </div>
 <div class="summary-row">
   <div class="summary-signature">
-    <a href="#update/2">update(changeset, options \\ [origin: nil, meta: nil, originator_id: nil])</a>
+    <a href="#update/2">update(changeset, options \\ [origin: nil, meta: nil, originator: nil])</a>
   </div>
 
     <div class="summary-synopsis"><p>Updates a record from the database with a related version insertion in one transaction</p>
@@ -184,7 +184,7 @@ <h1 class="section-heading">
     <a href="#delete/2" class="detail-link" title="Link to this function">
       <i class="icon-link"></i>
     </a>
-    <span class="signature">delete(struct, options \\ [origin: nil, meta: nil, originator_id: nil])</span>
+    <span class="signature">delete(struct, options \\ [origin: nil, meta: nil, originator: nil])</span>
 
 
 
@@ -282,7 +282,7 @@ <h1 class="section-heading">
     <a href="#insert/2" class="detail-link" title="Link to this function">
       <i class="icon-link"></i>
     </a>
-    <span class="signature">insert(changeset, options \\ [origin: nil, meta: nil, originator_id: nil])</span>
+    <span class="signature">insert(changeset, options \\ [origin: nil, meta: nil, originator: nil])</span>
 
 
 
@@ -300,7 +300,7 @@ <h1 class="section-heading">
     <a href="#update/2" class="detail-link" title="Link to this function">
       <i class="icon-link"></i>
     </a>
-    <span class="signature">update(changeset, options \\ [origin: nil, meta: nil, originator_id: nil])</span>
+    <span class="signature">update(changeset, options \\ [origin: nil, meta: nil, originator: nil])</span>
 
 
 

diff --git a/doc/api-reference.html b/doc/api-reference.html
@@ -5,7 +5,7 @@
     <meta http-equiv="x-ua-compatible" content="ie=edge">
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
     <meta name="generator" content="ExDoc v0.14.5">
-    <title>API Reference – paper_trail v0.6.3</title>
+    <title>API Reference – paper_trail v0.7.0</title>
     <link rel="stylesheet" href="dist/app-a07cea761b.css" />
 
       <link rel="canonical" href="https://hexdocs.pm/paper_trail/api-reference.html" />
@@ -28,7 +28,7 @@ <h1 class="sidebar-projectName">
         paper_trail
       </h1>
       <h2 class="sidebar-projectVersion">
-        v0.6.3
+        v0.7.0
       </h2>
     </div>
 
@@ -60,7 +60,7 @@ <h2 class="sidebar-projectVersion">
 
 
 <h1>
-  <small class="visible-xs">paper_trail v0.6.3</small>
+  <small class="visible-xs">paper_trail v0.7.0</small>
   API Reference
 </h1>
 

diff --git a/doc/index.html b/doc/index.html
@@ -2,7 +2,7 @@
 <html>
   <head>
     <meta charset="utf-8">
-    <title>paper_trail v0.6.3 – Documentation</title>
+    <title>paper_trail v0.7.0 – Documentation</title>
     <meta http-equiv="refresh" content="0; url=api-reference.html">
     <meta name="robots" content="noindex">
     <meta name="generator" content="ExDoc v0.14.5">