world-flags 0.5.1 → 0.6.0

data/README.md

@@ -80,14 +80,22 @@ Alternatively
 
 ```haml
 = flag_list 32 do
-	= flag(:ar)
-	= flag(:gb, :selected => true)
+	= flag(:ar, 'Argentina')
+	= flag(:gb, 'England', :selected => true)
+```
+
+Or using the locale mappings for the label...
+
+```haml
+= flag_list 32 do
+  = flag(:ar)
+  = flag(:gb, :selected => true)
 ```
 
 Or using the #flag_code helper
 
 ```haml
-	= flag(:ar) + flag(:gb, :selected => flag_code(I18n.locale)
+	= flag(:ar, 'Argentina') + flag(:gb, 'England', :selected => flag_code(I18n.locale)
 ```
 
 You can also include the :with_semi => true option in order to have flags not selected displayed with the 'semi' class (semi-bright image)
@@ -110,7 +118,13 @@ 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 country', :content => 'Argh!'
+= flag :ar, 'Argentina', :title => 'Argentina country', :content => 'Argh!'
+```
+
+or using the locale mapping...
+
+```haml
+= flag :ar, :title => 'Argentina country'
 ```
 
 To get content rendered for the <li>
@@ -121,6 +135,18 @@ To 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)
 
+## Customizing output
+
+You can customize the output by the flag view helper methods:
+
+```ruby
+WorldFlags.flag_list_tag = :div
+WorldFlags.flag_tag = :span
+WorldFlags.flag_text = ''
+```
+
+To do more customization, look at the `world_flags/helper/view/util.rb` file.
+
 ## 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)
@@ -132,10 +158,11 @@ Use danish (da) country labels
 	= flags :ar, :br, :gb, :country => :da
 ```
 
-Use language labels for current locale
+Use language labels for current locale.
+Note: Also use border class (see CSS below)
 
 ```haml
-= flag_list 32 do
+= flag_list 32, :class => 'border' do
 	= flags :ar, :br, :gb, :language => I18n.locale
 ```
 
@@ -194,10 +221,55 @@ when :ip
   country_code_from_ip browser_ip
 ```
 
+## CSS
+
+The `basic.css` file in the `vendor/assets/stylesheets/flags` folder of this repo defines the basic styling of flags. Override these styles to fit your needs.
+
+```ruby
+.flags {
+  list-style-type: none;
+  padding: 0;
+  margin-left: 0;  
+}
+
+.flags .l {
+  float: left;
+}
+
+.border .flag {
+  border: 1px solid;  
+}
+
+.border .flag.selected {
+  border: 1px solid black;
+}
+
+.f16.flag {
+  line-height: 16px;
+}
+
+.f24.flag {
+  line-height: 24px;
+}
+
+.f32.flag {
+  line-height: 32px; 
+}
+
+.f48.flag {
+  line-height: 48px; 
+}
+
+.f64.flag {
+  line-height: 64px; 
+}
+```
+
 ## TODO for version 1.0
 
 Suggestions welcome ;)
 
+
 ## Enjoy
 
 Copyright (2012) Kristian Mandrup

data/VERSION

@@ -1 +1 @@
-0.5.1
+0.6.0

data/lib/world-flags.rb

@@ -13,7 +13,21 @@ module WorldFlags
 		include Util
 
 		attr_writer :active_locales
-		attr_writer :locale_flag_map		
+		attr_writer :locale_flag_map
+
+		attr_writer :flag_tag, :flag_list_tag, :flag_text
+
+		def flag_text
+ 			@flag_text ||= '' #'  '
+ 		end
+
+		def flag_tag
+			@flag_tag ||= :li
+		end
+
+		def flag_list_tag
+			@flag_list_tag ||= :ul
+		end
 
 		def config &block
   		(block_given? && block.arity == 1) ? yield(self) : instance_eval(&block)

data/lib/world_flags/helper/view/util.rb

@@ -9,7 +9,7 @@ module WorldFlags
 					when String
 						options[:content]
 					else
-						' '
+						WorldFlags.flag_text
 					end
 				end				
 
@@ -34,10 +34,11 @@ module WorldFlags
 
 					# add semi class if not selected
 					semi = (selected.blank? ? ' semi' : '') if options[:with_semi]
+					xclass = options[:class] ? " #{options[:class]}" : ''
 
 					flag_locale = WorldFlags.locale(code)
 
-					{:class => "flag #{code}#{selected}#{semi}", :'data-country_name' => country_name, :'data-language_name' => language_name, :'data-cc' => code, :'data-locale' => flag_locale}.merge(options[:html] || {}).merge(extra_options)
+					{:class => "flag #{code}#{selected}#{semi}#{xclass}", :'data-country_name' => country_name, :'data-language_name' => language_name, :'data-cc' => code, :'data-locale' => flag_locale}.merge(options[:html] || {}).merge(extra_options)
 				end
 
 				def self.flag_selected? code, options = {}

data/lib/world_flags/helper/view.rb

@@ -7,13 +7,14 @@ module WorldFlags
 				[16, 24, 32, 48, 64]
 			end
 
-			def flags_list size = 24, &block
+			def flags_list size = 24, options = {}, &block
 				raise "Missing block" unless block_given?
 				unless WorldFlags::Helper::View.flag_sizes.include?(size.to_i)
 					raise "Supported sizes are only #{WorldFlags::Helper::View.flag_sizes}" 
 				end
 				content = capture(&block)
-				content_tag :ul, content, :class => "f#{size}"
+				xclass = options[:class] ? " #{options[:class]}" : ''
+				content_tag WorldFlags.flag_list_tag, content, :class => "f#{size} flags#{xclass}"
 			end
 			alias_method :flag_list, :flags_list
 
@@ -40,14 +41,20 @@ module WorldFlags
 				flags args, options.merge(:title => true)
 			end
 
-			def flag code, name, options = {}
+			def flag code, *args
+				options = args.extract_options!
+				name = args.first.kind_of?(String) ? args.first : WorldFlags.label(code, options)				
+
 				label = WorldFlags::Helper::View::Util.label_for options
 				title = WorldFlags::Helper::View::Util.title_for name, options
 
-				content_tag :li,  label.html_safe, WorldFlags::Helper::View::Util.flag_options(code, title, name, options)
+				content_tag WorldFlags.flag_tag,  label.html_safe, WorldFlags::Helper::View::Util.flag_options(code, title, name, options)
 			end
 
-			def flag_title code, name, options = {}
+			def flag_title code, *args
+				options = args.extract_options!
+				name = args.first.kind_of?(String) ? args.first : WorldFlags.label(code, options)				
+
 				flag code, name, options.merge(:title => true)
 			end
 

data/lib/world_flags/util/language.rb

@@ -14,7 +14,7 @@ module WorldFlags
         locale_languages_map = languages_map[locale] || languages_map[default_locale_used]
         locale_languages_map = languages_map[:en] if locale_languages_map.blank?
 
-        raise "No language-locale map defined for locale: #{locale} or :en in #{languages.inspect}" if locale_languages_map.blank?
+        raise "No language-locale map defined for locale: #{locale} or :en in #{locale_languages_map.inspect}" if locale_languages_map.blank?
 
         # raise("No language map defined for language code: #{code} in #{locale_languages_map[code]}")      
         code_language = locale_languages_map[code] ? locale_languages_map[code] : locale_languages_map[default_code_used]         

data/spec/world_flags/config_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe WorldFlags::Helper::View do
+  include ControllerTestHelpers,
+          WorldFlags::Helper::View
+
+  let(:default_size) { 24 }
+
+  before do
+    I18n.locale = 'ar'
+
+    WorldFlags.config do |c|
+      c.auto_select!    
+      c.available_locales = [:da, :sv, :nb, :en]
+      c.reset!
+      c.raise_error!
+    end
+  end
+
+  describe 'WorldFlags#locale' do
+    it 'should translate flag code to locale' do
+      WorldFlags.locale('dk').to_s.should == 'da'
+    end
+  end
+end

data/spec/world_flags/helper/util_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe WorldFlags::Helper::View do
+  include ControllerTestHelpers,
+          WorldFlags::Helper::View
+
+  let(:default_size) { 24 }
+
+  before do
+    I18n.locale = 'en'
+
+    WorldFlags.config do |c|
+      c.auto_select!    
+      c.available_locales = [:ar, :en]
+      c.reset!
+      c.raise_error!
+    end
+  end
+
+  describe 'customize flag tags and text' do
+    before do
+      WorldFlags.config do |c|
+        c.flag_list_tag = :div
+        c.flag_tag = :span
+        c.flag_text = ''
+      end
+    end
+
+    it "should list flags using customized tags and text" do
+      output = flags_list 32 do
+        flags [:ar]
+      end
+      output.should == "<div class=\"f32 flags\"><span class=\"flag ar\" data-cc=\"ar\" data-country_name=\"Argentina\" data-language_name=\"Spanish\" data-locale=\"ar\"></span></div>"
+    end
+  end
+end

data/spec/world_flags/helper/view_spec.rb

@@ -0,0 +1,122 @@
+require 'spec_helper'
+
+describe WorldFlags::Helper::View do
+  include ControllerTestHelpers,
+          WorldFlags::Helper::View
+
+  let(:default_size) { 24 }
+
+  before do
+    I18n.locale = 'ar'
+
+    WorldFlags.config do |c|
+      c.auto_select!    
+      c.available_locales = [:da, :sv, :nb, :en]
+      c.reset!
+      c.raise_error!
+    end
+  end
+
+  describe '#flags_list' do
+    it "should be empty, with an empty block" do
+      output = flags_list do
+      end
+      output.should == "<ul class=\"f#{default_size} flags\"></ul>"
+    end
+
+    it "should work with alias :flag_list" do
+      output = flag_list do
+      end
+      output.should == "<ul class=\"f#{default_size} flags\"></ul>"
+    end
+
+    it "should raise error when unsupported flag size" do
+      lambda do flags_list(8) { }    	
+      end.should raise_error
+    end
+
+    it "should set size to 16 or 32" do
+      output = flags_list 32 do
+      end
+      output.should == "<ul class=\"f32 flags\"></ul>"
+    end
+  end
+
+  describe '#flags' do
+    it "should list flags using Array" do
+      output = flags_list 32 do
+        flags [:ar, :gb]
+      end
+      output.should == "<ul class=\"f32 flags\"><li class=\"flag ar selected\" data-cc=\"ar\" data-country_name=\"Argentina\" data-language_name=\"Spanish\" data-locale=\"ar\"></li><li class=\"flag gb\" data-cc=\"gb\" data-country_name=\"United Kingdom\" data-language_name=\"British English\" data-locale=\"gb\"></li></ul>"
+    end
+
+    it "should list flags using args" do
+      output = flags_list 32 do
+        flags :ar, :gb
+      end
+      output.should == "<ul class=\"f32 flags\"><li class=\"flag ar selected\" data-cc=\"ar\" data-country_name=\"Argentina\" data-language_name=\"Spanish\" data-locale=\"ar\"></li><li class=\"flag gb\" data-cc=\"gb\" data-country_name=\"United Kingdom\" data-language_name=\"British English\" data-locale=\"gb\"></li></ul>"
+    end
+
+    it "should list flags using args and :with_semi" do
+      output = flags_list 32 do
+        flags :ar, :gb, :with_semi => true
+      end
+      output.should == "<ul class=\"f32 flags\"><li class=\"flag ar selected\" data-cc=\"ar\" data-country_name=\"Argentina\" data-language_name=\"Spanish\" data-locale=\"ar\"></li><li class=\"flag gb semi\" data-cc=\"gb\" data-country_name=\"United Kingdom\" data-language_name=\"British English\" data-locale=\"gb\"></li></ul>"
+    end
+  end
+
+  describe '#flag' do
+    it "should create a flag tag" do
+      output = flag :ar, 'Argentina'
+      output.should == "<li class=\"flag ar selected\" data-cc=\"ar\" data-country_name=\"Argentina\" data-language_name=\"Spanish\" data-locale=\"ar\"></li>"
+    end
+  end
+
+  describe '#flag_title' do
+    it "should list flags" do
+      output = flag_title :ar, 'Argentina'
+      output.should == "<li class=\"flag ar selected\" data-cc=\"ar\" data-country_name=\"Argentina\" data-language_name=\"Spanish\" data-locale=\"ar\" title=\"Argentina\"></li>"
+    end
+  end
+
+  describe 'Countries' do
+    context 'Danish locale' do
+      before do
+        I18n.locale = 'da'
+      end
+
+      it "should list nordic flags using args and :with_semi" do
+        output = flags_list 32 do
+          flags :dk, :se, :no, :with_semi => true, :country => :da
+        end
+        output.should == "<ul class=\"f32 flags\"><li class=\"flag dk selected\" data-cc=\"dk\" data-country_name=\"Danmark\" data-language_name=\"Dansk\" data-locale=\"da\"></li><li class=\"flag se semi\" data-cc=\"se\" data-country_name=\"Sverige\" data-language_name=\"Svensk\" data-locale=\"sv\"></li><li class=\"flag no semi\" data-cc=\"no\" data-country_name=\"Norge\" data-language_name=\"Norsk\" data-locale=\"nb\"></li></ul>"
+      end
+    end
+
+    context 'Swedish locale' do
+      before do
+        I18n.locale = 'sv'
+      end
+
+      it "should list nordic flags using args and :with_semi" do
+        output = flags_list 32 do
+          flags :dk, :se, :no, :with_semi => true, :country => :da
+        end
+        output.should == "<ul class=\"f32 flags\"><li class=\"flag dk semi\" data-cc=\"dk\" data-country_name=\"Danmark\" data-language_name=\"Dansk\" data-locale=\"da\"></li><li class=\"flag se selected\" data-cc=\"se\" data-country_name=\"Sverige\" data-language_name=\"Svenska\" data-locale=\"sv\"></li><li class=\"flag no semi\" data-cc=\"no\" data-country_name=\"Norge\" data-language_name=\"Norsk\" data-locale=\"nb\"></li></ul>"
+      end
+    end
+
+    context 'Norwegian locale' do
+      before do
+        I18n.locale = 'nb'
+      end
+
+      it "should list nordic flags using args and :with_semi" do
+        output = flags_list 32 do
+          flags :dk, :se, :no, :with_semi => true, :country => :da
+        end
+        output.should == "<ul class=\"f32 flags\"><li class=\"flag dk semi\" data-cc=\"dk\" data-country_name=\"Danmark\" data-language_name=\"Dansk\" data-locale=\"da\"></li><li class=\"flag se semi\" data-cc=\"se\" data-country_name=\"Sverige\" data-language_name=\"Svensk\" data-locale=\"sv\"></li><li class=\"flag no selected\" data-cc=\"no\" data-country_name=\"Norge\" data-language_name=\"Norsk\" data-locale=\"nb\"></li></ul>"
+      end
+    end
+  end  
+end

data/vendor/assets/stylesheets/flags/basic.css

@@ -1,32 +1,37 @@
-#languages {
-	float: right;
+.flags {
+  list-style-type: none;
+  padding: 0;
+  margin-left: 0;  
 }
 
-#languages ul {
-	list-style-type: none;
-	padding: 0;
-	margin-left: 0;
+.flags .l {
+  float: left;
 }
 
-#languages li.flag {
-	float:left;
-	border: 1px solid none;
+.border .flag {
+  border: 1px solid;  
 }
 
-#languages li.flag.selected {
-	float:left;
-	border: 1px solid black;
+.border .flag.selected {
+  border: 1px solid black;
 }
 
-#languages .f32 li.flag {
-	padding-bottom: 6px;
-	padding-right: 26px;
-	margin-right: 8px;			
+.f16.flag {
+  line-height: 16px;
 }
 
-#languages .f64 li.flag {
-	padding-top: 12px;
-	padding-bottom: 24px;
-	padding-right: 60px;
-	margin-right: 8px;
+.f24.flag {
+  line-height: 24px;
+}
+
+.f32.flag {
+  line-height: 32px; 
+}
+
+.f48.flag {
+  line-height: 48px; 
+}
+
+.f64.flag {
+  line-height: 64px; 
 }

data/vendor/assets/stylesheets/flags/basic.scss.css

@@ -1,32 +1,39 @@
-#languages {
-	float: right;
-
-	ul {
-		list-style-type: none;
-		padding: 0;
-		margin-left: 0;
-	}
-
-	li.flag {
-		float:left;
-		border: 1px solid none;
-	}
-
-	li.flag.selected {
-		float:left;
-		border: 1px solid black;
-	}
-
-	.f32 li.flag {
-			padding-bottom: 6px;
-			padding-right: 26px;
-			margin-right: 8px;			
-	}
-
-	.f64 li.flag {
-			padding-top: 12px;
-			padding-bottom: 24px;
-			padding-right: 60px;
-			margin-right: 8px;
-	}
+.flags {
+  list-style-type: none;
+  padding: 0;
+  margin-left: 0;
+
+	.l {
+  	float: left;
+	}  
+}
+
+.border {
+  .flag {
+    border: 1px solid black;
+  }
+
+  .flag.selected {
+    border: 1px solid black;
+  }
+}
+
+.f16.flag {
+  line-height: 16px;
+}
+
+.f24.flag {
+  line-height: 24px;
+}
+
+.f32.flag {
+  line-height: 32px; 
+}
+
+.f48.flag {
+  line-height: 48px; 
+}
+
+.f64.flag {
+  line-height: 64px; 
 }