uuidx 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d2e41b677c8a6cb523605c6f10620796d1b5831ad511a32b49e8d98415629677
-  data.tar.gz: 8e8935a0b62e6538a5de355ec22119a0cba5242a3c76767bb720d5d13192431d
+  metadata.gz: 0ca7c3e75acfde9ce0b2cd6f05d8bdd1c9809e095a7b69200a1a0271c7dcadbe
+  data.tar.gz: d393cb6874eae6ff28a4537a5f634764d3946611e61e00bd5f840ead16179d04
 SHA512:
-  metadata.gz: ff313efefe5c2ccca58479e2e208cd98d636b74e5311f5e29de20faaf5207f47baf708c304c2e15275fa2a75b26d0f050f7c38174ddeaadcbf8e9449e9dd8a1c
-  data.tar.gz: 4def103fd92484499eef8474454eed8e7f6bc2a0e975e7f22deabe986d02f12d957b7bf2457b8d6c6101e66c4789cffaf3844812b6b0e973c95950e7b7abfbf5
+  metadata.gz: de256df49b04450bc9cc47c3f44ca58af19a77385c7b7b52ad3d856e454e0ff48a2a7325eab9d38a083fcd12091a6663fa57f07ff3f7065bedab5be87756ea26
+  data.tar.gz: 2d8878d99f1086f9867f03d76382e87d30e7c915a1779a73c8dfad47e8e8c9e03cb007307d07b9748fc488659f27b2de2fb0bb6f345ce9f0ee2005f018442b24

data/CHANGELOG.md

@@ -6,6 +6,9 @@
 
 # Alpha Releases
 
+## 0.10.0 – 2023-02-21
+- Refactor module name to `Uuidx`
+
 ## 0.9.0 – 2023-02-11
 - Swap gem name to shorter uuidx
 - Main documentation written

data/README.md

@@ -1,5 +1,6 @@
 <h1 align="center">uuidx</h1>
 <p align="center">Fast Ruby implementations of UUID versions 4, 6, 7, and 8 🪪</p> 
+<p align="center"><a href="https://badge.fury.io/rb/uuidx"><img src="https://badge.fury.io/rb/uuidx.svg" alt="Gem Version" height="18"></a></p>
 
 ---
 
@@ -38,9 +39,9 @@ the library and call the associated method.
 ```ruby
 require "uuidx"
 
-Uuid.v4 # => "2b54639d-e43e-489f-9c64-30ecdcac3c95"
-Uuid.v6 # => "1eda9761-9f6f-6414-8c5f-fd61f1239907"
-Uuid.v7 # => "01863d24-6d1e-78ba-92ee-6e80c79c4e28"
+Uuidx.v4 # => "2b54639d-e43e-489f-9c64-30ecdcac3c95"
+Uuidx.v6 # => "1eda9761-9f6f-6414-8c5f-fd61f1239907"
+Uuidx.v7 # => "01863d24-6d1e-78ba-92ee-6e80c79c4e28"
 ```
 
 These methods all use default generators and are thread-safe. However, if you
@@ -50,9 +51,9 @@ the generators you are using when each child process starts.
 ```ruby
 # Puma example that resets all default generators.
 on_worker_boot do
-  Uuid.reset_v4!
-  Uuid.reset_v6!
-  Uuid.reset_v7!
+  Uuidx.reset_v4!
+  Uuidx.reset_v6!
+  Uuidx.reset_v7!
 end
 ```
 
@@ -60,13 +61,13 @@ This way you will get thread-safe state access per process without requiring
 IPC.
 
 ### Monotonicity & Batching
-The simple API provided by `Uuid` also supports monotonic batches. Provide the
+The simple API provided by `Uuidx` also supports monotonic batches. Provide the
 batch size and you will receive an array of UUID values back.
 
 ```ruby
-Uuid.batch_v4(10) # => ["2b54639d-e43e-489f-9c64-30ecdcac3c95", ...]
-Uuid.batch_v6(10) # => ["1eda9761-9f6f-6414-8c5f-fd61f1239907", ...]
-Uuid.batch_v7(10) # => ["01863d24-6d1e-78ba-92ee-6e80c79c4e28", ...]
+Uuidx.batch_v4(10) # => ["2b54639d-e43e-489f-9c64-30ecdcac3c95", ...]
+Uuidx.batch_v6(10) # => ["1eda9761-9f6f-6414-8c5f-fd61f1239907", ...]
+Uuidx.batch_v7(10) # => ["01863d24-6d1e-78ba-92ee-6e80c79c4e28", ...]
 ```
 
 ### Advanced Usage
@@ -74,7 +75,7 @@ If you require multiple generators you can drop below the simple API presented
 above to create generators directly.
 
 ```ruby
-v6 = Uuid::Version6.new
+v6 = Uuidx::Version6.new
 v6.generate # => "1eda9adc-2ed9-629e-9a02-4d2ccc87c569"
 ```
 
@@ -91,21 +92,21 @@ a generator directly. It takes a single parameter to its constructor which must
 be the class name of your UUID v8 definition.
 
 ```ruby
-v8 = Uuid::Version8.new(MyV8Definition)
+v8 = Uuidx::Version8.new(MyV8Definition)
 v8.generate # => "..."
 ```
 
 The definition class should implement the methods `custom_a`, `custom_b`, and
 `custom_c` in order to fill out the UUID data [according to the draft](https://www.ietf.org/archive/id/draft-ietf-uuidrev-rfc4122bis-01.html#name-uuid-version-8).
 
-See the [documentation for Version8](https://tinychameleon.github.io/uuidx/Uuid/Version8.html) for precise details.
+See the [documentation for Version8](https://tinychameleon.github.io/uuidx/Uuidx/Version8.html) for precise details.
 
 #### Batching
-Any custom UUID v8 generators can also participate in thread-safe batching by using
-the `batch` method.
+Any custom UUID v8 generators can also participate in batching by using the
+`batch` method. The thread-safety of this depends on your UUID v8 implementation.
 
 ```ruby
-Uuid.batch(v8, 10) # => ["<a v8 uuid>", ...]
+Uuidx.batch(v8, 10) # => ["<a v8 uuidx>", ...]
 ```
 
 ### Clock Resolution
@@ -115,24 +116,24 @@ is raised if the system has insufficient precision.
 
 ```ruby
 begin
-  Uuid::Version6.verify_clock_resolution! # or Uuid::Version7
-rescue Uuid::ClockResolutionError
+  Uuidx::Version6.verify_clock_resolution! # or Uuidx::Version7
+rescue Uuidx::ClockResolutionError
   # ...
 end
 ```
 
 The API documentation has details about what the clock resolution must be for
 each of the UUID versions. See the
-[Version 6](https://tinychameleon.github.io/uuidx/Uuid/Version6.html) and
-[Version 7](https://tinychameleon.github.io/uuidx/Uuid/Version7.html)
+[Version 6](https://tinychameleon.github.io/uuidx/Uuidx/Version6.html) and
+[Version 7](https://tinychameleon.github.io/uuidx/Uuidx/Version7.html)
 documentation for details.
 
 ### A Note on Clock Timings
 The API documentation contains specific details around how the implementations
 deal with clock drift. See the
-[Uuid](https://tinychameleon.github.io/uuidx/Uuid.html),
-[Version 6](https://tinychameleon.github.io/uuidx/Uuid/Version6.html), and
-[Version 7](https://tinychameleon.github.io/uuidx/Uuid/Version7.html)
+[Uuidx](https://tinychameleon.github.io/uuidx/Uuidx.html),
+[Version 6](https://tinychameleon.github.io/uuidx/Uuidx/Version6.html), and
+[Version 7](https://tinychameleon.github.io/uuidx/Uuidx/Version7.html)
 documentation for more information.
 
 ## Performance
@@ -183,9 +184,9 @@ To release a new version:
 
 1. ensure the documentation and changelog are ready
 2. run `bundle exec rake rdoc` to generate the new documentation and commit it
-3. update the version number in `lib/uuid/gem_version.rb`
+3. update the version number in `lib/uuidx/gem_version.rb`
 4. run `bundle install` to update the `Gemfile.lock`
-5. create a release commit with the version updates
+5. create a release commit with these updates
 6. run `bundle exec rake release` to tag and push the version to RubyGems
 
 ## Contributing

data/lib/{uuid → uuidx}/errors.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-module Uuid
-  # Top-level error for all Uuid errors.
+module Uuidx
+  # Top-level error for all Uuidx errors.
   class Error < StandardError
   end
 

data/lib/{uuid → uuidx}/gem_version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Uuid
+module Uuidx
   # The gem version.
-  VERSION = "0.9.0"
+  VERSION = "0.10.0"
 end

data/lib/{uuid → uuidx}/version4.rb

@@ -2,12 +2,12 @@
 
 require "securerandom"
 
-module Uuid
+module Uuidx
   # UUID Version 7 defined by the
   # {RFC 4122 BIS-01 Draft}[https://www.ietf.org/archive/id/draft-ietf-uuidrev-rfc4122bis-01.html#name-uuid-version-4].
   #
   # To construct a new UUID v4 value create a generator, then use #generate.
-  #   g = Uuid::Version4.new
+  #   g = Uuidx::Version4.new
   #   g.generate # => "2b54639d-e43e-489f-9c64-30ecdcac3c95"
   #
   # The implementation will cache 1024 bytes of random data from +SecureRandom+ to facilitate faster construction.
@@ -30,7 +30,7 @@ module Uuid
       @pool = SecureRandom.bytes(NEEDED_BYTES).unpack(UNPACK_FORMAT) if @pool.empty?
       ab, c = @pool.pop(2)
 
-      Uuid.format(VERSION_VARIANT | ((ab & RANDOM_AB_MASK) << AB_SHIFT) | (c & RANDOM_C_MASK))
+      Uuidx.format(VERSION_VARIANT | ((ab & RANDOM_AB_MASK) << AB_SHIFT) | (c & RANDOM_C_MASK))
     end
   end
 end

data/lib/{uuid → uuidx}/version6.rb

@@ -2,12 +2,12 @@
 
 require "securerandom"
 
-module Uuid
+module Uuidx
   # UUID Version 6 defined by the
   # {RFC 4122 BIS-01 Draft}[https://www.ietf.org/archive/id/draft-ietf-uuidrev-rfc4122bis-01.html#name-uuid-version-6].
   #
   # To construct a new UUID v6 value create a generator, then use #generate.
-  #   g = Uuid::Version6.new
+  #   g = Uuidx::Version6.new
   #   g.generate # => "1eda9761-9f6f-6414-8c5f-fd61f1239907"
   #
   # The implementation will use +SecureRandom+ to populate the Node and Clock Sequence bits with a random value
@@ -20,8 +20,8 @@ module Uuid
   # you can call ::verify_clock_resolution! and handle the ClockResolutionError as you see fit.
   #
   #   begin
-  #     Uuid::Version6.verify_clock_resolution!
-  #   rescue Uuid::ClockResolutionError
+  #     Uuidx::Version6.verify_clock_resolution!
+  #   rescue Uuidx::ClockResolutionError
   #     # ...
   #   end
   #
@@ -56,7 +56,7 @@ module Uuid
       ts = GREGORIAN_MICROSECOND_TENTHS + (Process.clock_gettime(Process::CLOCK_REALTIME, :nanosecond) / TS_NS_FACTOR)
       ts = ((ts << TS_MASK_SHIFT) & TS_HIGH_MID_MASK) | (ts & TS_LOW_MASK)
 
-      Uuid.format(VERSION_VARIANT | (ts << TS_POSITIONAL_SHIFT) | @clock_sequence | @node_id)
+      Uuidx.format(VERSION_VARIANT | (ts << TS_POSITIONAL_SHIFT) | @clock_sequence | @node_id)
     end
 
     # Reset the generator with a new random node ID and clock sequence.

data/lib/{uuid → uuidx}/version7.rb

@@ -2,12 +2,12 @@
 
 require "securerandom"
 
-module Uuid
+module Uuidx
   # UUID Version 7 defined by the
   # {RFC 4122 BIS-01 Draft}[https://www.ietf.org/archive/id/draft-ietf-uuidrev-rfc4122bis-01.html#name-uuid-version-7].
   #
   # To construct a new UUID v7 value create a generator, then use #generate.
-  #   g = Uuid::Version7.new
+  #   g = Uuidx::Version7.new
   #   g.generate # => "01863d24-6d1e-78ba-92ee-6e80c79c4e28"
   #
   # The implementation will cache 640 bytes of random data from +SecureRandom+ to facilitate faster construction.
@@ -16,8 +16,8 @@ module Uuid
   # you can call ::verify_clock_resolution! and handle the ClockResolutionError as you see fit.
   #
   #   begin
-  #     Uuid::Version7.verify_clock_resolution!
-  #   rescue Uuid::ClockResolutionError
+  #     Uuidx::Version7.verify_clock_resolution!
+  #   rescue Uuidx::ClockResolutionError
   #     # ...
   #   end
   #
@@ -53,7 +53,7 @@ module Uuid
       ts = Process.clock_gettime(Process::CLOCK_REALTIME, :millisecond) & TS_MASK
       high = (ts << TS_SHIFT) | (a & RAND_A_MASK)
 
-      Uuid.format(VERSION_VARIANT | (high << HIGH_SHIFT) | (b & RAND_B_MASK))
+      Uuidx.format(VERSION_VARIANT | (high << HIGH_SHIFT) | (b & RAND_B_MASK))
     end
 
     # Verify that the clock resolution is capable of 1ms resolution.

data/lib/{uuid → uuidx}/version8.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Uuid
+module Uuidx
   # UUID Version 8 defined by the
   # {RFC 4122 BIS-01 Draft}[https://www.ietf.org/archive/id/draft-ietf-uuidrev-rfc4122bis-01.html#name-uuid-version-8].
   #
@@ -26,7 +26,7 @@ module Uuid
   # - +custom_c+ should generate a 62-bit value which acts as the remaining least significant octets.
   #
   # Then create a UUID v8 generator by passing in the class, and call #generate.
-  #   g = Uuid::Version8.new(MyGeneratorDefinition)
+  #   g = Uuidx::Version8.new(MyGeneratorDefinition)
   #   g.generate # => "00000000-0001-8002-8000-000000000003"
   #
   # The implementation will truncate the results of each generator module method so that they abide by the bit lengths
@@ -53,7 +53,7 @@ module Uuid
       high = (a << A_SHIFT) | b
       c = @definition.custom_c & CUSTOM_C_MASK
 
-      Uuid.format(VERSION_VARIANT | (high << HIGH_SHIFT) | c)
+      Uuidx.format(VERSION_VARIANT | (high << HIGH_SHIFT) | c)
     end
   end
 end

data/lib/{uuid.rb → uuidx.rb}

@@ -1,22 +1,22 @@
 # frozen_string_literal: true
 
 require "set"
-require_relative "uuid/gem_version"
-require_relative "uuid/errors"
-require_relative "uuid/version4"
-require_relative "uuid/version6"
-require_relative "uuid/version7"
-require_relative "uuid/version8"
+require_relative "uuidx/gem_version"
+require_relative "uuidx/errors"
+require_relative "uuidx/version4"
+require_relative "uuidx/version6"
+require_relative "uuidx/version7"
+require_relative "uuidx/version8"
 
-# The Uuid module contains a simple API to generate v4, v6, and v7 UUIDs
+# The Uuidx module contains a simple API to generate v4, v6, and v7 UUIDs
 # without needing to create generators manually.
 #
 # The simple API is exposed as a set of methods ::v4, ::v6, and ::v7 which
 # handle thread-safety and generator creation.
 #
-#   Uuid.v4 # => "2b54639d-e43e-489f-9c64-30ecdcac3c95"
-#   Uuid.v6 # => "1eda9761-9f6f-6414-8c5f-fd61f1239907"
-#   Uuid.v7 # => "01863d24-6d1e-78ba-92ee-6e80c79c4e28"
+#   Uuidx.v4 # => "2b54639d-e43e-489f-9c64-30ecdcac3c95"
+#   Uuidx.v6 # => "1eda9761-9f6f-6414-8c5f-fd61f1239907"
+#   Uuidx.v7 # => "01863d24-6d1e-78ba-92ee-6e80c79c4e28"
 #
 # See the Version4, Version6, and Version7 classes for details on how to create
 # generators manually.
@@ -25,9 +25,9 @@ require_relative "uuid/version8"
 # The simple API also provides thread-safe monotonic batch methods which expect
 # an amount.
 #
-#   Uuid.batch_v4(10) # => ["2b54639d-e43e-489f-9c64-30ecdcac3c95", ...]
-#   Uuid.batch_v6(10) # => ["1eda9761-9f6f-6414-8c5f-fd61f1239907", ...]
-#   Uuid.batch_v7(10) # => ["01863d24-6d1e-78ba-92ee-6e80c79c4e28", ...]
+#   Uuidx.batch_v4(10) # => ["2b54639d-e43e-489f-9c64-30ecdcac3c95", ...]
+#   Uuidx.batch_v6(10) # => ["1eda9761-9f6f-6414-8c5f-fd61f1239907", ...]
+#   Uuidx.batch_v7(10) # => ["01863d24-6d1e-78ba-92ee-6e80c79c4e28", ...]
 #
 # Monotonicity has little meaning with UUID v4, but the batches are ordered for
 # consistency.
@@ -39,7 +39,7 @@ require_relative "uuid/version8"
 # within the timestamp values.
 #
 # See the Version6 and Version7 documentation for manifestation details.
-module Uuid
+module Uuidx
   # The nil UUID as defined by
   # {§5.10 of RFC 4122 BIS-01}[https://www.ietf.org/archive/id/draft-ietf-uuidrev-rfc4122bis-01.html#name-nil-uuid].
   #

data/sig/{uuid → uuidx}/errors.rbs

@@ -1,4 +1,4 @@
-module Uuid
+module Uuidx
   class Error < StandardError
   end
 

data/sig/{uuid → uuidx}/version4.rbs

@@ -1,4 +1,4 @@
-module Uuid
+module Uuidx
   class Version4
     def initialize: () -> void
     def generate: () -> uuid

data/sig/{uuid → uuidx}/version6.rbs

@@ -1,4 +1,4 @@
-module Uuid
+module Uuidx
   class Version6
     public
 

data/sig/{uuid → uuidx}/version7.rbs

@@ -1,4 +1,4 @@
-module Uuid
+module Uuidx
   class Version7
     public
 

data/sig/{uuid → uuidx}/version8.rbs

@@ -1,4 +1,4 @@
-module Uuid
+module Uuidx
   class Version8
     public
 

data/sig/{uuid.rbs → uuidx.rbs}

@@ -1,6 +1,6 @@
 # See the writing guide of rbs: https://github.com/ruby/rbs#guides
 
-module Uuid
+module Uuidx
   VERSION: String
 
   type uuid = String

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: uuidx
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Stephan Tarulli
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-02-11 00:00:00.000000000 Z
+date: 2023-02-22 00:00:00.000000000 Z
 dependencies: []
 description: "A fast Ruby implementation of UUID versions 4, 6, 7, and 8 \U0001FAAA"
 email:
@@ -20,19 +20,19 @@ files:
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
-- lib/uuid.rb
-- lib/uuid/errors.rb
-- lib/uuid/gem_version.rb
-- lib/uuid/version4.rb
-- lib/uuid/version6.rb
-- lib/uuid/version7.rb
-- lib/uuid/version8.rb
-- sig/uuid.rbs
-- sig/uuid/errors.rbs
-- sig/uuid/version4.rbs
-- sig/uuid/version6.rbs
-- sig/uuid/version7.rbs
-- sig/uuid/version8.rbs
+- lib/uuidx.rb
+- lib/uuidx/errors.rb
+- lib/uuidx/gem_version.rb
+- lib/uuidx/version4.rb
+- lib/uuidx/version6.rb
+- lib/uuidx/version7.rb
+- lib/uuidx/version8.rb
+- sig/uuidx.rbs
+- sig/uuidx/errors.rbs
+- sig/uuidx/version4.rbs
+- sig/uuidx/version6.rbs
+- sig/uuidx/version7.rbs
+- sig/uuidx/version8.rbs
 homepage: https://github.com/tinychameleon/uuidx
 licenses:
 - MIT
@@ -58,7 +58,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.3
+rubygems_version: 3.4.7
 signing_key:
 specification_version: 4
 summary: "A fast Ruby implementation of UUID versions 4, 6, 7, and 8 \U0001FAAA"