factbook-codes 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 647f0b94f4e8dd97a64d74a7071041f2626832577fbac29d4095ec6ea10f063a
-  data.tar.gz: 748f86b88eb922e964cb4b1bdae2797e8162a20f4a236a388312876aa84c5429
+  metadata.gz: f315e31562bd310f9499a67bbb535c582b8bc8813e95c01ab2a7583fd5ef5c78
+  data.tar.gz: 9119488f7305b7f702125b5a4d1a95bfbb63feb8f9bf474a3d7be286ac2fd308
 SHA512:
-  metadata.gz: 6a616c078ef9ddeffc7bd411b1ab0660c6efcfb2ad7a18472a242862b67074ded0431ede70f9e0d1e02533493f1c2a2d912574c5f1ac6efa91582b0b0911c43b
-  data.tar.gz: 3c3b7d498263fe6f0ed74dbe62c54a0117b559200881b1ef4060a276561f7f85a2822c7c6dbb9319a53cc1c83888898416a75dd83f5e43d44bd7422262a4e7e4
+  metadata.gz: bef206fa344cfdced6555ec4e099dd0a3dbd6d96c5b173f7ea2affa02877e149233e8d716209643c2e28fb931538dcee9c54861c9411d6cddba74fbbeb467678
+  data.tar.gz: b9934611ff2d0bd73863cf80484795d9f282c112c695a073f5f87856ec14a4d2875189c28f1529c9f8c13e48cc6e3dc7109301c77757b1486963755304f1de3d

data/README.md

@@ -26,22 +26,22 @@ end
 resulting in:
 
 ```
-#<struct Factbook::Codes::Code
+#<Factbook::Codes::Code
  code    ="af",
  name    ="Afghanistan",
  category="Countries",
  region  ="South Asia">
-#<struct Factbook::Codes::Code
+#<Factbook::Codes::Code
  code    ="al",
  name    ="Albania",
  category="Countries",
  region  ="Europe">
-#<struct Factbook::Codes::Code
+#<Factbook::Codes::Code
  code    ="ag",
  name    ="Algeria",
  category="Countries",
  region  ="Africa">
-#<struct Factbook::Codes::Code
+#<Factbook::Codes::Code
  code    ="an",
  name    ="Andorra",
  category="Countries",
@@ -55,7 +55,7 @@ and/or by region e.g. Africa, Europe, South Asia, Central America and Caribbean,
 
 ```ruby
 
-assert_equal 261, Factbook.codes.size
+assert_equal 260, Factbook.codes.size
 
 ## categories
 assert_equal 195, Factbook.codes.countries.size
@@ -63,7 +63,7 @@ assert_equal  52, Factbook.codes.dependencies.size
 assert_equal   5, Factbook.codes.oceans.size
 assert_equal   1, Factbook.codes.world.size
 assert_equal   2, Factbook.codes.others.size
-assert_equal   6, Factbook.codes.misc.size
+assert_equal   5, Factbook.codes.misc.size
 
 ## regions
 assert_equal  55, Factbook.codes.europe.size
@@ -71,7 +71,7 @@ assert_equal   9, Factbook.codes.south_asia.size
 assert_equal   6, Factbook.codes.central_asia.size
 assert_equal  22, Factbook.codes.east_n_souteast_asia.size
 assert_equal  19, Factbook.codes.middle_east.size
-assert_equal  56, Factbook.codes.africa.size
+assert_equal  55, Factbook.codes.africa.size
 assert_equal   7, Factbook.codes.north_america.size
 assert_equal  33, Factbook.codes.central_america_n_caribbean.size
 assert_equal  14, Factbook.codes.south_america.size
@@ -90,6 +90,52 @@ See [`data/codes.csv`](data/codes.csv) for the built-in listing of all codes wit
 
 
 
+## Frequently Asked Questions (F.A.Q.s) & Answers
+
+Q: The World Factbook front-page
+says "for 266 world entities" - but
+the `Factbook.codes.size` is only 260 (thus, 6 entities short)?
+What's the story?
+
+> The World Factbook provides basic intelligence on the history,
+> people, government, economy, energy, geography, communications,
+> transportation, military, terrorism, and transnational issues
+> for 266 world entities.
+>
+> (Source: [`cia.gov/the-world-factbook`](https://www.cia.gov/the-world-factbook/))
+
+
+A: Since March 2006
+the United States Pacific Island Wildlife Refuges (`um`)
+country profile consolidates
+seven profiles into a single new one
+(but keeps entities count as before):
+
+- Baker Island  (`fq`)
+- Howland Island (`hq`)
+- Jarvis Island (`dq`)
+- Johnston Atoll (`jq`)
+- Kingman Reef (`kq`)
+- Midway Islands (`mq`)
+- Palmyra Atoll (`lq`)
+
+
+
+Q: What happened to the Western Sahara (`wi`) country profile?
+
+In December 2020 the World Factbook dropped coverage of the Western Sahara (`wi`). Why?
+In a deal with Morocco the United States recognizes the claim
+of Marocco over the Western Sahara and in return
+Morocco starts official diplomatic relations with Israel.
+
+```
+Code, Name,           Category,      Region
+wi,   Western Sahara, Miscellaneous, Africa
+```
+
+
+
+
 ## Install
 
 Use

data/data/codes.csv

@@ -253,7 +253,6 @@ gz,Gaza Strip,Miscellaneous,Middle East
 pf,Paracel Islands,Miscellaneous,East & Southeast Asia
 pg,Spratly Islands,Miscellaneous,East & Southeast Asia
 we,West Bank,Miscellaneous,Middle East
-wi,Western Sahara,Miscellaneous,Africa
 xq,Arctic Ocean,Oceans,Oceans
 zh,Atlantic Ocean,Oceans,Oceans
 xo,Indian Ocean,Oceans,Oceans

data/lib/factbook-codes.rb

@@ -9,6 +9,12 @@ require 'csvreader'
 # our own code
 require 'factbook-codes/version' # let it always go first
 
+
+module SportDb
+  Logging = LogUtils::Logging     ## logging machinery shortcut; use LogUtils for now
+end
+
+
 require 'factbook-codes/codes'
 
 
@@ -17,9 +23,21 @@ module Factbook
   ##  note: load on demand only builtin codes, comparisons, etc.
   ##          for now
   def self.codes
-    @@codes       ||= Codes.read_csv( "#{Factbook::Module::Codes.root}/data/codes.csv" );
+    @@codes ||= Codes.read_csv( "#{Factbook::Module::Codes.root}/data/codes.csv" );
+  end
+
+  ## let's put test configuration in its own namespace / module
+  class Test    ## todo/check: works with module too? use a module - why? why not?
+    ####
+    #  todo/fix:  find a better way to configure shared test datasets - why? why not?
+    #    note: use one-up (..) directory for now as default - why? why not?
+    def self.data_dir()        @data_dir ||= '../testdata'; end
+    def self.data_dir=( path ) @data_dir = path; end
   end
 end # module Factbook
 
 
+
+
+
 puts Factbook::Module::Codes.banner

data/lib/factbook-codes/codes.rb

@@ -6,13 +6,33 @@
 
 module Factbook
 
+##  check: move region_to_slug into a utility module / helper
+##              for (re)use - how, why? why not??
+def self.region_to_slug( text )
+  ##  change and  =>  n
+  ##  change  &   =>  n
+  ##  change all spaces to => -
+  ##   e.g. East & Southeast Asia          => east-n-southeast-asia
+  ##        Central America and Caribbean  => central-america-n-caribbean
+  text.downcase.gsub('and', 'n').gsub( '&', 'n' ).gsub( ' ', '-' )
+end
+
 class Codes
+  class Code   ## nested class
+    attr_accessor :code,      ## todo: add notes (country affiliation) - why? why not??
+                  :name,
+                  :category,  ## e.g. Countries, Other, Oceans, World, Dependencies, etc.
+                  :region    ## e.g. Europe, Oceans, etc.
+
+    ## todo/check: add aliases e.g. - why? why not?
+    ##    country_code => code
+    ##    country_name => name
+    ##    region_name  => region
+
+    def region_slug() Factbook.region_to_slug( @region ); end
+  end # (nested) class Code
+
 
-  Code = Struct.new( :code,      ## todo: add notes (country affiliation) - why? why not??
-                     :name,
-                     :category,  ## e.g. Countries, Other, Oceans, World, Dependencies, etc.
-                     :region,    ## e.g. Europe, Oceans, etc.
-                    )
 
   def self.read_csv( path )
     ###
@@ -27,20 +47,18 @@ class Codes
 
     rows = CsvHash.read( path )
 
-    pp rows
+    ## pp rows
 
     recs = []
     rows.each do |row|
-      pp row
+      ## pp row
       rec = Code.new
       rec.code     = row['Code'].strip    ## remove leading n trailing whitespaces
       rec.name     = row['Name'].strip
+      rec.category = row['Category'].strip
+      rec.region   = row['Region'].strip
 
-      ## note: for now category and region are optional
-      rec.category = row['Category'].strip   if row['Category'] && row['Category'].size > 0
-      rec.region   = row['Region'].strip     if row['Region'] && row['Region'].size > 0
-
-      pp rec
+      ## pp rec
       recs << rec
     end
 
@@ -61,6 +79,8 @@ class Codes
   end
 
 
+  def [](key) @codes[ key ]; end
+
   def to_a
     @codes.collect {|code| code.code }   ## return array of codes
   end

data/lib/factbook-codes/version.rb

@@ -4,7 +4,7 @@ module  Module
 module   Codes
   MAJOR = 0
   MINOR = 1
-  PATCH = 0
+  PATCH = 1
   VERSION = [MAJOR,MINOR,PATCH].join('.')
 
   def self.version

data/test/test_codes.rb

@@ -10,8 +10,8 @@ class TestCodes < MiniTest::Test
 
 
   def test_codes
-    assert_equal 261, Factbook.codes.size
-    assert_equal 261, Factbook.codes.to_a.size
+    assert_equal 260, Factbook.codes.size
+    assert_equal 260, Factbook.codes.to_a.size
 
 
     assert_equal 195, Factbook.codes.countries.size
@@ -19,7 +19,7 @@ class TestCodes < MiniTest::Test
     assert_equal   5, Factbook.codes.oceans.size
     assert_equal   1, Factbook.codes.world.size
     assert_equal   2, Factbook.codes.others.size
-    assert_equal   6, Factbook.codes.misc.size
+    assert_equal   5, Factbook.codes.misc.size
 
     assert_equal   8, Factbook.codes.dependencies_us.size
 
@@ -29,7 +29,7 @@ class TestCodes < MiniTest::Test
     assert_equal   6, Factbook.codes.central_asia.size
     assert_equal  22, Factbook.codes.east_n_souteast_asia.size
     assert_equal  19, Factbook.codes.middle_east.size
-    assert_equal  56, Factbook.codes.africa.size
+    assert_equal  55, Factbook.codes.africa.size
     assert_equal   7, Factbook.codes.north_america.size
     assert_equal  33, Factbook.codes.central_america_n_caribbean.size
     assert_equal  14, Factbook.codes.south_america.size
@@ -44,14 +44,14 @@ class TestCodes < MiniTest::Test
     assert_equal  Factbook.codes.category('World').size,  Factbook.codes.region('World').size
 
 
-    assert_equal 261, Factbook.codes.countries.size +
+    assert_equal 260, Factbook.codes.countries.size +
                       Factbook.codes.others.size +
                       Factbook.codes.dependencies.size +
                       Factbook.codes.misc.size +
                       Factbook.codes.oceans.size +
                       Factbook.codes.world.size
 
-    assert_equal 261, Factbook.codes.europe.size +
+    assert_equal 260, Factbook.codes.europe.size +
                       Factbook.codes.south_asia.size +
                       Factbook.codes.central_asia.size +
                       Factbook.codes.east_n_souteast_asia.size +
@@ -64,9 +64,20 @@ class TestCodes < MiniTest::Test
                       Factbook.codes.antartica.size +
                       Factbook.codes.region('Oceans').size +
                       Factbook.codes.region('World').size
-
   end
 
-end # class TestCodes
+  def test_region_slug
+    bx = Factbook.codes[24]
+    #=> bx,Brunei,Countries,East & Southeast Asia
+
+    assert_equal 'East & Southeast Asia', bx.region
+    assert_equal 'east-n-southeast-asia', bx.region_slug
 
+    ac = Factbook.codes[5]
+    #=> ac,Antigua and Barbuda,Countries,Central America and Caribbean
+
+    assert_equal 'Central America and Caribbean', ac.region
+    assert_equal 'central-america-n-caribbean',   ac.region_slug
+  end
+end # class TestCodes
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: factbook-codes
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Gerald Bauer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-03 00:00:00.000000000 Z
+date: 2021-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logutils