1  #--
   2  # Copyright (c) 2006 Philip Ross
   3  # 
   4  # Permission is hereby granted, free of charge, to any person obtaining a copy
   5  # of this software and associated documentation files (the "Software"), to deal
   6  # in the Software without restriction, including without limitation the rights
   7  # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   8  # copies of the Software, and to permit persons to whom the Software is
   9  # furnished to do so, subject to the following conditions:
  10  # 
  11  # The above copyright notice and this permission notice shall be included in all
  12  # copies or substantial portions of the Software.
  13  #
  14  # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  15  # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  16  # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  17  # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  18  # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  19  # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  20  # THE SOFTWARE.
  21  #++
  22 
  23  require 'tzinfo/data_timezone_info'
  24  require 'tzinfo/linked_timezone_info'
  25 
  26  module TZInfo
  27    
  28    # TimezoneDefinition is included into Timezone definition modules.
  29    # TimezoneDefinition provides the methods for defining timezones.
  30    module TimezoneDefinition #:nodoc:
  31      # Add class methods to the includee.
  32      def self.append_features(base)
  33        super
  34        base.extend(ClassMethods)
  35      end
  36      
  37      # Class methods for inclusion.
  38      module ClassMethods #:nodoc:
  39        # Returns and yields a DataTimezoneInfo object to define a timezone.
  40        def timezone(identifier)
  41          yield @timezone = DataTimezoneInfo.new(identifier)
  42        end
  43        
  44        # Defines a linked timezone.
  45        def linked_timezone(identifier, link_to_identifier)
  46          @timezone = LinkedTimezoneInfo.new(identifier, link_to_identifier)
  47        end
  48        
  49        # Returns the last TimezoneInfo to be defined with timezone or 
  50        # linked_timezone.
  51        def get
  52          @timezone
  53        end
  54      end
  55    end
  56  end