From d5aef863ad25c18065f8d8ca87756995cf07dd6e Mon Sep 17 00:00:00 2001 From: Michael Holloway Date: Wed, 15 Jan 2025 23:31:57 -0500 Subject: [PATCH] Fix up copypasted class description comments --- .../transformers/acknowledgements_claim_transformer.rb | 3 +-- lib/digital_scriptorium/transformers/date_claim_transformer.rb | 2 +- .../transformers/dated_claim_transformer.rb | 2 +- .../transformers/iiif_manifest_claim_transformer.rb | 2 +- .../transformers/institution_claim_transformer.rb | 2 +- .../transformers/institutional_record_claim_transformer.rb | 2 +- .../transformers/language_claim_transformer.rb | 2 +- .../transformers/material_claim_transformer.rb | 2 +- lib/digital_scriptorium/transformers/name_claim_transformer.rb | 2 +- lib/digital_scriptorium/transformers/note_claim_transformer.rb | 2 +- .../transformers/physical_description_claim_transformer.rb | 2 +- .../transformers/place_claim_transformer.rb | 2 +- .../qualified_claim_transformer_with_facet_fallback.rb | 3 ++- .../transformers/shelfmark_claim_transformer.rb | 2 +- lib/digital_scriptorium/transformers/term_claim_transformer.rb | 2 +- .../transformers/title_claim_transformer.rb | 2 +- .../transformers/uniform_title_claim_transformer.rb | 2 +- 17 files changed, 18 insertions(+), 18 deletions(-) diff --git a/lib/digital_scriptorium/transformers/acknowledgements_claim_transformer.rb b/lib/digital_scriptorium/transformers/acknowledgements_claim_transformer.rb index 0116e8e..07e6f52 100644 --- a/lib/digital_scriptorium/transformers/acknowledgements_claim_transformer.rb +++ b/lib/digital_scriptorium/transformers/acknowledgements_claim_transformer.rb @@ -1,8 +1,7 @@ # frozen_string_literal: true module DigitalScriptorium - # Base transformer class providing a common interface for all transformers. - class AcknowledgementsClaimTransformer < BaseClaimTransformer + # Transformer for acknowledgements (P33) claims. PREFIX = 'acknowledgements' def initialize(claim, _) diff --git a/lib/digital_scriptorium/transformers/date_claim_transformer.rb b/lib/digital_scriptorium/transformers/date_claim_transformer.rb index dc79d90..6173fa9 100644 --- a/lib/digital_scriptorium/transformers/date_claim_transformer.rb +++ b/lib/digital_scriptorium/transformers/date_claim_transformer.rb @@ -3,7 +3,7 @@ require 'time' module DigitalScriptorium - # Base transformer class providing a common interface for all transformers. + # Transformer for production date (P23) claims. class DateClaimTransformer < QualifiedClaimTransformer include PropertyId diff --git a/lib/digital_scriptorium/transformers/dated_claim_transformer.rb b/lib/digital_scriptorium/transformers/dated_claim_transformer.rb index 4ac1f1f..80cb020 100644 --- a/lib/digital_scriptorium/transformers/dated_claim_transformer.rb +++ b/lib/digital_scriptorium/transformers/dated_claim_transformer.rb @@ -1,7 +1,7 @@ # frozen_string_literal: true module DigitalScriptorium - # Base transformer class providing a common interface for all transformers. + # Transformer for dated? (P26) claims. class DatedClaimTransformer < BaseClaimTransformer PREFIX = 'dated' diff --git a/lib/digital_scriptorium/transformers/iiif_manifest_claim_transformer.rb b/lib/digital_scriptorium/transformers/iiif_manifest_claim_transformer.rb index f0aafce..3e6232e 100644 --- a/lib/digital_scriptorium/transformers/iiif_manifest_claim_transformer.rb +++ b/lib/digital_scriptorium/transformers/iiif_manifest_claim_transformer.rb @@ -1,7 +1,7 @@ # frozen_string_literal: true module DigitalScriptorium - # Transformer for extracting links from relevant Digital Scriptorium claims. + # Transformer for IIIF Manifest (P41) claims. class IiifManifestClaimTransformer < LinkClaimTransformer PREFIX = 'iiif_manifest' diff --git a/lib/digital_scriptorium/transformers/institution_claim_transformer.rb b/lib/digital_scriptorium/transformers/institution_claim_transformer.rb index 0811bc6..de5bba6 100644 --- a/lib/digital_scriptorium/transformers/institution_claim_transformer.rb +++ b/lib/digital_scriptorium/transformers/institution_claim_transformer.rb @@ -1,7 +1,7 @@ # frozen_string_literal: true module DigitalScriptorium - # Base transformer class providing a common interface for all transformers. + # Transformer for holding institution (P5) claims. class InstitutionClaimTransformer < QualifiedClaimTransformer include PropertyId diff --git a/lib/digital_scriptorium/transformers/institutional_record_claim_transformer.rb b/lib/digital_scriptorium/transformers/institutional_record_claim_transformer.rb index a9890e2..a0e0f21 100644 --- a/lib/digital_scriptorium/transformers/institutional_record_claim_transformer.rb +++ b/lib/digital_scriptorium/transformers/institutional_record_claim_transformer.rb @@ -1,7 +1,7 @@ # frozen_string_literal: true module DigitalScriptorium - # Transformer for extracting links from relevant Digital Scriptorium claims. + # Transformer for institutional record (P9) claims. class InstitutionalRecordClaimTransformer < LinkClaimTransformer PREFIX = 'institutional_record' diff --git a/lib/digital_scriptorium/transformers/language_claim_transformer.rb b/lib/digital_scriptorium/transformers/language_claim_transformer.rb index e8a9c71..7882970 100644 --- a/lib/digital_scriptorium/transformers/language_claim_transformer.rb +++ b/lib/digital_scriptorium/transformers/language_claim_transformer.rb @@ -1,7 +1,7 @@ # frozen_string_literal: true module DigitalScriptorium - # Transformer for converting qualified claims of Digital Scriptorium items into Solr fields. + # Transformer for language (P21) claims. class LanguageClaimTransformer < QualifiedClaimTransformer include PropertyId diff --git a/lib/digital_scriptorium/transformers/material_claim_transformer.rb b/lib/digital_scriptorium/transformers/material_claim_transformer.rb index 40a45e9..8400168 100644 --- a/lib/digital_scriptorium/transformers/material_claim_transformer.rb +++ b/lib/digital_scriptorium/transformers/material_claim_transformer.rb @@ -1,7 +1,7 @@ # frozen_string_literal: true module DigitalScriptorium - # Transformer for converting qualified claims of Digital Scriptorium items into Solr fields. + # Transformer for material (P30) claims. class MaterialClaimTransformer < QualifiedClaimTransformer include PropertyId diff --git a/lib/digital_scriptorium/transformers/name_claim_transformer.rb b/lib/digital_scriptorium/transformers/name_claim_transformer.rb index 1fa0c4d..9bf24f2 100644 --- a/lib/digital_scriptorium/transformers/name_claim_transformer.rb +++ b/lib/digital_scriptorium/transformers/name_claim_transformer.rb @@ -1,7 +1,7 @@ # frozen_string_literal: true module DigitalScriptorium - # Transformer for name (P14) claims. + # Transformer for associated name (P14) claims. # NOTE: Name claims produce fields prefixes derived from the value of their role (P15) qualifiers # (owner, author, scribe, artist, agent). class NameClaimTransformer < QualifiedClaimTransformerWithFacetFallback diff --git a/lib/digital_scriptorium/transformers/note_claim_transformer.rb b/lib/digital_scriptorium/transformers/note_claim_transformer.rb index 6063e3a..5e502d3 100644 --- a/lib/digital_scriptorium/transformers/note_claim_transformer.rb +++ b/lib/digital_scriptorium/transformers/note_claim_transformer.rb @@ -1,7 +1,7 @@ # frozen_string_literal: true module DigitalScriptorium - # Base transformer class providing a common interface for all transformers. + # Transformer for acknowledgements (P32) claims. class NoteClaimTransformer < BaseClaimTransformer PREFIX = 'note' diff --git a/lib/digital_scriptorium/transformers/physical_description_claim_transformer.rb b/lib/digital_scriptorium/transformers/physical_description_claim_transformer.rb index 0003728..8c7c15e 100644 --- a/lib/digital_scriptorium/transformers/physical_description_claim_transformer.rb +++ b/lib/digital_scriptorium/transformers/physical_description_claim_transformer.rb @@ -1,7 +1,7 @@ # frozen_string_literal: true module DigitalScriptorium - # Base transformer class providing a common interface for all transformers. + # Transformer for physical description (P29) claims. class PhysicalDescriptionClaimTransformer < BaseClaimTransformer PREFIX = 'physical_description' diff --git a/lib/digital_scriptorium/transformers/place_claim_transformer.rb b/lib/digital_scriptorium/transformers/place_claim_transformer.rb index 113f5cc..a157a7d 100644 --- a/lib/digital_scriptorium/transformers/place_claim_transformer.rb +++ b/lib/digital_scriptorium/transformers/place_claim_transformer.rb @@ -1,7 +1,7 @@ # frozen_string_literal: true module DigitalScriptorium - # Transformer for converting qualified claims of Digital Scriptorium items into Solr fields. + # Transformer for place (P28) claims. class PlaceClaimTransformer < QualifiedClaimTransformer include PropertyId diff --git a/lib/digital_scriptorium/transformers/qualified_claim_transformer_with_facet_fallback.rb b/lib/digital_scriptorium/transformers/qualified_claim_transformer_with_facet_fallback.rb index 9cb362f..bae71b9 100644 --- a/lib/digital_scriptorium/transformers/qualified_claim_transformer_with_facet_fallback.rb +++ b/lib/digital_scriptorium/transformers/qualified_claim_transformer_with_facet_fallback.rb @@ -1,7 +1,8 @@ # frozen_string_literal: true module DigitalScriptorium - # Transformer for converting qualified claims of Digital Scriptorium items into Solr fields. + # Transformer for converting qualified claims of Digital Scriptorium items into Solr fields + # with a fallback to the value as-recorded for the facet field. class QualifiedClaimTransformerWithFacetFallback < QualifiedClaimTransformer def facet_values super.any? ? super : [claim.data_value] diff --git a/lib/digital_scriptorium/transformers/shelfmark_claim_transformer.rb b/lib/digital_scriptorium/transformers/shelfmark_claim_transformer.rb index 46df76d..85065ef 100644 --- a/lib/digital_scriptorium/transformers/shelfmark_claim_transformer.rb +++ b/lib/digital_scriptorium/transformers/shelfmark_claim_transformer.rb @@ -1,7 +1,7 @@ # frozen_string_literal: true module DigitalScriptorium - # Base transformer class providing a common interface for all transformers. + # Transformer for shelfmark (P8) claims. class ShelfmarkClaimTransformer < BaseClaimTransformer PREFIX = 'shelfmark' diff --git a/lib/digital_scriptorium/transformers/term_claim_transformer.rb b/lib/digital_scriptorium/transformers/term_claim_transformer.rb index 9455ef5..6fc4ec2 100644 --- a/lib/digital_scriptorium/transformers/term_claim_transformer.rb +++ b/lib/digital_scriptorium/transformers/term_claim_transformer.rb @@ -1,7 +1,7 @@ # frozen_string_literal: true module DigitalScriptorium - # Transformer for converting qualified claims of Digital Scriptorium items into Solr fields. + # Transformer for genre (P18) and subject (P19) claims. class TermClaimTransformer < QualifiedClaimTransformerWithFacetFallback include PropertyId diff --git a/lib/digital_scriptorium/transformers/title_claim_transformer.rb b/lib/digital_scriptorium/transformers/title_claim_transformer.rb index f5f8520..b4ee8db 100644 --- a/lib/digital_scriptorium/transformers/title_claim_transformer.rb +++ b/lib/digital_scriptorium/transformers/title_claim_transformer.rb @@ -1,7 +1,7 @@ # frozen_string_literal: true module DigitalScriptorium - # Transformer for converting qualified claims of Digital Scriptorium items into Solr fields. + # Transformer for title (P10) claims. class TitleClaimTransformer < QualifiedClaimTransformerWithFacetFallback include PropertyId diff --git a/lib/digital_scriptorium/transformers/uniform_title_claim_transformer.rb b/lib/digital_scriptorium/transformers/uniform_title_claim_transformer.rb index 95ede6c..15ad061 100644 --- a/lib/digital_scriptorium/transformers/uniform_title_claim_transformer.rb +++ b/lib/digital_scriptorium/transformers/uniform_title_claim_transformer.rb @@ -1,7 +1,7 @@ # frozen_string_literal: true module DigitalScriptorium - # Base transformer class providing a common interface for all transformers. + # Transformer for uniform title (P12) claims. class UniformTitleClaimTransformer < BaseClaimTransformer PREFIX = 'uniform_title'