idnx 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e9eef708b35b383a3270b44ca3670e72d92bd3c29e89ecf2df9ba0ded94a144
-  data.tar.gz: 4c08ebc4dc52aa8ccf6fe5b1c53c17e7eb2a6e07d11c7d689f049d757d6de379
+  metadata.gz: f0b5da39f881e947e1c29b5fbe5eb3647071e30316c817e6b87eeeba1c34af90
+  data.tar.gz: 3d5afd606ab46635d3db135952efae893963c460d87487302e83f3925b49143c
 SHA512:
-  metadata.gz: 960e68d02443bf62b55290187f1785e16b9d16005107ce3b3f7db4ee016c1c91dd867de57d04f8cb92db18081a7b01499ac20fa8082f76ba884e8702806ff8ea
-  data.tar.gz: 0be4f68aa311208b5652e2773192487cec450e6ff604d04a1d72f662136309928bd405a095f36eb4dc6f9180dafa10d1f90fe4f847225dd6288b5a2d4aeab29f
+  metadata.gz: a4c2583fc53027a4b37a6727f6ea0b40fe49ac84db9f1e35f687a79ff6924831e23d2bc259dc6fb86b0e6e89796fc05cf1a0b2901dbe9f8cfac02f7fb2a95bef
+  data.tar.gz: c28933fb3ae97ee2fe8c1eb9f80df6dff5fb66a063767db604f9ee7e9c49ff6ee5ac803f57c23488a6d3cc538f9d70c9bd5dabd9538df9a7a38545c5ddda33e8

data/CHANGELOG.md

@@ -0,0 +1,35 @@
+## [Unreleased]
+
+## [0.1.2] - 2026-11-11
+
+* added missing license file.
+* skip warnings when falling back to pure ruby version.
+* remove pure ruby dead code for decoding.
+
+## [0.1.1] - 2021-10-03
+
+Added missing RBS sig files to the gemspec.
+
+## [0.1.0] - 2021-09-04
+
+### improvements
+
+It ships RBS signatures for the main public API.
+
+### compliance
+
+`idnx` ships with a pure ruby punycode implementation (IDNA 2003), which will get loaded when `libidn2` isn't installed in the system. This was necessary for license compatibility, given that Apache 2.0 projects can rely on GPL dependencies (such as `libidn2`) but nnot exclusively.
+
+## [0.0.1] - 2021-06-11
+
+This is the initial release.
+
+### Features
+
+`idnx` ships with a single function, which translate Innternational domain names into Punycode names, which can be used for DNS requests:
+
+```ruby
+require "idnx"
+
+Idnx.to_punycode("bücher.de") #=> "xn--bcher-kva.de"
+```

data/README.md

@@ -1,7 +1,8 @@
 # Idnx
 
+[![Gem Version](https://badge.fury.io/rb/idnx.svg)](http://rubygems.org/gems/idnx)
 [![CI](https://github.com/HoneyryderChuck/idnx/actions/workflows/test.yml/badge.svg)](https://github.com/HoneyryderChuck/idnx/actions/workflows/test.yml)
-
+[![coverage report](https://honeyryderchuck.github.io/idnx/merged/badge_total.svg)](https://honeyryderchuck.github.io/idnx/merged/#_AllFiles)
 
 
 `idnx` provides a Ruby API for decoding Internationalized domain names into Punycode.

data/lib/idnx/idn2.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Idnx
-  module Lib
+  module Idn2
     extend FFI::Library
 
     if FFI::Platform.mac?
@@ -55,4 +55,6 @@ module Idnx
       ascii
     end
   end
+
+  LIB = Idn2
 end

data/lib/idnx/ruby.rb

@@ -8,7 +8,6 @@ module Idnx
       Punycode.encode_hostname(hostname)
     end
 
-    # :nocov:
     # -*- coding: utf-8 -*-
     #--
     # punycode.rb - PunyCode encoder for the Domain Name library
@@ -78,12 +77,14 @@ module Idnx
       # Returns the numeric value of a basic code point (for use in
       # representing integers) in the range 0 to base-1, or nil if cp
       # is does not represent a value.
-      DECODE_DIGIT = {}.tap do |map|
+      DECODE_DIGIT = begin
+        map = {} #: Hash[Integer, Integer]
         # ASCII A..Z map to 0..25
         # ASCII a..z map to 0..25
         (0..25).each { |i| map[65 + i] = map[97 + i] = i }
         # ASCII 0..9 map to 26..35
         (26..35).each { |i| map[22 + i] = i }
+        map
       end
 
       # Returns the basic code point whose value (when used for
@@ -109,7 +110,7 @@ module Idnx
 
       # Encode a +string+ in Punycode
       def encode(string)
-        input = string.unpack("U*")
+        input = string.unpack("U*") #: Array[Integer]
         output = +""
 
         # Initialize the state
@@ -201,99 +202,6 @@ module Idnx
           end
         end.join(DOT)
       end
-
-      # Decode a +string+ encoded in Punycode
-      def decode(string)
-        # Initialize the state
-        n = INITIAL_N
-        i = 0
-        bias = INITIAL_BIAS
-
-        if j = string.rindex(DELIMITER)
-          b = string[0...j]
-
-          b.match(RE_NONBASIC) &&
-            raise(ArgumentError, "Illegal character is found in basic part: #{string.inspect}")
-
-          # Handle the basic code points
-
-          output = b.unpack("U*")
-          u = string[(j + 1)..-1]
-        else
-          output = []
-          u = string
-        end
-
-        # Main decoding loop: Start just after the last delimiter if any
-        # basic code points were copied; start at the beginning
-        # otherwise.
-
-        input = u.unpack("C*")
-        input_length = input.length
-        h = 0
-        out = output.length
-
-        while h < input_length
-          # Decode a generalized variable-length integer into delta,
-          # which gets added to i.  The overflow checking is easier
-          # if we increase i as we go, then subtract off its starting
-          # value at the end to obtain delta.
-
-          oldi = i
-          w = 1
-          k = BASE
-
-          loop do
-            (digit = DECODE_DIGIT[input[h]]) ||
-              raise(ArgumentError, "Illegal character is found in non-basic part: #{string.inspect}")
-            h += 1
-            i += digit * w
-            raise BufferOverflowError if i > MAXINT
-
-            t = k <= bias ? TMIN : k - bias >= TMAX ? TMAX : k - bias
-            break if digit < t
-
-            w *= BASE - t
-            raise BufferOverflowError if w > MAXINT
-
-            k += BASE
-            (h < input_length) || raise(ArgumentError, "Malformed input given: #{string.inspect}")
-          end
-
-          # Adapt the bias
-          delta = oldi == 0 ? i / DAMP : (i - oldi) >> 1
-          delta += delta / (out + 1)
-          bias = 0
-          while delta > CUTOFF
-            delta /= LOBASE
-            bias += BASE
-          end
-          bias += (LOBASE + 1) * delta / (delta + SKEW)
-
-          # i was supposed to wrap around from out+1 to 0, incrementing
-          # n each time, so we'll fix that now:
-
-          q, i = i.divmod(out + 1)
-          n += q
-          raise BufferOverflowError if n > MAXINT
-
-          # Insert n at position i of the output:
-
-          output[i, 0] = n
-
-          out += 1
-          i += 1
-        end
-        output.pack("U*")
-      end
-
-      # Decode a hostname using IDN/Punycode algorithms
-      def decode_hostname(hostname)
-        hostname.gsub(/(\A|#{Regexp.quote(DOT)})#{Regexp.quote(PREFIX)}([^#{Regexp.quote(DOT)}]*)/o) do
-          Regexp.last_match(1) << decode(Regexp.last_match(2))
-        end
-      end
     end
-    # :nocov:
   end
 end

data/lib/idnx/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Idnx
-  VERSION = "0.1.0"
+  VERSION = "0.1.2"
 end

data/lib/idnx/windows.rb

@@ -3,7 +3,7 @@
 require "win32ole"
 
 module Idnx
-  module Lib
+  module Windows
     extend FFI::Library
 
     ffi_lib "Normaliz.dll"
@@ -100,6 +100,9 @@ module Idnx
 
       unicode = utf8_ptr.read_string(utf8_ptr.size)
       unicode.strip! # remove null-byte
+      unicode
     end
   end
+
+  LIB = Windows
 end

data/lib/idnx.rb

@@ -9,7 +9,7 @@ module Idnx
   module_function
 
   def to_punycode(hostname)
-    Lib.lookup(hostname)
+    LIB.lookup(hostname)
   end
 end
 
@@ -21,6 +21,6 @@ else
   rescue LoadError
     # fallback to pure ruby punycode 2003 implementation
     require "idnx/ruby"
-    Idnx::Lib = Idnx::Ruby
+    LIB = Idnx::Ruby
   end
 end

data/sig/idnx.rbs

@@ -0,0 +1,93 @@
+module Idnx
+  VERSION: String
+
+  class Error < StandardError
+  end
+
+  module Idn2
+    extend FFI::Library
+
+    VERSION: String
+    IDN2_OK: Integer
+    IDN2_NFC_INPUT: Integer
+    IDN2_TRANSITIONAL: Integer
+    IDN2_NONTRANSITIONAL: Integer
+
+    FLAGS: Integer
+
+    def self?.lookup: (String hostname) -> String
+
+    def self?.idn2_lookup_ul: (String hostname, FFI::Pointer?, Integer flags) -> Integer
+
+
+    def self?.idn2_strerror: (Integer code) -> String
+
+    def self?.idn2_free: (FFI::Pointer?) -> void
+
+    def self?.idn2_check_version: (FFI::Pointer?) -> void
+  end
+
+  module Windows
+    extend FFI::Library
+
+    IDN_MAX_LENGTH: Integer
+    MB_ERR_INVALID_CHARS: Integer
+
+    ERROR_INSUFFICIENT_BUFFER: Integer
+    ERROR_INVALID_FLAGS: Integer
+    ERROR_INVALID_NAME: Integer
+    ERROR_INVALID_PARAMETER: Integer
+    ERROR_NO_UNICODE_TRANSLATION: Integer
+
+    def self?.lookup: (String hostname) -> String
+
+    def self?.IdnToAscii: (Integer, FFI::Pointer?, Integer, FFI::Pointer?, Integer) -> Integer
+
+    def self?.MultiByteToWideChar: (Integer, Integer, String, Integer, FFI::Pointer?, Integer) -> Integer
+
+    def self?.WideCharToMultiByte: (Integer, Integer, FFI::Pointer?, Integer, FFI::Pointer?, Integer, FFI::Pointer?, FFI::Pointer?) -> Integer
+  end
+
+  module Ruby
+    def self?.lookup: (String hostname) -> String
+
+    module Punycode
+      BASE: Integer
+      TMIN: Integer
+      TMAX: Integer
+      SKEW: Integer
+      DAMP: Integer
+      INITIAL_BIAS: Integer
+      INITIAL_N: Integer
+      DELIMITER: String
+
+      MAXINT: Integer
+
+      LOBASE: Integer
+      CUTOFF: Integer
+
+      RE_NONBASIC: Regexp
+
+      DECODE_DIGIT: Hash[Integer, Integer]
+
+      ENCODE_DIGIT: ^(Integer d, bool flag) -> String
+
+      DOT: String
+      PREFIX: String
+
+      class ArgumentError < ::ArgumentError
+      end
+
+      class BufferOverflowError < ArgumentError
+      end
+
+      def self?.encode: (String string) -> String
+
+      def self?.encode_hostname: (String hostname) -> String
+    end
+  end
+
+  def self?.to_punycode: (String hostname) -> String
+
+  LIB: singleton(Idn2) | singleton(Windows) | singleton(Ruby)
+end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: idnx
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - HoneyryderChuck
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-04 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -35,6 +34,7 @@ extra_rdoc_files:
 - LICENSE.txt
 - README.md
 files:
+- CHANGELOG.md
 - LICENSE.txt
 - README.md
 - lib/idnx.rb
@@ -42,13 +42,15 @@ files:
 - lib/idnx/ruby.rb
 - lib/idnx/version.rb
 - lib/idnx/windows.rb
+- sig/idnx.rbs
 homepage: https://github.com/honeyryderchuck/idnx
-licenses: []
+licenses:
+- Apache 2.0
 metadata:
   homepage_uri: https://github.com/honeyryderchuck/idnx
   source_code_uri: https://github.com/honeyryderchuck/idnx
   changelog_uri: https://github.com/honeyryderchuck/idnx/-/blob/master/CHANGELOG.md
-post_install_message:
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -63,8 +65,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
-signing_key:
+rubygems_version: 4.0.20
 specification_version: 4
 summary: Converts International Domain Names into Punycode. It uses (via FFI) 'libidn2'
   for Mac and Linux; for Windows, it uses native APIs.