Adds parser behaviour

dragonwasrobot · dragonwasrobot · commit f986d33282ef · 2017-09-09T14:04:28.000+02:00
diff --git a/.tool-versions b/.tool-versions
@@ -0,0 +1,2 @@
+erlang 20.0
+elixir 1.5.1
diff --git a/lib/parsers/all_of_parser.ex b/lib/parsers/all_of_parser.ex
@@ -1,4 +1,5 @@
 defmodule JS2E.Parsers.AllOfParser do
+  @behaviour JS2E.Parsers.ParserBehaviour
   @moduledoc ~S"""
   Parses a JSON schema allOf type:
 
@@ -36,7 +37,8 @@ defmodule JS2E.Parsers.AllOfParser do
   @doc ~S"""
   Parses a JSON schema allOf type into an `JS2E.Types.AllOfType`.
   """
-  @spec parse(map, URI.t, URI.t, TypePath.t, String.t)
+  @impl JS2E.Parsers.ParserBehaviour
+  @spec parse(map, URI.t, URI.t | nil, TypePath.t, String.t)
   :: Types.typeDictionary
   def parse(schema_node, parent_id, id, path, name) do
     Logger.debug "Parsing '#{inspect path}' as allOf type"
diff --git a/lib/parsers/any_of_parser.ex b/lib/parsers/any_of_parser.ex
@@ -1,4 +1,5 @@
 defmodule JS2E.Parsers.AnyOfParser do
+  @behaviour JS2E.Parsers.ParserBehaviour
   @moduledoc ~S"""
   Parses a JSON schema anyOf type:
 
@@ -36,7 +37,8 @@ defmodule JS2E.Parsers.AnyOfParser do
   @doc ~S"""
   Parses a JSON schema anyOf type into an `JS2E.Types.AnyOfType`.
   """
-  @spec parse(map, URI.t, URI.t, TypePath.t, String.t)
+  @impl JS2E.Parsers.ParserBehaviour
+  @spec parse(map, URI.t, URI.t | nil, TypePath.t, String.t)
   :: Types.typeDictionary
   def parse(schema_node, parent_id, id, path, name) do
     Logger.debug "Parsing '#{inspect path}' as anyOf type"
diff --git a/lib/parsers/array_parser.ex b/lib/parsers/array_parser.ex
@@ -1,4 +1,5 @@
 defmodule JS2E.Parsers.ArrayParser do
+  @behaviour JS2E.Parsers.ParserBehaviour
   @moduledoc ~S"""
   Parses a JSON schema array type:
 
@@ -20,7 +21,8 @@ defmodule JS2E.Parsers.ArrayParser do
   @doc ~S"""
   Parses a JSON schema array type into an `JS2E.Types.ArrayType`.
   """
-  @spec parse(map, URI.t, URI.t, TypePath.t, String.t)
+  @impl JS2E.Parsers.ParserBehaviour
+  @spec parse(map, URI.t, URI.t | nil, TypePath.t, String.t)
   :: Types.typeDictionary
   def parse(schema_node, parent_id, id, path, name) do
     Logger.debug "Parsing '#{inspect path}' as ArrayType"
diff --git a/lib/parsers/definitions_parser.ex b/lib/parsers/definitions_parser.ex
@@ -1,4 +1,5 @@
 defmodule JS2E.Parsers.DefinitionsParser do
+  @behaviour JS2E.Parsers.ParserBehaviour
   @moduledoc ~S"""
   Parses a 'definitions' property in a JSON schema or subschema.
 
@@ -20,13 +21,9 @@ defmodule JS2E.Parsers.DefinitionsParser do
   @doc ~S"""
   Parses a JSON schema 'definitions' property into a map of types.
   """
-  @spec parse(
-    map,
-    URI.t,
-    URI.t | nil,
-    TypePath.t,
-    String.t
-  ) :: Types.typeDictionary
+  @impl JS2E.Parsers.ParserBehaviour
+  @spec parse(map, URI.t, URI.t | nil, TypePath.t, String.t)
+  :: Types.typeDictionary
   def parse(schema_node, parent_id, _id, path, _name) do
     Logger.debug "Parsing '#{inspect path}' as definitions"
 
diff --git a/lib/parsers/enum_parser.ex b/lib/parsers/enum_parser.ex
@@ -1,4 +1,5 @@
 defmodule JS2E.Parsers.EnumParser do
+  @behaviour JS2E.Parsers.ParserBehaviour
   @moduledoc ~S"""
   Parse a JSON schema enum type:
 
@@ -18,7 +19,9 @@ defmodule JS2E.Parsers.EnumParser do
   @doc ~S"""
   Parses a JSON schema enum type into an `JS2E.Types.EnumType`.
   """
-  @spec parse(map, URI.t, URI.t, TypePath.t, String.t) :: Types.typeDictionary
+  @impl JS2E.Parsers.ParserBehaviour
+  @spec parse(map, URI.t, URI.t | nil, TypePath.t, String.t)
+  :: Types.typeDictionary
   def parse(schema_node, _parent_id, id, path, name) do
     Logger.debug "parsing '#{inspect path}' as EnumType"
 
diff --git a/lib/parsers/object_parser.ex b/lib/parsers/object_parser.ex
@@ -1,4 +1,5 @@
 defmodule JS2E.Parsers.ObjectParser do
+  @behaviour JS2E.Parsers.ParserBehaviour
   @moduledoc ~S"""
   Parses a JSON schema object type:
 
@@ -29,6 +30,7 @@ defmodule JS2E.Parsers.ObjectParser do
   @doc ~S"""
   Parses a JSON schema object type into an `JS2E.Types.ObjectType`.
   """
+  @impl JS2E.Parsers.ParserBehaviour
   @spec parse(map, URI.t, URI.t, TypePath.t, String.t) :: Types.typeDictionary
   def parse(schema_node, parent_id, id, path, name) do
     Logger.debug "Parsing '#{inspect path}' as ObjectType"
diff --git a/lib/parsers/one_of_parser.ex b/lib/parsers/one_of_parser.ex
@@ -1,4 +1,5 @@
 defmodule JS2E.Parsers.OneOfParser do
+  @behaviour JS2E.Parsers.ParserBehaviour
   @moduledoc ~S"""
   Parses a JSON schema oneOf type:
 
@@ -36,6 +37,7 @@ defmodule JS2E.Parsers.OneOfParser do
   @doc ~S"""
   Parses a JSON schema oneOf type into an `JS2E.Types.OneOfType`.
   """
+  @impl JS2E.Parsers.ParserBehaviour
   @spec parse(map, URI.t, URI.t, TypePath.t, String.t)
   :: Types.typeDictionary
   def parse(schema_node, parent_id, id, path, name) do
diff --git a/lib/parsers/parser_behaviour.ex b/lib/parsers/parser_behaviour.ex
@@ -0,0 +1,8 @@
+defmodule JS2E.Parsers.ParserBehaviour do
+  @moduledoc ~S"""
+  Describes the functions needed to implement a parser for a JSON schema node.
+  """
+
+  @callback parse(map, URI.t, URI.t | nil, TypePath.t, String.t)
+  :: Types.typeDictionary
+end
diff --git a/lib/parsers/primitive_parser.ex b/lib/parsers/primitive_parser.ex
@@ -1,4 +1,5 @@
 defmodule JS2E.Parsers.PrimitiveParser do
+  @behaviour JS2E.Parsers.ParserBehaviour
   @moduledoc ~S"""
   Parses a JSON schema primitive type:
 
@@ -17,6 +18,7 @@ defmodule JS2E.Parsers.PrimitiveParser do
   @doc ~S"""
   Parses a JSON schema primitive type into an `JS2E.Types.PrimitiveType`.
   """
+  @impl JS2E.Parsers.ParserBehaviour
   @spec parse(map, URI.t, URI.t, TypePath.t, String.t) :: Types.typeDictionary
   def parse(schema_node, _parent_id, id, path, name) do
     Logger.debug "Parsing '#{inspect path}' as primitive type"
diff --git a/lib/parsers/type_reference_parser.ex b/lib/parsers/type_reference_parser.ex
@@ -1,4 +1,5 @@
 defmodule JS2E.Parsers.TypeReferenceParser do
+  @behaviour JS2E.Parsers.ParserBehaviour
   @moduledoc ~S"""
   Parses a JSON schema type reference:
 
@@ -17,13 +18,9 @@ defmodule JS2E.Parsers.TypeReferenceParser do
   @doc ~S"""
   Parses a JSON schema type reference into an `JS2E.Types.TypeReference`.
   """
-  @spec parse(
-    map,
-    URI.t,
-    URI.t | nil,
-    TypePath.t,
-    String.t
-  ) :: Types.typeDictionary
+  @impl JS2E.Parsers.ParserBehaviour
+  @spec parse(map, URI.t, URI.t | nil, TypePath.t, String.t)
+  :: Types.typeDictionary
   def parse(schema_node, _parent_id, id, path, name) do
     Logger.debug "parsing '#{inspect path}' as TypeReference"
 
diff --git a/lib/parsers/union_parser.ex b/lib/parsers/union_parser.ex
@@ -1,4 +1,5 @@
 defmodule JS2E.Parsers.UnionParser do
+  @behaviour JS2E.Parsers.ParserBehaviour
   @moduledoc ~S"""
   Parses a JSON schema union type:
 
@@ -17,6 +18,7 @@ defmodule JS2E.Parsers.UnionParser do
   @doc ~S"""
   Parses a JSON schema union type into an `JS2E.Types.UnionType`.
   """
+  @impl JS2E.Parsers.ParserBehaviour
   @spec parse(map, URI.t, URI.t, TypePath.t, String.t) :: Types.typeDictionary
   def parse(schema_node, _parent_id, id, path, name) do
     Logger.debug "Parsing '#{inspect path}' as union type"
diff --git a/mix.lock b/mix.lock
@@ -1,17 +1,17 @@
 %{"apex": {:hex, :apex, "1.0.0", "abf230314d35ca4c48a902f693247f190ad42fc14862b9c4f7dbb7077b21c20a", [:mix], []},
   "bunt": {:hex, :bunt, "0.2.0", "951c6e801e8b1d2cbe58ebbd3e616a869061ddadcc4863d0a2182541acae9a38", [:mix], []},
-  "certifi": {:hex, :certifi, "1.2.1", "c3904f192bd5284e5b13f20db3ceac9626e14eeacfbb492e19583cf0e37b22be", [:rebar3], []},
-  "credo": {:hex, :credo, "0.6.0", "44a82f82b94eeb4ba6092c89b8a6730ca1a3291c7940739d5acc8806d25ac991", [:mix], [{:bunt, "~> 0.2.0", [hex: :bunt, optional: false]}]},
-  "dialyxir": {:hex, :dialyxir, "0.5.0", "5bc543f9c28ecd51b99cc1a685a3c2a1a93216990347f259406a910cf048d1d7", [:mix], []},
-  "earmark": {:hex, :earmark, "1.2.0", "bf1ce17aea43ab62f6943b97bd6e3dc032ce45d4f787504e3adf738e54b42f3a", [:mix], []},
-  "ex_doc": {:hex, :ex_doc, "0.15.0", "e73333785eef3488cf9144a6e847d3d647e67d02bd6fdac500687854dd5c599f", [:mix], [{:earmark, "~> 1.1", [hex: :earmark, optional: false]}]},
-  "excoveralls": {:hex, :excoveralls, "0.7.0", "05cb3332c2b0f799df3ab90eb7df1ae5a147c86776e91792848a12b7ed87242f", [:mix], [{:exjsx, ">= 3.0.0", [hex: :exjsx, optional: false]}, {:hackney, ">= 0.12.0", [hex: :hackney, optional: false]}]},
+  "certifi": {:hex, :certifi, "1.2.1", "c3904f192bd5284e5b13f20db3ceac9626e14eeacfbb492e19583cf0e37b22be", [:rebar3], [], "hexpm"},
+  "credo": {:hex, :credo, "0.6.0", "44a82f82b94eeb4ba6092c89b8a6730ca1a3291c7940739d5acc8806d25ac991", [:mix], [{:bunt, "~> 0.2.0", [repo: "hexpm", hex: :bunt, optional: false]}], "hexpm"},
+  "dialyxir": {:hex, :dialyxir, "0.5.0", "5bc543f9c28ecd51b99cc1a685a3c2a1a93216990347f259406a910cf048d1d7", [:mix], [], "hexpm"},
+  "earmark": {:hex, :earmark, "1.2.0", "bf1ce17aea43ab62f6943b97bd6e3dc032ce45d4f787504e3adf738e54b42f3a", [:mix], [], "hexpm"},
+  "ex_doc": {:hex, :ex_doc, "0.15.0", "e73333785eef3488cf9144a6e847d3d647e67d02bd6fdac500687854dd5c599f", [:mix], [{:earmark, "~> 1.1", [repo: "hexpm", hex: :earmark, optional: false]}], "hexpm"},
+  "excoveralls": {:hex, :excoveralls, "0.7.0", "05cb3332c2b0f799df3ab90eb7df1ae5a147c86776e91792848a12b7ed87242f", [:mix], [{:exjsx, ">= 3.0.0", [repo: "hexpm", hex: :exjsx, optional: false]}, {:hackney, ">= 0.12.0", [repo: "hexpm", hex: :hackney, optional: false]}], "hexpm"},
   "exjsx": {:hex, :exjsx, "4.0.0", "60548841e0212df401e38e63c0078ec57b33e7ea49b032c796ccad8cde794b5c", [:mix], [{:jsx, "~> 2.8.0", [hex: :jsx, optional: false]}]},
-  "hackney": {:hex, :hackney, "1.8.6", "21a725db3569b3fb11a6af17d5c5f654052ce9624219f1317e8639183de4a423", [:rebar3], [{:certifi, "1.2.1", [hex: :certifi, optional: false]}, {:idna, "5.0.2", [hex: :idna, optional: false]}, {:metrics, "1.0.1", [hex: :metrics, optional: false]}, {:mimerl, "1.0.2", [hex: :mimerl, optional: false]}, {:ssl_verify_fun, "1.1.1", [hex: :ssl_verify_fun, optional: false]}]},
-  "idna": {:hex, :idna, "5.0.2", "ac203208ada855d95dc591a764b6e87259cb0e2a364218f215ad662daa8cd6b4", [:rebar3], [{:unicode_util_compat, "0.2.0", [hex: :unicode_util_compat, optional: false]}]},
+  "hackney": {:hex, :hackney, "1.8.6", "21a725db3569b3fb11a6af17d5c5f654052ce9624219f1317e8639183de4a423", [:rebar3], [{:certifi, "1.2.1", [repo: "hexpm", hex: :certifi, optional: false]}, {:idna, "5.0.2", [repo: "hexpm", hex: :idna, optional: false]}, {:metrics, "1.0.1", [repo: "hexpm", hex: :metrics, optional: false]}, {:mimerl, "1.0.2", [repo: "hexpm", hex: :mimerl, optional: false]}, {:ssl_verify_fun, "1.1.1", [repo: "hexpm", hex: :ssl_verify_fun, optional: false]}], "hexpm"},
+  "idna": {:hex, :idna, "5.0.2", "ac203208ada855d95dc591a764b6e87259cb0e2a364218f215ad662daa8cd6b4", [:rebar3], [{:unicode_util_compat, "0.2.0", [repo: "hexpm", hex: :unicode_util_compat, optional: false]}], "hexpm"},
   "jsx": {:hex, :jsx, "2.8.2", "7acc7d785b5abe8a6e9adbde926a24e481f29956dd8b4df49e3e4e7bcc92a018", [:mix, :rebar3], []},
   "metrics": {:hex, :metrics, "1.0.1", "25f094dea2cda98213cecc3aeff09e940299d950904393b2a29d191c346a8486", [:rebar3], []},
   "mimerl": {:hex, :mimerl, "1.0.2", "993f9b0e084083405ed8252b99460c4f0563e41729ab42d9074fd5e52439be88", [:rebar3], []},
   "poison": {:hex, :poison, "3.1.0", "d9eb636610e096f86f25d9a46f35a9facac35609a7591b3be3326e99a0484665", [:mix], []},
   "ssl_verify_fun": {:hex, :ssl_verify_fun, "1.1.1", "28a4d65b7f59893bc2c7de786dec1e1555bd742d336043fe644ae956c3497fbe", [:make, :rebar], []},
-  "unicode_util_compat": {:hex, :unicode_util_compat, "0.2.0", "dbbccf6781821b1c0701845eaf966c9b6d83d7c3bfc65ca2b78b88b8678bfa35", [:rebar3], []}}
+  "unicode_util_compat": {:hex, :unicode_util_compat, "0.2.0", "dbbccf6781821b1c0701845eaf966c9b6d83d7c3bfc65ca2b78b88b8678bfa35", [:rebar3], [], "hexpm"}}
