feat: add Factories::define() to explicitly override a class by kenjis · Pull Request #7733 · codeigniter4/CodeIgniter4

kenjis · 2023-07-24T07:09:29Z

Description
Fixes#7694

add Factories::define() to explicitly override a class
[BC] preferApp works only for no namespaced classname
[BC] rename Factories::$basenames to $aliases

I would like to deprecate preferApp option.

Changes
Property structure:

$basenames = [component => [basename => FQCN]];
↓
$aliases = [component => [alias => FQCN]];

basename is a short classname, or short classname with sub-directories.
alias is a FQCN, short classname, or short classname with sub-directories.
Factories::define() sets $aliases.

Behavior:

model(\Myth\Auth\Models\UserModel::class) or model('Myth\Auth\Models\UserModel')
- before:
  - returns App\Models\UserModel if exists and preferApp is true
  - returns Myth\Auth\Models\UserModel if exists and preferApp is false
- after:
  - returns Myth\Auth\Models\UserModel even if preferApp is true
  - returns App\Models\UserModel if you define Factories::define('models', 'Myth\Auth\Models\UserModel', 'App\Models\UserModel') before the first call of the model()

Checklist:

Securely signed commits
Component(s) with PHPDoc blocks, only if necessary or adds value
Unit testing, with >80% coverage
User guide updated
Conforms to style guide

MGatner

Can you give an example of how this would affect an existing workflow? For example right now Myth:Auth controller might use:

$user = model('UserModel')->find($userId);

... and a developer would supply app/Models/UserModel.php to override. With this update, would the developer need to add something to boot like:

useApp\Models\UserModel;
Factories::define('models', 'UserModel', UserModel::class);

?

MGatner · 2023-07-24T11:23:53Z

+ * @param string $name Classname. The first parameter of Factories magic method
+ * @param string $classname FQCN to load


These can get mixed up very easily. Let's stick to something like "shortname" for the unqualified version.
Suggested change
* @param string $name Classname. The first parameter of Factories magic method
* @param string $classnameFQCN to load
* @param string $name Class shortname. The first parameter of Factories magic method
* @param string $classnameFQCN to load

Or I see I called it "basename" below. Doesn't matter as long as we are consistent.

I introduced a new term "class alias".

MGatner · 2023-07-24T11:30:38Z

- if ($options['preferApp'] && class_exists($appname) && self::verifyInstanceOf($options, $name)) {
+ if (
+ // preferApp is used only for no namespace class.
+ strpos($name, '\\') === false


Is this the only breaking change? It seems like the rest of this PR could be rolled out separately without as big an impact.

Perhaps.
And it is what I want to change. Also it is Paul's opinion. See #7694 (comment)

kenjis · 2023-07-25T01:21:09Z

@MGatner No. model('UserModel') specifies no namespaced classname 'UserModel'. So Factories look for App\Models\UserModel (preferApp works).

But if there is code like model(\Myth\Auth\Models\UserModel::class) or model('Myth\Auth\Models\UserModel'), Factories returns Myth\Auth\Models\UserModel if you don't define anything.

MGatner

Nice work!

Except for Config, if FQCN is specified, preferApp is ignored and that class is loaded.

…instance as `Config\Validation` When you call `Factories::injectMock('config', 'Validation', $config)`, but if the production code calls `config(\Config\Validation::class)`, the mock instance will not be used and fail the test: CodeIgniter\Database\ModelFactoryTest::testBasenameReturnsExistingNamespaceInstance

preferApp should work only for no namespaced (Config) classname.

kenjis · 2023-07-26T02:35:42Z

Rebased and added commits from a3c768atest: add test.

kenjis · 2023-07-24T07:09:29Z

Description
Fixes#7694

add Factories::define() to explicitly override a class
[BC] preferApp works only for no namespaced classname
[BC] rename Factories::$basenames to $aliases

I would like to deprecate preferApp option.

Changes
Property structure:

$basenames = [component => [basename => FQCN]];
↓
$aliases = [component => [alias => FQCN]];

basename is a short classname, or short classname with sub-directories.
alias is a FQCN, short classname, or short classname with sub-directories.
Factories::define() sets $aliases.

Behavior:

model(\Myth\Auth\Models\UserModel::class) or model('Myth\Auth\Models\UserModel')
- before:
  - returns App\Models\UserModel if exists and preferApp is true
  - returns Myth\Auth\Models\UserModel if exists and preferApp is false
- after:
  - returns Myth\Auth\Models\UserModel even if preferApp is true
  - returns App\Models\UserModel if you define Factories::define('models', 'Myth\Auth\Models\UserModel', 'App\Models\UserModel') before the first call of the model()

Checklist:

Securely signed commits
Component(s) with PHPDoc blocks, only if necessary or adds value
Unit testing, with >80% coverage
User guide updated
Conforms to style guide

MGatner

Can you give an example of how this would affect an existing workflow? For example right now Myth:Auth controller might use:

$user = model('UserModel')->find($userId);

... and a developer would supply app/Models/UserModel.php to override. With this update, would the developer need to add something to boot like:

useApp\Models\UserModel;
Factories::define('models', 'UserModel', UserModel::class);

?

MGatner · 2023-07-24T11:23:53Z

+ * @param string $name Classname. The first parameter of Factories magic method
+ * @param string $classname FQCN to load


These can get mixed up very easily. Let's stick to something like "shortname" for the unqualified version.
Suggested change
* @param string $name Classname. The first parameter of Factories magic method
* @param string $classnameFQCN to load
* @param string $name Class shortname. The first parameter of Factories magic method
* @param string $classnameFQCN to load

Or I see I called it "basename" below. Doesn't matter as long as we are consistent.

I introduced a new term "class alias".

MGatner · 2023-07-24T11:30:38Z

- if ($options['preferApp'] && class_exists($appname) && self::verifyInstanceOf($options, $name)) {
+ if (
+ // preferApp is used only for no namespace class.
+ strpos($name, '\\') === false


Is this the only breaking change? It seems like the rest of this PR could be rolled out separately without as big an impact.

Perhaps.
And it is what I want to change. Also it is Paul's opinion. See #7694 (comment)

kenjis · 2023-07-25T01:21:09Z

@MGatner No. model('UserModel') specifies no namespaced classname 'UserModel'. So Factories look for App\Models\UserModel (preferApp works).

But if there is code like model(\Myth\Auth\Models\UserModel::class) or model('Myth\Auth\Models\UserModel'), Factories returns Myth\Auth\Models\UserModel if you don't define anything.

MGatner

Nice work!

Except for Config, if FQCN is specified, preferApp is ignored and that class is loaded.

…instance as `Config\Validation` When you call `Factories::injectMock('config', 'Validation', $config)`, but if the production code calls `config(\Config\Validation::class)`, the mock instance will not be used and fail the test: CodeIgniter\Database\ModelFactoryTest::testBasenameReturnsExistingNamespaceInstance

preferApp should work only for no namespaced (Config) classname.

kenjis · 2023-07-26T02:35:42Z

Rebased and added commits from a3c768atest: add test.

kenjis · 2023-07-24T07:09:29Z

Description
Fixes#7694

add Factories::define() to explicitly override a class
[BC] preferApp works only for no namespaced classname
[BC] rename Factories::$basenames to $aliases

I would like to deprecate preferApp option.

Changes
Property structure:

$basenames = [component => [basename => FQCN]];
↓
$aliases = [component => [alias => FQCN]];

basename is a short classname, or short classname with sub-directories.
alias is a FQCN, short classname, or short classname with sub-directories.
Factories::define() sets $aliases.

Behavior:

model(\Myth\Auth\Models\UserModel::class) or model('Myth\Auth\Models\UserModel')
- before:
  - returns App\Models\UserModel if exists and preferApp is true
  - returns Myth\Auth\Models\UserModel if exists and preferApp is false
- after:
  - returns Myth\Auth\Models\UserModel even if preferApp is true
  - returns App\Models\UserModel if you define Factories::define('models', 'Myth\Auth\Models\UserModel', 'App\Models\UserModel') before the first call of the model()

Checklist:

Securely signed commits
Component(s) with PHPDoc blocks, only if necessary or adds value
Unit testing, with >80% coverage
User guide updated
Conforms to style guide

MGatner

Can you give an example of how this would affect an existing workflow? For example right now Myth:Auth controller might use:

$user = model('UserModel')->find($userId);

... and a developer would supply app/Models/UserModel.php to override. With this update, would the developer need to add something to boot like:

useApp\Models\UserModel;
Factories::define('models', 'UserModel', UserModel::class);

?

MGatner · 2023-07-24T11:23:53Z

+ * @param string $name Classname. The first parameter of Factories magic method
+ * @param string $classname FQCN to load


These can get mixed up very easily. Let's stick to something like "shortname" for the unqualified version.
Suggested change
* @param string $name Classname. The first parameter of Factories magic method
* @param string $classnameFQCN to load
* @param string $name Class shortname. The first parameter of Factories magic method
* @param string $classnameFQCN to load

Or I see I called it "basename" below. Doesn't matter as long as we are consistent.

I introduced a new term "class alias".

MGatner · 2023-07-24T11:30:38Z

- if ($options['preferApp'] && class_exists($appname) && self::verifyInstanceOf($options, $name)) {
+ if (
+ // preferApp is used only for no namespace class.
+ strpos($name, '\\') === false


Is this the only breaking change? It seems like the rest of this PR could be rolled out separately without as big an impact.

Perhaps.
And it is what I want to change. Also it is Paul's opinion. See #7694 (comment)

kenjis · 2023-07-25T01:21:09Z

@MGatner No. model('UserModel') specifies no namespaced classname 'UserModel'. So Factories look for App\Models\UserModel (preferApp works).

But if there is code like model(\Myth\Auth\Models\UserModel::class) or model('Myth\Auth\Models\UserModel'), Factories returns Myth\Auth\Models\UserModel if you don't define anything.

MGatner

Nice work!

Except for Config, if FQCN is specified, preferApp is ignored and that class is loaded.

…instance as `Config\Validation` When you call `Factories::injectMock('config', 'Validation', $config)`, but if the production code calls `config(\Config\Validation::class)`, the mock instance will not be used and fail the test: CodeIgniter\Database\ModelFactoryTest::testBasenameReturnsExistingNamespaceInstance

preferApp should work only for no namespaced (Config) classname.

kenjis · 2023-07-26T02:35:42Z

Rebased and added commits from a3c768atest: add test.

kenjis · 2023-07-24T07:09:29Z

Description
Fixes#7694

add Factories::define() to explicitly override a class
[BC] preferApp works only for no namespaced classname
[BC] rename Factories::$basenames to $aliases

I would like to deprecate preferApp option.

Changes
Property structure:

$basenames = [component => [basename => FQCN]];
↓
$aliases = [component => [alias => FQCN]];

basename is a short classname, or short classname with sub-directories.
alias is a FQCN, short classname, or short classname with sub-directories.
Factories::define() sets $aliases.

Behavior:

model(\Myth\Auth\Models\UserModel::class) or model('Myth\Auth\Models\UserModel')
- before:
  - returns App\Models\UserModel if exists and preferApp is true
  - returns Myth\Auth\Models\UserModel if exists and preferApp is false
- after:
  - returns Myth\Auth\Models\UserModel even if preferApp is true
  - returns App\Models\UserModel if you define Factories::define('models', 'Myth\Auth\Models\UserModel', 'App\Models\UserModel') before the first call of the model()

Checklist:

Securely signed commits
Component(s) with PHPDoc blocks, only if necessary or adds value
Unit testing, with >80% coverage
User guide updated
Conforms to style guide

MGatner

Can you give an example of how this would affect an existing workflow? For example right now Myth:Auth controller might use:

$user = model('UserModel')->find($userId);

... and a developer would supply app/Models/UserModel.php to override. With this update, would the developer need to add something to boot like:

useApp\Models\UserModel;
Factories::define('models', 'UserModel', UserModel::class);

?

MGatner · 2023-07-24T11:23:53Z

+ * @param string $name Classname. The first parameter of Factories magic method
+ * @param string $classname FQCN to load


These can get mixed up very easily. Let's stick to something like "shortname" for the unqualified version.
Suggested change
* @param string $name Classname. The first parameter of Factories magic method
* @param string $classnameFQCN to load
* @param string $name Class shortname. The first parameter of Factories magic method
* @param string $classnameFQCN to load

Or I see I called it "basename" below. Doesn't matter as long as we are consistent.

I introduced a new term "class alias".

MGatner · 2023-07-24T11:30:38Z

- if ($options['preferApp'] && class_exists($appname) && self::verifyInstanceOf($options, $name)) {
+ if (
+ // preferApp is used only for no namespace class.
+ strpos($name, '\\') === false


Is this the only breaking change? It seems like the rest of this PR could be rolled out separately without as big an impact.

Perhaps.
And it is what I want to change. Also it is Paul's opinion. See #7694 (comment)

kenjis · 2023-07-25T01:21:09Z

@MGatner No. model('UserModel') specifies no namespaced classname 'UserModel'. So Factories look for App\Models\UserModel (preferApp works).

But if there is code like model(\Myth\Auth\Models\UserModel::class) or model('Myth\Auth\Models\UserModel'), Factories returns Myth\Auth\Models\UserModel if you don't define anything.

MGatner

Nice work!

Except for Config, if FQCN is specified, preferApp is ignored and that class is loaded.

…instance as `Config\Validation` When you call `Factories::injectMock('config', 'Validation', $config)`, but if the production code calls `config(\Config\Validation::class)`, the mock instance will not be used and fail the test: CodeIgniter\Database\ModelFactoryTest::testBasenameReturnsExistingNamespaceInstance

preferApp should work only for no namespaced (Config) classname.

kenjis · 2023-07-26T02:35:42Z

Rebased and added commits from a3c768atest: add test.

kenjis · 2023-07-24T07:09:29Z

Description
Fixes#7694

add Factories::define() to explicitly override a class
[BC] preferApp works only for no namespaced classname
[BC] rename Factories::$basenames to $aliases

I would like to deprecate preferApp option.

Changes
Property structure:

$basenames = [component => [basename => FQCN]];
↓
$aliases = [component => [alias => FQCN]];

basename is a short classname, or short classname with sub-directories.
alias is a FQCN, short classname, or short classname with sub-directories.
Factories::define() sets $aliases.

Behavior:

model(\Myth\Auth\Models\UserModel::class) or model('Myth\Auth\Models\UserModel')
- before:
  - returns App\Models\UserModel if exists and preferApp is true
  - returns Myth\Auth\Models\UserModel if exists and preferApp is false
- after:
  - returns Myth\Auth\Models\UserModel even if preferApp is true
  - returns App\Models\UserModel if you define Factories::define('models', 'Myth\Auth\Models\UserModel', 'App\Models\UserModel') before the first call of the model()

Checklist:

Securely signed commits
Component(s) with PHPDoc blocks, only if necessary or adds value
Unit testing, with >80% coverage
User guide updated
Conforms to style guide

MGatner

Can you give an example of how this would affect an existing workflow? For example right now Myth:Auth controller might use:

$user = model('UserModel')->find($userId);

... and a developer would supply app/Models/UserModel.php to override. With this update, would the developer need to add something to boot like:

useApp\Models\UserModel;
Factories::define('models', 'UserModel', UserModel::class);

?

MGatner · 2023-07-24T11:23:53Z

+ * @param string $name Classname. The first parameter of Factories magic method
+ * @param string $classname FQCN to load


These can get mixed up very easily. Let's stick to something like "shortname" for the unqualified version.
Suggested change
* @param string $name Classname. The first parameter of Factories magic method
* @param string $classnameFQCN to load
* @param string $name Class shortname. The first parameter of Factories magic method
* @param string $classnameFQCN to load

Or I see I called it "basename" below. Doesn't matter as long as we are consistent.

I introduced a new term "class alias".

MGatner · 2023-07-24T11:30:38Z

- if ($options['preferApp'] && class_exists($appname) && self::verifyInstanceOf($options, $name)) {
+ if (
+ // preferApp is used only for no namespace class.
+ strpos($name, '\\') === false


Is this the only breaking change? It seems like the rest of this PR could be rolled out separately without as big an impact.

Perhaps.
And it is what I want to change. Also it is Paul's opinion. See #7694 (comment)

kenjis · 2023-07-25T01:21:09Z

@MGatner No. model('UserModel') specifies no namespaced classname 'UserModel'. So Factories look for App\Models\UserModel (preferApp works).

But if there is code like model(\Myth\Auth\Models\UserModel::class) or model('Myth\Auth\Models\UserModel'), Factories returns Myth\Auth\Models\UserModel if you don't define anything.

MGatner

Nice work!

Except for Config, if FQCN is specified, preferApp is ignored and that class is loaded.

…instance as `Config\Validation` When you call `Factories::injectMock('config', 'Validation', $config)`, but if the production code calls `config(\Config\Validation::class)`, the mock instance will not be used and fail the test: CodeIgniter\Database\ModelFactoryTest::testBasenameReturnsExistingNamespaceInstance

preferApp should work only for no namespaced (Config) classname.

kenjis · 2023-07-26T02:35:42Z

Rebased and added commits from a3c768atest: add test.

kenjis · 2023-07-24T07:09:29Z

Description
Fixes#7694

add Factories::define() to explicitly override a class
[BC] preferApp works only for no namespaced classname
[BC] rename Factories::$basenames to $aliases

I would like to deprecate preferApp option.

Changes
Property structure:

$basenames = [component => [basename => FQCN]];
↓
$aliases = [component => [alias => FQCN]];

basename is a short classname, or short classname with sub-directories.
alias is a FQCN, short classname, or short classname with sub-directories.
Factories::define() sets $aliases.

Behavior:

model(\Myth\Auth\Models\UserModel::class) or model('Myth\Auth\Models\UserModel')
- before:
  - returns App\Models\UserModel if exists and preferApp is true
  - returns Myth\Auth\Models\UserModel if exists and preferApp is false
- after:
  - returns Myth\Auth\Models\UserModel even if preferApp is true
  - returns App\Models\UserModel if you define Factories::define('models', 'Myth\Auth\Models\UserModel', 'App\Models\UserModel') before the first call of the model()

Checklist:

Securely signed commits
Component(s) with PHPDoc blocks, only if necessary or adds value
Unit testing, with >80% coverage
User guide updated
Conforms to style guide

MGatner

Can you give an example of how this would affect an existing workflow? For example right now Myth:Auth controller might use:

$user = model('UserModel')->find($userId);

... and a developer would supply app/Models/UserModel.php to override. With this update, would the developer need to add something to boot like:

useApp\Models\UserModel;
Factories::define('models', 'UserModel', UserModel::class);

?

MGatner · 2023-07-24T11:23:53Z

+ * @param string $name Classname. The first parameter of Factories magic method
+ * @param string $classname FQCN to load


These can get mixed up very easily. Let's stick to something like "shortname" for the unqualified version.
Suggested change
* @param string $name Classname. The first parameter of Factories magic method
* @param string $classnameFQCN to load
* @param string $name Class shortname. The first parameter of Factories magic method
* @param string $classnameFQCN to load

Or I see I called it "basename" below. Doesn't matter as long as we are consistent.

I introduced a new term "class alias".

MGatner · 2023-07-24T11:30:38Z

- if ($options['preferApp'] && class_exists($appname) && self::verifyInstanceOf($options, $name)) {
+ if (
+ // preferApp is used only for no namespace class.
+ strpos($name, '\\') === false


Is this the only breaking change? It seems like the rest of this PR could be rolled out separately without as big an impact.

Perhaps.
And it is what I want to change. Also it is Paul's opinion. See #7694 (comment)

kenjis · 2023-07-25T01:21:09Z

@MGatner No. model('UserModel') specifies no namespaced classname 'UserModel'. So Factories look for App\Models\UserModel (preferApp works).

But if there is code like model(\Myth\Auth\Models\UserModel::class) or model('Myth\Auth\Models\UserModel'), Factories returns Myth\Auth\Models\UserModel if you don't define anything.

MGatner

Nice work!

Except for Config, if FQCN is specified, preferApp is ignored and that class is loaded.

…instance as `Config\Validation` When you call `Factories::injectMock('config', 'Validation', $config)`, but if the production code calls `config(\Config\Validation::class)`, the mock instance will not be used and fail the test: CodeIgniter\Database\ModelFactoryTest::testBasenameReturnsExistingNamespaceInstance

preferApp should work only for no namespaced (Config) classname.

kenjis · 2023-07-26T02:35:42Z

Rebased and added commits from a3c768atest: add test.

kenjis · 2023-07-24T07:09:29Z

Description
Fixes#7694

add Factories::define() to explicitly override a class
[BC] preferApp works only for no namespaced classname
[BC] rename Factories::$basenames to $aliases

I would like to deprecate preferApp option.

Changes
Property structure:

$basenames = [component => [basename => FQCN]];
↓
$aliases = [component => [alias => FQCN]];

basename is a short classname, or short classname with sub-directories.
alias is a FQCN, short classname, or short classname with sub-directories.
Factories::define() sets $aliases.

Behavior:

model(\Myth\Auth\Models\UserModel::class) or model('Myth\Auth\Models\UserModel')
- before:
  - returns App\Models\UserModel if exists and preferApp is true
  - returns Myth\Auth\Models\UserModel if exists and preferApp is false
- after:
  - returns Myth\Auth\Models\UserModel even if preferApp is true
  - returns App\Models\UserModel if you define Factories::define('models', 'Myth\Auth\Models\UserModel', 'App\Models\UserModel') before the first call of the model()

Checklist:

Securely signed commits
Component(s) with PHPDoc blocks, only if necessary or adds value
Unit testing, with >80% coverage
User guide updated
Conforms to style guide

MGatner

Can you give an example of how this would affect an existing workflow? For example right now Myth:Auth controller might use:

$user = model('UserModel')->find($userId);

... and a developer would supply app/Models/UserModel.php to override. With this update, would the developer need to add something to boot like:

useApp\Models\UserModel;
Factories::define('models', 'UserModel', UserModel::class);

?

MGatner · 2023-07-24T11:23:53Z

+ * @param string $name Classname. The first parameter of Factories magic method
+ * @param string $classname FQCN to load


These can get mixed up very easily. Let's stick to something like "shortname" for the unqualified version.
Suggested change
* @param string $name Classname. The first parameter of Factories magic method
* @param string $classnameFQCN to load
* @param string $name Class shortname. The first parameter of Factories magic method
* @param string $classnameFQCN to load

Or I see I called it "basename" below. Doesn't matter as long as we are consistent.

I introduced a new term "class alias".

MGatner · 2023-07-24T11:30:38Z

- if ($options['preferApp'] && class_exists($appname) && self::verifyInstanceOf($options, $name)) {
+ if (
+ // preferApp is used only for no namespace class.
+ strpos($name, '\\') === false


Is this the only breaking change? It seems like the rest of this PR could be rolled out separately without as big an impact.

Perhaps.
And it is what I want to change. Also it is Paul's opinion. See #7694 (comment)

kenjis · 2023-07-25T01:21:09Z

@MGatner No. model('UserModel') specifies no namespaced classname 'UserModel'. So Factories look for App\Models\UserModel (preferApp works).

But if there is code like model(\Myth\Auth\Models\UserModel::class) or model('Myth\Auth\Models\UserModel'), Factories returns Myth\Auth\Models\UserModel if you don't define anything.

MGatner

Nice work!

Except for Config, if FQCN is specified, preferApp is ignored and that class is loaded.

…instance as `Config\Validation` When you call `Factories::injectMock('config', 'Validation', $config)`, but if the production code calls `config(\Config\Validation::class)`, the mock instance will not be used and fail the test: CodeIgniter\Database\ModelFactoryTest::testBasenameReturnsExistingNamespaceInstance

preferApp should work only for no namespaced (Config) classname.

kenjis · 2023-07-26T02:35:42Z

Rebased and added commits from a3c768atest: add test.

kenjis · 2023-07-24T07:09:29Z

Description
Fixes#7694

add Factories::define() to explicitly override a class
[BC] preferApp works only for no namespaced classname
[BC] rename Factories::$basenames to $aliases

I would like to deprecate preferApp option.

Changes
Property structure:

$basenames = [component => [basename => FQCN]];
↓
$aliases = [component => [alias => FQCN]];

basename is a short classname, or short classname with sub-directories.
alias is a FQCN, short classname, or short classname with sub-directories.
Factories::define() sets $aliases.

Behavior:

model(\Myth\Auth\Models\UserModel::class) or model('Myth\Auth\Models\UserModel')
- before:
  - returns App\Models\UserModel if exists and preferApp is true
  - returns Myth\Auth\Models\UserModel if exists and preferApp is false
- after:
  - returns Myth\Auth\Models\UserModel even if preferApp is true
  - returns App\Models\UserModel if you define Factories::define('models', 'Myth\Auth\Models\UserModel', 'App\Models\UserModel') before the first call of the model()

Checklist:

Securely signed commits
Component(s) with PHPDoc blocks, only if necessary or adds value
Unit testing, with >80% coverage
User guide updated
Conforms to style guide

MGatner

Can you give an example of how this would affect an existing workflow? For example right now Myth:Auth controller might use:

$user = model('UserModel')->find($userId);

... and a developer would supply app/Models/UserModel.php to override. With this update, would the developer need to add something to boot like:

useApp\Models\UserModel;
Factories::define('models', 'UserModel', UserModel::class);

?

MGatner · 2023-07-24T11:23:53Z

+ * @param string $name Classname. The first parameter of Factories magic method
+ * @param string $classname FQCN to load


These can get mixed up very easily. Let's stick to something like "shortname" for the unqualified version.
Suggested change
* @param string $name Classname. The first parameter of Factories magic method
* @param string $classnameFQCN to load
* @param string $name Class shortname. The first parameter of Factories magic method
* @param string $classnameFQCN to load

Or I see I called it "basename" below. Doesn't matter as long as we are consistent.

I introduced a new term "class alias".

MGatner · 2023-07-24T11:30:38Z

- if ($options['preferApp'] && class_exists($appname) && self::verifyInstanceOf($options, $name)) {
+ if (
+ // preferApp is used only for no namespace class.
+ strpos($name, '\\') === false


Is this the only breaking change? It seems like the rest of this PR could be rolled out separately without as big an impact.

Perhaps.
And it is what I want to change. Also it is Paul's opinion. See #7694 (comment)

kenjis · 2023-07-25T01:21:09Z

@MGatner No. model('UserModel') specifies no namespaced classname 'UserModel'. So Factories look for App\Models\UserModel (preferApp works).

But if there is code like model(\Myth\Auth\Models\UserModel::class) or model('Myth\Auth\Models\UserModel'), Factories returns Myth\Auth\Models\UserModel if you don't define anything.

MGatner

Nice work!

Except for Config, if FQCN is specified, preferApp is ignored and that class is loaded.

…instance as `Config\Validation` When you call `Factories::injectMock('config', 'Validation', $config)`, but if the production code calls `config(\Config\Validation::class)`, the mock instance will not be used and fail the test: CodeIgniter\Database\ModelFactoryTest::testBasenameReturnsExistingNamespaceInstance

preferApp should work only for no namespaced (Config) classname.

kenjis · 2023-07-26T02:35:42Z

Rebased and added commits from a3c768atest: add test.

kenjis added bug Verified issues on the current code behavior or pull requests that will fix them enhancement PRs that improve existing functionalities breaking change Pull requests that may break existing functionalities 4.4 labels Jul 24, 2023

kenjis force-pushed the feat-Factories-define branch 2 times, most recently from 1294ee7 to 4716098Compare July 24, 2023 07:36

kenjis added the docs needed Pull requests needing documentation write-ups and/or revisions. label Jul 24, 2023

kenjis marked this pull request as draft July 24, 2023 09:38

kenjis marked this pull request as ready for review July 24, 2023 10:52

MGatner requested changes Jul 24, 2023
View reviewed changes

kenjis force-pushed the feat-Factories-define branch from 891be8d to 1de7e3dCompare July 25, 2023 02:14

kenjis mentioned this pull request Jul 25, 2023
fix: wrong Config classname to config() in Toolbar #7735
Merged
2 tasks

kenjis force-pushed the feat-Factories-define branch from 1de7e3d to e0db315Compare July 25, 2023 07:21

kenjis requested a review from MGatner July 25, 2023 07:55

MGatner approved these changes Jul 25, 2023
View reviewed changes

kenjis added 14 commits July 26, 2023 09:00

style: break long lines
a8b528e

refactor: extract isConfig()
85dd31b

docs: add doc comments
79d3f35

feat: [BC] add Factories::define() to override module classes
d7ed053
Except for Config, if FQCN is specified, preferApp is ignored and that class is loaded.

chore: update psalm-baseline.xml for UndefinedClass
510c73f

test: update failed test
8629fdd

style: remove empty line
86ca97b

test: update failed test
74177ef

fix: preferApp is used with short classname only
88bbbcf

docs: introduce term "class alias" for docs
da9ea30

refactor: rename $basenames to $aliases
fd4d88c

refactor: rename $name to $alias
0fac66c

docs: improve doc comments
d385e98

kenjis added 7 commits July 26, 2023 09:00

refactor: extract isNamespaced()
8880351

docs: add@testtag
a1fa03f

refactor: use isNamespaced()
5b05bf9

refactor: use isNamespaced()
b482774

test: add test
a3c768a

docs: update comments
e3c223b

refactor: extract getDefinedInstance()
244c5fb

kenjis force-pushed the feat-Factories-define branch from aa25ccc to 244c5fbCompare July 26, 2023 00:35

kenjis marked this pull request as draft July 26, 2023 00:35

kenjis added 5 commits July 26, 2023 09:42

fix: remove logic for preferApp for no namespaced Config classname
340a930
preferApp should work only for no namespaced (Config) classname.

docs: update existing description
a13c53d

docs: add about Factories::define()
886fa87

docs: add changelog and upgrade guide
9fdd3f1

docs: fix typo
c48b523

kenjis removed the docs needed Pull requests needing documentation write-ups and/or revisions. label Jul 26, 2023

kenjis marked this pull request as ready for review July 26, 2023 02:35

kenjis requested a review from MGatner July 26, 2023 02:51

This was referenced Jul 26, 2023
Bug: [Factories] preferApp does not work for classes with the same short name #7699
Closed
Bug: [Factories] when there are classes with the same short name, only the first class is loaded #7694
Closed

MGatner approved these changes Jul 27, 2023
View reviewed changes

docs: update existing descriptions
89d6f37

MGatner approved these changes Jul 28, 2023
View reviewed changes

kenjis merged commit 5695e7a into codeigniter4:4.4Jul 29, 2023

kenjis deleted the feat-Factories-define branch July 29, 2023 00:35