twitter_cldr 3.3.0 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4d3c83418de63bc5d460bb981ad0d1564a09de4f
-  data.tar.gz: 376f8ac7e27080e7cc1b604ef01e2f870bf9546d
+  metadata.gz: 24c9124b0a865bb5129c1ee452c64523388c511c
+  data.tar.gz: b4dcd2273f4220961ef9cb0f08e028003e3d859a
 SHA512:
-  metadata.gz: 625ac607af99d9ea241ffbcb406a6d024595ebe7255bb340a38a573e50ddd11afc577954e400427bf588b73fca3c0b75ea7c3848ee4c90f86fd2c7106bd617b1
-  data.tar.gz: 9746a38d2c5f56ec515e63ca88a75e0f72754d6b5553d05429bb93a8ef89d5f69ab742b1d8b269bcd4a41215fa6d87a068541c8852230ee9a0361b4af9b068e4
+  metadata.gz: 4c0cb24e46abd72a293cba324d00e03b973cdf00f40ba3f11fccd44fe71e378ab9d5a06a03acb4f6a71aeb3f60f1e91a1da714caae2e52afafeeebd97f6c6cbf
+  data.tar.gz: c7f81da3faeb01ab877a54fe66e7bcb68117dc015d321d84592dd79303f1407386cc3a413095f53d8ed3bf72821168ce52e74b17600489525e500cbe6ac23206

data/History.txt

@@ -1,5 +1,7 @@
-== 3.3.0
+== 3.4.0
+* Add units support, eg. "12 degrees Celsius", etc.
 
+== 3.3.0
 * Added `#as_territory` convenience method to LocalizedSymbol (@Anthony-Gaudino).
 * Improved documentation for world territories (@Anthony-Gaudino).
 * Fixed issues with Unicode regular expressions

data/README.md

@@ -86,6 +86,31 @@ In addition to formatting regular decimals, TwitterCLDR supports short and long
 1337123.localize.to_long_decimal.to_s   # "1 million"
 ```
 
+### Units
+
+TwitterCLDR supports formatting numbers with an attached unit, for example "12 degrees Celsius". It's easy to make use of this functionality via the `#to_unit` method:
+
+```ruby
+12.localize.to_unit.length_mile  # "12 miles"
+12.localize(:ru).to_unit.length_mile  # "12 миль"
+```
+Units support a few different forms, long, short, and narrow:
+
+```ruby
+12.localize.to_unit.mass_kilogram(form: :short)  # "12 kg"
+```
+
+To get a list of all available unit types, use the `#unit_types` method:
+
+```ruby
+unit = 12.localize.to_unit
+unit.unit_types  # => [:length_mile, :temperature_celsius, :mass_kilogram, ...]
+```
+
+
+
+
+
 ### Number Spellout, Ordinalization, and More
 
 TwitterCLDR's rule-based number formatters are capable of transforming integers into their written equivalents. Note that rule-based formatting of decimal numbers is currently not supported for languages other than English.
@@ -290,6 +315,15 @@ TwitterCldr::Localized::LocalizedTimespan.new(45).to_s(:approximate => true)  #
 TwitterCldr::Localized::LocalizedTimespan.new(52).to_s(:approximate => true)  # "In 1 minute"
 ```
 
+### Calendar Data
+
+CLDR contains a trove of calendar data, much of which can be accessed. One example is names of months, days, years.
+
+```ruby
+TwitterCldr::Shared::Calendar.new(:sv).months.take(3) # ["Januari", "Februari", "Mars"]
+```
+
+
 ### Lists
 
 TwitterCLDR supports formatting lists of strings as you might do in English by using commas, eg: "Apples, cherries, and oranges".  Use the `localize` method on an array followed by a call to `to_sentence`:
@@ -450,10 +484,10 @@ In addition to translating territory codes, TwitterCLDR provides access to the f
 
 ```ruby
 # get all territories for the default locale
-TwitterCldr::Shared::Territories.all                                                 # { ... :tl=>"East Timor", :tm=>"Turkmenistan" ... }
+TwitterCldr::Shared::Territories.all                                                 # { ... :tl => "East Timor", :tm => "Turkmenistan" ... }
 
 # get all territories for a specific locale
-TwitterCldr::Shared::Territories.all_for(:pt)                                        # { ... :tl=>"República Democrática de Timor-Leste", :tm=>"Turcomenistão" ... }
+TwitterCldr::Shared::Territories.all_for(:pt)                                        # { ... :tl => "República Democrática de Timor-Leste", :tm => "Turcomenistão" ... }
 
 # get a territory by its code for the default locale
 TwitterCldr::Shared::Territories.from_territory_code(:'gb')                          # "U.K."
@@ -514,7 +548,7 @@ postal_code.regexp  # /(\d{5})(?:[ \-](\d{4}))?/
 Get a sample of valid postal codes with the `#sample` method:
 
 ```ruby
-postal_code.sample(5)  # ["79220", "97037-1396", "41756", "07232-5538", "99181-2266"]
+postal_code.sample(5)  # ["04937-1403", "24033-3284", "40707-3618", "56564", "53993"]
 ```
 
 ### Phone Codes
@@ -668,7 +702,7 @@ You can break a string into sentences using the `LocalizedString#each_sentence`
 
 ```ruby
 "The. Quick. Brown. Fox.".localize.each_sentence do |sentence|
-  puts sentence.to_s  # "The.", " Quick.", " Brown.", " Fox."
+  puts sentence.to_s  # "The. ", "Quick. ", "Brown. ", "Fox."
 end
 ```
 
@@ -676,9 +710,9 @@ Under the hood, text segmentation is performed by the `BreakIterator` class (nam
 
 ```ruby
 
-iterator = TwitterCldr::Shared::BreakIterator.new(:en)
+iterator = TwitterCldr::Segmentation::BreakIterator.new(:en)
 iterator.each_sentence("The. Quick. Brown. Fox.") do |sentence|
-  puts sentence  # "The.", " Quick.", " Brown.", " Fox."
+  puts sentence  # "The. ", "Quick. ", "Brown. ", "Fox."
 end
 ```
 
@@ -686,9 +720,9 @@ To improve segmentation accuracy, a list of special segmentation exceptions have
 
 ```ruby
 
-iterator = TwitterCldr::Shared::BreakIterator.new(:en, :use_uli_exceptions => false)
+iterator = TwitterCldr::Segmentation::BreakIterator.new(:en, :use_uli_exceptions => false)
 iterator.each_sentence("I like Ms. Murphy, she's nice.") do |sentence|
-  puts sentence  # "I like Ms.", " Murphy, she's nice."
+  puts sentence  # "I like Ms. ", "Murphy, she's nice."
 end
 ```
 
@@ -700,7 +734,7 @@ Retrieve data for code points:
 
 ```ruby
 
-code_point = TwitterCldr::Shared::CodePoint.find(0x1F3E9)
+code_point = TwitterCldr::Shared::CodePoint.get(0x1F3E9)
 code_point.name             # "LOVE HOTEL"
 code_point.bidi_mirrored    # "N"
 code_point.category         # "So"
@@ -901,6 +935,6 @@ TwitterCLDR currently supports localization of certain textual objects in JavaSc
 
 ## License
 
-Copyright 2015 Twitter, Inc.
+Copyright 2016 Twitter, Inc.
 
 Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0

data/lib/twitter_cldr/data_readers/timespan_data_reader.rb

@@ -9,8 +9,8 @@ module TwitterCldr
 
       DEFAULT_DIRECTION = :none
       DEFAULT_TYPE = :default
-      VALID_UNITS = [:second, :minute, :hour, :day, :week, :month, :year]
-      BASE_PATH = [:units]
+      VALID_FIELDS = [:second, :minute, :hour, :day, :week, :month, :year]
+      BASE_PATH = [:fields]
 
       PATHS = {
         ago: {
@@ -23,6 +23,7 @@ module TwitterCldr
           month:   :'month-past',
           year:    :'year-past'
         },
+
         until: {
           default: :'hour-future',
           second:  :'second-future',
@@ -33,6 +34,7 @@ module TwitterCldr
           month:   :'month-future',
           year:    :'year-future'
         },
+
         none: {
           default: :second,
           second:  :second,
@@ -113,9 +115,9 @@ module TwitterCldr
 
         def resource_for_locale(locale)
           @resources ||= {}
-          @resources[locale] ||= TwitterCldr.get_locale_resource(locale, :units)[TwitterCldr.convert_locale(locale)]
+          @resources[locale] ||= TwitterCldr.get_locale_resource(locale, :fields)[TwitterCldr.convert_locale(locale)]
         end
       end
     end
   end
-end
+end

data/lib/twitter_cldr/localized/localized_number.rb

@@ -55,7 +55,11 @@ module TwitterCldr
         @rbnf ||= TwitterCldr::Formatters::Rbnf::RbnfFormatter.new(locale)
       end
 
-      protected
+      def to_unit
+        TwitterCldr::Shared::Unit.create(base_obj, locale)
+      end
+
+      private
 
       def to_type(target_type)
         self.class.new(base_obj, locale, {

data/lib/twitter_cldr/localized/localized_object.rb

@@ -17,14 +17,8 @@ module TwitterCldr
 
         options = options.dup
         options[:locale] = @locale
-
-        # @formatter = formatter_const.new(options) if formatter_const
       end
 
-      # def formatter_const
-      #   raise NotImplementedError
-      # end
-
       def self.localize(klass)
         klass.class_eval <<-LOCALIZE, __FILE__, __LINE__ + 1
           def localize(locale = TwitterCldr.locale, options = {})
@@ -35,4 +29,4 @@ module TwitterCldr
     end
 
   end
-end
+end

data/lib/twitter_cldr/localized/localized_string.rb

@@ -151,7 +151,7 @@ module TwitterCldr
       protected
 
       def escape_plural_interpolation(string)
-        # escape plura interpolation patterns ()see PluralFormatter)
+        # escape plural interpolation patterns (see PluralFormatter)
         string.gsub(TwitterCldr::Formatters::PluralFormatter::PLURALIZATION_REGEXP, '%\0')
       end
 

data/lib/twitter_cldr/shared.rb

@@ -30,5 +30,6 @@ module TwitterCldr
     autoload :TerritoriesContainment, 'twitter_cldr/shared/territories_containment'
     autoload :Territory,              'twitter_cldr/shared/territory'
     autoload :UnicodeRegex,           'twitter_cldr/shared/unicode_regex'
+    autoload :Unit,                   'twitter_cldr/shared/unit'
   end
 end

data/lib/twitter_cldr/shared/unit.rb

@@ -0,0 +1,126 @@
+# encoding: UTF-8
+
+# Copyright 2012 Twitter, Inc
+# http://www.apache.org/licenses/LICENSE-2.0
+
+require 'set'
+
+module TwitterCldr
+  module Shared
+    class Unit
+      class << self
+        def create(value, locale = TwitterCldr.locale)
+          subtype_for(locale).new(value, locale)
+        end
+
+        private
+
+        def reader_for(locale)
+          readers[locale] ||= TwitterCldr::DataReaders::NumberDataReader.new(locale)
+        end
+
+        def resource_for(locale)
+          TwitterCldr.get_locale_resource(locale, :units)[locale][:units]
+        end
+
+        def subtype_for(locale)
+          subtypes[locale] ||= begin
+            klass = Class.new(Unit)
+
+            all_unit_types_for(locale).each do |unit_type|
+              method_name = unit_type_to_method_name(unit_type)
+              klass.send(:define_method, method_name) do |*args|
+                format(unit_type, *args)
+              end
+            end
+
+            klass
+          end
+        end
+
+        def all_unit_types_for(locale)
+          unit_types[locale] ||= begin
+            resource = resource_for(locale)
+            lengths = resource[:unitLength].keys
+
+            lengths.each_with_object(Set.new) do |length, ret|
+              ret.merge(resource[:unitLength][length].keys)
+            end
+          end
+        end
+
+        def all_unit_methods_for(locale)
+          unit_methods[locale] ||= all_unit_types_for(locale).map do |unit_type|
+            unit_type_to_method_name(unit_type).to_sym
+          end
+        end
+
+        def unit_type_to_method_name(unit_type)
+          unit_type.to_s.gsub('-', '_')
+        end
+
+        def subtypes
+          @subtypes ||= {}
+        end
+
+        def unit_types
+          @unit_types ||= {}
+        end
+
+        def unit_methods
+          @unit_methods ||= {}
+        end
+
+        def readers
+          @readers ||= {}
+        end
+      end
+
+      DEFAULT_FORM = :long
+
+      attr_reader :value, :locale
+
+      def initialize(value, locale = TwitterCldr.locale)
+        @value = value
+        @locale = locale
+      end
+
+      def unit_types
+        self.class.send(:all_unit_methods_for, locale)
+      end
+
+      private
+
+      def format(unit_type, options = {})
+        form = options.fetch(:form, DEFAULT_FORM)
+
+        if variant = variant_for(form, unit_type)
+          variant.sub('{0}', formatted_value)
+        end
+      end
+
+      def formatted_value
+        if value.is_a?(Numeric)
+          self.class.send(:reader_for, locale).format_number(value)
+        else
+          value
+        end
+      end
+
+      def variant_for(form, unit_type)
+        variant = resource[:unitLength]
+          .fetch(form, {})
+          .fetch(unit_type, {})
+          .fetch(plural_rule.to_sym, nil)
+      end
+
+      def plural_rule
+        TwitterCldr::Formatters::Plurals::Rules.rule_for(value, locale)
+      end
+
+      def resource
+        @resource ||= self.class.send(:resource_for, locale)
+      end
+    end
+  end
+end

data/lib/twitter_cldr/version.rb

@@ -4,5 +4,5 @@
 # http://www.apache.org/licenses/LICENSE-2.0
 
 module TwitterCldr
-  VERSION = "3.3.0"
+  VERSION = '3.4.0'
 end

data/resources/custom/locales/af/fields.yml

@@ -0,0 +1,19 @@
+---
+:af:
+  :fields:
+    :day:
+      :abbreviated:
+        :one: "{0}d"
+        :other: "{0}d"
+    :hour:
+      :abbreviated:
+        :one: "{0}h"
+        :other: "{0}h"
+    :minute:
+      :abbreviated:
+        :one: "{0}m"
+        :other: "{0}m"
+    :second:
+      :abbreviated:
+        :one: "{0}s"
+        :other: "{0}s"

data/resources/custom/locales/ar/fields.yml

@@ -0,0 +1,35 @@
+---
+:ar:
+  :fields:
+    :day:
+      :abbreviated:
+        :zero: "{0}يومًا"
+        :one: "{0}يومًا"
+        :two: "{0}يومًا"
+        :few: "{0}يومًا"
+        :many: "{0}يومًا"
+        :other: "{0}يومًا"
+    :hour:
+      :abbreviated:
+        :zero: "{0} ساعة"
+        :one: "{0} ساعة"
+        :two: "{0} ساعة"
+        :few: "{0} ساعة"
+        :many: "{0} ساعة"
+        :other: "{0} ساعة"
+    :minute:
+      :abbreviated:
+        :zero: "{0} دقيقة"
+        :one: "{0} دقيقة"
+        :two: "{0} دقيقة"
+        :few: "{0} دقيقة"
+        :many: "{0} دقيقة"
+        :other: "{0} دقيقة"
+    :second:
+      :abbreviated:
+        :zero: "{0} ثانية"
+        :one: "{0} ثانية"
+        :two: "{0} ثانية"
+        :few: "{0} ثانية"
+        :many: "{0} ثانية"
+        :other: "{0} ثانية"

data/resources/custom/locales/be/fields.yml

@@ -0,0 +1,27 @@
+---
+:be:
+  :fields:
+    :day:
+      :abbreviated:
+        :one: "{0} дн"
+        :few: "{0} дн"
+        :many: "{0} дн"
+        :other: "{0} дн"
+    :hour:
+      :abbreviated:
+        :one: "{0} г"
+        :few: "{0} г"
+        :many: "{0} г"
+        :other: "{0} г"
+    :minute:
+      :abbreviated:
+        :one: "{0} мін"
+        :few: "{0} мін"
+        :many: "{0} мін"
+        :other: "{0} мін"
+    :second:
+      :abbreviated:
+        :one: "{0} сэк"
+        :few: "{0} сэк"
+        :many: "{0} сэк"
+        :other: "{0} сэк"