ipaddress 0.7.0 → 0.7.5

data/CHANGELOG.rdoc

@@ -1,4 +1,11 @@
-== master
+== ipaddress 0.7.5
+
+CHANGED:: IPAddress::IPv4#each_host to improve speed
+FIXED::   IPAddress::IPv4::summarize bug (summarization should now work properly)
+NEW::     IPAddress::IPv4#include_all?
+NEW::     #ipv4? and #ipv6?
+
+== ipaddress 0.7.0
 
 NEW:: IPAddress::IPv6#include?
 NEW:: IPAddress::IPv6#network_u128

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 Marco Ceresa
+Copyright (c) 2009-2011 Marco Ceresa
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -81,7 +81,7 @@ documentation with Rake:
   ipaddress$ rake rdoc
 
 The latest documentation can be found online at 
-{this address}[http://rubydoc.info/github/bluemonk/ipaddress/master/frames]
+{this address}[http://rubydoc.info/gems/ipaddress/0.7.0/frames]
  
 == IPv4
 
@@ -108,7 +108,7 @@ or, in a easier way, using the IPAddress parse method
 which accepts and parses any kind of IP (IPv4, IPV6 and 
 IPv4 IPv6 Mapped addresses).
 
-If you like sintactic sugar, you can use the wrapper method
+If you like syntactic sugar, you can use the wrapper method
 IPAddress(), which is built around IPAddress::parse:
 
   ip = IPAddress "172.16.10.1/24"
@@ -246,7 +246,7 @@ address has all one's. For example, ip "172.16.10.1/24" has broadcast
 "172.16.10.255/24", where ip "172.16.10.1/16" has broadcast
 "172.16.255.255/16".
 
-Method IPv4#broadcast has the same behaviour as is #network
+Method IPv4#broadcast has the same behavior as is #network
 counterpart: it creates a new IPv4 object to handle the broadcast
 address:
  
@@ -277,7 +277,7 @@ It is important to note that it doesn't matter if the original IP is a
 host IP or a network number (or a broadcast address): the #each method
 only considers the range that the original IP specifies. 
 
-If you only want to iterate over hosts IP, use the Ipv4#each_host
+If you only want to iterate over hosts IP, use the IPv4#each_host
 method:
 
   ip = IPAddress "172.16.10.1/24"
@@ -327,7 +327,7 @@ the IPv4#to_u32 method
 
 This method is the equivalent of the Unix call pton(), expressing an
 IP address in the so called +network byte order+ notation. However, if
-you want to trasmit your IP over a network socket, you might need to
+you want to transmit your IP over a network socket, you might need to
 transform it in data format using the IPv4#data method:
 
   ip.data
@@ -382,7 +382,7 @@ You can easily check which CLASSFUL network an IPv4 object belongs:
     #=> true
 
 Remember that these methods are only checking the address portion of an IP, and are
-indipendent from its prefix, as classful networks have no concept of prefix.
+independent from its prefix, as classful networks have no concept of prefix.
 
 For more information on CLASSFUL networks visit the 
 {Wikipedia page}[http://en.wikipedia.org/wiki/Classful_network]
@@ -430,7 +430,7 @@ example:
 
 Usually, subnetting implies dividing a network to a number of subnets
 which is a power of two: in this way, you can be sure that the network
-will be divived evenly, and all the subnets will have the same number
+will be divided evenly, and all the subnets will have the same number
 of hosts. 
 
 ==== Uneven subnetting
@@ -460,7 +460,7 @@ We can go even further and divide into 11 subnets:
          "172.16.10.160/27", "172.16.10.192/26"]
 	 
 As you can see, most of the networks are /28, with a few /27 and one
-/26 to fill up the remaning space.
+/26 to fill up the remaining space.
 
 ==== Summarization
 
@@ -569,7 +569,7 @@ our projects.
 IPv6 addresses are 128 bits long, in contrast with IPv4 addresses
 which are only 32 bits long. An IPv6 address is generally written as
 eight groups of four hexadecimal digits, each group representing 16
-bits or two octect. For example, the following is a valid IPv6
+bits or two octet. For example, the following is a valid IPv6
 address: 
 
   1080:0000:0000:0000:0008:0800:200c:417a
@@ -581,7 +581,7 @@ they will be converted.
 ==== Compression
 
 Since IPv6 addresses are very long to write, there are some
-semplifications and compressions that you can use to shorten them. 
+simplifications and compressions that you can use to shorten them. 
 
 * Leading zeroes: all the leading zeroes within a group can be
   omitted: "0008" would become "8"
@@ -765,7 +765,7 @@ Finally, a new IPv6 address can be created from an hex string:
 === Special IPv6 addresses
 
 Some IPv6 have a special meaning and are expressed in a special form,
-quite different than an usual IPv6 address. IPAddress has builtin
+quite different than an usual IPv6 address. IPAddress has built-in
 support for unspecified, loopback and mapped IPv6 addresses.
 
 ==== Unspecified address
@@ -921,14 +921,15 @@ Feel free to join us and tell us what you think!
 
 == Thanks to
  
-Thanks to Luca Russo (vargolo) and Simone Carletti (weppos) for all 
-the support and technical review. Thanks to Marco Beri, Bryan T. Richardson,
-Nicolas Fevrier, jdpace, Daniele Alessandri and Steve Rawlinson for 
-their support, feedback and bug reports.
+Thanks to Luca Russo (vargolo) and Simone Carletti 
+(weppos) for all the support and technical review. Thanks to Marco Beri, 
+Bryan T. Richardson, Nicolas Fevrier, jdpace, Daniele Alessandri, jrdioko, 
+Ghislain Charrier, Pawel Krzesniak, Mark Sullivan, Erik Ahlström and 
+Steve Rawlinson for their support, feedback and bug reports.
   
 == Copyright
 
-Copyright (c) 2009-2010 Marco Ceresa. See LICENSE for details.
+Copyright (c) 2009-2011 Marco Ceresa. See LICENSE for details.
 
 
  

data/VERSION

@@ -1 +1 @@
-0.7.0
+0.7.5

data/lib/ipaddress.rb

@@ -22,7 +22,7 @@ module IPAddress
   NAME            = "IPAddress"
   GEM             = "ipaddress"
   AUTHORS         = ["Marco Ceresa <ceresa@ieee.org>"]
-  
+
   #
   # Parse the argument string to create a new
   # IPv4, IPv6 or Mapped IP object
@@ -50,6 +50,30 @@ module IPAddress
     end
   end
 
+  #
+  # True if the object is an IPv4 address
+  #
+  #   ip = IPAddress("192.168.10.100/24")
+  #
+  #   ip.ipv4?
+  #     #-> true
+  #
+  def ipv4?
+    self.kind_of? IPAddress::IPv4
+  end
+  
+  #
+  # True if the object is an IPv6 address
+  #
+  #   ip = IPAddress("192.168.10.100/24")
+  #
+  #   ip.ipv6?
+  #     #-> false
+  #
+  def ipv6?
+    self.kind_of? IPAddress::IPv6
+  end
+
   # 
   # Checks if the given string is a valid IP address,
   # either IPv4 or IPv6

data/lib/ipaddress/ipv4.rb

@@ -382,7 +382,7 @@ module IPAddress;
     #
     #   ip = IPAddress("10.0.0.1/29")
     #
-    #   ip.each do |i|
+    #   ip.each_host do |i|
     #     p i.to_s
     #   end
     #     #=> "10.0.0.1"
@@ -393,8 +393,8 @@ module IPAddress;
     #     #=> "10.0.0.6"
     #
     def each_host
-      hosts.each do |i|
-        yield i
+      (network_u32+1..broadcast_u32-1).each do |i|
+        yield self.class.parse_u32(i, @prefix)
       end
     end
 
@@ -520,8 +520,7 @@ module IPAddress;
     #
     # Checks whether a subnet includes the given IP address.
     #
-    # Accepts either string with the IP or and IPAddress::IPv4
-    # object.
+    # Accepts an IPAddress::IPv4 object.
     #
     #   ip = IPAddress("192.168.10.100/24")
     #
@@ -537,6 +536,46 @@ module IPAddress;
       @prefix <= oth.prefix and network_u32 == (oth.to_u32 & @prefix.to_u32)
     end
 
+    #
+    # Checks whether a subnet includes all the 
+    # given IPv4 objects.
+    #
+    #   ip = IPAddress("192.168.10.100/24")
+    #
+    #   addr1 = IPAddress("192.168.10.102/24")
+    #   addr2 = IPAddress("192.168.10.103/24")
+    #
+    #   ip.include_all?(addr1,addr2)
+    #     #=> true
+    #
+    def include_all?(*others)
+      others.all? {|oth| include?(oth)}
+    end
+    
+    #
+    # True if the object is an IPv4 address
+    #
+    #   ip = IPAddress("192.168.10.100/24")
+    #
+    #   ip.ipv4?
+    #     #-> true
+    #
+#    def ipv4?
+#      true
+#    end
+
+    #
+    # True if the object is an IPv6 address
+    #
+    #   ip = IPAddress("192.168.10.100/24")
+    #
+    #   ip.ipv6?
+    #     #-> false
+    #
+#    def ipv6?
+#      false
+#    end
+
     #
     # Checks if an IPv4 address objects belongs
     # to a private network RFC1918
@@ -943,20 +982,15 @@ module IPAddress;
     end
 
     def aggregate(ip1,ip2)
-      if ip1.include? ip2
-        return [ip1]
+      return [ip1] if ip1.include? ip2
+
+      snet = ip1.supernet(ip1.prefix-1)
+      if snet.include_all?(ip1, ip2) && ((ip1.size + ip2.size) == snet.size)
+        return [snet]
       else
-        snet = ip1.supernet(ip1.prefix-1)
-        arr1 = ip1.subnet(2**(ip2.prefix-ip1.prefix)).map{|i| i.to_string}
-        arr2 = snet.subnet(2**(ip2.prefix-snet.prefix)).map{|i| i.to_string} 
-        if (arr2 - [ip2.to_string] - arr1).empty?
-          return [snet]
-        else
-          return [ip1, ip2]
-        end
+        return [ip1, ip2]
       end
     end
-    
   end # class IPv4
 end # module IPAddress
 

data/lib/ipaddress/prefix.rb

@@ -92,8 +92,8 @@ module IPAddress
     #     #=> 24
     #
     def initialize(num)
-      unless (1..32).include? num
-        raise ArgumentError, "Prefix must be in range 1..32, got: #{num}"
+      unless (0..32).include? num
+        raise ArgumentError, "Prefix must be in range 0..32, got: #{num}"
       end
       super(num)
     end
@@ -121,7 +121,7 @@ module IPAddress
     #     #=> "11111111111111111111111100000000"
     #
     def bits
-      to_u32.to_s(2)
+      "%.32b" % to_u32
     end
 
     #

data/test/ipaddress/ipv4_test.rb

@@ -6,6 +6,7 @@ class IPv4Test < Test::Unit::TestCase
     @klass = IPAddress::IPv4
 
     @valid_ipv4 = {
+      "0.0.0.0/0" => ["0.0.0.0", 0],
       "10.0.0.0" => ["10.0.0.0", 32],
       "10.0.0.1" => ["10.0.0.1", 32],
       "10.0.0.1/24" => ["10.0.0.1", 24],
@@ -21,12 +22,14 @@ class IPv4Test < Test::Unit::TestCase
                          "10.1-254.0.0"]
 
     @netmask_values = {
+      "0.0.0.0/0"        => "0.0.0.0",
       "10.0.0.0/8"       => "255.0.0.0",
       "172.16.0.0/16"    => "255.255.0.0",
       "192.168.0.0/24"   => "255.255.255.0",
       "192.168.100.4/30" => "255.255.255.252"}
 
     @decimal_values ={      
+      "0.0.0.0/0"        => 0,
       "10.0.0.0/8"       => 167772160,
       "172.16.0.0/16"    => 2886729728,
       "192.168.0.0/24"   => 3232235520,
@@ -237,6 +240,22 @@ class IPv4Test < Test::Unit::TestCase
     assert_equal false, ip.include?(@klass.new("13.16.0.0/32"))    
   end
 
+  def test_method_include_all?
+    ip = @klass.new("192.168.10.100/24")
+    addr1 = @klass.new("192.168.10.102/24")
+    addr2 = @klass.new("192.168.10.103/24")    
+    assert_equal true, ip.include_all?(addr1,addr2)
+    assert_equal false, ip.include_all?(addr1, @klass.new("13.16.0.0/32"))
+  end
+
+  def test_method_ipv4?
+    assert_equal true, @ip.ipv4?
+  end
+  
+  def test_method_ipv6?
+    assert_equal false, @ip.ipv6?
+  end
+    
   def test_method_private?
     assert_equal true, @klass.new("192.168.10.50/24").private?
     assert_equal true, @klass.new("192.168.10.50/16").private?
@@ -453,6 +472,21 @@ class IPv4Test < Test::Unit::TestCase
     result = ["10.0.1.0/24","10.10.2.0/24","172.16.0.0/23"]
     assert_equal result, @klass.summarize(ip1,ip2,ip3,ip4).map{|i| i.to_string}
 
+    ips = [@klass.new("10.0.0.12/30"),
+           @klass.new("10.0.100.0/24")]
+    result = ["10.0.0.12/30", "10.0.100.0/24"]
+    assert_equal result, @klass.summarize(*ips).map{|i| i.to_string}
+
+    ips = [@klass.new("172.16.0.0/31"),
+           @klass.new("10.10.2.1/32")]
+    result = ["10.10.2.1/32", "172.16.0.0/31"]
+    assert_equal result, @klass.summarize(*ips).map{|i| i.to_string}    
+           
+    ips = [@klass.new("172.16.0.0/32"),
+           @klass.new("10.10.2.1/32")]
+    result = ["10.10.2.1/32", "172.16.0.0/32"]
+    assert_equal result, @klass.summarize(*ips).map{|i| i.to_string}    
+
   end
 
   def test_classmethod_parse_data

data/test/ipaddress/ipv6_test.rb

@@ -106,6 +106,14 @@ class IPv6Test < Test::Unit::TestCase
     end
   end
 
+  def test_method_ipv4?
+    assert_equal false, @ip.ipv4?
+  end
+  
+  def test_method_ipv6?
+    assert_equal true, @ip.ipv6?
+  end
+
   def test_method_network?
     assert_equal true, @network.network?
     assert_equal false, @ip.network?
@@ -197,22 +205,6 @@ class IPv6Test < Test::Unit::TestCase
     assert_not_equal compressed, @klass.compress("2001:0db8::cd3")
   end
 
-#   def test_classmethod_create_unpecified
-#     unspec = @klass.create_unspecified
-#     assert_equal "::", unspec.address
-#     assert_equal 128, unspec.prefix
-#     assert_equal true, unspec.unspecified?
-#     assert_instance_of @klass, unspec.class
-#   end
-  
-#   def test_classmethod_create_loopback
-#     loopb = @klass.create_loopback
-#     assert_equal "::1", loopb.address
-#     assert_equal 128, loopb.prefix
-#     assert_equal true, loopb.loopback?
-#     assert_instance_of @klass, loopb.class
-#   end
-
   def test_classmethod_parse_data
     str = " \001\r\270\000\000\000\000\000\b\b\000 \fAz"
     ip = @klass.parse_data str
@@ -231,7 +223,7 @@ class IPv6Test < Test::Unit::TestCase
     assert_equal @ip.to_s, @klass.parse_hex(@hex,64).to_s
   end
 
-end # class IPv4Test
+end # class IPv6Test
 
 class IPv6UnspecifiedTest < Test::Unit::TestCase
   
@@ -259,6 +251,10 @@ class IPv6UnspecifiedTest < Test::Unit::TestCase
     assert_equal @string, @ip.to_string_uncompressed
     assert_equal @u128, @ip.to_u128
   end
+
+  def test_method_ipv6?
+    assert_equal true, @ip.ipv6?
+  end
   
 end # class IPv6UnspecifiedTest
 
@@ -289,6 +285,10 @@ class IPv6LoopbackTest < Test::Unit::TestCase
     assert_equal @string, @ip.to_string_uncompressed
     assert_equal @u128, @ip.to_u128
   end
+
+  def test_method_ipv6?
+    assert_equal true, @ip.ipv6?
+  end
   
 end # class IPv6LoopbackTest
 
@@ -345,6 +345,10 @@ class IPv6MappedTest < Test::Unit::TestCase
     assert_equal @u128, @ip.to_u128
   end
 
+  def test_method_ipv6?
+    assert_equal true, @ip.ipv6?
+  end
+
   def test_mapped?
     assert_equal true, @ip.mapped?
   end

data/test/ipaddress/prefix_test.rb

@@ -3,25 +3,29 @@ require 'test_helper'
 class Prefix32Test < Test::Unit::TestCase
 
   def setup
+    @netmask0  = "0.0.0.0"
     @netmask8  = "255.0.0.0"
     @netmask16 = "255.255.0.0"
     @netmask24 = "255.255.255.0"
     @netmask30 = "255.255.255.252"
-    @netmasks = [@netmask8,@netmask16,@netmask24,@netmask30]
+    @netmasks  = [@netmask0,@netmask8,@netmask16,@netmask24,@netmask30]
     
     @prefix_hash = {
+      "0.0.0.0"         => 0,
       "255.0.0.0"       => 8,
       "255.255.0.0"     => 16,
       "255.255.255.0"   => 24,
       "255.255.255.252" => 30}
 
     @octets_hash = {
+      [0,0,0,0]         => 0,
       [255,0,0,0]       => 8,
       [255,255,0,0]     => 16,
       [255,255,255,0]   => 24,
       [255,255,255,252] => 30}
 
     @u32_hash = {
+      0  => 0,
       8  => 4278190080,
       16 => 4294901760,
       24 => 4294967040,

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ipaddress
 version: !ruby/object:Gem::Version 
-  hash: 3
+  hash: 9
   prerelease: false
   segments: 
   - 0
   - 7
-  - 0
-  version: 0.7.0
+  - 5
+  version: 0.7.5
 platform: ruby
 authors: 
 - Marco Ceresa
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-08 00:00:00 +02:00
+date: 2011-04-08 00:00:00 +02:00
 default_executable: 
 dependencies: []
 
@@ -30,7 +30,6 @@ extra_rdoc_files:
 - README.rdoc
 files: 
 - .document
-- .gitignore
 - CHANGELOG.rdoc
 - LICENSE
 - README.rdoc
@@ -52,8 +51,8 @@ homepage: http://github.com/bluemonk/ipaddress
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -82,9 +81,9 @@ signing_key:
 specification_version: 3
 summary: IPv4/IPv6 addresses manipulation library
 test_files: 
-- test/test_helper.rb
-- test/ipaddress_test.rb
-- test/ipaddress/prefix_test.rb
-- test/ipaddress/ipv6_test.rb
 - test/ipaddress/extensions/extensions_test.rb
 - test/ipaddress/ipv4_test.rb
+- test/ipaddress/ipv6_test.rb
+- test/ipaddress/prefix_test.rb
+- test/ipaddress_test.rb
+- test/test_helper.rb

data/.gitignore

@@ -1,7 +0,0 @@
-*.sw?
-.DS_Store
-coverage
-rdoc
-pkg
-server.rb
-ipaddr.html