cocina_display 0.1.0 → 0.3.0

data/lib/cocina_display/dates/date_range.rb

@@ -0,0 +1,122 @@
+require_relative "date"
+
+module CocinaDisplay
+  module Dates
+    # A date range parsed from Cocina structuredValues.
+    class DateRange < Date
+      attr_reader :start, :stop
+
+      # Construct a DateRange from Cocina hash with structuredValue.
+      # @param cocina [Hash] Cocina date data containing structuredValue
+      # @return [CocinaDisplay::DateRange]
+      # @return [nil] if no parsable start or stop dates are found
+      def self.from_cocina(cocina)
+        return unless cocina["structuredValue"].present?
+
+        dates = cocina["structuredValue"].map { |sv| Date.from_cocina(sv) }
+        start = dates.find(&:start?)
+        stop = dates.find(&:end?)
+        return unless start || stop
+
+        DateRange.new(cocina, start: start, stop: stop)
+      end
+
+      # Create a new date range using two CocinaDisplay::Date objects.
+      # @param cocina [Hash] Cocina date data containing structuredValue
+      # @param start [CocinaDisplay::Date, nil] The start date of the range.
+      # @param stop [CocinaDisplay::Date, nil] The end date of the range.
+      # @return [CocinaDisplay::DateRange]
+      def initialize(cocina, start: nil, stop: nil)
+        @cocina = cocina
+        @start = start
+        @stop = stop
+      end
+
+      # The values of the start and stop dates as an array.
+      # @see CocinaDisplay::Date#value
+      # @return [Array<String>]
+      def value
+        [start&.value, stop&.value]
+      end
+
+      # Key used to sort this date range. Respects BCE/CE ordering and precision.
+      # Ranges are sorted first by their start date, then by their stop date.
+      # @see CocinaDisplay::Date#sort_key
+      # @return [String]
+      def sort_key
+        [start&.sort_key, stop&.sort_key].join(" - ")
+      end
+
+      # Base values of start/end as single string. Used for comparison/deduping.
+      # @note This is important for uniqueness checks in Imprint display.
+      # @return [String]
+      def base_value
+        "#{@start&.base_value}-#{@stop&.base_value}"
+      end
+
+      # The encoding value for the range.
+      # Uses the start encoding, stop encoding, or top-level encoding in that order.
+      # @see CocinaDisplay::Date#encoding
+      # @return [String, nil]
+      def encoding
+        start&.encoding || stop&.encoding || super
+      end
+
+      # Is either date in the range qualified in any way?
+      # @see CocinaDisplay::Date#qualified?
+      # @return [Boolean]
+      def qualified?
+        start&.qualified? || stop&.qualified? || super
+      end
+
+      # Is either date in the range marked as primary?
+      # @see CocinaDisplay::Date#primary?
+      # @return [Boolean]
+      def primary?
+        start&.primary? || stop&.primary? || super
+      end
+
+      # Was either date in the range successfully parsed?
+      # @see CocinaDisplay::Date#parsed_date?
+      # @return [Boolean]
+      def parsed_date?
+        start&.parsed_date? || stop&.parsed_date? || false
+      end
+
+      # Decoded version of the range, if it was encoded. Strips leading zeroes.
+      # @see CocinaDisplay::Date#decoded_value
+      # @return [String]
+      def decoded_value(**kwargs)
+        [
+          start&.decoded_value(**kwargs),
+          stop&.decoded_value(**kwargs)
+        ].uniq.join(" - ")
+      end
+
+      # Decoded range with "BCE" or "CE" and qualifier markers applied.
+      # @see CocinaDisplay::Date#qualified_value
+      # @return [String]
+      def qualified_value
+        if start&.qualifier == stop&.qualifier
+          qualifier = start&.qualifier || stop&.qualifier
+          date = decoded_value
+          return "[ca. #{date}]" if qualifier == "approximate"
+          return "[#{date}?]" if qualifier == "questionable"
+          return "[#{date}]" if qualifier == "inferred"
+
+          date
+        else
+          "#{start&.qualified_value} - #{stop&.qualified_value}"
+        end
+      end
+
+      # Express the range as an EDTF::Interval between the start and stop dates.
+      # @return [EDTF::Interval]
+      def as_interval
+        interval_start = start&.date&.edtf || "open"
+        interval_stop = stop&.date&.edtf || "open"
+        ::Date.edtf("#{interval_start}/#{interval_stop}")
+      end
+    end
+  end
+end

data/lib/cocina_display/imprint.rb

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+require "edtf"
+require "active_support"
+require "active_support/core_ext/enumerable"
+require "active_support/core_ext/object/blank"
+
+require_relative "dates/date"
+require_relative "dates/date_range"
+require_relative "marc_country_codes"
+
+module CocinaDisplay
+  # Wrapper for Cocina events used to generate an imprint statement for display.
+  class Imprint
+    # Parse Cocina dates and convert any non-single dates to DateRange objects.
+    # This ensures that we can correctly deduplicate ranges against single dates.
+    # @param cocina_dates [Array<Hash>] Array of Cocina date hashes
+    # @return [Array<CocinaDisplay::Dates::Date | CocinaDisplay::Dates::DateRange>]
+    def self.parse_dates(cocina_dates)
+      cocina_dates.map { |cd| CocinaDisplay::Dates::Date.from_cocina(cd) }.filter(&:parsable?).compact
+    end
+
+    # Join non-empty values into a string using provided delimiter.
+    # If values already end in delimiter (ignoring whitespace), join with a space instead.
+    # @param values [Array<String>] The values to compact and join
+    # @param delimiter [String] The delimiter to use for joining, default is space
+    def self.compact_and_join(values, delimiter: " ")
+      compacted_values = values.compact_blank.map(&:strip)
+      return compacted_values.first if compacted_values.one?
+
+      compacted_values.reduce(+"") do |result, value|
+        result << if value.end_with?(delimiter.strip)
+          value + " "
+        else
+          value + delimiter
+        end
+      end.delete_suffix(delimiter)
+    end
+
+    attr_reader :cocina, :dates
+
+    # Initialize the imprint with Cocina event data.
+    # @param cocina [Hash] Cocina structured data for a single event
+    def initialize(cocina)
+      @cocina = cocina
+      @dates = self.class.parse_dates(Array(cocina["date"]))
+    end
+
+    # The entire imprint statement formatted as a string for display.
+    # @return [String]
+    def display_str
+      place_pub = self.class.compact_and_join([place_str, publisher_str], delimiter: " : ")
+      edition_place_pub = self.class.compact_and_join([edition_str, place_pub], delimiter: " - ")
+      self.class.compact_and_join([edition_place_pub, date_str], delimiter: ", ")
+    end
+
+    # Were any of the dates encoded?
+    # Used to detect which event(s) most likely represent the actual imprint(s).
+    def date_encoding?
+      @dates.any?(&:encoding?)
+    end
+
+    private
+
+    # The date portion of the imprint statement, comprising all unique dates.
+    # @return [String]
+    def date_str
+      self.class.compact_and_join(unique_dates_for_display.map(&:qualified_value))
+    end
+
+    # The editions portion of the imprint statement, combining all edition notes.
+    # @return [String]
+    def edition_str
+      self.class.compact_and_join(Janeway.enum_for("$.note[?@.type == 'edition'].value", cocina))
+    end
+
+    # The place of publication, combining all location values.
+    # @return [String]
+    def place_str
+      self.class.compact_and_join(locations_for_display, delimiter: " : ")
+    end
+
+    # The publisher information, combining all name values for publishers.
+    # @return [String]
+    def publisher_str
+      self.class.compact_and_join(Janeway.enum_for("$.contributor[?@.role[?@.value == 'publisher']].name[*].value", cocina), delimiter: " : ")
+    end
+
+    # Get the place name for a location, decoding from MARC if necessary.
+    # Ignores the unknown/"various locations" country codes and returns nil.
+    # @param location [Hash] A location hash parsed from Cocina
+    # @return [String] The decoded location name
+    # @return [nil] If no valid location value is found
+    def decoded_location(location)
+      return location["value"] if location["value"].present?
+
+      if location.dig("source", "code") == "marccountry" &&
+          location["code"].present? &&
+          ["xx", "vp"].exclude?(location["code"])
+        CocinaDisplay::MARC_COUNTRY[location["code"]]
+      end
+    end
+
+    # Filter locations to display according to predefined rules.
+    # 1. Prefer unencoded locations (plain value) over encoded ones
+    # 2. If no unencoded locations but there are MARC country codes, decode them
+    # 3. Keep only unique locations after decoding
+    def locations_for_display
+      unencoded_locs, encoded_locs = Array(cocina["location"]).partition { |loc| loc["value"].present? }
+      locs_for_display = unencoded_locs.presence || encoded_locs
+      locs_for_display.map { |loc| decoded_location(loc) }.compact_blank.uniq
+    end
+
+    # Filter dates for uniqueness using base value according to predefined rules.
+    # 1. For a group of dates with the same base value, choose a single one
+    # 2. Prefer unencoded dates over encoded ones when choosing a single date
+    # 3. Remove date ranges that duplicate any unencoded non-range dates
+    # @return [Array<CocinaDisplay::Dates::Date>]
+    # @see CocinaDisplay::Dates::Date#base_value
+    # @see https://consul.stanford.edu/display/chimera/MODS+display+rules#MODSdisplayrules-3b.%3CoriginInfo%3E
+    def unique_dates_for_display
+      # Choose a single date for each group with the same base value
+      deduped_dates = dates.group_by(&:base_value).map do |base_value, group|
+        if (unencoded = group.reject(&:encoding?)).any?
+          unencoded.first
+        else
+          group.first
+        end
+      end
+
+      # Remove any ranges that duplicate part of an unencoded non-range date
+      ranges, singles = deduped_dates.partition { |date| date.is_a?(CocinaDisplay::Dates::DateRange) }
+      unencoded_singles_dates = singles.reject(&:encoding?).flat_map(&:to_a)
+      ranges.reject! { |range| unencoded_singles_dates.any? { |date| range.as_interval.include?(date) } }
+
+      (singles + ranges).sort
+    end
+  end
+end

data/lib/cocina_display/marc_country_codes.rb

@@ -0,0 +1,394 @@
+# frozen_string_literal: true
+
+# Represents the Marc Country Codes mapped to names, from http://www.loc.gov/marc/countries/countries_code.html 2013-01-03
+# key - Marc Country code
+# value - Marc Country term
+
+# Ported from sul-dlss/mods gem
+
+module CocinaDisplay
+  MARC_COUNTRY = {
+    "aa" => "Albania",
+    "abc" => "Alberta",
+    "ac" => "Ashmore and Cartier Islands", # discontinued
+    "aca" => "Australian Capital Territory",
+    "ae" => "Algeria",
+    "af" => "Afghanistan",
+    "ag" => "Argentina",
+    "ai" => "Armenia (Republic)",
+    "air" => "Armenian S.S.R.", # discontinued
+    "aj" => "Azerbaijan",
+    "ajr" => "Azerbaijan S.S.R.", # discontinued
+    "aku" => "Alaska",
+    "alu" => "Alabama",
+    "am" => "Anguilla",
+    "an" => "Andorra",
+    "ao" => "Angola",
+    "aq" => "Antigua and Barbuda",
+    "aru" => "Arkansas",
+    "as" => "American Samoa",
+    "at" => "Australia",
+    "au" => "Austria",
+    "aw" => "Aruba",
+    "ay" => "Antarctica",
+    "azu" => "Arizona",
+    "ba" => "Bahrain",
+    "bb" => "Barbados",
+    "bcc" => "British Columbia",
+    "bd" => "Burundi",
+    "be" => "Belgium",
+    "bf" => "Bahamas",
+    "bg" => "Bangladesh",
+    "bh" => "Belize",
+    "bi" => "British Indian Ocean Territory",
+    "bl" => "Brazil",
+    "bm" => "Bermuda Islands",
+    "bn" => "Bosnia and Herzegovina",
+    "bo" => "Bolivia",
+    "bp" => "Solomon Islands",
+    "br" => "Burma",
+    "bs" => "Botswana",
+    "bt" => "Bhutan",
+    "bu" => "Bulgaria",
+    "bv" => "Bouvet Island",
+    "bw" => "Belarus",
+    "bwr" => "Byelorussian S.S.R.", # discontinued
+    "bx" => "Brunei",
+    "ca" => "Caribbean Netherlands",
+    "cau" => "California",
+    "cb" => "Cambodia",
+    "cc" => "China",
+    "cd" => "Chad",
+    "ce" => "Sri Lanka",
+    "cf" => "Congo (Brazzaville)",
+    "cg" => "Congo (Democratic Republic)",
+    "ch" => "China (Republic : 1949- )",
+    "ci" => "Croatia",
+    "cj" => "Cayman Islands",
+    "ck" => "Colombia",
+    "cl" => "Chile",
+    "cm" => "Cameroon",
+    "cn" => "Canada", # discontinued
+    "co" => "Curaçao",
+    "cou" => "Colorado",
+    "cp" => "Canton and Enderbury Islands", # discontinued
+    "cq" => "Comoros",
+    "cr" => "Costa Rica",
+    "cs" => "Czechoslovakia", # discontinued
+    "ctu" => "Connecticut",
+    "cu" => "Cuba",
+    "cv" => "Cabo Verde",
+    "cw" => "Cook Islands",
+    "cx" => "Central African Republic",
+    "cy" => "Cyprus",
+    "cz" => "Canal Zone", # discontinued
+    "dcu" => "District of Columbia",
+    "deu" => "Delaware",
+    "dk" => "Denmark",
+    "dm" => "Benin",
+    "dq" => "Dominica",
+    "dr" => "Dominican Republic",
+    "ea" => "Eritrea",
+    "ec" => "Ecuador",
+    "eg" => "Equatorial Guinea",
+    "em" => "Timor-Leste",
+    "enk" => "England",
+    "er" => "Estonia",
+    "err" => "Estonia", # discontinued
+    "es" => "El Salvador",
+    "et" => "Ethiopia",
+    "fa" => "Faroe Islands",
+    "fg" => "French Guiana",
+    "fi" => "Finland",
+    "fj" => "Fiji",
+    "fk" => "Falkland Islands",
+    "flu" => "Florida",
+    "fm" => "Micronesia (Federated States)",
+    "fp" => "French Polynesia",
+    "fr" => "France",
+    "fs" => "Terres australes et antarctiques françaises",
+    "ft" => "Djibouti",
+    "gau" => "Georgia",
+    "gb" => "Kiribati",
+    "gd" => "Grenada",
+    "ge" => "Germany (East)", # discontinued
+    "gg" => "Guernsey",
+    "gh" => "Ghana",
+    "gi" => "Gibraltar",
+    "gl" => "Greenland",
+    "gm" => "Gambia",
+    "gn" => "Gilbert and Ellice Islands", # discontinued
+    "go" => "Gabon",
+    "gp" => "Guadeloupe",
+    "gr" => "Greece",
+    "gs" => "Georgia (Republic)",
+    "gsr" => "Georgian S.S.R.", # discontinued
+    "gt" => "Guatemala",
+    "gu" => "Guam",
+    "gv" => "Guinea",
+    "gw" => "Germany",
+    "gy" => "Guyana",
+    "gz" => "Gaza Strip",
+    "hiu" => "Hawaii",
+    "hk" => "Hong Kong", # discontinued
+    "hm" => "Heard and McDonald Islands",
+    "ho" => "Honduras",
+    "ht" => "Haiti",
+    "hu" => "Hungary",
+    "iau" => "Iowa",
+    "ic" => "Iceland",
+    "idu" => "Idaho",
+    "ie" => "Ireland",
+    "ii" => "India",
+    "ilu" => "Illinois",
+    "im" => "Isle of Man",
+    "inu" => "Indiana",
+    "io" => "Indonesia",
+    "iq" => "Iraq",
+    "ir" => "Iran",
+    "is" => "Israel",
+    "it" => "Italy",
+    "iu" => "Israel-Syria Demilitarized Zones", # discontinued
+    "iv" => "Côte d'Ivoire",
+    "iw" => "Israel-Jordan Demilitarized Zones", # discontinued
+    "iy" => "Iraq-Saudi Arabia Neutral Zone",
+    "ja" => "Japan",
+    "je" => "Jersey",
+    "ji" => "Johnston Atoll",
+    "jm" => "Jamaica",
+    "jn" => "Jan Mayen", # discontinued
+    "jo" => "Jordan",
+    "ke" => "Kenya",
+    "kg" => "Kyrgyzstan",
+    "kgr" => "Kirghiz S.S.R.", # discontinued
+    "kn" => "Korea (North)",
+    "ko" => "Korea (South)",
+    "ksu" => "Kansas",
+    "ku" => "Kuwait",
+    "kv" => "Kosovo",
+    "kyu" => "Kentucky",
+    "kz" => "Kazakhstan",
+    "kzr" => "Kazakh S.S.R.", # discontinued
+    "lau" => "Louisiana",
+    "lb" => "Liberia",
+    "le" => "Lebanon",
+    "lh" => "Liechtenstein",
+    "li" => "Lithuania",
+    "lir" => "Lithuania", # discontinued
+    "ln" => "Central and Southern Line Islands", # discontinued
+    "lo" => "Lesotho",
+    "ls" => "Laos",
+    "lu" => "Luxembourg",
+    "lv" => "Latvia",
+    "lvr" => "Latvia", # discontinued
+    "ly" => "Libya",
+    "mau" => "Massachusetts",
+    "mbc" => "Manitoba",
+    "mc" => "Monaco",
+    "mdu" => "Maryland",
+    "meu" => "Maine",
+    "mf" => "Mauritius",
+    "mg" => "Madagascar",
+    "mh" => "Macao", # discontinued
+    "miu" => "Michigan",
+    "mj" => "Montserrat",
+    "mk" => "Oman",
+    "ml" => "Mali",
+    "mm" => "Malta",
+    "mnu" => "Minnesota",
+    "mo" => "Montenegro",
+    "mou" => "Missouri",
+    "mp" => "Mongolia",
+    "mq" => "Martinique",
+    "mr" => "Morocco",
+    "msu" => "Mississippi",
+    "mtu" => "Montana",
+    "mu" => "Mauritania",
+    "mv" => "Moldova",
+    "mvr" => "Moldavian S.S.R.", # discontinued
+    "mw" => "Malawi",
+    "mx" => "Mexico",
+    "my" => "Malaysia",
+    "mz" => "Mozambique",
+    "na" => "Netherlands Antilles", # discontinued
+    "nbu" => "Nebraska",
+    "ncu" => "North Carolina",
+    "ndu" => "North Dakota",
+    "ne" => "Netherlands",
+    "nfc" => "Newfoundland and Labrador",
+    "ng" => "Niger",
+    "nhu" => "New Hampshire",
+    "nik" => "Northern Ireland",
+    "nju" => "New Jersey",
+    "nkc" => "New Brunswick",
+    "nl" => "New Caledonia",
+    "nm" => "Northern Mariana Islands", # discontinued
+    "nmu" => "New Mexico",
+    "nn" => "Vanuatu",
+    "no" => "Norway",
+    "np" => "Nepal",
+    "nq" => "Nicaragua",
+    "nr" => "Nigeria",
+    "nsc" => "Nova Scotia",
+    "ntc" => "Northwest Territories",
+    "nu" => "Nauru",
+    "nuc" => "Nunavut",
+    "nvu" => "Nevada",
+    "nw" => "Northern Mariana Islands",
+    "nx" => "Norfolk Island",
+    "nyu" => "New York (State)",
+    "nz" => "New Zealand",
+    "ohu" => "Ohio",
+    "oku" => "Oklahoma",
+    "onc" => "Ontario",
+    "oru" => "Oregon",
+    "ot" => "Mayotte",
+    "pau" => "Pennsylvania",
+    "pc" => "Pitcairn Island",
+    "pe" => "Peru",
+    "pf" => "Paracel Islands",
+    "pg" => "Guinea-Bissau",
+    "ph" => "Philippines",
+    "pic" => "Prince Edward Island",
+    "pk" => "Pakistan",
+    "pl" => "Poland",
+    "pn" => "Panama",
+    "po" => "Portugal",
+    "pp" => "Papua New Guinea",
+    "pr" => "Puerto Rico",
+    "pt" => "Portuguese Timor", # discontinued
+    "pw" => "Palau",
+    "py" => "Paraguay",
+    "qa" => "Qatar",
+    "qea" => "Queensland",
+    "quc" => "Québec (Province)",
+    "rb" => "Serbia",
+    "re" => "Réunion",
+    "rh" => "Zimbabwe",
+    "riu" => "Rhode Island",
+    "rm" => "Romania",
+    "ru" => "Russia (Federation)",
+    "rur" => "Russian S.F.S.R.", # discontinued
+    "rw" => "Rwanda",
+    "ry" => "Ryukyu Islands, Southern", # discontinued
+    "sa" => "South Africa",
+    "sb" => "Svalbard", # discontinued
+    "sc" => "Saint-Barthélemy",
+    "scu" => "South Carolina",
+    "sd" => "South Sudan",
+    "sdu" => "South Dakota",
+    "se" => "Seychelles",
+    "sf" => "Sao Tome and Principe",
+    "sg" => "Senegal",
+    "sh" => "Spanish North Africa",
+    "si" => "Singapore",
+    "sj" => "Sudan",
+    "sk" => "Sikkim", # discontinued
+    "sl" => "Sierra Leone",
+    "sm" => "San Marino",
+    "sn" => "Sint Maarten",
+    "snc" => "Saskatchewan",
+    "so" => "Somalia",
+    "sp" => "Spain",
+    "sq" => "Eswatini",
+    "sr" => "Surinam",
+    "ss" => "Western Sahara",
+    "st" => "Saint-Martin",
+    "stk" => "Scotland",
+    "su" => "Saudi Arabia",
+    "sv" => "Swan Islands", # discontinued
+    "sw" => "Sweden",
+    "sx" => "Namibia",
+    "sy" => "Syria",
+    "sz" => "Switzerland",
+    "ta" => "Tajikistan",
+    "tar" => "Tajik S.S.R.", # discontinued
+    "tc" => "Turks and Caicos Islands",
+    "tg" => "Togo",
+    "th" => "Thailand",
+    "ti" => "Tunisia",
+    "tk" => "Turkmenistan",
+    "tkr" => "Turkmen S.S.R.", # discontinued
+    "tl" => "Tokelau",
+    "tma" => "Tasmania",
+    "tnu" => "Tennessee",
+    "to" => "Tonga",
+    "tr" => "Trinidad and Tobago",
+    "ts" => "United Arab Emirates",
+    "tt" => "Trust Territory of the Pacific Islands", # discontinued
+    "tu" => "Turkey",
+    "tv" => "Tuvalu",
+    "txu" => "Texas",
+    "tz" => "Tanzania",
+    "ua" => "Egypt",
+    "uc" => "United States Misc. Caribbean Islands",
+    "ug" => "Uganda",
+    "ui" => "United Kingdom Misc. Islands", # discontinued
+    "uik" => "United Kingdom Misc. Islands",
+    "uk" => "United Kingdom", # discontinued
+    "un" => "Ukraine",
+    "unr" => "Ukraine", # discontinued
+    "up" => "United States Misc. Pacific Islands",
+    "ur" => "Soviet Union", # discontinued
+    "us" => "United States", # discontinued
+    "utu" => "Utah",
+    "uv" => "Burkina Faso",
+    "uy" => "Uruguay",
+    "uz" => "Uzbekistan",
+    "uzr" => "Uzbek S.S.R.", # discontinued
+    "vau" => "Virginia",
+    "vb" => "British Virgin Islands",
+    "vc" => "Vatican City",
+    "ve" => "Venezuela",
+    "vi" => "Virgin Islands of the United States",
+    "vm" => "Vietnam",
+    "vn" => "Vietnam, North", # discontinued
+    "vp" => "Various places",
+    "vra" => "Victoria",
+    "vs" => "Vietnam, South", # discontinued
+    "vtu" => "Vermont",
+    "wau" => "Washington (State)",
+    "wb" => "West Berlin", # discontinued
+    "wea" => "Western Australia",
+    "wf" => "Wallis and Futuna",
+    "wiu" => "Wisconsin",
+    "wj" => "West Bank of the Jordan River",
+    "wk" => "Wake Island",
+    "wlk" => "Wales",
+    "ws" => "Samoa",
+    "wvu" => "West Virginia",
+    "wyu" => "Wyoming",
+    "xa" => "Christmas Island (Indian Ocean)",
+    "xb" => "Cocos (Keeling) Islands",
+    "xc" => "Maldives",
+    "xd" => "Saint Kitts-Nevis",
+    "xe" => "Marshall Islands",
+    "xf" => "Midway Islands",
+    "xga" => "Coral Sea Islands Territory",
+    "xh" => "Niue",
+    "xi" => "Saint Kitts-Nevis-Anguilla", # discontinued
+    "xj" => "Saint Helena",
+    "xk" => "Saint Lucia",
+    "xl" => "Saint Pierre and Miquelon",
+    "xm" => "Saint Vincent and the Grenadines",
+    "xn" => "North Macedonia",
+    "xna" => "New South Wales",
+    "xo" => "Slovakia",
+    "xoa" => "Northern Territory",
+    "xp" => "Spratly Island",
+    "xr" => "Czech Republic",
+    "xra" => "South Australia",
+    "xs" => "South Georgia and the South Sandwich Islands",
+    "xv" => "Slovenia",
+    "xx" => "No place, unknown, or undetermined",
+    "xxc" => "Canada",
+    "xxk" => "United Kingdom",
+    "xxr" => "Soviet Union", # discontinued
+    "xxu" => "United States",
+    "ye" => "Yemen",
+    "ykc" => "Yukon Territory",
+    "ys" => "Yemen (People's Democratic Republic)", # discontinued
+    "yu" => "Serbia and Montenegro", # discontinued
+    "za" => "Zambia"
+  }.freeze
+end