world-flags 0.2.4 → 0.2.7

data/Gemfile

@@ -1,7 +1,5 @@
 source :rubygems
 
-gem 'httparty'
-
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
 group :development do
@@ -13,5 +11,6 @@ group :development do
 end
 
 group :test do
+	gem 'httparty'
 	gem 'rails', '>= 3.1'
 end

data/README.md

@@ -204,7 +204,7 @@ A small helper module is provided that can be inserted into a Controller or wher
 class MainController < ApplicationController
   def home
   	@json = Property.all.to_gmaps4rails
-    @country_code = WorldFlags::Geo.ip_country_code
+    @country_code = WorldFlags::Helper::Geo.ip_country_code
   end
 end
 ```
@@ -213,8 +213,8 @@ Alternatively you can include the modules directly into the controller:
 
 ```ruby
 class MainController < ApplicationController
-	include WorldFlags::Geo
-	include WorldFlags::Browser
+	include WorldFlags::Helper::Geo
+	include WorldFlags::Helper::Browser
 
   def home
   	@json = Property.all.to_gmaps4rails
@@ -224,17 +224,20 @@ class MainController < ApplicationController
 end
 ```
 
-If you include the `WorldFlags::Locale` module, you can simply do:
+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`.
-For each locale it will check if it is a vaild locale, using
-`WorldFlags::Locale#valid_locales`
 
-For convenience you can also include `WorldFlags::All` to include all these modules.
+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:
 
@@ -246,13 +249,25 @@ class MainController < ApplicationController
 end
 ```
 
-You must set up valid locales for use with WorldFlags in some initializer:
+You can configure valid locales for use with WorldFlags in an initializer, fx `initializers/locales.rb` :
 
 ```ruby
 # fx [:da, :en] or even ['da', 'en']
-WorldFlags::Locale.locales = my_valid_locales_list 
+WorldFlags.valid_locales = my_valid_locales_list 
 ```
 
+Note that if not set, this list is preconfigured to: `['en', 'de', 'es', 'ru']`
+
+Alternatively configure in your `application.rb` file:
+
+```ruby
+class Application < Rails::Application
+  # ...
+  config.i18n.available_locales = [:da, :sv, :no]
+``
+
+Note: This approach in turn works well with the `i18n-docs` gem ;)
+
 ## 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.
@@ -264,6 +279,8 @@ $("li.flag").click(function() {
 	// 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);
@@ -271,6 +288,23 @@ $("li.flag").click(function() {
 });
 ```
 
+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');
+});
+```
+
 ## Enjoy
 
 Copyright (2012) Kristian Mandrup

data/VERSION

@@ -1 +1 @@
-0.2.4
+0.2.7

data/lib/world-flags.rb

@@ -1,22 +1,25 @@
-require "world_flags/view_helper"
-require "world_flags/locale_helper"
+require "world_flags/core_ext"
+require "world_flags/helpers"
+
 require 'world_flags/rails/engine' if defined?(::Rails::Engine)
 
 require "world_flags/languages"
 require "world_flags/countries"
 
-class Hash
-  def hash_revert
-    r = Hash.new
-    each {|k,v| r[v] = k}
-    r
-  end
-end
-
 module WorldFlags
 	class << self
 		attr_accessor :auto_select
 
+		# for WorldFlags::Helper::Locale
+    def valid_locales
+      @valid_locales ||= ['en', 'de', 'es', 'ru']
+    end
+
+		def valid_locales= *list
+			raise ArgumentError, "Must be a list of locales, was #{list}" if list.empty?
+			@valid_locales ||= list.flatten
+		end
+
 		def auto_select?
 			auto_select
 		end

data/lib/world_flags/core_ext.rb

@@ -0,0 +1,22 @@
+class Hash
+  def hash_revert
+    r = Hash.new
+    each {|k,v| r[v] = k}
+    r
+  end
+end
+
+class Array
+  def downcase
+    self.map{|e| e.to_s.downcase}
+  end
+
+  def upcase
+    self.map{|e| e.to_s.upcase}
+  end
+
+  def select_first_in *list
+    list = list.flatten.compact   
+    self.each {|e| return e if list.include?(e) }
+  end
+end

data/lib/world_flags/helper/all.rb

@@ -0,0 +1,11 @@
+module WorldFlags
+	module Helper
+	  module All
+	  	def self.included(base)
+	  		[:Geo, :Browser, :Locale].each do |name|
+	  			base.send :include, "WorldFlags::Helper::#{name}".constantize
+	  		end
+	  	end
+	  end
+	end
+end

data/lib/world_flags/helper/browser.rb

@@ -0,0 +1,22 @@
+module WorldFlags
+  module Helper
+    module Browser
+      def self.browser_locale request
+        return @browser_locale if @browser_locale
+        if lang = request.env["HTTP_ACCEPT_LANGUAGE"]
+          lang = lang.split(",").map { |l|
+            l += ';q=1.0' unless l =~ /;q=\d+\.\d+$/
+            l.split(';q=')
+          }.first
+          @browser_locale = lang.first.split("-").first
+        else
+          @browser_locale = I18n.default_locale
+        end
+      end
+
+      def browser_locale
+        WorldFlags::Helper::Browser.browser_locale(request)
+      end
+    end
+  end
+end

data/lib/world_flags/helper/geo.rb

@@ -0,0 +1,19 @@
+module WorldFlags
+  module Helper
+  	module Geo
+      def self.ip_json
+        require "httparty"
+
+        HTTParty.get('http://freegeoip.net/json/')
+      end
+
+  		def self.ip_country_code
+      	@ip_country_code ||= ip_json.parsed_response['country_code']
+      end
+
+  		def ip_country_code
+      	WorldFlags::Helper::Geo.ip_country_code
+      end
+    end
+  end
+end

data/lib/world_flags/helper/locale.rb

@@ -0,0 +1,21 @@
+module WorldFlags
+  module Helper
+    module Locale
+      def set_locale    
+        I18n.locale = locales.select_first_in(valid_locales.downcase)
+      end  
+
+      def valid_locales
+        if I18n.respond_to?(:available_locales) && I18n.available_locales.present?
+          I18n.available_locales 
+        else
+          WorldFlags.valid_locales
+        end
+      end
+
+      def locales
+        [params[:locale], browser_locale, ip_country_code, I18n.default_locale].downcase
+      end
+    end
+  end
+end

data/lib/world_flags/helper/view.rb

@@ -0,0 +1,89 @@
+module WorldFlags
+	module Helper
+		module View
+			def self.flag_sizes
+				[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)
+					raise "Supported sizes are only #{WorldFlags::Helper::View.flag_sizes}" 
+				end
+				content = capture(&block)
+				content_tag :ul, content, :class => "f#{size}"
+			end
+			alias_method :flag_list, :flags_list
+
+			# 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|
+					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"
+					end				
+					res << flag(code, name, options)
+				end.html_safe
+			end
+
+			def flags_title flags_arr, options = {}
+				flags flags_arr, 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?
+
+				selected ||= [sel, auto_sel].any?{|e| e == code }
+			end
+
+			def flag_title code, name, options = {}
+				flag code, name, options.merge(:title => true)
+			end
+
+			def use_flags size = 16
+				stylesheet_link_tag "flags/flags#{size}"
+			end
+		end
+	end
+end

data/lib/world_flags/helpers.rb

@@ -0,0 +1,8 @@
+require 'world_flags/helper/view'
+
+# controller helpers
+require 'world_flags/helper/locale'
+require 'world_flags/helper/browser'
+require 'world_flags/helper/geo'
+require 'world_flags/helper/all'
+

data/lib/world_flags/rails/engine.rb

@@ -6,7 +6,7 @@ module WorldFlags
       end
 
     	def self.add_view_ext
-    		ActionView::Base.send :include, WorldFlags::ViewHelper
+    		ActionView::Base.send :include, WorldFlags::Helper::View
     	end
     end
   end

data/spec/world_flags/view_helper_spec.rb

@@ -1,8 +1,8 @@
 require 'spec_helper'
 
-describe WorldFlags::ViewHelper do
+describe WorldFlags::Helper::View do
   include ControllerTestHelpers,
-          WorldFlags::ViewHelper
+          WorldFlags::Helper::View
 
   it "should be empty, with an empty block" do
     output = flags_list do

data/vendor/assets/javascripts/world_flags/url_helper.js

@@ -0,0 +1,48 @@
+// Usage: 
+// WorldFlagsUrlHelper.reloadWithLocaleParam('da');
+
+var WorldFlagsUrlHelper = {
+  reloadWithLocaleParam: function(locale) {
+
+    // will reload page with 'locale' param added for locale
+    // fx www.example.com?locale=da
+    // or www.example.com?status=ok&locale=da
+    window.location.href = this.addLocaleParameter(window.location.href, locale);     
+  },
+
+  addLocaleParameter: function(url, locale) {
+    //return this.addParameterToURL(url, 'locale', locale);
+    return this.addUrlParameter(url, 'locale', locale, true);    
+  },
+
+  // From http://stackoverflow.com/questions/486896/adding-a-parameter-to-the-url-with-javascript
+  addUrlParameter: function (sourceUrl, parameterName, parameterValue, replaceDuplicates) {
+    if ((sourceUrl == null) || (sourceUrl.length == 0)) sourceUrl = document.location.href;
+    var urlParts = sourceUrl.split("?");
+    var newQueryString = "";
+    if (urlParts.length > 1)
+    {
+        var parameters = urlParts[1].split("&");
+        for (var i=0; (i < parameters.length); i++)
+        {
+                var parameterParts = parameters[i].split("=");
+                if (!(replaceDuplicates && parameterParts[0] == parameterName))
+                {
+                        if (newQueryString == "")
+                                newQueryString = "?";
+                        else
+                                newQueryString += "&";
+                        newQueryString += parameterParts[0] + "=" + parameterParts[1];
+                }
+        }
+    }
+    if (newQueryString == "")
+        newQueryString = "?";
+    else
+        newQueryString += "&";
+
+    newQueryString += parameterName + "=" + parameterValue;
+
+    return urlParts[0] + newQueryString;
+  }
+}

data/world-flags.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "world-flags"
-  s.version = "0.2.4"
+  s.version = "0.2.7"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kristian Mandrup"]
-  s.date = "2012-04-18"
+  s.date = "2012-04-26"
   s.description = "Use world flag icons in your Rails app"
   s.email = "kmandrup@gmail.com"
   s.extra_rdoc_files = [
@@ -28,11 +28,16 @@ Gem::Specification.new do |s|
     "VERSION",
     "app/config/country_codes/iso-3166-2.en.json",
     "lib/world-flags.rb",
+    "lib/world_flags/core_ext.rb",
     "lib/world_flags/countries.rb",
+    "lib/world_flags/helper/all.rb",
+    "lib/world_flags/helper/browser.rb",
+    "lib/world_flags/helper/geo.rb",
+    "lib/world_flags/helper/locale.rb",
+    "lib/world_flags/helper/view.rb",
+    "lib/world_flags/helpers.rb",
     "lib/world_flags/languages.rb",
-    "lib/world_flags/locale_helper.rb",
     "lib/world_flags/rails/engine.rb",
-    "lib/world_flags/view_helper.rb",
     "sandbox/country_codes_table.html",
     "sandbox/extract_codes.rb",
     "spec/spec_helper.rb",
@@ -46,6 +51,7 @@ Gem::Specification.new do |s|
     "vendor/assets/images/flags/flags32_semi.png",
     "vendor/assets/images/flags/flags64.png",
     "vendor/assets/images/flags/flags64_semi.png",
+    "vendor/assets/javascripts/world_flags/url_helper.js",
     "vendor/assets/stylesheets/flags/basic.css",
     "vendor/assets/stylesheets/flags/basic.scss.css",
     "vendor/assets/stylesheets/flags/flags16-semi.css.erb",
@@ -70,14 +76,12 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<httparty>, [">= 0"])
       s.add_development_dependency(%q<rspec>, [">= 2.8.0"])
       s.add_development_dependency(%q<rdoc>, [">= 3.12"])
       s.add_development_dependency(%q<bundler>, [">= 1.0.0"])
       s.add_development_dependency(%q<jeweler>, [">= 1.8.3"])
       s.add_development_dependency(%q<simplecov>, [">= 0.5"])
     else
-      s.add_dependency(%q<httparty>, [">= 0"])
       s.add_dependency(%q<rspec>, [">= 2.8.0"])
       s.add_dependency(%q<rdoc>, [">= 3.12"])
       s.add_dependency(%q<bundler>, [">= 1.0.0"])
@@ -85,7 +89,6 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<simplecov>, [">= 0.5"])
     end
   else
-    s.add_dependency(%q<httparty>, [">= 0"])
     s.add_dependency(%q<rspec>, [">= 2.8.0"])
     s.add_dependency(%q<rdoc>, [">= 3.12"])
     s.add_dependency(%q<bundler>, [">= 1.0.0"])

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: world-flags
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,24 +9,8 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-18 00:00:00.000000000 Z
+date: 2012-04-26 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: httparty
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -126,11 +110,16 @@ files:
 - VERSION
 - app/config/country_codes/iso-3166-2.en.json
 - lib/world-flags.rb
+- lib/world_flags/core_ext.rb
 - lib/world_flags/countries.rb
+- lib/world_flags/helper/all.rb
+- lib/world_flags/helper/browser.rb
+- lib/world_flags/helper/geo.rb
+- lib/world_flags/helper/locale.rb
+- lib/world_flags/helper/view.rb
+- lib/world_flags/helpers.rb
 - lib/world_flags/languages.rb
-- lib/world_flags/locale_helper.rb
 - lib/world_flags/rails/engine.rb
-- lib/world_flags/view_helper.rb
 - sandbox/country_codes_table.html
 - sandbox/extract_codes.rb
 - spec/spec_helper.rb
@@ -144,6 +133,7 @@ files:
 - vendor/assets/images/flags/flags32_semi.png
 - vendor/assets/images/flags/flags64.png
 - vendor/assets/images/flags/flags64_semi.png
+- vendor/assets/javascripts/world_flags/url_helper.js
 - vendor/assets/stylesheets/flags/basic.css
 - vendor/assets/stylesheets/flags/basic.scss.css
 - vendor/assets/stylesheets/flags/flags16-semi.css.erb
@@ -172,7 +162,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4001890539095180022
+      hash: -4369520111429852681
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:

data/lib/world_flags/locale_helper.rb

@@ -1,77 +0,0 @@
-require "httparty"
-
-class Array
-  def downcase
-    self.map{|e| e.to_s.downcase}
-  end
-
-  def upcase
-    self.map{|e| e.to_s.upcase}
-  end
-
-  def select_first_in *list
-    list = list.flatten.compact   
-    self.each {|e| return e if list.include?(e) }
-  end
-end
-
-module WorldFlags
-	module Geo
-    def self.ip_json
-      HTTParty.get('http://freegeoip.net/json/')
-    end
-
-		def self.ip_country_code
-    	@ip_country_code ||= ip_json.parsed_response['country_code']
-    end
-
-		def ip_country_code
-    	WorldFlags::Geo.ip_country_code
-    end
-  end
-
-  module Locale
-    def set_locale    
-      I18n.locale = locales.select_first_in(valid_locales.downcase)
-    end  
-
-    class << self
-      attr_writer :valid_locales
-
-      def valid_locales
-        @valid_locales ||= ['en', 'de', 'es', 'ru']
-      end
-    end
-
-    def locales
-      [params[:locale], browser_locale, ip_country_code, I18n.default_locale].downcase
-    end    
-  end
-
-  module Browser
-		def self.browser_locale request
-			return @browser_locale if @browser_locale
-      if lang = request.env["HTTP_ACCEPT_LANGUAGE"]
-        lang = lang.split(",").map { |l|
-          l += ';q=1.0' unless l =~ /;q=\d+\.\d+$/
-          l.split(';q=')
-        }.first
-        @browser_locale = lang.first.split("-").first
-      else
-        @browser_locale = I18n.default_locale
-      end
-   	end
-
-   	def browser_locale
-   		WorldFlags::Browser.browser_locale(request)
-   	end
-  end
-
-  module All
-  	def self.included(base)
-  		base.send :include, Geo
-  		base.send :include, Browser
-      base.send :include, Locale
-  	end
-  end
-end

data/lib/world_flags/view_helper.rb

@@ -1,81 +0,0 @@
-module WorldFlags
-	module ViewHelper
-		def self.flag_sizes
-			[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?
-			raise "Supported sizes are only #{WorldFlags::ViewHelper.flag_sizes}" unless WorldFlags::ViewHelper.flag_sizes.include?(size.to_i)
-			content = capture(&block)
-			content_tag :ul, content, :class => "f#{size}"
-		end
-		alias_method :flag_list, :flags_list
-
-		# 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|
-				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"
-				end				
-				res << flag(code, name, options)
-			end.html_safe
-		end
-
-		def flags_title flags_arr, options = {}
-			flags flags_arr, 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 = {}
-			selected = options[:selected] || options[code.to_sym]
-			selected ||= (flag_code(I18n.locale.to_sym) == code.to_sym) if WorldFlags.auto_select?
-		end
-
-		def flag_title code, name, options = {}
-			flag code, name, options.merge(:title => true)
-		end
-
-		def use_flags size = 16
-			stylesheet_link_tag "flags/flags#{size}"
-		end
-	end
-end