ipaddr_range_set 0.9.0 → 0.9.1

data/README.md

@@ -2,32 +2,35 @@ ipaddr_range_set
 ================
 
 convenience class to create a set of possibly discontiguous IP address range
-segments, and check if an IP address is in the set. 
+segments, and check if an IP address is in the set. ruby 1.9.3+ only. 
 
-Ruby stdlib IPAddr does the heavy-lifting, this is relatively simple code, 
-but which can simplify your own code when used. Having to do this sort
-of thing is often the sign of a bad design, but many of us have to do it anyway. 
+Ruby stdlib [IPAddr](http://www.ruby-doc.org/stdlib-1.9.3/libdoc/ipaddr/rdoc/IPAddr.html) 
+does the heavy-lifting, this is relatively simple code wrapping it
+in a convenience class. But this can simplify your own code when used. 
+Basing logic on IP address range checking can often be the sign of a bad design, 
+but many of us have to do it anyway.  
 
-== Usage
+## Usage
 
     require 'ipaddr_range_set'
     
-    # Zero or more segment arguments, of a variety
+    # Zero or more segment arguments, which can be input in a variety of
     # of formats. 
     range = IPAddrRangeSet.new(
-      '220.1.10.3',   # an IPv4 as a string
-      '2001:db8::10',  # An IPv6 as a string
-      '8.0.0.0/24',    # IPv4 as CIDR, IPv6 CIDR too
+      '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
+      '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.       
     )
     
-When ruby Range's are used, IPAddrRangeSegment makes sure to use `Range#cover?`
+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 ranges are supported, if for
-some reason you want them. 
+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. 
 
     range.include?  '220.1.10.5'
     range.include?  IPAddr.new('220.1.10.5')
@@ -38,7 +41,7 @@ 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')
+    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
@@ -50,17 +53,17 @@ 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 constants are available for local (private, not publically routable)
-and loopback ranges in both IPv4 IPv6.   IPv4Local, IPv4Loopback, IPv6Local, 
-IPv6Loopback.  The constant `LocalAddresses` is the union of v4 and v6 local 
+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 
 and loopback addresses. 
 
-    IPAddrRangeSet::LocalAddress.include? "127.0.0.1" # true
-    IPAddrRangeSet::LocalAddress.include? "10.0.0.1" # true
-    IPAddrRangeSet::LocalAddress.include? "192.168.0.1" # true
-    IPAddrRangeSet::LocalAddress.include? "::1" # true, ipv6 loopback
-    IPAddrRangeSet::LocalAddress.include? "fc00::1" # an ipv6 local
+    IPAddrRangeSet::LocalAddresses.include? "127.0.0.1" # true
+    IPAddrRangeSet::LocalAddresses.include? "10.0.0.1" # true
+    IPAddrRangeSet::LocalAddresses.include? "192.168.0.1" # true
+    IPAddrRangeSet::LocalAddresses.include? "::1" # true, ipv6 loopback
+    IPAddrRangeSet::LocalAddresses.include? "fc00::1" # an ipv6 local
     
-== Note on ipv6
+## Note on ipv6
 
 It supports ipv6 just because it was so easy to do so with the underlying
 IPAddr implementation.  But I don't have much experience or use for IPv6, there
@@ -69,4 +72,9 @@ could be oddities hiding in there.
 You can create an IPAddrRangeSet that includes both IPv4 and IPv6 segments, no
 problem. But an individual `include?` argument will only match a segment of
 it's own type, no automatic conversion of IPv4-compatible IPv6 addresses
-is done (should it be? I have no idea, don't really understand ipv6 use cases). 
+is done (should it be? I have no idea, don't really understand ipv6 use cases). 
+
+## thanks
+
+to whoever wrote IPAddr in ruby stdlib, nice to have it, this is just a
+convenience wrapper over it, really. 

data/lib/ipaddr_range_set.rb

@@ -110,10 +110,11 @@ end
 class IPAddrRangeSet
   # Constant ranges for local/non-routable/private addresses
   IPv4Local     = IPAddrRangeSet.new("10.0.0.0/8", "172.16.0.0/12", "192.168.0.0/16")
+  # who knew it's not just 127.0.0.1? Check the spec, it's this:
   IPv4Loopback  = IPAddrRangeSet.new("127.0.0.0/8")
   
   IPv6Local = IPAddrRangeSet.new("fc00::/7")
   IPv6Loopback =  IPAddrRangeSet.new("::1")
   
-  LocalAddresses = IPv4Local + IPv4Local + IPv6Local + IPv6Local 
+  LocalAddresses = IPv4Local + IPv4Loopback + IPv6Local + IPv6Loopback 
 end

data/lib/ipaddr_range_set/version.rb

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

data/test/test_ip_addr_range_set.rb

@@ -121,7 +121,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}.each do |ip|
+    %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.0
+  version: 0.9.1
   prerelease: 
 platform: ruby
 authors: