area 0.9.0 → 0.10.0

data/data/areacodes.csv

@@ -1,4 +1,3 @@
-Area Code,Region
 201,NJ
 202,DC
 203,CT

data/lib/area.rb

@@ -14,7 +14,7 @@ module Area
   zip_path = File.open(File.join(File.dirname(__FILE__), '..', 'data', 'zipcodes.csv'))
   area_path = File.open(File.join(File.dirname(__FILE__), '..', 'data', 'areacodes.csv'))
 
-    # there is probably a better way to do this...
+  # there is probably a better way to do this...
   if RUBY_VERSION.to_f >= 1.9
     @area_codes = CSV.read(area_path)
     @zip_codes = CSV.read(zip_path)
@@ -31,7 +31,11 @@ module Area
     @zip_codes
   end
 
-  @regions = ["REGION", "NJ", "DC", "CT", "MB", "AL", "WA", "ME", "ID", "CA", "TX", "NY", "PA", "OH", "IL", "MN", "IN", "LA", "ON", "MS", "GA", "MI", "FL", "MD", "BAHAMAS", "BARBADOS", "BC", "NC", "WI", "ANGUILLA", "ANTIGUA AND BARBUDA", "KY", "VA", "BRITISH VIRGIN ISLANDS", "DE", "CO", "WV", "SK", "WY", "NE", "MO", "KS", "IA", "MA", "USVI", "CAYMAN ISLANDS", "RI", "AB", "OK", "MT", "QC", "TN", "UT", "BERMUDA", "RESERVED", "GRENADA", "AR", "AZ", "OR", "NM", "NB", "NH", "SD", "TURKS & CAICOS ISLANDS", "MONTSERRAT", "MP", "GU", "AS", "ND", "NV", "NL", "US GOVERNMENT", "ST. LUCIA", "DOMINICA", "ST. VINCENT & GRENADINES", "PR", "TOLL FREE", "VT", "SC", "HI", "DOMINICAN REPUBLIC", "YT", "TRINIDAD & TOBAGO", "ST. KITTS & NEVIS", "JAMAICA", "TOLL CALLS", "NS", "AK"]
+  def self.regions
+    regions = []
+    @area_codes.map{|row| regions << row.last.upcase }
+    return regions
+  end
 
   def self.code?(code)
     if code.to_s.length == 3
@@ -58,7 +62,7 @@ module Area
   end
 
   def self.state_or_territory?(state)
-    if @regions.include?(state.upcase)
+    if self.regions.include?(state.upcase)
       return state
     else
       raise ArgumentError, "You must provide a valid US state abbreviation or territory name", caller
@@ -66,7 +70,7 @@ module Area
   end
 
   def self.zip_or_territory?(state)
-    if @regions.include?(state.upcase) or Area.zip?(state)
+    if self.regions.include?(state.upcase) or self.zip?(state)
       return state
     else
       raise ArgumentError, "You must provide a valid US state abbreviation or zipcode.", caller

data/lib/area/array.rb

@@ -14,14 +14,19 @@ class Array
   #
   # Returns a String representation of the lat/lon pair.
   def to_region(options = {})
-    if row = Area.zip_codes.find {|row| row[3] == self[0].to_s and row[4] == self[1].to_s }
-      if options[:city]
-        return row[1]
-      elsif options[:state]
-        return row[2]
-      else
-        return row[1] + ', ' + row[2]
+    if self[0].is_a?(String) and self[1].is_a?(String)
+      if row = Area.zip_codes.find {|row| row[3] == self[0].to_s and row[4] == self[1].to_s }
+        if options[:city]
+          return row[1]
+        elsif options[:state]
+          return row[2]
+        else
+          return row[1] + ', ' + row[2]
+        end
       end
+    else
+      warn "[DEPRECATION] using to_region on an array of integers has been deprecated. Use a string instead."
+      return nil
     end
   end
 

data/lib/area/version.rb

@@ -1,3 +1,3 @@
 module Area
-  VERSION = "0.9.0"
+  VERSION = "0.10.0"
 end

data/test/unit/area_test.rb

@@ -1,5 +1,7 @@
 require 'minitest/autorun'
-require 'area'
+require 'minitest/benchmark' if ENV["BENCH"]
+require 'minitest/pride'
+require File.expand_path('../../../lib/area.rb', __FILE__)
 
 class TestInteger < MiniTest::Unit::TestCase
 
@@ -31,6 +33,14 @@ class TestInteger < MiniTest::Unit::TestCase
     assert_raises(ArgumentError) { 1234.to_gmt_offset }
   end
 
+  # Benchmarks
+
+  def bench_to_region
+    assert_performance_constant 0.9999 do |n|
+      n.times { 646.to_region }
+    end
+  end
+
 end
 
 class TestString < MiniTest::Unit::TestCase
@@ -43,7 +53,7 @@ class TestString < MiniTest::Unit::TestCase
     assert_equal "Brooklyn, NY", "11211".to_region
   end
 
-  def test_that_it_supports_options
+  def test_that_it_supports_options_for_zipcodes
     assert_equal "Brooklyn", "11211".to_region(:city => true)
     assert_equal "NY", "11211".to_region(:state => true)
   end
@@ -89,35 +99,124 @@ class TestString < MiniTest::Unit::TestCase
     assert_equal "-5", "11211".to_gmt_offset
   end
 
+  # Benchmarks
+
+  def bench_area_code_to_region
+    assert_performance_constant 0.9999 do |n|
+      n.times { "646".to_region }
+    end
+  end
+
+  def bench_zip_code_to_region
+    assert_performance_constant 0.9999 do |n|
+      n.times { "11211".to_region }
+    end
+  end
+
+  def bench_zip_code_to_region_with_state_option
+    assert_performance_constant 0.9999 do |n|
+      n.times { "11211".to_region(:state => true) }
+    end
+  end
+
+  def bench_zip_code_to_region_with_city_option
+    assert_performance_constant 0.9999 do |n|
+      n.times { "11211".to_region(:city => true) }
+    end
+  end
+
+  def bench_to_area_code
+    assert_performance_constant 0.9999 do |n|
+      n.times { "NY".to_area }
+    end
+  end
+
+  def bench_to_zip_code
+    assert_performance_constant 0.9999 do |n|
+      n.times { "long island city".to_zip }
+    end
+  end
+
+  def bench_city_state_to_zip_code
+    assert_performance_constant 0.9999 do |n|
+      n.times { "long island city, ny".to_zip }
+    end
+  end
+
+  def bench_to_offset
+    assert_performance_constant 0.9999 do |n|
+      n.times { "ny".to_gmt_offset }
+    end
+  end
 
 end
 
 class TestArray < MiniTest::Unit::TestCase
 
   def test_that_it_converts_latlon_to_zip_code
-    assert_equal "11211", [40.71209, -73.95427].to_zip
+    assert_equal "11211", ["40.71209", "-73.95427"].to_zip
   end
 
   def test_that_it_converts_latlon_to_region
-    assert_equal "Brooklyn, NY", [40.71209, -73.95427].to_region
+    assert_equal "Brooklyn, NY", ["40.71209", "-73.95427"].to_region
   end
 
   def test_that_it_converts_latlon_to_region_with_options
-    assert_equal "NY", [40.71209, -73.95427].to_region(:state => true)
+    assert_equal "NY", ["40.71209", "-73.95427"].to_region(:state => true)
   end
 
   def test_that_it_converts_latlon_to_gmt_offset
-    assert_equal "-5", [40.71209, -73.95427].to_gmt_offset
+    assert_equal "-5", ["40.71209", "-73.95427"].to_gmt_offset
   end
 
   def test_that_it_handles_latlon_precision
-    assert_equal "11211", [40.71209123228157, -73.95488409019887].to_zip
+    assert_equal "11211", ["40.71209123228157", "-73.95488409019887"].to_zip
   end
 
   def test_that_it_handles_incorrect_values
-    assert_nil [12.12345, -40.23423].to_zip
-    assert_nil [12.12345, -40.23423].to_region
-    assert_nil [12.12345, -40.23423].to_gmt_offset
+    assert_nil ["12.12345", "-40.23423"].to_zip
+    assert_nil ["12.12345", "-40.23423"].to_region
+    assert_nil ["12.12345", "-40.23423"].to_gmt_offset
+  end
+
+  # Benchmarks
+
+  def bench_to_zip_code
+    assert_performance_constant 0.9999 do |n|
+      n.times { ["40.71209", "-73.95427"].to_zip }
+    end
+  end
+
+  def bench_to_region
+    assert_performance_constant 0.9999 do |n|
+      n.times { ["40.71209", "-73.95427"].to_region }
+    end
+  end
+
+  def bench_to_region_with_options
+    assert_performance_constant 0.9999 do |n|
+      n.times { ["40.71209", "-73.95427"].to_region(:state => true) }
+    end
+  end
+
+  def bench_to_gmt_offset
+    assert_performance_constant 0.9999 do |n|
+      n.times { ["40.71209", "-73.95427"].to_gmt_offset }
+    end
+  end
+
+  def bench_precision_handling
+    assert_performance_constant 0.9999 do |n|
+      n.times { ["40.71209123228157", "-73.95488409019887"].to_zip }
+    end
+  end
+
+end
+
+class TestArea < MiniTest::Unit::TestCase
+
+  def test_that_regions_is_an_array
+    assert_instance_of Array, Area.regions
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: area
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-11 00:00:00.000000000 Z
+date: 2013-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fastercsv