snail 0.8.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c1cb99969310c1c08d9eef5146e5d5f68a1ede29
-  data.tar.gz: 8964a79612336d7ab86e78bb118df92769e49c55
+  metadata.gz: 69299ca47862ebd3ed450e287deafcf5a89175fa
+  data.tar.gz: c582b6d1c0d07674c12307bdc76a001c1976d48e
 SHA512:
-  metadata.gz: b590cb20875b4b46e87c8d004bd099484fe9612ddb5c3e0d7ea1768b9cd45b644bb2aa659b6ead0255e87f9b894de834807b29f163f30cfa962d9cc83d0b3f99
-  data.tar.gz: 0d9cde988655502db980d579b8ce4bbc2988fb2b15a8c0c19e09fe448273bf09199b0de51a33c5b4bd724699dac023efb943e0e50aaf94bd31b5ac76e6a618fd
+  metadata.gz: 28db2ac9d411e136359ba5bc3bfe4676856e5aba38f197bb2c3729cb64f276bd562e51267c125915432f1f5cd4c5981b28be65b42a47a770a3dde676cf9d5b5e
+  data.tar.gz: acfa11f47bd78a8a4c0671fefa24a0ab2ac0b9f47e715124e5a677840e0588087436073936da30de69bd4313dd9b1f6d30c6d09a13dd4ad6f6ccf6cf5161dec1

data/lib/snail/constants.rb

@@ -1,240 +1,7 @@
 # -*- encoding : utf-8 -*-
 
+# TODO: carmen
 class Snail
-  # based on http://www.columbia.edu/kermit/postal.html#index, which is in turn based on
-  # the USPS International Mailing Manual. See also http://www.25thandclement.com/~william/USPS_ICL.html.
-  USPS_COUNTRIES = [
-    'Afghanistan',
-    'Albania',
-    'Algeria',
-    'Andorra',
-    'Angola',
-    'Anguilla',
-    'Antigua and Barbuda',
-    'Argentina',
-    'Armenia',
-    'Aruba',
-    'Ascension',
-    'Australia',
-    'Austria',
-    'Azerbaijan',
-    'Bahamas',
-    'Bahrain',
-    'Bangladesh',
-    'Barbados',
-    'Belarus',
-    'Belgium',
-    'Belize',
-    'Benin',
-    'Bermuda',
-    'Bhutan',
-    'Bolivia',
-    'Bosnia and Herzegovina',
-    'Botswana',
-    'Brazil',
-    'British Virgin Islands',
-    'Brunei Darussalam',
-    'Bulgaria',
-    'Burkina Faso',
-    'Burundi',
-    'Cambodia',
-    'Cameroon',
-    'Canada',
-    'Canary Islands',
-    'Cape Verde',
-    'Cayman Islands',
-    'Central African Republic',
-    'Chad',
-    'Chile',
-    'China',
-    'Colombia',
-    'Comoros',
-    'Costa Rica',
-    'CÔte D\'ivoire',
-    'Croatia',
-    'Cuba',
-    'Curacao',
-    'Cyprus',
-    'Czech Republic',
-    'Democratic Republic of the Congo',
-    'Denmark',
-    'Djibouti',
-    'Dominica',
-    'Dominican Republic',
-    'East Timor',
-    'Ecuador',
-    'Egypt',
-    'El Salvador',
-    'England',
-    'Equatorial Guinea',
-    'Eritrea',
-    'Estonia',
-    'Ethiopia',
-    'Falkland Islands',
-    'Faroe Islands',
-    'Fiji',
-    'Finland',
-    'France',
-    'French Guiana',
-    'French Polynesia',
-    'Gabon',
-    'Gambia',
-    'Georgia',
-    'Germany',
-    'Ghana',
-    'Gibraltar',
-    'Greece',
-    'Greenland',
-    'Grenada',
-    'Guadeloupe',
-    'Guatemala',
-    'Guinea',
-    'Guinea-Bissau',
-    'Guyana',
-    'Haiti',
-    'Honduras',
-    'Hong Kong',
-    'Hungary',
-    'Iceland',
-    'India',
-    'Indonesia',
-    'Iran',
-    'Iraq',
-    'Ireland',
-    'Isle of Man',
-    'Israel',
-    'Italy',
-    'Jamaica',
-    'Japan',
-    'Jordan',
-    'Kazakhstan',
-    'Kenya',
-    'Kiribati',
-    'Korea',
-    'Kosovo',
-    'Kuwait',
-    'Kyrgyzstan',
-    'Laos',
-    'Latvia',
-    'Lebanon',
-    'Lesotho',
-    'Liberia',
-    'Libya',
-    'Liechtenstein',
-    'Lithuania',
-    'Luxembourg',
-    'Macao',
-    'Macedonia',
-    'Madagascar',
-    'Malawi',
-    'Malaysia',
-    'Maldives',
-    'Mali',
-    'Malta',
-    'Martinique',
-    'Mauritania',
-    'Mauritius',
-    'Mayotte',
-    'Mexico',
-    'Moldova',
-    'Monaco',
-    'Mongolia',
-    'Montenegro',
-    'Montserrat',
-    'Morocco',
-    'Mozambique',
-    'Myanmar',
-    'Namibia',
-    'Nauru',
-    'Nepal',
-    'Netherlands',
-    'Netherlands Antilles',
-    'New Caledonia',
-    'New Zealand',
-    'Nicaragua',
-    'Niger',
-    'Nigeria',
-    'North Korea',
-    'Northern Ireland',
-    'Norway',
-    'Oman',
-    'Pakistan',
-    'Palestinian Territory',
-    'Panama',
-    'Papua New Guinea',
-    'Paraguay',
-    'Peru',
-    'Philippines',
-    'Pitcairn Island',
-    'Poland',
-    'Portugal',
-    'Qatar',
-    'Republic of the Congo',
-    'Reunion',
-    'Romania',
-    'Russian Federation',
-    'Rwanda',
-    'Saint Helena',
-    'Saint Kitts and Nevis',
-    'Saint Lucia',
-    'Saint Pierre and Miquelon',
-    'Saint Vincent and the Grenadines',
-    'San Marino',
-    'Sao Tome and Principe',
-    'Saudi Arabia',
-    'Scotland',
-    'Senegal',
-    'Serbia',
-    'Seychelles',
-    'Sierra Leone',
-    'Singapore',
-    'Slovak Republic',
-    'Slovenia',
-    'Solomon Islands',
-    'Somalia',
-    'South Africa',
-    'South Georgia',
-    'South Sudan',
-    'Spain',
-    'Sri Lanka',
-    'Sudan',
-    'Suriname',
-    'Swaziland',
-    'Sweden',
-    'Switzerland',
-    'Syria',
-    'Taiwan',
-    'Tajikistan',
-    'Tanzania',
-    'Thailand',
-    'Togo',
-    'Tonga',
-    'Trinidad and Tobago',
-    'Tristan da Cunha',
-    'Tunisia',
-    'Turkey',
-    'Turkmenistan',
-    'Turks and Caicos Islands',
-    'Tuvalu',
-    'Uganda',
-    'Ukraine',
-    'United Arab Emirates',
-    'United Kingdom',
-    'Uruguay',
-    'USA',
-    'Uzbekistan',
-    'Vanuatu',
-    'Vatican City',
-    'Venezuela',
-    'Vietnam',
-    'Wales',
-    'Wallis and Futuna Islands',
-    'Western Samoa',
-    'Western Sahara',
-    'Yemen',
-    'Zambia',
-    'Zimbabwe'
-  ]
 
   REGIONS = {
     # see http://en.wikipedia.org/wiki/Postcodes_in_Australia#Australia_States_and_territories
@@ -337,12 +104,6 @@ class Snail
     }
   }
 
-
-  # Deprecated
-  USA_STATES   = REGIONS[:us]
-  CA_PROVINCES = REGIONS[:ca]
-  AU_REGIONS   = REGIONS[:au]
-
   module Iso3166
     # as of January 28, 2013
     # pulled http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
@@ -604,13 +365,13 @@ class Snail
       'ZM' => ["ZAMBIA"],
       'ZW' => ["ZIMBABWE"]
     }
-    
+
     ALPHA2_EXCEPTIONS = {
       'UK' => 'GB', # great britain aka united kingdom
       'FX' => 'FR', # france
       'SU' => 'RU'  # russia
     }
-    
+
     ALPHA3_TO_ALPHA2 = {
       "ABW" => "AW",
       "AFG" => "AF",

data/lib/snail/{configurable.rb → initializable.rb}

@@ -1,5 +1,5 @@
 class Snail
-  module Configurable
+  module Initializable
     def initialize(attrs = {}, &block)
       attrs.each do |k, v|
         m = "#{k}="
@@ -12,5 +12,4 @@ class Snail
       yield self if block_given?
     end
   end
-  include Configurable
 end

data/lib/snail/version.rb

@@ -1,3 +1,3 @@
 class Snail
-  VERSION = '0.8.0'
+  VERSION = '1.0.1'
 end

data/lib/snail.rb

@@ -1,5 +1,5 @@
 # -*- encoding : utf-8 -*-
-require 'snail/configurable'
+require 'snail/initializable'
 require 'snail/constants'
 require 'snail_helpers'
 
@@ -11,7 +11,7 @@ if defined? ActionView
 end
 
 class Snail
-  include Configurable
+  include Snail::Initializable
 
   # this will be raised whenever formatting or validation is run on an unsupported or unknown country
   class UnknownCountryError < ArgumentError; end
@@ -63,14 +63,21 @@ class Snail
       iso
     elsif iso = ::Snail::Iso3166::ALPHA3_TO_ALPHA2[val]
       iso
-    elsif iso_pair = ::Snail::Iso3166::ALPHA2.find { |a2, names| names.include?(val) }
-      ActiveSupport::Deprecation.warn("Country name lookup will be deprecated in the near future. Please pass ISO3166 country codes to Snail instead.", caller)
-      iso_pair.first
     else
       nil
     end
   end
 
+  # Where the mail is coming from.
+  def origin=(val)
+    @origin = Snail.lookup_country_iso(val)
+  end
+
+  # Where the mail is coming from. Defaults to the global `home_country`.
+  def origin
+    @origin ||= Snail.home_country
+  end
+
   # Store country as ISO-3166 Alpha 2
   def country=(val)
     @country = Snail.lookup_country_iso(val)
@@ -136,8 +143,8 @@ class Snail
     end
   end
 
-  # TODO after country name lookup deprecation, add localized country names to this
+  # TODO localize to the origin country
   def country_line
-    ::Snail::Iso3166::ALPHA2[country].first if country and self.class.home_country != country
+    ::Snail::Iso3166::ALPHA2[country].first if country and self.origin != country
   end
 end

data/lib/snail_helpers.rb

@@ -1,16 +1,7 @@
 module SnailHelpers
-  def usps_country_options_for_select(selected = nil, default_selected = 'USA')
-    options_for_select(Snail::USPS_COUNTRIES, selected || default_selected)
-  end
 
   def region_options_for_select(country = :us, selected = nil)
     options_for_select(Snail::REGIONS[country], selected)
   end
 
-  # Deprecated
-  def usa_state_options_for_select(selected = nil)
-    region_options_for_select(:us, selected)
-  end
-
-
 end

data/snail.gemspec

@@ -13,5 +13,5 @@ Gem::Specification.new do |s|
   s.test_files        = s.files.grep(%r{^(test|spec|features)/})
   s.require_paths     = ["lib"]
 
-  s.add_dependency    "active_support"
+  s.add_dependency    "activesupport"
 end

data/test/snail_test.rb

@@ -6,19 +6,6 @@ class SnailTest < ActiveSupport::TestCase
     @ca = {:name => "John Doe", :line_1 => "12345 5th St", :city => "Somewheres", :state => "NY", :zip => "12345", :country => 'CAN'}
   end
 
-  test "provides USPS country names" do
-    assert Snail.const_defined?('USPS_COUNTRIES')
-  end
-
-  test "provides USA state names with abbreviations" do
-    assert Snail.const_defined?('USA_STATES')
-    assert_equal 'MN', Snail::USA_STATES['Minnesota']
-  end
-
-  test "USA states include territories and islands" do
-    assert Snail::USA_STATES['Guam']
-  end
-
   test "provides region codes via 2-digit iso country code" do
     assert_equal "WA", Snail::REGIONS[:us]["Washington"]
     assert_equal "WA", Snail::REGIONS[:au]["Western Australia"]
@@ -59,16 +46,6 @@ class SnailTest < ActiveSupport::TestCase
   ## Country Normalization
   ##
 
-  test "normalize country name to alpha2" do
-    s = Snail.new(@ca.merge(:country => 'Slovenia'))
-    assert_equal "SI", s.country
-  end
-
-  test "normalize uppercase country name to alpha2" do
-    s = Snail.new(@ca.merge(:country => 'JAPAN'))
-    assert_equal "JP", s.country
-  end
-
   test "normalize alpha3 to alpha2" do
     s = Snail.new(@ca.merge(:country => 'SVN'))
     assert_equal "SI", s.country
@@ -94,20 +71,17 @@ class SnailTest < ActiveSupport::TestCase
   end
 
   test "does not include country name for domestic addresses" do
-    s = Snail.new(@us)
+    s = Snail.new(@us.merge(:origin => 'US'))
     assert !s.to_s.match(/United States/i)
-  end
-
-  test "does not include country name for domestic addresses in canada" do
-    Snail.home_country = "Canada"
-    s = Snail.new(@ca)
+    s = Snail.new(@ca.merge(:origin => 'CA'))
     assert !s.to_s.match(/Canada/i)
-    Snail.home_country = "USA"
   end
 
   test "includes country name for international addresses" do
-    s = Snail.new(@ca)
-    assert s.to_s.match(/Canada\Z/i), s.to_s
+    s = Snail.new(@us.merge(:origin => 'CA'))
+    assert s.to_s.match(/United States/i)
+    s = Snail.new(@ca.merge(:origin => 'US'))
+    assert s.to_s.match(/Canada/i)
   end
 
   test "includes first country name for countries with many commonly used names" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: snail
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Lance Ivy
@@ -11,7 +11,7 @@ cert_chain: []
 date: 2013-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: active_support
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -36,8 +36,8 @@ files:
 - README.rdoc
 - Rakefile
 - lib/snail.rb
-- lib/snail/configurable.rb
 - lib/snail/constants.rb
+- lib/snail/initializable.rb
 - lib/snail/version.rb
 - lib/snail_helpers.rb
 - snail.gemspec