Contexts (#58)

* Contexts: restructuring -> more encapsulation

Trying to restructure the project a bit such that everything parser related is
found inside the `lib/parser` folder and that `lib/parser.ex` defines the
'facade' of the these submodules. Likewise, for printer related modules in
`lib/printer`.  However, this exercise isn't very doable for the `lib/types`
folder, so have to consider if I'm gaining anything from going down this road
for types.

* Adds contexts 'parser' and 'printer'

We isolate all parser related code in the 'parser' folder and expose the
parser.ex module as the interface for that folder / context.

We repeat this exercise for the 'printer' folder / context.

Furthermore, we remove all the import statements and replace them with more
explicit aliases.

Closes #57

Author: dragonwasrobot

lib/js2e.ex

@@ -19,9 +19,9 @@ defmodule JS2E do
 
   require Logger
   alias JS2E.Parser
+  alias JS2E.Parser.{ParserWarning, ParserError}
   alias JS2E.Printer
-  alias JS2E.Parsers.{ParserWarning, ParserError}
-  alias JS2E.Printers.PrinterError
+  alias JS2E.Printer.PrinterError
 
   @spec main([String.t()]) :: :ok
   def main(args) do
@@ -135,7 +135,7 @@ defmodule JS2E do
               String.replace(module_name, ".", "/")
             )
 
-          Logger.debug("Writing file '#{file_path}'")
+          Logger.debug(fn -> "Writing file '#{file_path}'" end)
           {:ok, file} = File.open(normalized_file_path, [:write])
           IO.binwrite(file, file_content)
           File.close(file)

lib/parsers/all_of_parser.ex renamed to lib/parser/all_of_parser.ex

@@ -1,5 +1,5 @@
-defmodule JS2E.Parsers.AllOfParser do
-  @behaviour JS2E.Parsers.ParserBehaviour
+defmodule JS2E.Parser.AllOfParser do
+  @behaviour JS2E.Parser.ParserBehaviour
   @moduledoc ~S"""
   Parses a JSON schema allOf type:
 
@@ -30,15 +30,7 @@ defmodule JS2E.Parsers.AllOfParser do
   """
 
   require Logger
-
-  import JS2E.Parsers.Util,
-    only: [
-      parse_child_types: 3,
-      create_types_list: 2,
-      create_type_dict: 3
-    ]
-
-  alias JS2E.Parsers.{ErrorUtil, ParserResult}
+  alias JS2E.Parser.{Util, ErrorUtil, ParserResult}
   alias JS2E.{Types, TypePath}
   alias JS2E.Types.AllOfType
 
@@ -57,7 +49,7 @@ defmodule JS2E.Parsers.AllOfParser do
   true
 
   """
-  @impl JS2E.Parsers.ParserBehaviour
+  @impl JS2E.Parser.ParserBehaviour
   @spec type?(Types.node()) :: boolean
   def type?(%{"allOf" => all_of})
       when is_list(all_of) and length(all_of) > 0,
@@ -68,7 +60,7 @@ defmodule JS2E.Parsers.AllOfParser do
   @doc ~S"""
   Parses a JSON schema allOf type into an `JS2E.Types.AllOfType`.
   """
-  @impl JS2E.Parsers.ParserBehaviour
+  @impl JS2E.Parser.ParserBehaviour
   @spec parse(Types.node(), URI.t(), URI.t() | nil, TypePath.t(), String.t()) ::
           ParserResult.t()
   def parse(%{"allOf" => all_of}, parent_id, id, path, name)
@@ -77,16 +69,16 @@ defmodule JS2E.Parsers.AllOfParser do
 
     child_types_result =
       all_of
-      |> parse_child_types(parent_id, child_path)
+      |> Util.parse_child_types(parent_id, child_path)
 
     all_of_types =
       child_types_result.type_dict
-      |> create_types_list(child_path)
+      |> Util.create_types_list(child_path)
 
     all_of_type = AllOfType.new(name, path, all_of_types)
 
     all_of_type
-    |> create_type_dict(path, id)
+    |> Util.create_type_dict(path, id)
     |> ParserResult.new()
     |> ParserResult.merge(child_types_result)
   end

lib/parsers/any_of_parser.ex renamed to lib/parser/any_of_parser.ex

@@ -1,5 +1,5 @@
-defmodule JS2E.Parsers.AnyOfParser do
-  @behaviour JS2E.Parsers.ParserBehaviour
+defmodule JS2E.Parser.AnyOfParser do
+  @behaviour JS2E.Parser.ParserBehaviour
   @moduledoc ~S"""
   Parses a JSON schema anyOf type:
 
@@ -30,15 +30,7 @@ defmodule JS2E.Parsers.AnyOfParser do
   """
 
   require Logger
-
-  import JS2E.Parsers.Util,
-    only: [
-      parse_child_types: 3,
-      create_types_list: 2,
-      create_type_dict: 3
-    ]
-
-  alias JS2E.Parsers.{ErrorUtil, ParserResult}
+  alias JS2E.Parser.{Util, ErrorUtil, ParserResult}
   alias JS2E.{Types, TypePath}
   alias JS2E.Types.AnyOfType
 
@@ -57,7 +49,7 @@ defmodule JS2E.Parsers.AnyOfParser do
   true
 
   """
-  @impl JS2E.Parsers.ParserBehaviour
+  @impl JS2E.Parser.ParserBehaviour
   @spec type?(Types.schemaNode()) :: boolean
   def type?(schema_node) do
     any_of = schema_node["anyOf"]
@@ -67,7 +59,7 @@ defmodule JS2E.Parsers.AnyOfParser do
   @doc ~S"""
   Parses a JSON schema anyOf type into an `JS2E.Types.AnyOfType`.
   """
-  @impl JS2E.Parsers.ParserBehaviour
+  @impl JS2E.Parser.ParserBehaviour
   @spec parse(
           Types.schemaNode(),
           URI.t(),
@@ -81,16 +73,16 @@ defmodule JS2E.Parsers.AnyOfParser do
 
     child_types_result =
       any_of
-      |> parse_child_types(parent_id, child_path)
+      |> Util.parse_child_types(parent_id, child_path)
 
     any_of_types =
       child_types_result.type_dict
-      |> create_types_list(child_path)
+      |> Util.create_types_list(child_path)
 
     any_of_type = AnyOfType.new(name, path, any_of_types)
 
     any_of_type
-    |> create_type_dict(path, id)
+    |> Util.create_type_dict(path, id)
     |> ParserResult.new()
     |> ParserResult.merge(child_types_result)
   end

lib/parsers/array_parser.ex renamed to lib/parser/array_parser.ex

@@ -1,5 +1,5 @@
-defmodule JS2E.Parsers.ArrayParser do
-  @behaviour JS2E.Parsers.ParserBehaviour
+defmodule JS2E.Parser.ArrayParser do
+  @behaviour JS2E.Parser.ParserBehaviour
   @moduledoc ~S"""
   Parses a JSON schema array type:
 
@@ -15,14 +15,8 @@ defmodule JS2E.Parsers.ArrayParser do
 
   require Logger
 
-  import JS2E.Parsers.Util,
-    only: [
-      create_type_dict: 3,
-      parse_type: 4
-    ]
-
   alias JS2E.{Types, TypePath}
-  alias JS2E.Parsers.ParserResult
+  alias JS2E.Parser.{Util, ParserResult}
   alias JS2E.Types.ArrayType
 
   @doc ~S"""
@@ -40,7 +34,7 @@ defmodule JS2E.Parsers.ArrayParser do
   true
 
   """
-  @impl JS2E.Parsers.ParserBehaviour
+  @impl JS2E.Parser.ParserBehaviour
   @spec type?(Types.schemaNode()) :: boolean
   def type?(schema_node) do
     type = schema_node["type"]
@@ -51,7 +45,7 @@ defmodule JS2E.Parsers.ArrayParser do
   @doc ~S"""
   Parses a JSON schema array type into an `JS2E.Types.ArrayType`.
   """
-  @impl JS2E.Parsers.ParserBehaviour
+  @impl JS2E.Parser.ParserBehaviour
   @spec parse(
           Types.schemaNode(),
           URI.t(),
@@ -67,12 +61,12 @@ defmodule JS2E.Parsers.ArrayParser do
     items_result =
       schema_node
       |> Map.get("items")
-      |> parse_type(parent_id, path, "items")
+      |> Util.parse_type(parent_id, path, "items")
 
     array_type = ArrayType.new(name, path, items_abs_path)
 
     array_type
-    |> create_type_dict(path, id)
+    |> Util.create_type_dict(path, id)
     |> ParserResult.new()
     |> ParserResult.merge(items_result)
   end

lib/parsers/definitions_parser.ex renamed to lib/parser/definitions_parser.ex

@@ -1,5 +1,5 @@
-defmodule JS2E.Parsers.DefinitionsParser do
-  @behaviour JS2E.Parsers.ParserBehaviour
+defmodule JS2E.Parser.DefinitionsParser do
+  @behaviour JS2E.Parser.ParserBehaviour
   @moduledoc ~S"""
   Parses a 'definitions' property in a JSON schema or subschema.
 
@@ -17,13 +17,8 @@ defmodule JS2E.Parsers.DefinitionsParser do
 
   require Logger
 
-  import JS2E.Parsers.Util,
-    only: [
-      parse_type: 4
-    ]
-
   alias JS2E.TypePath
-  alias JS2E.Parsers.ParserResult
+  alias JS2E.Parser.{Util, ParserResult}
 
   @doc ~S"""
   Returns true if the json schema contains a 'definitions' property.
@@ -37,7 +32,7 @@ defmodule JS2E.Parsers.DefinitionsParser do
   true
 
   """
-  @impl JS2E.Parsers.ParserBehaviour
+  @impl JS2E.Parser.ParserBehaviour
   @spec type?(map) :: boolean
   def type?(%{"definitions" => definitions})
       when is_map(definitions),
@@ -48,7 +43,7 @@ defmodule JS2E.Parsers.DefinitionsParser do
   @doc ~S"""
   Parses a JSON schema 'definitions' property into a map of types.
   """
-  @impl JS2E.Parsers.ParserBehaviour
+  @impl JS2E.Parser.ParserBehaviour
   @spec parse(map, URI.t(), URI.t() | nil, TypePath.t(), String.t()) ::
           ParserResult.t()
   def parse(%{"definitions" => definitions}, parent_id, _id, path, _name) do
@@ -61,7 +56,9 @@ defmodule JS2E.Parsers.DefinitionsParser do
     definitions_types_result =
       definitions
       |> Enum.reduce(init_result, fn {child_name, child_node}, acc_result ->
-        child_types = parse_type(child_node, parent_id, child_path, child_name)
+        child_types =
+          Util.parse_type(child_node, parent_id, child_path, child_name)
+
         ParserResult.merge(acc_result, child_types)
       end)
 

lib/parsers/enum_parser.ex renamed to lib/parser/enum_parser.ex

@@ -1,5 +1,5 @@
-defmodule JS2E.Parsers.EnumParser do
-  @behaviour JS2E.Parsers.ParserBehaviour
+defmodule JS2E.Parser.EnumParser do
+  @behaviour JS2E.Parser.ParserBehaviour
   @moduledoc ~S"""
   Parse a JSON schema enum type:
 
@@ -12,14 +12,8 @@ defmodule JS2E.Parsers.EnumParser do
   """
 
   require Logger
-
-  import JS2E.Parsers.Util,
-    only: [
-      create_type_dict: 3
-    ]
-
   alias JS2E.{Types, TypePath}
-  alias JS2E.Parsers.ParserResult
+  alias JS2E.Parser.{Util, ParserResult}
   alias JS2E.Types.EnumType
 
   @doc ~S"""
@@ -34,7 +28,7 @@ defmodule JS2E.Parsers.EnumParser do
   true
 
   """
-  @impl JS2E.Parsers.ParserBehaviour
+  @impl JS2E.Parser.ParserBehaviour
   @spec type?(Types.schemaNode()) :: boolean
   def type?(%{"enum" => enum, "type" => type})
       when is_list(enum) and is_binary(type),
@@ -45,7 +39,7 @@ defmodule JS2E.Parsers.EnumParser do
   @doc ~S"""
   Parses a JSON schema enum type into an `JS2E.Types.EnumType`.
   """
-  @impl JS2E.Parsers.ParserBehaviour
+  @impl JS2E.Parser.ParserBehaviour
   @spec parse(
           Types.schemaNode(),
           URI.t(),
@@ -59,7 +53,7 @@ defmodule JS2E.Parsers.EnumParser do
     enum_type = EnumType.new(name, path, type, enum)
 
     enum_type
-    |> create_type_dict(path, id)
+    |> Util.create_type_dict(path, id)
     |> ParserResult.new()
   end
 end

lib/parsers/error_util.ex renamed to lib/parser/error_util.ex

@@ -1,10 +1,10 @@
-defmodule JS2E.Parsers.ErrorUtil do
+defmodule JS2E.Parser.ErrorUtil do
   @moduledoc ~S"""
   Contains helper functions for reporting parser errors.
   """
 
   alias JS2E.{Types, TypePath}
-  alias JS2E.Parsers.ParserError
+  alias JS2E.Parser.ParserError
 
   @doc ~S"""
   Returns the name of the type of the given value.

lib/parsers/object_parser.ex renamed to lib/parser/object_parser.ex

@@ -1,5 +1,5 @@
-defmodule JS2E.Parsers.ObjectParser do
-  @behaviour JS2E.Parsers.ParserBehaviour
+defmodule JS2E.Parser.ObjectParser do
+  @behaviour JS2E.Parser.ParserBehaviour
   @moduledoc ~S"""
   Parses a JSON schema object type:
 
@@ -23,15 +23,8 @@ defmodule JS2E.Parsers.ObjectParser do
   """
 
   require Logger
-
-  import JS2E.Parsers.Util,
-    only: [
-      create_type_dict: 3,
-      parse_type: 4
-    ]
-
   alias JS2E.{Types, TypePath}
-  alias JS2E.Parsers.ParserResult
+  alias JS2E.Parser.{Util, ParserResult}
   alias JS2E.Types.ObjectType
 
   @doc ~S"""
@@ -51,7 +44,7 @@ defmodule JS2E.Parsers.ObjectParser do
   true
 
   """
-  @impl JS2E.Parsers.ParserBehaviour
+  @impl JS2E.Parser.ParserBehaviour
   @spec type?(map) :: boolean
   def type?(schema_node) do
     type = schema_node["type"]
@@ -62,7 +55,7 @@ defmodule JS2E.Parsers.ObjectParser do
   @doc ~S"""
   Parses a JSON schema object type into an `JS2E.Types.ObjectType`.
   """
-  @impl JS2E.Parsers.ParserBehaviour
+  @impl JS2E.Parser.ParserBehaviour
   @spec parse(Types.schemaNode(), URI.t(), URI.t(), TypePath.t(), String.t()) ::
           ParserResult.t()
   def parse(schema_node, parent_id, id, path, name) do
@@ -80,7 +73,7 @@ defmodule JS2E.Parsers.ObjectParser do
     object_type = ObjectType.new(name, path, type_dict, required)
 
     object_type
-    |> create_type_dict(path, id)
+    |> Util.create_type_dict(path, id)
     |> ParserResult.new()
     |> ParserResult.merge(child_types_result)
   end
@@ -91,7 +84,9 @@ defmodule JS2E.Parsers.ObjectParser do
 
     node_properties
     |> Enum.reduce(init_result, fn {child_name, child_node}, acc_result ->
-      child_types = parse_type(child_node, parent_id, child_path, child_name)
+      child_types =
+        Util.parse_type(child_node, parent_id, child_path, child_name)
+
       ParserResult.merge(acc_result, child_types)
     end)
   end
@@ -103,7 +98,7 @@ defmodule JS2E.Parsers.ObjectParser do
 
       iex> type_dict = %{}
       ...> path = JS2E.TypePath.from_string("#")
-      ...> JS2E.Parsers.ObjectParser.create_property_dict(type_dict, path)
+      ...> JS2E.Parser.ObjectParser.create_property_dict(type_dict, path)
       %{}
 
   """