diff --git a/tests/conftest.py b/tests/conftest.py index c2bab99..6d924a6 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -5,7 +5,7 @@ import transmogrifier.models as timdex from transmogrifier.config import SOURCES, load_external_config -from transmogrifier.sources.transformer import JsonTransformer, XmlTransformer +from transmogrifier.sources.transformer import JSONTransformer, XMLTransformer from transmogrifier.sources.xml.datacite import Datacite @@ -48,21 +48,21 @@ def runner(): @pytest.fixture def aardvark_record_all_fields(): - return JsonTransformer.parse_source_file( + return JSONTransformer.parse_source_file( "tests/fixtures/aardvark/aardvark_record_all_fields.jsonl" ) @pytest.fixture() def datacite_records(): - return XmlTransformer.parse_source_file( + return XMLTransformer.parse_source_file( "tests/fixtures/datacite/datacite_records.xml" ) @pytest.fixture() def datacite_record_all_fields(): - source_records = XmlTransformer.parse_source_file( + source_records = XMLTransformer.parse_source_file( "tests/fixtures/datacite/datacite_record_all_fields.xml" ) return Datacite("cool-repo", source_records) @@ -70,7 +70,7 @@ def datacite_record_all_fields(): @pytest.fixture() def aardvark_records(): - return JsonTransformer.parse_source_file("tests/fixtures/aardvark_records.jsonl") + return JSONTransformer.parse_source_file("tests/fixtures/aardvark_records.jsonl") @pytest.fixture() @@ -85,7 +85,7 @@ def marc_content_type_crosswalk(): @pytest.fixture() def oai_pmh_records(): - return XmlTransformer.parse_source_file("tests/fixtures/oai_pmh_records.xml") + return XMLTransformer.parse_source_file("tests/fixtures/oai_pmh_records.xml") @pytest.fixture() diff --git a/tests/sources/test_transformer.py b/tests/sources/test_transformer.py index 33ecb84..cda6d22 100644 --- a/tests/sources/test_transformer.py +++ b/tests/sources/test_transformer.py @@ -4,7 +4,7 @@ import pytest from transmogrifier.models import TimdexRecord -from transmogrifier.sources.transformer import Transformer, XmlTransformer +from transmogrifier.sources.transformer import Transformer, XMLTransformer from transmogrifier.sources.xml.datacite import Datacite @@ -28,7 +28,7 @@ def test_transformer_get_transformer_source_wrong_module_path_raises_error(bad_c def test_xmltransformer_initializes_with_expected_attributes(oai_pmh_records): - transformer = XmlTransformer("cool-repo", oai_pmh_records) + transformer = XMLTransformer("cool-repo", oai_pmh_records) assert transformer.source == "cool-repo" assert transformer.source_base_url == "https://example.com/" assert transformer.source_name == "A Cool Repository" @@ -36,7 +36,7 @@ def test_xmltransformer_initializes_with_expected_attributes(oai_pmh_records): def test_xmltransformer_iterates_through_all_records(oai_pmh_records): - output_records = XmlTransformer("cool-repo", oai_pmh_records) + output_records = XMLTransformer("cool-repo", oai_pmh_records) assert len(list(output_records)) == 2 assert output_records.processed_record_count == 3 assert output_records.transformed_record_count == 2 @@ -47,10 +47,10 @@ def test_xmltransformer_iterates_successfully_if_get_optional_fields_returns_non oai_pmh_records, ): with patch( - "transmogrifier.sources.transformer.XmlTransformer.get_optional_fields" + "transmogrifier.sources.transformer.XMLTransformer.get_optional_fields" ) as m: m.return_value = None - output_records = XmlTransformer("cool-repo", oai_pmh_records) + output_records = XMLTransformer("cool-repo", oai_pmh_records) assert len(list(output_records)) == 0 assert output_records.processed_record_count == 3 assert output_records.skipped_record_count == 2 @@ -62,7 +62,7 @@ def test_xmltransformer_transform_and_write_output_files_writes_output_files( tmp_path, oai_pmh_records ): output_file = str(tmp_path / "output_file.json") - transformer = XmlTransformer("cool-repo", oai_pmh_records) + transformer = XMLTransformer("cool-repo", oai_pmh_records) assert not Path(tmp_path / "output_file.json").exists() assert not Path(tmp_path / "output_file.txt").exists() transformer.transform_and_write_output_files(output_file) @@ -74,31 +74,31 @@ def test_xmltransformer_transform_and_write_output_files_no_txt_file_if_not_need tmp_path, ): output_file = str(tmp_path / "output_file.json") - datacite_records = XmlTransformer.parse_source_file( + datacite_records = XMLTransformer.parse_source_file( "tests/fixtures/datacite/datacite_records.xml" ) - transformer = XmlTransformer("cool-repo", datacite_records) + transformer = XMLTransformer("cool-repo", datacite_records) transformer.transform_and_write_output_files(output_file) assert len(list(tmp_path.iterdir())) == 1 assert next(tmp_path.iterdir()).name == "output_file.json" def test_xmltransformer_parse_source_file_returns_record_iterator(): - records = XmlTransformer.parse_source_file( + records = XMLTransformer.parse_source_file( "tests/fixtures/datacite/datacite_records.xml" ) assert len(list(records)) == 38 def test_xmltransformer_record_is_deleted_returns_true_if_deleted(caplog): - source_records = XmlTransformer.parse_source_file( + source_records = XMLTransformer.parse_source_file( "tests/fixtures/record_deleted.xml" ) - assert XmlTransformer.record_is_deleted(next(source_records)) is True + assert XMLTransformer.record_is_deleted(next(source_records)) is True def test_xmltransformer_get_required_fields_returns_expected_values(oai_pmh_records): - transformer = XmlTransformer("cool-repo", oai_pmh_records) + transformer = XMLTransformer("cool-repo", oai_pmh_records) assert transformer.get_required_fields(next(oai_pmh_records)) == { "source": "A Cool Repository", "source_link": "https://example.com/12345", @@ -108,7 +108,7 @@ def test_xmltransformer_get_required_fields_returns_expected_values(oai_pmh_reco def test_xmltransformer_transform_returns_timdex_record(oai_pmh_records): - transformer = XmlTransformer("cool-repo", oai_pmh_records) + transformer = XMLTransformer("cool-repo", oai_pmh_records) assert next(transformer) == TimdexRecord( source="A Cool Repository", source_link="https://example.com/12345", @@ -120,7 +120,7 @@ def test_xmltransformer_transform_returns_timdex_record(oai_pmh_records): def test_xmltransformer_get_valid_title_with_title_field_blank_logs_warning(caplog): - source_records = XmlTransformer.parse_source_file( + source_records = XMLTransformer.parse_source_file( "tests/fixtures/record_title_field_blank.xml" ) output_records = Datacite("cool-repo", source_records) @@ -132,7 +132,7 @@ def test_xmltransformer_get_valid_title_with_title_field_blank_logs_warning(capl def test_xmltransformer_get_valid_title_with_title_field_missing_logs_warning(caplog): - source_records = XmlTransformer.parse_source_file( + source_records = XMLTransformer.parse_source_file( "tests/fixtures/record_title_field_missing.xml" ) output_records = Datacite("cool-repo", source_records) @@ -144,7 +144,7 @@ def test_xmltransformer_get_valid_title_with_title_field_missing_logs_warning(ca def test_xmltransformer_get_valid_title_with_title_field_multiple_logs_warning(caplog): - source_records = XmlTransformer.parse_source_file( + source_records = XMLTransformer.parse_source_file( "tests/fixtures/record_title_field_multiple.xml" ) output_records = Datacite("cool-repo", source_records) diff --git a/transmogrifier/sources/json/aardvark.py b/transmogrifier/sources/json/aardvark.py index 32b4859..47324a8 100644 --- a/transmogrifier/sources/json/aardvark.py +++ b/transmogrifier/sources/json/aardvark.py @@ -1,12 +1,12 @@ import logging import transmogrifier.models as timdex -from transmogrifier.sources.transformer import JsonTransformer +from transmogrifier.sources.transformer import JSONTransformer logger = logging.getLogger(__name__) -class MITAardvark(JsonTransformer): +class MITAardvark(JSONTransformer): """MITAardvark transformer. MIT Aardvark records have more required fields than standard Aardvark records diff --git a/transmogrifier/sources/transformer.py b/transmogrifier/sources/transformer.py index d45e8ab..1a0acc8 100644 --- a/transmogrifier/sources/transformer.py +++ b/transmogrifier/sources/transformer.py @@ -374,7 +374,7 @@ def get_optional_fields( return {} -class JsonTransformer(Transformer): +class JSONTransformer(Transformer): """JSON transformer class.""" @final @@ -525,7 +525,7 @@ def get_optional_fields(self, source_record: dict[str, JSON]) -> Optional[dict]: return {} -class XmlTransformer(Transformer): +class XMLTransformer(Transformer): """XML transformer class.""" @final diff --git a/transmogrifier/sources/xml/datacite.py b/transmogrifier/sources/xml/datacite.py index 7741b04..b46c232 100644 --- a/transmogrifier/sources/xml/datacite.py +++ b/transmogrifier/sources/xml/datacite.py @@ -5,12 +5,12 @@ import transmogrifier.models as timdex from transmogrifier.helpers import validate_date, validate_date_range -from transmogrifier.sources.transformer import XmlTransformer +from transmogrifier.sources.transformer import XMLTransformer logger = logging.getLogger(__name__) -class Datacite(XmlTransformer): +class Datacite(XMLTransformer): """Datacite transformer.""" def get_optional_fields(self, xml: Tag) -> Optional[dict]: diff --git a/transmogrifier/sources/xml/dspace_dim.py b/transmogrifier/sources/xml/dspace_dim.py index 433a936..9c3b150 100644 --- a/transmogrifier/sources/xml/dspace_dim.py +++ b/transmogrifier/sources/xml/dspace_dim.py @@ -5,12 +5,12 @@ import transmogrifier.models as timdex from transmogrifier.helpers import validate_date, validate_date_range -from transmogrifier.sources.transformer import XmlTransformer +from transmogrifier.sources.transformer import XMLTransformer logger = logging.getLogger(__name__) -class DspaceDim(XmlTransformer): +class DspaceDim(XMLTransformer): """DSpace DIM transformer.""" def get_optional_fields(self, xml: Tag) -> Optional[dict]: diff --git a/transmogrifier/sources/xml/dspace_mets.py b/transmogrifier/sources/xml/dspace_mets.py index 7db882f..6b72868 100644 --- a/transmogrifier/sources/xml/dspace_mets.py +++ b/transmogrifier/sources/xml/dspace_mets.py @@ -5,12 +5,12 @@ import transmogrifier.models as timdex from transmogrifier.helpers import validate_date -from transmogrifier.sources.transformer import XmlTransformer +from transmogrifier.sources.transformer import XMLTransformer logger = logging.getLogger(__name__) -class DspaceMets(XmlTransformer): +class DspaceMets(XMLTransformer): """DSpace METS transformer.""" def get_optional_fields(self, xml: Tag) -> dict: diff --git a/transmogrifier/sources/xml/ead.py b/transmogrifier/sources/xml/ead.py index 82cdbad..83e2015 100644 --- a/transmogrifier/sources/xml/ead.py +++ b/transmogrifier/sources/xml/ead.py @@ -6,7 +6,7 @@ import transmogrifier.models as timdex from transmogrifier.config import load_external_config from transmogrifier.helpers import validate_date, validate_date_range -from transmogrifier.sources.transformer import XmlTransformer +from transmogrifier.sources.transformer import XMLTransformer logger = logging.getLogger(__name__) @@ -16,7 +16,7 @@ ) -class Ead(XmlTransformer): +class Ead(XMLTransformer): """EAD transformer.""" def get_optional_fields(self, xml: Tag) -> Optional[dict]: diff --git a/transmogrifier/sources/xml/marc.py b/transmogrifier/sources/xml/marc.py index 0077cc4..4ceda70 100644 --- a/transmogrifier/sources/xml/marc.py +++ b/transmogrifier/sources/xml/marc.py @@ -6,7 +6,7 @@ import transmogrifier.models as timdex from transmogrifier.config import load_external_config from transmogrifier.helpers import validate_date -from transmogrifier.sources.transformer import XmlTransformer +from transmogrifier.sources.transformer import XMLTransformer logger = logging.getLogger(__name__) @@ -30,7 +30,7 @@ ) -class Marc(XmlTransformer): +class Marc(XMLTransformer): """Marc transformer.""" def get_optional_fields(self, xml: Tag) -> Optional[dict]: diff --git a/transmogrifier/sources/xml/oaidc.py b/transmogrifier/sources/xml/oaidc.py index 7e672c7..2cedbc4 100644 --- a/transmogrifier/sources/xml/oaidc.py +++ b/transmogrifier/sources/xml/oaidc.py @@ -5,12 +5,12 @@ import transmogrifier.models as timdex from transmogrifier.helpers import validate_date -from transmogrifier.sources.transformer import XmlTransformer +from transmogrifier.sources.transformer import XMLTransformer logger = logging.getLogger(__name__) -class OaiDc(XmlTransformer): +class OaiDc(XMLTransformer): """ Generic OAI DC transformer.