Change the behavior the Octal

- adds coverage
- change argument types
- use custom implementation for Base-8, Base-16

Author: dipu-bd

.github/workflows/test.yml

@@ -1,31 +1,61 @@
-name: test
+name: Test
 
 on:
   workflow_dispatch:
   push:
     branches: [master]
-    paths: ["**.dart", "**.yaml"]
+    paths: ['**.dart', '**.yaml', '**.yml']
   pull_request:
     branches: [master]
-    paths: ["**.dart", "**.yaml"]
-  schedule:
-    - cron: "0 0 * * 5" # m h d M w
+    paths: ['**.dart', '**.yaml', '**.yml']
 
 jobs:
-  build:
+  coverage:
     if: github.repository == 'bitanon/hashlib_codecs'
-    runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        os: [ubuntu-latest] # macos-latest, windows-latest
-        sdk: ["2.14.0", "2.19.6", "stable", "dev"]
+        os: [ubuntu-latest]
+        sdk: ['stable']
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: dart-lang/setup-dart@v1
+        with:
+          sdk: ${{ matrix.sdk }}
+
+      - name: 'Install global packages'
+        run: |
+          dart pub global activate coverage
+          dart pub global activate cobertura
+          dart pub global activate junitreport
+
+      - name: Run tests with coverage
+        run: bash ./scripts/coverage.sh
+
+      - name: Upload results to Codecov
+        uses: codecov/codecov-action@v4
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          file: ./coverage/cobertura.xml
 
+      - name: Upload test results to Codecov
+        if: ${{ !cancelled() }}
+        uses: codecov/test-results-action@v1
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          file: ./coverage/junit.xml
+
+  test-on-stable:
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        sdk: ['stable']
+    runs-on: ${{ matrix.os }}
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
-      # You can specify other versions if desired, see documentation here:
-      # https://github.com/dart-lang/setup-dart/blob/main/README.md
-      - uses: dart-lang/[email protected]
+      - uses: dart-lang/setup-dart@v1
         with:
           sdk: ${{ matrix.sdk }}
 
@@ -38,12 +68,46 @@ jobs:
       - name: Analyze project source
         run: dart analyze --fatal-infos
 
-      - if: matrix.sdk != '2.14.0'
-        name: Generate documentation
-        run: dart doc --validate-links
+      - name: Run tests
+        run: dart test
+
+  test-on-legacy:
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest]
+        sdk: ['2.14']
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: dart-lang/setup-dart@v1
+        with:
+          sdk: ${{ matrix.sdk }}
+
+      - name: Run tests
+        run: dart test
+
+  test-on-beta:
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+        sdk: ['beta']
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: dart-lang/setup-dart@v1
+        with:
+          sdk: ${{ matrix.sdk }}
+
+      - name: Install dependencies
+        run: dart pub get
 
-      - name: Run tests on vm
-        run: dart test -p vm
+      - name: Verify formatting
+        run: dart format --output=none --set-exit-if-changed .
+
+      - name: Analyze project source
+        run: dart analyze --fatal-infos
 
-      - name: Run tests on node
-        run: dart test -p node
+      - name: Run tests
+        run: dart test

.gitignore

@@ -3,9 +3,10 @@
 .dart_tool/
 .packages
 
-# Conventional directory for build outputs.
+# Conventional directory for outputs.
 build/
 doc/
+coverage/
 benchmark/**/*.exe
 test/**/*.exe
 

CHANGELOG.md

@@ -1,3 +1,9 @@
+# 2.6.0
+
+- [**Breaking Changes**]
+  - Change the behavior of the Base-8 encoder to follow the standard
+  - Accept only `List<int>` instead of `Iterable<int>` in converters
+
 # 2.5.0
 
 - Support UTF-8 encoding and decoding.

README.md

@@ -1,11 +1,13 @@
 # Hashlib Codecs
 
 [![plugin version](https://img.shields.io/pub/v/hashlib_codecs?label=pub)](https://pub.dev/packages/hashlib_codecs)
-[![dependencies](https://img.shields.io/badge/dependencies-zero-889)](https://github.com/bitanon/hashlib_codecs/blob/master/pubspec.yaml)
-[![dart support](https://img.shields.io/badge/dart-%3e%3d%202.14.0-39f?logo=dart)](https://dart.dev/guides/whats-new#september-8-2021-214-release)
+[![test](https://github.com/bitanon/hashlib_codecs/actions/workflows/test.yml/badge.svg?branch=master)](https://github.com/bitanon/hashlib_codecs/actions/workflows/test.yml)
+[![codecov](https://codecov.io/gh/bitanon/hashlib_codecs/graph/badge.svg?token=ISIYJ8MNI0)](https://codecov.io/gh/bitanon/hashlib_codecs)
 [![likes](https://img.shields.io/pub/likes/hashlib_codecs?logo=dart)](https://pub.dev/packages/hashlib_codecs/score)
 [![pub points](https://img.shields.io/pub/points/hashlib_codecs?logo=dart&color=teal)](https://pub.dev/packages/hashlib_codecs/score)
 [![popularity](https://img.shields.io/pub/popularity/hashlib_codecs?logo=dart)](https://pub.dev/packages/hashlib_codecs/score)
+[![dart support](https://img.shields.io/badge/dart-%3e%3d%202.14.0-39f?logo=dart)](https://dart.dev/guides/whats-new#september-8-2021-214-release)
+[![dependencies](https://img.shields.io/badge/dependencies-zero-889)](https://github.com/bitanon/hashlib_codecs/blob/master/pubspec.yaml)
 
 <!-- [![test](https://github.com/bitanon/hashlib_codecs/actions/workflows/test.yml/badge.svg)](https://github.com/bitanon/hashlib_codecs/actions/workflows/test.yml) -->
 

dart_test.yaml

@@ -5,7 +5,8 @@ concurrency: 8
 platforms: [vm, node]
 
 tags:
-  skip-js:
+  vm-only:
+    skip: true
     on_platform:
-      node:
-        skip: true
+      vm:
+        skip: false

lib/src/base16.dart

@@ -23,7 +23,7 @@ Base16Codec _codecFromParameters({
 /// - [codec] is the [Base16Codec] to use. It is derived from the other
 ///   parameters if not provided.
 String toHex(
-  Iterable<int> input, {
+  List<int> input, {
   Base16Codec? codec,
   bool upper = false,
 }) {
@@ -49,6 +49,5 @@ Uint8List fromHex(
   Base16Codec? codec,
 }) {
   codec ??= _codecFromParameters();
-  var out = codec.decoder.convert(input.codeUnits);
-  return Uint8List.fromList(out as List<int>);
+  return codec.decoder.convert(input.codeUnits);
 }

lib/src/base2.dart

@@ -17,7 +17,7 @@ import 'codecs/base2.dart';
 /// toBigInt(input).toRadixString(2)
 /// ```
 String toBinary(
-  Iterable<int> input, {
+  List<int> input, {
   Base2Codec codec = Base2Codec.standard,
 }) {
   var out = codec.encoder.convert(input);
@@ -44,6 +44,5 @@ Uint8List fromBinary(
   String input, {
   Base2Codec codec = Base2Codec.standard,
 }) {
-  var out = codec.decoder.convert(input.codeUnits);
-  return Uint8List.fromList(out as List<int>);
+  return codec.decoder.convert(input.codeUnits);
 }

lib/src/base32.dart

@@ -38,7 +38,7 @@ const _codecsWithPadding = {
 /// - [codec] is the [Base32Codec] to use. It is derived from the other
 ///   parameters if not provided.
 String toBase32(
-  Iterable<int> input, {
+  List<int> input, {
   Base32Codec? codec,
   bool lower = false,
   bool padding = true,
@@ -47,7 +47,7 @@ String toBase32(
     lower: lower,
     padding: padding,
   );
-  var out = codec.encoder.convert(input);
+  Iterable<int> out = codec.encoder.convert(input);
   if (!padding && _codecsWithPadding.contains(codec)) {
     out = out.takeWhile((x) => x != codec!.encoder.padding);
   }
@@ -76,5 +76,5 @@ Uint8List fromBase32(
 }) {
   codec ??= _codecFromParameters(padding: padding);
   var out = codec.decoder.convert(input.codeUnits);
-  return Uint8List.fromList(out as List<int>);
+  return Uint8List.fromList(out);
 }

lib/src/base64.dart

@@ -34,7 +34,7 @@ const _codecsWithPadding = {
 /// - [codec] is the [Base64Codec] to use. It is derived from the other
 ///   parameters if not provided.
 String toBase64(
-  Iterable<int> input, {
+  List<int> input, {
   Base64Codec? codec,
   bool url = false,
   bool padding = true,
@@ -43,7 +43,7 @@ String toBase64(
     url: url,
     padding: padding,
   );
-  var out = codec.encoder.convert(input);
+  Iterable<int> out = codec.encoder.convert(input);
   if (!padding && _codecsWithPadding.contains(codec)) {
     out = out.takeWhile((x) => x != codec!.encoder.padding);
   }
@@ -73,5 +73,5 @@ Uint8List fromBase64(
 }) {
   codec ??= _codecFromParameters(padding: padding);
   var out = codec.decoder.convert(input.codeUnits);
-  return Uint8List.fromList(out as List<int>);
+  return Uint8List.fromList(out);
 }

lib/src/base8.dart

@@ -17,7 +17,7 @@ import 'codecs/base8.dart';
 /// toBigInt(input).toRadixString(8)
 /// ```
 String toOctal(
-  Iterable<int> input, {
+  List<int> input, {
   Base8Codec codec = Base8Codec.standard,
 }) {
   var out = codec.encoder.convert(input);
@@ -44,6 +44,5 @@ Uint8List fromOctal(
   String input, {
   Base8Codec codec = Base8Codec.standard,
 }) {
-  var out = codec.decoder.convert(input.codeUnits);
-  return Uint8List.fromList(out as List<int>);
+  return codec.decoder.convert(input.codeUnits);
 }

lib/src/codecs/base16.dart

@@ -6,14 +6,32 @@ import 'dart:typed_data';
 import 'package:hashlib_codecs/src/core/byte.dart';
 import 'package:hashlib_codecs/src/core/codec.dart';
 
-// ========================================================
-// Base-16 Encoder and Decoder
-// ========================================================
-
 const int _zero = 0x30;
 const int _bigA = 0x41;
 const int _smallA = 0x61;
 
+extension on List<int> {
+  @pragma('vm:prefer-inline')
+  int dec(int p) {
+    int x = this[p] & 0xFF;
+    if (x >= _smallA) {
+      x -= _smallA - 10;
+    } else if (x >= _bigA) {
+      x -= _bigA - 10;
+    } else {
+      x -= _zero;
+    }
+    if (x < 0 || x > 15) {
+      throw FormatException('Invalid character at $p');
+    }
+    return x;
+  }
+}
+
+// ========================================================
+// Base-16 Encoder and Decoder
+// ========================================================
+
 class _Base16Encoder extends ByteEncoder {
   final int startCode;
 
@@ -23,58 +41,42 @@ class _Base16Encoder extends ByteEncoder {
   static const lower = _Base16Encoder._(_smallA - 10);
 
   @override
-  Iterable<int> convert(Iterable<int> input) {
+  Uint8List convert(List<int> input) {
     int i, p, x, a, b;
-    List<int> list = input is List<int> ? input : List.of(input);
-    var result = Uint8List(list.length << 1);
-    for (i = p = 0; p < list.length; p++, i += 2) {
-      x = list[p];
+    var out = Uint8List(input.length << 1);
+    for (i = p = 0; p < input.length; p++, i += 2) {
+      x = input[p];
       a = (x >>> 4) & 0xF;
       b = x & 0xF;
       a += a < 10 ? _zero : startCode;
       b += b < 10 ? _zero : startCode;
-      result[i] = a;
-      result[i + 1] = b;
+      out[i] = a;
+      out[i + 1] = b;
     }
-    return result;
+    return out;
   }
 }
 
 class _Base16Decoder extends ByteDecoder {
   const _Base16Decoder() : super(bits: 4);
 
   @override
-  Iterable<int> convert(Iterable<int> input) {
-    bool t;
-    int p, x, y;
-    p = 0;
-    t = false;
-    List<int> out = <int>[];
-    for (y in input) {
-      if (y >= _smallA) {
-        x = y - _smallA + 10;
-      } else if (y >= _bigA) {
-        x = y - _bigA + 10;
-      } else if (y >= _zero) {
-        x = y - _zero;
-      } else {
-        x = -1;
-      }
-      if (x < 0 || x > 15) {
-        throw FormatException('Invalid character $y');
-      }
-      if (t) {
-        out.add((p << 4) | x);
-        p = 0;
-        t = false;
-      } else {
-        p = x;
-        t = true;
-      }
+  Uint8List convert(List<int> encoded) {
+    int p, n;
+
+    n = encoded.length;
+    p = (n >>> 1) + (n & 1);
+    var out = Uint8List(p);
+
+    for (p--; n >= 2; n -= 2, p--) {
+      out[p] = encoded.dec(n - 1) ^ //
+          (encoded.dec(n - 2) << 4);
     }
-    if (t) {
-      out.add(p);
+
+    if (n == 1) {
+      out[p] = encoded.dec(0);
     }
+
     return out;
   }
 }