factbook 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 24d96765bcda05d51ce7f72baa5f565da45aa85b
-  data.tar.gz: 7841f960d9905ad051c6ef255f374ed875091f88
+  metadata.gz: 7d04215fc02fbf5130eea7d48cc460f0e7df2cb6
+  data.tar.gz: eddd7e401104e81b6ab8146c080ace4e83e8f1d0
 SHA512:
-  metadata.gz: 93fac1f61de8fcd72e98afb4ed5bb6619cb849fac69ef979c2a5703fd2886a0cf8b6a9c260cb179c3209d6d61a57170ac7dc11e81c59928ec3532efcbf212180
-  data.tar.gz: 5e84df0a02a7278b9cb54f19fd02364abe302c78a1aa222b334e3844141b13d82c10e1e51b53d5a906bbb8f43ee59cd44b02abde2aff58c6f1cff37355346ce8
+  metadata.gz: c68ce2ae5385316adf9d2a9bda234cf96ab8b4d59553a155a159da4fbb1d9bf017d6fc9630dab2e4a15ab691ff36c60752a75e2db9c0f61258d34653f4e0759d
+  data.tar.gz: d54e73bf9d52eb7b71eea41f9633bb2b761cc4e3c3bfa292aa3318c527be9b7952524494582b252bd777fa9f1f6fa13b3985f54bff0a3003c04c35f65f9435cc

data/Manifest.txt

@@ -2,19 +2,27 @@ HISTORY.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
@@ -22,23 +30,33 @@ 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

@@ -92,6 +92,10 @@ pp page.resources         ## same as page['Geography'][Natural resources']['text
 ...
 ```
 
+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
@@ -172,6 +176,9 @@ 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)
 

data/data/attributes.yml

@@ -0,0 +1,337 @@
+############################
+# attributes
+
+Introduction:
+  Background:                { name: background }
+
+Geography:
+  Location:                  { name: location }
+  Geographic coordinates:    { name: coords }      ## use geo_coords - why, why not??
+  Map references:            { name: map }         ## use map_ref - why, why not??
+  Area:
+    total:                   { name: area }
+    land:                    { name: area_land }
+    water:                   { name: area_water }
+    note:                    { name: area_note }
+  Area - comparative:        { name: area_comparative }
+  Land boundaries:
+    total:                   { name: border_land }
+    border countries:        { name: border_countries }   ## todo/fix: remove count from key e.g. border countries (8)
+  Coastline:                 { name: coastline }          ## use border_water  - why, why not??
+  Maritime claims:
+    territorial sea:         { name: maritime_claims_territorial_sea }
+    contiguous zone:         { name: maritime_claims_contiguous_zone }
+    exclusive economic zone: { name: maritime_claims_exclusive_economic_zone }
+    continental shelf:       { name: maritime_claims_continental_shelf }
+  Climate:                   { name: climate }
+  Terrain:                   { name: terrain }
+  Elevation extremes:
+    lowest point:            { name: elevation_lowest }
+    highest point:           { name: elevation_highest }
+  Natural resources:         { name: resources }
+  Land use:
+    agricultural land:       { name: land_use_agriculture }
+    forest:                  { name: land_use_forest }
+    other:                   { name: land_use_other }
+  Irrigated land:            { name: land_irrigated }
+  Total renewable water resources:  { name: water_renewable }
+  Freshwater withdrawal (domestic/industrial/agricultural):
+    total:                   { name: water_withdrawal }
+    per capita:              { name: water_withdrawal_capita }
+  Natural hazards:
+    name: natural_hazards        ## note: "special" attribute case with "mixed" content
+    volcanism:               { name: natural_hazards_volcanism } 
+  Environment - current issues:  { name: environment_issues }
+  Environment - international agreements:
+    party to:                    { name: environment_agreements }
+    "signed, but not ratified":  { name: environment_agreements_note }     ## use _ratified - why, why not??
+  Geography - note:        { name: geography_note }      ## use geo_note or geography - why, why not??
+
+People and Society:
+  Nationality:
+    noun:               { name: nationality }
+    adjective:          { name: nationality_adjective }
+  Ethnic groups:        { name: ethnic_groups }
+  Languages:
+    name: languages       ## note: "special" attribute case with "mixed" content
+    note:               { name: languages_note }
+  Religions:            { name: religions }
+  Demographic profile:  { name: demographic }
+  Population:           { name: population }
+  Age structure:
+    0-14 years:         { name: age_0_14yrs }
+    15-24 years:        { name: age_15_24yrs }
+    25-54 years:        { name: age_25_54yrs }
+    55-64 years:        { name: age_55_64yrs }
+    65 years and over:  { name: age_65yrs_plus }
+  Dependency ratios:
+    total:                    { name: dependency_ratio }
+    youth dependency ratio:   { name: dependency_youth_ratio }
+    elderly dependency ratio: { name: dependency_elderly_ratio }
+    potential support ratio:  { name: dependency_support_ratio }
+  Median age:
+    total:                    { name: median_age }
+    male:                     { name: median_age_male }
+    female:                   { name: median_age_female }                           
+  Population growth rate:     { name: population_growth }
+  Birth rate:                 { name: birth_rate }
+  Death rate:                 { name: death_rate }
+  Net migration rate:         { name: migration_rate }
+  Urbanization:
+    urban population:         { name: urbanization }
+    rate of urbanization:     { name: urbanization_growth }   ## use _rate - why, why not??
+  Major urban areas - population:  { name: major_cities }
+  Sex ratio:
+    at birth:                 { name: sex_ratio_birth }
+    0-14 years:               { name: sex_ratio_0_14yrs }
+    15-24 years:              { name: sex_ratio_15_24yrs }
+    25-54 years:              { name: sex_ratio_25_54yrs }
+    55-64 years:              { name: sex_ratio_55_64yrs }
+    65 years and over:        { name: sex_ratio_65yrs_plus }
+    total population:         { name: sex_ratio }
+  Infant mortality rate:
+    total:                    { name: infant_mortality }   ## add _rate - why, why not??
+    male:                     { name: infant_mortality_male }
+    female:                   { name: infant_mortality_female }
+  Life expectancy at birth:
+    total population:         { name: life_expectancy }
+    male:                     { name: life_expectancy_male }
+    female:                   { name: life_expectancy_female }
+  Total fertility rate:       { name: fertility }
+  Contraceptive prevalence rate:
+    name: contraceptive_rate    ## note: "special" attribute case with "mixed" content
+    note:                     { name: contraceptive_rate_note }
+  Health expenditures:        { name: health_expenditures }   ## todo: change to health ??
+  Physicians density:         { name: density_physicians }
+  Hospital bed density:       { name: density_hospital_bed }
+  Drinking water source:
+    improved:                 { name: drinking_water_improved }   ## todo:split into urban/rural/total ??
+    unimproved:               { name: drinking_water_unimproved }
+  Sanitation facility access:
+    improved:                 { name: sanitation_improved }   ## todo:split into urban/rural/total ??
+    unimproved:               { name: sanitation_unimproved }
+  HIV/AIDS - adult prevalence rate:        { name: aids }
+  HIV/AIDS - people living with HIV/AIDS:  { name: aids_people }
+  HIV/AIDS - deaths:                       { name: aids_deaths }
+  Obesity - adult prevalence rate:         { name: obesity }
+  Children under the age of 5 years underweight:  { name: underweight_children_under_5yrs }
+  Education expenditures:                  { name: education_expenditures }  ## change to education ??
+  Literacy:
+    definition:                            { name: literacy_def }
+    total population:                      { name: literacy }
+    male:                                  { name: literacy_male }
+    female:                                { name: literacy_female }
+  School life expectancy (primary to tertiary education):
+    total:                                 { name: school_life }
+    male:                                  { name: school_life_male }
+    female:                                { name: school_life_female }
+  Child labor - children ages 5-14:
+    total number:                          { name: child_labor }
+    percentage:                            { name: child_labor_rate }
+    note:                                  { name: child_labor_note }
+  "Unemployment, youth ages 15-24":
+    total:                                 { name: unemployment_youth }
+    male:                                  { name: unemployment_youth_male }
+    female:                                { name: unemployment_youth_female }
+
+Government:
+  Country name:
+    conventional long form:   { name: name_long }
+    conventional short form:  { name: name }
+    local long form:          { name: name_long_local } 
+    local short form:         { name: name_local }
+    note:                     { name: name_note }
+    ## add name_former ( see gm) ??  add abbreviations (see us)
+  Government type:            { name: government_type }
+  Capital:
+    name:                     { name: capital }
+    geographic coordinates:   { name: capital_coords }
+    time difference:          { name: capital_time_diff }
+    daylight saving time:     { name: capital_dst }
+  Administrative divisions:   { name: admins }
+  Independence:               { name: independence } 
+  National holiday:           { name: natinal_holiday }
+  Constitution:               { name: constitution }
+  Legal system:               { name: legal_system }
+  International law organization participation:   { name: legal_intl_orgs }
+  Suffrage:                   { name: suffrage }
+  ## note: skip Executive,Legislative,Judicial,... entries for now
+  International organization participation: { name: intl_orgs }
+  Flag description:           { name: flag }
+  National symbol(s):         { name: national_symbols }
+  National anthem:
+    name:                     { name: national_anthem}
+    lyrics/music:             { name: national_anthem_by }
+    note:                     { name: national_anthem_note }   
+
+Economy:
+  Economy - overview:             { name: economy_overview }
+  GDP (purchasing power parity):
+    name: gdp_ppp                    ## note: "special" attribute case with "mixed" content
+    note:                         { name: gdp_ppp_note }
+  GDP (official exchange rate):   { name: gdp }
+  GDP - real growth rate:         { name: gdp_growth }
+  GDP - per capita (PPP):
+    name: gdp_ppp_capita              ## note: "special" attribute case with "mixed" content
+    note:                         { name: gdp_ppp_capita_note }
+  Gross national saving:          { name: saving }
+  "GDP - composition, by end use":
+    household consumption:         { name: consumption_household }
+    government consumption:        { name: consumption_government }
+    investment in fixed capital:   { name: investment_fixed }
+    investment in inventories:     { name: investment_inventories }
+    exports of goods and services: { name: exports_gdp_rate }
+    imports of goods and services: { name: imports_gdb_rate }
+  "GDP - composition, by sector of origin":
+    agriculture:                   { name: agriculture_gdb_rate }
+    industry:                      { name: industry_gdb_rate }
+    services:                      { name: services_gdb_rate }
+  Agriculture - products:          { name: agriculture_products }
+  Industries:                      { name: industries }
+  Industrial production growth rate: { name: industry_growth }
+  Labor force:                     { name: labor }
+  Labor force - by occupation:
+    agriculture:                   { name: labor_agriculture }
+    industry:                      { name: labor_industry }
+    services:                      { name: labor_services }
+  Unemployment rate:               { name: unemployment }
+  Population below poverty line:
+    name: poverty                    ## note: "special" attribute case with "mixed" content
+    note:                          { name: poverty_note }
+  Household income or consumption by percentage share:
+    "lowest 10%":                  { name: household_income_lowest }   ## use _poorest, _bottom ???
+    "highest 10%":                 { name: household_income_highest }  ## use _richest, _top ???
+  Distribution of family income - Gini index:  { name: gini }
+  Budget:
+    revenues:                      { name: budget_revenues }
+    expenditures:                  { name: budget_expenditures }
+  Taxes and other revenues:        { name: taxes }
+  Budget surplus (+) or deficit (-): { name: budget_balance }
+  Public debt:
+    name: public_debt               ## note: "special" attribute case with "mixed" content
+    note:                          { name: public_debt_note }
+  Fiscal year:                     { name: fiscal_year }
+  Inflation rate (consumer prices): { name: inflation }
+  Central bank discount rate:       { name: central_bank_discount_rate }  ## use discount_rate - why? why not?? 
+  Commercial bank prime lending rate: { name: prime_rate }
+  Stock of narrow money:
+    name: narrow_money               ## note: "special" attribute case with "mixed" content
+    note:                           { name: narrow_money_note }
+  Stock of broad money:             { name: broad_money }
+  Stock of domestic credit:         { name: domestic_credit }
+  Market value of publicly traded shares: { name: shares_market_value }
+  Current account balance:          { name: current_account_balance }
+  Exports:                          { name: exports }
+  Exports - commodities:            { name: exports_commodities }
+  Exports - partners:               { name: exports_partners }
+  Imports:                          { name: imports }
+  Imports - commodities:            { name: imports_commodities }
+  Imports - partners:               { name: imports_partners }
+  Reserves of foreign exchange and gold:  { name: foreign_exchange_reserves }
+  Debt - external:                  { name: debt_external }
+  Stock of direct foreign investment - at home:  { name: direct_foreign_investment_home }
+  Stock of direct foreign investment - abroad:   { name: direct_foreign_investment_abroad }
+  Exchange rates:                   { name: exchange_rates }
+
+Energy:
+  Electricity - production:  { name: electricity_production }
+  Electricity - consumption: { name: electricity_consumption }
+  Electricity - exports:     { name: electricity_exports }
+  Electricity - imports:     { name: electricity_imports }
+  Electricity - installed generating capacity: { name: electricity_capacity }
+  Electricity - from fossil fuels:   { name: electricity_fossil }
+  Electricity - from nuclear fuels:  { name: electricity_nuclear }
+  Electricity - from hydroelectric plants:  { name: electricity_hydro }
+  Electricity - from other renewable sources:  { name: electricity_other }
+  Crude oil - production:       { name: oil_production }
+  Crude oil - exports:          { name: oil_exports }
+  Crude oil - imports:          { name: oil_imports }
+  Crude oil - proved reserves:  { name: oil_reserves }
+  Refined petroleum products - production:  { name: petroleum_production }
+  Refined petroleum products - consumption: { name: petroleum_consumption }
+  Refined petroleum products - exports:     { name: petroleum_exports }
+  Refined petroleum products - imports:     { name: petroleum_imports }
+  Natural gas - production:      { name: natural_gas_production }
+  Natural gas - consumption:     { name: natural_gas_consumpiton }
+  Natural gas - exports:         { name: natural_gas_exports }
+  Natural gas - imports:         { name: natural_gas_imports }
+  Natural gas - proved reserves: { name: natural_gas_reserves }
+  Carbon dioxide emissions from consumption of energy:  { name: carbon_dioxide }
+
+Communications:
+  Telephones - fixed lines:
+    total subscriptions:                { name: telephones }
+    subscriptions per 100 inhabitants:  { name: telephones_subscriptions }
+  Telephones - mobile cellular:
+    total:                             { name: telephones_mobile }
+    subscriptions per 100 inhabitants: { name: telephones_mobile_subscriptions }
+  Telephone system:
+    general assessment:                { name: telephone_system }
+    domestic:                          { name: telephone_system_domestic }
+    international:                     { name: telephone_system_intl }
+  Broadcast media:                     { name: broadcast_media }
+  Radio broadcast stations:            { name: radio_broadcast_stations }
+  Television broadcast stations:       { name: tv_broadcast_stations }
+  Internet country code:               { name: internet }
+  Internet users:
+    total:                             { name: internet_users }
+    percent of population:             { name: internet_users_rate }
+
+Transportation:
+  Airports:                            { name: airports }
+  Airports - with paved runways:
+    total:                             { name: airports_paved }
+    "over 3,047 m":                    { name: airports_paved_over_10000ft }
+    "2,438 to 3,047 m":                { name: airports_paved_8000_10000ft }
+    "1,524 to 2,437 m":                { name: airports_paved_5000_8000ft  }
+    "914 to 1,523 m":                  { name: airports_paved_3000_5000ft  }
+    "under 914 m":                     { name: airports_paved_under_3000ft }
+  Airports - with unpaved runways:
+    total:                             { name: airports_unpaved }
+    "1,524 to 2,437 m":                { name: airports_unpaved_5000_8000ft } 
+    "914 to 1,523 m":                  { name: airports_unpaved_3000_5000ft }
+    "under 914 m":                     { name: airports_unpaved_under_3000ft }
+  Heliports:                           { name: heliports }
+  Pipelines:                           { name: pipelines }
+  Railways:
+    total:                             { name: railways }
+    standard gauge:                    { name: railways_standard_gauge }
+    narrow gauge:                      { name: railways_narrow_gauge }
+    broad gauge:                       { name: railways_broad_gauge }
+    dual gauge:                        { name: railways_dual_gauge }
+  Roadways:
+    total:                             { name: roadways }
+    paved:                             { name: roadways_paved }
+    unpaved:                           { name: roadways_unpaved }
+    note:                              { name: roadways_note }
+  Waterways:                           { name: waterways }
+  Merchant marine:
+    total:                             { name: merchant_marine }
+    by type:                           { name: merchant_marine_by_type }
+    foreign-owned:                     { name: merchant_marine_foreign }
+    registered in other countries:     { name: merchant_marine_others }
+  Ports and terminals:
+    major seaport(s):                  { name: sea_ports }
+    river port(s):                     { name: river_ports }
+
+Military:
+  Military branches:                    { name: military_branches }
+  Military service age and obligation:  { name: military_age      }
+  Manpower available for military service:
+    males age 16-49:                    { name: military_manpower_males }
+    females age 16-49:                  { name: military_manpower_females }
+  Manpower fit for military service:
+    males age 16-49:                    { name: military_manpower_males_fit }
+    females age 16-49:                  { name: military_manpower_females_fit }
+  Manpower reaching militarily significant age annually:
+    male:                               { name: military_manpower_male_annual }
+    female:                             { name: military_manpower_female_annual }
+  Military expenditures:                { name: military_expenditures }
+
+Transnational Issues:
+  Disputes - international:             { name: disputes }
+  Refugees and internally displaced persons:
+    refugees (country of origin):       { name: refugees }
+    IDPs:                               { name: refugees_idps }            
+    stateless persons:                  { name: refugess_stateless }
+  Illicit drugs:                        { name: drugs }

data/data/categories.csv

@@ -1,4 +1,4 @@
-Num,Category,Name,Key
+Num,Category,Name,Notes
 ,Introduction,Background,
 ,Geography,Location,
 ,Geography,Geographic coordinates,

data/lib/factbook.rb

@@ -10,6 +10,7 @@ require 'pp'
 require 'json'
 require 'csv'
 require 'fileutils'
+require 'erb'     ## used by Almanac class (for render)
 
 
 ## 3rd party gems/libs
@@ -25,36 +26,50 @@ require 'active_record'     ## add activerecord/db support (NOT optional for now
 # our own code
 
 require 'factbook/version' # let it always go first
+
+
+require 'factbook/codes'
+require 'factbook/comparisons'
+require 'factbook/attributes'
+
+module Factbook
+  
+  ##  auto-load builtin codes, comparisons, attributes, etc.
+  CODES       = Codes.from_csv( "#{Factbook.root}/data/codes.csv" )
+  COMPARISONS = Comparisons.from_csv( "#{Factbook.root}/data/comparisons.csv" )
+  ATTRIBUTES  = Attributes.from_yaml( "#{Factbook.root}/data/attributes.yml" )
+
+  def self.codes()       CODES; end
+  def self.comparisons() COMPARISONS; end
+  def self.attributes()  ATTRIBUTES; end
+
+end # module Factbook
+
+## note: make codes, comparisons, attributes available
+
 require 'factbook/utils'
 require 'factbook/utils_info'
 require 'factbook/sanitizer'
+require 'factbook/normalize'
 require 'factbook/builder_item'
 require 'factbook/builder'
+require 'factbook/builder_json'
 require 'factbook/page'
+require 'factbook/page_info'
 require 'factbook/sect'
 require 'factbook/subsect'
 
-require 'factbook/codes'
-require 'factbook/comparisons'
+require 'factbook/reader_json'
+require 'factbook/almanac'
 
 require 'factbook/table'    ## e.g. TableReader
 
+require 'factbook/counter'
+
 require 'factbook/db/schema'   ## database (sql tables) support
 require 'factbook/db/models'
 require 'factbook/db/importer'
 
 
 
-module Factbook
-  
-  ##  auto-load builtin codes and comparisons
-  CODES       = Codes.from_csv( "#{Factbook.root}/data/codes.csv" )
-  COMPARISONS = Comparisons.from_csv( "#{Factbook.root}/data/comparisons.csv")
-
-  def self.codes()       CODES; end
-  def self.comparisons() COMPARISONS; end
-
-end # module Factbook
-
-
 puts Factbook.banner     if defined?($RUBYLIBS_DEBUG) && $RUBYLIBS_DEBUG