better_ipaddr 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 427cfc9ba0645edbcb3dd185a7bc13a4d44474ab
-  data.tar.gz: f56f93a8ed9c724f9910db69b35c12da7b68ad17
+  metadata.gz: 7b4aa183d3f44f56ff13ead56db0d6a6644d96be
+  data.tar.gz: b8d6cfb47a73be0c2d8ccb7baee79ef9c9e88142
 SHA512:
-  metadata.gz: 206c1a4a003d56ccebb74308b615a622033c9bca9348dcb2516df7fdf5edd3745db3294c8cc2f221b351c35f13fbf92973e808e4f2770962c4668e4310a8b9d9
-  data.tar.gz: efc78d7a0e9c19fcf825faa48c728b3e1b7d307c9db0c94550fc5860b2057a6accab757fd6f8b7b611654a69a79b3882f628ed48f72d3953da9e29d519b5e3cd
+  metadata.gz: 1dc675f631f316c5b265f7d6a30e194ef03c4717148c977c5c28c1b18e0596ce640bc42973e3307d225e794842e82a9e8f54ed42303c20756eaccbb5ec5eee12
+  data.tar.gz: f68835b94ceb6ec6aec81db9136146c38c45a309d4a57f90ca603985e58790c5d3480f898bc6442fae8e989246ce0661487e296e5ac289ed7d9b9b25a7479d6f

data/lib/better_ipaddr/classes.rb

@@ -11,21 +11,134 @@ class IPAddr
       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
+    # IPAddr.
+    #
+    # @param address [Integer, IPAddr, String]
+    # @param mask [Integer, IPAddr, String, Nil]
+    # @param family [Integer]
+    # @return [IPAddr, Nil]
     def self.[](address, mask = nil, family: self::FAMILY)
-      case mask
+      prefix_length = mask && object_to_prefix_length(mask, family)
+
+      case address
       when Integer
-        if 0 <= mask && mask <= FAMILY_TO_BIT_LENGTH[family]
-          new(address, family).mask(mask)
-        else
-          new(address, family).mask(new(mask, family).to_s)
-        end
-      when String, IPAddr
-        new(address, family).mask(mask.to_s)
+        from_integer(address, prefix_length, family: family)
+      when IPAddr
+        from_ipaddr(address, prefix_length, family: family)
+      when String
+        from_string(address, prefix_length, family: family)
+      end
+    end
+
+    # Create an IPAddr from an Integer.
+    #
+    # @param address [Integer]
+    # @param mask [Integer, String] a netmask or prefix length
+    # @param family [Integer, Nil]
+    # @return [IPAddr]
+    def self.from_integer(address, prefix_length, family: self::FAMILY)
+      new(address, family).mask(prefix_length || FAMILY_TO_BIT_LENGTH[family])
+    end
+
+    # Create an IPAddr from an IPAddr.
+    #
+    # @param address [IPAddr]
+    # @param mask [Integer, String] a netmask or prefix length
+    # @param family [Integer, Nil]
+    # @return [IPAddr]
+    def self.from_ipaddr(address, prefix_length, family: self::FAMILY)
+      new(address.to_i, family).mask(prefix_length || address.prefix_length)
+    end
+
+    # Create an IPAddr from a String.
+    #
+    # @param address [String]
+    # @param mask [Integer, String] a netmask or prefix length
+    # @param family [Integer, Nil]
+    # @return [IPAddr]
+    def self.from_string(address, mask = nil, family: self::FAMILY)
+      if mask
+        new(address, family).mask(mask)
       else
         new(address, family)
       end
     end
 
+    # Convert an object to a prefix length.
+    #
+    # @param mask [Integer, String]
+    # @param family [Integer, Nil]
+    # @return [Integer]
+    def self.object_to_prefix_length(mask, family = self::FAMILY)
+      case mask
+      when Integer
+        integer_to_prefix_length(mask, family)
+      when String
+        string_to_prefix_length(mask, family)
+      when IPAddr
+        ipaddr_to_prefix_length(mask, family)
+      else
+        raise ArgumentError, "Can't convert #{mask.class} to prefix length"
+      end
+    end
+
+    # Convert an integer to a prefix length.
+    #
+    # If the integer is within the range of possible prefix lengths, returns the
+    # same integer. Otherwise it assumes that the given integer is the integer
+    # representation of a netmask.
+    #
+    # Returns nil if the integer can't be converted.
+    #
+    # @param mask [Integer]
+    # @return [Integer]
+    def self.integer_to_prefix_length(mask, family = self::FAMILY)
+      if valid_prefix_length?(mask)
+        mask
+      else
+        NETMASK_TO_PREFIX_LENGTH[family][mask] ||
+          (raise ArgumentError, "Can't convert #{mask} to prefix length")
+      end
+    end
+
+    # Convert a netmask represented as an IPAddr to a prefix length.
+    #
+    # Returns nil if the IPAddr can't be converted.
+    #
+    # @param mask [IPAddr]
+    # @return [Integer]
+    def self.ipaddr_to_prefix_length(mask, family = self::FAMILY)
+      NETMASK_TO_PREFIX_LENGTH[family][mask.to_i]
+    end
+
+    # Convert a string to a prefix length.
+    #
+    # Accepts the decimal representations of integers as well as netmasks in
+    # dotted quad notation.
+    #
+    # Returns nil if the string can't be converted.
+    #
+    # @param mask [String]
+    # @return [Integer]
+    def self.string_to_prefix_length(mask, family = self::FAMILY)
+      if mask =~ /^\d+$/
+        integer_to_prefix_length(mask.to_i, family)
+      else
+        NETMASK_TO_PREFIX_LENGTH[family][new(mask).to_i]
+      end
+    end
+
+    # Return true if the given number is a valid prefix length, false otherwise.
+    #
+    # @param prefix_length [Integer]
+    # @return [Boolean]
+    def self.valid_prefix_length?(prefix_length, family: self::FAMILY)
+      0 <= prefix_length && prefix_length <= FAMILY_TO_BIT_LENGTH[family]
+    end
+
     # Convert the given string to an IPAddr subclass.
     #
     # @param address [String] the string to convert

data/lib/better_ipaddr/version.rb

@@ -1,3 +1,3 @@
 module BetterIpaddr
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: better_ipaddr
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Ben Miller
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-04-25 00:00:00.000000000 Z
+date: 2016-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler