refactor: reorganize validator modules (#48)

Byzanteam · Dec 13, 2024 · 20e3cfb · 20e3cfb
1 parent 4c4cbae
commit 20e3cfb
Show file tree

Hide file tree

Showing 15 changed files with 30 additions and 31 deletions.
diff --git a/...nition/validators/colour_set_validator.ex → ...dators/definition/colour_set_validator.ex b/...nition/validators/colour_set_validator.ex → ...dators/definition/colour_set_validator.ex
@@ -1,4 +1,4 @@
-defmodule ColouredFlow.Definition.Validators.ColourSetValidator do
+defmodule ColouredFlow.Validators.Definition.ColourSetValidator do
   @moduledoc """
   This validator ensures that colour sets within a ColouredFlow definition are valid.
 
@@ -11,7 +11,7 @@ defmodule ColouredFlow.Definition.Validators.ColourSetValidator do
 
   alias ColouredFlow.Definition.ColourSet.Descr
   alias ColouredFlow.Definition.ColouredPetriNet
-  alias ColouredFlow.Definition.Validators.Exceptions.InvalidColourSetError
+  alias ColouredFlow.Validators.Exceptions.InvalidColourSetError
 
   @spec validate(ColouredPetriNet.t()) ::
           {:ok, ColouredPetriNet.t()} | {:error, InvalidColourSetError.t()}

diff --git a/...inition/validators/constants_validator.ex → ...idators/definition/constants_validator.ex b/...inition/validators/constants_validator.ex → ...idators/definition/constants_validator.ex
@@ -1,4 +1,4 @@
-defmodule ColouredFlow.Definition.Validators.ConstantsValidator do
+defmodule ColouredFlow.Validators.Definition.ConstantsValidator do
   @moduledoc """
   This validator ensures that constants within a ColouredFlow definition are valid.
 

diff --git a/...ition/validators/unique_name_validator.ex → ...ators/definition/unique_name_validator.ex b/...ition/validators/unique_name_validator.ex → ...ators/definition/unique_name_validator.ex
@@ -1,4 +1,4 @@
-defmodule ColouredFlow.Definition.Validators.UniqueNameValidator do
+defmodule ColouredFlow.Validators.Definition.UniqueNameValidator do
   @moduledoc """
   This validator ensures that names within a ColouredFlow definition are unique.
   It validates the uniqueness of:
@@ -19,7 +19,7 @@ defmodule ColouredFlow.Definition.Validators.UniqueNameValidator do
   alias ColouredFlow.Definition.Transition
   alias ColouredFlow.Definition.Variable
 
-  alias ColouredFlow.Definition.Validators.Exceptions.UniqueNameViolationError
+  alias ColouredFlow.Validators.Exceptions.UniqueNameViolationError
 
   @spec validate(ColouredPetriNet.t()) ::
           {:ok, ColouredPetriNet.t()} | {:error, UniqueNameViolationError.t()}

diff --git a/...inition/validators/variables_validator.ex → ...idators/definition/variables_validator.ex b/...inition/validators/variables_validator.ex → ...idators/definition/variables_validator.ex
@@ -1,13 +1,13 @@
-defmodule ColouredFlow.Definition.Validators.VariablesValidator do
+defmodule ColouredFlow.Validators.Definition.VariablesValidator do
   @moduledoc """
   The variables validator ensures that the variables in a ColouredFlow definition are valid.
 
   A variable is valid if its colour_set is valid.
   """
 
   alias ColouredFlow.Definition.ColouredPetriNet
-  alias ColouredFlow.Definition.Validators.Exceptions.MissingColourSetError
   alias ColouredFlow.Definition.Variable
+  alias ColouredFlow.Validators.Exceptions.MissingColourSetError
 
   @spec validate(variables, ColouredPetriNet.t()) ::
           {:ok, variables} | {:error, MissingColourSetError.t()}

diff --git a/...nactment/validators/markings_validator.ex → ...alidators/enactment/markings_validator.ex b/...nactment/validators/markings_validator.ex → ...alidators/enactment/markings_validator.ex
@@ -1,4 +1,4 @@
-defmodule ColouredFlow.Enactment.Validators.MarkingsValidator do
+defmodule ColouredFlow.Validators.Enactment.MarkingsValidator do
   @moduledoc """
   The markings validator ensures that the place of markings is valid,
   and that the tokens for the corresponding place are valid.
@@ -10,9 +10,9 @@ defmodule ColouredFlow.Enactment.Validators.MarkingsValidator do
   alias ColouredFlow.Definition.ColourSet.ColourSetMismatch
   alias ColouredFlow.Definition.ColouredPetriNet
   alias ColouredFlow.Definition.Place
-  alias ColouredFlow.Definition.Validators.Exceptions.MissingPlaceError
   alias ColouredFlow.Enactment.Marking
   alias ColouredFlow.MultiSet
+  alias ColouredFlow.Validators.Exceptions.MissingPlaceError
 
   @spec validate(markings, ColouredPetriNet.t()) ::
           {:ok, markings} | {:error, MissingPlaceError.t() | ColourSetMismatch.t()}

diff --git a/...rs/exceptions/invalid_colour_set_error.ex → ...rs/exceptions/invalid_colour_set_error.ex b/...rs/exceptions/invalid_colour_set_error.ex → ...rs/exceptions/invalid_colour_set_error.ex
@@ -1,4 +1,4 @@
-defmodule ColouredFlow.Definition.Validators.Exceptions.InvalidColourSetError do
+defmodule ColouredFlow.Validators.Exceptions.InvalidColourSetError do
   @moduledoc """
   This exception is raised when the colour set is invalid.
   """

diff --git a/...rs/exceptions/missing_colour_set_error.ex → ...rs/exceptions/missing_colour_set_error.ex b/...rs/exceptions/missing_colour_set_error.ex → ...rs/exceptions/missing_colour_set_error.ex
@@ -1,4 +1,4 @@
-defmodule ColouredFlow.Definition.Validators.Exceptions.MissingColourSetError do
+defmodule ColouredFlow.Validators.Exceptions.MissingColourSetError do
   @moduledoc """
   This exception is raised when the colour set is missing,
   but it is referred to by variables, constants, etc.

diff --git a/...idators/exceptions/missing_place_error.ex → ...idators/exceptions/missing_place_error.ex b/...idators/exceptions/missing_place_error.ex → ...idators/exceptions/missing_place_error.ex
@@ -1,4 +1,4 @@
-defmodule ColouredFlow.Definition.Validators.Exceptions.MissingPlaceError do
+defmodule ColouredFlow.Validators.Exceptions.MissingPlaceError do
   @moduledoc """
   This exception is raised when a place is missing,
   e.g., one of the markings is not found in the cpnet.

diff --git a/...exceptions/unique_name_violation_error.ex → ...exceptions/unique_name_violation_error.ex b/...exceptions/unique_name_violation_error.ex → ...exceptions/unique_name_violation_error.ex
@@ -1,6 +1,6 @@
-defmodule ColouredFlow.Definition.Validators.Exceptions.UniqueNameViolationError do
+defmodule ColouredFlow.Validators.Exceptions.UniqueNameViolationError do
   @moduledoc """
-  This exception is raised when a duplicate name violation is detected by the `ColouredFlow.Definition.Validators.UniqueNameValidator`.
+  This exception is raised when a duplicate name violation is detected by the `ColouredFlow.Validators.Definition.UniqueNameValidator`.
   """
 
   use TypedStructor

diff --git a/...n/validators/constants_validator_test.exs → ...s/definition/constants_validator_test.exs b/...n/validators/constants_validator_test.exs → ...s/definition/constants_validator_test.exs
@@ -1,4 +1,4 @@
-defmodule ColouredFlow.Definition.Validators.ConstantsValidatorTest do
+defmodule ColouredFlow.Validators.Definition.ConstantsValidatorTest do
   use ExUnit.Case, async: true
 
   import ColouredFlow.Notation.Colset
@@ -7,7 +7,7 @@ defmodule ColouredFlow.Definition.Validators.ConstantsValidatorTest do
   alias ColouredFlow.Definition.ColouredPetriNet
   alias ColouredFlow.Definition.Constant
 
-  alias ColouredFlow.Definition.Validators.ConstantsValidator
+  alias ColouredFlow.Validators.Definition.ConstantsValidator
 
   setup do
     cpnet = %ColouredPetriNet{

diff --git a/...on/validators/invalid_colour_set_test.exs → ...rs/definition/invalid_colour_set_test.exs b/...on/validators/invalid_colour_set_test.exs → ...rs/definition/invalid_colour_set_test.exs
@@ -1,12 +1,12 @@
-defmodule ColouredFlow.Definition.Validators.InvalidColourSetTest do
+defmodule ColouredFlow.Validators.Definition.InvalidColourSetTest do
   use ExUnit.Case, async: true
 
   alias ColouredFlow.Definition.ColourSet
   alias ColouredFlow.Definition.ColourSet.Descr
   alias ColouredFlow.Definition.ColouredPetriNet
 
-  alias ColouredFlow.Definition.Validators.ColourSetValidator
-  alias ColouredFlow.Definition.Validators.Exceptions.InvalidColourSetError
+  alias ColouredFlow.Validators.Definition.ColourSetValidator
+  alias ColouredFlow.Validators.Exceptions.InvalidColourSetError
 
   test "valid" do
     assert {:ok, _cpnet} =

diff --git a/...validators/unique_name_validator_test.exs → ...definition/unique_name_validator_test.exs b/...validators/unique_name_validator_test.exs → ...definition/unique_name_validator_test.exs
@@ -1,11 +1,11 @@
-defmodule ColouredFlow.Definition.Validators.UniqueNameValidatorTest do
+defmodule ColouredFlow.Validators.Definition.UniqueNameValidatorTest do
   use ExUnit.Case, async: true
 
   use ColouredFlow.DefinitionHelpers
   import ColouredFlow.Notation.Colset
 
-  alias ColouredFlow.Definition.Validators.Exceptions.UniqueNameViolationError
-  alias ColouredFlow.Definition.Validators.UniqueNameValidator
+  alias ColouredFlow.Validators.Definition.UniqueNameValidator
+  alias ColouredFlow.Validators.Exceptions.UniqueNameViolationError
 
   setup :setup_cpnet
 

diff --git a/...n/validators/variables_validator_test.exs → ...s/definition/variables_validator_test.exs b/...n/validators/variables_validator_test.exs → ...s/definition/variables_validator_test.exs
@@ -1,13 +1,12 @@
-defmodule ColouredFlow.Definition.Validators.VariablesValidatorTest do
+defmodule ColouredFlow.Validators.Definition.VariablesValidatorTest do
   use ExUnit.Case, async: true
 
   import ColouredFlow.Notation.Colset
 
   alias ColouredFlow.Definition.ColouredPetriNet
-  alias ColouredFlow.Definition.Validators.Exceptions.MissingColourSetError
   alias ColouredFlow.Definition.Variable
-
-  alias ColouredFlow.Definition.Validators.VariablesValidator
+  alias ColouredFlow.Validators.Definition.VariablesValidator
+  alias ColouredFlow.Validators.Exceptions.MissingColourSetError
 
   setup do
     cpnet = %ColouredPetriNet{

diff --git a/...nt/validators/markings_validator_test.exs → ...ors/enactment/markings_validator_test.exs b/...nt/validators/markings_validator_test.exs → ...ors/enactment/markings_validator_test.exs
@@ -1,4 +1,4 @@
-defmodule ColouredFlow.Enactment.Validators.MarkingsValidatorTest do
+defmodule ColouredFlow.Validators.Enactment.MarkingsValidatorTest do
   use ExUnit.Case, async: true
 
   import ColouredFlow.MultiSet
@@ -7,9 +7,9 @@ defmodule ColouredFlow.Enactment.Validators.MarkingsValidatorTest do
   alias ColouredFlow.Definition.ColourSet.ColourSetMismatch
   alias ColouredFlow.Definition.ColouredPetriNet
   alias ColouredFlow.Definition.Place
-  alias ColouredFlow.Definition.Validators.Exceptions.MissingPlaceError
   alias ColouredFlow.Enactment.Marking
-  alias ColouredFlow.Enactment.Validators.MarkingsValidator
+  alias ColouredFlow.Validators.Enactment.MarkingsValidator
+  alias ColouredFlow.Validators.Exceptions.MissingPlaceError
 
   describe "validate/2" do
     setup do

diff --git a/...definition/validators/exceptions_test.exs → ...oured_flow/validators/exceptions_test.exs b/...definition/validators/exceptions_test.exs → ...oured_flow/validators/exceptions_test.exs
@@ -1,6 +1,6 @@
-defmodule ColouredFlow.Definition.Validators.ExceptionsTest do
+defmodule ColouredFlow.Validators.ExceptionsTest do
   use ExUnit.Case, async: true
-  alias ColouredFlow.Definition.Validators.Exceptions
+  alias ColouredFlow.Validators.Exceptions
 
   test "UniqueNameViolationError.message/1" do
     exception = Exceptions.UniqueNameViolationError.exception(scope: :place, name: "input")