uuid-ncname 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e77f488ca6429c6b7799b8ae23f673c2d17ae2914abaebfb8411cd4408ce498
-  data.tar.gz: a744fad35027fd23aa64795baceeae5b940ef711d475a2e726f5c423df05997c
+  metadata.gz: bdbffa544b839b717c4c5d25d2602930be0576d01dcab7d282f52c21213c7b54
+  data.tar.gz: '08964857cf2c8908ca3258805b61aaf6adb4933b3b93f095e55db3b093be6a6a'
 SHA512:
-  metadata.gz: 37652d6a314d6629164f0d616bafa99185cb3d044e9908492d91d5d77a87c13308f5ce894b1a3c05bb382ae9a1cb825e90aaf00152690816a1c2e737b7d20066
-  data.tar.gz: 5740a1c557cbee7efe37ec3af6f3145a83010222cb3f91159fa9500d161c45279e9208d4cb11141197995d7cb9410e2b28dc69e4bcd8d8e30e4c3f1636c2682e
+  metadata.gz: 800487ec0f1fac16e67cbcdc71291a383d6dddf24e8729cbb937d87864b6f06dc3d61acd6141f0d0b4c6a6f4b3f36aa490a4f76b08b4731d86f66d65a2aa29a1
+  data.tar.gz: bbd9cc674f91ff9bd2605209b4ffb05a89f392aeb5ca2a3bf171baba19a81ceb1e692ff972b1b80209873ae676b04c26ee9a580880881787a6abf02b9640e9c5

data/lib/uuid/ncname.rb

@@ -127,7 +127,7 @@ module UUID::NCName
   def self.warn_version version
     if version.nil?
       warn 'Set an explicit :version to remove this warning. See documentation.'
-      version = 0
+      version = 1
     end
 
     raise 'Version must be 0 or 1' unless [0, 1].include? version
@@ -149,9 +149,9 @@ module UUID::NCName
   #
   # @param version [0, 1] An optional formatting version, where 0 is
   #  the naïve original version and 1 moves the `variant` nybble out
-  #  to the end of the identifier. You will be warned if you do not
-  #  set this parameter explicitly. The default is currently 0, but
-  #  will change in the next version.
+  #  to the end of the identifier. You will be warned for the time
+  #  being if you do not set this parameter explicitly. The default
+  #  version is 1.
   # 
   # @param align [true, false] Optional directive to treat the
   #  terminating character as aligned to the numerical base of the
@@ -202,7 +202,7 @@ module UUID::NCName
 
   # Converts an NCName-encoded UUID back to its canonical
   # representation. Will return nil if the input doesn't match the
-  # radix (if supplied) or is otherwise malformed.  doesn't match
+  # radix (if supplied) or is otherwise malformed.
   #
   # @param ncname [#to_s] an NCName-encoded UUID, either a
   #  22-character (Base64) variant, or a 26-character (Base32) variant.
@@ -212,17 +212,20 @@ module UUID::NCName
   # @param format [:str, :hex, :b64, :bin] An optional formatting
   #  parameter; defaults to `:str`, the canonical string representation.
   #
-  # @param version [0, 1] See `to_ncname`. Defaults (for now) to 0.
+  # @param version [0, 1] See #to_ncname. Defaults to 1.
   # 
-  # @param align [true, false, nil] See `to_ncname` for details.
+  # @param align [nil, true, false] See #to_ncname for details.
   #  Setting this parameter to `nil`, the default, will cause the
   #  decoder to detect the alignment state from the identifier.
   #
+  # @param validate [false, true] Check that the ninth octet is
+  # correctly masked _after_ decoding.
+  #
   # @return [String, nil] The corresponding UUID or nil if the input
   #  is malformed.
 
   def self.from_ncname ncname,
-      radix: nil, format: :str, version: nil, align: nil
+      radix: nil, format: :str, version: nil, align: nil, validate: false
     raise 'Format must be symbol-able' unless format.respond_to? :to_sym
     raise "Invalid format #{format}" unless FORMAT[format]
     raise 'Align must be true, false, or nil' unless
@@ -262,6 +265,9 @@ module UUID::NCName
 
     bin = TRANSFORM[version][1].call uuidver, content
 
+    # double-check the variant (high-order bits have to be 10)
+    return if validate and bin[8].ord >> 6 != 2
+
     FORMAT[format].call bin
   end
 
@@ -269,9 +275,9 @@ module UUID::NCName
   #
   # @param uuid [#to_s] The UUID
   # 
-  # @param version [0, 1] See `to_ncname`.
+  # @param version [0, 1] See #to_ncname.
   # 
-  # @param align [true, false] See `to_ncname`.
+  # @param align [true, false] See #to_ncname.
   #
   # @return [String] The Base64-encoded NCName
 
@@ -285,9 +291,9 @@ module UUID::NCName
   #
   # @param format [:str, :hex, :b64, :bin] The format
   # 
-  # @param version [0, 1] See `to_ncname`.
+  # @param version [0, 1] See #to_ncname.
   # 
-  # @param align [true, false] See `to_ncname`.
+  # @param align [true, false] See #to_ncname.
   #
   # @return [String, nil] The corresponding UUID or nil if the input
   #  is malformed.
@@ -300,9 +306,9 @@ module UUID::NCName
   #
   # @param uuid [#to_s] The UUID
   # 
-  # @param version [0, 1] See `to_ncname`.
+  # @param version [0, 1] See #to_ncname.
   # 
-  # @param align [true, false] See `to_ncname`.
+  # @param align [true, false] See #to_ncname.
   #
   # @return [String] The Base32-encoded NCName
 
@@ -316,9 +322,9 @@ module UUID::NCName
   #
   # @param format [:str, :hex, :b64, :bin] The format
   # 
-  # @param version [0, 1] See `to_ncname`.
+  # @param version [0, 1] See #to_ncname.
   # 
-  # @param align [true, false] See `to_ncname`.
+  # @param align [true, false] See #to_ncname.
   #
   # @return [String, nil] The corresponding UUID or nil if the input
   #  is malformed.
@@ -327,21 +333,34 @@ module UUID::NCName
     from_ncname ncname, radix: 32, format: format
   end
 
-  # Test if the given token is a UUID NCName, with a hint to its version.
+  # Test if the given token is a UUID NCName, with a hint to its
+  # version. This method can positively identify a token as a UUID
+  # NCName, but there is a small subset of UUIDs which will produce
+  # tokens which are valid in both versions. The method returns
+  # `false` if the token is invalid, otherwise it returns `0` or `1`
+  # for the guessed version.
+  #
+  # @note Version 1 tokens always end with I, J, K, or L (with base32
+  # being case-insensitive), so tokens that end in something else will
+  # be version 0.
   #
   # @param token [#to_s] The token to test
   #
   # @return [false, 0, 1]
   def self.valid? token
     token = token.to_s
-    if /^[A-P](?:[0-9A-Za-z_-]{21}|[2-7A-Za-z]{25})$/.match token
+    if /^[A-Pa-p](?:[0-9A-Za-z_-]{21}|[2-7A-Za-z]{25})$/.match token
       # false is definitely version zero but true is only maybe version 1
-      version = /[IJKLijkl]$/.match(token) ? 1 : 0
+      version = /^(?:.{21}[I-L]|.{25}[I-Li-l])$/.match(token) ? 1 : 0
+
+      # try decoding with validation on 
+      uu = from_ncname token, version: version, validate: true
 
-      if version == 1
-        uu = from_ncname token, version: 1
-        # lol even this isn't a guarantee
-        /[89ab]/.match(uu[19]) ? 1 : version
+      if version == 1 and !uu
+        # try version zero
+        uu = from_ncname token, version: 0, validate: true
+        # either zero or invalid
+        uu ? 0 : false
       else
         version
       end

data/lib/uuid/ncname/version.rb

@@ -3,5 +3,5 @@ unless Module.const_defined? 'UUID'
 end
 
 module UUID::NCName
-    VERSION = "0.2.3"
+    VERSION = "0.2.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: uuid-ncname
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - Dorian Taylor
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-15 00:00:00.000000000 Z
+date: 2019-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base32