ipaddr_range_set 0.9.1 → 0.10.0

data/README.md

@@ -12,6 +12,8 @@ but many of us have to do it anyway.
 
 ## Usage
 
+### Creating
+
     require 'ipaddr_range_set'
     
     # Zero or more segment arguments, which can be input in a variety of
@@ -23,25 +25,37 @@ but many of us have to do it anyway.
       '8.*.*.*',       # informal splat notation, only for IPv4
       '8.8.0.0'..'8.8.2.255', # arbitrary range, works for IPv6 too. 
       IPAddr.new(whatever),   # arbitrary existing IPAddr object
-      (ip_addr..ip_addr)      # range of arbitrary IPAddr objects.       
+      (ip_addr..ip_addr),     # range of arbitrary IPAddr objects.
+      IPAddrRangeSet::LocalAddresses    # An existing IPAddrRangeSet
     )
-    
+
+Ranges and splats are handled by this gem (in terms of underlying IPAddr), other strings
+passed directly to IPAddr constructor. 
+
 When ruby Range's are used, IPAddrRangeSet makes sure to use `Range#cover?`
 internally, not `Range#include?` (the latter being disastrous for anything that
 doesn't have `#to_int`).  Triple dot `...` exclusive endpoint ranges are 
 supported, which can be convenient if you don't like writing lots of `255`s
 in your range end points. 
 
+### Checking
+
+And then, once you have an IPAddrRangeSet, you can check if a particular
+ip is in the range set, using string (IPv4 or v6) or IPAddr instance:
+
     range.include?  '220.1.10.5'
     range.include?  IPAddr.new('220.1.10.5')
     
 `#include?` is aliased as `#===` so you can easily use it in `case/when`.  
+
+
+### Immutable, but create new with union of existing
     
 IPAddrRangeSets are immutable, but you can create new ones combining existing
 ranges:
 
     new_range = IPAddrRangeSet('8.10.5.1') + IPAddrRangeSet('8.11.6.1')
-    new_range = IPAddrRangeSet('8.10.5.1').add('8.0.0.0/24', 10.0.0.1..10.1.4.255 )
+    new_range = IPAddrRangeSet('8.10.5.1').add('8.0.0.0/24', '10.0.0.1'..'10.1.4.255' )
     
 The internal implementation just steps through all range segments and checks
 the argument for inclusion, there's no special optimization to detect overlapping
@@ -52,6 +66,8 @@ involving a search tree of some kind anyway.
 As above range 'union' is supported, but range intersection is not. It's 
 a bit tricky to implement well, and I don't have a use case for it. 
 
+## Built-in ranges for checking local addresses
+
 Built-in constants are available for local (private, not publically routable)
 and loopback ranges in both IPv4 and IPv6.   `IPAddrRangeSet::IPv4Local`, `IPv4Loopback`, `IPv6Local`, 
 `IPv6Loopback`.  The constant `LocalAddresses` is the union of all v4 and v6 local 

data/lib/ipaddr_range_set.rb

@@ -4,10 +4,28 @@ require 'ipaddr'
 
 class IPAddrRangeSet
   
+  # Zero or more segment arguments, which can be input in a variety of
+  # of formats. 
+  # range = IPAddrRangeSet.new(
+  #    '220.1.10.3',    # a single IPv4 as a string
+  #    '2001:db8::10',  # a single IPv6 as a string
+  #    '8.0.0.0/24',    # IPv4 as CIDR, works for IPv6 CIDR too
+  #    '8.*.*.*',       # informal splat notation, only for IPv4
+  #    '8.8.0.0'..'8.8.2.255', # arbitrary range, works for IPv6 too. 
+  #    IPAddr.new(whatever),   # arbitrary existing IPAddr object
+  #    (ip_addr..ip_addr),     # range of arbitrary IPAddr objects.
+  #    IPAddrRangeSet::LocalAddresses    # An existing IPAddrRangeSet
+  # )
   def initialize(*segments_list)        
     
     segments_list.each do |segment|
       
+      if IPAddrRangeSet === segment
+        # just absorb em
+        segments.concat segment.segments
+        next
+      end
+      
       if IPAddr === segment
         segment.freeze
         segments << segment
@@ -84,8 +102,7 @@ class IPAddrRangeSet
   #
   # IPAddrRangeSets are immutable. 
   def union(other_set)
-    all_segments = self.segments + other_set.segments
-    self.class.new  *all_segments
+    self.class.new(self, other_set)
   end
   alias_method :'+', :union
   
@@ -96,6 +113,7 @@ class IPAddrRangeSet
     return self + IPAddrRangeSet.new(*new_segments)
   end
   
+  
   protected
   
   # Not public API, but used for creating unions of range sets,

data/lib/ipaddr_range_set/version.rb

@@ -1,3 +1,3 @@
 module IpaddrRangeSet
-  VERSION = "0.9.1"
+  VERSION = "0.10.0"
 end

data/test/test_ip_addr_range_set.rb

@@ -37,6 +37,7 @@ class TestIpAddrRange < Test::Unit::TestCase
   
   test_inclusion("ipv4_range_str_exclusive_endpoint", ("128.220.10.1"..."128.220.11.255"), "128.220.10.1", "128.220.9.255", "128.220.11.255")
 
+  test_inclusion("existing IPAddrRangeSEt obj", IPAddrRangeSet.new("128.220.10.1"), "128.220.10.1", "128.220.10.2")
     
   def test_incompatible_range        
     # one ipv4 one ipv6. 
@@ -121,6 +122,7 @@ class TestIpAddrRange < Test::Unit::TestCase
   end
   
   def test_local_constants
+    
     %w{10.3.3.1 172.16.4.1 192.168.2.1  fc00::1 127.0.0.1 ::1}.each do |ip|
       assert IPAddrRangeSet::LocalAddresses.include?(ip), "IPAddrRangeSet::LocalAddresses should include #{ip}"
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ipaddr_range_set
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.10.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-08 00:00:00.000000000 Z
+date: 2012-11-12 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: