factbook 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 644b296946acd4f2c6993fd8b6f35342058e14f5
-  data.tar.gz: 2ee8bfffd3efe837e42dc400434f40fe5359a0a9
+  metadata.gz: 803eeea496771f3aa1270492a1c4cbadf4732e68
+  data.tar.gz: 1ab08bf6938912090394fef275bb472876051c09
 SHA512:
-  metadata.gz: f5e0b528262e1f5399eed7b6cebcace7a8311025212c1be05c266e5f6cf479e852d6682d566f3759d714cf6d37b39ac29692e4cb8d6c13352336768d270eff42
-  data.tar.gz: 25c5c82128a134f68ec139e031b2825c5e820cb2e21f42c10d41430b702693e7cfd9a9a248e5c3f5b899f159e34bc02980f77eed8130414f54bc94e4d68a8b79
+  metadata.gz: 0a93698f9cc92495e59bdc1ef65100dfbf73a9143459377919f967adc3cfc6e658610eeade7e58cc53e01776337a99fda786fb3a625aa735ea02aa5e232f30f7
+  data.tar.gz: 54a74b57d4d210c69d48dfc98b8d7d9b82a2109e56b77ac3691af252ec174b6dc7c5634cdc8d3c9f35d5236d538566c510d300e935d245e0c99875b051dced82

data/CHANGELOG.md

@@ -1,3 +1,3 @@
-### 0.0.1 / 2014-07-07
+### 0.0.1 / 2020-11-27
 
 * Everything is new. First release.

data/Manifest.txt

@@ -2,65 +2,4 @@ CHANGELOG.md
 Manifest.txt
 README.md
 Rakefile
-data/attributes.yml
-data/categories.csv
-data/codes.csv
-data/codesxref.csv
-data/comparisons.csv
 lib/factbook.rb
-lib/factbook/almanac.rb
-lib/factbook/attributes.rb
-lib/factbook/builder.rb
-lib/factbook/builder_item.rb
-lib/factbook/builder_json.rb
-lib/factbook/codes.rb
-lib/factbook/comparisons.rb
-lib/factbook/counter.rb
-lib/factbook/db/importer.rb
-lib/factbook/db/models.rb
-lib/factbook/db/schema.rb
-lib/factbook/normalize.rb
-lib/factbook/page.rb
-lib/factbook/page_info.rb
-lib/factbook/reader_json.rb
-lib/factbook/sanitizer.rb
-lib/factbook/sect.rb
-lib/factbook/subsect.rb
-lib/factbook/table.rb
-lib/factbook/utils.rb
-lib/factbook/utils_info.rb
-lib/factbook/version.rb
-script/almanac.rb
-script/attributes.rb
-script/build.rb
-script/counter.rb
-script/json.rb
-script/testbr.rb
-script/testcodes.rb
-test/data/au.html
-test/data/au.yml
-test/data/be.html
-test/data/be.yml
-test/data/json/au.json
-test/data/src/ag.html
-test/data/src/au-2015-09-24.html
-test/data/src/au.html
-test/data/src/be-2015-09-24.html
-test/data/src/be.html
-test/helper.rb
-test/test_attribs.rb
-test/test_attribs_def.rb
-test/test_builder.rb
-test/test_codes.rb
-test/test_comparisons.rb
-test/test_convert.rb
-test/test_counter.rb
-test/test_fields.rb
-test/test_importer.rb
-test/test_item_builder.rb
-test/test_json.rb
-test/test_json_builder.rb
-test/test_normalize.rb
-test/test_page.rb
-test/test_sanitizer.rb
-test/test_sanitizer_regex.rb

data/README.md

@@ -1,4 +1,4 @@
-# factbook - scripts for the world factbook (get open structured data e.g JSON etc.)
+# factbook - umbrella - all together incl. factbook readers, writers 'n' importers
 
 * home  :: [github.com/factbook/factbook](https://github.com/factbook/factbook)
 * bugs  :: [github.com/factbook/factbook/issues](https://github.com/factbook/factbook/issues)
@@ -10,518 +10,18 @@
 
 ## What's the World Factbook?
 
-The World Factbook [1][2] published by the Central Intelligence Agency (CIA)
-offers free country profiles in the public domain (that is, no copyright(s), no rights reserved).
-
-- [1] [The World Factbook](https://www.cia.gov/library/publications/the-world-factbook/)
-- [2] [Wikipedia Article: The World Factbook](http://en.wikipedia.org/wiki/The_World_Factbook)
+See [factbook/factbook.json »](https://github.com/factbook/factbook.json)
 
 
 ## Usage
 
-### Get country profile page as a hash (that is, structured data e.g. nested key/values)
-
-```ruby
-page = Factbook::Page.new( 'br' )   # br is the country code for Brazil
-pp page.data                        # pretty print hash
-```
-
-resulting in:
-
-```ruby
-{"Introduction"=>
-  {"Background"=>
-    {"text"=>
-      "Following more than three centuries under Portuguese rule,
-       Brazil gained its independence in 1822, ..."}},
- "Geography"=>
-  {"Location"=>{"text"=>"Eastern South America, bordering the Atlantic Ocean"},
-   "Geographic coordinates"=>{"text"=>"10 00 S, 55 00 W"},
-   "Map references"=>{"text"=>"South America"},
-   "Area"=>
-    {"total"=>{"text"=>"8,515,770 sq km"},
-     "land"=>{"text"=>"8,358,140 sq km"},
-     "water"=>{"text"=>"157,630 sq km"},
-     "note"=>
-      {"text"=>
-        "includes Arquipelago de Fernando de Noronha, Atol das Rocas, ..."}},
-   "Area - comparative"=>
-    {"text"=>"slightly smaller than the US"},
-   "Land boundaries"=>
-    {"total"=>{"text"=>"16,145 km"},
-     "border countries (10)"=>
-      {"text"=>
-        "Argentina 1,263 km, Bolivia 3,403 km, Colombia 1,790 km,
-        French Guiana 649 km, Guyana 1,308 km, Paraguay 1,371 km, Peru 2,659 km,
-        Suriname 515 km, Uruguay 1,050 km, Venezuela 2,137 km"}},
-   "Climate"=>{"text"=>"mostly tropical, but temperate in south"},
-   "Elevation extremes"=>
-    {"lowest point"=>{"text"=>"Atlantic Ocean 0 m"},
-     "highest point"=>{"text"=>"Pico da Neblina 2,994 m"}},
-   "Natural resources"=>
-    {"text"=>
-      "bauxite, gold, iron ore, manganese, nickel, phosphates, ..."},
-    ...
-```
-
-### Use shortcut attribute accessors
-
-```ruby
-pp page.background        ## same as page['Introduction']['Background']['text']
-# => "Following more than three centuries..."
-pp page.area              ## same as page['Geography'][''Area']['total']['text']
-# => "8,515,770 sq km"
-pp page.area_land         ## same as page['Geography'][''Area']['land']['text']
-# => "8,358,140 sq km"
-pp page.area_water        ## same as page['Geography'][''Area']['water']['text']
-# => "157,630 sq km"
-pp page.area_note         ## same as page['Geography'][''Area']['note']['text']
-# => "includes Arquipelago de Fernando de Noronha, Atol das Rocas, ..."
-pp page.area_comparative  ## same as page['Geography']['Area - comparative']['text']
-# => "slightly smaller than the US"
-pp page.climate           ## same as page['Geography']['Climate']['text']
-# => "mostly tropical, but temperate in south"
-pp page.terrain           ## same as page['Geography']['Terrain']['text']
-# => "mostly flat to rolling lowlands in north; ..."
-pp page.elevation_lowest  ## same as page['Geography']['Elevation extremes']['lowest point']['text']
-# => "Atlantic Ocean 0 m"
-pp page.elevation_highest ## same as page['Geography']['Elevation extremes']['highest point']['text']
-# => "Pico da Neblina 2,994 m"
-pp page.resources         ## same as page['Geography'][Natural resources']['text']
-# => "bauxite, gold, iron ore, manganese, nickel, phosphates, ..."
-...
-```
-
-See [`data/attributes.yml`](data/attributes.yml) for the full listing of all built-in attribute shortcut accessors.
-See [Attributes](ATTRIBUTES.md) for a quick reference listing.
-
-
-### Save to disk as JSON
-
-```ruby
-page = Factbook::Page.new( 'br' )
-File.open( 'br.json', 'w:utf-8') do |f|
-  f.write page.to_json
-end
-```
-
-
-### List all codes
-
-```ruby
-Factbook.codes.each do |code|
-  pp code
-end
-```
-
-resulting in:
-
-```
-#<struct Factbook::Codes::Code
- code    ="af",
- name    ="Afghanistan",
- category="Countries",
- region  ="South Asia">
-#<struct Factbook::Codes::Code
- code    ="al",
- name    ="Albania",
- category="Countries",
- region  ="Europe">
-#<struct Factbook::Codes::Code
- code    ="ag",
- name    ="Algeria",
- category="Countries",
- region  ="Africa">
-#<struct Factbook::Codes::Code
- code    ="an",
- name    ="Andorra",
- category="Countries",
- region  ="Europe">
-...
-```
-
-Note: You can filter codes by category e.g. Countries, Dependencies, Miscellaneous, Oceans, etc.
-and/or by region e.g. Africa, Europe, South Asia, Central America and Caribbean, etc.
-
-
-```ruby
-
-assert_equal 261, Factbook.codes.size
-
-## categories
-assert_equal 195, Factbook.codes.countries.size
-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
-
-## regions
-assert_equal  55, Factbook.codes.europe.size
-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   7, Factbook.codes.north_america.size
-assert_equal  33, Factbook.codes.central_america_n_caribbean.size
-assert_equal  14, Factbook.codes.south_america.size
-assert_equal  30, Factbook.codes.australia_oceania.size
-assert_equal   4, Factbook.codes.antartica.size
-assert_equal   5, Factbook.codes.region('Oceans').size
-assert_equal   1, Factbook.codes.region('World').size
-
-## categories + regions
-assert_equal  45, Factbook.codes.countries.europe.size
-...
-```
-
-See [`data/codes.csv`](data/codes.csv) for the built-in listing of all codes with categories and regions.
-
-
-
-## The World Factbook Summary (267 Entries)
-
-The World Factbook includes 267 entries -
-195 sovereign countries /
-2 others /
-58 dependencies /
-6 miscellaneous /
-5 oceans /
-1 world:
+It's an umbrella gem that (auto-)includes:
 
+- [**factbook-readers**](../factbook-readers)  - turn the country profile web pages into open structured data e.g JSON
+- [factbook-writers](../factbook-writers)     - produce your own personal world almanac
+- [factbook-importers](../factbook-importers) - import (semi-)structured data into database for SQL queries, etc.
 
-### Sovereign Countries (195)
 
-**A**
-`af` Afghanistan
-`al` Albania
-`ag` Algeria
-`an` Andorra
-`ao` Angola
-`ac` Antigua and Barbuda
-`ar` Argentina
-`am` Armenia
-`as` Australia
-`au` Austria
-`aj` Azerbaijan
-**B**
-`bf` The Bahamas
-`ba` Bahrain
-`bg` Bangladesh
-`bb` Barbados
-`bo` Belarus
-`be` Belgium
-`bh` Belize
-`bn` Benin
-`bt` Bhutan
-`bl` Bolivia
-`bk` Bosnia and Herzegovina
-`bc` Botswana
-`br` Brazil
-`bx` Brunei
-`bu` Bulgaria
-`uv` Burkina Faso
-`bm` Burma
-`by` Burundi
-**C**
-`cb` Cambodia
-`cm` Cameroon
-`ca` Canada
-`cv` Cape Verde
-`ct` Central African Republic
-`cd` Chad
-`ci` Chile
-`ch` China
-`co` Colombia
-`cn` Comoros
-`cg` Congo DR
-`cf` Congo
-`cs` Costa Rica
-`iv` Cote d'Ivoire
-`hr` Croatia
-`cu` Cuba
-`cy` Cyprus
-`ez` Czech Republic
-**D**
-`da` Denmark
-`dj` Djibouti
-`do` Dominica
-`dr` Dominican Republic
-**E**
-`ec` Ecuador
-`eg` Egypt
-`es` El Salvador
-`ek` Equatorial Guinea
-`er` Eritrea
-`en` Estonia
-`et` Ethiopia
-**F**
-`fj` Fiji
-`fi` Finland
-`fr` France
-**G**
-`gb` Gabon
-`ga` The Gambia
-`gg` Georgia
-`gm` Germany
-`gh` Ghana
-`gr` Greece
-`gj` Grenada
-`gt` Guatemala
-`gv` Guinea
-`pu` Guinea-Bissau
-`gy` Guyana
-**H**
-`ha` Haiti
-`ho` Honduras
-`hu` Hungary
-**I**
-`ic` Iceland
-`in` India
-`id` Indonesia
-`ir` Iran
-`iz` Iraq
-`ei` Ireland
-`is` Israel
-`it` Italy
-**J**
-`jm` Jamaica
-`ja` Japan
-`jo` Jordan
-**K**
-`kz` Kazakhstan
-`ke` Kenya
-`kr` Kiribati
-`kn` North Korea
-`ks` South Korea
-`kv` Kosovo
-`ku` Kuwait
-`kg` Kyrgyzstan
-**L**
-`la` Laos
-`lg` Latvia
-`le` Lebanon
-`lt` Lesotho
-`li` Liberia
-`ly` Libya
-`ls` Liechtenstein
-`lh` Lithuania
-`lu` Luxembourg
-**M**
-`mk` Macedonia
-`ma` Madagascar
-`mi` Malawi
-`my` Malaysia
-`mv` Maldives
-`ml` Mali
-`mt` Malta
-`rm` Marshall Islands
-`mr` Mauritania
-`mp` Mauritius
-`mx` Mexico
-`fm` Micronesia
-`md` Moldova
-`mn` Monaco
-`mg` Mongolia
-`mj` Montenegro
-`mo` Morocco
-`mz` Mozambique
-**N**
-`wa` Namibia
-`nr` Nauru
-`np` Nepal
-`nl` Netherlands
-`nz` New Zealand
-`nu` Nicaragua
-`ng` Niger
-`ni` Nigeria
-`no` Norway
-**O**
-`mu` Oman
-**P**
-`pk` Pakistan
-`ps` Palau
-`pm` Panama
-`pp` Papua New Guinea
-`pa` Paraguay
-`pe` Peru
-`rp` Philippines
-`pl` Poland
-`po` Portugal
-**Q**
-`qa` Qatar
-**R**
-`ro` Romania
-`rs` Russia
-`rw` Rwanda
-**S**
-`sc` Saint Kitts and Nevis
-`st` Saint Lucia
-`vc` Saint Vincent and the Grenadines
-`ws` Samoa
-`sm` San Marino
-`tp` Sao Tome and Principe
-`sa` Saudi Arabia
-`sg` Senegal
-`ri` Serbia
-`se` Seychelles
-`sl` Sierra Leone
-`sn` Singapore
-`lo` Slovakia
-`si` Slovenia
-`bp` Solomon Islands
-`so` Somalia
-`sf` South Africa
-`od` South Sudan
-`sp` Spain
-`ce` Sri Lanka
-`su` Sudan
-`ns` Suriname
-`wz` Swaziland
-`sw` Sweden
-`sz` Switzerland
-`sy` Syria
-**T**
-`ti` Tajikistan
-`tz` Tanzania
-`th` Thailand
-`tt` Timor-Leste
-`to` Togo
-`tn` Tonga
-`td` Trinidad and Tobago
-`ts` Tunisia
-`tu` Turkey
-`tx` Turkmenistan
-`tv` Tuvalu
-**U**
-`ug` Uganda
-`up` Ukraine
-`ae` United Arab Emirates
-`uk` United Kingdom
-`us` United States
-`uy` Uruguay
-`uz` Uzbekistan
-**V**
-`nh` Vanuatu
-`vt` Vatican City (Holy See)
-`ve` Venezuela
-`vm` Vietnam
-**Y**
-`ym` Yemen
-**Z**
-`za` Zambia
-`zi` Zimbabwe
-
-
-### Other (2)
-
-`tw` Taiwan
-`ee` European Union
-
-### Dependencies (58)
-
-Australia (6):
-`at` Ashmore and Cartier Islands
-`kt` Christmas Island
-`ck` Cocos (Keeling) Islands
-`cr` Coral Sea Islands
-`hm` Heard Island and McDonald Islands
-`nf` Norfolk Island
-
-China (2):
-`hk` Hong Kong
-`mc` Macau
-
-Denmark (2):
-`fo` Faroe Islands
-`gl` Greenland
-
-France (8):
-`ip` Clipperton Island
-`fp` French Polynesia
-`fs` French Southern and Antarctic Lands
-`nc` New Caledonia
-`tb` Saint Barthelemy
-`rn` Saint Martin
-`sb` Saint Pierre and Miquelon
-`wf` Wallis and Futuna
-
-Netherlands (3):
-`aa` Aruba
-`uc` Curacao
-`nn` Sint Maarten
-
-New Zealand (3):
-`cw` Cook Islands
-`ne` Niue
-`tl` Tokelau
-
-Norway (3):
-`bv` Bouvet Island
-`jn` Jan Mayen
-`sv` Svalbard
-
-Great Britain (17):
-`ax` Akrotiri (Sovereign Base)
-`av` Anguilla
-`bd` Bermuda
-`io` British Indian Ocean Territory
-`vi` British Virgin Islands
-`cj` Cayman Islands
-`dx` Dhekelia (Sovereign Base)
-`fk` Falkland Islands
-`gi` Gibraltar
-`gk` Guernsey
-`je` Jersey
-`im` Isle of Man
-`mh` Montserrat
-`pc` Pitcairn Islands
-`sh` Saint Helena
-`sx` South Georgia and the South Sandwich Islands
-`tk` Turks and Caicos Islands
-
-United States (14):
-`aq` American Samoa
-`gq` Guam
-`bq` Navassa Island
-`cq` Northern Mariana Islands
-`rq` Puerto Rico
-`vq` US Virgin Islands
-`wq` Wake Island
-`um` US Pacific Island Wildlife Refuges
-(Baker Island, Howland Island, Jarvis Island, Johnston Atoll, Kingman Reef, Midway Islands, Palmyra Atoll)
-
-
-### Miscellaneous (6)
-
-`ay` Antarctica
-`gz` Gaza Strip
-`pf` Paracel Islands
-`pg` Spratly Islands
-`we` West Bank
-`wi` Western Sahara
-
-### Oceans (5)
-
-`xq` Arctic Ocean
-`zh` Atlantic Ocean
-`xo` Indian Ocean
-`zn` Pacific Ocean
-`oo` Southern Ocean
-
-### World (1)
-
-`xx` World
-
-
-
-
-## Ready-To-Use Public Domain Factbook Datasets
-
-[factbook/factbook.json](https://github.com/factbook/factbook.json) - open (public domain)
-factbook country profiles in JSON for all the world's countries (using internet domain names
-for country codes e.g. Austria is `at.json` not `au.json`, Germany is `de.json` not `gm.json` and so on)
 
 
 ## Install
@@ -546,3 +46,5 @@ Use it as you please with no restrictions whatsoever.
 
 Send them along to the [Open Mundi (world.db) Database Forum/Mailing List](http://groups.google.com/group/openmundi).
 Thanks!
+
+