world-flags 0.3.2.2 → 0.3.4

data/Gemfile

@@ -1,5 +1,7 @@
 source :rubygems
 
+gem 'hashie'
+
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
 group :development do

data/Gemfile.lock

@@ -33,6 +33,7 @@ GEM
     diff-lcs (1.1.3)
     erubis (2.7.0)
     git (1.2.5)
+    hashie (1.2.0)
     hike (1.2.1)
     httparty (0.8.1)
       multi_json
@@ -106,6 +107,7 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (>= 1.0.0)
+  hashie
   httparty
   jeweler (>= 1.8.3)
   rails (>= 3.1)

data/README.md

@@ -80,30 +80,58 @@ Notice that it is a locale code pointing to a map of *ISO_3166-1_alpha-2* codes
 }
 ```
 
-An english translation file of country codes (in json format) can be found in `app/config/country_codes`.
+You can use [countries_and_languages](https://github.com/kristianmandrup/countries_and_languages) in order to generate the locale translation files needed for each locale. 
+
+## Locale mapping files
+
+The engine/gem includes English translation mapping files for countries and languages. They are not complete, so please edit them if you find errors or find your favorite country or language missing or misplaced somehow. 
+
+### Country mappings
+
+A country code to country name (in json format) can be found in `app/config/countries`. 
 
 ```ruby
-cc_file_en = File.join(Rails.root, 'app/config/country_codes/iso-3166-2.en.json')
-country_codes_en = JSON.parse File.read(cc_file_en)
-WorldFlags.languages = country_codes_en
+def countries locale = :en
+  path = File.join(Rails.root, "app/config/countries/locale_countries.#{locale}.json")
+  JSON.parse File.read(path)
+end
+
+WorldFlags.countries = countries(:en)
 ```
 
-Here an even better, more flexible approach that allows for multiple translations.
+### Languages mappings
 
+A country code to languages mappping file (also in json), can be found in `app/config/languages`.
+
+```ruby
+def languages locale = :en
+  path = File.join(Rails.root, "app/config/languages/locale_languages.#{locale}.json")
+  JSON.parse File.read(path)
+end
+
+WorldFlags.languages = languages(:en)
 ```
-WorldFlags::Language.en = country_codes_en
+
+Another approach more suited to adding single files is the following. Note that both `countrieds` and `languages` are instances of classes that inherit from the `Hashie::Mash` class (hash access via method missing).
+
+```
+WorldFlags.countries.en = countries_en
+WorldFlags.languages.en = languages_en
 ```
 
-If you use this approach, you must currently add a WorldFlags::Language class method for that locale (fx a method `#da`for danish) or fx use `attr_accessor :da`. For this approach, you must also set the active locales using `#active_locales`.
+You can set the active locales using:
 
 ```ruby
 WorldFlags.active_locales = [:en, :da]
-WorldFlags::Language.da = country_codes_da
 ```
 
-To customize the locale to flag code map, use:
+## Locale to country code
+
+You can  customize the locale to flag code map, using:
+
+`WorldFlags.locale_flag_map = some_hash`
 
-`WorldFlags.locale_flag_map = some hash`
+The gem also comes with a json file at `config/locale_map/locale_to_country_code.json` that you can load in as a hash. WorldFlags will treat any locale of the form `xx_YY` as the YY downcased (yy).
 
 Please feel free to suggest or improve this locale/translation infrastructure!
 
@@ -271,7 +299,7 @@ Example:
 
 ```ruby
 class MainController < ApplicationController
-	include WorldFlags::All
+	include WorldFlags::Helper::All
 
 	before_filter :set_locale	
 end

data/VERSION

@@ -1 +1 @@
-0.3.2.2
+0.3.4

data/config/languages/locale_languages.en.json

@@ -0,0 +1,253 @@
+{
+  "en": {
+    "ad": "Catalan",
+    "ae": "Arabic",
+    "af": "Afghan",
+    "ag": "Antigua and Barbuda",
+    "ai": "French",
+    "al": "Albanian",
+    "am": "Armenian",
+    "ao": "Portuguese",
+    "aq": "None",
+    "ar": "Spanish",
+    "as": "Samoan",
+    "at": "Austrian",
+    "au": "English",
+    "aw": "English",
+    "ax": "English",
+    "az": "Dutch",
+    "ba": "Azerbaijani",
+    "bb": ["Bosnian", "Serbian", "Croatian"],
+    "bd": "English",
+    "be": "Bengali",
+    "bf": ["Dutch", "French", "German"],
+    "bg": "French",
+    "bh": "Bulgarian",
+    "bi": "Arabic",
+    "bj": ["Kirundi", "French"],
+    "bl": "French",
+    "bm": "English",
+    "bn": "Malay",
+    "bo": "Spanish",
+    "bq": "Dutch",
+    "br": "Portuguese",
+    "bs": "English",
+    "bt": "Dzongkha",
+    "bv": "Norwegian",
+    "bw": ["English", "Setswana"],
+    "by": ["Belarusian", "Russian"],
+    "bz": "French",
+    "ca": "English",
+    "cc": "English",
+    "cd": "French",
+    "cf": "French",
+    "cg": "French",
+    "ch": ["German", "French", "Italian"],
+    "ci": "French",
+    "ck": "English",
+    "cl": "Spanish",
+    "cm": ["French", "English"],
+    "cn": "Chinese",
+    "co": "Spanish",
+    "cr": "Spanish",
+    "cu": "Spanish",
+    "cv": "Portuguese",
+    "cw": ["Papiamentu", "Dutch"],
+    "cx": "English",
+    "cy": ["Greek", "Turkish"]
+    "cz": "Czech",
+    "de": "German",
+    "dj": ["French", "Arabic"],
+    "dk": "Danish",
+    "dm": "Spanish",
+    "do": "Spanish",
+    "dz": "French",
+    "ec": "Spanish",
+    "ee": "Estonian",
+    "eg": "Arabic",
+    "eh": "Arabic",
+    "er": ["Arabic", "English"],
+    "es": "Spanish",
+    "et": "Amharic",
+    "fi": ["Finnish", "Swedish"],
+    "fj": "English",
+    "fk": "English",
+    "fm": "English",
+    "fo": ["Faroese", "Danish"],
+    "fr": "French",
+    "ga": "English",
+    "gb": "French",
+    "gd": "English",
+    "ge": "English",
+    "gf": "French",
+    "gg": "English",
+    "gh": "English",
+    "gi": "English",
+    "gl": "Danish",
+    "gm": "English",
+    "gn": "French",
+    "gp": "French",
+    "gq": "French",
+    "gr": "Greek",
+    "gs": "Georgian",
+    "gt": "Spanish",
+    "gu": "French",
+    "gw": "French",
+    "gy": "English",
+    "hk": ["English", "Chinese"],
+    "hm": "English",
+    "hn": "Spanish",
+    "hr": "Croatian",
+    "ht": "French",
+    "hu": "Hungarian",
+    "id": ["Indonesian","Vietnamese"],
+    "ie": "Irish",
+    "il": ["Hebrew", "Arabic"],
+    "im": "English",
+    "in": ["Hindi", "English"],
+    "io": "English",
+    "iq": ["Arabic", "Kurdish"],
+    "ir": "Persian",
+    "is": "Icelandic",
+    "it": "Italian",
+    "je": "English",
+    "jm": "English",
+    "jo": "Jordanian",
+    "jp": "Japanese",
+    "ke": "English",
+    "kg": ["Kyrgyz", "Russian"],
+    "kh": "French",
+    "ki": ["English", "Gilbertese"],
+    "km": ["Comorian", "Arabic", "French"],
+    "kn": "English",
+    "kp": "Korean",
+    "kr": "Korean",
+    "kw": "Arabic",
+    "ky": "English",
+    "kz": ["Kazakh", "Russian"],
+    "la": "Lao",
+    "lb": "Arabic",
+    "lc": "English",
+    "li": "German",
+    "lk": ["Sinhala", "Tamil"],
+    "lr": "English",
+    "ls": ["Sesotho", "English"],
+    "lt": "Lithuanian",
+    "lu": ["Luxembourgish", "French", "German"],
+    "lv": "Latvian",
+    "ly": "Arabic",
+    "ma": ["Arabic", "Berber"],
+    "mc": "French",
+    "md": "Romanian",
+    "me": ["Serbian", "Bosnian", "Albanian", "Croatian"],
+    "mf": "French",
+    "mg": "French",
+    "mh": "English",
+    "mk": "Macedonian",
+    "ml": "French",
+    "mm": "Burmese",
+    "mn": "Mongolian",
+    "mo": "French",
+    "mp": "English",
+    "mq": "French",
+    "mr": "English",
+    "ms": "French",
+    "mt": "French",
+    "mu": "English",
+    "mv": "Dhivehi",
+    "mw": ["Chichewa", "English"],
+    "mx": "Spanish",
+    "my": "Malaysian",
+    "mz": "French",
+    "na": "English",
+    "nc": "French",
+    "ne": "French",
+    "nf": "English",
+    "ng": "English",
+    "ni": "Spanish",
+    "nl": "Dutch",
+    "no": "Norwegian",
+    "np": "Nepalese",
+    "nr": ["English", "Nauruan"],
+    "nu": ["Niuean", "English"],
+    "nz": "English",
+    "om": "Arabic",
+    "pa": "Spanish",
+    "pe": "Spanish",
+    "pf": "French",
+    "pg": "English",
+    "ph": "Filipino",
+    "pk": "Arabic",
+    "pl": "Polish",
+    "pm": "French",
+    "pn": "English",
+    "pr": "Spanish",
+    "ps": ["Arabic", "Hebrew", "English"],
+    "pt": "Portuguese",
+    "pw": ["Palaun", "English"],
+    "py": "Spanish",
+    "qa": "Arabic",
+    "re": "French",
+    "ro": "Romanian",
+    "rs": "Serbian",
+    "ru": "Russian",
+    "rw": "French",
+    "sa": "Arabic",
+    "sb": "English",
+    "sc": ["French", "English"],
+    "sd": "Arabic",
+    "se": "Swedish",
+    "sg": ["English", "Malay", "Chinese"],
+    "sh": "Spanish",
+    "si": "Slovenian",
+    "sj": "Norwegian",
+    "sk": "Slovakian",
+    "sl": "French",
+    "sm": "Italian",
+    "sn": "Senegalese",
+    "so": ["Somali", "Arabic"],
+    "sr": "French",
+    "ss": "French",
+    "st": "French",
+    "sv": "Spanish",
+    "sx": "Dutch",
+    "sy": "Arabic",
+    "sz": ["Swati", "English"],
+    "tc": "English",
+    "td": "French",
+    "tf": "French",
+    "tg": "French",
+    "th": "Thai",
+    "tj": ["Tajik", "Russian"],
+    "tk": ["Tokelauan", "English"],
+    "tl": ["Tetum", "Portuguese"],
+    "tm": ["Turkmen", "Russian"],
+    "tn": "French",
+    "to": "French",
+    "tr": "Turkish",
+    "tt": "French",
+    "tv": ["Tuvaluan", "English"],
+    "tw": ["Chinese", "Taiwanese"],
+    "tz": ["Swahili", "English"],
+    "ua": ["Ukrainian", "Russian"],
+    "ug": ["Swahili", "English"],
+    "um": "English",
+    "us": "English",
+    "uy": "Spanish",
+    "uz": ["Uzbek", "Russian"],
+    "va": ["Latin", "Italian"],
+    "vc": "French",
+    "ve": "Spanish",
+    "vg": "English",
+    "vi": "English",
+    "vn": "Vietnamese",
+    "vu": ["Bislama", "English", "French"],
+    "wf": "French",
+    "ws": ["Samoan", "English"],
+    "ye": "Arabic",
+    "yt": "French",
+    "za": ["Afrikaans", "English", "Ndebele", "Sotho", "Swazi", "Tswana", "Tsonga", "Venda", "Xhosa", "Zulu"],
+    "zm": "English",
+    "zw": ["English", "Shona", "Sindebele"]
+  }
+}

data/config/locale_map/locale_to_country_code.json

@@ -0,0 +1,35 @@
+{
+  "af": "za",
+  "en": "us",
+  "da": "dk",
+  "sv": "se",
+  "sq": "al",
+  "nb": "no",
+  "ja": "jp",
+  "kk": "kz",
+  "ko": "kr",
+  "ky": "kg",
+  "hy": "am",
+  "ms": "bn",
+  "be": "by",
+  "bg": "bh",
+  "ca": "ad",
+  "zh": "cn",
+  "sr": "rs",
+  "sl": "si",
+  "et": "ee",
+  "sw": "tz",
+  "ta": "lk",
+  "ka": "gs",
+  "el": "gr",
+  "uk": "ua",
+  "he": "il",
+  "hi": "in",
+  "vi": "vn"
+}
+
+
+
+
+
+

data/lib/world-flags.rb

@@ -1,3 +1,4 @@
+require 'hashie'
 require "world_flags/core_ext"
 require "world_flags/helpers"
 
@@ -6,9 +7,13 @@ require 'world_flags/rails/engine' if defined?(::Rails::Engine)
 require "world_flags/languages"
 require "world_flags/countries"
 
+require "world_flags/lang_util"
+require "world_flags/country_util"
+
+
 module WorldFlags
 	class << self
-		attr_accessor :auto_select, :raise_error, :default_code
+		attr_accessor :auto_select, :raise_error, :default_code, :default_locale
 
 		# TODO: Why both active and valid locales? Does this even make sense!?
 		attr_writer :active_locales
@@ -32,6 +37,14 @@ module WorldFlags
 			@raise_error
 		end
 
+		def raise_error!
+			@raise_error = true
+		end
+
+		def raise_error_off!
+			@raise_error = false
+		end
+
 		def auto_select?
 			auto_select
 		end
@@ -40,117 +53,63 @@ module WorldFlags
 			@auto_select = true
 		end
 
-		def label code = :en, options = {:language => :en}			
-			label = options[:country] ? WorldFlags.country(options[:country], code) : WorldFlags.language(options[:language], code)
-			# if all else fails
-			default_locale = I18n.locale || :en
-			label ||= WorldFlags.language(default_locale, code)
+		def label code = :us, options = {:language => :en}
+			locale = extract_locale!(options) || default_locale_used || :en
+			options[:country] ? country_label(code, locale) : language_label(code, locale)
+		end
+
+		def extract_locale! options
+			options[:country] ? options.delete(:country) : options.delete(:language)
 		end
 
 		# Locale translation helper macros
 
-		def flag_code code = :en
-			locale_flag_map[code.to_sym] || code
+		def flag_code code = :us
+			# ensure that 'en_US' becomes simply 'us'
+			code = code.to_s.sub(/^\w+_/, '').downcase
+			(locale_flag_map[code.to_sym] || code).to_sym
 		end
 
-		def locale code = :en
+		def locale code = :us
 			flag_locale_map[code.to_sym] || code
 		end
 
 		attr_writer :locale_flag_map
 
-		# translate locales to flag code: ISO_3166-1_alpha-2
+		# override using fx 'locale_to_country_code.json' file
 		def locale_flag_map
-			@locale_map ||= {
-				:en => :us,
-				:da => :dk,
-				:sv => :se,
-				:nb => :no,
-				:'sv_SE' => :se,
-				:'en_UK' => :gb,
-				:'en_US' => :us
-			}
-		end
-
-		def flag_locale_map
-			locale_flag_map.hash_revert
-		end
-
-		def default_code_used
-			WorldFlags.default_code || :en
+			@locale_flag_map ||= keys_to_sym(locale_flag_hash) 
 		end
 
-		# Language helper macros
-
-		def language locale = :en, code = :en
-			locale ||= default_code_used
-			locale_languages_map = languages[locale] || languages[default_code_used]
-
-			raise "No language-locale map defined for locale: #{locale} in #{languages}" if locale_languages_map.blank?
-
-			# raise("No language map defined for language code: #{code} in #{locale_languages_map[code]}")			
-			locale_languages_map[code] ? locale_languages_map[code] : locale_languages_map[default_code_used] 
-		rescue Exception => e
-			raise e if WorldFlags.raise_error?
-			"Undefined"
-		end
-
-		def languages= languages
-			raise ArgumentError, "Must be a hash, was: #{languages}" unless languages.kind_of?(Hash)
-			@languages = languages
+		def keys_to_sym hash
+			hash.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}
 		end
 
-		def languages
-			@languages ||= begin 
-				active_locales.inject({}) do |res, loc|
-					res[locale] = find_language_map(loc)
-					res
-				end
-			end
-		end
+		def locale_flag_hash
+			{ 
+				:en => "us",
+  			:da => "dk",
+  			:sv => "se",
+  			:sq => "al",
+  			:nb => "no",
+  			:ja => "jp",
+  			:uk => "ua"
+  		}
+  	end		
 
-		def find_language_map loc
-			# return Countries.send(loc) if Countries.respond_to?(loc)
-			[loc, flag_code(loc), locale(loc)].each do |code|
-				return Languages.send(locale) if Languages.respond_to?(locale)
-			end
+		def flag_locale_map
+			locale_flag_map.hash_revert
 		end
 
-		# Country helper macros
-
-		def country locale = :en, code = :en
-			locale ||= default_code_used
-
-			locale_countries_map = countries[locale] || countries[default_code_used]
-
-			raise "No country-locale map defined for locale: #{locale} in #{countries}" if locale_countries_map.blank?
-
-			# raise("No country map defined for country code: #{code} in #{locale_countries_map[code]}")
-			locale_countries_map[code] ? locale_countries_map[code] : locale_countries_map[default_code_used] 
-		rescue Exception => e
-			raise e if WorldFlags.raise_error?
-			"Undefined"
+		def default_code_used
+			WorldFlags.default_code || :us
 		end
 
-		def countries= countries
-			raise ArgumentError, "Must be a hash, was: #{countries}" unless countries.kind_of?(Hash)
-			@countries = countries
+		def default_locale_used
+			WorldFlags.default_locale || I18n.locale
 		end
 
-		def countries
-			@countries ||= begin 
-				active_locales.inject({}) do |res, loc|
-					res[loc] = find_country_map(loc)
-					res
-				end
-			end
-		end		
-
-		def find_country_map loc
-			# return Countries.send(loc) if Countries.respond_to?(loc)
-			[loc, flag_code(loc), locale(loc)].each do |code|
-				return Countries.send(code) if Countries.respond_to?(code)
-			end
-		end
+		include WorldFlags::LangUtil
+		include WorldFlags::CountryUtil
 	end
 end