crockford32 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a8731f2fc74f2b2e8b156421639d7be5bccc79d8560295868ac278ca81b2f7a7
-  data.tar.gz: 2e9c6d6ccbb40ebb8023b3f711501a62b1ccb1bd972b3e9f967d1b50f4cbf2cb
+  metadata.gz: b2f3c133e3c624b9664a506fc2d8a9b4637d7316ce4e22d288f1c7a989ae2dc9
+  data.tar.gz: 99218eed8df26f78d663e6126e6a0f2579e7d7abbed00934bb17af668881561c
 SHA512:
-  metadata.gz: d73156968ffbfd3b02886fbd57d1adf6ffad73a7226b3f80c05e4e7c4cc89c3a533f7eb84d5dff7dd51020162d9ccd365ed206db43cc0fe3aa8f75bd8ff4a97d
-  data.tar.gz: 9c0a53a37aa656c4d69c0c1b7dd0a091660445450aff51339b1640e10031cd9cb50a1e99374be2b177bbe199fd18ff3cda47338a22023fc9362d4adc11902b20
+  metadata.gz: cfae960c489f647dd841ee981c2a414c2b92283be33519d125b65382f3e8f7bc818cad6a2dde442fbb2c7f6caf913b50d7d78567ea1aaba46d956b0f9f707320
+  data.tar.gz: 211e81e821b28cab1f6a84a698687a0c11d82a53de529e44708cd51d8f574b1c01c848246a5bf798364cd2ba4c62e54eb1ad9b5f3fd225be80fd3987c87842c8

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## v1.1.0 - 2022-03-08
+- Add `length:` parameter to `Crockford32.decode` to support padding to a given length after decoding into a string.
+
 ## v1.0.2 - 2022-02-22
 - Add type definitions
 

data/README.md

@@ -3,6 +3,20 @@ A fast little-endian implementation of [Douglas Crockford's Base32 specification
 
 [![Gem Version](https://badge.fury.io/rb/crockford32.svg)](https://badge.fury.io/rb/crockford32)
 
+## What's in the box?
+✅ Simple usage documentation written to get started fast. [Check it out!](#usage)
+
+⚡ A pretty fast implementation of Crockford32 in pure ruby. [Check it out!](#benchmarks)
+
+📚 YARD generated API documentation for the library. [Check it out!](https://tinychameleon.github.io/crockford32/)
+
+🤖 RBS types for your type checking wants. [Check it out!](./sig/crockford32.rbs)
+
+💎 Tests against many Ruby versions. [Check it out!](#ruby-versions)
+
+🔒 MFA protection on all gem owners. [Check it out!](https://rubygems.org/gems/crockford32)
+
+
 ## Installation
 Add this line to your application's Gemfile:
 
@@ -28,6 +42,7 @@ This gem is tested against the following Ruby versions:
 - 3.0.0
 - 3.0.3
 - 3.1.0
+- 3.1.1
 
 
 ## Usage
@@ -105,19 +120,21 @@ This library _always_ uses little-endian.
 For more detailed information about the library [see the API documentation](https://tinychameleon.github.io/crockford32/).
 
 
-## Development
+## Contributing
+
+### Development
 To get started development on this gem run the `bin/setup` command. This will install dependencies and run the tests and linting tasks to ensure everything is working.
 
 For an interactive console with the gem loaded run `bin/console`.
 
 
-## Testing
+### Testing
 Use the `bundle exec rake test` command to run unit tests. To install the gem onto your local machine for general integration testing use `bundle exec rake install`.
 
 To test the gem against each supported version of Ruby use `bin/test_versions`. This will create a Docker image for each version and run the tests and linting steps.
 
 
-## Releases
+### Releasing
 Do the following to release a new version of this gem:
 
 - Update the version number in [lib/crockford32/version.rb](./lib/crockford32/version.rb)

data/lib/crockford32/version.rb

@@ -2,5 +2,5 @@
 
 module Crockford32
   # The library version.
-  VERSION = "1.0.2"
+  VERSION = "1.1.0"
 end

data/lib/crockford32.rb

@@ -54,6 +54,7 @@ module Crockford32
   # @param value [String] the Base32 value to decode.
   # @param into [Symbol] the destination type to decode into. Can be +:integer+ or +:string+.
   # @param check [Boolean] whether to validate the check symbol.
+  # @param length [Integer, nil] the length of the resulting string when right padded.
   #
   # @return [Integer, String] the decoded value.
   #
@@ -61,7 +62,7 @@ module Crockford32
   # @raise [InvalidCharacterError] when the value being decoded has a character outside the
   #   Base32 symbol set or a misplaced check symbol.
   # @raise [UnsupportedDecodingTypeError] when the requested +into:+ type is not supported.
-  def self.decode(value, into: :integer, check: false)
+  def self.decode(value, into: :integer, check: false, length: nil)
     checksum = check ? value[-1] : nil
     value = check ? value[0...-1] : value
 
@@ -73,7 +74,7 @@ module Crockford32
       raise ChecksumError.new(value, actual, required) if actual != required
     end
 
-    convert result, into
+    convert result, into, length
   end
 
   # Encode a value as Base32.
@@ -118,13 +119,14 @@ module Crockford32
   #
   # @param result [Integer] the decoded value.
   # @param type [Symbol] the destination type for the value. Can be +:integer+ or +:string+.
+  # @param length [Integer, nil] the length to pad the string to.
   # @return [Integer, String] the decoded value converted to the destination type.
-  def self.convert(result, type)
+  def self.convert(result, type, length)
     case type
     when :integer
       result
     when :string
-      into_string result
+      into_string result, length
     else
       raise UnsupportedDecodingTypeError.new(type)
     end
@@ -135,8 +137,9 @@ module Crockford32
   # Each 8-bit sequence is packed into a String in little-endian order.
   #
   # @param result [Integer] the decoded value.
+  # @param length [Integer, nil] the length of the decoded value with right padding.
   # @return [String] the decoded value as a String.
-  def self.into_string(result)
+  def self.into_string(result, length)
     q, r = result.bit_length.divmod(0x08)
     q += 1 if r > 0
     bytes = Array.new(q)
@@ -144,7 +147,11 @@ module Crockford32
       bytes[i] = result & 0xff
       result >>= 0x08
     end
-    bytes.pack("C*")
+
+    bstr = bytes.pack("C*")
+    return bstr if length.nil?
+
+    bstr.ljust(length, "\x00")
   end
 
   # Convert a raw value into an Integer for encoding.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: crockford32
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Stephan Tarulli
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-02-23 00:00:00.000000000 Z
+date: 2022-03-09 00:00:00.000000000 Z
 dependencies: []
 description: A fast little-endian implementation of Crockford's Base32 specification.
 email: