ipaddress_2 0.12.1 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 37bc348612c012d7c7d743d9a9b642df1ee7d22d1362bcb0cfd23bf129eb07c3
-  data.tar.gz: 41b6893dc33205c71e0340838bc7fe6ec6a2faba3c6b18b0e3599304e3fbe15d
+  metadata.gz: cda18a11bce6a923e0471a7d08d6f8df8dae71d1ff768c6e0978772124be6f50
+  data.tar.gz: 47c24c1776bb9de0dedbec3179e42c22ed8ff4da96db53bcd95d8cb328bf2ca5
 SHA512:
-  metadata.gz: 76ac4f4c0af074075402e6ab1032e0bd46b500963d3763ff39f106c871cf54ae25e2fb8b3dc5a9386d3cfb53f7b3197b5a42d3e505fa014d489715a6429b4d31
-  data.tar.gz: 6f406303771c6a18470801ba35842fb36ff436e0d097b4971945ea3d02007c0f44349c18b3e3894affd338ba6d83ffa8f8ae7f1e9bd7650e8b3f6331585df3c2
+  metadata.gz: f9c69847cbf37301f1ded22d7bd4e97f0ab1040ff14d8f14993c414908872de88d06d6c25eecf1d153aaa22644038dcf3fb0fc2e4febf8be93e339b379b1f480
+  data.tar.gz: dbd02e8ed7d482b51873b45f443d92d7d11c78545ac20b9ba970745d3029c3d66c90aeb526dbf87f7bf95bd8a138ceb87e8621fba8d3e71dfadd591988b1fb35

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## [Unreleased]
 
+## 0.13.0
+
+### Enhancements
+* Provide arithmetic operations on IPv4 and IPv6
+
 ## 0.12.1
 
 ### Bugfix

data/VERSION

@@ -1 +1 @@
-0.12.1
+0.13.0

data/lib/ipaddress_2/ipv4.rb

@@ -377,6 +377,18 @@ module IPAddress;
     def network
       self.class.parse_u32(network_u32, @prefix)
     end
+    
+    #
+    # Returns a new IPv4 object containing only the host part of this IP.
+    #
+    #   ip = IPAddress("172.16.10.64/24")
+    #
+    #   ip.hostpart.to_s
+    #     #=> "0.0.0.64"
+    #
+    def hostpart
+      self.class.parse_u32(hostpart_u32, 32)
+    end
 
     #
     # Returns a new IPv4 object with the
@@ -600,6 +612,18 @@ module IPAddress;
     def network_u32
       @u32 & @prefix.to_u32
     end
+    
+    #
+    # Returns this address' host part in unsigned 32bits format
+    #
+    #   ip = IPAddress("10.0.0.42/24")
+    #
+    #   ip.host_u32
+    #     #=> 42
+    #
+    def hostpart_u32
+      @u32 & ~@prefix.to_u32
+    end
 
     #
     # Returns the broadcast address in Unsigned 32bits format
@@ -886,6 +910,97 @@ module IPAddress;
     def +(oth)
       aggregate(*[self,oth].sort.map{|i| i.network})
     end
+    
+    #
+    # Returns a new IPv4 object which is the result 
+    # of advancing this IP address by a given value.
+    # In other words, this arithmetically adds IP addresses.
+    #
+    # Will raise an error if the resulting address is in a different subnet,
+    # except validating is set to false.
+    #
+    # Example:
+    #
+    #   ip = IPAddress::IPv4.new("172.16.10.1/24")
+    #   ip.add(5).to_string
+    #     #=> "172.16.10.6/24"
+    def add(oth, validating=true)
+      oth = oth.to_i if oth.kind_of? IPAddress::IPv4 # oth shall be integer
+      
+      new_obj = self.class.parse_u32(self.to_i + oth, prefix)
+      
+      if validating and self.network_u32 != new_obj.network_u32
+        raise RuntimeError, "Subnet (/#{@prefix}) is not large enough."
+      end
+      
+      new_obj
+    end
+    
+    #
+    # Returns a new IPv4 object which is the result 
+    # of decreasing this IP address by a given value.
+    # In other words, this arithmetically subtracts IP addresses.
+    #
+    # Will raise an error if the resulting address is in a different subnet,
+    # except validating is set to false.
+    #
+    # Example:
+    #
+    #   ip = IPAddress::IPv4.new("172.16.10.10/24")
+    #   ip.subtract(5).to_string
+    #     #=> "172.16.10.5/24"
+    def subtract(oth, validating=true)
+      oth = oth.to_i if oth.kind_of? IPAddress::IPv4 # oth shall be integer
+      add(-oth, validating)
+    end
+    
+    #
+    # Returns the network address of the n-th network succeeding this one.
+    #
+    # Example:
+    #
+    #   ip = IPAddress::IPv4.new("172.16.10.0/24")
+    #   ip.advance_network(24).to_string
+    #     #=> "172.16.52.0/24"
+    def advance_network(amount)
+      IPAddress::IPv4.parse_u32(self.network.u32 + amount*self.size, @prefix)
+    end
+    
+    #
+    # Returns the network address of the network succeeding this one.
+    #
+    # Example:
+    #
+    #   ip = IPAddress::IPv4.new("172.16.10.0/24")
+    #   ip.next_network.to_string
+    #     #=> "172.16.11.0/24"
+    def next_network
+      advance_network 1
+    end
+    
+    #
+    # Returns the network address of the n-th network preceeding this one.
+    #
+    # Example:
+    #
+    #   ip = IPAddress::IPv4.new("172.16.10.0/24")
+    #   ip.regress_network(5).to_string
+    #     #=> "172.16.5.0/24"
+    def regress_network(amount)
+      advance_network(-amount)
+    end
+    
+    #
+    # Returns the network address of the network preceeding this one.
+    #
+    # Example:
+    #
+    #   ip = IPAddress::IPv4.new("172.16.10.0/24")
+    #   ip.previous_network.to_string
+    #     #=> "172.16.9.0/24"
+    def previous_network
+      regress_network 1
+    end
 
     #
     # Checks whether the ip address belongs to a 

data/lib/ipaddress_2/ipv6.rb

@@ -394,8 +394,110 @@ module IPAddress;
       to_hex.reverse.gsub(/./){|c| c+"."} + "ip6.arpa"
     end
     alias_method :arpa, :reverse
+    
+    #
+    # Returns a new IPv6 object which is the result 
+    # of advancing this IP address by a given value.
+    # In other words, this arithmetically adds IP addresses.
+    #
+    # Will raise an error if the resulting address is in a different subnet,
+    # except validating is set to false.
+    #
+    # Example:
+    #
+    #   ip = IPAddress::IPv6.new("fc42:1337::/64")
+    #   ip.add(5).to_string
+    #     #=> "fc42:1337::5/64"
+    def add(oth, validating=true)
+      oth = oth.to_i if oth.kind_of? IPAddress::IPv6 # oth shall be integer
+      
+      new_obj = self.class.parse_u128(self.to_i + oth, prefix)
+      
+      if validating and self.network_u128 != new_obj.network_u128
+        raise RuntimeError, "Subnet (/#{@prefix}) is not large enough."
+      end
+      
+      new_obj
+    end
+    
+    #
+    # Returns a new IPv6 object which is the result 
+    # of decreasing this IP address by a given value.
+    # In other words, this arithmetically subtracts IP addresses.
+    #
+    # Will raise an error if the resulting address is in a different subnet,
+    # except validating is set to false.
+    #
+    # Example:
+    #
+    #   ip = IPAddress::IPv6.new("fc42:1337::a/64")
+    #   ip.subtract(5).to_string
+    #     #=> "fc42:1337::5/64"
+    def subtract(oth, validating=true)
+      oth = oth.to_i if oth.kind_of? IPAddress::IPv6 # oth shall be integer
+      add(-oth, validating)
+    end
 
     #
+    # Returns the network address of the n-th network succeeding this one.
+    #
+    # Example:
+    #
+    #   ip = IPAddress::IPv6.new("fc42:1337:0:0::/64")
+    #   ip.advance_network(5).to_string
+    #     #=> "fc42:1337:0:5::/64"
+    def advance_network(amount)
+      IPAddress::IPv6.parse_u128(self.network.to_i + amount*self.size, @prefix)
+    end
+    
+    #
+    # Returns the network address of the network succeeding this one.
+    #
+    # Example:
+    #
+    #   ip = IPAddress::IPv6.new("fc42:1337:0:0::/64")
+    #   ip.next_network.to_string
+    #     #=> "fc42:1337:0:1::/64"
+    def next_network
+      advance_network 1
+    end
+    
+    #
+    # Returns the network address of the n-th network preceeding this one.
+    #
+    # Example:
+    #
+    #   ip = IPAddress::IPv6.new("fc42:1337:0:5::/64")
+    #   ip.regress_network(4).to_string
+    #     #=> "fc42:1337:0:1::/64"
+    def regress_network(amount)
+      advance_network(-amount)
+    end
+    
+    #
+    # Returns the network address of the network preceeding this one.
+    #
+    # Example:
+    #
+    #   ip = IPAddress::IPv6.new("fc42:1337:0:5::/64")
+    #   ip.previous_network.to_string
+    #     #=> "fc42:1337:0:4::/64"
+    def previous_network
+      regress_network 1
+    end
+    
+    #
+    # Returns a new IPv6 object containing only the host part of this IP.
+    #
+    #   ip = IPAddress::IPv6.new("fc42:1337:0:5::7/64")
+    #
+    #   ip.hostpart.to_s
+    #     #=> "::7"
+    #
+    def hostpart
+      self.class.parse_u128(hostpart_u128, 128)
+    end
+    
     # Splits a network into different subnets
     #
     # NOTE: Will allow you to split past /64 against RFC 5375
@@ -453,6 +555,18 @@ module IPAddress;
     def network_u128
       to_u128 & @prefix.to_u128
     end
+    
+    #
+    # Returns this address' host part in unsigned 128bits format
+    #
+    #   ip = IPAddress::IPv6.new("fc42:1337:0:5::7/64")
+    #
+    #   ip.host_u128
+    #     #=> 7
+    #
+    def hostpart_u128
+      to_u128 & ~@prefix.to_u128
+    end
 
     #
     # Returns the broadcast address in Unsigned 128bits format

data/lib/ipaddress_2/version.rb

@@ -1,3 +1,3 @@
 module IPAddress
-  VERSION = "0.12.1"
+  VERSION = "0.13.0"
 end

data/test/ipaddress_2/ipv4_test.rb

@@ -455,7 +455,7 @@ class IPv4Test < Minitest::Test
 
     ip2 = @klass.new("172.16.12.2/24")
     assert_equal [ip1.network.to_string, ip2.network.to_string], 
-    (ip1 + ip2).map{|i| i.to_string}
+                 (ip1 + ip2).map{|i| i.to_string}
 
     ip1 = @klass.new("10.0.0.0/23")
     ip2 = @klass.new("10.0.2.0/24")
@@ -533,6 +533,57 @@ class IPv4Test < Minitest::Test
     assert_equal "172.16.8.0/22", @ip.supernet(22).to_string
   end
 
+  def test_method_add
+    ip = IPAddress::IPv4.new("172.16.10.1/24")
+    assert_equal ip.add(5), IPAddress::IPv4.new("172.16.10.6/24")
+    assert_equal ip.add(IPAddress::IPv4.new("0.0.0.5/6")), IPAddress::IPv4.new("172.16.10.6/24")
+    assert_equal ip.add(50), IPAddress::IPv4.new("172.16.10.51/24")
+    assert_equal ip.add(254), IPAddress::IPv4.new("172.16.10.255/24")
+    assert_raises(RuntimeError) {ip.add(255)}
+    assert_equal ip.add(255, false), IPAddress::IPv4.new("172.16.11.0/24")
+    assert_raises(RuntimeError) {ip.add(1000)}
+    ip = IPAddress::IPv4.new("172.16.10.1/30")
+    assert_equal ip.add(2), IPAddress::IPv4.new("172.16.10.3/30")
+    assert_raises(RuntimeError) {ip.add(3)}
+  end
+
+  def test_method_subtract
+    ip = IPAddress::IPv4.new("172.16.10.10/24")
+    assert_equal ip.subtract(5), IPAddress::IPv4.new("172.16.10.5/24")
+    assert_equal ip.subtract(IPAddress::IPv4.new("0.0.0.5/32")), IPAddress::IPv4.new("172.16.10.5/24")
+    assert_equal ip.subtract(10), IPAddress::IPv4.new("172.16.10.0/24")
+    assert_raises(RuntimeError) {ip.subtract(11)}
+    assert_equal ip.subtract(11, false), IPAddress::IPv4.new("172.16.9.255/24")
+    assert_raises(RuntimeError) {ip.subtract(IPAddress::IPv4.new("0.0.0.11/16"))}
+  end
+  
+  def test_method_hostpart
+    ip = IPAddress::IPv4.new("172.16.10.64/24")
+    assert_equal ip.hostpart.to_s, "0.0.0.64"
+    ip = IPAddress::IPv4.new("172.16.10.130/25")
+    assert_equal ip.hostpart.to_s, "0.0.0.2"
+  end
+  
+  def test_method_advance_network
+    ip = IPAddress::IPv4.new("172.16.10.64/24")
+    assert_equal ip.advance_network(42), IPAddress::IPv4.new("172.16.52.0/24")
+  end
+
+  def test_method_next_network
+    ip = IPAddress::IPv4.new("172.16.10.64/24")
+    assert_equal ip.next_network, IPAddress::IPv4.new("172.16.11.0/24")
+  end
+  
+  def test_method_regress_network
+    ip = IPAddress::IPv4.new("172.16.10.64/24")
+    assert_equal ip.regress_network(5), IPAddress::IPv4.new("172.16.5.0/24")
+  end
+  
+  def test_method_previous_network
+    ip = IPAddress::IPv4.new("172.16.10.64/24")
+    assert_equal ip.previous_network, IPAddress::IPv4.new("172.16.9.0/24")
+  end  
+  
   def test_classmethod_parse_u32
     @decimal_values.each do  |addr,int|
       ip = @klass.parse_u32(int)

data/test/ipaddress_2/ipv6_test.rb

@@ -627,6 +627,51 @@ class IPv6Test < Minitest::Test
     assert_equal "2001:db8:8:2000::/51", @klass.new("2001:db8:8::/51").find_adjacent_subnet 
   end
 
+  def test_method_add
+    ip = IPAddress::IPv6.new("fc42:1337::/64")
+    assert_equal ip.add(5), IPAddress::IPv6.new("fc42:1337::5/64")
+    assert_equal ip.add(IPAddress::IPv6.new("::5/42")), IPAddress::IPv6.new("fc42:1337::5/64")
+    assert_equal ip.add(50), IPAddress::IPv6.new("fc42:1337::32/64")
+    ip = IPAddress::IPv6.new("fc42:1337::/120")
+    assert_equal ip.add(2), IPAddress::IPv6.new("fc42:1337::2/120")
+    assert_raises(RuntimeError) {ip.add(256)}
+    assert_equal ip.add(256, false), IPAddress::IPv6.new("fc42:1337::100/120")
+  end
+
+  def test_method_subtract
+    ip = IPAddress::IPv6.new("fc42:1337::5/64")
+    assert_equal ip.subtract(5), IPAddress::IPv6.new("fc42:1337::/64")
+    assert_equal ip.subtract(IPAddress::IPv6.new("::5/12")), IPAddress::IPv6.new("fc42:1337::0/64")
+    assert_raises(RuntimeError) {ip.subtract(11)}
+    assert_raises(RuntimeError) {ip.subtract(IPAddress::IPv6.new("::11/66"))}
+  end
+  
+  def test_method_hostpart
+    ip = IPAddress::IPv6.new("fc42:1337:0:5::7/64")
+    assert_equal ip.hostpart.to_s, "::7"
+  end
+
+  def test_method_advance_network
+    ip = IPAddress::IPv6.new("fc42:1337:0:0::/64")
+    assert_equal ip.advance_network(5), IPAddress::IPv6.new("fc42:1337:0:5::/64")
+  end
+
+  def test_method_next_network
+    ip = IPAddress::IPv6.new("fc42:1337:0:0::/64")
+    assert_equal ip.next_network, IPAddress::IPv6.new("fc42:1337:0:1::/64")
+  end
+  
+  def test_method_regress_network
+    ip = IPAddress::IPv6.new("fc42:1337:0:5::/64")
+    assert_equal ip.regress_network(4), IPAddress::IPv6.new("fc42:1337:0:1::/64")
+  end
+  
+  def test_method_previous_network
+    ip = IPAddress::IPv6.new("fc42:1337:0:5::/64")
+    assert_equal ip.previous_network, IPAddress::IPv6.new("fc42:1337:0:4::/64")
+  end  
+
+
 end # class IPv6Test
 
 class IPv6UnspecifiedTest < Minitest::Test

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ipaddress_2
 version: !ruby/object:Gem::Version
-  version: 0.12.1
+  version: 0.13.0
 platform: ruby
 authors:
 - bluemonk
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-19 00:00:00.000000000 Z
+date: 2019-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler