base32h 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: de7e1abc9f5fbb560cd132ff8c7d11c0c8c91e3b751d2031988de46cc3072b7b
-  data.tar.gz: 734e6651e89a697c7d8faeee81351a235a2d3473215e027cd7b7cae1897685d6
+  metadata.gz: fc91506f58aea74f8356374108a71bc367c03e9730bfb0fa29101472c0b506f3
+  data.tar.gz: a00a043947aeb4cd6a8f4abbb332f1110515da60d664ede1fd1bb972d4317f70
 SHA512:
-  metadata.gz: 2022dfbdefa1e442441a68118e1cc82a497f75f703e23f98b0078a6c93f482225ce21fc66388e826f76d6aa47b7401ae69075b43ce59d40837664a0aab1ecd68
-  data.tar.gz: 93b45da982c68477c84ff31ec3926038c24f26d1b1fb7aa94551b50bcf17a79f9e48099e4f1a10f334b20df25ca78dcecf89b725fe28549d8447cf7d8b9edc95
+  metadata.gz: 1c19d762b0ceaac4274fc54e77e7d01a5db96118f1f86f1a3f8e3ea0def3111cdef18e2ed5ffe6aa053250d2fb8463cce829eb01d869ee11999f8f07059fbae9
+  data.tar.gz: fd14eda07b8c3832b239aba0159c4af7f66cffcde005d150785da211fd5b60e4c5ebffb17cae859be522559946aa05c1369541cbd3d0b7f45c999573045c471f

data/lib/base32h.rb

@@ -1,12 +1,12 @@
 ##
 # This module provides Base32H encoding and decoding functions.
 module Base32H
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
   
   extend self
 
   ##
-  # The complete list of Base32H digits, as an array of strings; the
+  # The complete list of Base32H digits, as an array of strings.  The
   # index of the array is the numeric value of the digit(s) in the
   # string at that index.  The first character in each string is the
   # "canonical" digit (i.e. the one that Base32H-conformant encoders
@@ -15,10 +15,10 @@ module Base32H
   # Base32H-conformant decoders *must* accept and correctly decode to
   # that value).
   #
-  # For example, +digits[27]+ returns +'VvUu'+, meaning that the
-  # "canonical" digit of value 27 is +V+, and that +v+, +U+, and +u+
-  # are all "aliases" of that canonical digit and decode to a value of
-  # 27.
+  # @example
+  #   Base32H.digits[27] #=> 'VvUu'
+  #
+  # @return [Array<String>] the full list of digits
   def digits
     ['0Oo',
      '1Ii',
@@ -54,11 +54,16 @@ module Base32H
      'Zz']
   end
 
+  # @!group Encoders
+
   ##
-  # :category: Encoding Digit
-  #
   # Encodes an integer between 0 and 31 (inclusive) to its Base32H
-  # representation.
+  # representation.  Returns +nil+ for input values outside that
+  # range.
+  #
+  # @param d [#to_i] the integer value of the requested digit
+  #
+  # @return [String, NilClass] the resulting digit
   def encode_digit(d)
     d = d.to_i
     return nil unless (0..31).include? d
@@ -66,9 +71,11 @@ module Base32H
   end
 
   ##
-  # :category: Encoding Numeric
-  #
   # Encodes an integer to its Base32H representation.
+  #
+  # @param int [#to_i] the integer to encode
+  #
+  # @return [String] the encoded number
   def encode(int)
     rem = int.to_i.abs
     out = []
@@ -81,9 +88,11 @@ module Base32H
   end
 
   ##
-  # :category: Encoding Binary
-  #
   # Encodes a (binary) string to its Base32H representation.
+  #
+  # @param bin [String] the string/binary to encode
+  #
+  # @return [String] the encoded binary
   def encode_bin(bin)
     data = bin.unpack('C*')
     extra = data.length % 5
@@ -96,19 +105,28 @@ module Base32H
     out.join ''
   end
 
+  # @!endgroup
+
+  # @!group Decoders
+
   ##
-  # :category: Decoding Digit
-  #
   # Decodes a single Base32H digit to its integer representation.
+  # Returns nil if the input is not a Base32H digit.
+  #
+  # @param d [#to_s] the digit to decode
+  #
+  # @return [Integer] the digit's value
   def decode_digit(d)
     d = d.to_s
     digits.find_index {|i| i.include? d}
   end
 
   ##
-  # :category: Decoding Numeric
-  #
   # Decodes a Base32H number to its integer representation.
+  #
+  # @param str [#to_s] the number to decode
+  #
+  # @return [Integer] the decoded integer
   def decode(str)
     res = str.to_s.chars.reverse.reduce({acc: 0, exp: 0}) do |state, char|
       digit = decode_digit(char)
@@ -123,9 +141,11 @@ module Base32H
   end
 
   ##
-  # :category: Decoding Binary
-  #
   # Decodes a Base32H binary into a string of packed unsigned bytes.
+  #
+  # @param str [String] the binary to decode
+  #
+  # @return [String] the decoded binary
   def decode_bin(str)
     data = str.chars.reject {|c| decode_digit(c).nil?}
     extra = data.length % 8
@@ -138,6 +158,8 @@ module Base32H
     out.pack('C*')
   end
 
+  # @!endgroup
+
   private
 
   def u40_to_bytes(int)
@@ -161,12 +183,20 @@ module Base32H
 end
 
 class Integer
+  ##
+  # Encodes the integer to its Base32H numeric representation.
+  #
+  # @return [String] the integer's Base32H representation
   def to_base32h
     Base32H.encode(self)
   end
 end
 
 class String
+  ##
+  # Encodes the string to its Base32H binary representation.
+  #
+  # @return [String] the string's Base32H representation
   def to_base32h
     Base32H.encode_bin(self)
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: base32h
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Ryan S. Northrup ("RyNo")
@@ -39,6 +39,7 @@ licenses:
 metadata:
   homepage_uri: https://base32h.github.io
   source_code_uri: https://github.com/base32h/base32h.rb
+  documentation_uri: https://rubydoc.info/gems/base32h/Base32H
 post_install_message:
 rdoc_options: []
 require_paths: