localized_language_select 0.2.0

data/Gemfile

@@ -0,0 +1,15 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+gem "rails", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", ">= 2.3.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,90 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionmailer (3.0.3)
+      actionpack (= 3.0.3)
+      mail (~> 2.2.9)
+    actionpack (3.0.3)
+      activemodel (= 3.0.3)
+      activesupport (= 3.0.3)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.4)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.13)
+      rack-test (~> 0.5.6)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.3)
+      activesupport (= 3.0.3)
+      builder (~> 2.1.2)
+      i18n (~> 0.4)
+    activerecord (3.0.3)
+      activemodel (= 3.0.3)
+      activesupport (= 3.0.3)
+      arel (~> 2.0.2)
+      tzinfo (~> 0.3.23)
+    activeresource (3.0.3)
+      activemodel (= 3.0.3)
+      activesupport (= 3.0.3)
+    activesupport (3.0.3)
+    arel (2.0.6)
+    builder (2.1.2)
+    diff-lcs (1.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    git (1.2.5)
+    i18n (0.5.0)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    mail (2.2.14)
+      activesupport (>= 2.3.6)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.16)
+    polyglot (0.3.1)
+    rack (1.2.1)
+    rack-mount (0.6.13)
+      rack (>= 1.0.0)
+    rack-test (0.5.7)
+      rack (>= 1.0)
+    rails (3.0.3)
+      actionmailer (= 3.0.3)
+      actionpack (= 3.0.3)
+      activerecord (= 3.0.3)
+      activeresource (= 3.0.3)
+      activesupport (= 3.0.3)
+      bundler (~> 1.0)
+      railties (= 3.0.3)
+    railties (3.0.3)
+      actionpack (= 3.0.3)
+      activesupport (= 3.0.3)
+      rake (>= 0.8.7)
+      thor (~> 0.14.4)
+    rake (0.8.7)
+    rcov (0.9.9)
+    rspec (2.4.0)
+      rspec-core (~> 2.4.0)
+      rspec-expectations (~> 2.4.0)
+      rspec-mocks (~> 2.4.0)
+    rspec-core (2.4.0)
+    rspec-expectations (2.4.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.4.0)
+    thor (0.14.6)
+    treetop (1.4.9)
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.23)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.2)
+  rails (>= 2.3.5)
+  rcov
+  rspec (>= 2.3.0)

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 [name of plugin creator]
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.textile

@@ -0,0 +1,107 @@
+h1. LocalizedLanguageSelect
+
+Rails plugin to provide support for localized <tt><select></tt> menu with language names and for
+storing language information as language _code_ (eg. 'sv'), not _name_ (eg. 'Swedish'), in the database.
+
+Uses the Rails internationalization framework ("I18n":http://rails-i18n.org) for translating the names of languages.
+Requires Rails 2.2 (released November 21st, 2008) or later versions.
+
+Language names are loaded from hashes in plugin directory, according to <tt>I18n.locale</tt> value.
+
+You can easily translate language codes in your application like this:
+
+<pre>
+  <%= I18n.t @user.language, :scope => 'languages' %>  
+</pre>
+
+Comes with a Rake task <tt>rake import:language_select locale=de</tt> for importing language names
+from Unicode.org's CLDR repository (http://www.unicode.org/cldr/data/charts/summary/root.html)
+Don't forget to restart the application when you add new locale.
+
+The code borrows heavily from the LocalizedCountrySelect plugin.
+See "localized_country_select":http://github.com/karmi/localized_country_select
+
+h2. Install & Usage
+
+Install as plugin:
+
+<pre>$ rails plugin install https://github.com/kristianmandrup/localized_language_select.git</pre>  
+
+Install as gem:
+
+Insert in Gemfile
+
+<pre>gem 'localized_language_select'</pre>
+
+Then to instal it, run:
+
+<pre>$ bundle install</pre>  
+
+Then to install the locale files, run:
+
+<pre>$ rails g localized_language_select:locales</pre>  
+
+This will copy the locale files to your Rails config/locales dir. The files will be called 'language.en.yml' and so on...
+
+Note: you can specify which locales using the @--locales@ option, which takes a list of locales.
+
+<pre>$ rails g localized_language_select:locales --locales da en fr</pre>  
+
+h2. Usage example
+
+<pre>
+  <%= localized_language_select(:user, :language, [], :include_blank => 'Please choose...') %>  
+</pre>
+
+
+will become:
+
+<pre>
+  <select name="user[language]" id="user_language">
+  <option value="">Please choose...</option>
+  <option disabled="disabled" value="">-------------</option>
+  <option value="aa">Afar</option>
+  ...
+  <option value="zza">ZaZa</option>
+  </select>  
+</pre>
+    
+for the <tt>en</tt> locale.
+
+h2. Options
+
+@:exclude@ option
+
+<pre>
+  <%= localized_language_select(:user, :language, ['English'], :include_blank => 'Please choose...', :exclude => ['Afrikaans']) %>  
+</pre>
+
+@:only@ option
+
+<pre>
+  <%= localized_language_select(:user, :language, ['English'], :include_blank => 'Please choose...', :only => ['German', 'French']) %>  
+</pre>
+
+h2. Todo - Request
+
+Please add translations for your language!
+
+Would be nice to have at least: German, Spanish, Chinese, Japanese, Russian, Indian and Arabic (Persian?) in there as well...
+
+h2. Framework usage
+
+This plugin should also integrate nicely with various formbuilders, including Formtastic
+
+Formtastic example:
+
+<pre>
+<%= semantic_form_for @user do |form| %>  
+  ...
+  <%= form.input :lang, :as => :language, :priority_languages => ['English'], :include_blank => 'Please choose...', :only => ['German', 'French']) %>    
+  ...
+<% end %>  
+</pre>
+
+h2. Copyright
+
+Copyright (c) 2009 David Cato, released under the MIT license

data/Rakefile

@@ -0,0 +1,50 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "localized_language_select"
+  gem.homepage = "http://github.com/kristianmandrup/localized_language_select"
+  gem.license = "MIT"
+  gem.summary = %Q{Localized language select for Rails 2.3+}
+  gem.description = %Q{Localized language select for Rails 2.3+ with options to control languages to display}
+  gem.email = "kmandrup@gmail.com"
+  gem.authors = ["Kristian Mandrup"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+
+  gem.add_runtime_dependency 'rails', '>= 2.3.5'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "localized_language_select #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/init.rb

@@ -0,0 +1,5 @@
+# Require the plugin code
+require 'localized_language_select'
+
+# Load locales for languages from +locale+ directory into Rails
+I18n.load_path += Dir[ File.join(File.dirname(__FILE__), 'locale', '*.{rb,yml}') ]

data/install.rb

@@ -0,0 +1,4 @@
+# Show the README text file
+puts "\n\n"
+puts IO.read(File.join(File.dirname(__FILE__), 'README.textile'))
+puts "\n"

data/lib/generators/localized_language_select/locales/locales_generator.rb

@@ -0,0 +1,38 @@
+# require 'rails/generators/base'
+# require 'sugar-high/array'
+# require 'active_support/inflector'
+# require 'rails3_artifactor'
+# require 'logging_assist'
+
+module LocalizedLanguageSelect
+  module Generators
+    class LocaleGenerator < Rails::Generators::Base
+      desc "Copy locale files"
+
+      class_option :locales, :type => :array, :default => ['all'], :desc => 'locales to generate for'
+
+      source_root File.dirname(__FILE__)
+
+      def main_flow      
+        copy_locales
+      end
+  
+      protected
+
+      def supported_locales
+        [:en, :da]
+      end
+
+      def locales
+        return supported_locales if options[:locales].include? 'all'
+        options[:locales].map(&:to_sym) & supported_locales
+      end
+  
+      def copy_locales
+        locales.each do |locale|          
+          copy_file "../../../../locale/#{locale}.yml", "config/locales/languages.#{locale}.yml"
+        end
+      end
+    end
+  end
+end

data/lib/localized_language_select.rb

@@ -0,0 +1,117 @@
+# = LocalizedLanguageSelect
+# 
+# View helper for displaying select list with languages:
+# 
+#     localized_language_select(:user, :language)
+# 
+# Works just like the default Rails' +country_select+ plugin, but stores languages as
+# language *codes*, not *names*, in the database.
+# 
+# You can easily translate language codes in your application like this:
+#     <%= I18n.t @user.language, :scope => 'languages' %>
+# 
+# Uses the Rails internationalization framework (I18n) for translating the names of languages.
+# 
+# Use Rake task <tt>rake import:language_select 'de'</tt> for importing language names
+# from Unicode.org's CLDR repository (http://www.unicode.org/cldr/data/charts/summary/root.html)
+# 
+# The code borrows heavily from the LocalizedCountrySelect plugin.
+# See http://github.com/karmi/localized_country_select
+#
+
+require 'localized_language_select/i18n'
+
+module LocalizedLanguageSelect
+  class << self
+    # Returns array with codes and localized language names (according to <tt>I18n.locale</tt>)
+    # for <tt><option></tt> tags
+    def localized_languages_array options = {}
+      res = []
+      list = I18n.translate(:languages).each do |key, value| 
+        res << [value, key.to_s.upcase] if include_language?(key.to_s, options)
+      end
+      res.sort_by { |country| country.first.parameterize }
+    end
+    
+    def include_language?(key, options)                                           
+      if options[:only] 
+        return options[:only].include?(key)
+      end      
+      if options[:except] 
+        return !options[:except].include?(key)
+      end
+      true      
+    end      
+    
+    
+    # Return array with codes and localized language names for array of language codes passed as argument
+    # == Example
+    #   priority_languages_array([:de, :fr, :en])
+    #   # => [ ['German', 'de'], ['French', 'fr'], ['English', 'en'] ]
+    def priority_languages_array(language_codes=[])
+      languages = I18n.translate(:languages)
+      language_codes.map { |code| [languages[code], code.to_s.downcase] }
+    end
+  end
+end
+
+module ActionView
+  module Helpers
+
+    module FormOptionsHelper
+
+      # Return select and option tags for the given object and method, using +localized_language_options_for_select+ 
+      # to generate the list of option tags. Uses <b>language code</b>, not name as option +value+.
+      # Language codes listed as an array of symbols in +priority_languages+ argument will be listed first
+      # TODO : Implement pseudo-named args with a hash, not the "somebody said PHP?" multiple args sillines
+      def localized_language_select(object, method, priority_languages = nil, options = {}, html_options = {})
+        InstanceTag.new(object, method, self, options.delete(:object)).
+          to_localized_language_select_tag(priority_languages, options, html_options)
+      end
+
+      # Return "named" select and option tags according to given arguments.
+      # Use +selected_value+ for setting initial value
+      # It behaves likes older object-binded brother +localized_language_select+ otherwise
+      # TODO : Implement pseudo-named args with a hash, not the "somebody said PHP?" multiple args sillines
+      def localized_language_select_tag(name, selected_value = nil, priority_languages = nil, html_options = {})
+        content_tag :select,
+                    localized_language_options_for_select(selected_value, priority_languages),
+                    { "name" => name, "id" => name }.update(html_options.stringify_keys)
+      end
+
+      # Returns a string of option tags for languages according to locale. Supply the language code in lower-case ('en', 'de') 
+      # as +selected+ to have it marked as the selected option tag.
+      # Language codes listed as an array of symbols in +priority_languages+ argument will be listed first
+      def localized_language_options_for_select(selected = nil, priority_languages = nil, options = {})
+        language_options = ""
+        if priority_languages
+          language_options += options_for_select(LocalizedLanguageSelect::priority_languages_array(priority_languages), selected)
+          language_options += "<option value=\"\" disabled=\"disabled\">-------------</option>\n"
+        end
+        return language_options + options_for_select(LocalizedLanguageSelect::localized_languages_array(options), selected)
+      end
+      
+    end
+
+    class InstanceTag
+      def to_localized_language_select_tag(priority_languages, options, html_options)
+        html_options = html_options.stringify_keys
+        add_default_name_and_id(html_options)
+        value = value(object)
+        content_tag("select",
+          add_options(
+            localized_language_options_for_select(value, priority_languages, options),
+            options, value
+          ), html_options
+        )
+      end
+    end
+    
+    class FormBuilder
+      def localized_language_select(method, priority_languages = nil, options = {}, html_options = {})
+        @template.localized_language_select(@object_name, method, priority_languages, options.merge(:object => @object), html_options)
+      end
+    end
+
+  end
+end