valkyrjaio / valkyrja-php / 30726559438
100%

DEFAULT BRANCH: 26.x
Ran
Jobs 1
Files 1217
Run time 2min
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst
coverage: 100.0%. Remained the same
30726559438

push

github

web-flow 
[Orm] refactor(#1107)!: Align the date field names with the common convention (#1108)

# Description

The ORM stamped a date into `date_created`, `date_modified` and
`date_deleted`.
Most frameworks use `created_at`, `updated_at` and `deleted_at`. This
pull
request changes the default to the common name.

valkyrjaio/valkyrja-php#1090 restored the date stamping and moved the
field names
into the entity metadata registry. The names became a default on a data
object at
that point, which is why this change comes now and not later. A later
change
breaks the same properties a second time.

## Why the common name

A default in a framework decides for every user, and it is not a
decision of
taste. A developer who prefers a different name registers that name, so
the
default must serve the developer who registers nothing.

| Framework | Names |
|:----------|:------|
| Laravel / Eloquent | `created_at`, `updated_at`, `deleted_at` |
| Rails / ActiveRecord | `created_at`, `updated_at` (a soft delete gem
adds `deleted_at`) |
| Django | no name is built in, and `created_at` / `updated_at` is the
convention |
| Doctrine | no timestamp is built in |

Two more reasons support the change:

- A developer who comes from another framework has an existing schema,
and that
schema holds `created_at` more often than any other name. The common
default
  therefore also helps the developer who already has a database.
- The prefix `date_` describes a calendar day, and the value holds a
time.
`DateFormat::MICROSECOND` holds a sub-second time. The suffix `_at`
describes
  an instant, which is what the field holds.

No language port holds an ORM entity yet, so this change needs no
sibling pull
request. A later port inherits the name that this pull request sets.

**This pull request breaks two public properties and three default
values.** An
application that keeps an older schema registers the old names and
declares the
properties on its own entity:

```php
$registry->withEntity(
    P... (continued)

12914 of 12914 relevant lines covered (100.0%)

24.45 hits per line

Jobs
ID Job ID Ran Files Coverage
1 30726559438.1 1217
100.0
 GitHub Action Run
Source Files on build 30726559438