canvas-lms/lib/i18n_time_zone.rb

55 lines
1.9 KiB
Ruby

# frozen_string_literal: true
#
# Copyright (C) 2011 - present Instructure, Inc.
#
# This file is part of Canvas.
#
# Canvas is free software: you can redistribute it and/or modify it under
# the terms of the GNU Affero General Public License as published by the Free
# Software Foundation, version 3 of the License.
#
# Canvas is distributed in the hope that it will be useful, but WITHOUT ANY
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
# A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
# details.
#
# You should have received a copy of the GNU Affero General Public License along
# with this program. If not, see <http://www.gnu.org/licenses/>.
# i18n friendly ActiveSupport::TimeZone subclass extended to play nicely with
# our #time_zone_options_for_select method on ActionView::Helpers::InstanceTag
class I18nTimeZone < ActiveSupport::TimeZone
# this initialization doesn't get inherited, apparently
@lazy_zones_map = Concurrent::Map.new
@country_zones = Concurrent::Map.new
# override to include both standard and DST offsets if they exist
def formatted_offset(colon = true)
return super unless tzinfo
period = tzinfo.current_period
# not planning on ever switching to/from DST again
return super unless period.end_transition
other_period = tzinfo.period_for_utc(period.end_transition.at)
# always sort the DST offset second
periods = [period, other_period].sort_by { |p| p.dst? ? 1 : 0 }
periods.map { |p| self.class.seconds_to_utc_offset(p.utc_offset + p.std_offset, colon) }.join('/')
end
def to_s
translated_name = I18n.send(:translate, keyify) || name
"#{translated_name} (#{formatted_offset})"
end
def keyify
"time_zones.#{name.gsub(/(\W|\s|-)/, '').underscore}"
end
def self.us_zones
# only include specially named zones
super.select { |zone| ActiveSupport::TimeZone::MAPPING.include?(zone.name) }
end
end