better_ipaddr 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5cd953909cfae8bb5422a297acdd4592ec96957c262072587add707a78ca9dd3
-  data.tar.gz: 32ff0ee9fb1aa6fc91a1fd2db3802add0d9b10af29c97ecbb066b3805ca5dcf3
+  metadata.gz: c932b6f935ba9e71a4bb4471ecb0bfcfebbf77f316799e75a4617d3a39cdf7b0
+  data.tar.gz: 677d6e46f7129f07dbcb5a57f78845eba60ace671400c477609e6fd7fbe43e7d
 SHA512:
-  metadata.gz: 4ac0277a9876f20973dd0418547093ec41342ecbd1186c2da235c2463a0cd70f9cf39c623242ebad8cb2aa2156528a1d9735317c82a04310385ae93624beec75
-  data.tar.gz: 2d8f9e58dc03ea59d6af81995345e37395fd259bb1a615ef6ad9cd0d6e19a5b9cfb5f1ef3cc2891574861e99ae9280ee72288ed5d29308483b4d909041f7dba1
+  metadata.gz: f98ca91e742c0081664a2126fea68d69c194e37a1ab30ceee3d5774cfd99d7d8891cd79300bce192ce9efecc0277406c2a4a1bafbb65fe49ee78cade918cdb94
+  data.tar.gz: c7eade85d3969499eb0c0a50b5240b3b94a1828947de936082e88fb8269e1b3e820ffa93bda60769c7212188b5c08cd2e33d46aca4fe4e6c5a82b43a51f6e656

data/lib/better_ipaddr/classes.rb

@@ -33,6 +33,8 @@ class IPAddr
       end
     end
 
+    # rubocop: disable CyclomaticComplexity
+
     # Create an IPAddr from the given object, guessing the type of address given
     # based on its type and content.
     #
@@ -50,6 +52,10 @@ class IPAddr
     # @param classful [Boolean] see Base.from_string
     # @return [IPAddr, Nil]
     def self.from(address, exception: false, classful: false)
+      if class_converter?(address)
+        return class_convert(address, classful: classful, exception: exception)
+      end
+
       case address
       when IPAddr
         specialize address
@@ -59,7 +65,62 @@ class IPAddr
         V6[address]
       end || (
         if exception
-          raise TypeError, "can't convert #{address.inspect} to #{self}"
+          (raise TypeError, "can't convert #{address.inspect} to #{self}")
+        end
+      )
+    end
+
+    # rubocop: enable CyclomaticComplexity
+
+    # A Hash of classes and class names which can be converted to IPAddr::Base
+    # subclasses, but which are not necessarily loaded at the same time as this
+    # file.
+    #
+    # Conversion callables for custom classes can be registered here, e.g., with
+    # custom class Foo:
+    #
+    #   IPAddr::Base.class_converters[Foo] = proc { |foo, _| foo.to_ipaddr }
+    #
+    # The arguments passed to the callable will be the same as the parameters of
+    # Kernel#IPAddr.
+    #
+    # @return [Hash{String, Class => Proc, Method}]
+    def self.class_converters
+      @class_converters ||= {
+        'Resolv::IPv4' => V4.method(:from_string_representable),
+        'Resolv::IPv6' => V6.method(:from_string_representable)
+      }
+    end
+
+    # Return the class_converter for the given object, if one exists.
+    #
+    # Checks by both class identity and class name so that every class with a
+    # converter doesn't need to be loaded for this file to load.
+    #
+    # @return [Proc, Method, Nil]
+    def self.class_converter(address)
+      class_converters[address.class] ||= class_converters[address.class.name]
+      class_converters[address.class]
+    end
+
+    def self.class_converter?(address)
+      class_converters.key?(address.class) ||
+        class_converters.key?(address.class.name)
+    end
+
+    # Convert the given object using its class_converter, if one exists.
+    #
+    # @return [IPAddr, Nil]
+    def self.class_convert(address, mask = nil, classful: nil, exception: false)
+      converter = class_converter(address)
+      converter && converter.call(
+        address,
+        mask,
+        classful: classful,
+        exception: exception
+      ) || (
+        if exception
+          (raise TypeError, "can't convert #{address.inspect} to #{self}")
         end
       )
     end
@@ -132,6 +193,29 @@ class IPAddr
       end
     end
 
+    # Create an IPAddr from an object that can be converted to a String via
+    # #to_s.
+    #
+    #
+    # @param address [#to_s]
+    # @param mask [Integer, String] a netmask or prefix length
+    # @param family [Integer, Nil]
+    # @param classful [Boolean] controls the conversion of IPv4 addresses
+    #   without a prefix length in CIDR notation. When false, these are assumed
+    #   to be host networks (/32). When true, these are assumed to be classful
+    #   (rfc791) networks, with an implicit prefix length. Has no effect on IPv6
+    #   addresses.
+    # @return [IPAddr]
+    def self.from_string_representable(
+      address,
+      mask = nil,
+      family: self::FAMILY,
+      classful: false,
+      exception: false
+    )
+      from_string(address.to_s, mask, family: family, classful: classful)
+    end
+
     # Convert an object to a prefix length.
     #
     # @param mask [Integer, String]

data/lib/better_ipaddr/version.rb

@@ -1,3 +1,3 @@
 module BetterIpaddr
-  VERSION = "0.6.0".freeze
+  VERSION = "0.7.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: better_ipaddr
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Ben Miller
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-14 00:00:00.000000000 Z
+date: 2018-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler