world-flags 0.4.2 → 0.4.3

data/README.md

@@ -22,123 +22,6 @@ There is also support for semi-transparent flags. This can be used to fade certa
 
 Simply add or remove the "semi" class for the flag to adjust the brightness level (fx for selection/mouse over).
 
-```javascript
-$("li.flag['data-cc'=dk).addClass('semi');
-$("li.flag['data-cc'=dk).removeClass('semi');
-```
-
-CSS configuration in `application.css` manifest.
-
-```css
-*/
- *= require_self
- *= require_tree .
- *= require flags/flags32
- *= require flags/flags62
-*/
-```
-
-## Alternative config
-
-Note that the ruby examples uses HAML syntax
-
-In the head of your view or layout file:
-
-```haml
-= stylesheet_link_tag 'flags16'
-```
-
-or using a helper
-
-```haml
-= use_flags(16)
-```
-
-Alternatively for the 32 width flags
-
-```haml
-= use_flags 32
-```
-
-## Configuring localization
-
-You can run the Rails generator `world_flags:init` in order to create a basic initializer file for world flags with an overview of the different options available.
-
-You can setup WorldFlags to use a localization map for the labels of the flag icons
-
-```ruby
-WorldFlags.language_map = some_language_hash # fx loaded from a yaml file
-WorldFlags.countries = some_country_hash # fx loaded from a yaml file
-```
-
-Notice that it is a locale code pointing to a map of *ISO_3166-1_alpha-2* codes to labels for that locale.
-
-```ruby
-{
-	:en => {:gb => 'English', :dk => 'Danish'}
-	:da => {:gb => 'Engelsk', :dk => 'Dansk'}
-}
-```
-
-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
-def countries locale = :en
-  path = File.join(Rails.root, "app/config/countries/locale_countries.#{locale}.json")
-  JSON.parse File.read(path)
-end
-
-WorldFlags.countries = Hashie::Mash.new countries
-```
-
-PS: See the json specs for examples.
-
-### 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 = Hashie::Mash.new languages
-```
-
-PS: See the json specs for examples.
-
-Another approach more suited to adding single files is the following. Note that both `countries` 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
-```
-
-You can set the available locales. By default they are the same as `I18n.available_locales`.
-
-```ruby
-WorldFlags.available_locales = [:en, :da]
-```
-
-## Locale to country code
-
-You can  customize the locale to flag code map, using:
-
-`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!
-
 ## Rendering
 
 Flags will be rendered in HTML as:
@@ -200,10 +83,10 @@ Note: The `  is needed in order for the background (flag icon) to have some
 The :title and :content can also be set to a string which is then displayed
 
 ```haml
-= flag :ar, :title => 'Argentina is the best', :content => 'Argh!'
+= flag :ar, :title => 'Argentina country', :content => 'Argh!'
 ```
 
-To also get content rendered for the <li>
+To get content rendered for the <li>
 
 ```haml
 	= flags :ar, :br, :gb, :content => true
@@ -211,17 +94,6 @@ To also get content rendered for the <li>
 
 Note: There is also a #flag_selected? helper, which is (and/or can be) used to determine if the flag to be drawn should have the "selected" class set)
 
-## Automatic flag selection
-
-The auto-select feature is by default turned off, but can be turned on/off using:
-
-```ruby
-WorldFlags.auto_select = true # or WorldFlags.auto_select!
-```
-
-With this feature turned on, WorlfFlags will attempt to set the `selected` CSS class on whatever flag drawn that matches the current `I18n.locale`code.
-If this doesn't work out for you, try to add a WorldFlags flag-to-locale code mapping for the locale.
-
 ## Using localization
 
 You can specify whether to look up labels for the flags for either language or country and for which locale to look up the labels (see Configuring localization)
@@ -233,129 +105,26 @@ Use danish (da) country labels
 	= flags :ar, :br, :gb, :country => :da
 ```
 
-Use danish (da) language labels
+Use language labels for current locale
 
 ```haml
 = flag_list 32 do
 	= flags :ar, :br, :gb, :language => I18n.locale
 ```
 
-Note: In the config folder there is now a json file with all the english ISO-3166-2 code translations ready for use. You can make similar locale files for other locales/languages.
-
-h## Get client country code (browser and geo)
-
-A small helper module is provided that can be inserted into a Controller or wherever you see fit
-
-* ip_country_code
-* browser_locale
-
-```ruby
-class MainController < ApplicationController
-  def home
-    @country_code = WorldFlags::Helper::Geo.ip_country_code
-  end
-end
-```
-
-Alternatively you can include the modules directly into the controller:
-
-```ruby
-class MainController < ApplicationController
-	include WorldFlags::Helper::Geo
-	include WorldFlags::Helper::Browser
-
-  def home
-    @country_code = ip_country_code
-    @locale = browser_locale
-  end
-end
-```
-
-If you include the `WorldFlags::Helper::Locale` module, you can simply do:
-
-```ruby
-before_filter :set_locale
-```
-
-And it should set the I18n.locale appropriately, trying `params[locale], browser, ip address` in succession, defaulting to `I18n.default_locale`.
+In the /config folder of this gem/engine there is a json file with all the english _ISO-3166-2_ code translations ready for use. You can make similar locale files for other locales/languages. You can use either of the following:
 
+* [countries_and_languages](https://github.com/grosser/countries_and_languages)
+* [i18n data](https://github.com/grosser/i18n_data)
+* [i18n gen](https://github.com/kristianmandrup/i18n-gen)
 
-Under the covers, the `set_locale` filter uses the `locale_sources`method to get the locale:
+To generate i18n data for your particular locale(s).
 
-```ruby
-def locale_sources
-  [params[:locale], extract_locale_from_tld, 
-  browser_locale, ip_country_code, I18n.default_locale]
-end
-```
-
-Note: You can override this method in your controller to set the priority order for getting the user locale. Each code will be mapped to a locale code using the `WorldFlags#locale` mapping helper method.
-
-For each locale it will check if it is a valid locale. By default it will call `valid_locales` in the controller, which will first try `I18n.available_locales` and then fall-back to `WorldFlags#valid_locales`.
-You can override this behavior by defining you custom `valid_locales` method in the controller.
-
-For convenience you can include `WorldFlags::Helper::All` to include all these helper modules.
-
-Note that if you include the `WorldFlags::Helper::Geo you need the `httparty` gem as well.
-
-Example:
-
-```ruby
-class MainController < ApplicationController
-	include WorldFlags::Helper::All
-
-	before_filter :set_locale	
-end
-```
-
-You can define the available locales for your app in your `application.rb` file:
-
-```ruby
-class Application < Rails::Application
-  # ...
-  config.i18n.available_locales = [:da, :sv, :no]
-``
-
-The perhaps sync i18n `I18n.available_locales = MyCool::Application.i18n.available_locales`
-
-Note: This approach in turn works well with the `i18n-docs` gem ;)
+## More configuration/usage tips
 
-## Post flag selection
+[Handling flag selection](https://github.com/kristianmandrup/world-flags/wiki/Handling-flag-selection)
 
-Here an example of setting up a flag click handler in order to call the server with the country/locale/language selection of the flag.
-
-```javascript
-$("li.flag").click(function() {
-	country = $(this).data('locale');
-
-	// full page reload
-	// window.location.href = "/locale/select/" + country;
-
-	// window.location.href = window.location.href + '?locale=' + country;
-
-	// async post
-	$.post("/locale/select", { "country": country }, function(data) {
-		console.log(data);
-	});	
-});
-```
-
-This gem now comes with a simple javascript object `WorldFlagsUrlHelper` baked in. To use it, add the following to your ``application.js manifest.
-
-```
-//= require world_flags/url_helper
-```
-
-And use it something like this:
-
-```javascript
-$("li.flag").click(function() {
-	country = $(this).data('locale');
-
-	// full page reload with locale=xx param added to url :)
-	WorldFlagsUrlHelper.reloadWithLocaleParam('da');
-});
-```
+[Configuration](https://github.com/kristianmandrup/world-flags/wiki/Configuration)
 
 ## TODO for version 1.0
 

data/VERSION

@@ -1 +1 @@
-0.4.2
+0.4.3

data/lib/world-flags.rb

@@ -29,7 +29,22 @@ module WorldFlags
 		def locale code = :us
 			flag_locale_map[code.to_sym] || code
 		end
-		
+
+		# avoid uk being translated to ukraine for domain names!		
+		def domain_to_locale code
+			domain_locale_map[code.to_sym] || flag_locale_map[code.to_sym] || code
+		end
+
+		def domain_locale_map
+			{ 
+				:uk => "en_GB",
+				:tp => "tl",
+				:su => 'ru',
+				:an => 'nl'
+  		}
+  	end
+
+
 		# override using fx 'locale_to_country_code.json' file
 		def locale_flag_map
 			@locale_flag_map ||= keys_to_sym(locale_flag_hash) 

data/lib/world_flags/countries.rb

@@ -1,5 +1,5 @@
 module WorldFlags
-	class Countries < Hashie::Mash
+	class Countries
 		def en
 			{
 				:ar => 'Argentina',

data/lib/world_flags/helper/locale.rb

@@ -6,10 +6,11 @@ module WorldFlags
       end  
 
       def valid_locales
+        return WorldFlags.available_locales if WorldFlags.available_locales.present?
         if I18n.respond_to?(:available_locales) && I18n.available_locales.present?
           I18n.available_locales
         else
-          WorldFlags.valid_locales
+          raise "You must define a list of available locales for use with WorldFlags either in WorldFlags.available_locales or I18n.available_locales"
         end
       end
 
@@ -19,7 +20,29 @@ module WorldFlags
       end
 
       def locale_sources
-        [params[:locale], extract_locale_from_tld, browser_locale, ip_country_code, I18n.default_locale]
+        locale_source_priority.inject([]) do |res, name|
+          res << locale_priority(name)
+          res
+        end
+      end
+
+      def locale_priority name
+        case name.to_sym
+        when :param
+          params[:locale]
+        when :domain
+          extract_locale_from_tld # http://en.wikipedia.org/wiki/List_of_Internet_top-level_domains
+        when :browser
+          browser_locale # http://www.metamodpro.com/browser-language-codes
+        when :ip
+          ip_country_code
+        when :default
+          I18n.default_locale
+        end
+      end
+
+      def locale_source_priority
+        WorldFlags.locale_source_priority
       end
  
       # Get locale from top-level domain or return nil if such locale is not available
@@ -33,7 +56,7 @@ module WorldFlags
       end      
 
       def parsed_locale
-        WorldFlags.locale(parsed_domain)
+        WorldFlags.domain_to_locale(parsed_domain)
       end
 
       def parsed_domain

data/lib/world_flags/languages.rb

@@ -1,5 +1,5 @@
 module WorldFlags
-	class Languages < Hashie::Mash
+	class Languages
 		def en
 			{
 				:ar => 'Spanish',

data/lib/world_flags/util/config.rb

@@ -3,15 +3,30 @@ module WorldFlags
     module Config
       attr_accessor :auto_select, :raise_error
       attr_accessor :default_code, :default_locale
+      attr_writer   :locale_source_priority
+
+      def locale_source_priority
+        @locale_source_priority ||= default_locale_source_priority
+      end
+
+      def default_locale_source_priority
+        supported_locale_source_priorities
+      end
+
+      def supported_locale_source_priorities
+        [:param, :domain, :browser, :ip, :default]
+      end
 
       def reset!
         raise_error_off!
         auto_select_off!
 
         self.countries = nil
+        self.hashied_countries = nil
         self.countries_map = nil
 
         self.languages_map = nil
+        self.hashied_languages = nil
         self.languages = nil
       end
 

data/lib/world_flags/util/country.rb

@@ -1,16 +1,12 @@
 module WorldFlags
   module Util
     module Country
-      attr_writer :countries_map
+      attr_writer :countries_map, :hashied_countries
       
       def country_label code, locale
         WorldFlags.country code, locale
       end
 
-      def countries
-        @countries ||= Countries.new
-      end
-
       def country code = :us, locale = :en
         locale ||= default_locale_used
         locale = WorldFlags.locale(locale).to_sym
@@ -32,6 +28,10 @@ module WorldFlags
         @countries = countries
       end
 
+      def countries
+        @countries ||= Countries.new
+      end
+
       def countries_map
         @countries_map ||= begin 
           available_locales.inject({}) do |res, loc|
@@ -41,10 +41,21 @@ module WorldFlags
         end
       end   
 
-      def find_country_map loc
-        countries.respond_to?(loc) ? countries.send(loc) : languages.send(locale(loc))
+      def hashied_countries
+        @hashied_countries ||= begin
+          case countries
+          when Hash
+            Hashie::Mash.new countries
+          else
+            countries
+          end
+        end
+      end
+
+      def find_country_map loc        
+        hashied_countries.respond_to?(loc) ? hashied_countries.send(loc) : hashied_countries.send(locale loc)
       rescue
-        countries.send(default_locale_used)
+        hashied_countries.send(default_locale_used)
       end
     end
   end

data/lib/world_flags/util/language.rb

@@ -1,7 +1,7 @@
 module WorldFlags
   module Util
     module Language
-      attr_writer :languages_map
+      attr_writer :languages_map, :hashied_languages
 
       def language_label code, locale
         language code, locale
@@ -50,10 +50,21 @@ module WorldFlags
         end
       end
 
+      def hashied_languages
+        @hashied_languages ||= begin
+          case languages
+          when Hash
+            Hashie::Mash.new languages
+          else
+            languages
+          end
+        end
+      end
+
       def find_language_map loc
-        languages.respond_to?(loc) ? languages.send(loc) : languages.send(locale(loc))
+        hashied_languages.respond_to?(loc) ? hashied_languages.send(loc) : hashied_languages.send(locale(loc))
       rescue
-        languages.send(default_locale_used)
+        hashied_languages.send(default_locale_used)
       end
     end
   end

data/spec/world_flags/json/json_countries_spec.rb

@@ -14,7 +14,7 @@ describe WorldFlags::Helper::View do
     I18n.locale = :en
     WorldFlags.available_locales = [:da, :sv, :nb, :en]
     WorldFlags.reset!
-    WorldFlags.countries = Hashie::Mash.new countries
+    WorldFlags.countries = countries
     WorldFlags.raise_error!
   end
 

data/spec/world_flags/json/json_languages_spec.rb

@@ -14,7 +14,7 @@ describe WorldFlags::Helper::View do
     I18n.locale = :en
     WorldFlags.available_locales = [:da, :sv, :nb, :en]
     WorldFlags.reset!
-    WorldFlags.languages = Hashie::Mash.new languages
+    WorldFlags.languages = languages
     WorldFlags.raise_error!
   end
 

data/world-flags.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "world-flags"
-  s.version = "0.4.2"
+  s.version = "0.4.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kristian Mandrup"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: world-flags
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.4.3
   prerelease: 
 platform: ruby
 authors:
@@ -194,7 +194,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3536745244245353850
+      hash: 4215201966939774215
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: