Better error message if no database path provided. (#201)

* Better error message if no database path provided.

Fixes #200. Thanks for the report, @jfcalvo.

* Prepare 2.2.2 release.

Author: scouten

CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog for v2.2.x Series
 
+## v2.2.2
+
+_8 October 2017_
+
+* Better error message if no database path provided. Fixes #200.
+
+
 ## v2.2.1
 
 _11 September 2017_

lib/sqlite_ecto.ex

@@ -105,7 +105,27 @@ defmodule Sqlite.Ecto2 do
 
   @doc false
   def storage_up(opts) do
-    database = Keyword.get(opts, :database)
+    storage_up_with_path(Keyword.get(opts, :database), opts)
+  end
+
+  defp storage_up_with_path(nil, opts) do
+    raise ArgumentError,
+      """
+      No SQLite database path specified. Please check the configuration for your Repo.
+      Your config/*.exs file should have something like this in it:
+
+        config :my_app, MyApp.Repo,
+          adapter: Sqlite.Ecto2,
+          database: "/path/to/sqlite/database"
+
+      Options provided were:
+
+      #{inspect opts, pretty: true}
+
+      """
+  end
+
+  defp storage_up_with_path(database, _opts) do
     if File.exists?(database) do
       {:error, :already_up}
     else

mix.exs

@@ -3,7 +3,7 @@ defmodule Sqlite.Ecto2.Mixfile do
 
   def project do
     [app: :sqlite_ecto2,
-     version: "2.2.1",
+     version: "2.2.2",
      name: "Sqlite.Ecto2",
      elixir: "~> 1.4",
      elixirc_options: [warnings_as_errors: true],

mix.lock

@@ -7,7 +7,7 @@
   "decimal": {:hex, :decimal, "1.4.0", "fac965ce71a46aab53d3a6ce45662806bdd708a4a95a65cde8a12eb0124a1333", [:mix], [], "hexpm"},
   "dogma": {:hex, :dogma, "0.1.15", "5bceba9054b2b97a4adcb2ab4948ca9245e5258b883946e82d32f785340fd411", [:mix], [{:poison, ">= 2.0.0", [hex: :poison, repo: "hexpm", optional: false]}], "hexpm"},
   "earmark": {:hex, :earmark, "1.2.2", "f718159d6b65068e8daeef709ccddae5f7fdc770707d82e7d126f584cd925b74", [:mix], [], "hexpm"},
-  "ecto": {:hex, :ecto, "2.2.2", "e9bd6ebc044eaaab1cb369e3465686d8aca830aa5bf545ef2bae000a3d42c54b", [], [{:db_connection, "~> 1.1", [hex: :db_connection, repo: "hexpm", optional: true]}, {:decimal, "~> 1.2", [hex: :decimal, repo: "hexpm", optional: false]}, {:mariaex, "~> 0.8.0", [hex: :mariaex, repo: "hexpm", optional: true]}, {:poison, "~> 2.2 or ~> 3.0", [hex: :poison, repo: "hexpm", optional: true]}, {:poolboy, "~> 1.5", [hex: :poolboy, repo: "hexpm", optional: false]}, {:postgrex, "~> 0.13.0", [hex: :postgrex, repo: "hexpm", optional: true]}, {:sbroker, "~> 1.0", [hex: :sbroker, repo: "hexpm", optional: true]}], "hexpm"},
+  "ecto": {:hex, :ecto, "2.2.2", "e9bd6ebc044eaaab1cb369e3465686d8aca830aa5bf545ef2bae000a3d42c54b", [:mix], [{:db_connection, "~> 1.1", [hex: :db_connection, repo: "hexpm", optional: true]}, {:decimal, "~> 1.2", [hex: :decimal, repo: "hexpm", optional: false]}, {:mariaex, "~> 0.8.0", [hex: :mariaex, repo: "hexpm", optional: true]}, {:poison, "~> 2.2 or ~> 3.0", [hex: :poison, repo: "hexpm", optional: true]}, {:poolboy, "~> 1.5", [hex: :poolboy, repo: "hexpm", optional: false]}, {:postgrex, "~> 0.13.0", [hex: :postgrex, repo: "hexpm", optional: true]}, {:sbroker, "~> 1.0", [hex: :sbroker, repo: "hexpm", optional: true]}], "hexpm"},
   "esqlite": {:hex, :esqlite, "0.2.3", "1a8b60877fdd3d50a8a84b342db04032c0231cc27ecff4ddd0d934485d4c0cd5", [:rebar3], [], "hexpm"},
   "ex_doc": {:hex, :ex_doc, "0.16.3", "cd2a4cfe5d26e37502d3ec776702c72efa1adfa24ed9ce723bb565f4c30bd31a", [:mix], [{:earmark, "~> 1.1", [hex: :earmark, repo: "hexpm", optional: false]}], "hexpm"},
   "hackney": {:hex, :hackney, "1.7.1", "e238c52c5df3c3b16ce613d3a51c7220a784d734879b1e231c9babd433ac1cb4", [:rebar3], [{:certifi, "1.0.0", [hex: :certifi, repo: "hexpm", optional: false]}, {:idna, "4.0.0", [hex: :idna, repo: "hexpm", optional: false]}, {:metrics, "1.0.1", [hex: :metrics, repo: "hexpm", optional: false]}, {:mimerl, "1.0.2", [hex: :mimerl, repo: "hexpm", optional: false]}, {:ssl_verify_fun, "1.1.1", [hex: :ssl_verify_fun, repo: "hexpm", optional: false]}], "hexpm"},

test/sqlite_ecto_test.exs

@@ -12,12 +12,32 @@ defmodule Sqlite.Ecto2.Test do
 
   import Ecto.Query
 
-  test "storage up (twice)" do
-    tmp = [database: tempfilename()]
-    assert Sqlite.Ecto2.storage_up(tmp) == :ok
-    assert File.exists? tmp[:database]
-    assert Sqlite.Ecto2.storage_up(tmp) == {:error, :already_up}
-    File.rm(tmp[:database])
+  describe "storage_up" do
+    test "fails with :already_up on second call" do
+      tmp = [database: tempfilename()]
+      assert Sqlite.Ecto2.storage_up(tmp) == :ok
+      assert File.exists? tmp[:database]
+      assert Sqlite.Ecto2.storage_up(tmp) == {:error, :already_up}
+      File.rm(tmp[:database])
+    end
+
+    test "fails with helpful error message if no database specified" do
+      assert_raise ArgumentError,
+        """
+        No SQLite database path specified. Please check the configuration for your Repo.
+        Your config/*.exs file should have something like this in it:
+
+          config :my_app, MyApp.Repo,
+            adapter: Sqlite.Ecto2,
+            database: "/path/to/sqlite/database"
+
+        Options provided were:
+
+        [mumble: "no database here"]
+
+        """,
+        fn -> Sqlite.Ecto2.storage_up([mumble: "no database here"]) == :ok end
+    end
   end
 
   test "storage down (twice)" do