Introduce mix format

What does this commit/MR/PR do ?

- Introduce mix format

Why is this commit/MR/PR needed ?

- Linted/standardised code

Author: stephenmoloney

.formatter.exs

@@ -0,0 +1,6 @@
+[
+  inputs: [
+    "{lib,config,test}/**/*.{ex,exs}",
+    "*.{ex,exs}"
+  ]
+]

config/config.exs

@@ -1,6 +1,5 @@
 use Mix.Config
 
-if Mix.env == :test do
-  config :scrivener_list, Scrivener.Repo,
-    adapter: Ecto.Adapters.Postgres
-end
+if Mix.env() == :test do
+  config :scrivener_list, Scrivener.Repo, adapter: Ecto.Adapters.Postgres
+end

lib/scrivener/paginater/list.ex

@@ -3,46 +3,43 @@ defimpl Scrivener.Paginater, for: List do
   alias Scrivener.Config
   alias Scrivener.Page
 
-
   @doc ~s"""
   Implementation of `Scrivener.Paginater` protocol to extend the `Scrivener.Paginater.paginate/2` function.
   """
-  @spec paginate(any, map | Keyword.t) :: Scrivener.Page.t
+  @spec paginate(any, map | Keyword.t()) :: Scrivener.Page.t()
   def paginate(entries, %Config{page_number: page_number, page_size: page_size}) do
-      total_entries = length(entries)
-
-      %Page{
-        page_size: page_size,
-        page_number: page_number,
-        entries: entries(entries, page_number, page_size),
-        total_entries: total_entries,
-        total_pages: total_pages(total_entries, page_size)
-      }
+    total_entries = length(entries)
+
+    %Page{
+      page_size: page_size,
+      page_number: page_number,
+      entries: entries(entries, page_number, page_size),
+      total_entries: total_entries,
+      total_pages: total_pages(total_entries, page_size)
+    }
   end
 
-
   defp entries(entries, page_number, page_size) do
     offset = page_size * (page_number - 1)
     Enum.slice(entries, offset, page_size)
   end
 
-
   defp total_pages(total_entries, page_size) do
     ceiling(total_entries / page_size)
   end
 
-
   defp ceiling(float) do
     t = trunc(float)
 
     case float - t do
       neg when neg < 0 ->
         t
+
       pos when pos > 0 ->
         t + 1
-      _ -> t
+
+      _ ->
+        t
     end
   end
-
-
 end

mix.exs

@@ -7,43 +7,39 @@ defmodule Scrivener.List.Mixfile do
 
   def project do
     [
-     app: :scrivener_list,
-     name: @name,
-     version: @version,
-     source_url: @source_url,
-     homepage_url: @homepage_url,
-     elixir: "~> 1.3",
-     build_embedded: Mix.env == :prod,
-     start_permanent: Mix.env == :prod,
-     description: description(),
-     package: package(),
-     deps: deps(),
-     docs: docs()
+      app: :scrivener_list,
+      name: @name,
+      version: @version,
+      source_url: @source_url,
+      homepage_url: @homepage_url,
+      elixir: "~> 1.3",
+      build_embedded: Mix.env() == :prod,
+      start_permanent: Mix.env() == :prod,
+      description: description(),
+      package: package(),
+      deps: deps(),
+      docs: docs()
     ]
   end
 
-
   def application do
     [applications: [:logger, :scrivener_ecto]]
   end
 
-
   defp deps() do
     [
-     {:scrivener_ecto, "~> 1.0 or ~> 2.0"},
-     {:earmark, "~> 1.3", only: :dev},
-     {:ex_doc, "~> 0.19", only: :dev}
+      {:scrivener_ecto, "~> 1.0 or ~> 2.0"},
+      {:earmark, "~> 1.3", only: :dev},
+      {:ex_doc, "~> 0.19", only: :dev}
     ]
   end
 
-
   defp description() do
     ~S"""
     A scrivener/scrivener_ecto compatible extension that allows pagination of a list.
     """
   end
 
-
   defp package() do
     [
       maintainers: ["Stephen Moloney"],
@@ -59,13 +55,11 @@ defmodule Scrivener.List.Mixfile do
 
   defp docs do
     [
-     main: "README.md",
-     extra_section: "GUIDE",
-     extras: [
-              "README.md": [path: "README.md", title: "GUIDE"]
-             ]
+      main: "README.md",
+      extra_section: "GUIDE",
+      extras: [
+        "README.md": [path: "README.md", title: "GUIDE"]
+      ]
     ]
   end
-
-
 end

test/scrivener_list_test.exs

@@ -1,11 +1,26 @@
 defmodule Scrivener.ListTest do
   use Scrivener.List.TestCase
-  @languages ["C#", "C++", "Clojure", "Elixir", "Erlang", "Go", "JAVA", "JavaScript", "Lisp",
-              "PHP", "Perl", "Python", "Ruby", "Rust", "SQL"]
+
+  @languages [
+    "C#",
+    "C++",
+    "Clojure",
+    "Elixir",
+    "Erlang",
+    "Go",
+    "JAVA",
+    "JavaScript",
+    "Lisp",
+    "PHP",
+    "Perl",
+    "Python",
+    "Ruby",
+    "Rust",
+    "SQL"
+  ]
   @total_entries length(@languages)
   @config %Scrivener.Config{page_number: 2, page_size: 4}
 
-
   describe "paginate when using a repo module" do
     test "can paginate a list using a Repo module  - 1" do
       page = Scrivener.Repo.paginate(@languages)
@@ -14,7 +29,7 @@ defmodule Scrivener.ListTest do
       assert page.page_number == 1
       assert page.entries == ["C#", "C++", "Clojure", "Elixir", "Erlang"]
       assert page.total_entries == @total_entries
-      assert page.total_pages == Float.ceil(length(@languages)/5)
+      assert page.total_pages == Float.ceil(length(@languages) / 5)
     end
 
     test "can paginate a list using a Repo module - 2" do
@@ -25,7 +40,7 @@ defmodule Scrivener.ListTest do
       assert page.page_size == 5
       assert page.entries == ["C#", "C++", "Clojure"]
       assert page.total_entries == 3
-      assert page.total_pages == Float.ceil(length(languages)/5)
+      assert page.total_pages == Float.ceil(length(languages) / 5)
     end
 
     test "can paginate a list when provided the current page and page size as a params map" do
@@ -35,7 +50,7 @@ defmodule Scrivener.ListTest do
       assert page.page_number == 2
       assert page.entries == ["Elixir", "Erlang", "Go"]
       assert page.total_entries == @total_entries
-      assert page.total_pages == Float.ceil(length(@languages)/3)
+      assert page.total_pages == Float.ceil(length(@languages) / 3)
     end
 
     test "can paginate a list when only provided with the page size as a keyword list
@@ -45,7 +60,7 @@ defmodule Scrivener.ListTest do
       assert page.page_size == 3
       assert page.page_number == 1
       assert page.entries == ["C#", "C++", "Clojure"]
-      assert page.total_pages == Float.ceil(length(@languages)/3)
+      assert page.total_pages == Float.ceil(length(@languages) / 3)
       assert page.total_entries == @total_entries
     end
 
@@ -56,23 +71,23 @@ defmodule Scrivener.ListTest do
       assert page.page_size == 5
       assert page.page_number == 2
       assert page.entries == ["Go", "JAVA", "JavaScript", "Lisp", "PHP"]
-      assert page.total_pages == Float.ceil(length(@languages)/5)
+      assert page.total_pages == Float.ceil(length(@languages) / 5)
       assert page.total_entries == @total_entries
     end
 
     test "can respect a max_page_size configuration" do
       page = Scrivener.Repo.paginate(@languages, page: 2, page_size: 200)
 
       assert page.page_size < 200
-      assert page.page_size == 10 # this is the max_page_size set in the Repo `use` statement.
+      # this is the max_page_size set in the Repo `use` statement.
+      assert page.page_size == 10
       assert page.page_number == 2
-      assert page.entries ==  ["Perl", "Python", "Ruby", "Rust", "SQL"]
-      assert page.total_pages == Float.ceil(length(@languages)/10)
+      assert page.entries == ["Perl", "Python", "Ruby", "Rust", "SQL"]
+      assert page.total_pages == Float.ceil(length(@languages) / 10)
       assert page.total_entries == @total_entries
     end
   end
 
-
   describe "paginate without using a repo module" do
     test "can paginate a list when passed a Scrivener.Config. t directly - 1" do
       page = Scrivener.paginate(@languages, @config)
@@ -81,7 +96,7 @@ defmodule Scrivener.ListTest do
       assert page.page_size == 4
       assert page.entries == ["Erlang", "Go", "JAVA", "JavaScript"]
       assert page.total_entries == @total_entries
-      assert page.total_pages == Float.ceil(length(@languages)/4)
+      assert page.total_pages == Float.ceil(length(@languages) / 4)
     end
 
     test "can paginate a list when passed a Scrivener.Config. t directly - 2" do
@@ -92,7 +107,7 @@ defmodule Scrivener.ListTest do
       assert page.page_size == 4
       assert page.entries == []
       assert page.total_entries == 3
-      assert page.total_pages == Float.ceil(length(languages)/4)
+      assert page.total_pages == Float.ceil(length(languages) / 4)
     end
 
     test "can paginate a list when provided the current page and page size as a params map" do
@@ -102,7 +117,7 @@ defmodule Scrivener.ListTest do
       assert page.page_number == 2
       assert page.entries == ["Elixir", "Erlang", "Go"]
       assert page.total_entries == @total_entries
-      assert page.total_pages == Float.ceil(length(@languages)/3)
+      assert page.total_pages == Float.ceil(length(@languages) / 3)
     end
 
     test "can paginate a list when provided the current page and page size as a keyword list" do
@@ -111,7 +126,7 @@ defmodule Scrivener.ListTest do
       assert page.page_size == 3
       assert page.page_number == 2
       assert page.entries == ["Elixir", "Erlang", "Go"]
-      assert page.total_pages == Float.ceil(length(@languages)/3)
+      assert page.total_pages == Float.ceil(length(@languages) / 3)
       assert page.total_entries == @total_entries
     end
 
@@ -122,7 +137,7 @@ defmodule Scrivener.ListTest do
       assert page.page_size == 3
       assert page.page_number == 1
       assert page.entries == ["C#", "C++", "Clojure"]
-      assert page.total_pages == Float.ceil(length(@languages)/3)
+      assert page.total_pages == Float.ceil(length(@languages) / 3)
       assert page.total_entries == @total_entries
     end
 
@@ -132,8 +147,8 @@ defmodule Scrivener.ListTest do
 
       assert page.page_size == 10
       assert page.page_number == 2
-      assert page.entries == [ "Perl", "Python", "Ruby", "Rust", "SQL"]
-      assert page.total_pages == Float.ceil(length(@languages)/10)
+      assert page.entries == ["Perl", "Python", "Ruby", "Rust", "SQL"]
+      assert page.total_pages == Float.ceil(length(@languages) / 10)
       assert page.total_entries == @total_entries
     end
 
@@ -143,7 +158,7 @@ defmodule Scrivener.ListTest do
       assert page.page_size == 10
       assert page.page_number == 2
       assert page.entries == ["Perl", "Python", "Ruby", "Rust", "SQL"]
-      assert page.total_pages == Float.ceil(length(@languages)/10)
+      assert page.total_pages == Float.ceil(length(@languages) / 10)
       assert page.total_entries == @total_entries
     end
 
@@ -153,10 +168,8 @@ defmodule Scrivener.ListTest do
       refute page.page_size < 200
       assert page.page_number == 2
       assert page.entries == []
-      assert page.total_pages == Float.ceil(length(@languages)/200)
+      assert page.total_pages == Float.ceil(length(@languages) / 200)
       assert page.total_entries == @total_entries
     end
   end
-
-
 end