z85 0.5 → 0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc3a06cd55838caabe94e5669cb0a28d4279f12b9b26e4e78aaf692789b2a24a
-  data.tar.gz: 6b3662ea29821bbb38b0f813b20790f22ad08da30b5bc3a51fe80038b289bf7e
+  metadata.gz: ebd3df9b05fe5482e386d7940d6ba1c08c6d24d46aa01a65894ca7911f4d94f9
+  data.tar.gz: 40edd0c27fbc90cec3f897bfff9b6ee07ce83435046c87b41074f363d5534e52
 SHA512:
-  metadata.gz: 6a0674ef043853bdf233ccef0dd6536d92469a7f6bad6fdc8929c5dfcd6991dd03dc8f3d377f64f7c98035059ed0abebf85b0c1980e014548f6beba34c10a68f
-  data.tar.gz: c1a1cdacb3348191524c0ce6ee376282abca80c26067639a50329765cf25226758067d575362c740063f7ee8f721ebebd1e4994cbd86af2bd797212d6e6c0849
+  metadata.gz: b6ba69e691cbf272a2ae65beca2a074fa21d38e242a7e0b9e4234f11be6b5778432800a26d73ba72f39e6e81204b661b2b6b972e35445cdf2c052f02721467a9
+  data.tar.gz: a9b9b8813295aeb016f2cc051337d3fa80f369d4366a6bcbd61a4fa59a2f14c695f6a455c79764088fba046805fd2c4a237c11e2634846447e4143238d66d1eb

data/ext/z85/z85.c

@@ -60,21 +60,18 @@ static byte decoder[96] = {
     0x21, 0x22, 0x23, 0x4F, 0x00, 0x50, 0x00, 0x00
 };
 
-static VALUE encode(VALUE _mod, VALUE string)
+static VALUE Z85_encode(VALUE _mod, VALUE string)
 {
     byte* data = (byte*) StringValuePtr(string);
-    long data_len = RSTRING_LEN(string);
+    long size = RSTRING_LEN(string);
 
-    if (data_len % 4)
-        rb_raise(rb_eRuntimeError, "Invalid string, number of bytes must be a multiple of 4");
-
-    size_t encoded_len = data_len * 5 / 4;
+    size_t encoded_len = size * 5 / 4;
     char *encoded = malloc(encoded_len + 1);
     uint char_nbr = 0;
     uint byte_nbr = 0;
     uint32_t value = 0;
 
-    while (byte_nbr < data_len) {
+    while (byte_nbr < size) {
         value = value * 256 + data[byte_nbr++];
         if (byte_nbr % 4 == 0) {
             uint divisor = 85 * 85 * 85 * 85;
@@ -89,36 +86,24 @@ static VALUE encode(VALUE _mod, VALUE string)
 
     VALUE out = rb_str_export_locale(rb_str_new_cstr(encoded));
     free(encoded);
-
     return out;
 }
 
-static VALUE _decode(VALUE string, int padding)
+static VALUE Z85_decode(VALUE _mod, VALUE rstring)
 {
-    char* data = StringValuePtr(string);
-    long data_len = RSTRING_LEN(string) - padding;
-
-    if (data_len % 5)
-        rb_raise(rb_eRuntimeError, "Invalid string, number of bytes must be a multiple of 5");
-
-    size_t decoded_size = data_len * 4 / 5;
-
-    /* Verify the counter looks legit before even allocating memory. */
-    if (padding) {
-        int counter = data[data_len] - '0';
-        if (counter < 0 || counter > 3)
-            rb_raise(rb_eRuntimeError, "Invalid padding length");
-        else if (decoded_size < (size_t) counter)
-            rb_raise(rb_eRuntimeError, "Invalid padded string");
-    }
+    char* string = StringValuePtr(rstring);
+    long strlen = RSTRING_LEN(rstring);
+    if (strlen % 5)
+      strlen--; /* It is padded, ignore the counter */
 
+    size_t decoded_size = strlen * 4 / 5;
     byte* decoded = malloc(decoded_size);
 
     uint byte_nbr = 0;
     uint char_nbr = 0;
     uint32_t value = 0;
-    while (char_nbr < data_len) {
-        value = value * 85 + decoder[(byte) data[char_nbr++] - 32];
+    while (char_nbr < strlen) {
+        value = value * 85 + decoder[(byte) string[char_nbr++] - 32];
         if (char_nbr % 5 == 0) {
             uint divisor = 256 * 256 * 256;
             while (divisor) {
@@ -129,32 +114,16 @@ static VALUE _decode(VALUE string, int padding)
         }
     }
 
-    VALUE out = padding ?
-      rb_str_new((const char*) decoded, decoded_size - (data[data_len] - '0')) :
-      rb_str_new((const char*) decoded, decoded_size);
-
+    VALUE out = rb_str_new((const char*) decoded, decoded_size);
     free(decoded);
-
     return out;
 }
 
-static VALUE decode(VALUE _mod, VALUE string)
-{
-    return _decode(string, 0);
-}
-
-static VALUE decode_with_padding(VALUE _mod, VALUE string)
-{
-    return _decode(string, 1);
-}
-
 /* This function has a special name and it is invoked by Ruby to initialize the extension. */
 void Init_z85()
 {
     VALUE z85 = rb_define_module("Z85");
 
-    rb_define_singleton_method(z85, "encode", encode, 1);
-    rb_define_singleton_method(z85, "decode", decode, 1);
-
-    rb_define_singleton_method(z85, "decode_with_padding", decode_with_padding, 1);
+    rb_define_singleton_method(z85, "_encode", Z85_encode, 1);
+    rb_define_singleton_method(z85, "_decode", Z85_decode, 1);
 }

data/lib/z85/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Z85
-  VERSION = "0.5"
+  VERSION = "0.6"
 end

data/lib/z85.rb

@@ -4,10 +4,46 @@ require "z85/z85"
 require "z85/version"
 
 module Z85
-  def self.encode_with_padding(string)
-    counter = 4 - (string.bytesize % 4)
-    counter = 0 if counter == 4
-    string += "\0" * counter if counter != 0
-    encode(string) + counter.to_s
+  PADDINGS = ["", "\0", "\0\0", "\0\0\0"].freeze
+  private_constant :PADDINGS
+
+  class Error < StandardError; end
+
+  class << self
+    private def err(message)
+      raise Error, message
+    end
+
+    def encode(string)
+      if string.bytesize % 4 != 0
+        err "Input length should be 0 mod 4. Please, check Z85.encode_with_padding."
+      end
+      _encode(string)
+    end
+
+    def encode_with_padding(string)
+      counter = 4 - (string.bytesize % 4)
+      counter == 4 ? _encode(string) + "0" : _encode(string + PADDINGS[counter]) + counter.to_s
+    end
+
+    def decode(string)
+      if string.bytesize % 5 != 0
+        err "Input length should be 0 mod 5. Please, check Z85.decode_with_padding."
+      end
+      _decode(string)
+    end
+
+    def decode_with_padding(string)
+      err "Input length should be 1 mod 5" if string.bytesize % 5 != 1
+
+      counter = string[-1]
+      err "Invalid counter: #{counter}" if counter < "0" || counter > "3"
+
+      decoded = _decode(string)
+      size = decoded.bytesize - counter.to_i
+      err "String too short for counter #{counter}" if size < 0
+
+      decoded.slice!(0, size)
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: z85
 version: !ruby/object:Gem::Version
-  version: '0.5'
+  version: '0.6'
 platform: ruby
 authors:
 - Xavier Noria