[289509] Move BaseParamStruct to AntikytheraCore

core/handler/gear_error.ex

@@ -58,7 +58,7 @@ defmodule AntikytheraCore.Handler.GearError do
   defun parameter_validation_error(
           conn :: v[Conn.t()],
           parameter_type :: Antikythera.Plug.ParamsValidator.parameter_type_t(),
-          reason :: Antikythera.BaseParamStruct.validate_error_t()
+          reason :: AntikytheraCore.BaseParamStruct.validate_error_t()
         ) :: v[Conn.t()] do
     invoke_error_handler(
       conn,
@@ -72,7 +72,7 @@ defmodule AntikytheraCore.Handler.GearError do
 
   defunp create_default_parameter_validation_error_message(
            parameter_type :: Antikythera.Plug.ParamsValidator.parameter_type_t(),
-           {error_reason, mods} :: Antikythera.BaseParamStruct.validate_error_t()
+           {error_reason, mods} :: AntikytheraCore.BaseParamStruct.validate_error_t()
          ) :: v[String.t()] do
     field_path =
       Enum.flat_map(mods, fn

lib/type/base_param_struct.ex → core/type/base_param_struct.ex

@@ -2,14 +2,12 @@
 
 use Croma
 
-defmodule Antikythera.BaseParamStruct do
+defmodule AntikytheraCore.BaseParamStruct do
   @moduledoc """
   Module to define a struct that represents abstract parameters.
 
   This module is a base module of `Antikythera.ParamStringStruct` and `Antikythera.BodyJsonStruct`.
   See their respective module documents for details.
-
-  It is not recommended to use this module directly from gears.
   """
 
   @type json_value_t() ::
@@ -302,7 +300,7 @@ defmodule Antikythera.BaseParamStruct do
           {field_name, {mod, preprocessor}}
           when is_atom(field_name) and is_atom(mod) and is_function(preprocessor, 1) ->
             {field_name, mod, preprocessor,
-             Antikythera.BaseParamStruct.compute_default_value(mod)}
+             AntikytheraCore.BaseParamStruct.compute_default_value(mod)}
 
           {field_name, {mod, [default: default_value]}}
           when is_atom(field_name) and is_atom(mod) ->
@@ -311,11 +309,11 @@ defmodule Antikythera.BaseParamStruct do
 
           {field_name, mod} when is_atom(field_name) and is_atom(mod) ->
             {field_name, mod, Croma.Result.get(default_pp.(mod), &Function.identity/1),
-             Antikythera.BaseParamStruct.compute_default_value(mod)}
+             AntikytheraCore.BaseParamStruct.compute_default_value(mod)}
         end)
         |> Enum.map(fn {field_name, mod, preprocessor, default_value_opt} ->
           {field_name,
-           Antikythera.BaseParamStruct.compute_accepted_field_names(
+           AntikytheraCore.BaseParamStruct.compute_accepted_field_names(
              field_name,
              opts[:accept_case]
            ), mod, preprocessor, default_value_opt}
@@ -344,7 +342,7 @@ defmodule Antikythera.BaseParamStruct do
 
       defun from_params(params :: term()) :: Croma.Result.t(t()) do
         params when is_map(params) ->
-          Antikythera.BaseParamStruct.preprocess_params(
+          AntikytheraCore.BaseParamStruct.preprocess_params(
             __MODULE__,
             @base_param_struct_fields_with_attrs,
             params
@@ -361,7 +359,7 @@ defmodule Antikythera.BaseParamStruct do
 
       # Override
       def new(dict) do
-        Antikythera.BaseParamStruct.new_impl(
+        AntikytheraCore.BaseParamStruct.new_impl(
           __MODULE__,
           @base_param_struct_fields_with_attrs,
           dict
@@ -370,7 +368,7 @@ defmodule Antikythera.BaseParamStruct do
 
       # Override
       def update(s, dict) do
-        Antikythera.BaseParamStruct.update_impl(
+        AntikytheraCore.BaseParamStruct.update_impl(
           s,
           __MODULE__,
           @base_param_struct_fields_with_accept_fields,
@@ -381,7 +379,7 @@ defmodule Antikythera.BaseParamStruct do
       # Override
       def valid?(%__MODULE__{} = s) do
         Enum.all?(@base_param_struct_fields, fn {field_name, mod} ->
-          Map.fetch!(s, field_name) |> Antikythera.BaseParamStruct.valid_field?(mod)
+          Map.fetch!(s, field_name) |> AntikytheraCore.BaseParamStruct.valid_field?(mod)
         end)
       end
 

lib/gear_application/error_handler.ex

@@ -17,7 +17,7 @@ defmodule Antikythera.GearApplication.ErrorHandler do
       - Optional error handlers
           - `bad_executor_pool_id(Antikythera.Conn.t, Antikythera.ExecutorPool.BadIdReason.t) :: Antikythera.Conn.t`
           - `ws_too_many_connections(Antikythera.Conn.t) :: Antikythera.Conn.t` (when your gear uses websocket)
-          - `parameter_validation_error(Antikythera.Conn.t, Antikythera.Plug.ParamsValidator.parameter_type_t, Antikythera.BaseParamStruct.validate_error_t) :: Antikythera.Conn.t` (when your gear uses parameter validation)
+          - `parameter_validation_error(Antikythera.Conn.t, Antikythera.Plug.ParamsValidator.parameter_type_t, AntikytheraCore.BaseParamStruct.validate_error_t) :: Antikythera.Conn.t` (when your gear uses parameter validation)
 
   This module generates `YourGear.error_handler_module/0` function, which is called by antikythera when handling errors.
   """

lib/type/body_json_list.ex

@@ -51,7 +51,7 @@ defmodule Antikythera.BodyJsonList do
   - `max_length`: The maximum length of the list. If not specified, there is no maximum length.
   """
 
-  alias Antikythera.BaseParamStruct
+  alias AntikytheraCore.BaseParamStruct
   alias Antikythera.BodyJsonStruct
 
   @doc false

lib/type/body_json_map.ex

@@ -54,7 +54,7 @@ defmodule Antikythera.BodyJsonMap do
   - `min_size`: The minimum size of the map. If not specified, there is no minimum size.
   - `max_size`: The maximum size of the map. If not specified, there is no maximum size.
   """
-  alias Antikythera.BaseParamStruct
+  alias AntikytheraCore.BaseParamStruct
   alias Antikythera.BodyJsonStruct
 
   @doc false

lib/type/body_json_struct.ex

@@ -136,7 +136,7 @@ defmodule Antikythera.BodyJsonStruct do
   The preprocessor must be specified as a capture form like `&module.function/1`.
   """
 
-  alias Antikythera.BaseParamStruct
+  alias AntikytheraCore.BaseParamStruct
 
   defmodule Preprocessor do
     @moduledoc false
@@ -166,7 +166,7 @@ defmodule Antikythera.BodyJsonStruct do
           &Antikythera.BodyJsonStruct.Preprocessor.default/1
         )
 
-      use Antikythera.BaseParamStruct, opts_with_default_preprocessor
+      use AntikytheraCore.BaseParamStruct, opts_with_default_preprocessor
     end
   end
 end

lib/type/param_string_struct.ex

@@ -265,7 +265,7 @@ defmodule Antikythera.ParamStringStruct do
           &Antikythera.ParamStringStruct.Preprocessor.default/1
         )
 
-      use Antikythera.BaseParamStruct, opts_with_default_preprocessor
+      use AntikytheraCore.BaseParamStruct, opts_with_default_preprocessor
     end
   end
 end

lib/web/plug/params_validator.ex

@@ -125,7 +125,7 @@ defmodule Antikythera.Plug.ParamsValidator do
            conn :: v[Conn.t()],
            param_type :: parameter_type_t(),
            validator :: v[module()],
-           params :: Antikythera.BaseParamStruct.params_t()
+           params :: AntikytheraCore.BaseParamStruct.params_t()
          ) :: v[Conn.t()] do
     case validator.from_params(params) do
       {:ok, validated_params} ->

test/lib/type/base_param_struct_test.exs

@@ -2,7 +2,7 @@
 
 use Croma
 
-defmodule Antikythera.BaseParamStructTest do
+defmodule AntikytheraCore.BaseParamStructTest do
   use Croma.TestCase
 
   defmodule TestStruct1 do