net-proto 1.0.5 → 1.0.6

data/CHANGES

@@ -1,3 +1,8 @@
+== 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
 * Changed license to Artistic 2.0.
 * Added a build_binary_gem task.

data/README

@@ -1,17 +1,21 @@
-== Description
+= Description
 The net-proto package provides a way to get protocol information.
 
-This is really just a wrapper for the getprotobyname(), getprotobynumber() and
-the getprotoent() functions.
+= Installation
+gem install net-proto
+
+= Synopsis
+require 'net/proto'
 
-== Prerequisites
-Ruby 1.8.0 or later.
+Net::Proto.getprotobyname('tcp') # => 6
+Net::Proto.getprotobynumber(0)   # => 'ip'
 
-== Installation
-rake test (optional)
-rake install (non-gem) OR rake install_gem (gem)
+Net::Proto.getprotoent{ |entry| p entry }
+
+= Notes
+This library is a wrapper for the getprotobyname(), getprotobynumber() and
+the getprotoent() functions.
 
-== Notes
 The net-proto package uses reentrant code for sunos and linux. Otherwise, the
 generic form of the functions are used (which may be reentrant by default
 anway - check the man pages on your platform).
@@ -19,12 +23,12 @@ anway - check the man pages on your platform).
 The Proto.getprotoent method is not supported on MS Windows because the
 underlying function isn't supported by the MS Windows API.
 
-== 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
+= Further Documentation
 See the 'netproto.txt' file under the 'doc' directory for more details.  There
 is also an example under the 'examples' directory.

data/Rakefile

@@ -6,74 +6,77 @@ include Config
 
 desc 'Clean the build files for the net-proto source' 
 task :clean do
-   make = RUBY_PLATFORM.match('mswin') ? 'nmake' : 'make'
-   Dir.chdir('ext') do
-      proto_file = 'proto.' + Config::CONFIG['DLEXT']
-      if File.exists?('proto.o') || File.exists?(proto_file)
-         sh "#{make} distclean"
-      end
-      FileUtils.rm_rf('proto.c') if File.exists?('proto.c')
-      FileUtils.rm_rf('net') if File.exists?('net')
-   end
-   FileUtils.rm_rf('net') if File.exists?('net')
+  Dir['*.gem'].each{ |f| File.delete(f) }
+  Dir['**/*.rbc'].each{ |f| File.delete(f) }
+
+  make = RUBY_PLATFORM.match('mswin') ? 'nmake' : 'make'
+
+  Dir.chdir('ext') do
+    proto_file = 'proto.' + Config::CONFIG['DLEXT']
+    if File.exists?('proto.o') || File.exists?(proto_file)
+      sh "#{make} distclean"
+    end
+    rm_rf('proto.c') if File.exists?('proto.c')
+    rm_rf('net') if File.exists?('net')
+  end
+
+  rm_rf('net') if File.exists?('net')
+  rm_rf('lib') if File.exists?('lib')
 end
 
 desc 'Build the net-proto library'
 task :build => [:clean] do
-   make = RUBY_PLATFORM.match('mswin') ? 'nmake' : 'make'
-   Dir.chdir('ext') do
-      ruby 'extconf.rb'
-      sh make
-      build_file = 'proto.' + Config::CONFIG['DLEXT']
-      Dir.mkdir('net') unless File.exists?('net')
-      FileUtils.cp(build_file, 'net')
-   end
+  make = RUBY_PLATFORM.match('mswin') ? 'nmake' : 'make'
+  Dir.chdir('ext') do
+    ruby 'extconf.rb'
+    sh make
+    build_file = 'proto.' + Config::CONFIG['DLEXT']
+    Dir.mkdir('net') unless File.exists?('net')
+    FileUtils.cp(build_file, 'net')
+  end
 end
 
-desc 'Install the net-proto library (non-gem)'
-task :install => [:build] do
-   Dir.chdir('ext') do
-      sh 'make install'
-   end
-end
+namespace :gem do
+  desc 'Build a standard gem'
+  task :create => :clean do
+    rm_rf('lib') if File.exists?('lib')
+    spec = eval(IO.read('net-proto.gemspec'))
+    Gem::Builder.new(spec).build
+  end
+
+  desc 'Build a binary gem'
+  task :create_binary => [:build] do
+    file = 'ext/net/proto.' + CONFIG['DLEXT']
+    mkdir_p('lib/net')
+    mv(file, 'lib/net')
+
+    spec = eval(IO.read('net-proto.gemspec'))
+    spec.extensions = nil
+    spec.files = spec.files.reject{ |f| f.include?('ext/') }
+    spec.platform = Gem::Platform::CURRENT
 
-desc 'Install the net-proto library (gem)'
-task :install_gem do
-   ruby 'net-proto.gemspec'
-   file = Dir["net-proto*.gem"].last
-   sh "gem install #{file}"
+    Gem::Builder.new(spec).build
+  end
+
+  desc 'Install the net-proto library (gem)'
+  task :install => [:create] do
+    ruby 'net-proto.gemspec'
+    file = Dir["net-proto*.gem"].last
+    sh "gem install #{file}"
+  end
 end
 
 desc 'Run the example net-proto program'
 task :example => [:build] do
-   Dir.mkdir('net') unless File.exists?('net')
-   ruby '-Iext examples/example_net_proto.rb'
+  Dir.mkdir('net') unless File.exists?('net')
+  ruby '-Iext examples/example_net_proto.rb'
 end
 
 Rake::TestTask.new do |t|
-   task :test => :build
-   t.libs << 'ext'
-   t.warning = true
-   t.verbose = true
-end
-
-desc 'Build a standard gem'
-task :build_gem => :clean do
-  rm_rf('lib') if File.exists?('lib')
-  spec = eval(IO.read('net-proto.gemspec'))
-  Gem::Builder.new(spec).build
+  task :test => :build
+  t.libs << 'ext'
+  t.warning = true
+  t.verbose = true
 end
 
-desc 'Build a binary gem'
-task :build_binary_gem => [:build] do
-   file = 'ext/net/proto.' + CONFIG['DLEXT']
-   mkdir_p('lib/net')
-   mv(file, 'lib/net')
-
-   spec = eval(IO.read('net-proto.gemspec'))
-   spec.extensions = nil
-   spec.files = spec.files.reject{ |f| f.include?('ext/') }
-   spec.platform = Gem::Platform::CURRENT
-
-   Gem::Builder.new(spec).build
-end
+task :default => :test

data/ext/version.h

@@ -1,2 +1,2 @@
 /* version.h - there can be only one */
-#define NET_PROTO_VERSION "1.0.4"
+#define NET_PROTO_VERSION "1.0.6"

data/net-proto.gemspec

@@ -4,27 +4,26 @@ require 'rubygems'
 # To build a binary gem  => rake build_binary_gem
 
 Gem::Specification.new do |gem|
-   gem.name       = 'net-proto'
-   gem.version    = '1.0.5'
-   gem.author     = 'Daniel J. Berger'
-   gem.license    = 'Artistic 2.0'
-   gem.email      = 'djberg96@gmail.com'
-   gem.homepage   = 'http://www.rubyforge.org/projects/sysutils'
-   gem.platform   = Gem::Platform::RUBY
-   gem.summary    = 'A Ruby interface for determining protocol information'
-   gem.test_file  = 'test/test_net_proto.rb'
-   gem.has_rdoc   = true
-   gem.extensions = ['ext/extconf.rb']
-   gem.files      = Dir['**/*'].reject{ |f| f.include?('CVS') }
+  gem.name       = 'net-proto'
+  gem.version    = '1.0.6'
+  gem.author     = 'Daniel J. Berger'
+  gem.license    = 'Artistic 2.0'
+  gem.email      = 'djberg96@gmail.com'
+  gem.homepage   = 'http://www.rubyforge.org/projects/sysutils'
+  gem.platform   = Gem::Platform::RUBY
+  gem.summary    = 'A Ruby interface for determining protocol information'
+  gem.test_file  = 'test/test_net_proto.rb'
+  gem.extensions = ['ext/extconf.rb']
+  gem.files      = Dir['**/*'].reject{ |f| f.include?('git') }
 
-   gem.rubyforge_project = 'sysutils'
-   gem.extra_rdoc_files  = ['CHANGES', 'README', 'MANIFEST', 'doc/netproto.txt']
+  gem.rubyforge_project = 'sysutils'
+  gem.extra_rdoc_files  = ['CHANGES', 'README', 'MANIFEST', 'doc/netproto.txt']
 
-   gem.add_development_dependency('test-unit', '>= 2.0.3')
+  gem.add_development_dependency('test-unit', '>= 2.1.1')
 
-   gem.description = <<-EOF
-      The net-proto library provides an interface for get protocol information
-      by name or by number. It can also iterate over the list of protocol
-      entries defined on your system.
-   EOF
-end
+  gem.description = <<-EOF
+    The net-proto library provides an interface for get protocol information
+    by name or by number. It can also iterate over the list of protocol
+    entries defined on your system.
+  EOF
+end

data/test/test_net_proto.rb

@@ -12,115 +12,126 @@ 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
-
-   def test_version
-      assert_equal('1.0.4', Net::Proto::VERSION)
-   end
-
-   def test_getprotobynumber_basic
-      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
-
-   def test_getprotobynumber_result_expected
-      assert_equal('icmp', Net::Proto.getprotobynumber(1))
-      assert_equal('tcp', Net::Proto.getprotobynumber(6))
-   end
-
-   def test_getprotbynumber_result_not_expected
-      assert_equal(nil, Net::Proto.getprotobynumber(9999999))
-      assert_equal(nil, Net::Proto.getprotobynumber(-1))
-   end
-
-   def test_getprotobynumber_expected_errors
-      assert_raise(TypeError){ Net::Proto.getprotobynumber('foo') }
-      assert_raise(TypeError){ Net::Proto.getprotobynumber(nil) }
-      assert_raise(RangeError){ Net::Proto.getprotobynumber(999999999999) }
-   end
-
-   def test_getprotobyname_basic
-      assert_respond_to(Net::Proto, :getprotobyname)
-      @@protocols.each{ |n| assert_nothing_raised{ Net::Proto.getprotobyname(n) } }
-   end
-
-   def test_getprotobyname_result_expected
-      assert_equal(1, Net::Proto.getprotobyname('icmp'))
-      assert_equal(6, Net::Proto.getprotobyname('tcp'))
-   end
-
-   def test_getprotobyname_result_not_expected
-      assert_equal(nil, Net::Proto.getprotobyname('foo'))
-      assert_equal(nil, Net::Proto.getprotobyname('tcpx'))
-      assert_equal(nil, Net::Proto.getprotobyname(''))
-   end
-
-   def test_getprotobyname_expected_errors
-      assert_raises(TypeError){ Net::Proto.getprotobyname(1) }
-      assert_raises(TypeError){ Net::Proto.getprotobyname(nil) }        
-   end
-
-   def test_getprotoent_basic
-      omit_if(Config::CONFIG['host_os'].match('mswin'), 'Skipped on MS Windows')
-
-      assert_respond_to(Net::Proto, :getprotoent)    
-      assert_nothing_raised{ Net::Proto.getprotoent }
-      assert_kind_of(Array, Net::Proto.getprotoent)
-   end
-
-   def test_getprotoent
-      omit_if(Config::CONFIG['host_os'].match('mswin'), 'Skipped on MS Windows')
-
-      assert_kind_of(Struct::ProtoStruct, Net::Proto.getprotoent.first)
-      assert_nil(Net::Proto.getprotoent{})
-   end
-
-   def test_getprotoent_struct
-      omit_if(Config::CONFIG['host_os'].match('mswin'), 'Skipped on MS Windows')
-
-      @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
-
-   def test_getprotoent_struct_aliases_member
-      omit_if(Config::CONFIG['host_os'].match('mswin'), 'Skipped on MS Windows')
-
-      @protoent = Net::Proto.getprotoent.first
-      assert_true(@protoent.aliases.all?{ |e| e.is_a?(String) })
-   end
-
-   def test_getprotoent_struct_frozen
-      omit_if(Config::CONFIG['host_os'].match('mswin'), 'Skipped on MS Windows')
-
-      @protoent = Net::Proto.getprotoent.first
-      assert_true(@protoent.frozen?)
-   end
+  # These were the protocols listed in my own /etc/protocols file on Solaris 9
+  def self.startup
+    @@windows = Config::CONFIG['host_os'] =~ /win32|msdos|mswin|cygwin|mingw/i
+
+    @@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 returns expected value" do
+    assert_equal('1.0.6', Net::Proto::VERSION)
+  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 the protocol cannot be found" do
+    assert_equal(nil, Net::Proto.getprotobynumber(9999999))
+    assert_equal(nil, Net::Proto.getprotobynumber(-1))
+  end
+
+  test "getprotobynumber requires a numeric argument" do
+    assert_raise(TypeError){ Net::Proto.getprotobynumber('foo') }
+    assert_raise(TypeError){ Net::Proto.getprotobynumber(nil) }
+  end
+
+  test "getprotobyname basic functionality" do
+    assert_respond_to(Net::Proto, :getprotobyname)
+    @@protocols.each{ |n| assert_nothing_raised{ Net::Proto.getprotobyname(n) } }
+    assert_kind_of(Fixnum, Net::Proto.getprotobyname('tcp'))
+  end
+
+  test "getprotobyname returns 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 cannot be found" do
+    assert_equal(nil, Net::Proto.getprotobyname('foo'))
+    assert_equal(nil, Net::Proto.getprotobyname('tcpx'))
+    assert_equal(nil, Net::Proto.getprotobyname(''))
+  end
+
+  test "getprotobyname requires a string argument" do
+    assert_raises(TypeError){ Net::Proto.getprotobyname(1) }
+    assert_raises(TypeError){ Net::Proto.getprotobyname(nil) }        
+  end
+
+  test "getprotoent basic functionality" do
+    omit_if(@@windows, 'Skipped on MS Windows')
+    assert_respond_to(Net::Proto, :getprotoent)    
+    assert_nothing_raised{ Net::Proto.getprotoent }
+  end
+
+  test "getprotoent returns an array if no block is provided" do
+    omit_if(@@windows, 'Skipped on MS Windows')
+    assert_kind_of(Array, Net::Proto.getprotoent)
+  end
+
+  test "getprotoent accepts a block" do
+    omit_if(@@windows, 'Skipped on MS Windows')
+    assert_nothing_raised{ Net::Proto.getprotoent{} }
+    assert_nil(Net::Proto.getprotoent{})
+  end
+
+  test "getprotoent returns an array of structs" do
+    omit_if(@@windows, 'Skipped on MS Windows')
+    assert_kind_of(Struct::ProtoStruct, Net::Proto.getprotoent.first)
+  end
+
+  test "structs returned by getprotoent contain specific members" do
+    omit_if(@@windows, 'Skipped on MS Windows')
+    @protoent = Net::Proto.getprotoent.first
+    assert_equal(['name', 'aliases', 'proto'], @protoent.members)
+  end
+
+  test "struct members are of a specific type" do
+    omit_if(@@windows, 'Skipped on MS Windows')
+    @protoent = Net::Proto.getprotoent.first
+    assert_kind_of(String, @protoent.name)
+    assert_kind_of(Array, @protoent.aliases)
+    assert_kind_of(Integer, @protoent.proto)
+  end
+
+  test "aliases struct member returns an array of strings" do
+    omit_if(@@windows, 'Skipped on MS Windows')
+    @protoent = Net::Proto.getprotoent.first
+    assert_true(@protoent.aliases.all?{ |e| e.is_a?(String) })
+  end
+
+  test "the structs returned by getprotoent are frozen" do
+    omit_if(@@windows, 'Skipped on MS Windows')
+    @protoent = Net::Proto.getprotoent.first
+    assert_true(@protoent.frozen?)
+  end
    
-   def test_constructor_illegal
-      assert_raise(NoMethodError){ Net::Proto.new }      
-   end
+  test "there is no constructor for the Proto class" do
+    assert_raise(NoMethodError){ Net::Proto.new }      
+  end
 
-   def teardown
-      @protoent = nil
-   end
+  def teardown
+    @protoent = nil
+  end
    
-   def self.shutdown
-      @@protocols = nil
-   end
+  def self.shutdown
+    @@protocols = nil
+  end
 end

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: net-proto
 version: !ruby/object:Gem::Version 
-  version: 1.0.5
+  hash: 27
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 6
+  version: 1.0.6
 platform: ruby
 authors: 
 - Daniel J. Berger
@@ -9,20 +15,26 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-12 00:00:00 -06:00
+date: 2010-10-22 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: test-unit
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 2.0.3
-    version: 
-description: "      The net-proto library provides an interface for get protocol information\n      by name or by number. It can also iterate over the list of protocol\n      entries defined on your system.\n"
+        hash: 9
+        segments: 
+        - 2
+        - 1
+        - 1
+        version: 2.1.1
+  type: :development
+  version_requirements: *id001
+description: "    The net-proto library provides an interface for get protocol information\n    by name or by number. It can also iterate over the list of protocol\n    entries defined on your system.\n"
 email: djberg96@gmail.com
 executables: []
 
@@ -34,20 +46,20 @@ extra_rdoc_files:
 - MANIFEST
 - doc/netproto.txt
 files: 
-- CHANGES
+- Rakefile
+- README
 - doc/netproto.txt
+- net-proto.gemspec
+- CHANGES
 - examples/example_net_proto.rb
+- test/test_net_proto.rb
+- MANIFEST
 - ext/extconf.rb
+- ext/version.h
 - ext/generic/generic.c
 - ext/linux/linux.c
 - ext/sunos/sunos.c
-- ext/version.h
 - ext/windows/windows.c
-- MANIFEST
-- net-proto.gemspec
-- Rakefile
-- README
-- test/test_net_proto.rb
 has_rdoc: true
 homepage: http://www.rubyforge.org/projects/sysutils
 licenses: 
@@ -58,21 +70,27 @@ rdoc_options: []
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: sysutils
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: A Ruby interface for determining protocol information