Page MenuHomePhabricator

[ES-M5] Rename classes / files from Schema to EntitySchema
Closed, ResolvedPublic3 Estimated Story Points

Description

We renamed the EntitySchema extension from WikibaseSchema to EntitySchema, and the namespace and concept from just Schema to EntitySchema, relatively shortly before launch (T221942); as a result, some of the classes and files still have names with “Schema” but should instead be “EntitySchema” – such as SchemaInserter, SchemaId, SchemaDiffer etc., but also resources/special.newSchema.js and tests/selenium/specs/editSchema.js in JS. We should rename them to make the terminology consistent and the code less confusing.

Acceptance Criteria:

  • The classes and files listed below should reflect our agreed upon terminology of EntitySchema (instead of Schema)

PHP classes

  • SchemaId
  • SchemaCleaner
  • SchemaEncoder
  • SchemaInserter
  • SchemaUpdateGuard
  • SchemaUpdater
  • MediaWikiRevisionSchemaInserter
  • MediaWikiRevisionSchemaUpdater
  • SchemaDiffer
  • SchemaPatcher
  • SchemaEditAction
  • SchemaSubmitAction
  • SchemaConverter
  • FullArraySchemaData
  • FullViewSchemaData
  • PersistenceSchemaData

Namespaces / directories

  • SchemaConverter

Files

  • .phan/stubs/WikibaseSchema.php
  • resources/viewSchema.less
  • resources/special.newSchema.js
  • resources/special.setSchemaLabelDescriptionAliases.edit.js
  • tests/selenium/specs/editSchema.js
  • cypress/e2e/viewSchema.cy.js
  • cypress/support/pageObjects/ViewSchemaPage.js

Other

  • maintenance/createPreexistingSchemas.php – is this even worth keeping at all? (Also, if we do keep it, also rename it to initial uppercase, cf. Wikibase ADR 12.)

Event Timeline

Prio Notes

  • Impact Areas: Analyzability
  • Does not affect end users / production
  • Does not affect development efforts
  • Affects onboarding efforts (As the naming is inconsistent)
  • Does not affect additional stakeholders
ItamarWMDE renamed this task from Rename classes / files from Schema to EntitySchema to [ES-MS5] Rename classes / files from Schema to EntitySchema.Mar 28 2023, 1:14 PM
ItamarWMDE renamed this task from [ES-MS5] Rename classes / files from Schema to EntitySchema to [SW] [ES-M5] Rename classes / files from Schema to EntitySchema.Mar 28 2023, 1:20 PM

Story Writing Notes:

  • Add ACs to the ticket, explicitly stating the desired names for these classes and files
ItamarWMDE renamed this task from [SW] [ES-M5] Rename classes / files from Schema to EntitySchema to [ES-M5] Rename classes / files from Schema to EntitySchema.Apr 18 2023, 8:04 AM
ItamarWMDE updated the task description. (Show Details)
karapayneWMDE set the point value for this task to 3.Aug 8 2023, 9:27 AM

Change 951447 had a related patch set uploaded (by Noa wmde; author: Noa wmde):

[mediawiki/extensions/EntitySchema@master] Rename SchemaId to EntitySchemaId in class and file names

https://gerrit.wikimedia.org/r/951447

Change 951447 merged by jenkins-bot:

[mediawiki/extensions/EntitySchema@master] Rename SchemaId to EntitySchemaId in class and file names

https://gerrit.wikimedia.org/r/951447

Change 951480 had a related patch set uploaded (by Noa wmde; author: Noa wmde):

[mediawiki/extensions/EntitySchema@master] Rename SchemaCleaner class and file names to EntitySchemaCleaner

https://gerrit.wikimedia.org/r/951480

Change 951480 merged by jenkins-bot:

[mediawiki/extensions/EntitySchema@master] Rename SchemaCleaner class and file names to EntitySchemaCleaner

https://gerrit.wikimedia.org/r/951480

Change 951831 had a related patch set uploaded (by Noa wmde; author: Noa wmde):

[mediawiki/extensions/EntitySchema@master] Rename SchemaEncoder files and classes EntitySchemaEncoder

https://gerrit.wikimedia.org/r/951831

Change 951831 merged by jenkins-bot:

[mediawiki/extensions/EntitySchema@master] Rename SchemaEncoder files and classes EntitySchemaEncoder

https://gerrit.wikimedia.org/r/951831

Change 951910 had a related patch set uploaded (by Noa wmde; author: Noa wmde):

[mediawiki/extensions/EntitySchema@master] Rename SchemaInserter and SchemaUpdateGuard

https://gerrit.wikimedia.org/r/951910

Change 951920 had a related patch set uploaded (by Noa wmde; author: Noa wmde):

[mediawiki/extensions/EntitySchema@master] Rename SchemaUpdater and MediaWikiRevisionSchemaUpdater

https://gerrit.wikimedia.org/r/951920

Change 951910 merged by jenkins-bot:

[mediawiki/extensions/EntitySchema@master] Rename 'Schema' to 'EntitySchema'

https://gerrit.wikimedia.org/r/951910

Change 952303 had a related patch set uploaded (by Noa wmde; author: Noa wmde):

[mediawiki/extensions/EntitySchema@master] Rename SchemaDiffer to EntitySchemaDiffer

https://gerrit.wikimedia.org/r/952303

Change 952308 had a related patch set uploaded (by Noa wmde; author: Noa wmde):

[mediawiki/extensions/EntitySchema@master] Rename SchemaPatcher to EntitySchemaPatcher

https://gerrit.wikimedia.org/r/952308

Change 952303 merged by jenkins-bot:

[mediawiki/extensions/EntitySchema@master] Rename SchemaDiffer to EntitySchemaDiffer

https://gerrit.wikimedia.org/r/952303

Change 952308 merged by jenkins-bot:

[mediawiki/extensions/EntitySchema@master] Rename SchemaPatcher to EntitySchemaPatcher

https://gerrit.wikimedia.org/r/952308

Change 952350 had a related patch set uploaded (by Noa wmde; author: Noa wmde):

[mediawiki/extensions/EntitySchema@master] Rename SchemaEditAction and SchemaSubmitAction

https://gerrit.wikimedia.org/r/952350

Change 951920 merged by jenkins-bot:

[mediawiki/extensions/EntitySchema@master] Rename SchemaUpdater and MediaWikiRevisionSchemaUpdater

https://gerrit.wikimedia.org/r/951920

Change 952356 had a related patch set uploaded (by Lucas Werkmeister (WMDE); author: Lucas Werkmeister (WMDE)):

[mediawiki/extensions/EntitySchema@master] Rename SchemaConverter to EntitySchemaConverter

https://gerrit.wikimedia.org/r/952356

Change 952357 had a related patch set uploaded (by Lucas Werkmeister (WMDE); author: Lucas Werkmeister (WMDE)):

[mediawiki/extensions/EntitySchema@master] Rename SchemaConverter namespace to Converter

https://gerrit.wikimedia.org/r/952357

Change 952350 merged by jenkins-bot:

[mediawiki/extensions/EntitySchema@master] Rename SchemaEditAction and SchemaSubmitAction

https://gerrit.wikimedia.org/r/952350

Change 952356 merged by jenkins-bot:

[mediawiki/extensions/EntitySchema@master] Rename SchemaConverter to EntitySchemaConverter

https://gerrit.wikimedia.org/r/952356

Change 952357 merged by jenkins-bot:

[mediawiki/extensions/EntitySchema@master] Rename SchemaConverter namespace to Converter

https://gerrit.wikimedia.org/r/952357

Change 952462 had a related patch set uploaded (by Lucas Werkmeister (WMDE); author: Lucas Werkmeister (WMDE)):

[mediawiki/extensions/EntitySchema@master] Rename SchemaData classes

https://gerrit.wikimedia.org/r/952462

Change 952462 merged by jenkins-bot:

[mediawiki/extensions/EntitySchema@master] Rename SchemaData classes

https://gerrit.wikimedia.org/r/952462

Change 952657 had a related patch set uploaded (by Noa wmde; author: Noa wmde):

[mediawiki/extensions/EntitySchema@master] Rename js files and classes

https://gerrit.wikimedia.org/r/952657

Change 952657 merged by jenkins-bot:

[mediawiki/extensions/EntitySchema@master] Rename js files and classes

https://gerrit.wikimedia.org/r/952657

Change 953226 had a related patch set uploaded (by Noa wmde; author: Noa wmde):

[mediawiki/extensions/EntitySchema@master] One last file name change

https://gerrit.wikimedia.org/r/953226

Change 953226 merged by jenkins-bot:

[mediawiki/extensions/EntitySchema@master] One last file name change

https://gerrit.wikimedia.org/r/953226

Neat! Code search brings up no significant results. Thank you!