Rename App & Add Application

Author: maennchen

.gitignore

@@ -20,7 +20,7 @@ erl_crash.dump
 *.ez
 
 # Ignore package tarball (built via "mix hex.build").
-quantum_storage_ets-*.tar
+quantum_storage_persistent_ets-*.tar
 
 # Ignore mix.lock
 /mix.lock

README.md

@@ -1,30 +1,30 @@
-# Quantum Storage Ets
+# Quantum Storage Persistent Ets
 
-[![Hex.pm Version](http://img.shields.io/hexpm/v/quantum_storage_ets.svg)](https://hex.pm/packages/quantum_storage_ets)
-[![Hex docs](http://img.shields.io/badge/hex.pm-docs-green.svg?style=flat)](https://hexdocs.pm/quantum_storage_ets)
-[![Build Status](https://travis-ci.org/quantum-elixir/quantum-storage-ets.svg?branch=master)](https://travis-ci.org/quantum-elixir/quantum-storage-ets)
-[![Coverage Status](https://coveralls.io/repos/quantum-elixir/quantum-storage-ets/badge.svg?branch=master)](https://coveralls.io/r/quantum-elixir/quantum-storage-ets?branch=master)
-[![Inline docs](http://inch-ci.org/github/quantum-elixir/quantum-storage-ets.svg)](http://inch-ci.org/github/quantum-elixir/quantum-storage-ets)
-[![Hex.pm](https://img.shields.io/hexpm/dt/quantum_storage_ets.svg)](https://hex.pm/packages/quantum_storage_ets)
+[![Hex.pm Version](http://img.shields.io/hexpm/v/quantum_storage_persistent_ets.svg)](https://hex.pm/packages/quantum_storage_persistent_ets)
+[![Hex docs](http://img.shields.io/badge/hex.pm-docs-green.svg?style=flat)](https://hexdocs.pm/quantum_storage_persistent_ets)
+[![Build Status](https://travis-ci.org/quantum-elixir/quantum-storage-persistent-ets.svg?branch=master)](https://travis-ci.org/quantum-elixir/quantum-storage-persistent-ets)
+[![Coverage Status](https://coveralls.io/repos/quantum-elixir/quantum-storage-persistent-ets/badge.svg?branch=master)](https://coveralls.io/r/quantum-elixir/quantum-storage-persistent-ets?branch=master)
+[![Inline docs](http://inch-ci.org/github/quantum-elixir/quantum-storage-persistent-ets.svg)](http://inch-ci.org/github/quantum-elixir/quantum-storage-persistent-ets)
+[![Hex.pm](https://img.shields.io/hexpm/dt/quantum_storage_persistent_ets.svg)](https://hex.pm/packages/quantum_storage_persistent_ets)
 
 Adds a persistent storage adapter for ETS.
 
 ## Installation
 
-The package can be installed by adding `quantum_storage_ets` to your list
+The package can be installed by adding `quantum_storage_persistent_ets` to your list
 of dependencies in `mix.exs`:
 
 ```elixir
 def deps do
   [
-    {:quantum_storage_ets, "~> 0.1.0"}
+    {:quantum_storage_persistent_ets, "~> 0.1.0"}
   ]
 end
 ```
 
 Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
 and published on [HexDocs](https://hexdocs.pm). The docs can be found at
-[https://hexdocs.pm/quantum_storage_ets](https://hexdocs.pm/quantum_storage_ets).
+[https://hexdocs.pm/quantum_storage_persistent_ets](https://hexdocs.pm/quantum_storage_persistent_ets).
 
 ## Contribution
 
@@ -36,14 +36,14 @@ terms of this contract."
 
 ### tl;dr
 
-1. Check for [open issues](https://github.com/quantum-elixir/quantum-storage-ets/issues) or [open a new issue](https://github.com/quantum-elixir/quantum-storage-ets/issues/new) to start
+1. Check for [open issues](https://github.com/quantum-elixir/quantum-storage-persistent-ets/issues) or [open a new issue](https://github.com/quantum-elixir/quantum-storage-persistent-ets/issues/new) to start
 a discussion around [a problem](https://www.youtube.com/watch?v=_QF9sFJGJuc).
 2. Issues SHALL be named as "Problem: _description of the problem_".
-3. Fork the [quantum-storage-ets repository on GitHub](https://github.com/quantum-elixir/quantum-storage-ets) to start making your changes
+3. Fork the [quantum-storage-persistent-ets repository on GitHub](https://github.com/quantum-elixir/quantum-storage-persistent-ets) to start making your changes
 4. If possible, write a test which shows that the problem was solved.
 5. Send a pull request.
 6. Pull requests SHALL be named as "Solution: _description of your solution_"
-7. Your pull request is merged and you are added to the [list of contributors](https://github.com/quantum-elixir/quantum-storage-ets/graphs/contributors)
+7. Your pull request is merged and you are added to the [list of contributors](https://github.com/quantum-elixir/quantum-storage-persistent-ets/graphs/contributors)
 
 ## License
 

lib/quantum_storage_ets.ex

@@ -1,4 +1,4 @@
-defmodule QuantumStorageEts do
+defmodule QuantumStoragePersistentEts do
   @moduledoc """
   `PersistentEts` based implementation of a `Quantum.Storage`.
   """
@@ -13,43 +13,54 @@ defmodule QuantumStorageEts do
 
   @behaviour Quantum.Storage
 
+  @doc false
   def start_link(opts),
     do: GenServer.start_link(__MODULE__, opts, name: Keyword.get(opts, :name, @server))
 
+  @doc false
   @impl GenServer
   def init(opts), do: {:ok, %State{schedulers: %{}, name: Keyword.get(opts, :name, @server)}}
 
+  @doc false
   @impl Quantum.Storage
   def jobs(server \\ @server, scheduler_module),
     do: GenServer.call(server, {:jobs, scheduler_module})
 
+  @doc false
   @impl Quantum.Storage
   def add_job(server \\ @server, scheduler_module, job),
     do: GenServer.call(server, {:add_job, scheduler_module, job})
 
+  @doc false
   @impl Quantum.Storage
   def delete_job(server \\ @server, scheduler_module, job_name),
     do: GenServer.call(server, {:delete_job, scheduler_module, job_name})
 
+  @doc false
   @impl Quantum.Storage
   def update_job_state(server \\ @server, scheduler_module, job_name, state),
     do: GenServer.call(server, {:update_job_state, scheduler_module, job_name, state})
 
+  @doc false
   @impl Quantum.Storage
   def last_execution_date(server \\ @server, scheduler_module),
     do: GenServer.call(server, {:last_execution_date, scheduler_module})
 
+  @doc false
   @impl Quantum.Storage
   def update_last_execution_date(server \\ @server, scheduler_module, last_execution_date),
     do:
       GenServer.call(server, {:update_last_execution_date, scheduler_module, last_execution_date})
 
+  @doc false
   @impl Quantum.Storage
   def purge(server \\ @server, scheduler_module),
     do: GenServer.call(server, {:purge, scheduler_module})
 
+  @doc false
   def purge_all(server \\ @server), do: GenServer.call(server, :purge_all)
 
+  @doc false
   @impl GenServer
   def handle_call(
         {:add_job, scheduler_module, job},
@@ -203,7 +214,11 @@ defmodule QuantumStorageEts do
     if ets_exist?(scheduler_module_atom) do
       scheduler_module_atom
     else
-      path = Application.app_dir(:quantum_storage_ets, "priv/tables/#{scheduler_module_atom}.tab")
+      path =
+        Application.app_dir(
+          :quantum_storage_persistent_ets,
+          "priv/tables/#{scheduler_module_atom}.tab"
+        )
 
       File.mkdir_p!(Path.dirname(path))
 

lib/quantum_storage_ets/application.ex

@@ -0,0 +1,12 @@
+defmodule QuantumStoragePersistentEts.Application do
+  @moduledoc false
+
+  use Application
+
+  def start(_type, _args),
+    do:
+      Supervisor.start_link([QuantumStoragePersistentEts],
+        strategy: :one_for_one,
+        name: QuantumTest.Supervisor
+      )
+end

lib/quantum_storage_ets/state.ex

@@ -1,8 +1,8 @@
-defmodule QuantumStorageEts.State do
+defmodule QuantumStoragePersistentEts.State do
   @moduledoc false
 
   @type t :: %__MODULE__{schedulers: map}
 
   @enforce_keys [:schedulers, :name]
-  defstruct schedulers: %{}, name: QuantumStorageEts
+  defstruct schedulers: %{}, name: QuantumStoragePersistentEts
 end

mix.exs

@@ -1,4 +1,4 @@
-defmodule QuantumStorageEts.MixProject do
+defmodule QuantumStoragePersistentEts.MixProject do
   @moduledoc false
 
   use Mix.Project
@@ -7,14 +7,14 @@ defmodule QuantumStorageEts.MixProject do
 
   def project do
     [
-      app: :quantum_storage_ets,
+      app: :quantum_storage_persistent_ets,
       version: @version,
       elixir: "~> 1.6",
       build_embedded: Mix.env() == :prod,
       start_permanent: Mix.env() == :prod,
       deps: deps(),
       docs: docs(),
-      name: "Quantum Storage ETS",
+      name: "Quantum Storage Persistent ETS",
       elixirc_paths: elixirc_paths(Mix.env()),
       package: package(),
       test_coverage: [tool: ExCoveralls]
@@ -24,7 +24,8 @@ defmodule QuantumStorageEts.MixProject do
   # Run "mix help compile.app" to learn about applications.
   def application do
     [
-      extra_applications: [:logger]
+      extra_applications: [:logger],
+      mod: {QuantumStoragePersistentEts.Application, []}
     ]
   end
 
@@ -39,8 +40,8 @@ defmodule QuantumStorageEts.MixProject do
       licenses: ["Apache License 2.0"],
       links: %{
         "Changelog" =>
-          "https://github.com/quantum-elixir/quantum-storage-ets/blob/master/CHANGELOG.md",
-        "GitHub" => "https://github.com/quantum-elixir/quantum-storage-ets"
+          "https://github.com/quantum-elixir/quantum-storage-persistent-ets/blob/master/CHANGELOG.md",
+        "GitHub" => "https://github.com/quantum-elixir/quantum-storage-persistent-ets"
       }
     }
   end
@@ -49,7 +50,7 @@ defmodule QuantumStorageEts.MixProject do
     [
       main: "readme",
       source_ref: "v#{@version}",
-      source_url: "https://github.com/quantum-elixir/quantum-storage-ets",
+      source_url: "https://github.com/quantum-elixir/quantum-storage-persistent-ets",
       extras: [
         "README.md",
         "CHANGELOG.md"

test/quantum_storage_ets_test.exs

@@ -1,108 +1,109 @@
-defmodule QuantumStorageEtsTest do
+defmodule QuantumStoragePersistentEtsTest do
   @moduledoc false
 
   use ExUnit.Case
-  doctest QuantumStorageEts
+  doctest QuantumStoragePersistentEts
 
   defmodule Scheduler do
-    use Quantum, otp_app: :quantum_storage_ets
+    use Quantum, otp_app: :quantum_storage_persistent_ets
   end
 
   setup %{test: test} do
-    storage = start_supervised!({QuantumStorageEts, name: Module.concat(__MODULE__, test)})
+    storage =
+      start_supervised!({QuantumStoragePersistentEts, name: Module.concat(__MODULE__, test)})
 
-    assert :ok = QuantumStorageEts.purge(storage, A)
-    assert :ok = QuantumStorageEts.purge(storage, B)
+    assert :ok = QuantumStoragePersistentEts.purge(storage, A)
+    assert :ok = QuantumStoragePersistentEts.purge(storage, B)
 
     {:ok, storage: storage}
   end
 
   describe "purge/1" do
     test "purges correct module", %{storage: storage} do
-      assert :ok = QuantumStorageEts.add_job(storage, A, Scheduler.new_job())
-      assert :ok = QuantumStorageEts.purge(storage, A)
-      assert [] = QuantumStorageEts.jobs(storage, A)
+      assert :ok = QuantumStoragePersistentEts.add_job(storage, A, Scheduler.new_job())
+      assert :ok = QuantumStoragePersistentEts.purge(storage, A)
+      assert [] = QuantumStoragePersistentEts.jobs(storage, A)
     end
 
     test "does not purge incorrect module", %{storage: storage} do
       job = Scheduler.new_job()
-      assert :ok = QuantumStorageEts.add_job(storage, A, job)
-      assert :ok = QuantumStorageEts.purge(storage, B)
-      assert [^job] = QuantumStorageEts.jobs(storage, A)
+      assert :ok = QuantumStoragePersistentEts.add_job(storage, A, job)
+      assert :ok = QuantumStoragePersistentEts.purge(storage, B)
+      assert [^job] = QuantumStoragePersistentEts.jobs(storage, A)
     end
   end
 
   describe "add_job/2" do
     test "adds job", %{storage: storage} do
       job = Scheduler.new_job()
-      assert :ok = QuantumStorageEts.add_job(storage, A, job)
-      assert [^job] = QuantumStorageEts.jobs(storage, A)
+      assert :ok = QuantumStoragePersistentEts.add_job(storage, A, job)
+      assert [^job] = QuantumStoragePersistentEts.jobs(storage, A)
     end
   end
 
   describe "delete_job/2" do
     test "deletes job", %{storage: storage} do
       job = Scheduler.new_job()
-      assert :ok = QuantumStorageEts.add_job(storage, A, job)
-      assert :ok = QuantumStorageEts.delete_job(storage, A, job.name)
-      assert [] = QuantumStorageEts.jobs(storage, A)
+      assert :ok = QuantumStoragePersistentEts.add_job(storage, A, job)
+      assert :ok = QuantumStoragePersistentEts.delete_job(storage, A, job.name)
+      assert [] = QuantumStoragePersistentEts.jobs(storage, A)
     end
 
     test "does not fail when deleting unknown job", %{storage: storage} do
       job = Scheduler.new_job()
-      assert :ok = QuantumStorageEts.add_job(storage, A, job)
+      assert :ok = QuantumStoragePersistentEts.add_job(storage, A, job)
 
-      assert :ok = QuantumStorageEts.delete_job(storage, A, make_ref())
+      assert :ok = QuantumStoragePersistentEts.delete_job(storage, A, make_ref())
     end
 
     test "does not fail when deleting job from unknown scheduler", %{storage: storage} do
-      assert :ok = QuantumStorageEts.delete_job(storage, A, make_ref())
+      assert :ok = QuantumStoragePersistentEts.delete_job(storage, A, make_ref())
     end
   end
 
   describe "update_job_state/2" do
     test "updates job", %{storage: storage} do
       job = Scheduler.new_job()
-      assert :ok = QuantumStorageEts.add_job(storage, A, job)
-      assert :ok = QuantumStorageEts.update_job_state(storage, A, job.name, :inactive)
-      assert [%{state: :inactive}] = QuantumStorageEts.jobs(storage, A)
+      assert :ok = QuantumStoragePersistentEts.add_job(storage, A, job)
+      assert :ok = QuantumStoragePersistentEts.update_job_state(storage, A, job.name, :inactive)
+      assert [%{state: :inactive}] = QuantumStoragePersistentEts.jobs(storage, A)
     end
 
     test "does not fail when updating unknown job", %{storage: storage} do
       job = Scheduler.new_job()
-      assert :ok = QuantumStorageEts.add_job(storage, A, job)
+      assert :ok = QuantumStoragePersistentEts.add_job(storage, A, job)
 
-      assert :ok = QuantumStorageEts.update_job_state(storage, A, make_ref(), :inactive)
+      assert :ok = QuantumStoragePersistentEts.update_job_state(storage, A, make_ref(), :inactive)
     end
 
     test "does not fail when updating job from unknown scheduler", %{storage: storage} do
-      assert :ok = QuantumStorageEts.delete_job(storage, A, make_ref())
+      assert :ok = QuantumStoragePersistentEts.delete_job(storage, A, make_ref())
     end
   end
 
   describe "update_last_execution_date/2" do
     test "sets time on scheduler", %{storage: storage} do
       date = NaiveDateTime.utc_now()
-      assert :ok = QuantumStorageEts.update_last_execution_date(storage, A, date)
-      assert ^date = QuantumStorageEts.last_execution_date(storage, A)
+      assert :ok = QuantumStoragePersistentEts.update_last_execution_date(storage, A, date)
+      assert ^date = QuantumStoragePersistentEts.last_execution_date(storage, A)
     end
 
     test "sets time only on right scheduler", %{storage: storage} do
       date = NaiveDateTime.utc_now()
-      assert :ok = QuantumStorageEts.update_last_execution_date(storage, A, date)
-      assert :unknown = QuantumStorageEts.last_execution_date(storage, B)
+      assert :ok = QuantumStoragePersistentEts.update_last_execution_date(storage, A, date)
+      assert :unknown = QuantumStoragePersistentEts.last_execution_date(storage, B)
     end
   end
 
   describe "last_execution_date/1" do
     test "gets time", %{storage: storage} do
       date = NaiveDateTime.utc_now()
-      assert :ok = QuantumStorageEts.update_last_execution_date(storage, A, date)
-      assert ^date = QuantumStorageEts.last_execution_date(storage, A)
+      assert :ok = QuantumStoragePersistentEts.update_last_execution_date(storage, A, date)
+      assert ^date = QuantumStoragePersistentEts.last_execution_date(storage, A)
     end
 
     test "get unknown otherwise", %{storage: storage} do
-      assert :unknown = QuantumStorageEts.last_execution_date(storage, A)
+      assert :unknown = QuantumStoragePersistentEts.last_execution_date(storage, A)
     end
   end
 end