deprecate start functions, close #48

Author: artemeff

README.md

@@ -11,7 +11,7 @@
 Add this to the dependencies:
 
 ```elixir
-{:exredis, ">= 0.2.1"}
+{:exredis, ">= 0.2.2"}
 ```
 
 ---
@@ -21,13 +21,13 @@ Add this to the dependencies:
 In your applications config.exs file you need to add new section for customizing redis connection.
 
 ```elixir
-  config :exredis,
-    host: "127.0.0.1",
-    port: 6379,
-    password: "",
-    db: 0,
-    reconnect: :no_reconnect,
-    max_queue: :infinity
+config :exredis,
+  host: "127.0.0.1",
+  port: 6379,
+  password: "",
+  db: 0,
+  reconnect: :no_reconnect,
+  max_queue: :infinity
 ```
 
 ### Usage ([web docs](http://hexdocs.pm/exredis/))
@@ -38,8 +38,8 @@ __As mixin__
 defmodule Pi do
   import Exredis
 
-  def get, do: start |> query ["GET", "Pi"]
-  def set, do: start |> query ["SET", "Pi", "3.14"]
+  def get, do: start_link |> elem(1) |> query ["GET", "Pi"]
+  def set, do: start_link |> elem(1) |> query ["SET", "Pi", "3.14"]
 end
 
 Pi.set
@@ -61,7 +61,7 @@ defmodule Api do
 
 end
 
-client = Exredis.start
+{:ok, client} = Exredis.start_link
 
 client |> Api.set
 # => "OK"
@@ -73,12 +73,9 @@ client |> Api.get
 __Connect to the Redis server__
 
 ```elixir
-client = Exredis.start
+{:ok, client} = Exredis.start_link
 # or
 client = Exredis.start_using_connection_string("redis://127.0.0.1:6379")
-# or
-{:ok, client} = Exredis.start_link
-
 ```
 
 __Disconnect from the server__
@@ -132,8 +129,8 @@ client |> Exredis.query_pipe [["SET", :a, "1"], ["LPUSH", :b, "3"], ["LPUSH", :b
 __Pub/sub__
 
 ```elixir
-client_sub = Exredis.Sub.start
-client = Exredis.start
+{:ok, client_sub} = Exredis.Sub.start_link
+{:ok, client} = Exredis.start_link
 pid = Kernel.self
 
 client_sub |> Exredis.Sub.subscribe "foo", fn(msg) ->
@@ -158,8 +155,8 @@ end
 __Pub/sub by a pattern__
 
 ```elixir
-client_sub = Exredis.Sub.start
-client = Exredis.start
+{:ok, client_sub} = Exredis.Sub.start_link
+{:ok, client} = Exredis.start_link
 pid = Kernel.self
 
 client_sub |> Exredis.Sub.psubscribe "bar_*", fn(msg) ->

lib/exredis.ex

@@ -4,7 +4,7 @@ defmodule Exredis do
   """
 
   @type reconnect_sleep :: :no_reconnect | integer
-  @type start_link      :: { :ok, pid } | { :error, term }
+  @type start_link      :: {:ok, pid} | {:error, term}
 
   @doc """
   Connects to the Redis server using a connection string:
@@ -17,33 +17,27 @@ defmodule Exredis do
   @spec start_using_connection_string(binary, :no_reconnect | integer) :: pid
   def start_using_connection_string(connection_string \\ "redis://127.0.0.1:6379", reconnect_sleep \\ :no_reconnect)  do
     config = Exredis.Config.parse(connection_string)
-    start(config.host, config.port, config.db, config.password, reconnect_sleep)
+    start_link(config.host, config.port, config.db, config.password, reconnect_sleep) |> elem(1)
   end
 
-  @doc """
-  Connects to the Redis server:
-
-  * `start("127.0.0.1", 6379)`
-  * `start("127.0.0.1", 6379, 0, "", :no_reconnect)`
-
-  Returns the pid of the connected client.
-  """
+  @doc false
   @spec start(binary, integer, integer, binary, :no_reconnect | integer) :: pid
   def start(host, port, database \\ 0,
-            password \\ "", reconnect_sleep \\ :no_reconnect), do:
+            password \\ "", reconnect_sleep \\ :no_reconnect) do
+    IO.write :stderr, "warning: Exredis.start/5 is deprecated\n" <>
+      Exception.format_stacktrace
+
     start_link(host, port, database, password, reconnect_sleep)
     |> elem 1
+  end
 
 
-  @doc """
-  Connects to the Redis server with default or environment settings:
-
-  * `start`
-
-  Returns the pid of the connected client.
-  """
+  @doc false
   @spec start :: pid
   def start do
+    IO.write :stderr, "warning: Exredis.start/0 is deprecated\n" <>
+      Exception.format_stacktrace
+
     config = Exredis.Config.fetch_env
     start_link(config.host, config.port, config.db, config.password, config.reconnect)
     |> elem 1

lib/exredis/api.ex

@@ -30,7 +30,7 @@ defmodule Exredis.Api do
   def defaultclient do
     pid = Process.whereis(:exredis_hapi_default_client)
     if !pid do
-      pid = Exredis.start
+      {:ok, pid} = Exredis.start_link
       Process.register pid, :exredis_hapi_default_client
     end
     pid

lib/exredis/sub.ex

@@ -6,7 +6,7 @@ defmodule Exredis.Sub do
   @type reconnect  :: :no_reconnect | integer
   @type max_queue  :: :infinity | integer
   @type behaviour  :: :drop | :exit
-  @type start_link :: { :ok, pid } | { :error, term }
+  @type start_link :: {:ok, pid} | {:error, term}
 
   @doc """
   Connect to the Redis server for subscribe to a channel
@@ -28,26 +28,23 @@ defmodule Exredis.Sub do
     :eredis_sub.start_link(String.to_char_list(config.host), config.port, String.to_char_list(config.password), config.reconnect, config.max_queue, config.behaviour)
   end
 
-  @doc """
-  Connect to the Redis server for subscribe to a channel
-
-  * `start("127.0.0.1", 6379)`
-  * `start("127.0.0.1", 6379, "with_password")`
-  """
+  @doc false
   @spec start(binary, integer, binary, reconnect, max_queue, behaviour) :: pid
   def start(host, port, password,
             reconnect, max_queue,
             behaviour) do
+    IO.write :stderr, "warning: Exredis.Sub.start/6 is deprecated\n" <>
+      Exception.format_stacktrace
+
     start_link(host, port, password, reconnect, max_queue, behaviour)
     |> elem 1
   end
-  @doc """
-  Connect to the Redis server with default or env settings for subscribe to a channel
-
-  * `start`
-  """
+  @doc false
   @spec start :: pid
   def start do
+    IO.write :stderr, "warning: Exredis.Sub.start/0 is deprecated\n" <>
+      Exception.format_stacktrace
+
     config = Exredis.Config.fetch_env
 
     start_link(config.host, config.port, config.password, config.reconnect, config.max_queue, config.behaviour)
@@ -69,7 +66,7 @@ defmodule Exredis.Sub do
         reconnect \\ :no_reconnect, max_queue \\ :infinity,
         behaviour \\ :drop) do
     config = Exredis.Config.parse(connection_string)
-    start(config.host, config.port, config.password, reconnect, max_queue, behaviour)
+    start_link(config.host, config.port, config.password, reconnect, max_queue, behaviour) |> elem(1)
   end
 
 

mix.exs

@@ -1,7 +1,7 @@
 defmodule Exredis.Mixfile do
   use Mix.Project
 
-  @version "0.2.1"
+  @version "0.2.2"
 
   def project do
     [app: :exredis,

test/api_test.exs

@@ -17,7 +17,7 @@ defmodule ApiTest do
   alias Exredis.Api, as: R
 
   setup do
-    client = E.start
+    {:ok, client} = E.start_link
 
     # clean up database and set test value
     client |> E.query ["FLUSHALL"]

test/exredis_test.exs

@@ -4,16 +4,16 @@ defmodule Pi do
   import Exredis
 
   # set/get
-  def get, do: start |> query ["GET", "Pi"]
-  def set, do: start |> query ["SET", "Pi", "3.14"]
+  def get, do: start_link |> elem(1) |> query ["GET", "Pi"]
+  def set, do: start_link |> elem(1) |> query ["SET", "Pi", "3.14"]
 end
 
 defmodule ExredisTest do
   use ExUnit.Case, async: true
   alias Exredis, as: E
 
   setup do
-    client = E.start
+    {:ok, client} = E.start_link
 
     # clean up database and set test value
     client |> E.query ["FLUSHALL"]
@@ -35,11 +35,11 @@ defmodule ExredisTest do
   end
 
   test "connect" do
-    assert E.start |> is_pid
+    assert E.start_link |> elem(1) |> is_pid
   end
 
   test "connect, erlang way" do
-    { :ok, pid } = E.start_link
+    {:ok, pid} = E.start_link
 
     assert pid |> is_pid
   end
@@ -49,7 +49,7 @@ defmodule ExredisTest do
   end
 
   test "disconnect" do
-    assert (E.start |> E.stop) == :ok
+    assert (E.start_link |> elem(1) |> E.stop) == :ok
   end
 
   test "set returns OK", ctx do
@@ -81,7 +81,7 @@ defmodule ExredisTest do
   end
 
   test "transactions" do
-    client = E.start
+    {:ok, client} = E.start_link
 
     status = E.query(client, ["MULTI"])
     assert status == "OK"
@@ -101,7 +101,7 @@ defmodule ExredisTest do
 
   test "pipelining" do
     query  = [["SET", :a, "1"], ["LPUSH", :b, "3"], ["LPUSH", :b, "2"]]
-    client = E.start
+    {:ok, client} = E.start_link
 
     status = E.query_pipe(client, query)
     assert status == ["OK", "1", "2"]

test/pubsub_test.exs

@@ -7,11 +7,11 @@ defmodule PubsubTest do
   alias Exredis.Api, as: R
 
   test "connect" do
-    assert S.start |> is_pid
+    assert S.start_link |> elem(1) |> is_pid
   end
 
   test "connect, erlang way" do
-    { :ok, pid } = S.start_link
+    {:ok, pid} = S.start_link
 
     assert pid |> is_pid
   end
@@ -21,12 +21,12 @@ defmodule PubsubTest do
   end
 
   test "disconnect" do
-    assert (S.start |> S.stop) == :ok
+    assert (S.start_link |> elem(1) |> S.stop) == :ok
   end
 
   test "pub/sub" do
-    client_sub = S.start
-    client = E.start
+    {:ok, client_sub} = S.start_link
+    {:ok, client} = E.start_link
     pid = Kernel.self
 
     client_sub |> S.subscribe "foo", fn(msg) ->
@@ -53,8 +53,8 @@ defmodule PubsubTest do
 
 
   test "pub/sub with multiple channels" do
-    client_sub = S.start
-    client = E.start
+    {:ok, client_sub} = S.start_link
+    {:ok, client} = E.start_link
     pid = Kernel.self
 
     client_sub |> S.subscribe ["foo", "bar"], fn(msg) ->
@@ -86,8 +86,8 @@ defmodule PubsubTest do
 
 
   test "pub/sub by a pattern" do
-    client_sub = S.start
-    client = E.start
+    {:ok, client_sub} = S.start_link
+    {:ok, client} = E.start_link
     pid = Kernel.self
 
     client_sub |> S.psubscribe "bar_*", fn(msg) ->

test/script_test.exs

@@ -17,7 +17,7 @@ defmodule ScriptTest do
   @lua_script_sha_non_existing "9c609a7ccf8e2ef9459f7f88c414c951e3d174d9"
 
   setup do
-    client = E.start
+    {:ok, client} = E.start_link
 
     # clean up database and set test value
     client |> E.query ["FLUSHALL"]