crockford32 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f6e7d5926825497887afa8a356c29d3d858c8fd77c8885b926899b69e110b5d2
-  data.tar.gz: 1d012996acd856eed31ec4aa096c6f1c2ee193b2df081138670201546811363d
+  metadata.gz: b2f3c133e3c624b9664a506fc2d8a9b4637d7316ce4e22d288f1c7a989ae2dc9
+  data.tar.gz: 99218eed8df26f78d663e6126e6a0f2579e7d7abbed00934bb17af668881561c
 SHA512:
-  metadata.gz: 4027fea38aa6aeb2f627e203d09345afd53a0e7120a25aec1d52ac5b1a1d0e626a8c37a02677a8eb47d5bed0b45db3264f2c4e33a6d7175bddd9b0e09e0efafa
-  data.tar.gz: 7af4989d8267bef92f06347af2bdd8cfaa668bf15c4e142111549939bcd4b8b4fa97c845d7cc29e23d48a8c386734600858689d02877e84c9bef3e3712277ac6
+  metadata.gz: cfae960c489f647dd841ee981c2a414c2b92283be33519d125b65382f3e8f7bc818cad6a2dde442fbb2c7f6caf913b50d7d78567ea1aaba46d956b0f9f707320
+  data.tar.gz: 211e81e821b28cab1f6a84a698687a0c11d82a53de529e44708cd51d8f574b1c01c848246a5bf798364cd2ba4c62e54eb1ad9b5f3fd225be80fd3987c87842c8

data/CHANGELOG.md

@@ -1,4 +1,13 @@
 # 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
+
+## v1.0.1 - 2022-02-19
+- Fixed `TypeError` in `private_class_method` call in Ruby < 3.0.0
+
 ## v1.0.0 - 2022-02-19
 - Initial release

data/LICENSE

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright 2022 Stephan Tarulli
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,6 +1,21 @@
 # Crockford32
 A fast little-endian implementation of [Douglas Crockford's Base32 specification](https://www.crockford.com/base32.html).
 
+[![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:
@@ -17,6 +32,18 @@ Or install it yourself as:
 
     $ gem install crockford32
 
+### Ruby Versions
+This gem is tested against the following Ruby versions:
+
+- 2.6.0
+- 2.6.9
+- 2.7.0
+- 2.7.5
+- 3.0.0
+- 3.0.3
+- 3.1.0
+- 3.1.1
+
 
 ## Usage
 Encode data with the `encode` method:
@@ -93,17 +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.0"
+  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.
@@ -226,8 +233,8 @@ module Crockford32
     result.freeze
   end
 
-  private_class_method [:le_decode_number, :convert, :into_string, :raw_value_to_number,
-    :string_to_integer, :string_to_integer_unrolled, :le_encode_number]
+  private_class_method :le_decode_number, :convert, :into_string, :raw_value_to_number,
+    :string_to_integer, :string_to_integer_unrolled, :le_encode_number
 
   # @!endgroup
 end

data/sig/crockford32.rbs

@@ -0,0 +1,9 @@
+module Crockford32
+  VERSION: String
+
+  type encodable = Integer | String
+  type decode_into = :integer | :string
+
+  def self.decode: (String, ?into: decode_into, ?check: bool) -> encodable
+  def self.encode: (encodable, ?length: Integer, ?check: bool) -> String
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: crockford32
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Stephan Tarulli
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-02-20 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:
@@ -17,20 +17,16 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".standard.yml"
 - CHANGELOG.md
-- Gemfile
-- Gemfile.lock
+- LICENSE
 - README.md
-- Rakefile
-- bin/console
-- bin/setup
-- crockford32.gemspec
 - lib/crockford32.rb
 - lib/crockford32/errors.rb
 - lib/crockford32/version.rb
+- sig/crockford32.rbs
 homepage: https://github.com/tinychameleon/crockford32
-licenses: []
+licenses:
+- MIT
 metadata:
   homepage_uri: https://github.com/tinychameleon/crockford32
   source_code_uri: https://github.com/tinychameleon/crockford32

data/.standard.yml

@@ -1,2 +0,0 @@
-# For available configuration options, see:
-#   https://github.com/testdouble/standard

data/Gemfile

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-
-gemspec
-
-gem "rake", "~> 13.0"
-gem "minitest", "~> 5.0"
-gem "benchmark-ips", "~> 2.10"
-gem "debug", "~> 1.4"
-gem "standard", "~> 1.3"
-gem "yard", "~> 0.9.27"

data/Gemfile.lock

@@ -1,63 +0,0 @@
-PATH
-  remote: .
-  specs:
-    crockford32 (1.0.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    ast (2.4.2)
-    benchmark-ips (2.10.0)
-    debug (1.4.0)
-      irb (>= 1.3.6)
-      reline (>= 0.2.7)
-    io-console (0.5.11)
-    irb (1.4.1)
-      reline (>= 0.3.0)
-    minitest (5.15.0)
-    parallel (1.21.0)
-    parser (3.1.0.0)
-      ast (~> 2.4.1)
-    rainbow (3.1.1)
-    rake (13.0.6)
-    regexp_parser (2.2.1)
-    reline (0.3.1)
-      io-console (~> 0.5)
-    rexml (3.2.5)
-    rubocop (1.25.1)
-      parallel (~> 1.10)
-      parser (>= 3.1.0.0)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.15.1, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.15.2)
-      parser (>= 3.0.1.1)
-    rubocop-performance (1.13.2)
-      rubocop (>= 1.7.0, < 2.0)
-      rubocop-ast (>= 0.4.0)
-    ruby-progressbar (1.11.0)
-    standard (1.7.2)
-      rubocop (= 1.25.1)
-      rubocop-performance (= 1.13.2)
-    unicode-display_width (2.1.0)
-    webrick (1.7.0)
-    yard (0.9.27)
-      webrick (~> 1.7.0)
-
-PLATFORMS
-  x86_64-darwin-19
-
-DEPENDENCIES
-  benchmark-ips (~> 2.10)
-  crockford32!
-  debug (~> 1.4)
-  minitest (~> 5.0)
-  rake (~> 13.0)
-  standard (~> 1.3)
-  yard (~> 0.9.27)
-
-BUNDLED WITH
-   2.3.3

data/Rakefile

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-require "rake/testtask"
-require "standard/rake"
-require "yard"
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList["test/**/test_*.rb"]
-end
-
-YARD::Rake::YardocTask.new do |t|
-  t.files = ["lib/**/*.rb", "-", "CHANGELOG.md"]
-  t.options = ["--private", "-o", "./docs"]
-end
-
-task default: %i[test standard]
-
-desc "Benchmark the current implementation"
-task benchmark: [] do |t|
-  sh "date; ruby test/benchmarks/current.rb"
-end

data/bin/console

@@ -1,8 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require "bundler/setup"
-require "crockford32"
-
-require "irb"
-IRB.start(__FILE__)

data/bin/setup

@@ -1,5 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-
-bundle install
-bundle exec rake test standard

data/crockford32.gemspec

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "lib/crockford32/version"
-
-Gem::Specification.new do |spec|
-  spec.name = "crockford32"
-  spec.version = Crockford32::VERSION
-  spec.authors = ["Stephan Tarulli"]
-  spec.email = ["srt@tinychameleon.com"]
-
-  spec.summary = "A fast little-endian implementation of Crockford's Base32 specification."
-  spec.description = "A fast little-endian implementation of Crockford's Base32 specification."
-  spec.homepage = "https://github.com/tinychameleon/crockford32"
-  spec.required_ruby_version = ">= 2.6.0"
-
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = spec.homepage
-  spec.metadata["changelog_uri"] = File.join(spec.homepage, "blob/main/CHANGELOG.md")
-  spec.metadata["bug_tracker_uri"] = File.join(spec.homepage, "issues")
-  spec.metadata["documentation_uri"] = "https://tinychameleon.github.io/crockford32/"
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
-    end
-  end
-  spec.bindir = "exe"
-  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  # Uncomment to register a new dependency of your gem
-  # spec.add_dependency "example-gem", "~> 1.0"
-
-  # For more information and examples about making a new gem, check out our
-  # guide at: https://bundler.io/guides/creating_gem.html
-end