0.7.4 release Version.first() && Version.last()

izelnakri · Apr 9, 2017 · eb51f4f · eb51f4f
1 parent 9852dc3
commit eb51f4f
Show file tree

Hide file tree

Showing 14 changed files with 200 additions and 35 deletions.
diff --git a/README.md b/README.md
@@ -82,9 +82,10 @@ PaperTrail is assailed with hundreds of test assertions for each release. Data i
   #     item_id: 1, item_type: "Post", originator_id: nil, originator: nil, meta: nil}}}
 
   Repo.aggregate(Post, :count, :id) # => 0
-  Repo.aggregate(PaperTrail.Version, :count, :id) # => 3
+  PaperTrail.Version.count() # => 3
+  # same as Repo.aggregate(PaperTrail.Version, :count, :id)
 
-  last(PaperTrail.Version, :id) |> Repo.one
+  PaperTrail.Version.last() # returns the last version in the db by inserted_at
   #  %PaperTrail.Version{__meta__: #Ecto.Schema.Metadata<:loaded, "versions">,
   #   event: "delete", id: 3, inserted_at: #Ecto.DateTime<2016-09-15 22:22:12>,
   #   item_changes: %{"title" => "Elixir matures fast", content: "Future is already here, Elixir is the next step!", "id" => 1,
@@ -351,9 +352,10 @@ Bang functions assume the operation will always be successful, otherwise functio
   #   item_id: 1, item_type: "Post", originator_id: nil, originator: nil, meta: nil}
 
   Repo.aggregate(Post, :count, :id) # => 0
-  Repo.aggregate(PaperTrail.Version, :count, :id) # => 3
+  PaperTrail.Version.count() # => 3
+  # same as Repo.aggregate(PaperTrail.Version, :count, :id)
 
-  last(PaperTrail.Version, :id) |> Repo.one
+  PaperTrail.Version.last() # returns the last version in the db by inserted_at
   #  %PaperTrail.Version{__meta__: #Ecto.Schema.Metadata<:loaded, "versions">,
   #   event: "delete", id: 3, inserted_at: #Ecto.DateTime<2016-09-15 22:22:12>,
   #   item_changes: %{"title" => "Elixir matures fast", content: "Future is already here, Elixir is the next step!", "id" => 1,

diff --git a/doc/.build b/doc/.build
@@ -4,7 +4,7 @@ fonts/icomoon.eot
 fonts/icomoon.svg
 fonts/icomoon.ttf
 fonts/icomoon.woff
-dist/sidebar_items-7c98857fb6.js
+dist/sidebar_items-295d4039c8.js
 api-reference.html
 index.html
 404.html

diff --git a/doc/404.html b/doc/404.html
@@ -5,12 +5,12 @@
     <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.7.3</title>
+    <title>404 – paper_trail v0.7.4</title>
     <link rel="stylesheet" href="dist/app-a07cea761b.css" />
 
       <link rel="canonical" href="https://hexdocs.pm/paper_trail/404.html" />
 
-    <script src="dist/sidebar_items-7c98857fb6.js"></script>
+    <script src="dist/sidebar_items-295d4039c8.js"></script>
   </head>
   <body data-type="extras">
     <script>if(localStorage.getItem('night-mode')) document.body.className += ' night-mode';</script>
@@ -28,7 +28,7 @@ <h1 class="sidebar-projectName">
         paper_trail
       </h1>
       <h2 class="sidebar-projectVersion">
-        v0.7.3
+        v0.7.4
       </h2>
     </div>
 

diff --git a/doc/Mix.Tasks.Papertrail.Install.html b/doc/Mix.Tasks.Papertrail.Install.html
@@ -5,12 +5,12 @@
     <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.7.3</title>
+    <title>Mix.Tasks.Papertrail.Install – paper_trail v0.7.4</title>
     <link rel="stylesheet" href="dist/app-a07cea761b.css" />
 
       <link rel="canonical" href="https://hexdocs.pm/paper_trail/Mix.Tasks.Papertrail.Install.html" />
 
-    <script src="dist/sidebar_items-7c98857fb6.js"></script>
+    <script src="dist/sidebar_items-295d4039c8.js"></script>
   </head>
   <body data-type="modules">
     <script>if(localStorage.getItem('night-mode')) document.body.className += ' night-mode';</script>
@@ -28,7 +28,7 @@ <h1 class="sidebar-projectName">
         paper_trail
       </h1>
       <h2 class="sidebar-projectVersion">
-        v0.7.3
+        v0.7.4
       </h2>
     </div>
 
@@ -60,7 +60,7 @@ <h2 class="sidebar-projectVersion">
 
 
       <h1>
-        <small class="visible-xs">paper_trail v0.7.3</small>
+        <small class="visible-xs">paper_trail v0.7.4</small>
         Mix.Tasks.Papertrail.Install
 
 

diff --git a/doc/PaperTrail.RepoClient.html b/doc/PaperTrail.RepoClient.html
@@ -5,12 +5,12 @@
     <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.7.3</title>
+    <title>PaperTrail.RepoClient – paper_trail v0.7.4</title>
     <link rel="stylesheet" href="dist/app-a07cea761b.css" />
 
       <link rel="canonical" href="https://hexdocs.pm/paper_trail/PaperTrail.RepoClient.html" />
 
-    <script src="dist/sidebar_items-7c98857fb6.js"></script>
+    <script src="dist/sidebar_items-295d4039c8.js"></script>
   </head>
   <body data-type="modules">
     <script>if(localStorage.getItem('night-mode')) document.body.className += ' night-mode';</script>
@@ -28,7 +28,7 @@ <h1 class="sidebar-projectName">
         paper_trail
       </h1>
       <h2 class="sidebar-projectVersion">
-        v0.7.3
+        v0.7.4
       </h2>
     </div>
 
@@ -60,7 +60,7 @@ <h2 class="sidebar-projectVersion">
 
 
       <h1>
-        <small class="visible-xs">paper_trail v0.7.3</small>
+        <small class="visible-xs">paper_trail v0.7.4</small>
         PaperTrail.RepoClient
 
 

diff --git a/doc/PaperTrail.Version.html b/doc/PaperTrail.Version.html
@@ -5,12 +5,12 @@
     <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.7.3</title>
+    <title>PaperTrail.Version – paper_trail v0.7.4</title>
     <link rel="stylesheet" href="dist/app-a07cea761b.css" />
 
       <link rel="canonical" href="https://hexdocs.pm/paper_trail/PaperTrail.Version.html" />
 
-    <script src="dist/sidebar_items-7c98857fb6.js"></script>
+    <script src="dist/sidebar_items-295d4039c8.js"></script>
   </head>
   <body data-type="modules">
     <script>if(localStorage.getItem('night-mode')) document.body.className += ' night-mode';</script>
@@ -28,7 +28,7 @@ <h1 class="sidebar-projectName">
         paper_trail
       </h1>
       <h2 class="sidebar-projectVersion">
-        v0.7.3
+        v0.7.4
       </h2>
     </div>
 
@@ -60,7 +60,7 @@ <h2 class="sidebar-projectVersion">
 
 
       <h1>
-        <small class="visible-xs">paper_trail v0.7.3</small>
+        <small class="visible-xs">paper_trail v0.7.4</small>
         PaperTrail.Version
 
 
@@ -94,6 +94,27 @@ <h2>
     <a href="#count/0">count()</a>
   </div>
 
+    <div class="summary-synopsis"><p>Returns the count of all version records in the database</p>
+</div>
+
+</div>
+<div class="summary-row">
+  <div class="summary-signature">
+    <a href="#first/0">first()</a>
+  </div>
+
+    <div class="summary-synopsis"><p>Returns the first version record in the database by :inserted_at</p>
+</div>
+
+</div>
+<div class="summary-row">
+  <div class="summary-signature">
+    <a href="#last/0">last()</a>
+  </div>
+
+    <div class="summary-synopsis"><p>Returns the last version record in the database by :inserted_at</p>
+</div>
+
 </div>
 
   </div>
@@ -145,7 +166,40 @@ <h1 class="section-heading">
 
   </div>
   <section class="docstring">
+    <p>Returns the count of all version records in the database</p>
+
+  </section>
+</div>
+<div class="detail" id="first/0">
+
+  <div class="detail-header">
+    <a href="#first/0" class="detail-link" title="Link to this function">
+      <i class="icon-link"></i>
+    </a>
+    <span class="signature">first()</span>
+
+
+
+  </div>
+  <section class="docstring">
+    <p>Returns the first version record in the database by :inserted_at</p>
+
+  </section>
+</div>
+<div class="detail" id="last/0">
+
+  <div class="detail-header">
+    <a href="#last/0" class="detail-link" title="Link to this function">
+      <i class="icon-link"></i>
+    </a>
+    <span class="signature">last()</span>
 
+
+
+  </div>
+  <section class="docstring">
+    <p>Returns the last version record in the database by :inserted_at</p>
+
   </section>
 </div>
 

diff --git a/doc/PaperTrail.VersionQueries.html b/doc/PaperTrail.VersionQueries.html
@@ -5,12 +5,12 @@
     <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.7.3</title>
+    <title>PaperTrail.VersionQueries – paper_trail v0.7.4</title>
     <link rel="stylesheet" href="dist/app-a07cea761b.css" />
 
       <link rel="canonical" href="https://hexdocs.pm/paper_trail/PaperTrail.VersionQueries.html" />
 
-    <script src="dist/sidebar_items-7c98857fb6.js"></script>
+    <script src="dist/sidebar_items-295d4039c8.js"></script>
   </head>
   <body data-type="modules">
     <script>if(localStorage.getItem('night-mode')) document.body.className += ' night-mode';</script>
@@ -28,7 +28,7 @@ <h1 class="sidebar-projectName">
         paper_trail
       </h1>
       <h2 class="sidebar-projectVersion">
-        v0.7.3
+        v0.7.4
       </h2>
     </div>
 
@@ -60,7 +60,7 @@ <h2 class="sidebar-projectVersion">
 
 
       <h1>
-        <small class="visible-xs">paper_trail v0.7.3</small>
+        <small class="visible-xs">paper_trail v0.7.4</small>
         PaperTrail.VersionQueries
 
 

diff --git a/doc/PaperTrail.html b/doc/PaperTrail.html
@@ -5,12 +5,12 @@
     <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.7.3</title>
+    <title>PaperTrail – paper_trail v0.7.4</title>
     <link rel="stylesheet" href="dist/app-a07cea761b.css" />
 
       <link rel="canonical" href="https://hexdocs.pm/paper_trail/PaperTrail.html" />
 
-    <script src="dist/sidebar_items-7c98857fb6.js"></script>
+    <script src="dist/sidebar_items-295d4039c8.js"></script>
   </head>
   <body data-type="modules">
     <script>if(localStorage.getItem('night-mode')) document.body.className += ' night-mode';</script>
@@ -28,7 +28,7 @@ <h1 class="sidebar-projectName">
         paper_trail
       </h1>
       <h2 class="sidebar-projectVersion">
-        v0.7.3
+        v0.7.4
       </h2>
     </div>
 
@@ -60,7 +60,7 @@ <h2 class="sidebar-projectVersion">
 
 
       <h1>
-        <small class="visible-xs">paper_trail v0.7.3</small>
+        <small class="visible-xs">paper_trail v0.7.4</small>
         PaperTrail
 
 

diff --git a/doc/api-reference.html b/doc/api-reference.html
@@ -5,12 +5,12 @@
     <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.7.3</title>
+    <title>API Reference – paper_trail v0.7.4</title>
     <link rel="stylesheet" href="dist/app-a07cea761b.css" />
 
       <link rel="canonical" href="https://hexdocs.pm/paper_trail/api-reference.html" />
 
-    <script src="dist/sidebar_items-7c98857fb6.js"></script>
+    <script src="dist/sidebar_items-295d4039c8.js"></script>
   </head>
   <body data-type="extras">
     <script>if(localStorage.getItem('night-mode')) document.body.className += ' night-mode';</script>
@@ -28,7 +28,7 @@ <h1 class="sidebar-projectName">
         paper_trail
       </h1>
       <h2 class="sidebar-projectVersion">
-        v0.7.3
+        v0.7.4
       </h2>
     </div>
 
@@ -60,7 +60,7 @@ <h2 class="sidebar-projectVersion">
 
 
 <h1>
-  <small class="visible-xs">paper_trail v0.7.3</small>
+  <small class="visible-xs">paper_trail v0.7.4</small>
   API Reference
 </h1>
 

diff --git a/doc/dist/sidebar_items-7c98857fb6.js → doc/dist/sidebar_items-295d4039c8.js b/doc/dist/sidebar_items-7c98857fb6.js → doc/dist/sidebar_items-295d4039c8.js
diff --git a/doc/index.html b/doc/index.html
@@ -2,7 +2,7 @@
 <html>
   <head>
     <meta charset="utf-8">
-    <title>paper_trail v0.7.3 – Documentation</title>
+    <title>paper_trail v0.7.4 – 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">

diff --git a/lib/version.ex b/lib/version.ex
@@ -28,7 +28,26 @@ defmodule PaperTrail.Version do
     |> validate_required([:event, :item_type, :item_id, :item_changes])
   end
 
+  @doc """
+  Returns the count of all version records in the database
+  """
   def count do
     from(version in __MODULE__, select: count(version.id)) |> PaperTrail.RepoClient.repo.one
   end
+
+  @doc """
+  Returns the first version record in the database by :inserted_at
+  """
+  def first do
+    from(record in __MODULE__, limit: 1, order_by: [asc: :inserted_at])
+    |> PaperTrail.RepoClient.repo.one
+  end
+
+  @doc """
+  Returns the last version record in the database by :inserted_at
+  """
+  def last do
+    from(record in __MODULE__, limit: 1, order_by: [desc: :inserted_at])
+    |> PaperTrail.RepoClient.repo.one
+  end
 end
diff --git a/mix.exs b/mix.exs
@@ -4,7 +4,7 @@ defmodule PaperTrail.Mixfile do
   def project do
     [
       app: :paper_trail,
-      version: "0.7.3",
+      version: "0.7.4",
       elixir: "~> 1.4",
       description: description(),
       build_embedded: Mix.env == :prod,