cocina_display 1.1.3 → 1.2.1

data/config/searchworks_languages.yml

@@ -0,0 +1,520 @@
+# Map of language codes to language names used in Searchworks, ported from stanford-mods gem.
+# See: https://github.com/solrmarc/stanford-solr-marc/blob/master/stanford-sw/translation_maps/language_map.properties
+
+aaa: Afar
+abk: Abkhaz
+ace: Achinese
+ach: Acoli
+ada: Adangme
+ady: Adygei
+afa: Afroasiatic (Other)
+afh: Afrihili (Artificial language)
+afr: Afrikaans
+ain: Ainu
+ajm: Aljamia
+aka: Akan
+akk: Akkadian
+alb: Albanian
+ale: Aleut
+alg: Algonquian (Other)
+alt: Altai
+amh: Amharic
+ang: English, Old (ca. 450-1100)
+anp: Angika
+apa: Apache languages
+ara: Arabic
+arc: Aramaic
+arg: Aragonese Spanish
+arm: Armenian
+arn: Mapuche
+arp: Arapaho
+art: Artificial (Other)
+arw: Arawak
+ase: American Sign Language
+asm: Assamese
+ast: Bable
+ath: Athapascan (Other)
+aus: Australian languages
+ava: Avaric
+ave: Avestan
+awa: Awadhi
+aym: Aymara
+aze: Azerbaijani
+bad: Banda
+bai: Bamileke languages
+bak: Bashkir
+bal: Baluchi
+bam: Bambara
+ban: Balinese
+baq: Basque
+bas: Basa
+bat: Baltic (Other)
+bej: Beja
+bel: Belarusian
+bem: Bemba
+ben: Bengali
+ber: Berber (Other)
+bho: Bhojpuri
+bih: Bihari
+bik: Bikol
+bin: Edo
+bis: Bislama
+bla: Siksika
+bnt: Bantu (Other)
+bos: Bosnian
+bra: Braj
+bre: Breton
+btk: Batak
+bua: Buriat
+bug: Bugis
+bul: Bulgarian
+bur: Burmese
+byn: Bilin
+cad: Caddo
+cai: Central American Indian (Other)
+cam: Khmer
+car: Carib
+cat: Catalan
+cau: Caucasian (Other)
+ceb: Cebuano
+cel: Celtic (Other)
+cha: Chamorro
+chb: Chibcha
+che: Chechen
+chg: Chagatai
+chi: Chinese
+chk: Truk
+chm: Mari
+chn: Chinook jargon
+cho: Choctaw
+chp: Chipewyan
+chr: Cherokee
+chu: Church Slavic
+chv: Chuvash
+chy: Cheyenne
+cmc: Chamic languages
+cop: Coptic
+cor: Cornish
+cos: Corsican
+cpe: Creoles and Pidgins, English-based (Other)
+cpf: Creoles and Pidgins, French-based (Other)
+cpp: Creoles and Pidgins, Portuguese-based (Other)
+cre: Cree
+crh: Crimean Tatar
+crp: Creoles and Pidgins (Other)
+csb: Kashubian
+cus: Cushitic (Other)
+cze: Czech
+dak: Dakota
+dan: Danish
+dar: Dargwa
+day: Dayak
+del: Delaware
+den: Slave
+dgr: Dogrib
+din: Dinka
+div: Divehi
+doi: Dogri
+dra: Dravidian (Other)
+dsb: Lower Sorbian
+dua: Duala
+dum: Dutch, Middle (ca. 1050-1350)
+dut: Dutch
+dyu: Dyula
+dzo: Dzongkha
+efi: Efik
+egy: Egyptian
+egy-Egyd: Egyptian, Demotic
+eka: Ekajuk
+elx: Elamite
+eng: English
+enm: English, Middle (1100-1500)
+epo: Esperanto
+esk: Eskimo languages
+esp: Esperanto
+est: Estonian
+eth: Ethiopic
+ewe: Ewe
+ewo: Ewondo
+fan: Fang
+fao: Faroese
+far: Faroese
+fat: Fanti
+fij: Fijian
+fil: Filipino
+fin: Finnish
+fiu: Finno-Ugrian (Other)
+fon: Fon
+fre: French
+fri: Frisian
+frm: French, Middle (ca. 1400-1600)
+fro: French, Old (ca. 842-1400)
+frr: North Frisian
+frs: East Frisian
+fry: Frisian
+ful: Fula
+fur: Friulian
+gaa: Ga
+gae: Scottish Gaelic
+gag: Galician
+gal: Oromo
+gay: Gayo
+gba: Gbaya
+gem: Germanic (Other)
+geo: Georgian
+ger: German
+gez: Ethiopic
+gil: Gilbertese
+gla: Scottish Gaelic
+gle: Irish
+glg: Galician
+glv: Manx
+gmh: German, Middle High (ca. 1050-1500)
+goh: German, Old High (ca. 750-1050)
+gon: Gondi
+gor: Gorontalo
+got: Gothic
+grb: Grebo
+grc: Greek, Ancient (to 1453)
+gre: Greek, Modern (1453- )
+grn: Guarani
+gsw: Swiss German
+gua: Guarani
+guj: Gujarati
+gwi: Gwich'in 
+hai: Haida
+hat: Haitian French Creole
+hau: Hausa
+haw: Hawaiian
+heb: Hebrew
+her: Herero
+hil: Hiligaynon
+him: Himachali
+hin: Hindi
+hit: Hittite
+hmn: Hmong
+hmo: Hiri Motu
+hrv: Croatian
+hsb: Upper Sorbian
+hun: Hungarian
+hup: Hupa
+iba: Iban
+ibo: Igbo
+ice: Icelandic
+ido: Ido
+iii: Sichuan Yi
+ijo: Ijo
+iku: Inuktitut
+ile: Interlingue
+ilo: Iloko
+ina: Interlingua (International Auxiliary Language Association)
+inc: Indic (Other)
+ind: Indonesian
+ine: Indo-European (Other)
+inh: Ingush
+int: Interlingua (International Auxiliary Language Association)
+ipk: Inupiaq
+ira: Iranian (Other)
+iri: Irish
+iro: Iroquoian (Other)
+ita: Italian
+jav: Javanese
+jbo: Lojban (Artificial language)
+jpn: Japanese
+jpr: Judeo-Persian
+jrb: Judeo-Arabic
+kaa: Kara-Kalpak
+kab: Kabyle
+kac: Kachin
+kal: Kalatdlisut
+kam: Kamba
+kan: Kannada
+kar: Karen
+kas: Kashmiri
+kau: Kanuri
+kaw: Kawi
+kaz: Kazakh
+kbd: Kabardian
+kha: Khasi
+khi: Khoisan (Other)
+khm: Khmer
+kho: Khotanese
+kik: Kikuyu
+kin: Kinyarwanda
+kir: Kyrgyz
+kmb: Kimbundu
+kok: Konkani
+kom: Komi
+kon: Kongo
+kor: Korean
+kos: Kusaie
+kpe: Kpelle
+krc: Karachay-Balkar
+krl: Karelian
+kro: Kru
+kru: Kurukh
+kua: Kuanyama
+kum: Kumyk
+kur: Kurdish
+kus: Kusaie
+kut: Kutenai
+lad: Ladino
+lah: Lahnda
+lam: Lamba
+lan: Occitan (post-1500)
+lao: Lao
+lap: Sami
+lat: Latin
+lav: Latvian
+lez: Lezgian
+lim: Limburgish
+lin: Lingala
+lit: Lithuanian
+lol: Mongo-Nkundu
+loz: Lozi
+ltz: Letzeburgesch
+lua: Luba-Lulua
+lub: Luba-Katanga
+lug: Ganda
+lui: Luiseno
+lun: Lunda
+luo: Luo (Kenya and Tanzania)
+lus: Lushai
+mac: Macedonian
+mad: Madurese
+mag: Magahi
+mah: Marshallese
+mai: Maithili
+mak: Makasar
+mal: Malayalam
+man: Mandingo
+mao: Maori
+map: Austronesian (Other)
+mar: Marathi
+mas: Masai
+max: Manx
+may: Malay
+mdf: Moksha
+mdr: Mandar
+men: Mende
+mga: Irish, Middle (ca. 1100-1550)
+mic: Micmac
+min: Minangkabau
+# mis: Miscellaneous languages
+mkh: Mon-Khmer (Other)
+mla: Malagasy
+mlg: Malagasy
+mlt: Maltese
+mnc: Manchu
+mni: Manipuri
+mno: Manobo languages
+moh: Mohawk
+mol: Moldavian
+mon: Mongolian
+mos: Moore
+# mul: Multiple languages
+mun: Munda (Other)
+mus: Creek
+mwl: Mirandese
+mwr: Marwari
+myn: Mayan languages
+myv: Erzya
+nah: Nahuatl
+nai: North American Indian (Other)
+nap: Neapolitan Italian
+nau: Nauru
+nav: Navajo
+nbl: Ndebele (South Africa)
+nde: Ndebele (Zimbabwe)
+ndo: Ndonga
+nds: Low German
+nep: Nepali
+new: Newari
+nia: Nias
+nic: Niger-Kordofanian (Other)
+niu: Niuean
+nno: Norwegian (Nynorsk)
+nob: Norwegian (Bokmal)
+nog: Nogai
+non: Old Norse
+nor: Norwegian
+nqo: N'Ko
+nso: Northern Sotho
+nub: Nubian languages
+nwc: Newari, Old
+nya: Nyanja
+nym: Nyamwezi
+nyn: Nyankole
+nyo: Nyoro
+nzi: Nzima
+oci: Occitan (post-1500)
+oji: Ojibwa
+ori: Oriya
+orm: Oromo
+osa: Osage
+oss: Ossetic
+ota: Turkish, Ottoman
+oto: Otomian languages
+paa: Papuan (Other)
+pag: Pangasinan
+pal: Pahlavi
+pam: Pampanga
+pan: Panjabi
+pap: Papiamento
+pau: Palauan
+peo: Old Persian (ca. 600-400 B.C.)
+per: Persian
+phi: Philippine (Other)
+phn: Phoenician
+pli: Pali
+pol: Polish
+pon: Ponape
+por: Portuguese
+pra: Prakrit languages
+pro: Provencal (to 1500)
+pus: Pushto
+que: Quechua
+raj: Rajasthani
+rap: Rapanui
+rar: Rarotongan
+roa: Romance (Other)
+roh: Raeto-Romance
+rom: Romani
+rum: Romanian
+run: Rundi
+rup: Aromanian
+rus: Russian
+sad: Sandawe
+sag: Sango (Ubangi Creole)
+sah: Yakut
+sai: South American Indian (Other)
+sal: Salishan languages
+sam: Samaritan Aramaic
+san: Sanskrit
+sao: Samoan
+sas: Sasak
+sat: Santali
+scc: Serbian
+scn: Sicilian Italian
+sco: Scots
+scr: Croatian
+sel: Selkup
+sem: Semitic (Other)
+sga: Irish, Old (to 1100)
+sgn: Sign languages
+shn: Shan
+sho: Shona
+sid: Sidamo
+sin: Sinhalese
+sio: Siouan (Other)
+sit: Sino-Tibetan (Other)
+sla: Slavic (Other)
+slo: Slovak
+slv: Slovenian
+sma: Southern Sami
+sme: Northern Sami
+smi: Sami
+smj: Lule Sami
+smn: Inari Sami
+smo: Samoan
+sms: Skolt Sami
+sna: Shona
+snd: Sindhi
+snh: Sinhalese
+snk: Soninke
+sog: Sogdian
+som: Somali
+son: Songhai
+sot: Sotho
+spa: Spanish
+srd: Sardinian
+srn: Sranan
+srp: Serbian
+srr: Serer
+ssa: Nilo-Saharan (Other)
+sso: Sotho
+ssw: Swazi
+suk: Sukuma
+sun: Sundanese
+sus: Susu
+sux: Sumerian
+swa: Swahili
+swe: Swedish
+swz: Swazi
+syc: Syriac
+syr: Syriac, Modern
+tag: Tagalog
+tah: Tahitian
+tai: Tai (Other)
+taj: Tajik
+tam: Tamil
+tar: Tatar
+tat: Tatar
+tel: Telugu
+tem: Temne
+ter: Terena
+tet: Tetum
+tgk: Tajik
+tgl: Tagalog
+tha: Thai
+tib: Tibetan
+tig: Tigre
+tir: Tigrinya
+tiv: Tiv
+tkl: Tokelauan
+tlh: Klingon (Artificial language)
+tli: Tlingit
+tmh: Tamashek
+tog: Tonga (Nyasa)
+ton: Tongan
+tpi: Tok Pisin
+tru: Truk
+tsi: Tsimshian
+tsn: Tswana
+tso: Tsonga
+tsw: Tswana
+tuk: Turkmen
+tum: Tumbuka
+tup: Tupi languages
+tur: Turkish
+tut: Altaic (Other)
+tvl: Tuvaluan
+twi: Twi
+tyv: Tuvinian
+udm: Udmurt
+uga: Ugaritic
+uig: Uighur
+ukr: Ukrainian
+umb: Umbundu
+# und: Undetermined
+urd: Urdu
+uzb: Uzbek
+vai: Vai
+ven: Venda
+vie: Vietnamese
+vol: Volapuk
+vot: Votic
+wak: Wakashan languages
+wal: Walamo
+war: Waray
+was: Washo
+wel: Welsh
+wen: Sorbian languages
+wln: Walloon
+wol: Wolof
+xal: Kalmyk
+xho: Xhosa
+yao: Yao (Africa)
+yap: Yapese
+yid: Yiddish
+yor: Yoruba
+ypk: Yupik languages
+zap: Zapotec
+zbl: Blissymbolics
+zen: Zenaga
+zha: Zhuang
+znd: Zande
+zul: Zulu
+zun: Zuni
+# zxx: null
+zza: Zaza

data/lib/cocina_display/cocina_record.rb

@@ -1,46 +1,31 @@
 # frozen_string_literal: true
 
-require "janeway"
-require "json"
-require "net/http"
-require "active_support"
-require "active_support/core_ext/object/blank"
-require "active_support/core_ext/hash/conversions"
-
-require_relative "concerns/events"
-require_relative "concerns/contributors"
-require_relative "concerns/identifiers"
-require_relative "concerns/titles"
-require_relative "concerns/access"
-require_relative "concerns/subjects"
-require_relative "concerns/forms"
-require_relative "concerns/languages"
-require_relative "concerns/geospatial"
-require_relative "concerns/structural"
-require_relative "utils"
-
 module CocinaDisplay
   # Public Cocina metadata for an SDR object, as fetched from PURL.
-  class CocinaRecord
+  class CocinaRecord < JsonBackedRecord
+    include CocinaDisplay::Concerns::Accesses
     include CocinaDisplay::Concerns::Events
     include CocinaDisplay::Concerns::Contributors
     include CocinaDisplay::Concerns::Identifiers
+    include CocinaDisplay::Concerns::Notes
     include CocinaDisplay::Concerns::Titles
-    include CocinaDisplay::Concerns::Access
+    include CocinaDisplay::Concerns::UrlHelpers
     include CocinaDisplay::Concerns::Subjects
     include CocinaDisplay::Concerns::Forms
     include CocinaDisplay::Concerns::Languages
     include CocinaDisplay::Concerns::Geospatial
     include CocinaDisplay::Concerns::Structural
+    include CocinaDisplay::Concerns::RelatedResources
 
     # Fetch a public Cocina document from PURL and create a CocinaRecord.
     # @note This is intended to be used in development or testing only.
     # @param druid [String] The bare DRUID of the object to fetch.
+    # @param purl_url [String] The base url for the purl service.
     # @param deep_compact [Boolean] If true, compact the JSON to remove blank values.
     # @return [CocinaDisplay::CocinaRecord]
     # :nocov:
-    def self.fetch(druid, deep_compact: false)
-      from_json(Net::HTTP.get(URI("https://purl.stanford.edu/#{druid}.json")), deep_compact: deep_compact)
+    def self.fetch(druid, deep_compact: true, purl_url: "https://purl.stanford.edu")
+      from_json(Net::HTTP.get(URI("#{purl_url}/#{druid}.json")), deep_compact: deep_compact)
     end
     # :nocov:
 
@@ -53,28 +38,6 @@ module CocinaDisplay
       deep_compact ? new(Utils.deep_compact_blank(cocina_doc)) : new(cocina_doc)
     end
 
-    # The parsed Cocina document.
-    # @return [Hash]
-    attr_reader :cocina_doc
-
-    # Initialize a CocinaRecord with a Cocina document hash.
-    # @param cocina_doc [Hash]
-    def initialize(cocina_doc)
-      @cocina_doc = cocina_doc
-    end
-
-    # Evaluate a JSONPath expression against the Cocina document.
-    # @return [Enumerator] An enumerator that yields results matching the expression.
-    # @param path_expression [String] The JSONPath expression to evaluate.
-    # @see https://www.rubydoc.info/gems/janeway-jsonpath/0.6.0/file/README.md
-    # @example Name values for contributors
-    #  record.path("$.description.contributor.*.name.*.value").search #=> ["Smith, John", "ACME Corp."]
-    # @example Filtering nodes using a condition
-    #  record.path("$.description.contributor[?(@.type == 'person')].name.*.value").search #=> ["Smith, John"]
-    def path(path_expression)
-      Janeway.enum_for(path_expression, cocina_doc)
-    end
-
     # Timestamp when the Cocina was created.
     # @note This is for the metadata itself, not the object.
     # @return [Time]
@@ -96,7 +59,7 @@ module CocinaDisplay
     # @example
     #  record.content_type #=> "image"
     def content_type
-      cocina_doc["type"]&.split("/")&.last
+      cocina_doc["type"].delete_prefix("https://cocina.sul.stanford.edu/models/")
     end
 
     # Primary processing label for the object.
@@ -112,27 +75,29 @@ module CocinaDisplay
       content_type == "collection"
     end
 
-    # Resources related to the object.
-    # @return [Array<CocinaDisplay::RelatedResource>]
-    def related_resources
-      @related_resources ||= path("$.description.relatedResource[*]").map { |res| RelatedResource.new(res) }
+    # Copyright statement from Cocina access metadata.
+    # @return [String, nil]
+    def copyright
+      cocina_doc.dig("access", "copyright")
     end
-  end
 
-  # A resource related to the record; behaves like a CocinaRecord.
-  # @note Related resources have no structural metadata.
-  class RelatedResource < CocinaRecord
-    # Description of the relation to the source record.
-    # @return [String]
-    # @example "is part of"
-    # @see https://github.com/sul-dlss/cocina-models/blob/main/docs/description_types.md#relatedresource-types
-    attr_reader :type
+    # Use and reproduction statement from Cocina access metadata.
+    # @return [String, nil]
+    def use_and_reproduction
+      cocina_doc.dig("access", "useAndReproductionStatement")
+    end
 
-    # Restructure the hash so that everything is under "description" key, since
-    # it's all descriptive metadata. This makes most CocinaRecord methods work.
-    def initialize(cocina_doc)
-      @type = cocina_doc["type"]
-      @cocina_doc = {"description" => cocina_doc.except("type")}
+    # Description of the license
+    # @return [String, nil]
+    def license_description
+      @license_description ||=
+        license ? License.new(url: license).description : nil
+    end
+
+    # License URI
+    # @return [String, nil]
+    def license
+      cocina_doc.dig("access", "license")
     end
   end
 end