crockford32 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 29ffac6e2fae482581e82faa6fef2e3a537790fc7b5f8dbdae87fe8ffafb45a5
-  data.tar.gz: 52554e3c47cba913aab0894ea4dcb99eeb332cd32afbc021f598ee72624110c5
+  metadata.gz: a8731f2fc74f2b2e8b156421639d7be5bccc79d8560295868ac278ca81b2f7a7
+  data.tar.gz: 2e9c6d6ccbb40ebb8023b3f711501a62b1ccb1bd972b3e9f967d1b50f4cbf2cb
 SHA512:
-  metadata.gz: 352994d3ecc7cd967b0f60169ebb6572b741c08f09d402ee686491aa340c7b360fa5154ccbdc4cc9072d02c8794478d8bc783be740a2063dac6d4ab7aedc725b
-  data.tar.gz: b896cbd7d9c0a0da623b07392dc35def1f5e17a6168272d02284f88b361a6d834612bd491669fb51106090a24f93e7abc3ad20dbd7c6e4570c59ef0e588ac110
+  metadata.gz: d73156968ffbfd3b02886fbd57d1adf6ffad73a7226b3f80c05e4e7c4cc89c3a533f7eb84d5dff7dd51020162d9ccd365ed206db43cc0fe3aa8f75bd8ff4a97d
+  data.tar.gz: 9c0a53a37aa656c4d69c0c1b7dd0a091660445450aff51339b1640e10031cd9cb50a1e99374be2b177bbe199fd18ff3cda47338a22023fc9362d4adc11902b20

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## 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
 

data/LICENSE

@@ -1,3 +1,5 @@
+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:

data/README.md

@@ -1,6 +1,7 @@
 # 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)
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -17,6 +18,17 @@ 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
+
 
 ## Usage
 Encode data with the `encode` method:
@@ -102,6 +114,8 @@ For an interactive console with the gem loaded run `bin/console`.
 ## 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
 Do the following to release a new version of this gem:

data/lib/crockford32/version.rb

@@ -2,5 +2,5 @@
 
 module Crockford32
   # The library version.
-  VERSION = "1.0.1"
+  VERSION = "1.0.2"
 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.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Stephan Tarulli
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-02-20 00:00:00.000000000 Z
+date: 2022-02-23 00:00:00.000000000 Z
 dependencies: []
 description: A fast little-endian implementation of Crockford's Base32 specification.
 email:
@@ -23,6 +23,7 @@ files:
 - lib/crockford32.rb
 - lib/crockford32/errors.rb
 - lib/crockford32/version.rb
+- sig/crockford32.rbs
 homepage: https://github.com/tinychameleon/crockford32
 licenses:
 - MIT