world-flags 0.2.7 → 0.3.0

data/README.md

@@ -27,6 +27,8 @@ $("li.flag['data-cc'=dk).addClass('semi');
 $("li.flag['data-cc'=dk).removeClass('semi');
 ```
 
+CSS configuration in `application.css` manifest.
+
 ```css
 */
  *= require_self
@@ -60,13 +62,16 @@ Alternatively for the 32 width flags
 
 ## 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.languages = 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.
+Notice that it is a locale code pointing to a map of *ISO_3166-1_alpha-2* codes to labels for that locale.
 
 ```ruby
 {
@@ -75,7 +80,7 @@ to labels for that locale.
 }
 ```
 
-An english translation file of country codes (in json format) can be found in app/config/country_codes.
+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')
@@ -91,11 +96,15 @@ WorldFlags::Language.en = country_codes_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`.
 
-```
+```ruby
 WorldFlags.active_locales = [:en, :da]
 WorldFlags::Language.da = country_codes_da
 ```
 
+To customize the locale to flag code map, use:
+
+`WorldFlags.locale_flag_map = some hash`
+
 Please feel free to suggest or improve this locale/translation infrastructure!
 
 ## Rendering
@@ -122,7 +131,7 @@ You can also use built in helper methods:
 
 ```haml
 = flag_list 16 do
-	= flags [:ar, :gb], :selected => :gb
+	= flags :ar, :gb, :selected => :gb
 ```
 
 Alternatively
@@ -139,11 +148,13 @@ Or using the #flag_code helper
 	= flag(:ar) + flag(:gb, :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)
+
 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
+	= flags :ar, :br, :gb, :title => true
 ```
 
 The flag_title will render the following list item:
@@ -163,16 +174,22 @@ The :title and :content can also be set to a string which is then displayed
 To also get content rendered for the <li>
 
 ```haml
-	= flags [:ar, :br, :gb], :content => true
+	= 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)
+
+## 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)
@@ -181,14 +198,14 @@ Use danish (da) country labels
 
 ```haml
 = flag_list 32 do
-	= flags [:ar, :br, :gb], :country => :da
+	= flags :ar, :br, :gb, :country => :da
 ```
 
 Use danish (da) language labels
 
 ```haml
 = flag_list 32 do
-	= flags [:ar, :br, :gb], :language => I18n.locale
+	= 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.

data/VERSION

@@ -1 +1 @@
-0.2.7
+0.3.0

data/lib/generators/world_flags/init_generator.rb

@@ -0,0 +1,14 @@
+module WorldFlags
+  module Generators
+    class InitGenerator < ::Rails::Generators::Base
+      desc "Creates world flags initializer"
+
+      source_root File.dirname(__FILE__) + '/templates'
+
+      def main_flow
+        template "world_flags.erb", "config/initializers/world_flags.rb"
+      end      
+    end
+  end
+end
+

data/lib/generators/world_flags/templates/world_flags.erb

@@ -0,0 +1,12 @@
+WorldFlags.auto_select! # = false to disable
+
+# cc_en = 'app/config/country_codes/iso-3166-2.en.json'
+# cc_path = File.join(Rails.root, cc_en)
+# country_codes_en = JSON.parse File.read(cc_path)
+
+# WorldFlags.languages = some_language_hash # fx loaded from a yaml file
+# WorldFlags.countries = some_country_hash # fx loaded from a yaml file
+
+# WorldFlags.active_locales = [:en, :da]
+
+# WorldFlags.locale_flag_map = some hash

data/lib/world-flags.rb

@@ -10,6 +10,14 @@ module WorldFlags
 	class << self
 		attr_accessor :auto_select
 
+		# TODO: Why both active and valid locales? Does this even make sense!?
+		attr_writer :active_locales
+
+		def active_locales
+			@active_locales ||= I18n.available_locales unless I18n.available_locales.blank?
+			@active_locales ||= [:en]
+		end
+
 		# for WorldFlags::Helper::Locale
     def valid_locales
       @valid_locales ||= ['en', 'de', 'es', 'ru']
@@ -45,11 +53,7 @@ module WorldFlags
 			flag_locale_map[code.to_sym] || code
 		end
 
-		attr_writer :locale_flag_map, :active_locales
-
-		def active_locales
-			@active_locales ||= [:en]
-		end
+		attr_writer :locale_flag_map
 
 		# translate locales to flag code: ISO_3166-1_alpha-2
 		def locale_flag_map

data/lib/world_flags/helper/view.rb

@@ -1,3 +1,5 @@
+require 'world_flags/helper/view/util'
+
 module WorldFlags
 	module Helper
 		module View
@@ -5,12 +7,6 @@ module WorldFlags
 				[16, 32, 64]
 			end
 
-			# define more mappings by setting WorldFlags.locale_flag_map to a Hash map
-			# http://en.wikipedia.org/wiki/ISO_639-1_language_matrix
-			def flag_code code
-				WorldFlags.flag_code code
-			end
-
 			def flags_list size = 16, &block
 				raise "Missing block" unless block_given?
 				unless WorldFlags::Helper::View.flag_sizes.include?(size.to_i)
@@ -24,57 +20,31 @@ module WorldFlags
 			# http://en.wikipedia.org/wiki/ISO_639-1_language_matrix
 
 			# should look up translation for each code
-			def flags flags_arr, options = {}
-				flags_arr.inject("") do |res, elem|
+			def flags *args
+				options = args.extract_options!
+				args.flatten!
+				args.inject("") do |res, elem|
 					case elem
-					when Array
-						code = elem.first
-						name = elem.last
 					when String, Symbol
 						code = elem
 						name = WorldFlags.label(code, options)
 					else
-						raise ArgumentError, "Bad argument: #{flags_arr}, must be Hash or Array"
+						raise ArgumentError, "Bad argument: #{args}, must be Array"
 					end				
 					res << flag(code, name, options)
 				end.html_safe
 			end
 
-			def flags_title flags_arr, options = {}
-				flags flags_arr, options.merge(:title => true)
+			def flags_title *args
+				options = args.extract_options!
+				flags args, options.merge(:title => true)
 			end
 
 			def flag code, name, options = {}
-				label = case options[:content]
-				when true 
-					name
-				when String
-					options[:content]
-				else
-					'&nbsp;'
-				end
-
-				title = case options[:title]
-				when true
-					name
-				when String
-					options[:title]
-				else
-					nil
-				end
-				locale = WorldFlags.locale(code)
-				extra_options = title ? {:title => title } : {}			
-				selected = flag_selected?(code, options) ? 'selected' : ''
-				content_tag :li,  label.html_safe, {:class => "flag #{code} #{selected}", :'data-country' => name, :'data-cc' => code, :'data-locale' => locale}.merge(options[:html] || {}).merge(extra_options)
-			end
-
-			def flag_selected? code, options = {}
-				code = code.to_sym
-				sel = options[:selected] || options[code]
-
-				auto_sel = flag_code(I18n.locale).to_sym if WorldFlags.auto_select?
+				label = WorldFlags::Helper::View::Util.label_for options
+				title = WorldFlags::Helper::View::Util.title_for name, options
 
-				selected ||= [sel, auto_sel].any?{|e| e == code }
+				content_tag :li,  label.html_safe, WorldFlags::Helper::View::Util.flag_options(code, title, name, options)
 			end
 
 			def flag_title code, name, options = {}

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

@@ -0,0 +1,56 @@
+module WorldFlags
+	module Helper
+		module View
+			module Util
+				def self.label_for options = {}
+					label = case options[:content]
+					when true 
+						name
+					when String
+						options[:content]
+					else
+						' '
+					end
+				end				
+
+				def self.title_for name, options = {}
+					case options[:title]
+					when true
+						name
+					when String
+						options[:title]
+					else
+						nil
+					end				
+				end
+
+				def self.flag_options code, title, name, options = {}
+					locale = WorldFlags.locale(code)
+					extra_options = title ? {:title => title } : {}			
+					selected = flag_selected?(code, options) ? ' selected' : ''
+
+					# add semi class if not selected
+					semi = (selected.blank? ? ' semi' : '') if options[:with_semi]
+
+					{:class => "flag #{code}#{selected}#{semi}", :'data-country' => name, :'data-cc' => code, :'data-locale' => locale}.merge(options[:html] || {}).merge(extra_options)
+				end
+
+				def self.flag_selected? code, options = {}
+					code = code.to_sym
+					sel = options[:selected] || options[code]
+
+					auto_sel = flag_code(I18n.locale).to_sym if WorldFlags.auto_select?
+					match_locales = [sel, auto_sel]
+
+					selected ||= match_locales.any?{|e| e == code }
+				end
+
+				# define more mappings by setting WorldFlags.locale_flag_map to a Hash map
+				# http://en.wikipedia.org/wiki/ISO_639-1_language_matrix
+				def self.flag_code code
+					WorldFlags.flag_code code
+				end				
+			end
+		end
+	end
+end

data/spec/world_flags/view_helper_spec.rb

@@ -4,6 +4,11 @@ describe WorldFlags::Helper::View do
   include ControllerTestHelpers,
           WorldFlags::Helper::View
 
+  before do
+    WorldFlags.auto_select!
+    I18n.locale = 'ar'
+  end
+
   it "should be empty, with an empty block" do
     output = flags_list do
     end
@@ -27,37 +32,30 @@ describe WorldFlags::Helper::View do
     output.should == "<ul class=\"f32\"></ul>"
   end
 
-  it "should list flags using Hash arg" do
-    output = flags_list 32 do
-    	flags :ar => 'Argentina', :gb => 'England', :dk => 'Denmark'
-    end
-    output.should == "<ul class=\"f32\"><li class=\"flag ar \" data-cc=\"ar\" data-country=\"Argentina\" data-locale=\"ar\">&nbsp;</li><li class=\"flag gb \" data-cc=\"gb\" data-country=\"England\" data-locale=\"en_UK\">&nbsp;</li><li class=\"flag dk \" data-cc=\"dk\" data-country=\"Denmark\" data-locale=\"da\">&nbsp;</li></ul>"
-  end
-
   it "should list flags using Array" do
     output = flags_list 32 do
       flags [:ar, :gb]
     end
-    output.should == "<ul class=\"f32\"><li class=\"flag ar \" data-cc=\"ar\" data-country=\"Argentinian Spanish\" data-locale=\"ar\">&nbsp;</li><li class=\"flag gb \" data-cc=\"gb\" data-country=\"British English\" data-locale=\"en_UK\">&nbsp;</li></ul>"
+    output.should == "<ul class=\"f32\"><li class=\"flag ar selected\" data-cc=\"ar\" data-country=\"Argentinian Spanish\" data-locale=\"ar\">&nbsp;</li><li class=\"flag gb\" data-cc=\"gb\" data-country=\"British English\" data-locale=\"en_UK\">&nbsp;</li></ul>"
   end
 
-  it "should list flags" do
-    output = flag_title :ar, 'Argentina'
-    output.should == "<li class=\"flag ar \" data-cc=\"ar\" data-country=\"Argentina\" data-locale=\"ar\" title=\"Argentina\">&nbsp;</li>"
-  end
-
-  it "should list flags" do
+  it "should list flags using args" do
     output = flags_list 32 do
-    	flags_title :ar => 'Argentina'
+      flags :ar, :gb
     end
-    output.should == "<ul class=\"f32\"><li class=\"flag ar \" data-cc=\"ar\" data-country=\"Argentina\" data-locale=\"ar\" title=\"Argentina\">&nbsp;</li></ul>"
+    output.should == "<ul class=\"f32\"><li class=\"flag ar selected\" data-cc=\"ar\" data-country=\"Argentinian Spanish\" data-locale=\"ar\">&nbsp;</li><li class=\"flag gb\" data-cc=\"gb\" data-country=\"British English\" data-locale=\"en_UK\">&nbsp;</li></ul>"
   end
 
-  it "should list flags combined" do
+  it "should list flags using args and :with_semi" do
     output = flags_list 32 do
-    	[flags(:ar => 'Argentina', :gb => 'England'), flag(:br, 'Brazil')].join.html_safe 
+      flags :ar, :gb, :with_semi => true
     end
-    output.should == "<ul class=\"f32\"><li class=\"flag ar \" data-cc=\"ar\" data-country=\"Argentina\" data-locale=\"ar\">&nbsp;</li><li class=\"flag gb \" data-cc=\"gb\" data-country=\"England\" data-locale=\"en_UK\">&nbsp;</li><li class=\"flag br \" data-cc=\"br\" data-country=\"Brazil\" data-locale=\"br\">&nbsp;</li></ul>"
+    output.should == "<ul class=\"f32\"><li class=\"flag ar selected\" data-cc=\"ar\" data-country=\"Argentinian Spanish\" data-locale=\"ar\">&nbsp;</li><li class=\"flag gb semi\" data-cc=\"gb\" data-country=\"British English\" data-locale=\"en_UK\">&nbsp;</li></ul>"
+  end
+
+  it "should list flags" do
+    output = flag_title :ar, 'Argentina'
+    output.should == "<li class=\"flag ar selected\" data-cc=\"ar\" data-country=\"Argentina\" data-locale=\"ar\" title=\"Argentina\">&nbsp;</li>"
   end
 end
 

data/world-flags.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "world-flags"
-  s.version = "0.2.7"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kristian Mandrup"]
-  s.date = "2012-04-26"
+  s.date = "2012-04-27"
   s.description = "Use world flag icons in your Rails app"
   s.email = "kmandrup@gmail.com"
   s.extra_rdoc_files = [
@@ -27,6 +27,8 @@ Gem::Specification.new do |s|
     "Rakefile",
     "VERSION",
     "app/config/country_codes/iso-3166-2.en.json",
+    "lib/generators/world_flags/init_generator.rb",
+    "lib/generators/world_flags/templates/world_flags.erb",
     "lib/world-flags.rb",
     "lib/world_flags/core_ext.rb",
     "lib/world_flags/countries.rb",
@@ -35,6 +37,7 @@ Gem::Specification.new do |s|
     "lib/world_flags/helper/geo.rb",
     "lib/world_flags/helper/locale.rb",
     "lib/world_flags/helper/view.rb",
+    "lib/world_flags/helper/view/util.rb",
     "lib/world_flags/helpers.rb",
     "lib/world_flags/languages.rb",
     "lib/world_flags/rails/engine.rb",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: world-flags
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-26 00:00:00.000000000 Z
+date: 2012-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -109,6 +109,8 @@ files:
 - Rakefile
 - VERSION
 - app/config/country_codes/iso-3166-2.en.json
+- lib/generators/world_flags/init_generator.rb
+- lib/generators/world_flags/templates/world_flags.erb
 - lib/world-flags.rb
 - lib/world_flags/core_ext.rb
 - lib/world_flags/countries.rb
@@ -117,6 +119,7 @@ files:
 - lib/world_flags/helper/geo.rb
 - lib/world_flags/helper/locale.rb
 - lib/world_flags/helper/view.rb
+- lib/world_flags/helper/view/util.rb
 - lib/world_flags/helpers.rb
 - lib/world_flags/languages.rb
 - lib/world_flags/rails/engine.rb
@@ -162,7 +165,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4369520111429852681
+      hash: -1830379886448737503
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: