easy-uuid 0.1.0 → 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ad07d1208eb16cd745b048adb55ca02f86430e88f513f7e188d77a4a30d3fc10
+  data.tar.gz: cad79f0eea9bdf41194365c4935cf49c946395d754632335bee9fd6a32e7561b
+SHA512:
+  metadata.gz: bbbe31f97f6e193c3ee8c35b73dbf6ff433d77c1a801320dc9a6e8fa9fe11a71eaf998f4854fe69274955c9142456f336ce3439a4b9ddfd69200f82bd9c05bd5
+  data.tar.gz: 41681b7c64d41c1f4e0b18ef0b26467be123df2ff528e57bc229c8b4bdf04525b1c1742f05c561d6009ae00bf93f0acc9a101ab7bf33e4cadb5f3fbc0f29826f

data/lib/uuid.rb

@@ -1,48 +1,86 @@
 module Kernel
+    # Cast to UUID
+    #
+    # @raise [TypeError] 
     def UUID(uuid)
-        if    uuid.nil?                       then nil
+        if    uuid.nil?                       then UUID::NIL
         elsif uuid.is_a?(UUID)                then uuid
         elsif uuid.is_a?(Integer)             then UUID.new(uuid)
-        elsif uuid = String.try_convert(uuid) then UUID.parse(uuid)
-        else raise ArgumentError, 
-                 "bad argument (expected UUID object, string or integer)"
+        elsif uuid = String.try_convert(uuid) then
+            uuid.size == 16 ? UUID.new(uuid) : UUID.parse(uuid)
+        else raise TypeError, "can't convert #{uuid.class} into UUID"
         end
     end
     module_function :UUID
 end
 
 class UUID
-    VERSION = '0.1.0'
-
-    REGEX   = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i
-    MAX_INT = 2**128-1
-    def self.parse(v)
-        v = v.to_str
-        s = v.size
-        v = if    s == 16                then v
-            elsif s == 36 && REGEX === v then [v.delete('-')].pack('H32')
-            else raise ArgumentError, "unable to parse UUID"
-            end
-        self.new(v)
+    # Version
+    VERSION = '0.2.0'
+
+    # Basic regex for validating UUID formatted string
+    REGEX   = /\A\h{8}-\h{4}-\h{4}-\h{4}-\h{12}\z/
+
+
+    # Parse a UUID formatted string
+    #
+    # @param str [String] string to parse
+    #
+    # @raise [ArgumentError] the string is not parsable as a UUID
+    #
+    # @return [UUID]
+    #
+    def self.parse(str)
+        unless str =~ REGEX
+            raise ArgumentError, "unable to parse UUID value"
+        end
+
+        self.new( [str.delete('-')].pack('H32') )
     end
 
+
+    # Create UUID
+    #
+    # @param [String,Integer] UUID value
+    #
+    # @raise [ArgumentError] given integer is too big or
+    #                        given string is not 16-byte 8bit
+    #
     def initialize(v)
         case v
         when Integer
-            v += MAX_INT + 1 if v < 0
-            raise "value to big (must fit in 128bit)" if v > MAX_INT
-            v = [ "%032x" % [ v ] ].pack('H32')
+            hex = "%032x" % [ v ]
+            if hex.size > 32
+                raise ArgumentError,
+                      "integer to big (must fit in 128-bit)"
+            end
+            @raw = [ hex ].pack('H32')
         when String
             if v.size != 16 || v.encoding.name != 'ASCII-8BIT'
                 raise ArgumentError,
-                    "need to be 16 characters ASCII-8BIT string (#{v})"
+                    "need to be a 16 byte ASCII-8BIT string (#{v})"
             end
+            @raw = v.dup.freeze
         else
-            raise ArgumentError, "expected 128-bit integer or 16-byte string"
+            raise ArgumentError,
+                  "expected 128-bit integer or 16-byte string"
         end
-        @raw = v.dup.freeze
     end
 
+
+    # Return the 16-byte sequence forming the UUID.
+    #
+    # @return [Array<Integer>]
+    #
+    def bytes
+        @raw.bytes
+    end
+
+
+    # Generates an integer hash value
+    #
+    # @return [Integer] hash value
+    #
     def hash
         @raw.hash
     end
@@ -56,16 +94,65 @@ class UUID
     alias_method :==,        :eql?
 
     def to_raw          ; @raw					; end
-    def to_s            ; @raw.unpack('H8H4H4H4H12').join('-')	; end
-    def inspect         ; "#<#{self.class}:#{to_s}>"   		; end
-    alias_method :to_binary, :to_raw    
+
+    # Returns a string containing a human-readable representation
+    # of this object
+    #
+    # @return [String]
+    #
+    def inspect
+        "#<#{self.class}:#{to_s}>"
+    end
+
+
+    # Get the UUID value as an integer
+    #
+    # @return [Integer] UUID value
+    #
+    def to_i
+        i, j = @raw.unpack('Q>Q>')
+        i * 2**64 + j
+    end
+    alias :to_int :to_i
+
+
+    # Get the UUID string representation
+    #
+    # @return [String] UUID string representation
+    #
+    def to_s
+        @raw.unpack('H8H4H4H4H12').join('-')
+    end
     alias_method :to_str,    :to_s
 
+    
+    # Get the URI has a URN in UUID namespace
+    #
+    # @return [String] Uniform Resource Name
+    #
+    def to_uri
+        "urn:uuid:#{self}"
+    end
+
+
+    # Get the JSON represenation
+    #
+    # @return [String]
+    #
+    def to_json(*a)
+        self.to_s.to_json(*a)
+    end
+
+
     # Sequel
     def sql_literal(ds) ; '0x' + @raw.unpack('H32')[0] 		; end
     def to_blob         ; Sequel.blob(@raw)            		; end
 
-    # Constants
+    
+    # Nil/Empty UUID
     NIL = UUID('00000000-0000-0000-0000-000000000000')
+
+    # UUID with all bit set.
+    # @note It is not a valid UUID but can be usefull
     FFF = UUID('ffffffff-ffff-ffff-ffff-ffffffffffff')
 end

metadata

@@ -1,16 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: easy-uuid
 version: !ruby/object:Gem::Version
-  version: 0.1.0
-  prerelease: 
+  version: 0.2.0
 platform: ruby
 authors:
 - Stephane D'Alu
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-02-05 00:00:00.000000000 Z
-dependencies: []
+date: 2021-05-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13'
 description: UUID library for Ruby
 email:
 - sdalu@sdalu.com
@@ -19,34 +46,27 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/uuid.rb
-homepage: http://github.com/sdalu/easy-uuid
-licenses: []
-post_install_message: 
+homepage: http://gitlab.com/sdalu/easy-uuid
+licenses:
+- MIT
+metadata: {}
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 1872846144021895192
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 1872846144021895192
 requirements: []
-rubyforge_project: 
-rubygems_version: 1.8.29
-signing_key: 
-specification_version: 3
+rubygems_version: 3.0.8
+signing_key:
+specification_version: 4
 summary: UUID library for Ruby
 test_files: []