First steps to convert MARC schema to Avram format

pkiraly / qa-catalogue

QA catalogue – a metadata quality assessment tool for library catalogue records (MARC, PICA)

GNU General Public License v3.0

78 stars 17 forks source link

First steps to convert MARC schema to Avram format #371

Closed nichtich closed 10 months ago

nichtich commented 10 months ago

Partly resolves #370 by simple modification of the format as listed at https://github.com/timathom/marc-schema/issues/1:

wrap the list of fields in a root object with key 'fields' and add key family with value 'marc'
rename key 'name' to 'label'
rename key 'values' to 'codes'
rename key 'staticValues' to 'positions'
remove key 'fixed', its value is implied by non-existence of 'subfields'

pkiraly commented 10 months ago

@nichtich Sorry I just reviewed this PR. I would like to keep both versions and your versions of the class and the schema. Why? Because the maintainer of this schema is @timathom and he might have an existing infrastructure which supports his naming conventions, while it is equally important that there should be an Avram compatible version. So my suggestion: name your Marc21SchemaReader.java to AvramMarc21SchemaReader.java, and I will rename the old one to something like YaleMarc21SchemaReader. For the same reason I will rename the existing schema authority-schema.yale.json, and you should rename yours to authority-schema.avram.json. Do you agree?

pkiraly commented 10 months ago

@nichtich I have just modified the existing files, so you can rename your versions.

timathom commented 10 months ago

Thanks for your consideration, @pkiraly, but there's no need to maintain the naming conventions I used. I haven't yet built anything that depends on them, so, I'm more than happy to align with Avram!

pkiraly commented 10 months ago

@timathom Thanks for the clarification! @nichtich You do not need any further action yet. I'll do the modifications.

pkiraly commented 10 months ago

I fixed the conflicts, now both schema versions and both handlers are available in the code base.

sonarcloud[bot] commented 10 months ago

SonarCloud Quality Gate failed.

0 Bugs
0 Vulnerabilities
0 Security Hotspots
24 Code Smells

81.4% Coverage
48.9% Duplication

warning The version of Java (11.0.21) you have used to run this analysis is deprecated and we will stop accepting it soon. Please update to at least Java 17. Read more here

idea Catch issues before they fail your Quality Gate with our IDE extension SonarLint