Fix RDF.BlankNode.Generator.start_link interface

CHANGELOG.md

@@ -15,6 +15,11 @@ This project adheres to [Semantic Versioning](http://semver.org/) and
 - `RDF.Triple.coercible_t`, `RDF.Quad.coercible_t`, `RDF.Star.Triple.coercible_t`  
   and `RDF.Star.Quad.coercible_t` types
 
+### Fixed
+
+- the interface of `RDF.BlankNode.Generator.start_link/1` was fixed, so that
+  generators can be started supervised
+
 
 [Compare v0.10.0...HEAD](https://github.com/rdf-elixir/rdf-ex/compare/v0.10.0...HEAD)
 

lib/rdf/blank_node/generator.ex

@@ -12,22 +12,40 @@ defmodule RDF.BlankNode.Generator do
 
   The state will be initialized according to the given `RDF.BlankNode.Generator.Algorithm`.
   """
-  def start_link(generation_mod, init_opts \\ %{}) do
-    GenServer.start_link(__MODULE__, {generation_mod, convert_opts(init_opts)})
+  def start_link(algorithm) when is_atom(algorithm) do
+    start_link({[algorithm: algorithm], []})
   end
 
+  def start_link({algorithm, gen_server_opts}) when is_atom(algorithm) do
+    start_link({[algorithm: algorithm], gen_server_opts})
+  end
+
+  def start_link({init_opts, gen_server_opts}) do
+    {algorithm, init_opts} = Keyword.pop!(init_opts, :algorithm)
+    GenServer.start_link(__MODULE__, {algorithm, Map.new(init_opts)}, gen_server_opts)
+  end
+
+  def start_link(init_opts), do: start_link({init_opts, []})
+
   @doc """
   Starts a blank node generator process without links (outside of a supervision tree).
 
   The state will be initialized according to the given `RDF.BlankNode.Generator.Algorithm`.
   """
-  def start(generation_mod, init_opts \\ %{}) do
-    GenServer.start(__MODULE__, {generation_mod, convert_opts(init_opts)})
+  def start(algorithm) when is_atom(algorithm) do
+    start({[algorithm: algorithm], []})
   end
 
-  defp convert_opts(nil), do: %{}
-  defp convert_opts(opts) when is_list(opts), do: Map.new(opts)
-  defp convert_opts(opts) when is_map(opts), do: opts
+  def start({algorithm, gen_server_opts}) when is_atom(algorithm) do
+    start({[algorithm: algorithm], gen_server_opts})
+  end
+
+  def start({init_opts, gen_server_opts}) do
+    {algorithm, init_opts} = Keyword.pop!(init_opts, :algorithm)
+    GenServer.start(__MODULE__, {algorithm, Map.new(init_opts)}, gen_server_opts)
+  end
+
+  def start(init_opts), do: start({init_opts, []})
 
   @doc """
   Synchronously stops the blank node generator with the given `reason`.

lib/rdf/blank_node/generator_algorithm.ex

@@ -8,7 +8,7 @@ defmodule RDF.BlankNode.Generator.Algorithm do
   @doc """
   Returns the initial state of the algorithm.
   """
-  @callback init(opts :: map | keyword) :: map
+  @callback init(opts :: map) :: map
 
   @doc """
   Generates a blank node.

test/unit/blank_node/generator_test.exs

@@ -0,0 +1,61 @@
+defmodule RDF.BlankNode.GeneratorTest do
+  use RDF.Test.Case
+
+  import RDF, only: [bnode: 1]
+
+  alias RDF.BlankNode.{Generator, Increment}
+
+  describe "Increment generator" do
+    test "generator without prefix" do
+      {:ok, generator} = start_supervised({Generator, Increment})
+
+      assert Generator.generate(generator) == bnode(0)
+      assert Generator.generate(generator) == bnode(1)
+      assert Generator.generate_for(generator, "foo") == bnode(2)
+      assert Generator.generate(generator) == bnode(3)
+      assert Generator.generate_for(generator, "bar") == bnode(4)
+      assert Generator.generate(generator) == bnode(5)
+      assert Generator.generate_for(generator, "foo") == bnode(2)
+      assert Generator.generate(generator) == bnode(6)
+    end
+
+    test "generator with prefix" do
+      {:ok, generator} = start_supervised({Generator, [algorithm: Increment, prefix: "b"]})
+
+      assert Generator.generate(generator) == bnode("b0")
+      assert Generator.generate(generator) == bnode("b1")
+      assert Generator.generate_for(generator, "foo") == bnode("b2")
+      assert Generator.generate(generator) == bnode("b3")
+      assert Generator.generate_for(generator, "bar") == bnode("b4")
+      assert Generator.generate(generator) == bnode("b5")
+      assert Generator.generate_for(generator, "foo") == bnode("b2")
+      assert Generator.generate(generator) == bnode("b6")
+    end
+
+    test "generator with non-string values" do
+      {:ok, generator} = start_supervised({Generator, [algorithm: Increment, prefix: "b"]})
+
+      assert Generator.generate(generator) == bnode("b0")
+      assert Generator.generate(generator) == bnode("b1")
+      assert Generator.generate_for(generator, {:foo, 42}) == bnode("b2")
+      assert Generator.generate(generator) == bnode("b3")
+      assert Generator.generate_for(generator, [:bar, 3.14]) == bnode("b4")
+      assert Generator.generate(generator) == bnode("b5")
+      assert Generator.generate_for(generator, {:foo, 42}) == bnode("b2")
+      assert Generator.generate(generator) == bnode("b6")
+    end
+
+    test "named generator" do
+      {:ok, _} = start_supervised({Generator, {Increment, [name: Foo]}})
+
+      assert Generator.generate(Foo) == bnode(0)
+      assert Generator.generate(Foo) == bnode(1)
+
+      {:ok, _} =
+        start_supervised({Generator, {[algorithm: Increment, prefix: "b"], [name: Bar]}}, id: :g2)
+
+      assert Generator.generate(Bar) == bnode("b0")
+      assert Generator.generate(Bar) == bnode("b1")
+    end
+  end
+end

test/unit/blank_node/increment_test.exs

@@ -3,7 +3,7 @@ defmodule RDF.BlankNode.IncrementTest do
 
   import RDF, only: [bnode: 1]
 
-  alias RDF.BlankNode.{Generator, Increment}
+  alias RDF.BlankNode.Increment
 
   describe "generate/1" do
     test "without prefix" do
@@ -36,43 +36,4 @@ defmodule RDF.BlankNode.IncrementTest do
                {bnode("b0"), %{counter: 1, map: %{"foo" => 0}, prefix: "b"}}
     end
   end
-
-  test "generator without prefix" do
-    {:ok, generator} = Generator.start_link(Increment)
-
-    assert Generator.generate(generator) == bnode(0)
-    assert Generator.generate(generator) == bnode(1)
-    assert Generator.generate_for(generator, "foo") == bnode(2)
-    assert Generator.generate(generator) == bnode(3)
-    assert Generator.generate_for(generator, "bar") == bnode(4)
-    assert Generator.generate(generator) == bnode(5)
-    assert Generator.generate_for(generator, "foo") == bnode(2)
-    assert Generator.generate(generator) == bnode(6)
-  end
-
-  test "generator with prefix" do
-    {:ok, generator} = Generator.start_link(Increment, prefix: "b")
-
-    assert Generator.generate(generator) == bnode("b0")
-    assert Generator.generate(generator) == bnode("b1")
-    assert Generator.generate_for(generator, "foo") == bnode("b2")
-    assert Generator.generate(generator) == bnode("b3")
-    assert Generator.generate_for(generator, "bar") == bnode("b4")
-    assert Generator.generate(generator) == bnode("b5")
-    assert Generator.generate_for(generator, "foo") == bnode("b2")
-    assert Generator.generate(generator) == bnode("b6")
-  end
-
-  test "generator with non-string values" do
-    {:ok, generator} = Generator.start_link(Increment, prefix: "b")
-
-    assert Generator.generate(generator) == bnode("b0")
-    assert Generator.generate(generator) == bnode("b1")
-    assert Generator.generate_for(generator, {:foo, 42}) == bnode("b2")
-    assert Generator.generate(generator) == bnode("b3")
-    assert Generator.generate_for(generator, [:bar, 3.14]) == bnode("b4")
-    assert Generator.generate(generator) == bnode("b5")
-    assert Generator.generate_for(generator, {:foo, 42}) == bnode("b2")
-    assert Generator.generate(generator) == bnode("b6")
-  end
 end