carmen 0.2.1 → 0.2.2

data/README.rdoc

@@ -2,7 +2,7 @@
 
 This library will work as a drop in replacement for the official Rails country_select and its various forks. The idea is to provide a single library for all geographic naming concerns, and unify them under a consistent API.
 
-States are supported for the following countries: Australia, Brazil, Canada, Cuba, Denmark, Germany, Italy, Mexico, Norway, Spain, Ukraine, and United States.
+States are supported for the following countries: Australia, Brazil, Canada, Cuba, Denmark, Germany, Italy, Mexico, New Zealand, Norway, Spain, Ukraine, and United States.
 
 == Installation
 
@@ -44,6 +44,22 @@ Methods that take a country code argument will use the default country if none i
 
   Carmen.default_country = 'CA'
 
+= Adding country and state exclusion to Carmen
+
+This fork lets you exclude specific countries and/or states from Carmen. Simply set the appropriate class variables and the exclusion will take effect.
+
+== Excluding Countries 
+
+Countries to exclude are specified as an array of country codes:
+
+  Carmen.excluded_countries = [ 'AF', 'ST', 'ZW', ... ]
+
+== Excluding States
+
+States to exclude are specified via a hash, with keys being the country's code, and values being the states to exclude from that country:
+    
+  Carmen.excluded_states = { 'US' => [ 'AA', 'AP', 'PW', ... ], 'DE' => [ 'BW', 'TH' ], ... }
+
 == Localization
 
 You can switch between different localizations of the countries list, by setting the locale value (default is :en):
@@ -64,6 +80,7 @@ Currently included localizations are: English (:en), German (:de)
 * Split the Rails-specific view helpers out into a separate gem (carmen-rails)
 
 == Changelog
+* 0.2.2 Added state and country exclusion (kalafut)
 * 0.2.1 Added regions for New Zealand (yehezkielbs)
 * 0.2.0 Merge in Maximilian Schulz's locale fork, refactor internals to better support locales, and update documentation.       
         Remove Carmen::STATES and Carmen::COUNTRIES constants in favor of module instance variables and proper accessors.
@@ -94,6 +111,7 @@ Maximilian Schulz (namxam)
 Mani Tadayon (bowsersenior)
 Andriy Tyurnikov (andriytyurnikov)
 lonestarsoftware
+kalafut
 yehezkielbs
 
 If I missed your name in this list, please let me know and I will add it. I tried to find everyone that has sent in patches or found bugs, but I may have missed a few folks.

data/Rakefile

@@ -13,6 +13,7 @@ begin
     gem.authors = ["Jim Benton"]
     gem.add_development_dependency "mocha"
     gem.add_development_dependency "rails"
+    gem.add_development_dependency "hanna"
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError

data/VERSION

@@ -1 +1 @@
-0.2.1
+0.2.2

data/carmen.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{carmen}
-  s.version = "0.2.1"
+  s.version = "0.2.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jim Benton"]
-  s.date = %q{2010-11-19}
+  s.date = %q{2010-12-28}
   s.description = %q{A collection of geographis country and state names for Ruby. Also includes replacements for Rails' country_select and state_select plugins}
   s.email = %q{jim@autonomousmachine.com}
   s.extra_rdoc_files = [
@@ -63,13 +63,16 @@ Gem::Specification.new do |s|
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_development_dependency(%q<mocha>, [">= 0"])
       s.add_development_dependency(%q<rails>, [">= 0"])
+      s.add_development_dependency(%q<hanna>, [">= 0"])
     else
       s.add_dependency(%q<mocha>, [">= 0"])
       s.add_dependency(%q<rails>, [">= 0"])
+      s.add_dependency(%q<hanna>, [">= 0"])
     end
   else
     s.add_dependency(%q<mocha>, [">= 0"])
     s.add_dependency(%q<rails>, [">= 0"])
+    s.add_dependency(%q<hanna>, [">= 0"])
   end
 end
 

data/lib/carmen.rb

@@ -8,11 +8,13 @@ end
 module Carmen
 
   class << self
-    attr_accessor :default_country, :default_locale
+    attr_accessor :default_country, :default_locale, :excluded_countries, :excluded_states
   end
   
   self.default_country = 'US'
   self.default_locale = :en
+  self.excluded_countries = []
+  self.excluded_states = {} 
   
   @data_path = File.join(File.dirname(__FILE__), '..', 'data')
   
@@ -47,9 +49,10 @@ module Carmen
       @countries[locale] = YAML.load_file(localized_data)
     end
     
-    # Return data
-    @countries[locale]
+    # Return data after filtering excluded countries
+    @countries[locale].reject { |c| excluded_countries.include?( c[1] ) }
   end
+
   
   # Returns the country name corresponding to the supplied country code, optionally using the specified locale.
   #  Carmen::country_name('TR') => 'Turkey'
@@ -108,7 +111,14 @@ module Carmen
   def self.states(country_code = Carmen.default_country, options={})        
     raise NonexistentCountry.new("Country not found for code #{country_code}") unless country_codes.include?(country_code)
     raise StatesNotSupported unless states?(country_code)
-    search_collection(@states, country_code, 0, 1)
+
+    results = search_collection(@states, country_code, 0, 1)
+
+    if excluded_states[country_code]
+        results.reject { |s| excluded_states[country_code].include?(s[1]) }
+    else
+        results
+    end
   end
 
   # Returns whether states are supported for the given country code
@@ -134,4 +144,4 @@ module Carmen
     nil
   end
   
-end
+end

data/test/carmen_test.rb

@@ -96,6 +96,33 @@ class TestCarmen < Test::Unit::TestCase
     assert_equal Carmen::states?('ZZ'), false
   end
   
+  def test_excluded_countries
+      Carmen.excluded_countries = [ 'US', 'DE' ]
+      countries = Carmen.countries
+      assert !countries.include?( ["United States", "US"] )
+      assert !countries.include?( ["Germany", "DE"] )
+      assert countries.include?( ["Portugal", "PT"] )
+      Carmen.excluded_countries = [ ]
+  end
+
+  def test_excluded_states
+      Carmen.excluded_states = { 'US' => ['IL', 'OR'], 'DE' => ['BE', 'HH'] }
+      states = Carmen.states
+      assert !states.include?( ["Illinois", "IL"] )
+      assert !states.include?( ["Oregon", "OR"] )
+      assert states.include?( ["Kentucky", "KY"] )
+
+      states = Carmen.states("DE")
+      assert !states.include?( ["Berlin", "BE"] )
+      assert !states.include?( ["Hamburg", "HH"] )
+      assert states.include?( ["Rheinland-Pfalz", "RP"] )
+
+      states = Carmen.states("ES")
+      assert states.include?( ["Cantabria", "CAN"] )
+
+      Carmen.excluded_states = {}
+  end
+
   def test_invalid_country_exception
     assert_raises Carmen::NonexistentCountry do
       Carmen::state_codes('ZZ')
@@ -113,5 +140,7 @@ class TestCarmen < Test::Unit::TestCase
       Carmen.countries(:locale => :latin)
     end
   end
+
+
   
 end

data/test/test_helper.rb

@@ -1,2 +1,3 @@
 require 'test/unit'
+require 'rubygems'
 require File.expand_path('../lib/carmen', File.dirname(__FILE__))

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: carmen
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: false
   segments: 
   - 0
   - 2
-  - 1
-  version: 0.2.1
+  - 2
+  version: 0.2.2
 platform: ruby
 authors: 
 - Jim Benton
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-19 00:00:00 -06:00
+date: 2010-12-28 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -46,6 +46,20 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: hanna
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
 description: A collection of geographis country and state names for Ruby. Also includes replacements for Rails' country_select and state_select plugins
 email: jim@autonomousmachine.com
 executables: []