ffi-icu 0.5.0 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 77b5088964964f78d79893dc7260d5e01dde9e701c62877eb19556ecc3ee460b
-  data.tar.gz: b008d71ecdd7360bbe8bf24544f888a71fede1934a5fdaf1bb46b121b21be95e
+  metadata.gz: 2075e91bd27944e5725d4379471db7bda9787d7b4a0622e92b71f15d03ed9ef3
+  data.tar.gz: 145eddff12e1d703ed29d01f3661e674439b39ff11c3882fc52633af50e6ca09
 SHA512:
-  metadata.gz: 9074f912c536402fadf8e489989bc475f4330fac69cd32b720c5916fa0f5a4b447a1ef4994692f0116c36def1cc84632d2e6f4529071412d4a44b01d2f10e5a1
-  data.tar.gz: '028fab98aaf0c3ddef7f6a4af81f9c228c84bd1d2a17be241ab4834fb0c4922ca51dd1c7e49860589a54178a0c02430b2a60cb3e1f3cd460e605336a58200982'
+  metadata.gz: 6d63a1b1f93622d80abbc93889fa0e8eea90fa81025de1b4c5bf672a65d8922809100fa55ccc55a3c42599d2b2dfd3c2d69774601f512308783b66c26e9b6a71
+  data.tar.gz: 99fa27ab152f6f52a62d71a850e201ac61149c2c86b3fbb92fd2ff86f1ec942f19394af43e4068338d6a11121cdaadab9d53509da0d93750efeb1d54b960556d

data/README.md

@@ -18,9 +18,11 @@ ICU.
 If you get messages that the library or functions are not found, you can
 set some environment variables to tell ffi-icu where to find it, e.g.:
 
-    $ export FFI_ICU_LIB="icui18n.so"
-    $ export FFI_ICU_VERSION_SUFFIX="_3_8"
-    $ ruby -r ffi-icu program.rb
+```sh
+$ export FFI_ICU_LIB="icui18n.so"
+$ export FFI_ICU_VERSION_SUFFIX="_3_8"
+$ ruby -r ffi-icu program.rb
+```
 
 Features
 ========
@@ -31,17 +33,16 @@ Character Encoding Detection
 Examples:
 
 ```ruby
-
-    match = ICU::CharDet.detect(str)
-    match.name       # => "UTF-8"
-    match.confidence # => 80
+match = ICU::CharDet.detect(str)
+match.name       # => "UTF-8"
+match.confidence # => 80
 ```
 
 or
 
 ```ruby
-    detector = ICU::CharDet::Detector.new
-    detector.detect(str) => #<struct ICU::CharDet::Detector::Match ...>
+detector = ICU::CharDet::Detector.new
+detector.detect(str) => #<struct ICU::CharDet::Detector::Match ...>
 ```
 
 Why not just use rchardet?
@@ -54,16 +55,16 @@ Locale Sensitive Collation
 Examples:
 
 ```ruby
-    ICU::Collation.collate("nb", %w[å æ ø]) == %w[æ ø å] #=> true
+ICU::Collation.collate("nb", %w[å æ ø]) == %w[æ ø å] #=> true
 ```
 
 or
 
 ```ruby
-    collator = ICU::Collation::Collator.new("nb")
-    collator.compare("a", "b")  #=> -1
-    collator.greater?("z", "a") #=> true
-    collator.collate(%w[å æ ø]) #=> ["æ", "ø", "å"]
+collator = ICU::Collation::Collator.new("nb")
+collator.compare("a", "b")  #=> -1
+collator.greater?("z", "a") #=> true
+collator.collate(%w[å æ ø]) #=> ["æ", "ø", "å"]
 ```
 
 Text Boundary Analysis
@@ -72,9 +73,9 @@ Text Boundary Analysis
 Examples:
 
 ```ruby
-    iterator = ICU::BreakIterator.new(:word, "en_US")
-    iterator.text = "This is a sentence."
-    iterator.to_a  #=> [0, 4, 5, 7, 8, 9, 10, 18, 19]
+iterator = ICU::BreakIterator.new(:word, "en_US")
+iterator.text = "This is a sentence."
+iterator.to_a  #=> [0, 4, 5, 7, 8, 9, 10, 18, 19]
 ```
 
 Number/Currency Formatting
@@ -83,50 +84,107 @@ Number/Currency Formatting
 Examples:
 
 ```ruby
-    # class method interface
-    ICU::NumberFormatting.format_number("en", 1_000) #=> "1,000"
-    ICU::NumberFormatting.format_number("de-DE", 1234.56) #=> "1.234,56"
-    ICU::NumberFormatting.format_currency("en", 123.45, 'USD') #=> "$123.45"
-    ICU::NumberFormatting.format_percent("en", 0.53, 'USD') #=> "53%"
-    ICU::NumberFormatting.spell("en_US", 1_000) #=> "one thousand"
-
-    # reusable formatting objects
-    numf = ICU::NumberFormatting.create('fr-CA')
-    numf.format(1000) #=> "1 000"
-
-    curf = ICU::NumberFormatting.create('en-US', :currency)
-    curf.format(1234.56, 'USD') #=> "$1,234.56"
+# class method interface
+ICU::NumberFormatting.format_number("en", 1_000) #=> "1,000"
+ICU::NumberFormatting.format_number("de-DE", 1234.56) #=> "1.234,56"
+ICU::NumberFormatting.format_currency("en", 123.45, 'USD') #=> "$123.45"
+ICU::NumberFormatting.format_percent("en", 0.53, 'USD') #=> "53%"
+ICU::NumberFormatting.spell("en_US", 1_000) #=> "one thousand"
+
+# reusable formatting objects
+numf = ICU::NumberFormatting.create('fr-CA')
+numf.format(1000) #=> "1 000"
+
+curf = ICU::NumberFormatting.create('en-US', :currency)
+curf.format(1234.56, 'USD') #=> "$1,234.56"
 ```
 
 Time Formatting/Parsing
---------------------------
+-----------------------
 
 Examples:
 
 ```ruby
-    # class method interface
-    f = ICU::TimeFormatting.format(Time.mktime(2015, 11, 12, 15, 21, 16), {:locale => 'cs_CZ', :zone => 'Europe/Prague', :date => :short, :time => :short})
-    f #=> "12.11.15 15:21"
+# class method interface
+f = ICU::TimeFormatting.format(Time.mktime(2015, 11, 12, 15, 21, 16), {:locale => 'cs_CZ', :zone => 'Europe/Prague', :date => :short, :time => :short})
+f #=> "12.11.15 15:21"
 
-    # reusable formatting objects
-    formatter = ICU::TimeFormatting.create(:locale => 'cs_CZ', :zone => 'Europe/Prague', :date => :long, :time => :none)
-    formatter.format(Time.now)  #=> "25. února 2015"
+# reusable formatting objects
+formatter = ICU::TimeFormatting.create(:locale => 'cs_CZ', :zone => 'Europe/Prague', :date => :long, :time => :none)
+formatter.format(Time.now)  #=> "25. února 2015"
 ```
 
 ```ruby
-    # reusable formatting objects
-    formatter = ICU::TimeFormatting.create(:locale => 'cs_CZ', :zone => 'Europe/Prague', :date => :long, :time => :none)
-    formatter.parse("25. února 2015") #=> Wed Feb 25 00:00:00 +0100 2015
+# reusable formatting objects
+formatter = ICU::TimeFormatting.create(:locale => 'cs_CZ', :zone => 'Europe/Prague', :date => :long, :time => :none)
+formatter.parse("25. února 2015") #=> Wed Feb 25 00:00:00 +0100 2015
 ```
 
 For skeleton formatting, visit the [Unicode date field symbol table](https://unicode-org.github.io/icu/userguide/format_parse/datetime/#date-field-symbol-table) page to help find the pattern characters to use.
 
 ```ruby
-    formatter = ICU::TimeFormatting.create(:locale => 'cs_CZ', :date => :pattern, :time => :pattern, :skeleton => 'MMMMY')
-    formatter.format(Time.now)  #=> "únor 2015"
+formatter = ICU::TimeFormatting.create(:locale => 'cs_CZ', :date => :pattern, :time => :pattern, :skeleton => 'MMMMY')
+formatter.format(Time.now)  #=> "únor 2015"
 
-    formatter = ICU::TimeFormatting.create(:locale => 'cs_CZ', :date => :pattern, :time => :pattern, :skeleton => 'Y')
-    formatter.format(Time.now)  #=> "2015"
+formatter = ICU::TimeFormatting.create(:locale => 'cs_CZ', :date => :pattern, :time => :pattern, :skeleton => 'Y')
+formatter.format(Time.now)  #=> "2015"
+```
+
+Duration Formatting
+-------------------
+
+```ruby
+# What the various styles look like
+formatter = ICU::DurationFormatting::DurationFormatter.new(locale: 'en-AU', style: :long)
+formatter.format({hours: 8, minutes: 40, seconds: 35})  #=> "8 hours, 40 minutes, 35 seconds"
+
+formatter = ICU::DurationFormatting::DurationFormatter.new(locale: 'en-AU', style: :short)
+formatter.format({hours: 8, minutes: 40, seconds: 35})  #=> "8 hrs, 40 mins, 35 secs"
+
+formatter = ICU::DurationFormatting::DurationFormatter.new(locale: 'en-AU', style: :narrow)
+formatter.format({hours: 8, minutes: 40, seconds: 35})  #=> "8h 40min. 35s."
+formatter = ICU::DurationFormatting::DurationFormatter.new(locale: 'en-AU', style: :digital)
+formatter.format({hours: 8, minutes: 40, seconds: 35})  #=> "8:40:35"
+
+# How digital & non-digital formats deal with units > hours
+formatter = ICU::DurationFormatting::DurationFormatter.new(locale: 'en-AU', style: :narrow)
+formatter.format({days: 2, hours: 8, minutes: 40, seconds: 35})  #=> "2d 8h 40min. 35s."
+formatter = ICU::DurationFormatting::DurationFormatter.new(locale: 'en-AU', style: :digital)
+formatter.format({days: 2, hours: 8, minutes: 40, seconds: 35})  #=> "2d 8:40:35"
+
+# Missing or zero parts are omitted
+formatter = ICU::DurationFormatting::DurationFormatter.new(locale: 'en-AU', style: :long)
+formatter.format({days: 2, minutes: 40, seconds:0})  #=> "2 days, 40 minutes"
+
+formatter = ICU::DurationFormatting::DurationFormatter.new(locale: 'en-AU', style: :digital)
+formatter.format({hours: 2, minutes: 40})  #=> "2:40"
+
+formatter = ICU::DurationFormatting::DurationFormatter.new(locale: 'en-AU', style: :digital)
+formatter.format({minutes: 40, seconds: 7})  #=> "40:07"
+
+# Sub-second parts are folded into seconds for digital display
+formatter = ICU::DurationFormatting::DurationFormatter.new(locale: 'en-AU', style: :digital)
+formatter.format({hours: 5, minutes: 7, seconds: 23, milliseconds: 98, microseconds: 997})  #=> "5:07:23.098997"
+
+# Zero-extension of sub-second parts in digital style
+formatter = ICU::DurationFormatting::DurationFormatter.new(locale: 'en-AU', style: :digital)
+formatter.format({hours: 5, minutes: 7, seconds: 23, milliseconds: 400})  #=> "5:07:23.400"
+formatter = ICU::DurationFormatting::DurationFormatter.new(locale: 'en-AU', style: :digital)
+formatter.format({hours: 5, minutes: 7, seconds: 23, milliseconds: 400, microseconds: 700})  #=> "5:07:23.400700"
+
+# All fractional parts except the last are truncated
+formatter = ICU::DurationFormatting::DurationFormatter.new(locale: 'en-AU', style: :long)
+formatter.format({days: 2, hours: 7.3, minutes: 40.9, seconds:0.43})  #=> "2 days, 7 hours, 40 minutes, 0.43 seconds"
+
+# With RU locale
+formatter = ICU::DurationFormatting::DurationFormatter.new(locale: 'ru', style: :long)
+formatter.format({hours: 1, minutes: 2, seconds: 3})  #=> "1 час 2 минуты 3 секунды"
+formatter = ICU::DurationFormatting::DurationFormatter.new(locale: 'ru', style: :long)
+formatter.format({hours: 10, minutes: 20, seconds: 30})  #=> "10 часов 20 минут 30 секунд"
+formatter = ICU::DurationFormatting::DurationFormatter.new(locale: 'ru', style: :narrow)
+formatter.format({hours: 1, minutes: 2, seconds: 3})  #=> "1 ч 2 мин 3 с"
+formatter = ICU::DurationFormatting::DurationFormatter.new(locale: 'ru', style: :narrow)
+formatter.format({hours: 10, minutes: 20, seconds: 30})  #=> "10 ч 20 мин 30 с"
 ```
 
 Transliteration
@@ -136,23 +194,21 @@ Example:
 
 ```ruby
 ICU::Transliteration.transliterate('Traditional-Simplified', '沈從文') # => "沈从文"
-
 ```
 
-Tested on:
-==========
-
-Platforms:
-
-* OS X 10.6 - 10.10
-* Travis' Linux
+Locale
+------
 
-Rubies:
+Examples:
 
-- 2.5
-- 2.6
-- 2.7
-- ruby-head
+```ruby
+locale = ICU::Locale.new('en-US')
+locale.display_country('en-US') #=> "United States"
+locale.display_language('es') #=> "inglés"
+locale.display_name('es') #=> "inglés (Estados Unidos)"
+locale.display_name_with_context('en-US', [:length_short]) #=> "English (US)"
+locale.display_name_with_context('en-US', [:length_long])  #=> "English (United States)"
+```
 
 TODO:
 =====

data/lib/ffi-icu/lib.rb

@@ -500,5 +500,9 @@ module ICU
     attach_function :ucal_setDefaultTimeZone, "ucal_setDefaultTimeZone#{suffix}", [:pointer, :pointer], :int32_t
     attach_function :ucal_getDefaultTimeZone, "ucal_getDefaultTimeZone#{suffix}", [:pointer, :int32_t, :pointer], :int32_t
 
+    # ULocaleDisplayNames
+    attach_function :uldn_openForContext, "uldn_openForContext#{suffix}", [:string, :pointer, :int32_t, :pointer], :pointer
+    attach_function :uldn_localeDisplayName, "uldn_localeDisplayName#{suffix}", [:pointer, :string, :pointer, :int32_t, :pointer], :int32_t
+    attach_function :uldn_close, "uldn_close#{suffix}", [:pointer], :void
   end # Lib
 end # ICU

data/lib/ffi-icu/locale.rb

@@ -42,6 +42,11 @@ module ICU
 
     attr_reader :id
 
+    DISPLAY_CONTEXT = {
+      length_full:  512, # UDISPCTX_LENGTH_FULL  = (UDISPCTX_TYPE_DISPLAY_LENGTH<<8) + 0
+      length_short: 513  # UDISPCTX_LENGTH_SHORT = (UDISPCTX_TYPE_DISPLAY_LENGTH<<8) + 1
+    }
+
     def initialize(id)
       @id = id.to_s
     end
@@ -96,6 +101,16 @@ module ICU
       end
     end
 
+    def display_name_with_context(locale, contexts = [])
+      contexts = DISPLAY_CONTEXT.select { |context| contexts.include?(context) }.values
+
+      with_locale_display_name(@id, contexts) do |locale_display_names|
+        Lib::Util.read_uchar_buffer(256) do |buffer, status|
+          Lib.uldn_localeDisplayName(locale_display_names, locale, buffer, buffer.size, status)
+        end
+      end
+    end
+
     def display_script(locale = nil)
       locale = locale.to_s unless locale.nil?
 
@@ -220,5 +235,14 @@ module ICU
 
       Locale.new(result)
     end
+
+    def with_locale_display_name(locale, contexts)
+      pointer = FFI::MemoryPointer.new(:int, contexts.length).write_array_of_int(contexts)
+      locale_display_names = ICU::Lib.check_error { |status| ICU::Lib.uldn_openForContext(locale, pointer, contexts.length, status) }
+
+      yield locale_display_names
+    ensure
+      Lib.uldn_close(locale_display_names) if locale_display_names
+    end
   end
 end

data/lib/ffi-icu/time_formatting.rb

@@ -275,7 +275,7 @@ module ICU
         resolved_hour_cycle = @hour_cycle == :locale ? Locale.new(@locale).keyword('hours') : @hour_cycle
 
         if HOUR_CYCLE_SYMS.keys.include?(resolved_hour_cycle)
-          new_pattern_str.gsub!(/[hHkK]/, HOUR_CYCLE_SYMS[resolved_hour_cycle])
+          new_pattern_str.gsub!(/[hHkK](?=(?:[^\']|\'[^\']*\')*$)/, HOUR_CYCLE_SYMS[resolved_hour_cycle])
         end
 
         # Finally, set the new pattern onto the date time formatter

data/lib/ffi-icu/version.rb

@@ -1,3 +1,3 @@
 module ICU
-  VERSION = "0.5.0"
+  VERSION = "0.5.2"
 end

data/spec/locale_spec.rb

@@ -123,6 +123,11 @@ module ICU
           expect(Locale.new('zh_CH').display_name('fr')).to eq('chinois (Suisse)')
         end
 
+        it 'returns the name using display context' do
+          expect(Locale.new('en_US').display_name_with_context('en_HK', [:length_full])).to eq('English (Hong Kong SAR China)')
+          expect(Locale.new('en_US').display_name_with_context('en_HK', [:length_short])).to eq('English (Hong Kong)')
+        end
+
         it 'returns the script' do
           expect(Locale.new('ja_Hira_JP').display_script('en')).to eq('Hiragana')
           expect(Locale.new('ja_Hira_JP').display_script('ru')).to eq('хирагана')
@@ -140,6 +145,7 @@ module ICU
           expect(Locale.new('en_VI').display_country('ccp')).to_not be_nil
           expect(Locale.new('yue_Hant').display_language('ccp')).to_not be_nil
           expect(Locale.new('en_VI').display_name('ccp')).to_not be_nil
+          expect(Locale.new('ccp').display_name_with_context('en_VI')).to_not be_nil
           expect(Locale.new('yue_Hant').display_script('ccp')).to_not be_nil
           expect(Locale.new('en_US_POSIX').display_variant('sl')).to_not be_nil
         end

data/spec/time_spec.rb

@@ -173,6 +173,12 @@ module ICU
           end
         end
 
+        it 'for lang=fi hour_cycle=h12' do
+          t = Time.new(2021, 04, 01, 13, 05, 0, "+00:00")
+          str = TimeFormatting.format(t, locale: 'fi', zone: 'America/Los_Angeles', date: :long, time: :short, hour_cycle: 'h12')
+          expect(str).to match(/\sklo\s/)
+        end
+
         it 'works with defaults on a h12 locale' do
           t = Time.new(2021, 04, 01, 13, 05, 0, "+00:00")
           str = TimeFormatting.format(t, time: :short, date: :none, locale: 'en_AU', zone: 'UTC', hour_cycle: :locale)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ffi-icu
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.2
 platform: ruby
 authors:
 - Jari Bakken
@@ -130,8 +130,22 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Simple Ruby FFI wrappers for things I need from ICU.
-test_files: []
+test_files:
+- spec/break_iterator_spec.rb
+- spec/chardet_spec.rb
+- spec/collation_spec.rb
+- spec/duration_formatting_spec.rb
+- spec/lib/version_info_spec.rb
+- spec/lib_spec.rb
+- spec/locale_spec.rb
+- spec/normalization_spec.rb
+- spec/normalizer_spec.rb
+- spec/number_formatting_spec.rb
+- spec/spec_helper.rb
+- spec/time_spec.rb
+- spec/transliteration_spec.rb
+- spec/uchar_spec.rb