ffi-icu 0.5.3 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b8a17a4a005b3b00d2620f11efc9d766b9b5d5c9af0de255f0fd172c9922fa3
-  data.tar.gz: e7987937796171479989cd08e0e4102e45294ef0b5df7251b4e41f867b1dc19e
+  metadata.gz: 006a4ec712fa21e3d72a80ada32f5d89dd47add0bf007efef2898c055075a37e
+  data.tar.gz: b79b4d2b4d4bcf359d58e30c8cf3d3abf1143d2d80fc0b030b19686a11238ed2
 SHA512:
-  metadata.gz: 36d49d10b1bddb4b0b809b50e8d8be7294a9a7e3f8566dc344f57ea3538aa6ed9c035d41866b5213bdb930169d4f731f10c47734bfb956a99b7a64d6f16ab831
-  data.tar.gz: 6f3e79cabd9351488e264e2d3bf545cc21447c7daece998c0c346c063213fb62b03f3eb8ea20388c3f4d280b249536fdf57d7d2bd88fa25dca9a973487ac74a4
+  metadata.gz: 4b557fe887c73e55dc6efa966dd9ed29d8f700ec6352fd44b6e7b86a170807089ce98dbca1428be020ff98fe9bfdf9c884e174b24d17176ff3fb75afd9c6e94c
+  data.tar.gz: 4d4a6e5c7eb7821814dc3f3a80585da9ee094097352c3a6c4889731f90dc299e32c48e4f3b62c457c516c0968f4f2ef41b78320e881291a3e7a58b1198faeb5b

data/Gemfile

@@ -1,3 +1,13 @@
 source 'https://rubygems.org'
 
 gemspec
+
+group :development, :test do
+  gem 'rake', '>= 12.3.3'
+  gem 'rspec', '~> 3.13'
+  gem 'rubocop', '~> 1.86'
+  gem 'rubocop-minitest', '~> 0.39'
+  gem 'rubocop-packaging', '~> 0.6'
+  gem 'rubocop-rspec', '~> 3.9'
+  gem 'rubocop-rspec_rails', '~> 2.32'
+end

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010-2015 Jari Bakken
+Copyright (c) 2010-2024 Erick Guan, Damian Nelson
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,22 +1,23 @@
-ffi-icu [![Build Status](https://app.travis-ci.com/erickguan/ffi-icu.svg?branch=master)](https://app.travis-ci.com/erickguan/ffi-icu)
-=======
+# ffi-icu
 
-Simple FFI wrappers for ICU. Checkout the renovated [ICU gem](https://github.com/fantasticfears/icu4r) instead which supports various of encoding and distributed with packaged source. FFI-ICU needs some love with ICU gem's transcoding method.
+FFI wrappers for [International Components for Unicode (ICU)][icu].
+ICU provides comprehensive localization and security features.
+Majority personal computing devices, server operating systems and web browsers use ICU.
+ICU builds on top of Unicode's Common Locale Data Repository (CLDR).
 
-Gem
----
+## Gem
 
 [Rubygem](http://rubygems.org/gems/ffi-icu "ffi-icu")
 
-    gem install ffi-icu
+```
+gem install ffi-icu
+```
 
-Dependencies
-------------
+## Dependencies
 
 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.:
+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.:
 
 ```sh
 $ export FFI_ICU_LIB="icui18n.so"
@@ -24,11 +25,9 @@ $ export FFI_ICU_VERSION_SUFFIX="_3_8"
 $ ruby -r ffi-icu program.rb
 ```
 
-Features
-========
+# Features
 
-Character Encoding Detection
-----------------------------
+## Character Encoding Detection
 
 Examples:
 
@@ -45,12 +44,9 @@ detector = ICU::CharDet::Detector.new
 detector.detect(str) => #<struct ICU::CharDet::Detector::Match ...>
 ```
 
-Why not just use rchardet?
-
 * speed
 
-Locale Sensitive Collation
---------------------------
+## Locale Sensitive Collation
 
 Examples:
 
@@ -67,8 +63,7 @@ collator.greater?("z", "a") #=> true
 collator.collate(%w[å æ ø]) #=> ["æ", "ø", "å"]
 ```
 
-Text Boundary Analysis
-----------------------
+## Text Boundary Analysis
 
 Examples:
 
@@ -78,8 +73,7 @@ iterator.text = "This is a sentence."
 iterator.to_a  #=> [0, 4, 5, 7, 8, 9, 10, 18, 19]
 ```
 
-Number/Currency Formatting
---------------------------
+## Number/Currency Formatting
 
 Examples:
 
@@ -99,8 +93,7 @@ curf = ICU::NumberFormatting.create('en-US', :currency)
 curf.format(1234.56, 'USD') #=> "$1,234.56"
 ```
 
-Time Formatting/Parsing
------------------------
+## Time Formatting/Parsing
 
 Examples:
 
@@ -130,8 +123,7 @@ formatter = ICU::TimeFormatting.create(:locale => 'cs_CZ', :date => :pattern, :t
 formatter.format(Time.now)  #=> "2015"
 ```
 
-Duration Formatting
--------------------
+## Duration Formatting
 
 ```ruby
 # What the various styles look like
@@ -187,8 +179,7 @@ formatter = ICU::DurationFormatting::DurationFormatter.new(locale: 'ru', style:
 formatter.format({hours: 10, minutes: 20, seconds: 30})  #=> "10 ч 20 мин 30 с"
 ```
 
-Transliteration
----------------
+## Transliteration
 
 Example:
 
@@ -196,8 +187,7 @@ Example:
 ICU::Transliteration.transliterate('Traditional-Simplified', '沈從文') # => "沈从文"
 ```
 
-Locale
-------
+## Locale
 
 Examples:
 
@@ -210,24 +200,4 @@ locale.display_name_with_context('en-US', [:length_short]) #=> "English (US)"
 locale.display_name_with_context('en-US', [:length_long])  #=> "English (United States)"
 ```
 
-TODO:
-=====
-
-* Any other useful part of ICU?
-* Windows?!
-
-Note on Patches/Pull Requests
-=============================
-
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
-
-Copyright
-=========
-
-Copyright (c) 2010-2015 Jari Bakken. See LICENSE for details.
+[icu]: https://github.com/unicode-org/icu

data/Rakefile

@@ -15,14 +15,13 @@ RSpec::Core::RakeTask.new(:rcov) do |spec|
   spec.rcov = true
 end
 
-task :default => :spec
+task default: :spec
 
 begin
-  require 'yard'
+  require('yard')
   YARD::Rake::YardocTask.new
 rescue LoadError
-  task :yardoc do
-    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  task(:yardoc) do
+    abort('YARD is not available. In order to run yardoc, you must: sudo gem install yard')
   end
 end
-

data/ffi-icu.gemspec

@@ -1,26 +1,35 @@
-require File.expand_path("../lib/ffi-icu/version", __FILE__)
-
-Gem::Specification.new do |s|
-  s.name                      = %q{ffi-icu}
-  s.version                   = ICU::VERSION
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors                   = ["Jari Bakken"]
-  s.date                      = %q{2019-10-15}
-  s.licenses                  = ['MIT']
-  s.description               = %q{Provides charset detection, locale sensitive collation and more. Depends on libicu.}
-  s.email                     = %q{jari.bakken@gmail.com}
-  s.extra_rdoc_files          = ["LICENSE", "README.md"]
-  s.files                     = `git ls-files`.split("\n")
-  s.test_files                = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables               = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths             = ["lib"]
-
-  s.homepage                  = %q{http://github.com/jarib/ffi-icu}
-  s.rdoc_options              = ["--charset=UTF-8"]
-  s.summary                   = %q{Simple Ruby FFI wrappers for things I need from ICU.}
-
-  s.add_runtime_dependency "ffi", "~> 1.0", ">= 1.0.9"
-  s.add_development_dependency 'rspec', '~> 3.9'
-  s.add_development_dependency "rake", [">= 12.3.3"]
+require_relative 'lib/ffi-icu/version'
+
+Gem::Specification.new do |spec|
+  spec.name        = 'ffi-icu'
+  spec.version     = ICU::VERSION
+  spec.platform    = Gem::Platform::RUBY # rely on FFI library, but being platform-independent
+
+  spec.required_rubygems_version = Gem::Requirement.new('>= 2.5.0')
+  spec.authors     = ['Erick Guan', 'Damian Nelson']
+  spec.licenses    = ['MIT']
+  spec.summary     = 'Ruby FFI wrappers for International Components for Unicode (ICU).'
+  spec.description = 'Provides charset detection, transiliteration, locale sensitive collation and more. ' \
+                     'Depends on libicu. ICU operates on CLDR data.'
+  spec.email       = 'erickguanst@gmail.com'
+  spec.homepage    = 'https://github.com/erickguan/ffi-icu'
+
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = "#{spec.homepage}/blob/master/CHANGELOG.md"
+
+  spec.files = Dir['lib/**/*.rb', 'Gemfile', 'ffi-icu.gemspec', 'Rakefile']
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.extra_rdoc_files = ['LICENSE', 'README.md']
+  spec.rdoc_options = ['--charset=UTF-8']
+
+  spec.required_ruby_version = '>= 3.2.0'
+
+  spec.add_dependency('bigdecimal', '~> 3.1')
+  spec.add_dependency('ffi', '~> 1.0', '>= 1.0.9')
+  spec.add_dependency('stringio', '~> 3.0')
+
+  spec.metadata['rubygems_mfa_required'] = 'true'
 end

data/lib/ffi-icu/break_iterator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ICU
   class BreakIterator
     include Enumerable
@@ -8,7 +10,7 @@ module ICU
 
     def self.available_locales
       (0...Lib.ubrk_countAvailable).map do |idx|
-        Lib.ubrk_getAvailable idx
+        Lib.ubrk_getAvailable(idx)
       end
     end
 
@@ -20,25 +22,25 @@ module ICU
     def text=(str)
       @text = str
 
-      Lib.check_error { |err|
-        Lib.ubrk_setText @iterator, UCharPointer.from_string(str), str.jlength, err
-      }
+      Lib.check_error do |err|
+        Lib.ubrk_setText(@iterator, UCharPointer.from_string(str), str.size, err)
+      end
     end
 
-    def each(&blk)
+    def each
       return to_enum(:each) unless block_given?
 
       int = first
 
       while int != DONE
-        yield int
+        yield(int)
         int = self.next
       end
 
       self
     end
 
-    def each_substring(&blk)
+    def each_substring
       return to_enum(:each_substring) unless block_given?
 
       # each_char needed for 1.8, where String#[] works on bytes, not characters
@@ -46,7 +48,7 @@ module ICU
       low   = first
 
       while (high = self.next) != DONE
-        yield chars[low...high].join
+        yield(chars[low...high].join)
         low = high
       end
 
@@ -58,36 +60,35 @@ module ICU
     end
 
     def next
-      Lib.ubrk_next @iterator
+      Lib.ubrk_next(@iterator)
     end
 
     def previous
-      Lib.ubrk_next @iterator
+      Lib.ubrk_next(@iterator)
     end
 
     def first
-      Lib.ubrk_first @iterator
+      Lib.ubrk_first(@iterator)
     end
 
     def last
-      Lib.ubrk_last @iterator
+      Lib.ubrk_last(@iterator)
     end
 
     def preceding(offset)
-      Lib.ubrk_preceding @iterator, Integer(offset)
+      Lib.ubrk_preceding(@iterator, Integer(offset))
     end
 
     def following(offset)
-      Lib.ubrk_following @iterator, Integer(offset)
+      Lib.ubrk_following(@iterator, Integer(offset))
     end
 
     def current
-      Lib.ubrk_current @iterator
+      Lib.ubrk_current(@iterator)
     end
 
     def boundary?(offset)
       Lib.ubrk_isBoundary(@iterator, Integer(offset)) != 0
     end
-
-  end # BreakIterator
-end # ICU
+  end
+end

data/lib/ffi-icu/chardet.rb

@@ -1,20 +1,21 @@
+# frozen_string_literal: true
+
 module ICU
   module CharDet
-
     def self.detect(string)
-      Detector.new.detect string
+      Detector.new.detect(string)
     end
 
     class Detector
       Match = Struct.new(:name, :confidence, :language)
 
       def initialize
-        ptr = Lib.check_error { |err| Lib.ucsdet_open err }
+        ptr = Lib.check_error { |err| Lib.ucsdet_open(err) }
         @detector = FFI::AutoPointer.new(ptr, Lib.method(:ucsdet_close))
       end
 
       def input_filter_enabled?
-        Lib.ucsdet_isInputFilterEnabled @detector
+        Lib.ucsdet_isInputFilterEnabled(@detector)
       end
 
       def input_filter_enabled=(bool)
@@ -23,7 +24,7 @@ module ICU
 
       def declared_encoding=(str)
         Lib.check_error do |ptr|
-          Lib.ucsdet_setDeclaredEncoding(@detector, str, str.bytesize, ptr)
+          Lib.ucsdet_setDeclaredEncoding(@detector, str, str.size, ptr)
         end
       end
 
@@ -37,7 +38,7 @@ module ICU
       def detect_all(str)
         set_text(str)
 
-        matches_found_ptr = FFI::MemoryPointer.new :int32_t
+        matches_found_ptr = FFI::MemoryPointer.new(:int32_t)
         array_ptr = Lib.check_error do |status|
           Lib.ucsdet_detectAll(@detector, matches_found_ptr, status)
         end
@@ -71,14 +72,12 @@ module ICU
         result
       end
 
-      def set_text(text)
+      def set_text(text) # rubocop:disable Naming/AccessorMethodName
         Lib.check_error do |status|
           data = FFI::MemoryPointer.from_string(text)
-          Lib.ucsdet_setText(@detector, data, text.bytesize, status)
+          Lib.ucsdet_setText(@detector, data, text.size, status)
         end
       end
-
-    end # Detector
-  end # CharDet
-end # ICU
-
+    end
+  end
+end

data/lib/ffi-icu/collation.rb

@@ -1,37 +1,38 @@
+# frozen_string_literal: true
+
 module ICU
   module Collation
-
     ATTRIBUTES = {
-        french_collation: 0,
-        alternate_handling: 1,
-        case_first: 2,
-        case_level: 3,
-        normalization_mode: 4,
-        strength: 5,
-        hiragana_quaternary_mode: 6,
-        numeric_collation: 7,
+      :french_collation => 0,
+      :alternate_handling => 1,
+      :case_first => 2,
+      :case_level => 3,
+      :normalization_mode => 4,
+      :strength => 5,
+      :hiragana_quaternary_mode => 6,
+      :numeric_collation => 7
     }.freeze
 
     ATTRIBUTE_VALUES = {
-        nil => -1,
-        primary: 0,
-        secondary: 1,
-        default_strength: 2,
-        tertiary: 2,
-        quaternary: 3,
-        identical: 15,
-
-        false => 16,
-        true => 17,
-
-        shifted: 20,
-        non_ignorable: 21,
-
-        lower_first: 24,
-        upper_first: 25,
+      nil => -1,
+      :primary => 0,
+      :secondary => 1,
+      :default_strength => 2,
+      :tertiary => 2,
+      :quaternary => 3,
+      :identical => 15,
+
+      false => 16,
+      true => 17,
+
+      :shifted => 20,
+      :non_ignorable => 21,
+
+      :lower_first => 24,
+      :upper_first => 25
     }.freeze
 
-    ATTRIBUTE_VALUES_INVERSE = Hash[ATTRIBUTE_VALUES.map {|k,v| [v, k]}].freeze
+    ATTRIBUTE_VALUES_INVERSE = ATTRIBUTE_VALUES.to_h { |k, v| [v, k] }.freeze
 
     def self.collate(locale, arr)
       Collator.new(locale).collate(arr)
@@ -40,7 +41,7 @@ module ICU
     def self.keywords
       enum_ptr = Lib.check_error { |error| Lib.ucol_getKeywords(error) }
       keywords = Lib.enum_ptr_to_array(enum_ptr)
-      Lib.uenum_close enum_ptr
+      Lib.uenum_close(enum_ptr)
 
       hash = {}
       keywords.each do |keyword|
@@ -54,7 +55,7 @@ module ICU
 
     def self.available_locales
       (0...Lib.ucol_countAvailable).map do |idx|
-        Lib.ucol_getAvailable idx
+        Lib.ucol_getAvailable(idx)
       end
     end
 
@@ -73,55 +74,51 @@ module ICU
       def compare(a, b)
         Lib.ucol_strcoll(
           @c,
-          UCharPointer.from_string(a), a.jlength,
-          UCharPointer.from_string(b), b.jlength
+          UCharPointer.from_string(a), a.size,
+          UCharPointer.from_string(b), b.size
         )
       end
 
       def greater?(a, b)
-        Lib.ucol_greater(@c, UCharPointer.from_string(a), a.jlength,
-                             UCharPointer.from_string(b), b.jlength)
+        Lib.ucol_greater(@c, UCharPointer.from_string(a), a.size,
+                         UCharPointer.from_string(b), b.size)
       end
 
       def greater_or_equal?(a, b)
-        Lib.ucol_greaterOrEqual(@c, UCharPointer.from_string(a), a.jlength,
-                                    UCharPointer.from_string(b), b.jlength)
+        Lib.ucol_greaterOrEqual(@c, UCharPointer.from_string(a), a.size,
+                                UCharPointer.from_string(b), b.size)
       end
 
       def equal?(*args)
         return super() if args.empty?
 
-        if args.size != 2
-          raise ArgumentError, "wrong number of arguments (#{args.size} for 2)"
-        end
+        raise(ArgumentError, "wrong number of arguments (#{args.size} for 2)") if args.size != 2
 
         a, b = args
 
-        Lib.ucol_equal(@c, UCharPointer.from_string(a), a.jlength,
-                           UCharPointer.from_string(b), b.jlength)
+        Lib.ucol_equal(@c, UCharPointer.from_string(a), a.size,
+                       UCharPointer.from_string(b), b.size)
       end
 
       def collate(sortable)
-        unless sortable.respond_to?(:sort)
-          raise ArgumentError, "argument must respond to :sort with arity of 2"
-        end
+        raise(ArgumentError, 'argument must respond to :sort with arity of 2') unless sortable.respond_to?(:sort)
 
-        sortable.sort { |a, b| compare a, b }
+        sortable.sort { |a, b| compare(a, b) }
       end
 
       def rules
         @rules ||= begin
           length = FFI::MemoryPointer.new(:int)
           ptr = Lib.ucol_getRules(@c, length)
-          ptr.read_array_of_uint16(length.read_int).pack("U*")
+          ptr.read_array_of_uint16(length.read_int).pack('U*')
         end
       end
 
       def collation_key(string)
         ptr = UCharPointer.from_string(string)
-        size = Lib.ucol_getSortKey(@c, ptr, string.jlength, nil, 0)
+        size = Lib.ucol_getSortKey(@c, ptr, string.size, nil, 0)
         buffer = FFI::MemoryPointer.new(:char, size)
-        Lib.ucol_getSortKey(@c, ptr, string.jlength, buffer, size)
+        Lib.ucol_getSortKey(@c, ptr, string.size, buffer, size)
         buffer.read_bytes(size - 1)
       end
 
@@ -135,22 +132,28 @@ module ICU
         Lib.check_error do |error|
           Lib.ucol_setAttribute(@c, ATTRIBUTES[attribute], ATTRIBUTE_VALUES[value], error)
         end
-        value
       end
 
       # create friendly named methods for setting attributes
       ATTRIBUTES.each_key do |attribute|
-        class_eval <<-CODE
-            def #{attribute}
-              self[:#{attribute}]
-            end
-
-            def #{attribute}=(value)
-              self[:#{attribute}] = value
-            end
+        class_eval <<-CODE, __FILE__, __LINE__ + 1
+          # def case_first
+          #   self[:case_first]
+          # end
+          #
+          # def case_first=(value)
+          #   self[:case_first] = value
+          # end
+
+          def #{attribute}
+            self[:#{attribute}]
+          end
+
+          def #{attribute}=(value)
+            self[:#{attribute}] = value
+          end
         CODE
       end
-    end # Collator
-
-  end # Collate
-end # ICU
+    end
+  end
+end