Namespace sub apps, add DB app seketon

.gitignore

@@ -41,3 +41,4 @@ erl_crash.dump
 rel/artifacts
 
 .ssh
+.todo

README.md

@@ -10,10 +10,10 @@ The `ExDoc` documentation is available [here](https://solomonhawk.github.io/gifs
 
 ## Starting Points
 
-* [GameApp.Game](https://solomonhawk.github.io/gifs-to-gifs-reborn/GameApp.Game.html) - Game state and logic
-* [GameApp.Round](https://solomonhawk.github.io/gifs-to-gifs-reborn/GameApp.Round.html) - Round state and logic
-* [GameApp.Server](https://solomonhawk.github.io/gifs-to-gifs-reborn/GameApp.Server.html) - Game Server logic (GenServer)
-* [GameApp.ServerSupervisor](https://solomonhawk.github.io/gifs-to-gifs-reborn/GameApp.ServerSupervisor.html) - Supervisor for Game Servers
+* [GifMe.Game.Game](https://solomonhawk.github.io/gifs-to-gifs-reborn/GifMe.Game.Game.html) - Game state and logic
+* [GifMe.Game.Round](https://solomonhawk.github.io/gifs-to-gifs-reborn/GifMe.Game.Round.html) - Round state and logic
+* [GifMe.Game.Server](https://solomonhawk.github.io/gifs-to-gifs-reborn/GifMe.Game.Server.html) - Game Server logic (GenServer)
+* [GifMe.Game.ServerSupervisor](https://solomonhawk.github.io/gifs-to-gifs-reborn/GifMe.Game.ServerSupervisor.html) - Supervisor for Game Servers
 
 ## Set Up
 

apps/db/.formatter.exs

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

apps/db/.gitignore

@@ -0,0 +1,24 @@
+# The directory Mix will write compiled artifacts to.
+/_build/
+
+# If you run "mix test --cover", coverage assets end up here.
+/cover/
+
+# The directory Mix downloads your dependencies sources to.
+/deps/
+
+# Where third-party dependencies like ExDoc output generated docs.
+/doc/
+
+# Ignore .fetch files in case you like to edit your project deps locally.
+/.fetch
+
+# If the VM crashes, it generates a dump, let's ignore it too.
+erl_crash.dump
+
+# Also ignore archive artifacts (built via "mix archive.build").
+*.ez
+
+# Ignore package tarball (built via "mix hex.build").
+db-*.tar
+

apps/db/README.md

@@ -0,0 +1,21 @@
+# Game.DB
+
+**TODO: Add description**
+
+## Installation
+
+If [available in Hex](https://hex.pm/docs/publish), the package can be installed
+by adding `db` to your list of dependencies in `mix.exs`:
+
+```elixir
+def deps do
+  [
+    {:db, "~> 0.1.0"}
+  ]
+end
+```
+
+Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
+and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
+be found at [https://hexdocs.pm/db](https://hexdocs.pm/db).
+

apps/db/lib/db.ex

@@ -0,0 +1,18 @@
+defmodule GifMe.DB do
+  @moduledoc """
+  Documentation for GifMe.DB.
+  """
+
+  @doc """
+  Hello world.
+
+  ## Examples
+
+      iex> GifMe.DB.hello()
+      :world
+
+  """
+  def hello do
+    :world
+  end
+end

apps/db/lib/db/application.ex

@@ -0,0 +1,19 @@
+defmodule GifMe.DB.Application do
+  # See https://hexdocs.pm/elixir/Application.html
+  # for more information on OTP Applications
+  @moduledoc false
+
+  use Application
+
+  def start(_type, _args) do
+    children = [
+      # Starts a worker by calling: Game.DB.Worker.start_link(arg)
+      # {Game.DB.Worker, arg}
+    ]
+
+    # See https://hexdocs.pm/elixir/Supervisor.html
+    # for other strategies and supported options
+    opts = [strategy: :one_for_one, name: GifMe.DB.Supervisor]
+    Supervisor.start_link(children, opts)
+  end
+end

apps/db/mix.exs

@@ -0,0 +1,34 @@
+defmodule GifMe.DB.MixProject do
+  use Mix.Project
+
+  def project do
+    [
+      app: :db,
+      version: "0.1.0",
+      build_path: "../../_build",
+      config_path: "../../config/config.exs",
+      deps_path: "../../deps",
+      lockfile: "../../mix.lock",
+      elixir: "~> 1.9",
+      start_permanent: Mix.env() == :prod,
+      deps: deps()
+    ]
+  end
+
+  # Run "mix help compile.app" to learn about applications.
+  def application do
+    [
+      extra_applications: [:logger],
+      mod: {GifMe.DB.Application, []}
+    ]
+  end
+
+  # Run "mix help deps" to learn about dependencies.
+  defp deps do
+    [
+      # {:dep_from_hexpm, "~> 0.3.0"},
+      # {:dep_from_git, git: "https://github.com/elixir-lang/my_dep.git", tag: "0.1.0"},
+      # {:sibling_app_in_umbrella, in_umbrella: true}
+    ]
+  end
+end

apps/db/test/game/db_test.exs

@@ -0,0 +1,8 @@
+defmodule GifMe.DBTest do
+  use ExUnit.Case
+  doctest GifMe.DB
+
+  test "greets the world" do
+    assert GifMe.DB.hello() == :world
+  end
+end

apps/db/test/test_helper.exs

@@ -0,0 +1 @@
+ExUnit.start()

apps/game/README.md

@@ -15,19 +15,19 @@ $ iex -S mix
 2. Create a Game Server, providing a shortcode and player (only id required for now)
 
 ```elixir
-$ iex> GameApp.ServerSupervisor.start_game("ABCD", %GameApp.Player{ name: "fatal1ty", id: "Gamer" })
+$ iex> GifMe.Game.ServerSupervisor.start_game("ABCD", %GifMe.Game.Player{ name: "fatal1ty", id: "Gamer" })
 ```
 
 3. Get a summary of the game state (shortcode required to locate correct game server process to message)
 
 ```elixir
-$ iex> GameApp.Server.summary("ABCD")
+$ iex> GifMe.Game.Server.summary("ABCD")
 
 %{
-  creator: %GameApp.Player{id: "gamer", name: "fatal1ity"},
+  creator: %GifMe.Game.Player{id: "gamer", name: "fatal1ity"},
   funmaster: nil,
   phase: :lobby,
-  players: %{"gamer" => %GameApp.Player{id: "gamer", name: "fatal1ity"}},
+  players: %{"gamer" => %GifMe.Game.Player{id: "gamer", name: "fatal1ity"}},
   prompt: nil,
   reactions: nil,
   round_number: nil,
@@ -40,25 +40,25 @@ $ iex> GameApp.Server.summary("ABCD")
 4. Join another player to the game
 
 ```elixir
-$ iex> GameApp.Server.join("ABCD", %GameApp.Player{ id: "Noob", name: "dylan" })
+$ iex> GifMe.Game.Server.join("ABCD", %GifMe.Game.Player{ id: "Noob", name: "dylan" })
 ```
 
 5. Remove a player from the game
 
 ```elixir
-$ iex> GameApp.Server.leave("ABCD", %GameApp.Player{ id: "Noob", name: "dylan"})
+$ iex> GifMe.Game.Server.leave("ABCD", %GifMe.Game.Player{ id: "Noob", name: "dylan"})
 ```
 
 6. Start the game
 
 ```elixir
-$ iex> GameApp.Server.start_game("ABCD")
+$ iex> GifMe.Game.Server.start_game("ABCD")
 ```
 
 7. Start the next round
 
 ```elixir
-$ iex> GameApp.Server.start_round("ABCD")
+$ iex> GifMe.Game.Server.start_round("ABCD")
 ```
 
 

apps/game/lib/game/application.ex

@@ -1,17 +1,17 @@
-defmodule GameApp.Application do
+defmodule GifMe.Game.Application do
   @moduledoc false
 
   use Application
 
   def start(_type, _args) do
     children = [
-      {Registry, keys: :unique, name: GameApp.Registry}
+      {Registry, keys: :unique, name: GifMe.Game.Registry}
       | Application.get_env(:game, :children)
     ]
 
     _ = :ets.new(:games_table, [:public, :named_table])
 
-    opts = [strategy: :one_for_one, name: GameApp.Supervisor]
+    opts = [strategy: :one_for_one, name: GifMe.Game.Supervisor]
     Supervisor.start_link(children, opts)
   end
 end

apps/game/lib/game/config.ex

@@ -1,4 +1,4 @@
-defmodule GameApp.Config do
+defmodule GifMe.Game.Config do
   alias __MODULE__, as: GameConfig
 
   @derive Jason.Encoder

apps/game/lib/game/server.ex

@@ -1,14 +1,14 @@
-defmodule GameApp.Server do
+defmodule GifMe.Game.Server do
   @moduledoc """
-  `GameApp.Server` provides a stateful process that maintains an internal game
+  `GifMe.Game.Server` provides a stateful process that maintains an internal game
   state and provides a public API for interacting with the game.
   """
 
   use GenServer
 
   alias __MODULE__, as: Server
-  alias GameApp.{Game, Player}
-  alias GameApp.Config, as: GameConfig
+  alias GifMe.Game.{Game, Player}
+  alias GifMe.Game.Config, as: GameConfig
 
   require Logger
 
@@ -270,9 +270,9 @@ defmodule GameApp.Server do
   @doc """
   Returns a tuple used to register and lookup a game server process by name.
   """
-  @spec via_tuple(String.t()) :: {:via, Registry, {GameApp.Registry, String.t()}}
+  @spec via_tuple(String.t()) :: {:via, Registry, {GifMe.Game.Registry, String.t()}}
   def via_tuple(shortcode) do
-    {:via, Registry, {GameApp.Registry, "game:" <> shortcode}}
+    {:via, Registry, {GifMe.Game.Registry, "game:" <> shortcode}}
   end
 
   @doc """

apps/game/lib/game/server_supervisor.ex

@@ -1,11 +1,12 @@
-defmodule GameApp.ServerSupervisor do
+defmodule GifMe.Game.ServerSupervisor do
   @moduledoc """
-  A dynamic supervisor that supervises child `GameApp.Server` processes.
+  A dynamic supervisor that supervises child `GifMe.Game.Server` processes.
   """
 
   alias __MODULE__, as: ServerSupervisor
-  alias GameApp.Player
-  alias GameApp.Config, as: GameConfig
+  alias GifMe.Game
+  alias Game.Player
+  alias Game.Config, as: GameConfig
 
   use DynamicSupervisor
 
@@ -25,15 +26,15 @@ defmodule GameApp.ServerSupervisor do
 
   ## Examples
 
-      iex> GameApp.ServerSupervisor.start_game("ABCD", %{id: "Gamer"})
+      iex> Game.ServerSupervisor.start_game("ABCD", %{id: "Gamer"})
       {:ok, pid}
 
   """
   @spec start_game(String.t(), Player.t(), GameConfig.t()) :: {:ok, pid()} | {:error, any()}
   def start_game(shortcode, player, config \\ %GameConfig{}) do
     child_spec = %{
-      id: GameApp.Server,
-      start: {GameApp.Server, :start_link, [shortcode, player, config]},
+      id: Game.Server,
+      start: {Game.Server, :start_link, [shortcode, player, config]},
       # don't restart game server processes that exit normally
       restart: :transient
     }
@@ -48,7 +49,7 @@ defmodule GameApp.ServerSupervisor do
   """
   @spec stop_game(String.t()) :: :ok | {:error, :not_found}
   def stop_game(shortcode) do
-    child_pid = GameApp.Server.game_pid(shortcode)
+    child_pid = Game.Server.game_pid(shortcode)
     DynamicSupervisor.terminate_child(ServerSupervisor, child_pid)
   end
 
@@ -59,7 +60,7 @@ defmodule GameApp.ServerSupervisor do
   """
   @spec find_game(String.t()) :: {:ok, pid()} | {:error, :not_found}
   def find_game(shortcode) do
-    case GameApp.Server.game_pid(shortcode) do
+    case Game.Server.game_pid(shortcode) do
       pid when is_pid(pid) ->
         {:ok, pid}
 

apps/game/lib/game/state/game.ex

@@ -1,12 +1,12 @@
-defmodule GameApp.Game do
+defmodule GifMe.Game.Game do
   @moduledoc """
-  `GameApp.Game` defines a struct that encapsulates game state as well as many
+  `GifMe.Game.Game` defines a struct that encapsulates game state as well as many
   functions that advance the game state based on actions that players can take.
   """
 
   alias __MODULE__, as: Game
-  alias GameApp.{Player, Round}
-  alias GameApp.Config, as: GameConfig
+  alias GifMe.Game.{Player, Round}
+  alias GifMe.Game.Config, as: GameConfig
 
   require Logger
 

apps/game/lib/game/state/player.ex

@@ -1,4 +1,4 @@
-defmodule GameApp.Player do
+defmodule GifMe.Game.Player do
   @moduledoc """
   A player in the game.
   """

apps/game/lib/game/state/round.ex

@@ -1,11 +1,11 @@
-defmodule GameApp.Round do
+defmodule GifMe.Game.Round do
   @moduledoc """
-  `GameApp.Round` defines a struct that encapsulates Round state as well as
+  `GifMe.Game.Round` defines a struct that encapsulates Round state as well as
   functions that update the round state.
   """
 
   alias __MODULE__, as: Round
-  alias GameApp.Player
+  alias GifMe.Game.Player
 
   @enforce_keys [:number]
   defstruct number: nil,

apps/game/mix.exs

@@ -1,4 +1,4 @@
-defmodule GameApp.MixProject do
+defmodule GifMe.Game.MixProject do
   use Mix.Project
 
   def project do
@@ -20,7 +20,7 @@ defmodule GameApp.MixProject do
   def application do
     [
       extra_applications: [:logger],
-      mod: {GameApp.Application, []}
+      mod: {GifMe.Game.Application, []}
     ]
   end
 

apps/game/test/game_test.exs

@@ -1,9 +1,9 @@
 defmodule GameTest do
   use ExUnit.Case, async: true
-  alias GameApp.{Round, Game, Player}
-  alias GameApp.Config, as: GameConfig
+  alias GifMe.Game.{Round, Game, Player}
+  alias GifMe.Game.Config, as: GameConfig
 
-  doctest GameApp.Game, import: true
+  doctest GifMe.Game.Game, import: true
 
   @shortcode "ABCD"
   @player1 Player.create(id: "1", name: "Gamer")

apps/game/test/round_test.exs

@@ -1,8 +1,8 @@
 defmodule RoundTest do
   use ExUnit.Case, async: true
-  alias GameApp.{Player, Round}
+  alias GifMe.Game.{Player, Round}
 
-  doctest GameApp.Round, import: true
+  doctest GifMe.Game.Round, import: true
 
   @player Player.create(id: "1", name: "Gamer")