Merge pull request #180 from dracor-org/173-naming

Align field and column names with DraCor wording

src/about.mdx

@@ -97,9 +97,9 @@ from different environments to conduct statistics. An example in R:
 ```R
 library(jsonlite)
 einakter <- fromJSON("https://einakter.dracor.org/data.json")
-hist(einakter$normalizedYear, breaks = 20, xlab="Jahrfünft", ylab="Anzahl Stücke im Korpus")
-plot(einakter$normalizedYear, einakter$numberOfScenes, xlab="Jahr", ylab="Anzahl Szenen pro Stück")
-plot(einakter$normalizedYear, einakter$numberOfCharacters, xlab="Jahr", ylab="Anzahl Figuren pro Stück")
+hist(einakter$yearNormalized, breaks = 20, xlab="Jahrfünft", ylab="Anzahl Stücke im Korpus")
+plot(einakter$yearNormalized, einakter$numOfScenes, xlab="Jahr", ylab="Anzahl Szenen pro Stück")
+plot(einakter$yearNormalized, einakter$numOfCharacters, xlab="Jahr", ylab="Anzahl Figuren pro Stück")
 ```
 
 The data model is described <a href="https://github.com/dracor-org/einakter/wiki">here</a>.

src/components/Details.tsx

@@ -43,15 +43,15 @@ export default function Details() {
  authors = [],
  cast,
  comments,
- created,
+ yearWritten,
+ yearPrinted,
  dictionaries,
  editions,
  formalia,
  ids,
  keywords,
- numberOfScenes,
+ numOfScenes,
  premiered,
- printed,
  reviews,
  settings,
  basedOn,
@@ -129,15 +129,19 @@ export default function Details() {
  <Trans>Dates</Trans>
  </th>
  <td>
- <Years written={created} premiere={premiered} print={printed} />
+ <Years
+ written={yearWritten}
+ premiere={premiered}
+ print={yearPrinted}
+ />
  </td>
  </tr>
- {numberOfScenes && (
+ {numOfScenes && (
  <tr>
  <th>
  <Trans>Number of Scenes</Trans>
  </th>
- <td>{numberOfScenes}</td>
+ <td>{numOfScenes}</td>
  </tr>
  )}
  {ids && (

src/components/Map.tsx

@@ -37,7 +37,7 @@ const SettingsMap = () => {
  authors: p.authors || [],
  title: p.title,
  slug: p.slug,
- year: p.normalizedYear,
+ year: p.yearNormalized,
  setting: s.description,
  });
  }

src/components/Original.tsx

@@ -10,8 +10,8 @@ import {localLanguageName} from '../languages';
 
 function getYear(ref: OriginalPlay) {
  const years = [];
- if (ref.created) years.push(ref.created);
- if (ref.printed) years.push(ref.printed);
+ if (ref.yearWritten) years.push(ref.yearWritten);
+ if (ref.yearPrinted) years.push(ref.yearPrinted);
  if (ref.premiered) years.push(parseInt(ref.premiered as string));
  return years.sort()[0] || undefined;
 }
@@ -95,7 +95,7 @@ const Original = ({data}: Props) => {
  {play.title}
  {play.subtitle && !play.title.match(/[.!?]\s*$/) && '.'}
  {play.subtitle && ` ${play.subtitle}`}
- {play.normalizedYear && ` (${play.normalizedYear})`}
+ {play.yearNormalized && ` (${play.yearNormalized})`}
  </Link>
  </li>
  ))}

src/components/OriginalDetails.tsx

@@ -38,9 +38,9 @@ const OriginalDetails = () => {
  title,
  subtitle,
  ids,
- created,
+ yearWritten,
  premiered,
- printed,
+ yearPrinted,
  fulltextUrl,
  language,
  } = original;
@@ -87,7 +87,7 @@ const OriginalDetails = () => {
  {play.title}
  {play.subtitle && !play.title.match(/[.!?]\s*$/) && '.'}
  {play.subtitle && ` ${play.subtitle}`}
- {play.normalizedYear && ` (${play.normalizedYear})`}
+ {play.yearNormalized && ` (${play.yearNormalized})`}
  </Link>
  </li>
  ))}
@@ -99,7 +99,11 @@ const OriginalDetails = () => {
  <Trans>Dates</Trans>
  </th>
  <td>
- <Years written={created} premiere={premiered} print={printed} />
+ <Years
+ written={yearWritten}
+ premiere={premiered}
+ print={yearPrinted}
+ />
  </td>
  </tr>
  {ids && (

src/components/Originals.tsx

@@ -57,11 +57,11 @@ function Originals() {
  cell: (info) => <TitleCell play={info.row.original} />,
  },
  {
- id: 'normalizedYear',
+ id: 'yearNormalized',
  header: t`Year (normalized)`,
- accessorFn: (row) => row.normalizedYear?.toString() || '',
+ accessorFn: (row) => row.yearNormalized?.toString() || '',
  cell: (info) => (
- <span>{formatEra(info.row.original.normalizedYear)}</span>
+ <span>{formatEra(info.row.original.yearNormalized)}</span>
  ),
  },
  {
@@ -88,7 +88,7 @@ function Originals() {
  <Table
  columns={columns}
  data={data}
- defaultSort={[{id: 'normalizedYear', desc: false}]}
+ defaultSort={[{id: 'yearNormalized', desc: false}]}
  />
  </div>
  </div>

src/components/Plays.tsx

@@ -56,32 +56,32 @@ export default function Plays() {
  cell: (info) => <TitleCell play={info.row.original} urlPath="/" />,
  },
  {
- id: 'normalizedYear',
+ id: 'yearNormalized',
  header: t`Year (normalized)`,
- accessorFn: (row) => row.normalizedYear?.toString() || '',
+ accessorFn: (row) => row.yearNormalized?.toString() || '',
  cell: ({
  row: {
- original: {normalizedYear},
+ original: {yearNormalized},
  },
  }) => {
  return (
  <span>
- {normalizedYear == null
+ {yearNormalized == null
  ? t`not available`
- : formatEra(normalizedYear)}
+ : formatEra(yearNormalized)}
  </span>
  );
  },
  },
  {
- id: 'numberOfScenes',
+ id: 'numOfScenes',
  header: t`Scenes`,
- accessorFn: (row) => row.numberOfScenes?.toString() || '',
+ accessorFn: (row) => row.numOfScenes?.toString() || '',
  },
  {
- id: 'numberOfCharacters',
+ id: 'numOfCharacters',
  header: t`Characters`,
- accessorFn: (row) => row.numberOfCharacters?.toString() || '',
+ accessorFn: (row) => row.numOfCharacters?.toString() || '',
  },
  {
  id: 'keywords',
@@ -124,7 +124,7 @@ export default function Plays() {
  <Table
  columns={columns}
  data={data}
- defaultSort={[{id: 'normalizedYear', desc: false}]}
+ defaultSort={[{id: 'yearNormalized', desc: false}]}
  />
  </div>
  </>

src/types.ts

@@ -59,7 +59,12 @@ export interface Play {
  basedOnLanguage?: string;
  cast?: CastMember[];
  comments?: string[];
- created?: number;
+ yearWritten?: number;
+ yearPrinted?: number;
+ yearPremiered?: number;
+ datePremiered?: string;
+ yearNormalized?: number;
+ premiered?: string | number;
  editions?: Edition[];
  dictionaries?: Dict[];
  formalia?: string[];
@@ -69,11 +74,8 @@ export interface Play {
  weber?: string;
  };
  keywords?: string[];
- normalizedYear?: number;
- numberOfCharacters?: number;
- numberOfScenes?: number;
- premiered?: string | number;
- printed?: number;
+ numOfCharacters?: number;
+ numOfScenes?: number;
  reviews?: string[];
  settings?: Setting[];
  subtitle?: string;
@@ -87,10 +89,10 @@ export interface OriginalPlay {
  title: string;
  subtitle?: string;
  language?: string;
- created?: number;
- printed?: number;
+ yearWritten?: number;
+ yearPrinted?: number;
  premiered?: string | number;
- normalizedYear?: number;
+ yearNormalized?: number;
  fulltextUrl?: string;
  ids?: {
  dracor?: string;

src/utils.test.ts

@@ -23,26 +23,26 @@ describe('normalizeYear', () => {
  expect(normalizeYear(play)).toBe(1789);
  });
 
- it('uses earlier year of "premiered" and "printed"', () => {
- const play = {...playTmpl, premiered: 1789, printed: 1805};
+ it('uses earlier year of "premiered" and "yearPrinted"', () => {
+ const play = {...playTmpl, premiered: 1789, yearPrinted: 1805};
  expect(normalizeYear(play)).toBe(1789);
 
- const play2 = {...playTmpl, premiered: 1805, printed: 1777};
+ const play2 = {...playTmpl, premiered: 1805, yearPrinted: 1777};
  expect(normalizeYear(play2)).toBe(1777);
  });
 
- it('uses "created" when it is the only defined year', () => {
- const play = {...playTmpl, created: 1777};
+ it('uses "yearWritten" when it is the only defined year', () => {
+ const play = {...playTmpl, yearWritten: 1777};
  expect(normalizeYear(play)).toBe(1777);
  });
 
- it('uses "created" when it is more than 10 years before publication', () => {
- const play = {...playTmpl, premiered: 1810, created: 1777};
+ it('uses "yearWritten" when it is more than 10 years before publication', () => {
+ const play = {...playTmpl, premiered: 1810, yearWritten: 1777};
  expect(normalizeYear(play)).toBe(1777);
  });
 
  it('prefers publication year when less than 10 years after creation', () => {
- const play = {...playTmpl, premiered: 1810, created: 1805};
+ const play = {...playTmpl, premiered: 1810, yearWritten: 1805};
  expect(normalizeYear(play)).toBe(1810);
  });
 });
@@ -75,7 +75,12 @@ describe('countCharactersByGender', () => {
 
 describe('getEarliestYear', () => {
  it('finds earliest year', () => {
- const play = {...playTmpl, premiered: 1789, created: 1770, printed: 1790};
+ const play = {
+ ...playTmpl,
+ premiered: 1789,
+ yearWritten: 1770,
+ yearPrinted: 1790,
+ };
  expect(getEarliestYear(play)).toBe(1770);
  });
 

src/utils.ts

@@ -1,26 +1,30 @@
 import {Play, OriginalPlay} from './types';
 
 export function normalizeYear(play: Play | OriginalPlay) {
- const {premiered: p, printed, created} = play;
+ const {premiered: p, yearPrinted, yearWritten} = play;
  const premiered: number = parseInt(p as string);
  const published =
- premiered && printed ? Math.min(premiered, printed) : premiered || printed;
+ premiered && yearPrinted
+ ? Math.min(premiered, yearPrinted)
+ : premiered || yearPrinted;
 
  let year;
- if (created && published) {
- year = published - created > 10 ? created : published;
+ if (yearWritten && published) {
+ year = published - yearWritten > 10 ? yearWritten : published;
  } else {
- year = created || published;
+ year = yearWritten || published;
  }
 
  return year;
 }
 
 export function getEarliestYear(play: Play) {
- const {premiered, printed, created} = play;
- const years = [parseInt(premiered as string), printed, created].filter((y) =>
- Boolean(y)
- );
+ const {premiered, yearPrinted, yearWritten} = play;
+ const years = [
+ parseInt(premiered as string),
+ yearPrinted,
+ yearWritten,
+ ].filter((y) => Boolean(y));
  return years.length > 0 ? Math.min(...(years as number[])) : undefined;
 }
 
@@ -56,8 +60,8 @@ export function countCharactersByGender(play: Play) {
 }
 
 export function sortByYear(a: Play, b: Play) {
- const yearA = a.normalizedYear || -10000;
- const yearB = b.normalizedYear || -10000;
+ const yearA = a.yearNormalized || -10000;
+ const yearB = b.yearNormalized || -10000;
  if (yearA > yearB) return 1;
  if (yearA < yearB) return -1;
  return 0;