world-flags 0.2.3 → 0.2.4

data/{README.textile → README.md}

@@ -1,13 +1,12 @@
-h1. The flags of the world as a sprite for use with Rails 
+# Country or language selection with Flag icons
 
-Includes css files for size 16 and 32 pixels and have all the worlds' flags.
+This gem can be used with Rails 3. It includes css files for size 16 and 32 pixels and have all the worlds' flags. See http://spritegen.website-performance.org/
 
-See http://spritegen.website-performance.org/
+## Configuration
 
-h2. Configuration
-
-In you asset application.css manifest file:
+In you asset `application.css` manifest file:
 
+```css
 */
  *= require_self
  *= require_tree .
@@ -15,6 +14,7 @@ In you asset application.css manifest file:
  *= require flags/flags32
  *= require flags/flags32_semi
 */
+```
 
 The `flags/basic` stylesheet sets up a basic css for use with borders around the 32 and 64 pixel flag images (to mark selected language). Use this css as inspiration and customize by overriding styles as needed.
 
@@ -22,35 +22,43 @@ 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
 */
  *= require_self
  *= require_tree .
  *= require flags/flags32
  *= require flags/flags62
 */
+```
 
-
-h2. Alternative config
+## 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
+```
 
-h2. Configuring localization
+## Configuring localization
 
 You can setup WorldFlags to use a localization map for the labels of the flag icons
 
@@ -60,15 +68,41 @@ 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'}
 }
+```
+
+An english translation file of country codes (in json format) can be found in app/config/country_codes.
+
+```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
+```
+
+Here an even better, more flexible approach that allows for multiple translations.
+
+```
+WorldFlags::Language.en = country_codes_en
+```
 
-h2. Rendering
+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`.
+
+```
+WorldFlags.active_locales = [:en, :da]
+WorldFlags::Language.da = country_codes_da
+```
+
+Please feel free to suggest or improve this locale/translation infrastructure!
+
+## Rendering
 
 Flags will be rendered in HTML as:
 
+```html
 <pre>
 <ul class="f32">
   <li class="flag ar" data-cc="ar" data-country="Argentina">Argentina</li>
@@ -76,83 +110,108 @@ Flags will be rendered in HTML as:
 ...
 </ul>
 </pre>
+```
 
 The countries corresponding to the codes can be found at "http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2":http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
 
-h2. Use
+## Use
 
 WorldFlags supports flag sizes in 16, 32 and 64 pixels (size).
 
 You can also use built in helper methods:
 
+```haml
 = flag_list 16 do
 	= flags [:ar, :gb], :selected => :gb
+```
 
 Alternatively
 
+```haml
 = flag_list 32 do
-	= flag(:ar) + flag(:gb, :selected => true)
+	= flag(:ar)
+	= flag(:gb, :selected => true)
+```
 
 Or using the #flag_code helper
 
+```haml
 	= flag(:ar) + flag(:gb, :selected => flag_code(I18n.locale)
+```
 
 For use with tooltips or similar js plguins, it can be useful to set the <li> title attribute:
 
+```haml
 = flag_list 32 do
 	= flags [:ar, :br, :gb], :title => true
+```
 
 The flag_title will render the following list item:
 
+```html
 <li class="flag ar" lang="ar" title="Argentina">&nbsp;</li>
+```
 
 Note: The `&nbsp; is needed in order for the background (flag icon) to have something to be displayed against.
 
 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!'
+```
 
 To also get content rendered for the <li>
 
+```haml
 	= flags [:ar, :br, :gb], :content => true
+```
 
 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)
 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!
+```
 
-h2. Using localization
+## 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)
 
 Use danish (da) country labels
 
+```haml
 = flag_list 32 do
 	= flags [:ar, :br, :gb], :country => :da
+```
 
 Use danish (da) language labels
 
+```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.
 
-h2. Get client country code (browser and geo)
+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
   	@json = Property.all.to_gmaps4rails
     @country_code = WorldFlags::Geo.ip_country_code
   end
 end
+```
 
 Alternatively you can include the modules directly into the controller:
 
+```ruby
 class MainController < ApplicationController
 	include WorldFlags::Geo
 	include WorldFlags::Browser
@@ -163,34 +222,42 @@ class MainController < ApplicationController
     @locale = browser_locale
   end
 end
+```
 
-If you include the WorldFlags::Locale module, you can simply do:
+If you include the `WorldFlags::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.
+And it should set the I18n.locale appropriately, trying `params[locale], browser, ip address` in succession, defaulting to `I18n.default_locale`.
 For each locale it will check if it is a vaild locale, using
-WorldFlags::Locale#valid_locales
+`WorldFlags::Locale#valid_locales`
 
-For convenience you can also include WorldFlags::All to include all these modules.
+For convenience you can also include `WorldFlags::All` to include all these modules.
 
 Example:
 
+```ruby
 class MainController < ApplicationController
 	include WorldFlags::All
 
 	before_filter :set_locale	
 end
+```
 
 You must set up valid locales for use with WorldFlags in some initializer:
 
+```ruby
 # fx [:da, :en] or even ['da', 'en']
 WorldFlags::Locale.locales = my_valid_locales_list 
+```
 
-h2. Post flag selection
+## Post 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');
 
@@ -202,62 +269,9 @@ $("li.flag").click(function() {
 		console.log(data);
 	});	
 });
+```
 
-h2. Nice effects
-
-CSS config:
-
-ul.f32 {
-	list-style-type: none;
-	padding: 0;
-	margin-left: 0;
-
-	li.flag {
-		float:left;
-		padding-bottom: 6px;
-		padding-right: 26px;
-		margin-right: 8px;
-		background-position: center; 
-	}
-}
-
-#languages {
-	float: right;
-}
-
-p.clear { 
-	clear:both; 
-}
-
-.tooltip {
-  display:none;
-  background: white;
-  border: 1px solid black;
-  font-size:14px;
-  font-weight: bold;
-  text-align: center;
-  height:16px;
-  width:120px;
-  padding:10px;
-  color: black;
-}
-
-Tooltip script:
-
-http://jquerytools.org/demos/tooltip/index.html
-
-$("li.flag[title]").tooltip()
-
-Layout file:
-
-%body
-	.main
-		= link_to "Sign in", new_user_session_path
-		= link_to "Sign up", new_user_registration_path
+## Enjoy
 
-		#languages
-			= flag_list 64 do
-				= flags [:ar, :gb], :selected => WorldFlags.flag_code(@locale)
-		%p.clear
-		= yield
+Copyright (2012) Kristian Mandrup
 

data/VERSION

@@ -1 +1 @@
-0.2.3
+0.2.4

data/lib/world-flags.rb

@@ -42,7 +42,11 @@ module WorldFlags
 			flag_locale_map[code.to_sym] || code
 		end
 
-		attr_accessor :locale_flag_map
+		attr_writer :locale_flag_map, :active_locales
+
+		def active_locales
+			@active_locales ||= [:en]
+		end
 
 		# translate locales to flag code: ISO_3166-1_alpha-2
 		def locale_flag_map
@@ -71,7 +75,12 @@ module WorldFlags
 		end
 
 		def languages
-			@languages ||= {:en => Languages.en}
+			@languages ||= begin 
+				active_locales.inject({}) do |res, locale|
+					res[locale] = Languages.send(locale) if Languages.respond_to?(locale)
+					res
+				end
+			end
 		end
 
 		# Country helper macros

data/lib/world_flags/countries.rb

@@ -1,21 +1,25 @@
 module WorldFlags
 	module Countries
-		def self.en
-			{
-				:ar => 'Argentina',
-				:br => 'Brazil',
-				:gb => 'Great Britain',
-				:us => 'United States',				
-				:es => 'Spain',
-				:gr => 'Greece',
-				:it => 'Italy',
-				:nl => 'Netherlands',
-				:de => 'Germany',
-				:dk => 'Denmark',
-				:se => 'Sweden',
-				:no => 'Norway',
-				:fi => 'Finland'
-			}
+		class << self		
+ 			attr_writer :en
+
+			def en
+				{
+					:ar => 'Argentina',
+					:br => 'Brazil',
+					:gb => 'Great Britain',
+					:us => 'United States',				
+					:es => 'Spain',
+					:gr => 'Greece',
+					:it => 'Italy',
+					:nl => 'Netherlands',
+					:de => 'Germany',
+					:dk => 'Denmark',
+					:se => 'Sweden',
+					:no => 'Norway',
+					:fi => 'Finland'
+				}
+			end
 		end
 	end
 end

data/lib/world_flags/languages.rb

@@ -1,22 +1,26 @@
 module WorldFlags
 	module Languages
-		def self.en
-			{
-				:ar => 'Argentinian Spanish',
-				:br => 'Brazilian Portuguese',
-				:po => 'Portuguese',
-				:gr => 'Greek',
-				:gb => 'British English',
-				:us => 'US English',				
-				:es => 'Spanish',
-				:it => 'Italian',
-				:nl => 'Dutch',
-				:de => 'German',
-				:dk => 'Danish',
-				:se => 'Swedish',
-				:no => 'Norwegian',
-				:fi => 'Finnish'
-			}
+		class << self		
+ 			attr_writer :en
+
+			def en
+				@en ||= {
+					:ar => 'Argentinian Spanish',
+					:br => 'Brazilian Portuguese',
+					:po => 'Portuguese',
+					:gr => 'Greek',
+					:gb => 'British English',
+					:us => 'US English',				
+					:es => 'Spanish',
+					:it => 'Italian',
+					:nl => 'Dutch',
+					:de => 'German',
+					:dk => 'Danish',
+					:se => 'Swedish',
+					:no => 'Norwegian',
+					:fi => 'Finnish'
+				}
+			end
 		end
 	end
 end

data/world-flags.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "world-flags"
-  s.version = "0.2.3"
+  s.version = "0.2.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kristian Mandrup"]
@@ -14,7 +14,7 @@ Gem::Specification.new do |s|
   s.email = "kmandrup@gmail.com"
   s.extra_rdoc_files = [
     "LICENSE.txt",
-    "README.textile"
+    "README.md"
   ]
   s.files = [
     ".document",
@@ -23,10 +23,10 @@ Gem::Specification.new do |s|
     "Gemfile",
     "Gemfile.lock",
     "LICENSE.txt",
-    "README.textile",
+    "README.md",
     "Rakefile",
     "VERSION",
-    "config/country_codes/iso-3166-2.en.json",
+    "app/config/country_codes/iso-3166-2.en.json",
     "lib/world-flags.rb",
     "lib/world_flags/countries.rb",
     "lib/world_flags/languages.rb",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: world-flags
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
   prerelease: 
 platform: ruby
 authors:
@@ -113,7 +113,7 @@ executables: []
 extensions: []
 extra_rdoc_files:
 - LICENSE.txt
-- README.textile
+- README.md
 files:
 - .document
 - .rspec
@@ -121,10 +121,10 @@ files:
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
-- README.textile
+- README.md
 - Rakefile
 - VERSION
-- config/country_codes/iso-3166-2.en.json
+- app/config/country_codes/iso-3166-2.en.json
 - lib/world-flags.rb
 - lib/world_flags/countries.rb
 - lib/world_flags/languages.rb
@@ -172,7 +172,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4049711410867555584
+      hash: 4001890539095180022
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: