timezone 0.1.3 → 0.1.4

data/.gitignore

@@ -2,5 +2,6 @@
 .DS_Store
 .rvmrc
 .bundle
+.idea/*
 Gemfile.lock
 pkg/*

data/README.markdown

@@ -47,4 +47,37 @@ Finally, pass the coordinates to your timezone initialization function.
 Retrieving the complete list of timezones is quite simple:
 
     timezones = Timezone::Zone.names
-    => ["Africa/Abidjan", "Africa/Accra", "Africa/Addis_Ababa", "Africa/Algiers", ...]
+    => ["Africa/Abidjan", "Africa/Accra", "Africa/Addis_Ababa", "Africa/Algiers", ...]
+    
+## Listing current information from specific timezones
+
+If you need information from a specific set of timezones rather than a complete list or one at a time, this can be accomplished with the following:
+
+    zone_list = Timezone::Zone.list "America/Chicago", "America/New_York", "America/Boise"
+    # This will return an array of information hashes in the following format:
+    # { 
+    #   :zone => "America/Chicago",
+    #   :title => "America/Chicago", # this can be customized to your needs
+    #   :offset => -18000, # UTC offset in seconds
+    #   :utc_offset => -5, # UTC offset in hours
+    #   :dst => false
+    # }
+    
+You can customize what is placed in the `:title` key in the configuration block. This would be useful in the case of an HTML select list that you would like to display different values than the default name.  For example, the following configuration will set the `:title` key in the list hash to "Chicago" rather than "America/Chicago".
+
+    Timezone::Configure.build do |c|
+      c.replace "America/Chicago", with: "Chicago"
+    end
+    
+Also, if you make numerous calls to the **Zone#list** method in your software, but you would like to avoid duplicating which timezones to retrieve, you can set a default in the configuration:
+
+    Timezone::Configure.begin do |c|
+      c.default_for_list = "America/Chicago", "America/New_York", "Australia/Sydney"
+    end
+    
+Finally, by default the **Zone#list** method will order the results by the timezone's UTC offset. You can customize this behavior this way:
+
+    Timezone::Configure.begin do |c|
+      # this can equal any hash key returned by the Zone#list method
+      c.order_list_by = :title 
+    end

data/lib/timezone/configure.rb

@@ -9,16 +9,50 @@ module Timezone
   # your application for latitude and longitude based timezone searches. If you aren't going to
   # initialize timezone objects based on latitude and longitude then this configuration is not necessary.
   class Configure
+    def self.url
+      @@url ||= 'ws.geonames.org'
+    end
+
+    def self.url= url
+      @@url = url
+    end
+
     def self.username
       @@username
     end
-    
+
     def self.username= username
       @@username = username
     end
-    
+
     def self.begin
       yield self
     end
+
+    def self.replace(what, with = Hash.new)
+      replacements # instantiate @@replacements
+      @@replacements[what] = with[:with]
+    end
+
+    def self.replacements
+      @@replacements ||= {}
+    end
+
+    def self.default_for_list
+      @@default_list ||= nil
+    end
+
+    def self.default_for_list=(*list)
+      @@default_list = list.flatten!
+    end
+
+    def self.order_list_by
+      @@order_by ||= :utc_offset
+    end
+
+    def self.order_list_by=(order)
+      @@order_by = order
+    end
+
   end
-end
+end

data/lib/timezone/version.rb

@@ -1,3 +1,3 @@
 module Timezone
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

data/lib/timezone/zone.rb

@@ -38,28 +38,6 @@ module Timezone
       @zone = data['_zone'] || options[:zone]
     end
 
-
-    class << self
-
-      # Retrieve the data from a particular time zone
-      def get_zone_data(zone)
-        file = File.join(ZONE_FILE_PATH, "#{zone}.json")
-        begin
-          return JSON.parse(open(file).read)
-        rescue
-          raise Timezone::Error::InvalidZone, "'#{zone}' is not a valid zone."
-        end
-      end
-
-      # Instantly grab all possible time zone names.
-      def names
-        Dir[File.join(ZONE_FILE_PATH, "**/**/*.json")].collect do |file|
-          file.gsub("#{ZONE_FILE_PATH}/", '').gsub(/\.json/, '')
-        end
-      end
-
-    end
-
     # Determine the time in the timezone.
     #
     #   timezone.time(reference)
@@ -84,16 +62,64 @@ module Timezone
       utc_offset <=> zone.utc_offset
     end
 
-    private
+    class << self
+
+      # Retrieve the data from a particular time zone
+      def get_zone_data(zone)
+        file = File.join(ZONE_FILE_PATH, "#{zone}.json")
+        begin
+          return JSON.parse(open(file).read)
+        rescue
+          raise Timezone::Error::InvalidZone, "'#{zone}' is not a valid zone."
+        end
+      end
+
+      # Instantly grab all possible time zone names.
+      def names
+        @@names ||= Dir[File.join(ZONE_FILE_PATH, "**/**/*.json")].collect do |file|
+          file.gsub("#{ZONE_FILE_PATH}/", '').gsub(".json", '')
+        end
+      end
+
+      # Get a list of specified timezones and the basic information accompanying that zone
+      #
+      #   zones = Timezone::Zone.infos(zones)
+      #
+      # zones - An array of timezone names. (i.e. Timezone::Zones.infos("America/Chicago", "Australia/Sydney"))
+      #
+      # The result is a Hash of timezones with their title, offset in seconds, UTC offset, and if it uses DST.
+      #
+      def list(*args)
+        args = nil if args.empty? # set to nil if no args are provided
+        zones = args || Configure.default_for_list || self.names # get default list
+        list = self.names.select { |name| zones.include? name } # only select zones if they exist
+
+        @zones = []
+        list.each do |zone|
+          item = Zone.new(zone: zone)
+          @zones << {
+            :zone => item.zone,
+            :title => Configure.replacements[item.zone] || item.zone,
+            :offset => item.utc_offset,
+            :utc_offset => (item.utc_offset/(60*60)),
+            :dst => item.time(Time.now).dst?
+          }
+        end
+        @zones.sort_by! { |zone| zone[Configure.order_list_by] }
+      end
+
+    end
+
+  private
 
     def rule_for_reference reference
       reference = reference.utc
-      rules.detect{ |rule| _parsetime(rule['_from']) <= reference && _parsetime(rule['_to']) > reference }
+      @rules.detect{ |rule| _parsetime(rule['_from']) <= reference && _parsetime(rule['_to']) > reference }
     end
 
     def timezone_id lat, lon #:nodoc:
       begin
-        response = Net::HTTP.get('ws.geonames.org', "/timezoneJSON?lat=#{lat}&lng=#{lon}&username=#{Timezone::Configure.username}")
+        response = Net::HTTP.get(Timezone::Configure.url, "/timezoneJSON?lat=#{lat}&lng=#{lon}&username=#{Timezone::Configure.username}")
         JSON.parse(response)['timezoneId']
       rescue Exception => e
         raise Timezone::Error::GeoNames, e.message

data/test/timezone_test.rb

@@ -22,6 +22,30 @@ class TimezoneTest < Test::Unit::TestCase
     end
   end
 
+  def test_timezone_list
+    list = Timezone::Zone.list "Australia/Sydney", "America/Chicago"
+    assert list.is_a?(Array)
+    assert list.count == 2
+    assert list.first.is_a?(Hash)
+    assert list.first[:zone] == "Australia/Sydney"
+  end
+
+  def test_timezone_custom_list_order
+    Timezone::Configure.order_list_by = :title
+    Timezone::Configure.replace "America/Chicago", with: "Chicago"
+    list = Timezone::Zone.list "Australia/Sydney", "America/Chicago"
+    assert list.first[:title] == "Australia/Sydney"
+    assert list.last[:title] == "Chicago"
+    assert list.last[:zone] == "America/Chicago"
+  end
+
+  def test_timezone_default_list
+    Timezone::Configure.default_for_list = "America/Chicago", "Australia/Sydney"
+    list = Timezone::Zone.list
+    assert list.count == 2
+    assert list.first.has_value? "Australia/Sydney"
+  end
+
   def test_timezone_names
     zones = Timezone::Zone.names
     assert zones.is_a?(Array)
@@ -77,4 +101,16 @@ class TimezoneTest < Test::Unit::TestCase
     local = Time.utc(2010, 12, 24, 6, 7, 15)
     assert_equal local.to_i, timezone.time(utc).to_i
   end
+
+  def test_configure_url_default
+    assert_equal 'ws.geonames.org', Timezone::Configure.url
+  end
+
+  def test_configure_url_custom
+    Timezone::Configure.begin { |c| c.url = 'www.newtimezoneserver.com' }
+    assert_equal 'www.newtimezoneserver.com', Timezone::Configure.url
+    # clean up url after test
+    Timezone::Configure.begin { |c| c.url = nil }
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: timezone
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-21 00:00:00.000000000Z
+date: 2012-01-11 00:00:00.000000000Z
 dependencies: []
 description: A simple way to get accurate current and historical timezone information
   based on zone or latitude and longitude coordinates. This gem uses the tz database
@@ -515,9 +515,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: timezone
-rubygems_version: 1.8.6
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: timezone-0.1.3
+summary: timezone-0.1.4
 test_files:
 - test/timezone_test.rb