net-proto 1.3.0 → 1.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1daa42393b00eb774a8ad1e9b6ecf3f1b369ac47c46d974c9d671e695a2963c6
-  data.tar.gz: 8b2437cc1ea12f09cad3b724307f24ea2172ad61cb6d764bcdac0a7bf4751f77
+  metadata.gz: 82de82e11a8d4cca74f1b807925b90c89a9dccf50907c5f29edfecf60e43d00d
+  data.tar.gz: 0f9f4da5409f7e6e6c1ba1b1ca6bb396964283edf1d01917fd168ccf666ec30c
 SHA512:
-  metadata.gz: eba3abc747ec6d2f92ae05bbb907124d85f7ea13a9c03b86519e7fc5306f54ab4ac5abe1e5080c3904b9da295f7e845dcfb8e2d9780fc136e982d44539e83580
-  data.tar.gz: d832391f70e27a8e8b4bdcadf1ad866e8f1083d6694b6269d944c2818fce546111d0a6fada3ccd93b9dd960d7f0ee496563545701c6d0e6bb001d988c7c2480a
+  metadata.gz: f31941974311642c93785c9885524cd724822cffc7d3e7a3954f033c6787125b6d50405a7edc2b41f9685114be2ec82c1dd758570fb0806cc769fa28fcafc777
+  data.tar.gz: 887a80b0657627809196abcbb4ae6966ab4d3147d79f9780bea662f3d5a1eb71e3180cb5c1af57746a61cc9ac57bb5d4c4e49fbf8ae4651aadcded2c67145040

data/{CHANGES → CHANGES.md}

@@ -1,24 +1,38 @@
-== 1.3.0 - 10-Jan-2019
+## 1.4.2 - 3-Aug-2021
+* Properly set the p_proto type (short, not int) for Windows.
+* Minor updates suggested by rubocop.
+* Added a Gemfile.
+
+## 1.4.1 - 18-Feb-2021
+* Switch rdoc format to markdown where appropriate.
+
+## 1.4.0 - 17-Aug-2020
+* Switched from test-unit to rspec.
+
+## 1.3.1 - 30-Jul-2020
+* Add a LICENSE file as required by the Apache-2.0 license.
+
+## 1.3.0 - 10-Jan-2019
 * Changed license to Apache-2.0.
 * The VERSION constant is now frozen.
 * Added metadata to the gemspec.
 * Updated cert, should be good for about 10 years now.
 
-== 1.2.1 - 4-Jan-2016
+## 1.2.1 - 4-Jan-2016
 * This gem is now signed.
 * The gem related tasks in the Rakefile now assume Rubygems 2.x.
 * Added a net-proto.rb file for convenience.
 
-== 1.2.0 - 3-Nov-2014
+## 1.2.0 - 3-Nov-2014
 * The getprotobynumber and getprotobyname methods on MS Windows now accept
   optional window and message arguments. If used, the method becomes
   asynchronous and yields a block instead.
 
-== 1.1.1 - 9-Oct-2014
+## 1.1.1 - 9-Oct-2014
 * Implemented getprotoent on Windows using pure Ruby.
 * Miscellaneous minor updates to the Rakefile, gemspec and docs.
 
-== 1.1.0 - 18-Jan-2012
+## 1.1.0 - 18-Jan-2012
 * Switched to FFI instead of C backend. Now works with JRuby, too.
 * Added the generic get_protocol instance method that accepts either a
   string or an integer and does the right thing. This method should be
@@ -27,19 +41,19 @@
 * Refactored the test suite to use features of test-unit 2.x.
 * Added a default rake task.
 
-== 1.0.6 - 22-Oct-2010
+## 1.0.6 - 22-Oct-2010
 * Refactored the test suite and removed one test that was implementation
   dependent and not useful.
 * Updates to the README and gemspec.
 
-== 1.0.5 - 12-Sep-2009
+## 1.0.5 - 12-Sep-2009
 * Changed license to Artistic 2.0.
 * Added a build_binary_gem task.
 * Cleaned up and refactored the gemspec a bit, including the addition of
   a license and an updated description.
 * Switched test-unit from a runtime dependency to a dev dependency.
 
-== 1.0.4 - 6-Jan-2008
+## 1.0.4 - 6-Jan-2008
 * The struct returned by Net::Proto.getprotoent is now frozen. This is
   strictly read-only data.
 * It is now explicitly illegal to call Net::Proto.new.
@@ -48,31 +62,31 @@
 * Renamed and refactored the test suite. This library now requires test-unit
   version 2.0.2 or later.
 
-== 1.0.3 - 13-Aug-2007
+## 1.0.3 - 13-Aug-2007
 * Fix for OS X (whining about malloced pointer).
 * Added a Rakefile along with tasks for installation and testing.
 * Major internal reorganization.
 * Fixed Proto::VERSION test.
 
-== 1.0.2 - 18-Nov-2006
+## 1.0.2 - 18-Nov-2006
 * Updated the README, gemspec and netproto.txt files.
 * No code changes.
 
-== 1.0.1 - 30-Jun-2006
+## 1.0.1 - 30-Jun-2006
 * Added rdoc to the source files.
 * Added a gemspec.
 
-== 1.0.0 - 14-Jul-2005
+## 1.0.0 - 14-Jul-2005
 * Moved project to RubyForge.
 * Minor directory layout change.
 * Minor changes to the extconf.rb file.
 * Officially bumped VERSION to 1.0.0.
 
-== 0.2.5 - 18-Apr-2005
+## 0.2.5 - 18-Apr-2005
 * The Unix versions now call setprotoent(0) and endprotoent() internally
   before each call.
 
-== 0.2.4 - 12-Apr-2005
+## 0.2.4 - 12-Apr-2005
 * Added internal taint checking for the Proto.getprotobyname method.
 * Removed the INSTALL file.  Installation instructions are now in the README.
 * Moved the sample script into the 'examples' directory.
@@ -81,13 +95,13 @@
 * Removed the netproto.rd and netproto.html files.  The netproto.txt file is
   now rdoc friendly.
 
-== 0.2.3 - 13-Sep-2004
+## 0.2.3 - 13-Sep-2004
 * Replaced all instances of the deprecated STR2CSTR() function with the
   StringValuePtr() function.  That means that, as of this release, this
   package requires Ruby 1.8.0 or later.
 * Minor documentation corrections.
 
-== 0.2.2 - 10-Apr-2004
+## 0.2.2 - 10-Apr-2004
 * No longer returns an Array in block form.  Only the non-block form returns
   an array.  The block form returns nil.
 * Updated the documentation, warranty information included, license changed
@@ -96,7 +110,7 @@
 * Changed "tc_all.rb" to "tc_netproto.rb".
 * Changed "netproto.rd2" to "netproto.rd".
 
-== 0.2.1 - 29-Jul-2003
+## 0.2.1 - 29-Jul-2003
 * Code cleanup (-Wall warnings on Linux)
 * Removed VERSION() class method.  Use the constant instead
 * The getprotoent() method now returns an array of structs in non-block form
@@ -106,7 +120,7 @@
   TestUnit installed, instead of dynamically generating one
 * Fixed up TestUnit test suite
 
-== 0.2.0 - 26-Feb-2003
+## 0.2.0 - 26-Feb-2003
 * Added MS Windows support (except 'getprotoent()' - see docs)
 * For protocols that aren't defined, nil is now returned instead
   of crashing (always a good thing)
@@ -121,7 +135,7 @@
 * Manifest now MANIFEST
 * Package name changed to lower case
 
-== 0.1.0 - 13-Aug-2002
+## 0.1.0 - 13-Aug-2002
 * Fixed bug with getprotoent_r function for Linux
 * Added a 'generic' source file that uses the non-reentrant functions for
   those platforms that are not specifically supported.
@@ -130,5 +144,5 @@
 * Added a changelog :)
 * Added a manifest
    
-== 0.0.1 - 12-Aug-2002
+## 0.0.1 - 12-Aug-2002
 * Initial release (though written earlier)

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,177 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

data/{MANIFEST → MANIFEST.md}

@@ -1,6 +1,7 @@
-* CHANGES
-* MANIFEST
-* README
+* CHANGES.md
+* LICENSE
+* MANIFEST.md
+* README.md
 * Rakefile
 * doc/netproto.txt
 * net-proto.gemspec
@@ -12,4 +13,4 @@
 * lib/linux/net/proto.rb
 * lib/sunos/net/proto.rb
 * examples/example_net_proto.rb
-* test/test_net_proto.rb
+* spec/net_proto_spec.rb

data/{README → README.md}

@@ -1,17 +1,18 @@
-== Description
+## Description
 The net-proto package provides a way to get protocol information.
 
-This is a wrapper for the getprotobyname(), getprotobynumber() and
-the getprotoent() functions.
+This is a wrapper for the `getprotobyname`, `getprotobynumber` and
+the `getprotoent` C functions.
 
-== Installation
-gem install net-proto
+## Installation
+`gem install net-proto`
 
-== Prerequisites
-ffi 1.0.0 or later.
+## Prerequisites
+* ffi 1.0.0 or later.
 
-== Synopsis
-require 'net/proto'
+## Synopsis
+```ruby
+require 'net/proto' # or 'net-proto'
 
 # Using generic method
 Net::Proto.get_protocol(1)      # => 'icmp'
@@ -25,13 +26,14 @@ Net::Proto.getprotobyname('tcp') # => 6
 Net::Proto.getprotoent do |ent|
   p ent
 end
+```
 
-== Why should I use this?
+## Why should I use this?
 Ruby has a predefined set of constants in socket.c in the general form of
 IPPROTO_XXX, Y.  However, using constants in this fashion can be unreliable
 because it's easy to define your own protocols (I set 'echo' to 7, for
 example), or to modify/delete entries in /etc/protocols.
 
-== Further Documentation
-See the 'netproto.txt' file under the 'doc' directory for more details.  There
+## Further Documentation
+See the 'netproto.rdoc' file under the 'doc' directory for more details.  There
 is also an example under the 'examples' directory.

data/Rakefile

@@ -1,16 +1,17 @@
 require 'rake'
 require 'rake/testtask'
 require 'rake/clean'
+require 'rspec/core/rake_task'
 
-CLEAN.include('**/*.gem', '**/*.rbx', '**/*.rbc')
+CLEAN.include('**/*.gem', '**/*.rbx', '**/*.rbc', '**/*.lock')
 
 namespace 'gem' do
   desc 'Create the net-proto gem'
   task :create => :clean do
     require 'rubygems/package'
-    spec = eval(IO.read('net-proto.gemspec'))
+    spec = Gem::Specification.load('net-proto.gemspec')
     spec.signing_key = File.join(Dir.home, '.ssh', 'gem-private_key.pem')
-    Gem::Package.build(spec, true)
+    Gem::Package.build(spec)
   end
 
   desc 'Install the net-proto gem'
@@ -25,9 +26,8 @@ task :example do
   ruby '-Ilib examples/example_net_proto.rb'
 end
 
-Rake::TestTask.new do |t|
-  t.warning = true
-  t.verbose = true
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = ['spec/net_proto_spec.rb']
 end
 
-task :default => :test
+task :default => :spec

data/doc/{netproto.txt → netproto.rdoc}

@@ -59,7 +59,7 @@ Proto.getprotoent{ |struct| ... }
   at https://github.com/djberg96/net-proto.
 	
 == Copyright
-  (C) 2003-2019 Daniel J. Berger
+  (C) 2003-2020 Daniel J. Berger
   All rights reserved.
 	
 == Warranty

data/lib/generic/net/proto.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'net/proto/common'
 
 # The Net module serves as a namespace only.
@@ -13,8 +15,6 @@ module Net
       ffi_convention :stdcall
     end
 
-    private
-
     # These should exist on every platform.
     attach_function :getprotobyname_c, :getprotobyname, [:string], :pointer
     attach_function :getprotobynumber_c, :getprotobynumber, [:int], :pointer
@@ -35,8 +35,6 @@ module Net
     private_class_method :getprotobyname_c
     private_class_method :getprotobynumber_c
 
-    public
-
     # If given a protocol string, returns the corresponding number. If
     # given a protocol number, returns the corresponding string.
     #
@@ -96,7 +94,7 @@ module Net
         endprotoent() if respond_to?(:endprotoent, true)
       end
 
-      ptr.null? ? nil: struct[:p_name]
+      ptr.null? ? nil : struct[:p_name]
     end
 
     # In block form, yields each entry from /etc/protocols as a struct of type

data/lib/linux/net/proto.rb

@@ -1,25 +1,22 @@
+# frozen_string_literal: true
+
 require 'net/proto/common'
 
 # The Net module serves as a namespace only.
 module Net
-
   # The Proto class serves as the base class for the various protocol methods.
   class Proto
     ffi_lib FFI::Library::LIBC
 
-    private
-
     attach_function :setprotoent, [:int], :void
     attach_function :endprotoent, [], :void
-    attach_function :getprotobyname_r, [:string, :pointer, :pointer, :long, :pointer], :int
-    attach_function :getprotobynumber_r, [:int, :pointer, :pointer, :long, :pointer], :int
-    attach_function :getprotoent_r, [:pointer, :pointer, :long, :pointer], :int
+    attach_function :getprotobyname_r, %i[string pointer pointer long pointer], :int
+    attach_function :getprotobynumber_r, %i[int pointer pointer long pointer], :int
+    attach_function :getprotoent_r, %i[pointer pointer long pointer], :int
 
     private_class_method :setprotoent, :endprotoent, :getprotobyname_r
     private_class_method :getprotobynumber_r, :getprotoent_r
 
-    public
-
     # If given a protocol string, returns the corresponding number. If
     # given a protocol number, returns the corresponding string.
     #

data/lib/net-proto.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require_relative 'net/proto'

data/lib/net/proto.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rbconfig'
 
 case RbConfig::CONFIG['host_os']

data/lib/net/proto/common.rb

@@ -1,29 +1,45 @@
+# frozen_string_literal: true
+
 require 'ffi'
 
+# The Net module serves as a namespace only.
 module Net
+  # The Proto class serves as the base class for the various protocol methods.
   class Proto
     extend FFI::Library
 
     # The version of the net-proto library
-    VERSION = '1.3.0'.freeze
+    VERSION = '1.4.2'
 
     private_class_method :new
 
+    # Struct used internally by C functions
     class ProtocolStruct < FFI::Struct
-      layout(
-        :p_name,    :string,
-        :p_aliases, :pointer,
-        :p_proto,   :int
-      )
+      if File::ALT_SEPARATOR
+        layout(
+          :p_name,    :string,
+          :p_aliases, :pointer,
+          :p_proto,   :short
+        )
+      else
+        layout(
+          :p_name,    :string,
+          :p_aliases, :pointer,
+          :p_proto,   :int
+        )
+      end
     end
 
+    private_constant :ProtocolStruct
+
+    # Reopen the FFI::Pointer class and add our own method.
     class FFI::Pointer
       def read_array_of_string
         elements = []
 
         loc = self
 
-        until ((element = loc.read_pointer).null?)
+        until (element = loc.read_pointer).null?
           elements << element.read_string
           loc += FFI::Type::POINTER.size
         end

data/lib/sunos/net/proto.rb

@@ -1,23 +1,22 @@
+# frozen_string_literal: true
+
 require 'net/proto/common'
 
 # The Net module serves as a namespace only.
 module Net
-
   # The Proto class serves as the base class for the various protocol methods.
   class Proto
     ffi_lib 'socket'
 
     attach_function :setprotoent, [:int], :void
     attach_function :endprotoent, [], :void
-    attach_function :getprotobyname_r, [:string, :pointer, :pointer, :int], :pointer
-    attach_function :getprotobynumber_r, [:int, :pointer, :pointer, :int], :pointer
-    attach_function :getprotoent_r, [:pointer, :pointer, :int], :pointer
+    attach_function :getprotobyname_r, %i[string pointer pointer int], :pointer
+    attach_function :getprotobynumber_r, %i[int pointer pointer int], :pointer
+    attach_function :getprotoent_r, %i[pointer pointer int], :pointer
 
     private_class_method :setprotoent, :endprotoent, :getprotobyname_r
     private_class_method :getprotobynumber_r, :getprotoent_r
 
-    public
-
     # If given a protocol string, returns the corresponding number. If
     # given a protocol number, returns the corresponding string.
     #

data/lib/windows/net/proto.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'net/proto/common'
 
 # The Net module serves as a namespace only.
@@ -10,13 +12,11 @@ module Net
     ffi_lib 'ws2_32'
     ffi_convention :stdcall
 
-    private
-
     # These should exist on every platform.
     attach_function :getprotobyname_c, :getprotobyname, [:string], :pointer
     attach_function :getprotobynumber_c, :getprotobynumber, [:int], :pointer
-    attach_function :WSAAsyncGetProtoByName, [:uintptr_t, :uint, :string, :pointer, :pointer], :uintptr_t
-    attach_function :WSAAsyncGetProtoByNumber, [:uintptr_t, :uint, :int, :pointer, :pointer], :uintptr_t
+    attach_function :WSAAsyncGetProtoByName, %i[uintptr_t uint string pointer pointer], :uintptr_t
+    attach_function :WSAAsyncGetProtoByNumber, %i[uintptr_t uint int pointer pointer], :uintptr_t
     attach_function :WSAGetLastError, [], :int
 
     private_class_method :getprotobyname_c
@@ -25,8 +25,6 @@ module Net
     private_class_method :WSAAsyncGetProtoByNumber
     private_class_method :WSAGetLastError
 
-    public
-
     # If given a protocol string, returns the corresponding number. If
     # given a protocol number, returns the corresponding string.
     #
@@ -71,9 +69,7 @@ module Net
 
         handle = WSAAsyncGetProtoByName(hwnd, msg, protocol, struct, size_ptr)
 
-        if handle == 0
-          raise SystemCallError.new('WSAAsyncGetProtoByName', WSAGetLastError())
-        end
+        raise SystemCallError.new('WSAAsyncGetProtoByName', WSAGetLastError()) if handle == 0
 
         yield struct[:p_proto], handle
       else
@@ -113,9 +109,7 @@ module Net
 
         handle = WSAAsyncGetProtoByNumber(hwnd, msg, protocol, struct, size_ptr)
 
-        if handle == 0
-          raise SystemCallError.new('WSAAsyncGetProtoByNumber', WSAGetLastError())
-        end
+        raise SystemCallError.new('WSAAsyncGetProtoByNumber', WSAGetLastError()) if handle == 0
 
         yield struct[:p_name], handle
       else
@@ -150,11 +144,11 @@ module Net
     #
     def self.getprotoent
       structs = block_given? ? nil : []
-      file = ENV['SystemRoot'] + '/system32/drivers/etc/protocol'
+      file = File.join(ENV['SystemRoot'], '/system32/drivers/etc/protocol')
 
       IO.foreach(file) do |line|
         next if line.lstrip[0] == '#' # Skip comments
-        next if line.lstrip.size == 0 # Skip blank lines
+        next if line.lstrip.empty? # Skip blank lines
         line = line.split
 
         ruby_struct = ProtoStruct.new(line[0], line[2].split(','), line[1].to_i).freeze

data/net-proto.gemspec

@@ -2,26 +2,26 @@ require 'rubygems'
 
 Gem::Specification.new do |spec|
   spec.name       = 'net-proto'
-  spec.version    = '1.3.0'
+  spec.version    = '1.4.2'
   spec.author     = 'Daniel J. Berger'
   spec.license    = 'Apache-2.0'
   spec.email      = 'djberg96@gmail.com'
   spec.homepage   = 'https://github.com/djberg96/net-proto'
   spec.summary    = 'A Ruby interface for determining protocol information'
-  spec.test_file  = 'test/test_net_proto.rb'
-  spec.files      = Dir['**/*'].reject{ |f| f.include?('git') }
+  spec.test_file  = 'spec/net_proto_spec.rb'
+  spec.files      = Dir['**/*'].reject{ |f| f.include?('git') || f.include?('rubocop') }
   spec.cert_chain = Dir['certs/*']
 
-  spec.extra_rdoc_files  = ['CHANGES', 'README', 'MANIFEST', 'doc/netproto.txt']
+  spec.extra_rdoc_files = ['doc/netproto.rdoc']
 
-  spec.add_dependency('ffi', '>= 1.0.0')
-  spec.add_development_dependency('test-unit', '>= 2.2.0')
+  spec.add_dependency('ffi', '~> 1.0')
+  spec.add_development_dependency('rspec', '~> 3.9')
   spec.add_development_dependency('rake')
 
   spec.metadata = {
     'homepage_uri'      => 'https://github.com/djberg96/net-proto',
     'bug_tracker_uri'   => 'https://github.com/djberg96/net-proto/issues',
-    'changelog_uri'     => 'https://github.com/djberg96/net-proto/blob/ffi/CHANGES',
+    'changelog_uri'     => 'https://github.com/djberg96/net-proto/blob/main/CHANGES.md',
     'documentation_uri' => 'https://github.com/djberg96/net-proto/wiki',
     'source_code_uri'   => 'https://github.com/djberg96/net-proto',
     'wiki_uri'          => 'https://github.com/djberg96/net-proto/wiki'

data/spec/net_proto_spec.rb

@@ -0,0 +1,123 @@
+###########################################################################
+# net_proto_spec.rb
+#
+# Test suite for net-proto on all platforms. This test suite should be run
+# via the 'rake spec' task.
+###########################################################################
+require 'net/proto'
+require 'rspec'
+
+RSpec.describe Net::Proto do
+  # These were the protocols listed in my own /etc/protocols file on Solaris 9
+  let(:protocols) do
+    %w[
+      ip icmp igmp ggp ipip tcp cbt egp igp pup udp mux hmp
+      xns-idp rdp idpr idpr-cmtp sdrp idrp rsvp gre
+      mobile ospf pim ipcomp vrrp sctp hopopt ipv6
+      ipv6-route ipv6-frag esp ah ipv6-icmp ipv6-nonxt ipv6-opts
+    ]
+  end
+
+  example "version number is set to expected value" do
+    expect(Net::Proto::VERSION).to eq('1.4.2')
+    expect(Net::Proto::VERSION).to be_frozen
+  end
+
+  example "get_protocol method basic functionality" do
+    expect(Net::Proto).to respond_to(:get_protocol)
+  end
+
+  example "get_protocol method accepts a string or a number" do
+    expect{ Net::Proto.get_protocol(1) }.not_to raise_error
+    expect{ Net::Proto.get_protocol('tcp') }.not_to raise_error
+  end
+
+  example "get_protocol returns nil if protocol not found" do
+    expect(Net::Proto.get_protocol(9999999)).to be_nil
+  end
+
+  example "get_protocol fails if an invalid type is passed" do
+    expect{ Net::Proto.get_protocol([]) }.to raise_error(TypeError)
+  end
+
+  example "getprotobynumber basic functionality" do
+    expect(Net::Proto).to respond_to(:getprotobynumber)
+    expect{ 0.upto(132){ |n| Net::Proto.getprotobynumber(n) } }.not_to raise_error
+    expect(Net::Proto.getprotobynumber(1)).to be_kind_of(String)
+  end
+
+  example "getprotobynumber returns the expected result" do
+    expect(Net::Proto.getprotobynumber(1)).to eq('icmp')
+    expect(Net::Proto.getprotobynumber(6)).to eq('tcp')
+  end
+
+  example "getprotobynumber returns nil if not found" do
+    expect(Net::Proto.getprotobynumber(9999999)).to eq(nil)
+    expect(Net::Proto.getprotobynumber(-1)).to eq(nil)
+  end
+
+  example "getprotobynumber raises a TypeError if a non-numeric arg is used" do
+    expect{ Net::Proto.getprotobynumber('foo') }.to raise_error(TypeError)
+    expect{ Net::Proto.getprotobynumber(nil) }.to raise_error(TypeError)
+  end
+
+  example "getprotobyname method basic functionality" do
+    expect(Net::Proto).to respond_to(:getprotobyname)
+    protocols.each{ |n| expect{ Net::Proto.getprotobyname(n) }.not_to raise_error }
+  end
+
+  example "getprotobyname returns the expected result" do
+    expect(Net::Proto.getprotobyname('icmp')).to eq(1)
+    expect(Net::Proto.getprotobyname('tcp')).to eq(6)
+  end
+
+  example "getprotobyname returns nil if the protocol is not found" do
+    expect(Net::Proto.getprotobyname('foo')).to be_nil
+    expect(Net::Proto.getprotobyname('tcpx')).to be_nil
+    expect(Net::Proto.getprotobyname('')).to be_nil
+  end
+
+  example "getprotobyname raises a TypeError if an invalid arg is passed" do
+    expect{ Net::Proto.getprotobyname(1) }.to raise_error(TypeError)
+    expect{ Net::Proto.getprotobyname(nil) }.to raise_error(TypeError)
+  end
+
+  example "getprotoent basic functionality" do
+    expect(Net::Proto).to respond_to(:getprotoent)
+    expect{ Net::Proto.getprotoent }.not_to raise_error
+    expect(Net::Proto.getprotoent).to be_kind_of(Array)
+  end
+
+  example "getprotoent method returns the expected results" do
+    expect(Net::Proto.getprotoent.first).to be_kind_of(Struct::ProtoStruct)
+    expect(Net::Proto.getprotoent{}).to be_nil
+  end
+
+  example "struct returned by getprotoent method contains the expected data" do
+    protoent = Net::Proto.getprotoent.first
+    expect( protoent.members).to eq([:name, :aliases, :proto])
+    expect( protoent.name).to be_kind_of(String)
+    expect( protoent.aliases).to be_kind_of(Array)
+    expect( protoent.proto).to be_kind_of(Integer)
+  end
+
+  example "all members of the aliases struct member are strings" do
+    protoent = Net::Proto.getprotoent.first
+    expect(protoent.aliases.all?{ |e| e.is_a?(String) }).to eq(true)
+  end
+
+  example "struct returned by getprotoent method is frozen" do
+    protoent = Net::Proto.getprotoent.first
+    expect(protoent.frozen?).to eq(true)
+  end
+
+  example "there is no constructor" do
+    expect{ Net::Proto.new }.to raise_error(NoMethodError)
+  end
+
+  example "ffi functions are private" do
+    methods = Net::Proto.methods(false)
+    expect(methods.include?(:setprotoent)).to eq(false)
+    expect(methods.include?(:endprotoent)).to eq(false)
+  end
+end

metadata

@@ -1,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: net-proto
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.2
 platform: ruby
 authors:
 - Daniel J. Berger
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain:
 - |
@@ -35,36 +35,36 @@ cert_chain:
   ORVCZpRuCPpmC8qmqxUnARDArzucjaclkxjLWvCVHeFa9UP7K3Nl9oTjJNv+7/jM
   WZs4eecIcUc4tKdHxcAJ0MO/Dkqq7hGaiHpwKY76wQ1+8xAh
   -----END CERTIFICATE-----
-date: 
+date: 2021-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: test-unit
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: '3.9'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -87,53 +87,37 @@ email: djberg96@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files:
-- CHANGES
-- README
-- MANIFEST
-- doc/netproto.txt
+- doc/netproto.rdoc
 files:
-- CHANGES
-- test
-- test/test_net_proto.rb
-- net-proto.gemspec
-- examples
-- examples/example_net_proto.rb
-- doc
-- doc/netproto.txt
-- README
+- CHANGES.md
+- Gemfile
+- LICENSE
+- MANIFEST.md
+- README.md
 - Rakefile
-- MANIFEST
-- lib
-- lib/windows
-- lib/windows/net
-- lib/windows/net/proto.rb
-- lib/sunos
-- lib/sunos/net
-- lib/sunos/net/proto.rb
-- lib/net-proto.rb
-- lib/linux
-- lib/linux/net
+- certs/djberg96_pub.pem
+- doc/netproto.rdoc
+- examples/example_net_proto.rb
+- lib/generic/net/proto.rb
 - lib/linux/net/proto.rb
-- lib/net
+- lib/net-proto.rb
 - lib/net/proto.rb
-- lib/net/proto
 - lib/net/proto/common.rb
-- lib/generic
-- lib/generic/net
-- lib/generic/net/proto.rb
-- certs
-- certs/djberg96_pub.pem
+- lib/sunos/net/proto.rb
+- lib/windows/net/proto.rb
+- net-proto.gemspec
+- spec/net_proto_spec.rb
 homepage: https://github.com/djberg96/net-proto
 licenses:
 - Apache-2.0
 metadata:
   homepage_uri: https://github.com/djberg96/net-proto
   bug_tracker_uri: https://github.com/djberg96/net-proto/issues
-  changelog_uri: https://github.com/djberg96/net-proto/blob/ffi/CHANGES
+  changelog_uri: https://github.com/djberg96/net-proto/blob/main/CHANGES.md
   documentation_uri: https://github.com/djberg96/net-proto/wiki
   source_code_uri: https://github.com/djberg96/net-proto
   wiki_uri: https://github.com/djberg96/net-proto/wiki
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -148,9 +132,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
-signing_key: 
+rubygems_version: 3.2.15
+signing_key:
 specification_version: 4
 summary: A Ruby interface for determining protocol information
 test_files:
-- test/test_net_proto.rb
+- spec/net_proto_spec.rb

data/test/test_net_proto.rb

@@ -1,136 +0,0 @@
-###########################################################################
-# test_net_netproto.rb
-#
-# Test suite for net-proto - all platforms. This test suite should be run
-# via the 'rake test' task.
-###########################################################################
-require 'net/proto'
-require 'test-unit'
-
-class TC_Net_Proto < Test::Unit::TestCase
-
-  # These were the protocols listed in my own /etc/protocols file on Solaris 9
-  def self.startup
-    @@protocols = %w/
-      ip icmp igmp ggp ipip tcp cbt egp igp pup udp mux hmp
-      xns-idp rdp idpr idpr-cmtp sdrp idrp rsvp gre
-      mobile ospf pim ipcomp vrrp sctp hopopt ipv6
-      ipv6-route ipv6-frag esp ah ipv6-icmp ipv6-nonxt ipv6-opts
-    /
-  end
-
-  def setup
-    @protoent = nil
-  end
-
-  test "version number is set to expected value" do
-    assert_equal('1.3.0', Net::Proto::VERSION)
-    assert_true(Net::Proto::VERSION.frozen?)
-  end
-
-  test "get_protocol method basic functionality" do
-    assert_respond_to(Net::Proto, :get_protocol)
-  end
-
-  test "get_protocol method accepts a string or a number" do
-    assert_nothing_raised{ Net::Proto.get_protocol(1) }
-    assert_nothing_raised{ Net::Proto.get_protocol('tcp') }
-  end
-
-  test "get_protocol returns nil if protocol not found" do
-    assert_nil(Net::Proto.get_protocol(9999999))
-  end
-
-  test "get_protocol fails if an invalid type is passed" do
-    assert_raise(TypeError){ Net::Proto.get_protocol([]) }
-  end
-
-  test "getprotobynumber basic functionality" do
-    assert_respond_to(Net::Proto, :getprotobynumber)
-    assert_nothing_raised{ 0.upto(132){ |n| Net::Proto.getprotobynumber(n) } }
-    assert_kind_of(String, Net::Proto.getprotobynumber(1))
-  end
-
-  test "getprotobynumber returns the expected result" do
-    assert_equal('icmp', Net::Proto.getprotobynumber(1))
-    assert_equal('tcp', Net::Proto.getprotobynumber(6))
-  end
-
-  test "getprotobynumber returns nil if not found" do
-    assert_equal(nil, Net::Proto.getprotobynumber(9999999))
-    assert_equal(nil, Net::Proto.getprotobynumber(-1))
-  end
-
-  test "getprotobynumber raises a TypeError if a non-numeric arg is used" do
-    assert_raise(TypeError){ Net::Proto.getprotobynumber('foo') }
-    assert_raise(TypeError){ Net::Proto.getprotobynumber(nil) }
-  end
-
-  test "getprotobyname method basic functionality" do
-    assert_respond_to(Net::Proto, :getprotobyname)
-    @@protocols.each{ |n| assert_nothing_raised{ Net::Proto.getprotobyname(n) } }
-  end
-
-  test "getprotobyname returns the expected result" do
-    assert_equal(1, Net::Proto.getprotobyname('icmp'))
-    assert_equal(6, Net::Proto.getprotobyname('tcp'))
-  end
-
-  test "getprotobyname returns nil if the protocol is not found" do
-    assert_nil(Net::Proto.getprotobyname('foo'))
-    assert_nil(Net::Proto.getprotobyname('tcpx'))
-    assert_nil(Net::Proto.getprotobyname(''))
-  end
-
-  test "getprotobyname raises a TypeError if an invalid arg is passed" do
-    assert_raises(TypeError){ Net::Proto.getprotobyname(1) }
-    assert_raises(TypeError){ Net::Proto.getprotobyname(nil) }
-  end
-
-  test "getprotoent basic functionality" do
-    assert_respond_to(Net::Proto, :getprotoent)
-    assert_nothing_raised{ Net::Proto.getprotoent }
-    assert_kind_of(Array, Net::Proto.getprotoent)
-  end
-
-  test "getprotoent method returns the expected results" do
-    assert_kind_of(Struct::ProtoStruct, Net::Proto.getprotoent.first)
-    assert_nil(Net::Proto.getprotoent{})
-  end
-
-  test "struct returned by getprotoent method contains the expected data" do
-    @protoent = Net::Proto.getprotoent.first
-    assert_equal([:name, :aliases, :proto], @protoent.members)
-    assert_kind_of(String, @protoent.name)
-    assert_kind_of(Array, @protoent.aliases)
-    assert_kind_of(Integer, @protoent.proto)
-  end
-
-  test "all members of the aliases struct member are strings" do
-    @protoent = Net::Proto.getprotoent.first
-    assert_true(@protoent.aliases.all?{ |e| e.is_a?(String) })
-  end
-
-  test "struct returned by getprotoent method is frozen" do
-    @protoent = Net::Proto.getprotoent.first
-    assert_true(@protoent.frozen?)
-  end
-
-  test "there is no constructor" do
-    assert_raise(NoMethodError){ Net::Proto.new }
-  end
-
-  test "ffi functions are private" do
-    methods = Net::Proto.methods(false).map{ |m| m.to_sym }
-    assert_false(methods.include?(:setprotoent))
-    assert_false(methods.include?(:endprotoent))
-  end
-
-  def teardown
-    @protoent = nil
-  end
-
-  def self.shutdown
-    @@protocols = nil
-  end
-end