ffi-win32-extensions 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a61a497ca132d28a6d17298a8551281955678458
-  data.tar.gz: 3976608e5b17ee479765ab737c8d7576e21236b0
+  metadata.gz: 222fca76d4a26f80510379101b6cdcbb35983631
+  data.tar.gz: c552a2d5f78aafd64c993fed870819d3f983b4b9
 SHA512:
-  metadata.gz: 1518bab2ccbc0114d46edfb17b96461c25b4747c556f9287213776b06899c30526db0106347841086fc4da8980919cf10a12252431c396484f497d3a0baf5fc0
-  data.tar.gz: 27048b83b513b98bc6a7fb33a8569d32cb84ed3416d5f26fdab677c57050f1b720fcbaefc7d7a5e32c404d76a94b7b6f23c0743c7ef2a76afb3844b1e44b753c
+  metadata.gz: ed1b217b84bf3bc93e382766f156aa8bfc88726a8cf20a51527d1f88bcff208b2e6bf729b70c61d06c5196219e82470b7a7c24d199efc6bdb79b2fb1648defa3
+  data.tar.gz: dd629833b40839498f2a49688a4cbe12bb8dfb6d78f81acc6a4dbb631a1710b4fa3e79d152a584a6a7df76391abcfe66b7d89beab212d878f53190d5c1da0a7f

data/CHANGES

@@ -1,3 +1,7 @@
+= 1.0.2 - 20-Jun-2016
+* Added the String#read_wide_string method.
+* Refactored the windows_error_message method a bit.
+
 = 1.0.1 - 8-May-2016
 * The String#wstrip method defaults to nil on failure.
 

data/README

@@ -18,8 +18,9 @@
 
   The following String instance methods have been added:
 
-  * wincode - Converts a string to UTF-16LE for use in wide character functions.
-  * wstrip  - Like String#strip, but for wide strings.
+  * wincode          - Converts a string to UTF-16LE for use in wide char functions.
+  * wstrip           - Like String#strip, but for wide strings.
+  * read_wide_string - Reads a Ruby string up to the first double null.
 
   Example:
 

data/ffi-win32-extensions.gemspec

@@ -2,7 +2,7 @@ require 'rubygems'
 
 Gem::Specification.new do |spec|
   spec.name       = 'ffi-win32-extensions'
-  spec.version    = '1.0.1'
+  spec.version    = '1.0.2'
   spec.authors    = 'Daniel J. Berger'
   spec.license    = 'Apache 2.0'
   spec.email      = 'djberg96@gmail.com'

data/lib/ffi/win32/extensions.rb

@@ -41,13 +41,20 @@ module FFI
   # The message will always be English regardless of your locale.
   #
   def windows_error_message(function, err=FFI.errno)
-    flags = 0x00001000 | 0x00000200 # ARGUMENT_ARRAY + SYSTEM
-    buf = FFI::MemoryPointer.new(:char, 1024)
+    error_message = ''
+
+    # ARGUMENT_ARRAY + SYSTEM + MAX_WIDTH_MASK
+    flags = 0x00001000 | 0x00000200 | 0x000000FF
 
     # 0x0409 = MAKELANGID(LANG_ENGLISH, SUBLANG_ENGLISH_US)
-    FormatMessage(flags, nil, err , 0x0409, buf, 1024, nil)
+    # We use English for errors because Ruby uses English for errors.
+
+    FFI::MemoryPointer.new(:char, 1024) do |buf|
+      length = FormatMessage(flags, nil, err , 0x0409, buf, buf.size, nil)
+      error_message = function + ': ' + buf.read_string(length).strip
+    end
 
-    function + ': ' + buf.read_string.strip
+    error_message
   end
 
   # Raises a Windows specific error using SystemCallError that is based on
@@ -79,4 +86,11 @@ class String
   rescue
     nil
   end
+
+  # Read a wide character string up until the first double null, and delete
+  # any remaining null characters.
+  #
+  def read_wide_string
+    self[/^.*?(?=\x00{2})/].delete(0.chr)
+  end
 end

data/test/test_ffi_extensions.rb

@@ -10,8 +10,14 @@ class TC_FFI_Win32_Extensions < Test::Unit::TestCase
     assert_respond_to(@ptr, :read_array_of_string)
   end
 
-  test 'windows_error_message' do
+  test 'windows_error_message basic functionality' do
     assert_respond_to(FFI, :windows_error_message)
+    assert_kind_of(String, FFI.windows_error_message('foo'))
+  end
+
+  test 'windows_error_message returns the expected value' do
+    expected = 'foo: The operation completed successfully.'
+    assert_equal(expected, FFI.windows_error_message('foo', 0))
   end
 
   test 'raise_windows_error' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ffi-win32-extensions
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Daniel J. Berger
@@ -30,7 +30,7 @@ cert_chain:
   EJYzxdPOrx2n6NYR3Hk+vHP0U7UBSveI6+qx+ndQYaeyCn+GRX2PKS9h66YF/Q1V
   tGSHgAmcLlkdGgan182qsE/4kKM=
   -----END CERTIFICATE-----
-date: 2016-05-08 00:00:00.000000000 Z
+date: 2016-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -108,7 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.4
 signing_key: 
 specification_version: 4
 summary: Extends the FFI and String classes on MS Windows