Emoji flags

Convert a two character ISO country code to an emoji flag

We often store references to countries in our applications as a two-letter code inline using the ISO 3166-1 alpha-2 standard. For example, “GB” for the United Kingdom or “US” for the United States.

But the people demand emoji and who are we to deny them?

def emoji_flag(country_code)
  cc = country_code.to_s.upcase
  return unless cc =~ /\A[A-Z]{2}\z/

  cc.codepoints.map { |c| (c + 127397).chr(Encoding::UTF_8) }.join

> emoji_flag("eu")
#=> "🇪🇺"

How does this work?

The first two lines can be classed as ‘defensive code’, which makes the method more resilient against different kinds of input.

cc = country_code.to_s.upcase

…ensures you’re working with an upper case string. And…

return unless cc =~ /\A[A-Z]{2}\z/

…provides an early return of nil when the passed string isn’t two capital letters.

You could make an argument and say we should return "" rather than nil to ensure the method always returns a string, but although it can be a pain, it’s more “ruby-ish” to return nil.

The clever bit, explained

Every country (and some previously existing countries) has a unique two-character code.

There is a unique Unicode character for every capital letter and within that there are 26 sequential regional indicator symbols. This means A has a corresponding 🇦 regional indicator.

An emoji flag is constructed by the text rendering of your operating system using two of these unicode indicator characters. For example, the 🇪🇺 character displayed on your screen is made up from a UTF-8 string containing the 🇪 and 🇺 characters consecutively.

=> ["🇪", "🇺"]

The Unicode table of characters contains both these regional indicators and the standard capital letter characters.

The character A is at codepoint 65, its corresponding 🇦 is at codepoint 127,462. There’s a consistent difference of 127,397 between each capital and its matching regional indicator. This “magic” number is the key to the translation method.

The main functionality of the code relies on breaking up the two-character string and converting each character into its numerical representation, found in the ASCII/UTF-8 character table via the #codepoints method. Then add 127,397 to each codepoint then convert this new reference back to a UTF-8 encoded character. Finally we #join the two regional indicator characters back together into a String.

If we were to explore this process step-by-step for France…

=> [70, 82]

70 + 127397
=> 127467

=> "🇫"

82 + 127397
=> 1274879

=> "🇷"

["🇫", "🇷"].join
=> "🇫🇷"

"🇫🇷".codepoints # to check
=> [127467, 127479]

We rely on the combined UTF-8 text-rendering of ruby and a modern operating system to ensure the flag is displayed instead of the two indicator characters.

This method is pretty forgiving, because of the thoughtful structure of the Unicode character table. If an unused country code is passed it renders the two regional indicators as a fallback.

=> "🇦🇦"

last updated on 01 Feb 2021 by @andycroll

Don’t miss my next post, sign up to the One Ruby Thing email and get my next post in your inbox.

Don’t miss my next post, sign up to the One Ruby Thing email and get my next post in your inbox.