twitter_cldr 1.3.0 → 1.3.6

data/README.md

@@ -33,14 +33,6 @@ TwitterCldr patches core Ruby objects like Fixnum and Date to make localization
 
 ### Numbers
 
-**Note**: The CLDR is missing complete number data for:
-
-* hu (Hungarian)
-* id (Indonesian)
-* msa (Malay)
-* no (Norwegian),
-* zh-tw (Traditional Chinese)
-
 Fixnum, Bignum, and Float objects are supported.  Here are some examples:
 
 ```ruby
@@ -328,6 +320,63 @@ No external requirements.
 
 `bundle exec rake` should do the trick.  Tests are written in RSpec using RR as the mocking framework.
 
+## JavaScript Support
+(Note: These changes have not yet been released as a gem.)
+
+TwitterCLDR currently supports localization of dates and times in JavaScript.  More awesome features are coming soon.
+
+### Generating the JavaScript
+
+You can automatically generate the JavaScript versions of TwitterCLDR using this Rubygem.  Here's the one-liner:
+
+`bundle exec rake js:build OUTPUT_DIR=/path/to/desired/output/location`
+
+If you'd like to customize the generated output further, you'll need to require the `TwitterCldr::Js` namespace.  You can choose the locales to export and whether to export a minified version alongside the full version for each locale.
+
+```ruby
+require 'twitter_cldr'
+
+TwitterCldr.require_js                                   # require JavaScript environment
+TwitterCldr::Js.output_dir = "/path/to/output/location"
+TwitterCldr::Js.make(:locales => [:de, :sv, :ja, :ar],   # generate files for German, Swedish,
+                     :minify => true)                    # Japanese, and Arabic
+TwitterCldr::Js.install                                  # copy files to output directory
+```
+
+### Dates and Times (JS)
+
+```javascript
+// include twitter_cldr_es.js for the Spanish DateTimeFormatter
+var fmt = new TwitterCldr.DateTimeFormatter();
+
+fmt.format(new Date(), {"type": "full"});                     // "lunes, 12 de diciembre de 2011 21:44:57 UTC -0800"
+fmt.format(new Date(), {"type": "long"});                     // "12 de diciembre de 201121:45:42 -08:00"
+fmt.format(new Date(), {"type": "medium"});                   // "12/12/2011 21:46:09"
+fmt.format(new Date(), {"type": "short"});                    // "12/12/11 21:47"
+
+fmt.format(new Date(), {"format": "date", "type": "full"});   // "lunes, 12 de diciembre de 2011"
+fmt.format(new Date(), {"format": "date", "type": "long"});   // "12 de diciembre de 2011"
+fmt.format(new Date(), {"format": "date", "type": "medium"}); // "12/12/2011"
+fmt.format(new Date(), {"format": "date", "type": "short"});  // "12/12/11"
+
+fmt.format(new Date(), {"format": "time", "type": "full"});   // "21:44:57 UTC -0800"
+fmt.format(new Date(), {"format": "time", "type": "long"});   // "21:45:42 -08:00"
+fmt.format(new Date(), {"format": "time", "type": "medium"}); // "21:46:09"
+fmt.format(new Date(), {"format": "time", "type": "short"});  // "21:47"
+```
+
+The CLDR data set only includes 4 specific date formats, full, long, medium, and short, so you'll have to choose amongst them for the one that best fits your needs.  Yes, it's limiting, but the 4 formats get the job done most of the time :)
+
+### Running Tests (JS)
+
+A JavaScript test suite comes with twitter-cldr-rb.  You'll need to install the Qt libs to be able to run the suite, as it uses [jasmine](https://github.com/pivotal/jasmine-gem) and [jasmine-headless-webkit](http://johnbintz.github.com/jasmine-headless-webkit/).
+
+1. Install qt (eg. `brew install qt`, `sudo apt-get install qt4`, etc)
+2. Run `bundle`
+3. Run `bundle exec rake js:test`
+
+The tests are located in `js/spec` and look similar to RSpec tests.
+
 ## Authors
 
 * Cameron C. Dutro: http://github.com/camertron
@@ -346,6 +395,5 @@ Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/L
 
 ## Future Plans
 
-* Add Javascript support
-* Implement algorithms for Unicode normalization, collation, and capitalization
+* Implement Unicode Collation Algorithm (UCA) for sorting/searching.
 * Patch Ruby 1.8 strings to provide better Unicode support (probably using pack and unpack).

data/Rakefile

@@ -1,3 +1,8 @@
+# encoding: UTF-8
+
+# Copyright 2012 Twitter, Inc
+# http://www.apache.org/licenses/LICENSE-2.0
+
 require 'rubygems' unless ENV['NO_RUBYGEMS']
 
 require 'bundler'
@@ -31,4 +36,24 @@ if RUBY_VERSION < '1.9.0'
     t.pattern   = './spec/**/*_spec.rb'
     t.rcov_opts = %w(-T --sort coverage --exclude gems/,spec/)
   end
+end
+
+namespace :js do
+  task :build do
+    require File.expand_path(File.join(File.dirname(__FILE__), %w[lib twitter_cldr]))
+    TwitterCldr.require_js
+    FileUtils.mkdir_p(TwitterCldr::Js.build_dir)
+    TwitterCldr::Js.output_dir = File.expand_path(ENV["OUTPUT_DIR"])
+    TwitterCldr::Js.make(:locales => TwitterCldr.supported_locales)
+    TwitterCldr::Js.install
+  end
+
+  task :test do
+    require File.expand_path(File.join(File.dirname(__FILE__), %w[lib twitter_cldr]))
+    TwitterCldr.require_js
+    FileUtils.mkdir_p(TwitterCldr::Js.build_dir)
+    TwitterCldr::Js.make(:locales => [:en])
+    TwitterCldr::Js.test
+    FileUtils.rm_rf(TwitterCldr::Js.build_dir)
+  end
 end

data/lib/twitter_cldr.rb

@@ -4,12 +4,16 @@
 # http://www.apache.org/licenses/LICENSE-2.0
 
 $:.push(File.dirname(__FILE__))
+$:.push(File.dirname(File.dirname(__FILE__)))
 
 $KCODE = 'UTF-8' unless RUBY_VERSION >= '1.9.0'
 
 require 'yaml'
 require 'date'
 require 'time'
+require 'fileutils'
+
+# gems
 require 'forwardable'
 
 require 'twitter_cldr/version'
@@ -39,6 +43,9 @@ module TwitterCldr
       :'zh-tw' => :'zh-Hant'
   }
 
+  # maps cldr locales to twitter locales
+  CLDR_LOCALE_MAP = TWITTER_LOCALE_MAP.invert
+
   def_delegator :resources, :get_resource
   def_delegator :resources, :get_locale_resource
 
@@ -64,6 +71,11 @@ module TwitterCldr
       TWITTER_LOCALE_MAP.fetch(locale, locale)
     end
 
+    def twitter_locale(locale)
+      locale = locale.to_sym
+      CLDR_LOCALE_MAP.fetch(locale, locale)
+    end
+
     def supported_locales
       @supported_locales ||= Dir.glob(File.join(RESOURCES_DIR, 'locales', '*')).map { |f| File.basename(f).to_sym }
     end
@@ -73,8 +85,11 @@ module TwitterCldr
       supported_locales.include?(locale) || supported_locales.include?(convert_locale(locale))
     end
 
+    def require_js
+      require "js/lib/twitter_cldr_js"
+    end
   end
 
 end
 
-require 'twitter_cldr/core_ext'
+require 'twitter_cldr/core_ext'

data/lib/twitter_cldr/core_ext.rb

@@ -2,6 +2,7 @@ require 'twitter_cldr/core_ext/localized_object'
 require 'twitter_cldr/core_ext/calendars/datetime'
 require 'twitter_cldr/core_ext/calendars/date'
 require 'twitter_cldr/core_ext/calendars/time'
+require 'twitter_cldr/core_ext/calendars/timespan'
 require 'twitter_cldr/core_ext/numbers/localized_number'
 require 'twitter_cldr/core_ext/numbers/bignum'
 require 'twitter_cldr/core_ext/numbers/fixnum'

data/lib/twitter_cldr/core_ext/calendars/datetime.rb

@@ -24,6 +24,20 @@ module TwitterCldr
       end
     end
 
+    def ago(options = {})
+      base_time = options[:base_time] || Time.now
+      seconds = self.to_time.base_obj.to_i - base_time.to_i
+      raise ArgumentError.new('Start date is after end date. Consider using "until" function.') if seconds > 0
+      TwitterCldr::Shared::LocalizedTimespan.new(seconds, @locale).to_s(options[:unit])
+    end
+
+    def until(options = {})
+      base_time = options[:base_time] || Time.now
+      seconds = self.to_time.base_obj.to_i - base_time.to_i
+      raise ArgumentError.new('End date is before start date. Consider using "ago" function.') if seconds < 0
+      TwitterCldr::Shared::LocalizedTimespan.new(seconds, @locale).to_s(options[:unit])
+    end
+
     def to_s
       to_default_s
     end

data/lib/twitter_cldr/core_ext/calendars/timespan.rb

@@ -0,0 +1,26 @@
+# encoding: UTF-8
+
+# Copyright 2012 Twitter, Inc
+# http://www.apache.org/licenses/LICENSE-2.0
+
+module TwitterCldr
+  module Shared
+    class LocalizedTimespan < LocalizedObject
+
+      def initialize(seconds, locale)
+        @formatter = TwitterCldr::Formatters::TimespanFormatter.new(:locale => locale)
+        @seconds = seconds
+      end
+
+      def to_s(unit = :default)
+        @formatter.format(@seconds, unit)
+      end
+
+      protected
+
+      def formatter_const
+        TwitterCldr::Formatters::TimespanFormatter
+      end
+    end
+  end
+end

data/lib/twitter_cldr/formatters.rb

@@ -10,6 +10,7 @@ module TwitterCldr
     autoload :DateTimeFormatter, 'twitter_cldr/formatters/calendars/datetime_formatter'
     autoload :DateFormatter,     'twitter_cldr/formatters/calendars/date_formatter'
     autoload :TimeFormatter,     'twitter_cldr/formatters/calendars/time_formatter'
+    autoload :TimespanFormatter, 'twitter_cldr/formatters/calendars/timespan_formatter'
 
     autoload :Numbers,           'twitter_cldr/formatters/numbers'
     autoload :NumberFormatter,   'twitter_cldr/formatters/numbers/number_formatter'

data/lib/twitter_cldr/formatters/calendars/datetime_formatter.rb

@@ -113,7 +113,7 @@ module TwitterCldr
           @tokenizer.calendar[:months][:format][:wide][date.month]
         when 5
           raise NotImplementedError, 'requires cldr\'s "multiple inheritance"'
-          @tokenizer.calendar[:months][:format][:narrow][date.month]
+          # @tokenizer.calendar[:months][:format][:narrow][date.month]
         else
           # raise unknown date format
         end
@@ -215,11 +215,6 @@ module TwitterCldr
       def timezone_generic_non_location(time, pattern, length)
         raise NotImplementedError, 'requires timezone translation data'
       end
-
-      def round_to(number, precision)
-        factor = 10 ** precision
-        (number * factor).round.to_f / factor
-      end
     end
   end
 end

data/lib/twitter_cldr/formatters/calendars/timespan_formatter.rb

@@ -0,0 +1,67 @@
+# encoding: UTF-8
+
+# Copyright 2012 Twitter, Inc
+# http://www.apache.org/licenses/LICENSE-2.0
+
+module TwitterCldr
+  module Formatters
+    class TimespanFormatter < Base
+      TIME_IN_SECONDS = { 
+        :second => 1,
+        :minute => 60,
+        :hour => 3600,
+        :day => 86400,
+        :week => 604800,
+        :month => 2629743.83,
+        :year => 31556926 
+      }
+
+      def initialize(options = {})
+        @tokenizer = TwitterCldr::Tokenizers::TimespanTokenizer.new(:locale => extract_locale(options))
+      end
+
+      def format(seconds, unit)
+        direction = seconds < 0 ? :ago : :until
+
+        if unit.nil? || unit == :default
+          unit = self.calculate_unit(seconds.abs)
+        end
+
+        number = calculate_time(seconds.abs, unit)
+
+        tokens = @tokenizer.tokens(:direction => direction, :unit => unit, :number => number)
+        strings = tokens.map { |token| token[:value]}
+        strings.join.gsub(/\{[0-9]\}/, number.to_s)
+      end
+
+      def calculate_unit(seconds)
+        if seconds < 30
+          :second
+        elsif seconds < 2670
+          :minute
+        elsif seconds < 86369
+          :hour
+        elsif seconds < 604800
+          :day
+        elsif seconds < 2591969
+          :week
+        elsif seconds < 31556926
+          :month
+        else
+          :year
+        end
+      end
+
+      # 0 <-> 29 secs                                                   # => seconds
+      # 30 secs <-> 44 mins, 29 secs                                    # => minutes
+      # 44 mins, 30 secs <-> 23 hrs, 59 mins, 29 secs                   # => hours
+      # 23 hrs, 59 mins, 29 secs <-> 29 days, 23 hrs, 59 mins, 29 secs  # => days
+      # 29 days, 23 hrs, 59 mins, 29 secs <-> 1 yr minus 1 sec          # => months
+      # 1 yr <-> max time or date                                       # => years
+      def calculate_time(seconds, unit)
+        (seconds / TIME_IN_SECONDS[unit]).round.to_i
+      end
+
+    end
+  end
+end

data/lib/twitter_cldr/formatters/numbers/number_formatter.rb

@@ -17,8 +17,8 @@ module TwitterCldr
       def format(number, options = {})
         opts = self.default_format_options_for(number).merge(options)
         prefix, suffix, integer_format, fraction_format = *partition_tokens(self.get_tokens(number, opts))
+        
         int, fraction = parse_number(number, opts)
-
         result =  integer_format.apply(int, opts)
         result << fraction_format.apply(fraction, opts) if fraction
         "#{prefix.to_s}#{result}#{suffix.to_s}"

data/lib/twitter_cldr/tokenizers.rb

@@ -13,5 +13,6 @@ module TwitterCldr
     autoload :DateTokenizer,     'twitter_cldr/tokenizers/calendars/date_tokenizer'
     autoload :TimeTokenizer,     'twitter_cldr/tokenizers/calendars/time_tokenizer'
     autoload :NumberTokenizer,   'twitter_cldr/tokenizers/numbers/number_tokenizer'
+    autoload :TimespanTokenizer,  'twitter_cldr/tokenizers/calendars/timespan_tokenizer'
   end
 end

data/lib/twitter_cldr/tokenizers/base.rb

@@ -41,13 +41,13 @@ module TwitterCldr
         final
       end
 
-      def tokens_for(key, type)
+      def tokens_for(path, type)
         @@token_cache ||= {}
-        cache_key = self.compute_cache_key(@locale, key, type)
+        cache_key = compute_cache_key(@locale, path.join('.'), type)
 
         unless @@token_cache.include?(cache_key)
           result = []
-          tokens = self.expand_pattern(self.pattern_for(self.traverse(key)), type)
+          tokens = expand_pattern(pattern_for(traverse(path)), type)
 
           tokens.each do |token|
             if token.is_a?(Token) || token.is_a?(CompositeToken)
@@ -63,6 +63,21 @@ module TwitterCldr
         @@token_cache[cache_key]
       end
 
+      def tokens_with_placeholders_for(key)
+        @@token_cache ||= {}
+        cache_key = self.compute_cache_key(@locale, key, type)
+
+        unless @@token_cache.include?(cache_key)
+          result = []
+          tokens = self.tokenize_pattern(self.pattern_for(self.traverse(key)))
+          tokens.each do |token|
+            result << token
+          end
+          @@token_cache[cache_key] = result
+        end
+        @@token_cache[cache_key]
+      end
+
       def compute_cache_key(*pieces)
         if pieces && pieces.size > 0
           pieces.join("|").hash
@@ -75,11 +90,10 @@ module TwitterCldr
         @placeholders = {}
       end
 
-      def traverse(needle, haystack = @resource)
-        needle.to_s.split('.').inject(haystack) do |current, segment|
-          key = segment.to_sym
-          if current.is_a?(Hash) && current.has_key?(key)
-            current[key]
+      def traverse(path, haystack = @resource)
+        path.inject(haystack) do |current, segment|
+          if current.is_a?(Hash) && current.has_key?(segment)
+            current[segment]
           else
             return
           end
@@ -89,7 +103,7 @@ module TwitterCldr
       def expand_pattern(format_str, type)
         if format_str.is_a?(Symbol)
           # symbols mean another path was given
-          self.expand_pattern(self.pattern_for(self.traverse(format_str)), type)
+          self.expand_pattern(self.pattern_for(self.traverse(format_str.to_s.split('.').map(&:to_sym))), type)
         else
           parts = tokenize_pattern(format_str)
           final = []

data/lib/twitter_cldr/tokenizers/calendars/date_tokenizer.rb

@@ -9,14 +9,20 @@ module TwitterCldr
       def initialize(options = {})
         super(options)
         @token_splitter_regex = /(\s*\'[\w\s-]+\'\s*|G{1,5}|y+|Y+|Q{1,4}|q{1,5}|M{1,5}|L{1,5}|d{1,2}|F{1}|E{1,5}|e{1,5}|c{1,5}|\#\{[^\}]+\})/
-        @token_type_regexes = [ { :type => :composite, :regex => /^\#\{[^\}]+\}/, :content => /^\#\{([^\}]+)\}/ },
-                                { :type => :pattern, :regex => /^(?:G{1,5}|y+|Y+|Q{1,4}|q{1,5}|M{1,5}|L{1,5}|d{1,2}|F{1}|E{1,5}|e{1,5}|c{1,5})/ },
-                               { :type => :plaintext, :regex => // }]
-        @paths = { :default => "formats.date.default",
-                   :full => "formats.date.full",
-                   :long => "formats.date.long",
-                   :medium => "formats.date.medium",
-                   :short => "formats.date.short" }
+
+        @token_type_regexes = [
+            { :type => :composite, :regex => /^\#\{[^\}]+\}/, :content => /^\#\{([^\}]+)\}/ },
+            { :type => :pattern,   :regex => /^(?:G{1,5}|y+|Y+|Q{1,4}|q{1,5}|M{1,5}|L{1,5}|d{1,2}|F{1}|E{1,5}|e{1,5}|c{1,5})/ },
+            { :type => :plaintext, :regex => // }
+        ]
+
+        @paths = {
+            :default => [:formats, :date, :default],
+            :full    => [:formats, :date, :full],
+            :long    => [:formats, :date, :long],
+            :medium  => [:formats, :date, :medium],
+            :short   => [:formats, :date, :short]
+        }
       end
 
       protected

data/lib/twitter_cldr/tokenizers/calendars/datetime_tokenizer.rb

@@ -12,22 +12,26 @@ module TwitterCldr
 
       def initialize(options = {})
         @calendar_type = options[:calendar_type] || TwitterCldr::DEFAULT_CALENDAR_TYPE
+
         @token_splitter_regex = //
-        @token_type_regexes = [{ :type => :plaintext, :regex => // }]
+        @token_type_regexes   = [{ :type => :plaintext, :regex => // }]
+
+        @base_path = [:calendars]
 
-        @base_path = "calendars"
-        @paths = { :default => "formats.datetime.default",
-                   :full => "formats.datetime.full",
-                   :long => "formats.datetime.long",
-                   :medium => "formats.datetime.medium",
-                   :short => "formats.datetime.short" }
+        @paths = {
+            :default => [:formats, :datetime, :default],
+            :full    => [:formats, :datetime, :full],
+            :long    => [:formats, :datetime, :long],
+            :medium  => [:formats, :datetime, :medium],
+            :short   => [:formats, :datetime, :short]
+        }
 
         super(options)
       end
 
       def tokens(options = {})
         type = options[:type] || :default
-        self.tokens_for(self.full_path_for(self.paths[type]), type)
+        tokens_for(full_path_for(paths[type]), type)
       end
 
       def calendar
@@ -37,7 +41,7 @@ module TwitterCldr
       protected
 
       def full_path_for(path, calendar_type = @calendar_type)
-        KeyPath.join(@base_path, calendar_type.to_s, path)
+        @base_path + [calendar_type] + path
       end
 
       def init_resources