ffi-win32-extensions 1.0.3 → 1.0.4

data/MANIFEST

@@ -1,9 +1,9 @@
-* ffi-win32-extensions.gemspec
-* LICENSE
-* MANIFEST
-* Rakefile
-* README
-* lib/ffi-win32-extensions.rb
-* lib/ffi/win32/extensions.rb
-* test/test_ffi_extensions.rb
-* test/test_string_extensions.rb
+* ffi-win32-extensions.gemspec
+* LICENSE
+* MANIFEST
+* Rakefile
+* README
+* lib/ffi-win32-extensions.rb
+* lib/ffi/win32/extensions.rb
+* test/test_ffi_extensions.rb
+* test/test_string_extensions.rb

data/README

@@ -1,48 +1,48 @@
-= Description
-  A Ruby library that adds some core FFI and String methods to supplement
-  development of Ruby libraries on Windows.
-
-= Installation
-  gem install ffi-win32-extensions
-
-= Details
-  The following FFI::MemoryPointer methods have been added:
-
-  * read_array_of_string - For reading char** types.
-  * read_wide_string     - Similar to read_string but for wide char* types.
-
-  The following FFI module functions have been added:
-
-  * windows_error_message - A Windows specific error string using FormatMessage.
-  * raise_windows_error   - Raises a windows specific error using windows_error_message.
-
-  The following String instance methods have been added:
-
-  * 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:
-
-  require 'ffi/win32/extensions'
-
-  str = old_string.wincode
-  rv  = SomeWideFunctionW(str)
-
-  unless rv == 0
-    FFI.raise_windows_error('SomeWindowsFunction', rv)
-  end
-
-= Copyright
-  (C) 2016 Daniel J. Berger, All Rights Reserved
-    
-= Warranty
-  This package is provided "as is" and without any express or
-  implied warranties, including, without limitation, the implied
-  warranties of merchantability and fitness for a particular purpose.
-
-= License
-  Apache 2.0
-
-= Author
-  Daniel Berger
+= Description
+  A Ruby library that adds some core FFI and String methods to supplement
+  development of Ruby libraries on Windows.
+
+= Installation
+  gem install ffi-win32-extensions
+
+= Details
+  The following FFI::MemoryPointer methods have been added:
+
+  * read_array_of_string - For reading char** types.
+  * read_wide_string     - Similar to read_string but for wide char* types.
+
+  The following FFI module functions have been added:
+
+  * windows_error_message - A Windows specific error string using FormatMessage.
+  * raise_windows_error   - Raises a windows specific error using windows_error_message.
+
+  The following String instance methods have been added:
+
+  * 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:
+
+  require 'ffi/win32/extensions'
+
+  str = old_string.wincode
+  rv  = SomeWideFunctionW(str)
+
+  unless rv == 0
+    FFI.raise_windows_error('SomeWindowsFunction', rv)
+  end
+
+= Copyright
+  (C) 2016 Daniel J. Berger, All Rights Reserved
+    
+= Warranty
+  This package is provided "as is" and without any express or
+  implied warranties, including, without limitation, the implied
+  warranties of merchantability and fitness for a particular purpose.
+
+= License
+  Apache 2.0
+
+= Author
+  Daniel Berger

data/README.md

@@ -0,0 +1,57 @@
+# ffi-win32-extensions
+
+[![Gem Version](https://badge.fury.io/rb/ffi-win32-extensions.svg)](https://badge.fury.io/rb/ffi-win32-extensions)
+
+A Ruby library that adds some core FFI and String methods to supplement development of Ruby libraries on Windows.
+
+## Installation
+
+```
+gem install ffi-win32-extensions
+```
+
+## Details
+
+The following FFI::MemoryPointer methods have been added:
+
+- read_array_of_string - For reading char** types.
+- read_wide_string - Similar to read_string but for wide char* types.
+
+The following FFI module functions have been added:
+
+- windows_error_message - A Windows specific error string using FormatMessage.
+- raise_windows_error - Raises a windows specific error using windows_error_message.
+
+The following String instance methods have been added:
+
+- 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
+
+```ruby
+require 'ffi/win32/extensions'
+
+str = old_string.wincode rv = SomeWideFunctionW(str)
+
+unless rv == 0
+  FFI.raise_windows_error('SomeWindowsFunction', rv)
+end
+```
+
+## Copyright
+
+(C) 2016 Daniel J. Berger, All Rights Reserved
+
+## Warranty
+
+This package is provided "as is" and without any express or implied warranties, including, without limitation, the implied warranties of merchantability and fitness for a particular purpose.
+
+## License
+
+Apache 2.0
+
+## Author
+
+Daniel Berger

data/Rakefile

@@ -1,42 +1,53 @@
-require 'rake'
-require 'rake/clean'
-require 'rake/testtask'
-
-CLEAN.include('**/*.gem', '**/*.rbc')
-
-namespace :gem do
-  desc "Create the ffi-win32-extensions gem"
-  task :create => [:clean] do
-    require 'rubygems/package'
-    spec = eval(IO.read('ffi-win32-extensions.gemspec'))
-    spec.signing_key = File.join(Dir.home, '.ssh', 'gem-private_key.pem')
-    Gem::Package.build(spec, true)
-  end
-
-  desc "Install the win32-clipboard library"
-  task :install => [:create] do
-    file = Dir["*.gem"].first
-    sh "gem install -l #{file}"
-  end
-end
-
-namespace :test do
-  Rake::TestTask.new(:all) do |t|
-    t.warning = true
-    t.verbose = true
-  end
-
-  Rake::TestTask.new(:ffi) do |t|
-    t.warning = true
-    t.verbose = true
-    t.test_files = FileList['test/test_ffi_extensions.rb']
-  end
-
-  Rake::TestTask.new(:string) do |t|
-    t.warning = true
-    t.verbose = true
-    t.test_files = FileList['test/test_string_extensions.rb']
-  end
-end
-
-task :default => 'test:all'
+require "rake"
+require "rake/clean"
+require "rake/testtask"
+
+CLEAN.include("**/*.gem", "**/*.rbc")
+
+namespace :gem do
+  desc "Create the ffi-win32-extensions gem"
+  task create: [:clean] do
+    require "rubygems/package" unless defined?(Gem::Package)
+    spec = eval(IO.read("ffi-win32-extensions.gemspec")) # rubocop: disable Security/Eval
+    spec.signing_key = File.join(Dir.home, ".ssh", "gem-private_key.pem")
+    Gem::Package.build(spec, true)
+  end
+
+  desc "Install the win32-clipboard library"
+  task install: [:create] do
+    file = Dir["*.gem"].first
+    sh "gem install -l #{file}"
+  end
+end
+
+namespace :test do
+  Rake::TestTask.new(:all) do |t|
+    t.warning = true
+    t.verbose = true
+  end
+
+  Rake::TestTask.new(:ffi) do |t|
+    t.warning = true
+    t.verbose = true
+    t.test_files = FileList["test/test_ffi_extensions.rb"]
+  end
+
+  Rake::TestTask.new(:string) do |t|
+    t.warning = true
+    t.verbose = true
+    t.test_files = FileList["test/test_string_extensions.rb"]
+  end
+end
+
+begin
+  require "chefstyle"
+  require "rubocop/rake_task"
+  desc "Run Chefstyle tests"
+  RuboCop::RakeTask.new(:style) do |task|
+    task.options += ["--display-cop-names", "--no-color"]
+  end
+rescue LoadError
+  puts "chefstyle gem is not installed. bundle install first to make sure all dependencies are installed."
+end
+
+task default: "test:all"

data/VERSION

@@ -0,0 +1 @@
+1.0.4

data/ffi-win32-extensions.gemspec

@@ -1,25 +1,19 @@
-require 'rubygems'
-
-Gem::Specification.new do |spec|
-  spec.name       = 'ffi-win32-extensions'
-  spec.version    = '1.0.3'
-  spec.authors    = 'Daniel J. Berger'
-  spec.license    = 'Apache 2.0'
-  spec.email      = 'djberg96@gmail.com'
-  spec.homepage   = 'http://github.com/djberg96/ffi-win32-extensions'
-  spec.summary    = 'Extends the FFI and String classes on MS Windows'
-  spec.test_files = Dir['test/test*']
-  spec.files      = Dir['**/*'].reject{ |f| f.include?('git') }
-  spec.cert_chain = ['certs/djberg96_pub.pem']
-
-  spec.extra_rdoc_files  = ['README', 'CHANGES', 'MANIFEST']
-
-  spec.add_dependency('ffi')
-  spec.add_development_dependency('test-unit')
-
-  spec.description = <<-EOF
-    The ffi-win32-extensions library adds additional methods to the FFI
-    and String classes to aid in the development of FFI based libraries
-    on MS Windows.
-  EOF
-end
+Gem::Specification.new do |spec|
+  spec.name       = "ffi-win32-extensions"
+  spec.version    = "1.0.4"
+  spec.authors    = "Daniel J. Berger"
+  spec.license    = "Apache 2.0"
+  spec.email      = "djberg96@gmail.com"
+  spec.homepage   = "http://github.com/chef/ffi-win32-extensions"
+  spec.summary    = "Extends the FFI and String classes on MS Windows"
+  spec.test_files = Dir["test/test*"]
+  spec.files      = Dir["**/*"].reject { |f| f.include?("git") }
+
+  spec.add_dependency("ffi")
+
+  spec.description = <<-EOF
+    The ffi-win32-extensions library adds additional methods to the FFI
+    and String classes to aid in the development of FFI based libraries
+    on MS Windows.
+  EOF
+end

data/lib/ffi-win32-extensions.rb

@@ -1 +1 @@
-require_relative 'ffi/win32/extensions'
+require_relative "ffi/win32/extensions"

data/lib/ffi/win32/extensions.rb

@@ -1,96 +1,133 @@
-require 'ffi'
-
-class FFI::Pointer
-  # Returns an array of strings for char** types.
-  #
-  def read_array_of_string
-    elements = []
-
-    loc = self
-
-    until ((element = loc.read_pointer).null?)
-      elements << element.read_string
-      loc += FFI::Type::POINTER.size
-    end
-
-    elements
-  end
-
-  # Read +num_bytes+ from a wide character string pointer.
-  #
-  def read_wide_string(num_bytes = self.size)
-    read_bytes(num_bytes).force_encoding('UTF-16LE')
-      .encode('UTF-8', :invalid => :replace, :undef => :replace)
-      .split(0.chr).first.force_encoding(Encoding.default_external)
-  end
-end
-
-module FFI
-  extend FFI::Library
-
-  ffi_lib :kernel32
-
-  # We deliberately use the ANSI version because all Ruby error messages are English.
-  attach_function :FormatMessage, :FormatMessageA,
-    [:ulong, :pointer, :ulong, :ulong, :pointer, :ulong, :pointer], :ulong
-
-  # Returns a Windows specific error message based on +err+ prepended
-  # with the +function+ name. Note that this does not actually raise
-  # an error, it only returns the message.
-  #
-  # The message will always be English regardless of your locale.
-  #
-  def windows_error_message(function, err=FFI.errno)
-    error_message = ''
-
-    # ARGUMENT_ARRAY + SYSTEM + MAX_WIDTH_MASK
-    flags = 0x00001000 | 0x00000200 | 0x000000FF
-
-    # 0x0409 = MAKELANGID(LANG_ENGLISH, SUBLANG_ENGLISH_US)
-    # 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
-
-    error_message
-  end
-
-  # Raises a Windows specific error using SystemCallError that is based on
-  # the +err+ provided, with the message prepended with the +function+ name.
-  #
-  def raise_windows_error(function, err=FFI.errno)
-    raise SystemCallError.new(windows_error_message(function, err), err)
-  end
-
-  module_function :windows_error_message
-  module_function :raise_windows_error
-end
-
-class String
-  # Convenience method for converting strings to UTF-16LE for wide character
-  # functions that require it.
-  #
-  def wincode
-    (self.tr(File::SEPARATOR, File::ALT_SEPARATOR) + 0.chr).encode('UTF-16LE')
-  end
-
-  # Read a wide character string up until the first double null, and delete
-  # any remaining null characters. If this fails (typically because there
-  # are only null characters) then nil is returned instead.
-  #
-  def wstrip
-    self.force_encoding('UTF-16LE').encode('UTF-8', :invalid=>:replace, :undef=>:replace).
-    split("\x00")[0].encode(Encoding.default_external)
-  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
+require "ffi" unless defined?(FFI)
+
+class FFI::Pointer
+  # Returns an array of strings for char** types.
+  #
+  def read_array_of_string
+    elements = []
+
+    loc = self
+
+    until (element = loc.read_pointer).null?
+      elements << element.read_string
+      loc += FFI::Type::POINTER.size
+    end
+
+    elements
+  end
+
+  # Read +num_bytes+ from a wide character string pointer.
+  # If this fails (typically because there are only null characters)
+  # then an empty string is returned instead.
+  #
+  def read_wide_string(num_bytes = size)
+    read_bytes(num_bytes).force_encoding("UTF-16LE")
+      .encode("UTF-8", invalid: :replace, undef: :replace)
+      .split(0.chr).first.force_encoding(Encoding.default_external)
+  rescue
+    ""
+  end
+
+  # Read null-terminated Unicode strings.
+  #
+  def read_wstring(num_wchars = nil)
+    if num_wchars.nil?
+      # Find the length of the string
+      length = 0
+      last_char = nil
+      while last_char != "\000\000"
+        length += 1
+        last_char = get_bytes(0, length * 2)[-2..-1]
+      end
+
+      num_wchars = length
+    end
+
+    wide_to_utf8(get_bytes(0, num_wchars * 2))
+  end
+
+  def wide_to_utf8(wstring)
+    # ensure it is actually UTF-16LE
+    # Ruby likes to mark binary data as ASCII-8BIT
+    wstring = wstring.force_encoding("UTF-16LE")
+
+    # encode it all as UTF-8 and remove trailing CRLF and NULL characters
+    wstring.encode("UTF-8").strip
+  end
+
+  def read_utf16string
+    offset = 0
+    offset += 2 while get_bytes(offset, 2) != "\x00\x00"
+    get_bytes(0, offset).force_encoding("utf-16le").encode("utf-8")
+  end
+end
+
+module FFI
+  extend FFI::Library
+
+  ffi_lib :kernel32
+
+  # We deliberately use the ANSI version because all Ruby error messages are English.
+  attach_function :FormatMessage, :FormatMessageA,
+    %i{ulong pointer ulong ulong pointer ulong pointer}, :ulong
+
+  # Returns a Windows specific error message based on +err+ prepended
+  # with the +function+ name. Note that this does not actually raise
+  # an error, it only returns the message.
+  #
+  # The message will always be English regardless of your locale.
+  #
+  def windows_error_message(function, err = FFI.errno)
+    error_message = ""
+
+    # ARGUMENT_ARRAY + SYSTEM + MAX_WIDTH_MASK
+    flags = 0x00001000 | 0x00000200 | 0x000000FF
+
+    # 0x0409 = MAKELANGID(LANG_ENGLISH, SUBLANG_ENGLISH_US)
+    # 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
+
+    error_message
+  end
+
+  # Raises a Windows specific error using SystemCallError that is based on
+  # the +err+ provided, with the message prepended with the +function+ name.
+  #
+  def raise_windows_error(function, err = FFI.errno)
+    raise SystemCallError.new(windows_error_message(function, err), err)
+  end
+
+  module_function :windows_error_message
+  module_function :raise_windows_error
+end
+
+class String
+  # Convenience method for converting strings to UTF-16LE for wide character
+  # functions that require it.
+  #
+  def wincode
+    (tr(File::SEPARATOR, File::ALT_SEPARATOR) + 0.chr).encode("UTF-16LE")
+  end
+
+  # Read a wide character string up until the first double null, and delete
+  # any remaining null characters. If this fails (typically because there
+  # are only null characters) then nil is returned instead.
+  #
+  def wstrip
+    force_encoding("UTF-16LE").encode("UTF-8", invalid: :replace, undef: :replace)
+      .split("\x00")[0].encode(Encoding.default_external)
+  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