ash-project/igniter
1
0
Fork 0
mirror of https://github.com/ash-project/igniter.git synced 2024-09-19 13:02:51 +12:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

improvement: add proper_test_support_location/1 (#18)
Some checks are pending
CI / ash-ci (push) Waiting to run
Details

Browse source
This commit is contained in:
Igor Barakaiev 2024-06-26 15:02:29 +03:00 committed by GitHub
parent 1271a75e04
commit a6464db658
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 36 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

39
lib/code/module.ex
View file

@ -4,7 +4,7 @@ defmodule Igniter.Code.Module do
alias Igniter.Code.Common
alias Sourceror.Zipper
@doc "Given a suffix, returns a module name with the prefix of the current project"
@doc "Given a suffix, returns a module name with the prefix of the current project."
@spec module_name(String.t()) :: module()
def module_name(suffix) do
Module.concat(module_name_prefix(), suffix)
@ -12,22 +12,49 @@ defmodule Igniter.Code.Module do
@doc """
Returns the idiomatic file location for a given module, starting with "lib/".
Examples:
iex> Igniter.Code.Module.proper_location(MyApp.Hello)
"lib/my_app/hello.ex"
"""
@spec proper_location(module()) :: Path.t()
def proper_location(module_name) do
do_proper_test_location(module_name)
do_proper_test_location(module_name, :lib)
end
@doc """
Returns the test file location for a given module, according to
`mix test` expectations, starting with "test/" and ending with "_test.exs"
`mix test` expectations, starting with "test/" and ending with "_test.exs".
Examples:
iex> Igniter.Code.Module.proper_test_location(MyApp.Hello)
"test/my_app/hello_test.exs"
iex> Igniter.Code.Module.proper_test_location(MyApp.HelloTest)
"test/my_app/hello_test.exs"
"""
@spec proper_test_location(module()) :: Path.t()
def proper_test_location(module_name) do
do_proper_test_location(module_name, :test)
end
defp do_proper_test_location(module_name, kind \\ :lib) do
@doc """
Returns the test support location for a given module, starting with
"test/support/" and dropping the module name prefix in the path.
Examples:
iex> Igniter.Code.Module.proper_test_support_location(MyApp.DataCase)
"test/support/data_case.ex"
"""
@spec proper_test_support_location(module()) :: Path.t()
def proper_test_support_location(module_name) do
do_proper_test_location(module_name, :test_support)
end
defp do_proper_test_location(module_name, kind) do
path =
module_name
|> Module.split()
@ -47,6 +74,10 @@ defmodule Igniter.Code.Module do
else
Path.join(["test" | leading] ++ ["#{last}_test.exs"])
end
:test_support ->
[_prefix | leading_rest] = leading
Path.join(["test/support" | leading_rest] ++ ["#{last}.ex"])
end
end

15
test/code/module_test.exs
View file

@ -1,18 +1,5 @@
defmodule Igniter.Code.ModuleTest do
use ExUnit.Case
test "proper_location/1 returns idiomatic path" do
assert "lib/my_app/hello.ex" = Igniter.Code.Module.proper_location(MyApp.Hello)
end
describe "proper_test_location/1" do
test "returns a path with _test appended if the module name doesn't end with Test" do
assert "test/my_app/hello_test.exs" = Igniter.Code.Module.proper_test_location(MyApp.Hello)
end
test "returns a path without appending _test if the module name already ends with Test" do
assert "test/my_app/hello_test.exs" =
Igniter.Code.Module.proper_test_location(MyApp.HelloTest)
end
end
doctest Igniter.Code.Module
end