RubyGems - factbook - Versions diffs - 1.1.1 → 2.0.1 - Mend

factbook 1.1.1 → 2.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (64) hide show

checksums.yaml +4 -4
data/{HISTORY.md → CHANGELOG.md} +3 -3
data/Manifest.txt +1 -58
data/README.md +50 -575
data/Rakefile +29 -33
data/lib/factbook.rb +8 -75
metadata +20 -114
data/data/attributes.yml +0 -337
data/data/categories.csv +0 -164
data/data/codes.csv +0 -262
data/data/codesxref.csv +0 -280
data/data/comparisons.csv +0 -75
data/lib/factbook/almanac.rb +0 -72
data/lib/factbook/attributes.rb +0 -74
data/lib/factbook/builder.rb +0 -214
data/lib/factbook/builder_item.rb +0 -92
data/lib/factbook/builder_json.rb +0 -79
data/lib/factbook/codes.rb +0 -119
data/lib/factbook/comparisons.rb +0 -50
data/lib/factbook/counter.rb +0 -48
data/lib/factbook/db/importer.rb +0 -92
data/lib/factbook/db/models.rb +0 -11
data/lib/factbook/db/schema.rb +0 -36
data/lib/factbook/normalize.rb +0 -43
data/lib/factbook/page.rb +0 -185
data/lib/factbook/page_info.rb +0 -12
data/lib/factbook/reader_json.rb +0 -51
data/lib/factbook/sanitizer.rb +0 -207
data/lib/factbook/sect.rb +0 -29
data/lib/factbook/subsect.rb +0 -18
data/lib/factbook/table.rb +0 -52
data/lib/factbook/utils.rb +0 -85
data/lib/factbook/utils_info.rb +0 -102
data/lib/factbook/version.rb +0 -22
data/script/almanac.rb +0 -48
data/script/attributes.rb +0 -34
data/script/build.rb +0 -28
data/script/counter.rb +0 -145
data/script/json.rb +0 -18
data/script/testbr.rb +0 -33
data/script/testcodes.rb +0 -11
data/test/data/au.html +0 -579
data/test/data/au.yml +0 -8
data/test/data/be.html +0 -596
data/test/data/be.yml +0 -8
data/test/data/json/au.json +0 -892
data/test/data/src/au.html +0 -2006
data/test/data/src/be.html +0 -2011
data/test/helper.rb +0 -11
data/test/test_attribs.rb +0 -82
data/test/test_attribs_def.rb +0 -20
data/test/test_builder.rb +0 -35
data/test/test_codes.rb +0 -76
data/test/test_comparisons.rb +0 -19
data/test/test_convert.rb +0 -30
data/test/test_counter.rb +0 -31
data/test/test_fields.rb +0 -52
data/test/test_importer.rb +0 -55
data/test/test_item_builder.rb +0 -99
data/test/test_json.rb +0 -44
data/test/test_json_builder.rb +0 -25
data/test/test_normalize.rb +0 -23
data/test/test_page.rb +0 -38
data/test/test_sanitizer.rb +0 -35

checksums.yaml CHANGED

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7d04215fc02fbf5130eea7d48cc460f0e7df2cb6
-  data.tar.gz: eddd7e401104e81b6ab8146c080ace4e83e8f1d0
+  metadata.gz: 803eeea496771f3aa1270492a1c4cbadf4732e68
+  data.tar.gz: 1ab08bf6938912090394fef275bb472876051c09
 SHA512:
-  metadata.gz: c68ce2ae5385316adf9d2a9bda234cf96ab8b4d59553a155a159da4fbb1d9bf017d6fc9630dab2e4a15ab691ff36c60752a75e2db9c0f61258d34653f4e0759d
-  data.tar.gz: d54e73bf9d52eb7b71eea41f9633bb2b761cc4e3c3bfa292aa3318c527be9b7952524494582b252bd777fa9f1f6fa13b3985f54bff0a3003c04c35f65f9435cc
+  metadata.gz: 0a93698f9cc92495e59bdc1ef65100dfbf73a9143459377919f967adc3cfc6e658610eeade7e58cc53e01776337a99fda786fb3a625aa735ea02aa5e232f30f7
+  data.tar.gz: 54a74b57d4d210c69d48dfc98b8d7d9b82a2109e56b77ac3691af252ec174b6dc7c5634cdc8d3c9f35d5236d538566c510d300e935d245e0c99875b051dced82

data/{HISTORY.md → CHANGELOG.md} RENAMED

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

data/Manifest.txt CHANGED

@@ -1,62 +1,5 @@
-HISTORY.md
+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/au.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

data/README.md CHANGED

@@ -1,575 +1,50 @@
-# factbook - scripts for the world factbook (get open structured data e.g JSON etc.)
-* home  :: [github.com/worlddb/factbook](https://github.com/worlddb/factbook)
-* bugs  :: [github.com/worlddb/factbook/issues](https://github.com/worlddb/factbook/issues)
-* gem   :: [rubygems.org/gems/factbook](https://rubygems.org/gems/factbook)
-* rdoc  :: [rubydoc.info/gems/factbook](http://rubydoc.info/gems/factbook)
-* forum :: [groups.google.com/group/openmundi](https://groups.google.com/group/openmundi)
-## 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)
-## 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') do |f|
-  f.write page.to_json
-end
-```
-### List all codes
-```ruby
-Factbook.codes.each do |code|
-  pp code
-end
-```
-resulting in:
-```ruby
-#<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:
-### 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)
-## Alternatives (Libraries and Gems)
-Ruby
-- [worldfactbook gem](https://github.com/sayem/worldfactbook)
-  by Sayem Khan (aka sayem);
-  fetches data from its own mirror, that is, [rubyworldfactbook.com](http://rubyworldfactbook.com)
-  (last updated 2011?)
-- [the_country_identity gem](https://github.com/p1nox/the_country_identity)
-  by Raul Pino (aka p1nox);
-  fetches data from an [RDF Turtle endpoint](http://wifo5-03.informatik.uni-mannheim.de/factbook/)
-  hosted by the Research Group Data and Web Science at the University of Mannheim, Germany
-JavaScript
-- [worldfactbook-dataset](https://github.com/twigkit/worldfactbook-dataset)
-  by Richard Marr (aka richmarr); fetches data using Node.js
-  (last updated 2013)
-Python
-- [openfactbook datasets & tools](https://github.com/openfactbook)
-  by Eckhard Licher; uses official (offline) download archive (last updated 2014); incl. flags, maps, and more
-Others
-TBD
-## Install
-Just install the gem:
-    $ gem install factbook
-## License
-The `factbook` scripts are dedicated to the public domain.
-Use it as you please with no restrictions whatsoever.
-## Questions? Comments?
-Send them along to the [Open Mundi (world.db) Database Forum/Mailing List](http://groups.google.com/group/openmundi).
-Thanks!
+# 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)
+* gem   :: [rubygems.org/gems/factbook](https://rubygems.org/gems/factbook)
+* rdoc  :: [rubydoc.info/gems/factbook](http://rubydoc.info/gems/factbook)
+* forum :: [groups.google.com/group/openmundi](https://groups.google.com/group/openmundi)
+## What's the World Factbook?
+See [factbook/factbook.json »](https://github.com/factbook/factbook.json)
+## Usage
+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.
+## Install
+Use
+    gem install factbook
+or add to your Gemfile
+    gem 'factbook'
+## License
+The `factbook` scripts are dedicated to the public domain.
+Use it as you please with no restrictions whatsoever.
+## Questions? Comments?
+Send them along to the [Open Mundi (world.db) Database Forum/Mailing List](http://groups.google.com/group/openmundi).
+Thanks!