ksuid 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 39789ed89a8ef5f2a949dc5cf716ef87f98904902dd8262e123b325408e6e69c
-  data.tar.gz: e0d3f66c83acab156cc260d063c0a69921b880a83dce3ca32edd0635ed230579
+  metadata.gz: f717bc154ecc3919542742b7c927f62c924a8d4f73ec81be31f3ac3239d2b76b
+  data.tar.gz: e64581c8cd8cb4097fc0cd8fe869f3900cc61de735bb0ac36947143ae87fe611
 SHA512:
-  metadata.gz: c4a500c7863252cbe4a55a898ee941e800757676ae3a78c5f191a61173267768ea5b8352609e3689295eb233e14551fea87333fe3f0158208154aed17d9035b4
-  data.tar.gz: de9846561e6d4a2282bbbdf16ea524f6160198916e4cee8292968cb58d378cd66b2ea4699a0698a3f95db69070d3307118bb000726cb6ce05192eac20ed73a90
+  metadata.gz: dfa9df01eb24b3ce510d38d673726e0bd6e0bda87e5716cdbff2bdd4cdeec129a1cc1a95c60c221e91202837e8a70ff3ec90421bc9a026b5af98038de10d6b06
+  data.tar.gz: ed5c2932989a25b83ef0b3004a546cd0b3b465a208cf374e46daeeb34080eaac626908b846af74b6183fe1b896c4aeec8ee38628b87b9c1d805ef1dc2b1d5c3a

data/CHANGELOG.md

@@ -4,6 +4,12 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [0.3.0](https://github.com/michaelherold/ksuid/compare/v0.2.0...v0.3.0) - 2021-10-07
+
+### Added
+
+- A utility function for converting from a hexidecimal-encoded string to a byte string. This is necessary to handle the default encoding of binary fields within PostgreSQL.
+
 ## [0.2.0](https://github.com/michaelherold/ksuid/compare/v0.1.0...v0.2.0) - 2020-11-11
 
 ### Added

data/README.md

@@ -1,14 +1,14 @@
 # KSUID for Ruby
 
-[![Build Status](https://travis-ci.org/michaelherold/ksuid-ruby.svg)][travis]
+[![Build Status](https://github.com/michaelherold/ksuid-ruby/workflows/Continuous%20integration/badge.svg)][actions]
 [![Test Coverage](https://api.codeclimate.com/v1/badges/94b2a2d4082bff21c10f/test_coverage)][test-coverage]
 [![Maintainability](https://api.codeclimate.com/v1/badges/94b2a2d4082bff21c10f/maintainability)][maintainability]
 [![Inline docs](http://inch-ci.org/github/michaelherold/ksuid-ruby.svg?branch=master)][inch]
 
+[actions]: https://github.com/michaelherold/ksuid-ruby/actions
 [inch]: http://inch-ci.org/github/michaelherold/ksuid-ruby
 [maintainability]: https://codeclimate.com/github/michaelherold/ksuid-ruby/maintainability
 [test-coverage]: https://codeclimate.com/github/michaelherold/ksuid-ruby/test_coverage
-[travis]: https://travis-ci.org/michaelherold/ksuid-ruby
 
 ksuid is a Ruby library that can generate and parse [KSUIDs](https://github.com/segmentio/ksuid). The original readme for the Go version of KSUID does a great job of explaining what they are and how they should be used, so it is excerpted here.
 
@@ -215,10 +215,11 @@ So you’re interested in contributing to KSUID? Check out our [contributing gui
 
 ## Supported Ruby Versions
 
-This library aims to support and is [tested against][travis] the following Ruby versions:
+This library aims to support and is [tested against][actions] the following Ruby versions:
 
 * Ruby 2.5
 * Ruby 2.6
+* Ruby 2.7
 * JRuby 9.2
 
 If something doesn't work on one of these versions, it's a bug.

data/ksuid.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |spec|
   spec.name    = 'ksuid'
   spec.version = KSUID::VERSION
   spec.authors = ['Michael Herold']
-  spec.email   = ['michael@michaeljherold.com']
+  spec.email   = ['opensource@michaeljherold.com']
 
   spec.summary     = 'Ruby implementation of the K-Sortable Unique IDentifier'
   spec.description = spec.summary

data/lib/ksuid/base62.rb

@@ -20,6 +20,11 @@ module KSUID
     # @api private
     BASE = CHARSET.size
 
+    # A matcher that checks whether a String has a character outside the charset
+    #
+    # @api private
+    MATCHER = /[^#{CHARSET}]/.freeze
+
     # Checks whether a string is a base 62-compatible string
     #
     # @api public
@@ -30,7 +35,7 @@ module KSUID
     # @param string [String] the string to check for compatibility
     # @return [Boolean]
     def self.compatible?(string)
-      string.each_char.all? { |char| CHARSET.include?(char) }
+      string.each_char.all? { |char| !MATCHER.match?(char) }
     end
 
     # Decodes a base 62-encoded string into an integer

data/lib/ksuid/utils.rb

@@ -5,7 +5,19 @@ module KSUID
   #
   # @api private
   module Utils
-    # Converts a byte string into a byte array
+    # A regular expression for splitting bytes out of a "binary" string
+    #
+    # @api private
+    # @return [Regexp] the splitter
+    BYTES = /.{8}/.freeze
+
+    # A regular expression for splitting a String into pairs of characters
+    #
+    # @api private
+    # @return [Regexp] the splitter
+    PAIRS = /.{2}/.freeze
+
+    # Converts a byte array into a byte string
     #
     # @param bytes [String] a byte string
     # @return [Array<Integer>] an array of bytes from the byte string
@@ -13,6 +25,21 @@ module KSUID
       bytes.pack('C*')
     end
 
+    # Converts a hex string into a byte string
+    #
+    # @param hex [String] a hex-encoded KSUID
+    # @param bits [Integer] the expected number of bits for the result
+    # @return [String] the byte string
+    def self.byte_string_from_hex(hex, bits = 32)
+      byte_array =
+        hex
+        .rjust(bits, '0')
+        .scan(PAIRS)
+        .map { |bytes| bytes.to_i(16) }
+
+      byte_string_from_array(byte_array)
+    end
+
     # Converts a byte string or byte array into a hex-encoded string
     #
     # @param bytes [String, Array<Integer>] the byte string or array
@@ -47,9 +74,8 @@ module KSUID
       int
         .to_s(2)
         .rjust(bits, '0')
-        .split('')
-        .each_slice(8)
-        .map { |digits| digits.join.to_i(2) }
+        .scan(BYTES)
+        .map { |digits| digits.to_i(2) }
         .pack("C#{bits / 8}")
     end
   end

data/lib/ksuid/version.rb

@@ -4,5 +4,5 @@ module KSUID
   # The version of the KSUID gem
   #
   # @return [String]
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ksuid
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Michael Herold
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-12 00:00:00.000000000 Z
+date: 2021-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -26,7 +26,7 @@ dependencies:
         version: '1.15'
 description: Ruby implementation of the K-Sortable Unique IDentifier
 email:
-- michael@michaeljherold.com
+- opensource@michaeljherold.com
 executables: []
 extensions: []
 extra_rdoc_files: []