uri-ni 0.2.1 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c7f97e35f7fc6987d8051e1f09e23cc2cbc29b6e188496b5d1abd5d030a7ec32
-  data.tar.gz: 3a66e3863206978a52e1281318808f043de2b7e4409b09d8bdff37a589bfb3fd
+  metadata.gz: 72fad83584f69d2982732c3a0578e6a19a740b4aab3892b5d80e0a73f97b3e9e
+  data.tar.gz: 94e56f2e88436acb04627be6d8b5b87f3a357dd0c1828ef3569ccdda21541812
 SHA512:
-  metadata.gz: eac81311c6e7e895c908b0d45db5a7b028ed1e9b2e1b65e35d264c5840837abc589a9c11ac315272bf751f1f326b753f1b5e2f1add14313ae66258eefeee7c88
-  data.tar.gz: 8456780c695e1ad060546e46bf8cc1fcccbee00c1d535e6a3845f19f2928fd1a13efb720e264f23091fcf24b82bae797365877ca3747d6701502f96df61c65ca
+  metadata.gz: 1d00ea6cb3b0b5dadac6097871743c4f4e709f884093dafd488c8e2a3d0bc2beae7e48c6bf54db509380137a671f0705abf464e18f41a43bbc7cd9500fe7f640
+  data.tar.gz: bd0774e708e1ec4f5b570a1770bb12363520282e802705ce4b76b2235d186e089c42773374388f56f71c5d6c1ae8958fe95e63a2435410d7191c37dd401b2a24

data/lib/uri/ni/version.rb

@@ -3,7 +3,7 @@ require 'uri/generic'
 
 module URI
   class NI < Generic
-    VERSION = "0.2.1"
+    VERSION = "0.2.3"
   end
 
   # might as well put this here

data/lib/uri/ni.rb

@@ -58,7 +58,9 @@ class URI::NI < URI::Generic
     end
 
     [k, v]
-  end.to_h
+  end.to_h.freeze
+
+  TRUNCATED = [32, 64, 96, 120, 128].map { |i| "sha-256-#{i}".to_sym }.freeze
 
   # resolve first against digest length and then class
   DIGEST_REV = {
@@ -324,18 +326,28 @@ class URI::NI < URI::Generic
     LENGTHS[algorithm] and LENGTHS[algorithm] == digest.length
   end
 
+  # Returns true if the algorithm is a truncated one.
+  #
+  # @return [false, true]
+  #
+  def truncated?
+    TRUNCATED.include? algorithm
+  end
+
   # Display the available algorithms.
   #
   # @return [Array] containing the symbols representing the available
   #  digest algorithms.
+  #
   def self.algorithms truncated: false
     out = DIGESTS.keys.sort
-    truncated ? out : out.reject { |a| /^sha-256-/.match? a }
+    truncated ? out : out - TRUNCATED
   end
 
   # Obtain the algorithm of the digest. May be nil.
   #
   # @return [Symbol, nil]
+  #
   def algorithm
     algo = assert_path.first
     return algo.to_sym if algo
@@ -343,7 +355,8 @@ class URI::NI < URI::Generic
 
   # Set the algorithm of the digest. Will croak if the path is malformed.
   #
-  # @return [Symbol, nil] the old algorithm
+  # @return [Symbol, nil]
+  #
   def algorithm= algo
     a, b = assert_path
     self.path   = "/#{algo}"
@@ -354,6 +367,7 @@ class URI::NI < URI::Generic
   # Obtain the authority (userinfo@host:port) if present.
   #
   # @return [String, nil] the authority
+  #
   def authority
     out = userinfo ? "#{userinfo}@#{host}" : host
     out += "#{out}:#{port}" if port
@@ -362,7 +376,8 @@ class URI::NI < URI::Generic
 
   # Set the authority of the URI.
   #
-  # @return [String, nil] the old authority
+  # @return [String, nil]
+  #
   def authority= authority
     old = self.authority
     u, h, p = assert_authority authority unless authority.nil?
@@ -383,6 +398,7 @@ class URI::NI < URI::Generic
   #
   # @param radix [256, 64, 32, 16] The radix of the representation
   # @param alt [false, true] Return the alternative representation
+  #
   # @return [String] The digest of the URI in the given representation
   #
   def digest radix: 256, alt: false
@@ -397,6 +413,7 @@ class URI::NI < URI::Generic
   #
   # @param value [String, nil, Digest::Instance] The new digest
   # @param radix [256, 64, 32, 16] The radix of the encoding (default 256)
+  #
   # @return [String] The _old_ digest in the given radix
   #
   def set_digest value, radix: 256
@@ -430,6 +447,7 @@ class URI::NI < URI::Generic
   # objects will just be run through #compute, with all that entails.
   #
   # @param value [String, nil, Digest::Instance] the new digest
+  #
   # @return [String, nil, Digest::Instance] the value passed in
   #
   def digest= value
@@ -441,6 +459,7 @@ class URI::NI < URI::Generic
   # representation.
   #
   # @param alt [false, true] Return the alternative representation
+  #
   # @return [String] The hexadecimal digest
   #
   def hexdigest alt: false
@@ -448,8 +467,11 @@ class URI::NI < URI::Generic
   end
 
   # Set the digest value, assuming a hexadecimal input.
+  #
   # @param value [String, nil, Digest::Instance] the new digest
+  #
   # @return [String, nil, Digest::Instance] the value passed in
+  #
   def hexdigest= value
     set_digest value, radix: 16
   end
@@ -459,6 +481,7 @@ class URI::NI < URI::Generic
   # representation. Note this method requires the base32 module.
   #
   # @param alt [false, true] Return the alternative representation
+  #
   # @return [String] The base32 digest
   #
   def b32digest alt: false
@@ -466,8 +489,11 @@ class URI::NI < URI::Generic
   end
 
   # Set the digest value, assuming a base32 input (requires base32).
+  #
   # @param value [String, nil, Digest::Instance] the new digest
+  #
   # @return [String, nil, Digest::Instance] the value passed in
+  #
   def b32digest= value
     set_digest value, radix: 32
   end
@@ -478,6 +504,7 @@ class URI::NI < URI::Generic
   # (_non_-URL-safe) base64 representation.
   #
   # @param alt [false, true] Return the alternative representation
+  #
   # @return [String] The base64 digest
   #
   def b64digest alt: false
@@ -485,8 +512,11 @@ class URI::NI < URI::Generic
   end
 
   # Set the digest value, assuming a base64 input.
+  #
   # @param value [String, nil, Digest::Instance] the new digest
+  #
   # @return [String, nil, Digest::Instance] the value passed in
+  #
   def b64digest= value
     set_digest value, radix: 64
   end
@@ -496,6 +526,7 @@ class URI::NI < URI::Generic
   #
   # @param authority [#to_s, URI] Override the authority part of the URI
   # @param https [true, false] Whether the URL is to be HTTPS.
+  #
   # @return [URI::HTTPS, URI::HTTP] The generated URL.
   #
   def to_www https: true, authority: nil
@@ -541,6 +572,7 @@ class URI::NI < URI::Generic
   # Unconditionally returns an HTTPS URL.
   #
   # @param authority [#to_s, URI] Override the authority part of the URI
+  #
   # @return [URI::HTTPS]
   #
   def to_https authority: nil
@@ -551,6 +583,7 @@ class URI::NI < URI::Generic
   # Unconditionally returns an HTTP URL.
   #
   # @param authority [#to_s, URI] Override the authority part of the URI
+  #
   # @return [URI::HTTP]
   #
   def to_http authority: nil
@@ -559,15 +592,20 @@ class URI::NI < URI::Generic
 
 
   # Returns true if the algorithm is supported.
+  #
   # @param algorithm [Symbol,String] the algorithm identifier to test
+  #
   # @return [true, false] whether it is supported
+  #
   def self.valid_algo? algorithm
-    algorithm = algorithm.to_s.downcase.to_sym
-
-    # special case for truncated sha-256
-    return true if /^(sha-256)-(32|64|96|120|128)$/.match? algorithm
+    DIGESTS.has_key? algorithm.to_s.downcase.to_sym
+  end
 
-    # etc
-    DIGESTS.has_key? algorithm
+  # Returns true if the supplied algorithm is a truncated one.
+  #
+  # @return [false, true]
+  #
+  def self.truncated? algorithm
+    valid_algo?(algorithm) && TRUNCATED.include?(algorithm.to_s.downcase.to_sym)
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: uri-ni
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.3
 platform: ruby
 authors:
 - Dorian Taylor