geolookup 0.6.2 → 0.6.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 46ae92eca6934c5c93d7507741b0064f65b81157
-  data.tar.gz: 59881c0780b02a53d5f0bc0e38f3b8262dea624c
+  metadata.gz: c2448f87284821120335883ab119ff7267a562bc
+  data.tar.gz: 00865ae14c0a0f6946e1a670434da19c48aeb783
 SHA512:
-  metadata.gz: e607715087e52aac9deb6c39db1e36acb5ef1695287753bf91d152bb0c202f84f0d1560e3ee0ef090e93734a21cf3bffb1e5a7b304b6641b805df89098714f27
-  data.tar.gz: 3bb0c3762db66561c1805d3b3a810ad258c1c46aaa77d23523613424d40e6b8c716e72888d8a4c2d3bfa76c05e45cfa1d4a0eea4356bf08f44c45b892ebdb223
+  metadata.gz: 5ea4ab17b773b6a6ad344c13efe857ed1240beb39471f65551c949574802677a1fd58792af405431199b38386476a62e206110c07617bf4e43f54ef8bfba1d4e
+  data.tar.gz: a1b0d38ad66f04f85df8e71cd898c05d8db9032dfd1f9e423c868b7c7a3f470c4293ef7f6b2d3617cc252e6585f28816a8cdb99cee8c455253f3dd15c2f3752e

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+*.idea

data/CHANGELOG.rdoc

@@ -1,3 +1,9 @@
+=== 0.6.4
+ - Changed the word 'ignored' to the more appropriate, general term 'territory'
+
+=== 0.6.3
+ - Added ignored? functionality
+
 === 0.6.2
  - Added ignored_states and country_to_phone_code and associated methods
 

data/README.md

@@ -85,6 +85,34 @@ Geolookup::USA::State.abbreviations_and_names
 Geolookup::USA::State.codes
 # => [1, 2, 4, ...]
 
+# US Territory State Codes
+Geolookup::USA::State.territory_state_codes
+# => [60, 66, 69, ...]
+
+# US Territory State Names
+Geolookup::USA::State.territory_state_names
+# => ["American Samoa", "Guam", ...]
+
+# Determine if state is territory
+
+# With code
+Geolookup::USA::State.territory?(60)
+# => true
+
+Geolookup::USA::State.territory?('60')
+# => true
+
+# With state name
+Geolookup::USA::State.territory?('Guam')
+# => true
+
+# With state abbreviation
+Geolookup::USA::State.territory?('GU')
+# => true
+
+Geolookup::USA::State.territory?('AZ')
+# => false
+
 # US County Examples:
 
 # Given a state code and county code return the county name

data/lib/geolookup/usa/state.rb

@@ -7,7 +7,7 @@ module Geolookup
       STATE_NAME_TO_CODE_FILE         = 'STATE_NAME_TO_CODE.yml'
       STATE_ABBREVIATION_TO_NAME_FILE = 'STATE_FULL_STATE_NAMES.yml'
       STATE_LAT_LONG_FILE             = 'STATE_LAT_LONG.yml'
-      IGNORED_STATES_FILE             = 'IGNORED_STATES.yml'
+      TERRITORY_STATES_FILE             = 'TERRITORY_STATES.yml'
       DOMESTIC_STATE_CUTOFF           = 56
 
       @state_code_to_full
@@ -15,7 +15,7 @@ module Geolookup
       @state_name_to_code
       @state_abbreviation_to_name
       @state_lat_long
-      @ignored_states
+      @territory_states
       @domestic_state_code_to_name
       @domestic_state_code_to_abbreviation
       ###################################################################
@@ -167,25 +167,46 @@ module Geolookup
       end
 
       ###################################################################
-      # self.ignored_state_codes
+      # self.territory_state_codes
       #
-      # Returns an array of ignored state codes
+      # Returns an array of territory state codes
       #
-      def self.ignored_state_codes
-        @ignored_states ||= Geolookup.load_hash_from_file(IGNORED_STATES_FILE)
-        @ignored_states.keys
+      def self.territory_state_codes
+        @territory_states ||= Geolookup.load_hash_from_file(TERRITORY_STATES_FILE)
+        @territory_states.keys
       end
 
       ###################################################################
-      # self.ignored_state_names
+      # self.territory_state_names
       #
-      # Returns an array of ignored state names
+      # Returns an array of territory state names
       #
-      def self.ignored_state_names
-        @ignored_states ||= Geolookup.load_hash_from_file(IGNORED_STATES_FILE)
-        @ignored_states.values
+      def self.territory_state_names
+        @territory_states ||= Geolookup.load_hash_from_file(TERRITORY_STATES_FILE)
+        @territory_states.values
       end
 
+      ###################################################################
+      # self.territory?
+      #
+      # Given a state name, abbreviation, or code, returns true if the
+      # state should be territory and false otherwise.
+      #
+      def self.territory?(state)
+        @territory_states ||= Geolookup.load_hash_from_file(TERRITORY_STATES_FILE)
+        titlized_state_name = state.to_s.split.map(&:capitalize).join(' ')
+
+        is_territory_state_name = territory_state_names.include? titlized_state_name
+        is_territory_state_code = territory_state_codes.include? state.to_i
+        is_territory_state_abbreviation = territory_state_names.include? abbreviation_to_name(state)
+
+        is_territory_state_name || is_territory_state_code || is_territory_state_abbreviation
+      end
+
+      def self.ignored_state_codes() territory_state_codes end
+      def self.ignored_state_names() territory_state_names end
+      def self.ignored?(state) territory?(state) end
+
       class << self
         alias :abbreviation_to_code :name_to_code
         alias :abbreviation_to_lat_long :name_to_lat_long

data/lib/geolookup/version.rb

@@ -1,3 +1,3 @@
 module Geolookup
-  VERSION = '0.6.2'
+  VERSION = '0.6.4'
 end

data/spec/lib/state_spec.rb

@@ -38,15 +38,15 @@ describe "Geolookup::USA::State" do
     end
   end
   
-  describe "#ignored_state_codes" do
-    it 'should return an array of ignored state codes' do
-      expect(Geolookup::USA::State.ignored_state_codes).to include(60)
+  describe "#territory_state_codes" do
+    it 'should return an array of territory state codes' do
+      expect(Geolookup::USA::State.territory_state_codes).to include(60)
     end
   end
   
-  describe "#ignored_state_names" do
-    it 'should return an array of ignored state names' do
-      expect(Geolookup::USA::State.ignored_state_names).to include("American Samoa")
+  describe "#territory_state_names" do
+    it 'should return an array of territory state names' do
+      expect(Geolookup::USA::State.territory_state_names).to include("American Samoa")
     end
   end
 
@@ -179,4 +179,115 @@ describe "Geolookup::USA::State" do
       expect(Geolookup::USA::State.domestic_names).to_not include("Guam")
     end
   end
+
+  describe '#territory?' do
+    context 'input is a code' do
+      context 'code is an integer' do
+        context 'state is territory' do
+          it 'returns true' do
+            state_code = 60
+            expect(Geolookup::USA::State.territory?(state_code)).to be true
+          end
+        end
+        context 'state is not territory' do
+          it 'returns false' do
+            state_code = 1
+            expect(Geolookup::USA::State.territory?(state_code)).to be false
+          end
+        end
+      end
+      context 'code is a string' do
+        context 'state is territory' do
+          it 'returns true' do
+            state_code = '66'
+            expect(Geolookup::USA::State.territory?(state_code)).to be true
+          end
+        end
+        context 'state is not territory' do
+          it 'returns false' do
+            state_code = '2'
+            expect(Geolookup::USA::State.territory?(state_code)).to be false
+          end
+        end
+      end
+    end
+    context 'input is an abbreviation' do
+      context 'casing is all upcase' do
+        context 'state is territory' do
+          it 'returns true' do
+            state_abbreviation = 'MP'
+            expect(Geolookup::USA::State.territory?(state_abbreviation)).to be true
+          end
+        end
+        context 'state is not territory' do
+          it 'returns false' do
+            state_abbreviation = 'AZ'
+            expect(Geolookup::USA::State.territory?(state_abbreviation)).to be false
+          end
+        end
+      end
+      context 'casing is mixed' do
+        context 'state is territory' do
+          it 'returns true' do
+            state_abbreviation = 'vI'
+            expect(Geolookup::USA::State.territory?(state_abbreviation)).to be true
+          end
+        end
+        context 'state is not territory' do
+          it 'returns false' do
+            state_abbreviation = 'Ar'
+            expect(Geolookup::USA::State.territory?(state_abbreviation)).to be false
+          end
+        end
+      end
+    end
+    context 'input is a state name' do
+      context 'casing is all upcase' do
+        context 'state is territory' do
+          it 'returns true' do
+            state_name = 'AMERICAN SAMOA'
+            expect(Geolookup::USA::State.territory?(state_name)).to be true
+          end
+        end
+        context 'state is not territory' do
+          it 'returns false' do
+            state_name = 'CALIFORNIA'
+            expect(Geolookup::USA::State.territory?(state_name)).to be false
+          end
+        end
+      end
+      context 'casing is mixed' do
+        context 'state is territory' do
+          it 'returns true' do
+            state_name = 'Guam'
+            expect(Geolookup::USA::State.territory?(state_name)).to be true
+          end
+        end
+        context 'state is not territory' do
+          it 'returns false' do
+            state_name = 'CoLoRaDo'
+            expect(Geolookup::USA::State.territory?(state_name)).to be false
+          end
+        end
+      end
+    end
+  end
+
+  describe '#ignored_state_names' do
+    it 'returns territory_state_names' do
+      expect(Geolookup::USA::State.ignored_state_names).to eq Geolookup::USA::State.territory_state_names
+    end
+  end
+
+  describe '#ignored_state_codes' do
+    it 'returns territory_state_codes' do
+      expect(Geolookup::USA::State.ignored_state_codes).to eq Geolookup::USA::State.territory_state_codes
+    end
+  end
+
+  describe '#ignored?' do
+    it 'returns territory' do
+      expect(Geolookup::USA::State.ignored?('ca')).to eq Geolookup::USA::State.territory?('ca')
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: geolookup
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.6.4
 platform: ruby
 authors:
 - Austin Fonacier
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-20 00:00:00.000000000 Z
+date: 2016-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -83,7 +83,6 @@ files:
 - lib/data/COUNTY_IGNORED_STATES.yml
 - lib/data/COUNTY_LAT_LONG.yml
 - lib/data/COUNTY_NAME_TO_CODE.yml
-- lib/data/IGNORED_STATES.yml
 - lib/data/METRO_CODE_TO_NAME.yml
 - lib/data/STATE_CODE_TO_DISPLAY_NAME.yml
 - lib/data/STATE_CODE_TO_FULL.yml
@@ -91,6 +90,7 @@ files:
 - lib/data/STATE_FULL_STATE_NAMES.yml
 - lib/data/STATE_LAT_LONG.yml
 - lib/data/STATE_NAME_TO_CODE.yml
+- lib/data/TERRITORY_STATES.yml
 - lib/data/ZIP_LAT_LONG.yml
 - lib/geolookup.rb
 - lib/geolookup/country.rb