better_ipaddr 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4c742e6191e7a279cb6b18444d6fbe019a7f2a44
-  data.tar.gz: 56e8d5c730c30dfbe39ffcfee75a85e35a32f0ae
+  metadata.gz: 77e832f6c7d7f6dc51281e3a00dbc4ac43c582c7
+  data.tar.gz: 57d339efecf6b8d195faf516438e9dbe6df63a6f
 SHA512:
-  metadata.gz: 4be8cf2af08d5c956400250aaad385ac8b9fa32c736330cf289326ba2eb4b44957cf5718ea2bf69c3e5b7524b4c758e9ed9de40ba87d6ff2f30baa839fa19c54
-  data.tar.gz: eac415d3db96e2c35d490d8412ad7fa8ccc28b66b582eec4632fced82ea48eef020956b36324c541532a6e0ec9fc70af8339b4ed20a54bb0e1c7da6a1a9cb158
+  metadata.gz: feded15fc34a564ddbab41eb3d1d0306b20ffd53125e2fd259be970b3dd034b7d6ae34056f71b985635e64020b508aae5fea82a5a606e9affee552c178cf115c
+  data.tar.gz: cf706c0395daef99367fad7dbdd70b6fbf701f4f33f740845556c66b5f7b876ecfd324ca601127809904c52d82d8fd79c71662144e6c41fc30230ec1e6ba2c57

data/README.md

@@ -90,6 +90,8 @@ Another way is to `require "better_ipaddr/methods"` and mix
 `BetterIpaddr::InstanceMethods` into your own class which implements
 the rest of the `IPAddr` API, or into individual `IPAddr` objects.
 
+The `Kernel#IPAddr` conversion method (in the spirit of `Kernel#Array`, `Kernel#Integer`, etc), is added to `Kernel` via `require "better_ipaddr/kernel_method"`. It delegates to `IPAddr::Base.from`.
+
 `BetterIpaddr::Space`, a collection class for dealing with sets of network addresses, is also available but not loaded by default.
 
 ```ruby

data/lib/better_ipaddr/classes.rb

@@ -1,3 +1,4 @@
+require "better_ipaddr/constants"
 require "better_ipaddr/methods"
 
 class IPAddr
@@ -7,10 +8,6 @@ class IPAddr
     include Comparable
     include Enumerable
 
-    def inherited(cls)
-      cls.extend BetterIpaddr::ClassMethods
-    end
-
     # Create an IPAddr from the given object.
     #
     # Returns nil if the object is of a type that can't be converted to an
@@ -33,6 +30,29 @@ class IPAddr
       end
     end
 
+    # Create an IPAddr from the given object, guessing the type of address given
+    # based on its type and content.
+    #
+    # Note that an Integer that corresponds to an IPv4 address will be converted
+    # to an IPAddr::V4, even though all such Integers also correspond to valid
+    # IPv6 addresses.
+    #
+    # Returns nil if the object can't be converted based on its type and
+    # content.
+    #
+    # @param address [Integer, IPAddr, String]
+    # @return [IPAddr, Nil]
+    def self.from(address)
+      case address
+      when IPAddr
+        specialize address
+      when Regex::IPV4, 0..V4::MAX_INT
+        V4[address]
+      when Regex::IPV6, 0..V6::MAX_INT
+        V6[address]
+      end
+    end
+
     # Create an IPAddr from an Integer.
     #
     # @param address [Integer]
@@ -172,6 +192,7 @@ class IPAddr
                 NETMASK_TO_PREFIX_LENGTH.fetch(self::FAMILY))
       const_set(:PREFIX_LENGTH_TO_NETMASK,
                 PREFIX_LENGTH_TO_NETMASK.fetch(self::FAMILY))
+      const_set(:MAX_INT, 2**self::BIT_LENGTH - 1)
     end
 
     def address_family_bit_length
@@ -189,10 +210,14 @@ class IPAddr
 
   class V4 < Base
     specialize_constants Family::IPV4
+
+    REGEX = Regex::IPV4
   end
 
   class V6 < Base
     specialize_constants Family::IPV6
+
+    REGEX = Regex::IPV6
   end
 
   class MAC < Base

data/lib/better_ipaddr/constants.rb

@@ -0,0 +1,103 @@
+require "socket"
+
+module BetterIpaddr
+  module Constants
+    # Integer codes representing supported address clases.
+    # Reuse values from Socket namespace where possible.
+    module Family
+      IPV4 = Socket::AF_INET
+      IPV6 = Socket::AF_INET6
+      EUI48 = 48
+      EUI64 = 64
+    end
+
+    module Regex
+      OCTET = Regexp.union(
+        /25[0-5]/,
+        /2[0-4][0-9]/,
+        /1[0-9][0-9]/,
+        /[1-9][0-9]/,
+        /[0-9]/
+      )
+
+      TRAILING_OCTET = /\.#{OCTET}/
+
+      IPV4_PL = Regexp.union(
+        /3[0-2]/,
+        /[1-2][0-9]/,
+        /[0-9]/
+      )
+
+      IPV4 = /\A#{OCTET}#{TRAILING_OCTET}{3}(?:\/#{IPV4_PL})?\z/
+
+      # IPv6 regex adapted from http://stackoverflow.com/a/17871737
+      QUAD = /[0-9a-zA-Z]{1,4}/
+      LEADING_QUAD = /[0-9a-zA-Z]{1,4}:/
+      TRAILING_QUAD = /:[0-9a-zA-Z]{1,4}/
+
+      IPV6_PL = Regexp.union(
+        /[0-9]/,
+        /[1-9][0-9]/,
+        /1[0-1][0-9]/,
+        /12[0-8]/
+      )
+
+      IPV6_ADDRESS = Regexp.union(
+        # full
+        /#{LEADING_QUAD}{7,7}#{QUAD}/,
+
+        # zero-compressed
+        /#{LEADING_QUAD}{1,7}:/,
+        /:#{TRAILING_QUAD}{1,7}/,
+        /#{LEADING_QUAD}{1,6}#{TRAILING_QUAD}{1,1}/,
+        /#{LEADING_QUAD}{1,5}#{TRAILING_QUAD}{1,2}/,
+        /#{LEADING_QUAD}{1,4}#{TRAILING_QUAD}{1,3}/,
+        /#{LEADING_QUAD}{1,3}#{TRAILING_QUAD}{1,4}/,
+        /#{LEADING_QUAD}{1,2}#{TRAILING_QUAD}{1,5}/,
+        /#{LEADING_QUAD}{1,1}#{TRAILING_QUAD}{1,6}}/,
+
+        # IPv4-mapped / -translated
+        /::(ffff(:0{1,4}){0,1}:){0,1}#{IPV4}/,
+
+        # IPv4 embedded
+        /#{LEADING_QUAD}{1,4}:#{IPV4}/
+      )
+
+      IPV6 = /\A#{IPV6_ADDRESS}(?:\/#{IPV6_PL})?\z/
+    end
+
+    # Map well known address family names to constants.
+    SYMBOL_TO_FAMILY = {
+      ipv4: Family::IPV4,
+      ipv6: Family::IPV6,
+      eui48: Family::EUI48,
+      eui64: Family::EUI64,
+      mac: Family::EUI48
+    }
+
+    # Map each address family to the size of its address space, in bits.
+    FAMILY_TO_BIT_LENGTH = {
+      Family::IPV4 => 32,
+      Family::IPV6 => 128,
+      Family::EUI48 => 48,
+      Family::EUI64 => 64
+    }
+
+    # Map all possible prefix lengths to the corresponding netmasks.
+    PREFIX_LENGTH_TO_NETMASK = {}
+    FAMILY_TO_BIT_LENGTH.each_pair do |family, size|
+      netmasks = []
+      (0..size).each do |prefix_length|
+        netmasks[prefix_length] = 2**size - 2**(size - prefix_length)
+      end
+      PREFIX_LENGTH_TO_NETMASK[family] = netmasks
+    end
+
+    # Map all possible netmasks to the corresponding prefix lengths.
+    NETMASK_TO_PREFIX_LENGTH = {}
+    PREFIX_LENGTH_TO_NETMASK.each_pair do |family, hash|
+      NETMASK_TO_PREFIX_LENGTH[family] =
+        Hash[hash.map.with_index { |e, i| [e, i] }]
+    end
+  end
+end

data/lib/better_ipaddr/kernel_method.rb

@@ -0,0 +1,7 @@
+require "better_ipaddr/classes"
+
+module Kernel
+  def IPAddr(object)
+    IPAddr::Base.from(object)
+  end
+end

data/lib/better_ipaddr/methods.rb

@@ -1,52 +1,7 @@
 require "ipaddr"
-require "socket"
+require "better_ipaddr/constants"
 
 module BetterIpaddr
-  module Constants
-    # Integer codes representing supported address clases.
-    # Reuse values from Socket namespace where possible.
-    module Family
-      IPV4 = Socket::AF_INET
-      IPV6 = Socket::AF_INET6
-      EUI48 = 48
-      EUI64 = 64
-    end
-
-    # Map well known address family names to constants.
-    SYMBOL_TO_FAMILY = {
-      ipv4: Family::IPV4,
-      ipv6: Family::IPV6,
-      eui48: Family::EUI48,
-      eui64: Family::EUI64,
-      mac: Family::EUI48
-    }
-
-    # Map each address family to the size of its address space, in bits.
-    FAMILY_TO_BIT_LENGTH = {
-      Family::IPV4 => 32,
-      Family::IPV6 => 128,
-      Family::EUI48 => 48,
-      Family::EUI64 => 64
-    }
-
-    # Map all possible prefix lengths to the corresponding netmasks.
-    PREFIX_LENGTH_TO_NETMASK = {}
-    FAMILY_TO_BIT_LENGTH.each_pair do |family, size|
-      netmasks = []
-      (0..size).each do |prefix_length|
-        netmasks[prefix_length] = 2**size - 2**(size - prefix_length)
-      end
-      PREFIX_LENGTH_TO_NETMASK[family] = netmasks
-    end
-
-    # Map all possible netmasks to the corresponding prefix lengths.
-    NETMASK_TO_PREFIX_LENGTH = {}
-    PREFIX_LENGTH_TO_NETMASK.each_pair do |family, hash|
-      NETMASK_TO_PREFIX_LENGTH[family] =
-        Hash[hash.map.with_index { |e, i| [e, i] }]
-    end
-  end
-
   module ClassMethods
     include Constants
 

data/lib/better_ipaddr/version.rb

@@ -1,3 +1,3 @@
 module BetterIpaddr
-  VERSION = "0.2.3"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: better_ipaddr
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Ben Miller
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-19 00:00:00.000000000 Z
+date: 2016-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -71,7 +71,9 @@ files:
 - bin/setup
 - lib/better_ipaddr.rb
 - lib/better_ipaddr/classes.rb
+- lib/better_ipaddr/constants.rb
 - lib/better_ipaddr/core_extension.rb
+- lib/better_ipaddr/kernel_method.rb
 - lib/better_ipaddr/methods.rb
 - lib/better_ipaddr/space.rb
 - lib/better_ipaddr/version.rb