ffi-icu 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f2a47f5a65ad78641ecce2ffbbbe66ece2f1f176
-  data.tar.gz: 6b6843b7b398a028e98b1254c22392bfa2ff7394
+  metadata.gz: 529b56ff2b576d863a9e7d221572ecce3c82575b
+  data.tar.gz: ba2279127152fc41ff8ee1c5663ed10c92809a80
 SHA512:
-  metadata.gz: 70c720e7259427e54f4157f3ed0dafd868547a943a07348bbd91936927b64887b5b23fa73e1a29428a48266c70134e9872c846d2d1a947749cd19a00742aaec7
-  data.tar.gz: 74a4c5a488584a3eee26b880c7af78a308fb4a3fc4d544cc4c3a903f67858e140f90e192bce1bafdfd73929fc4a10ec937b9f79391517962f58985abd46b2dfe
+  metadata.gz: 8b5e99bb6e1ed6d3309e0b024a73a38813feaf6b642070da6037baec8c4d99b7c6f3541ede0439cb90c69efaf286a39569bfcf2c7a354178cbac5907ab6286f3
+  data.tar.gz: fcba16704ab2146ae58c452d635a69125eca9bf358c2a5d5839ff9d011ee40201cd4530a4a6b6119c7d5276be24b2e6034b096df79e362f5a85b651ac9dad723

data/README.md

@@ -80,6 +80,27 @@ Examples:
     iterator.to_a  #=> [0, 4, 5, 7, 8, 9, 10, 18, 19]
 ```
 
+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"
+```
+
 Tested on:
 ==========
 
@@ -97,7 +118,6 @@ TODO:
 =====
 
 * Useful ICU stuff:
-  - number formatting (decimal points, thousand separators, currency)
   - date formatting
 * Windows?!
 

data/Rakefile

@@ -7,6 +7,7 @@ Bundler::GemHelper.install_tasks
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec) do |spec|
   spec.pattern = 'spec/**/*_spec.rb'
+  spec.rspec_opts = '--backtrace'
 end
 
 RSpec::Core::RakeTask.new(:rcov) do |spec|

data/lib/ffi-icu.rb

@@ -39,4 +39,5 @@ require "ffi-icu/locale"
 require "ffi-icu/transliteration"
 require "ffi-icu/normalization"
 require "ffi-icu/break_iterator"
+require "ffi-icu/number_formatting"
 

data/lib/ffi-icu/lib.rb

@@ -371,5 +371,41 @@ module ICU
     attach_function :ubrk_following,      "ubrk_following#{suffix}",      [:pointer,       :int32_t], :int32_t
     attach_function :ubrk_isBoundary,     "ubrk_isBoundary#{suffix}",     [:pointer,       :int32_t], :int32_t
 
+    enum :number_format_style, [
+      :pattern_decimal,
+      :decimal,
+      :currency,
+      :percent,
+      :scientific,
+      :spellout,
+      :ordinal,
+      :duration,
+      :numbering_system,
+      :pattern_rule_based,
+      :currency_iso,
+      :currency_plural,
+      :format_style_count,
+      :default,
+      :ignore
+    ]
+    enum :number_format_attribute, [
+       :parse_int_only, :grouping_used, :decimal_always_show, :max_integer_digits, 
+       :min_integer_digits, :integer_digits, :max_fraction_digits, :min_fraction_digits, 
+       :fraction_digits, :multiplier, :grouping_size, :rounding_mode, 
+       :rounding_increment, :format_width, :padding_position, :secondary_grouping_size, 
+       :significant_digits_used, :min_significant_digits, :max_significant_digits, :lenient_parse
+    ]
+    attach_function :unum_open, "unum_open#{suffix}", [:number_format_style, :pointer, :int32_t, :string, :pointer, :pointer ], :pointer
+    attach_function :unum_close, "unum_close#{suffix}", [:pointer], :void
+    attach_function :unum_format_int32, "unum_format#{suffix}", [:pointer, :int32_t, :pointer, :int32_t, :pointer, :pointer], :int32_t
+    attach_function :unum_format_int64, "unum_formatInt64#{suffix}", [:pointer, :int64_t, :pointer, :int32_t, :pointer, :pointer], :int32_t
+    attach_function :unum_format_double, "unum_formatDouble#{suffix}", [:pointer, :double, :pointer, :int32_t, :pointer, :pointer], :int32_t
+    begin
+      attach_function :unum_format_decimal, "unum_formatDecimal#{suffix}", [:pointer, :string, :int32_t, :pointer, :int32_t, :pointer, :pointer], :int32_t
+    rescue FFI::NotFoundError
+    end
+    attach_function :unum_format_currency, "unum_formatDoubleCurrency#{suffix}", [:pointer, :double, :pointer, :pointer, :int32_t, :pointer, :pointer], :int32_t
+    attach_function :unum_set_attribute, "unum_setAttribute#{suffix}", [:pointer, :number_format_attribute, :int32_t], :void
+
   end # Lib
 end # ICU

data/lib/ffi-icu/number_formatting.rb

@@ -0,0 +1,130 @@
+require 'bigdecimal'
+
+module ICU
+  module NumberFormatting
+    @default_options = {}
+    
+    def self.create(locale, type = :decimal, options = {})
+      case type
+      when :currency
+        CurrencyFormatter.new(locale, options.delete(:style)).set_attributes(@default_options.merge(options))
+      else
+        NumberFormatter.new(locale, type).set_attributes(@default_options.merge(options))
+      end
+    end
+
+    def self.clear_default_options
+      @default_options.clear
+    end
+
+    def self.set_default_options(options)
+      @default_options.merge!(options)
+    end
+
+    def self.format_number(locale, number, options = {})
+      create(locale, :decimal, options).format(number)
+    end
+
+    def self.format_percent(locale, number, options = {})
+      create(locale, :percent, options).format(number)
+    end
+
+    def self.format_currency(locale, number, currency, options = {})
+      create(locale, :currency, options).format(number, currency)
+    end
+
+    def self.spell(locale, number, options = {})
+      create(locale, :spellout, options).format(number)
+    end
+
+    class BaseFormatter
+
+      def set_attributes(options)
+        options.each { |key, value| Lib.unum_set_attribute(@f, key, value) }
+        self
+      end
+
+      private
+
+      def make_formatter(type, locale)
+        ptr = Lib.check_error { | error| Lib.unum_open(type, FFI::MemoryPointer.new(4), 0, locale, FFI::MemoryPointer.new(4), error) }
+        FFI::AutoPointer.new(ptr, Lib.method(:unum_close))
+      end
+    end
+
+    class NumberFormatter < BaseFormatter
+      def initialize(locale, type = :decimal)
+        @f = make_formatter(type, locale)
+      end
+
+      def format(number)
+        needed_length = 0
+        out_ptr = UCharPointer.new(needed_length)
+
+        retried = false
+
+        begin
+          Lib.check_error do |error|
+            case number
+            when Float
+              needed_length = Lib.unum_format_double(@f, number, out_ptr, needed_length, nil, error)
+            when Fixnum
+              needed_length = Lib.unum_format_int32(@f, number, out_ptr, needed_length, nil, error)
+            when BigDecimal
+              string_version = number.to_s('F')
+              if Lib.respond_to? :unum_format_decimal
+                needed_length = Lib.unum_format_decimal(@f, string_version, string_version.bytesize, out_ptr, needed_length, nil, error)
+              else
+                needed_length = Lib.unum_format_double(@f, number.to_f, out_ptr, needed_length, nil, error)
+              end
+            when Bignum
+              needed_length = Lib.unum_format_int64(@f, number, out_ptr, needed_length, nil, error)
+            end
+          end
+          out_ptr.string
+        rescue BufferOverflowError
+          raise BufferOverflowError, "needed: #{needed_length}" if retried
+          out_ptr = out_ptr.resized_to needed_length
+          retried = true
+          retry
+        end
+      end
+    end # NumberFormatter
+
+    class CurrencyFormatter < BaseFormatter
+      def initialize(locale, style = :default)
+        if %w(iso plural).include?((style || '').to_s)
+          if Lib.version.to_a.first >= 53
+            style = "currency_#{style}".to_sym
+          else
+            fail "Your version of ICU (#{Lib.version.to_a.join('.')}) does not support #{style} currency formatting (supported only in version >= 53)"
+          end
+        elsif style && style.to_sym != :default
+          fail "The ffi-icu ruby gem does not support :#{default} currency formatting (only :default, :iso, and :plural)"
+        else
+          style = :currency
+        end
+        @f = make_formatter(style, locale)
+      end
+
+      def format(number, currency)
+        needed_length = 0
+        out_ptr = UCharPointer.new(needed_length)
+
+        retried = false
+
+        begin
+          Lib.check_error do |error|
+            needed_length = Lib.unum_format_currency(@f, number, UCharPointer.from_string(currency, 3), out_ptr, needed_length, nil, error)
+          end
+          out_ptr.string
+        rescue BufferOverflowError
+          raise BufferOverflowError, "needed: #{needed_length}" if retried
+          out_ptr = out_ptr.resized_to needed_length
+          retried = true
+          retry
+        end
+      end
+    end # CurrencyFormatter
+  end # Formatting
+end # ICU

data/lib/ffi-icu/transliteration.rb

@@ -23,6 +23,8 @@ module ICU
     class Transliterator
 
       def initialize(id, rules = nil, direction = :forward)
+        warn 'the ffi-icu transliteration support is broken, see https://github.com/jarib/ffi-icu/issues/15'
+
         rules_length = 0
 
         if rules

data/lib/ffi-icu/version.rb

@@ -1,3 +1,3 @@
 module ICU
-  VERSION = "0.1.3"
-end
+  VERSION = "0.1.4"
+end

data/spec/number_formatting_spec.rb

@@ -0,0 +1,71 @@
+# encoding: UTF-8
+
+require 'spec_helper'
+
+module ICU
+  module NumberFormatting
+    describe 'NumberFormatting' do
+      it 'should format a simple integer' do
+        NumberFormatting.format_number("en", 1).should == "1"
+        NumberFormatting.format_number("en", 1_000).should == "1,000"
+        NumberFormatting.format_number("de-DE", 1_000_000).should == "1.000.000"
+      end
+
+      it 'should format a float' do
+        NumberFormatting.format_number("en", 1.0).should == "1"
+        NumberFormatting.format_number("en", 1.123).should == "1.123"
+        NumberFormatting.format_number("en", 1_000.1238).should == "1,000.124"
+        NumberFormatting.format_number("en", 1_000.1238, max_fraction_digits: 4).should == "1,000.1238"
+        NumberFormatting.set_default_options(fraction_digits: 5)
+        NumberFormatting.format_number("en", 1_000.1238).should == "1,000.12380"
+        NumberFormatting.clear_default_options
+      end
+
+      it 'should format a decimal' do
+        NumberFormatting.format_number("en", BigDecimal.new("10000.123")).should == "10,000.123"
+      end
+
+      it 'should format a currency' do
+        NumberFormatting.format_currency("en", 123.45, 'USD').should == "$123.45"
+        NumberFormatting.format_currency("en", 123_123.45, 'USD').should == "$123,123.45"
+        NumberFormatting.format_currency("de-DE", 123_123.45, 'EUR').should == "123.123,45\u{A0}€"
+      end
+
+      it 'should format a percent' do
+        NumberFormatting.format_percent("en", 1.1).should == "110%"
+        NumberFormatting.format_percent("da", 0.15).should == "15\u{A0}%"
+        NumberFormatting.format_percent("da", -0.1545, max_fraction_digits: 10).should == "-15,45\u{A0}%"
+      end
+
+      it 'should spell numbers' do
+        NumberFormatting.spell("en_US", 1_000).should == 'one thousand'
+        NumberFormatting.spell("de-DE", 123.456).should == "ein\u{AD}hundert\u{AD}drei\u{AD}und\u{AD}zwanzig Komma vier fünf sechs"
+      end
+
+      it 'should be able to re-use number formatter objects' do
+        numf = NumberFormatting.create('fr-CA')
+        numf.format(1_000).should == "1\u{A0}000"
+        numf.format(1_000.123).should == "1\u{A0}000,123"
+      end
+
+      it 'should be able to re-use currency formatter objects' do
+        curf = NumberFormatting.create('en-US', :currency)
+        curf.format(1_000.12, 'USD').should == "$1,000.12"
+      end
+
+      it 'should allow for various styles of currency formatting if the version is new enough' do
+        if ICU::Lib.version.to_a.first >= 53
+          curf = NumberFormatting.create('en-US', :currency, style: :iso)
+          curf.format(1_000.12, 'USD').should == "USD1,000.12"
+          curf = NumberFormatting.create('en-US', :currency, style: :plural)
+          curf.format(1_000.12, 'USD').should == "1,000.12 US dollars"
+          expect { NumberFormatting.create('en-US', :currency, style: :fake) }.to raise_error(StandardError)
+        else
+          curf = NumberFormatting.create('en-US', :currency, style: :default)
+          curf.format(1_000.12, 'USD').should == '$1,000.12'
+          expect { NumberFormatting.create('en-US', :currency, style: :iso) }.to raise_error(StandardError)
+        end
+      end
+    end
+  end # NumberFormatting
+end # ICU

data/spec/spec_helper.rb

@@ -7,4 +7,7 @@ require 'rspec'
 
 RSpec.configure do |config|
 
+  if ENV['TRAVIS']
+    config.filter_run_excluding broken: true
+  end
 end

data/spec/transliteration_spec.rb

@@ -3,7 +3,7 @@
 require "spec_helper"
 
 module ICU
-  describe Transliteration::Transliterator do
+  describe Transliteration::Transliterator, broken: true do
     def transliterator_for(*args)
       Transliteration::Transliterator.new(*args)
     end
@@ -21,7 +21,7 @@ module ICU
     end
   end # Transliterator
 
-  describe Transliteration do
+  describe Transliteration, broken: true do
     it "should provide a list of available ids" do
       ids = ICU::Transliteration.available_ids
       ids.should be_kind_of(Array)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ffi-icu
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Jari Bakken
@@ -86,6 +86,7 @@ files:
 - lib/ffi-icu/lib/util.rb
 - lib/ffi-icu/locale.rb
 - lib/ffi-icu/normalization.rb
+- lib/ffi-icu/number_formatting.rb
 - lib/ffi-icu/transliteration.rb
 - lib/ffi-icu/uchar.rb
 - lib/ffi-icu/version.rb
@@ -96,6 +97,7 @@ files:
 - spec/lib_spec.rb
 - spec/locale_spec.rb
 - spec/normalization_spec.rb
+- spec/number_formatting_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
 - spec/transliteration_spec.rb
@@ -133,8 +135,8 @@ test_files:
 - spec/lib_spec.rb
 - spec/locale_spec.rb
 - spec/normalization_spec.rb
+- spec/number_formatting_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
 - spec/transliteration_spec.rb
 - spec/uchar_spec.rb
-has_rdoc: