netaddr 2.0.1 → 2.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8baac76897c5888273f82c02b7719ac40704dde4
-  data.tar.gz: 55829efe0e322cd809cc8113fe88c74e4597f7fb
+  metadata.gz: 89ce300b6a351757d48c569e132c3e1346f7b09a
+  data.tar.gz: 5f11179793ee8a0d5a42758524b7aa49f71392cc
 SHA512:
-  metadata.gz: 64de30c364321364056cd9e50f1468991109203cdc58d7d3d0fa0f7626455ee8c42fd2fabe505efdaefa442b344fb03ed0354c43b39abf31470359007722bec7
-  data.tar.gz: ff8813e6e0319932083ea4e994e4194473ac439d579df47b45faf2e2b86a72895be082b33a663ad9705a55a706815685c18c8880ac5313d59b54265dc0e599a1
+  metadata.gz: 36acfbba061405495f4e4d08c271f6be19c9810de6c5a44f78a2ebf407cf24637dac6b50277c82cc6048e36d00785e143aa37170e0101d40638b36f77e575c5a
+  data.tar.gz: c9baee3f002fb16def0f60f8e9304b44015739f0a5f844b1413f8b20d2d80c9bc73678654f81906ef14255f9928b64a3153eba120e387f4044bd558e5d6f5df3

data/lib/ipv4.rb

@@ -67,6 +67,11 @@ module NetAddr
 			return IPv4.new(self.addr - 1)
 		end
 		
+		# to_net returns the IPv4 as a IPv4Net
+		def to_net()
+			NetAddr::IPv4Net.new(self,nil)
+		end
+		
 		# to_s returns the IPv4 as a String
 		def to_s()
 			Util.int_to_IPv4(@addr)

data/lib/ipv4net.rb

@@ -43,12 +43,13 @@ module NetAddr
 			return @base.to_s + " " + Util.int_to_IPv4(@m32.mask)
 		end
 		
-		#cmp compares equality with another IPv4Net. Return:
-		#* 1 if this IPv4Net is numerically greater
-		#* 0 if the two are equal
-		#* -1 if this IPv4Net is numerically less
+		# cmp compares equality with another IPv4Net. Return:
+		# * 1 if this IPv4Net is numerically greater
+		# * 0 if the two are equal
+		# * -1 if this IPv4Net is numerically less
 		#
-		#The comparison is initially performed on using the cmp() method of the network address, however, in cases where the network #addresses are identical then the netmasks will be compared with the cmp() method of the netmask. 
+		# The comparison is initially performed on using the cmp() method of the network address, however, in cases where the network
+		# addresses are identical then the netmasks will be compared with the cmp() method of the netmask. 
 		def cmp(other)
 			if (!other.kind_of?(IPv4Net))
 				raise ArgumentError, "Expected an IPv4Net object for 'other' but got a #{other.class}."
@@ -60,6 +61,17 @@ module NetAddr
 			return self.netmask.cmp(other.netmask)
 		end
 		
+		#contains returns true if the IPv4Net contains the IPv4
+		def contains(ip)
+			if (!ip.kind_of?(IPv4))
+				raise ArgumentError, "Expected an IPv4 object for 'ip' but got a #{ip.class}."
+			end
+			if (@base.addr == ip.addr & @m32.mask)
+				return true
+			end
+			return false
+		end
+		
 		# fill returns a copy of the given Array, stripped of any networks which are not subnets of this IPv4Net
 		# and with any missing gaps filled in.
 		def fill(list)

data/lib/ipv6.rb

@@ -16,7 +16,7 @@ module NetAddr
 			@addr = i
 		end
 		
-		# parse will create an IPv6 from its string representation (ie. "192.168.1.1").
+		# parse will create an IPv6 from its string representation (ie. "1::").
 		# Throws ValidationError on error.
 		def IPv6.parse(ip)
 			ip.strip!
@@ -24,10 +24,10 @@ module NetAddr
 			return IPv6.new(i)
 		end
 		
-		#cmp compares equality with another IPv6. Return:
-		#* 1 if this IPv6 is numerically greater
-		#* 0 if the two are equal
-		#* -1 if this IPv6 is numerically less
+		# cmp compares equality with another IPv6. Return:
+		# * 1 if this IPv6 is numerically greater
+		# * 0 if the two are equal
+		# * -1 if this IPv6 is numerically less
 		def cmp(other)
 			if (!other.kind_of?(IPv6))
 				raise ArgumentError, "Expected an IPv6 object for 'other' but got a #{other.class}."
@@ -66,6 +66,11 @@ module NetAddr
 			return IPv6.new(self.addr - 1)
 		end
 		
+		# to_net returns the IPv6 as a IPv6Net
+		def to_net()
+			NetAddr::IPv6Net.new(self,nil)
+		end
+		
 		# to_s returns the IPv6 as a String in zero-compressed format (per rfc5952).
 		def to_s()
 			hexStr = ["","","","","","","",""]

data/lib/ipv6net.rb

@@ -24,7 +24,7 @@ module NetAddr
 			@base = IPv6.new(ip.addr & m128.mask)
 		end
 		
-		# parse will create an IPv6Net from its string representation. Will default to a /64 netmask if not specified.
+		# parse will create an IPv6Net from its string representation. A default netmask will be used if not specified.
 		# Throws ValidationError on error.
 		def IPv6Net.parse(net)
 			m128 = nil
@@ -39,12 +39,13 @@ module NetAddr
 			return IPv6Net.new(ip,m128)
 		end
 		
-		#cmp compares equality with another IPv6Net. Return:
-		#* 1 if this IPv6Net is numerically greater
-		#* 0 if the two are equal
-		#* -1 if this IPv6Net is numerically less
+		# cmp compares equality with another IPv6Net. Return:
+		# * 1 if this IPv6Net is numerically greater
+		# * 0 if the two are equal
+		# * -1 if this IPv6Net is numerically less
 		#
-		#The comparison is initially performed on using the cmp() method of the network address, however, in cases where the network #addresses are identical then the netmasks will be compared with the cmp() method of the netmask. 
+		# The comparison is initially performed on using the cmp() method of the network address, however, in cases where the network
+		# addresses are identical then the netmasks will be compared with the cmp() method of the netmask. 
 		def cmp(other)
 			if (!other.kind_of?(IPv6Net))
 				raise ArgumentError, "Expected an IPv6Net object for 'other' but got a #{other.class}."
@@ -56,6 +57,17 @@ module NetAddr
 			return self.netmask.cmp(other.netmask)
 		end
 		
+		#contains returns true if the IPv6Net contains the IPv6
+		def contains(ip)
+			if (!ip.kind_of?(IPv6))
+				raise ArgumentError, "Expected an IPv6 object for 'ip' but got a #{ip.class}."
+			end
+			if (@base.addr == ip.addr & @m128.mask)
+				return true
+			end
+			return false
+		end
+		
 		# fill returns a copy of the given Array, stripped of any networks which are not subnets of this IPv6Net
 		# and with any missing gaps filled in.
 		def fill(list)
@@ -68,6 +80,11 @@ module NetAddr
 			return self.netmask.len
 		end
 		
+		# long returns the IPv6Net as a string in long (uncompressed) format
+		def long()
+			return @base.long() + @m128.to_s
+		end
+		
 		# netmask returns the Mask128 object representing the netmask for this network
 		def netmask()
 			@m128
@@ -116,13 +133,13 @@ module NetAddr
 			return sub0.nth_next_sib(index)
 		end
 		
-		# prev returns the previous largest consecutive IP network or nil if this is 0.0.0.0.
+		# prev returns the previous largest consecutive IP network or nil if this is ::.
 		def prev()
 			net = self.grow
 			return net.prev_sib
 		end
 		
-		# prev_sib returns the network immediately preceding this one or nil if this network is 0.0.0.0.
+		# prev_sib returns the network immediately preceding this one or nil if this network is ::.
 		def prev_sib()
 			if (self.network.addr == 0)
 				return nil
@@ -223,7 +240,6 @@ module NetAddr
 				prefix_len -= 1
 			end
 			
-			newNet = IPv6Net.new(IPv6.new(addr),Mask128.new(prefix_len))
 			return IPv6Net.new(IPv6.new(addr),Mask128.new(prefix_len))
 		end
 		

data/test/examples.rb

@@ -42,6 +42,21 @@ class NetAddrExamples < Test::Unit::TestCase
 			puts "  " + ip.to_s
 		end
 		
+		puts "\nDoes 10.0.0.7 belong to the 10.0.0.8/29 subnet?"
+		subnet29 = NetAddr::IPv4Net.parse("10.0.0.8/29")
+		if subnet29.contains(NetAddr::IPv4.parse("10.0.0.7"))
+			puts " yes"
+		else
+			puts " no"
+		end
+		
+		puts "\nDoes 10.0.0.10 belong to the 10.0.0.8/29 subnet?"
+		if subnet29.contains(NetAddr::IPv4.parse("10.0.0.10"))
+			puts " yes"
+		else
+			puts " no"
+		end 
+		
 		puts "\nGiven the 3rd /30 of 10.0.0.0/24, fill in the holes:"
 		expect = ["10.0.0.0/29","10.0.0.8/30","10.0.0.12/30","10.0.0.16/28","10.0.0.32/27","10.0.0.64/26","10.0.0.128/25"]
 		i = 0
@@ -82,6 +97,9 @@ class NetAddrExamples < Test::Unit::TestCase
 		puts "\nRendering as a String: " + net.to_s
 		assert_equal("fec0::/62", net.to_s)
 		
+		puts "\nRendering as a String (long format): " + net.long
+		assert_equal("fec0:0000:0000:0000:0000:0000:0000:0000/62", net.long)
+		
 		puts "\nIterating its /64 subnets:"
 		expect = ["fec0::/64","fec0:0:0:1::/64","fec0:0:0:2::/64","fec0:0:0:3::/64"]
 		0.upto(net.subnet_count(64) - 1) do |i|

data/test/ipv4_test.rb

@@ -26,7 +26,7 @@ class TestIPv4 < Test::Unit::TestCase
 	def test_cmp
 		ip = NetAddr::IPv4.parse("128.0.0.1")
 		ip2 = NetAddr::IPv4.parse("128.0.0.0")
-		ip3 =NetAddr::IPv4.parse("128.0.0.2")
+		ip3 = NetAddr::IPv4.parse("128.0.0.2")
 		ip4 = NetAddr::IPv4.parse("128.0.0.1")
 		assert_equal(1, ip.cmp(ip2))
 		assert_equal(-1, ip.cmp(ip3))
@@ -51,4 +51,10 @@ class TestIPv4 < Test::Unit::TestCase
 		assert_equal("0.0.0.0", NetAddr::IPv4.parse("0.0.0.1").prev().to_s)
 		assert_nil(NetAddr::IPv4.parse("0.0.0.0").prev())
 	end
+	
+	def test_to_net
+		ip = NetAddr::IPv4.parse("192.168.1.1")
+		net = NetAddr::IPv4Net.parse("192.168.1.1")
+		assert_equal(0, net.cmp(ip.to_net()))
+	end
 end

data/test/ipv4net_test.rb

@@ -35,6 +35,17 @@ class TestIPv4Net < Test::Unit::TestCase
 		assert_equal(0, net1.cmp(net5)) # eq
 	end
 	
+	def test_contains
+		net = NetAddr::IPv4Net.parse("1.0.0.8/29")
+		ip1 = NetAddr::IPv4.parse("1.0.0.15")
+		ip2 = NetAddr::IPv4.parse("1.0.0.16")
+		ip3 = NetAddr::IPv4.parse("1.0.0.7")
+		
+		assert_equal(true, net.contains(ip1))
+		assert_equal(false, net.contains(ip2))
+		assert_equal(false, net.contains(ip3))
+	end
+	
 	def test_extended
 		net = NetAddr::IPv4Net.parse("128.0.0.1/24")
 		assert_equal("128.0.0.0 255.255.255.0", net.extended)

data/test/ipv6_test.rb

@@ -67,6 +67,12 @@ class TestIPv6 < Test::Unit::TestCase
 		assert_nil(NetAddr::IPv6.parse("::").prev())
 	end
 	
+	def test_to_net
+		ip = NetAddr::IPv6.parse("1::")
+		net = NetAddr::IPv6Net.parse("1::")
+		assert_equal(0, net.cmp(ip.to_net()))
+	end
+	
 	def test_to_s
 		assert_equal("::", NetAddr::IPv6.parse("0:0:0:0:0:0:0:0").to_s)
 		assert_equal("1::", NetAddr::IPv6.parse("1:0:0:0:0:0:0:0").to_s)

data/test/ipv6net_test.rb

@@ -35,6 +35,17 @@ class TestIPv6Net < Test::Unit::TestCase
 		assert_equal(1, net1.cmp(net4)) # ip eq, mask greater
 		assert_equal(0, net1.cmp(net5)) # eq
 	end
+	
+	def test_contains
+		net = NetAddr::IPv6Net.parse("1:8::/29")
+		ip1 = NetAddr::IPv6.parse("1:f::")
+		ip2 = NetAddr::IPv6.parse("1:10::")
+		ip3 = NetAddr::IPv6.parse("1:7::")
+		
+		assert_equal(true, net.contains(ip1))
+		assert_equal(false, net.contains(ip2))
+		assert_equal(false, net.contains(ip3))
+	end
 
 	def test_fill
 		parent = NetAddr::IPv6Net.parse("ff00::/8")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: netaddr
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.0.3
 platform: ruby
 authors:
 - Dustin Spinhirne
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-22 00:00:00.000000000 Z
+date: 2018-03-23 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: 
@@ -61,7 +61,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2.1
 signing_key: 
 specification_version: 4
 summary: A Ruby library for performing calculations on IPv4 and IPv6 subnets.