Merge branch 'master' into v1

Author: dipu-bd

.github/workflows/release-test.yml

@@ -46,7 +46,7 @@ jobs:
             platform: 'node'
           - os: macos-latest
             sdk: 'beta'
-          - os: macos-latest 
+          - os: macos-latest
             sdk: '2.14'
     runs-on: ${{ matrix.os }}
     steps:

CHANGELOG.md

@@ -1,3 +1,7 @@
+# 1.23.0
+
+- Fixes typo: Alder is renamed to Adler
+
 # 1.22.0
 
 - Enhances the CRCs with custom polynomial support.
@@ -314,7 +318,7 @@
 - Adds `PBKDF2` key derivator.
 - Adds extension to `HMAC` to create `PBKDF2` instance.
 - Define `MACHashBase` and `MACSinkBase` for Message Authentication Code generators.
-- Reset features for `crc16`, `crc32`, `crc64`, `alder32`, and `hmac` internal sinks.
+- Reset features for `crc16`, `crc32`, `crc64`, `adler32`, and `hmac` internal sinks.
 - Enhance `blake2b` and `blake2s` for MAC generation
 - **Breaking change**:
   - Accept number of bytes instead of bits for `Blake2b` and `Blake2s`
@@ -384,7 +388,7 @@
   - `crc16`
   - `crc32`
   - `crc64`
-  - `alder32`
+  - `adler32`
 
 # 1.1.0
 

README.md

@@ -10,7 +10,7 @@
 
 This library contains implementations of secure hash functions, checksum generators, and key derivation algorithms optimized for Dart.
 
-## Depencencies
+## Dependencies
 
 There is only 1 dependency used by this package:
 
@@ -68,7 +68,7 @@ There is only 1 dependency used by this package:
 | Algorithms | Available methods         | Source    |
 | ---------- | ------------------------- | --------- |
 | CRC        | `crc16`, `crc32`, `crc64` | Wikipedia |
-| Alder32    | `alder32`                 | Wikipedia |
+| Adler32    | `adler32`                 | Wikipedia |
 
 ### Random Algorithm
 
@@ -118,7 +118,7 @@ Check the [API Reference](https://pub.dev/documentation/hashlib/latest/) for det
 
 Examples can be found inside the `example` folder.
 
-### Hashilb Example
+### Hashlib Example
 
 ```dart
 import 'package:hashlib/codecs.dart';
@@ -140,7 +140,7 @@ void main() {
   // Example of hash-code generations
   print('XXH32 => ${xxh32code(text)}');
   print('CRC32 => ${crc32code(text)}');
-  print('Alder32 => ${alder32code(text)}');
+  print('Adler32 => ${adler32code(text)}');
   print('CRC16 => ${crc16code(text)}');
   print('');
 
@@ -171,7 +171,7 @@ void main() {
   print('SHAKE-256 => ${shake256.of(20).string(text)}');
   print('BLAKE2s-256 => ${blake2s256.string(text)}');
   print('BLAKE2b-512 => ${blake2b512.string(text)}');
-  print('SM3] => ${sm3.string(text)}');
+  print('SM3 => ${sm3.string(text)}');
   print('');
 
   // Examples of MAC generations

example/hashlib_example.dart

@@ -17,7 +17,7 @@ void main() {
   // Example of hash-code generations
   print('XXH32 => ${xxh32code(text)}');
   print('CRC32 => ${crc32code(text)}');
-  print('Alder32 => ${alder32code(text)}');
+  print('Adler32 => ${adler32code(text)}');
   print('CRC16 => ${crc16code(text)}');
   print('');
 
@@ -48,7 +48,7 @@ void main() {
   print('SHAKE-256 => ${shake256.of(20).string(text)}');
   print('BLAKE2s-256 => ${blake2s256.string(text)}');
   print('BLAKE2b-512 => ${blake2b512.string(text)}');
-  print('SM3] => ${sm3.string(text)}');
+  print('SM3 => ${sm3.string(text)}');
   print('');
 
   // Examples of MAC generations

lib/hashlib.dart

@@ -1,7 +1,11 @@
 // Copyright (c) 2023, Sudipto Chandra
 // All rights reserved. Check LICENSE file for details.
 
-/// Secure hash algorithms in pure dart.
+/// Collection of hashing algorithms, checksum generators, message
+/// authentication code (MAC) utilities and key derivation functions.
+///
+/// This library serves as a convenience export so that all supported
+/// algorithms can be used with a single import.
 library hashlib;
 
 export 'src/hashlib.dart';

lib/src/alder32.dart lib/src/adler32.dartlib/src/alder32.dart renamed to lib/src/adler32.dart

@@ -3,7 +3,7 @@
 
 import 'dart:convert';
 
-import 'package:hashlib/src/algorithms/alder32.dart';
+import 'package:hashlib/src/algorithms/adler32.dart';
 import 'package:hashlib/src/core/hash_base.dart';
 
 /// [Adler-32][wiki] is composed of two sums accumulated per byte.
@@ -19,23 +19,23 @@ import 'package:hashlib/src/core/hash_base.dart';
 /// [wiki]: https://en.wikipedia.org/wiki/Adler-32
 ///
 /// **WARNING: It should not be used for cryptographic purposes.**
-const HashBase alder32 = _Alder32();
+const HashBase adler32 = _Adler32();
 
-class _Alder32 extends HashBase {
-  const _Alder32();
+class _Adler32 extends HashBase {
+  const _Adler32();
 
   @override
   final String name = 'ALDER-32';
 
   @override
-  Alder32Hash createSink() => Alder32Hash();
+  Adler32Hash createSink() => Adler32Hash();
 }
 
-/// Gets the Alder-32 value of a String
+/// Gets the Adler-32 value of a String
 ///
 /// Parameters:
 /// - [input] is the string to hash
 /// - The [encoding] is the encoding to use. Default is `input.codeUnits`
-int alder32code(String input, [Encoding? encoding]) {
-  return alder32.string(input, encoding).number();
+int adler32code(String input, [Encoding? encoding]) {
+  return adler32.string(input, encoding).number();
 }

lib/src/algorithms/alder32.dart lib/src/algorithms/adler32.dartlib/src/algorithms/alder32.dart renamed to lib/src/algorithms/adler32.dart

@@ -5,16 +5,16 @@ import 'dart:typed_data';
 
 import 'package:hashlib/src/core/hash_base.dart';
 
-const int _alder32Mod = 65521;
+const int _adler32Mod = 65521;
 
 /// This implementation is derived from the [ ZLIB Compressed Data Format
 /// Specification version 3.3 ][rfc]
 ///
 /// [rfc]: https://www.ietf.org/rfc/rfc1950.html
-class Alder32Hash extends HashDigestSink {
+class Adler32Hash extends HashDigestSink {
   int a = 1, b = 0;
 
-  Alder32Hash();
+  Adler32Hash();
 
   @override
   final int hashLength = 4;
@@ -29,8 +29,8 @@ class Alder32Hash extends HashDigestSink {
   @override
   void $process(List<int> chunk, int start, int end) {
     for (; start < end; start++) {
-      a = (a + chunk[start]) % _alder32Mod;
-      b = (b + a) % _alder32Mod;
+      a = (a + chunk[start]) % _adler32Mod;
+      b = (b + a) % _adler32Mod;
     }
   }
 

lib/src/core/registry.dart

@@ -17,7 +17,7 @@ void _buildRegistry() {
   if (_hash.isNotEmpty) return;
 
   _hash.addAll({
-    _norm(alder32.name): alder32,
+    _norm(adler32.name): adler32,
     _norm(crc16.name): crc16,
     _norm(crc32.name): crc32,
     _norm(crc64.name): crc64,

lib/src/hashlib.dart

@@ -1,7 +1,7 @@
 // Copyright (c) 2023, Sudipto Chandra
 // All rights reserved. Check LICENSE file for details.
 
-export 'alder32.dart';
+export 'adler32.dart';
 export 'argon2.dart';
 export 'bcrypt.dart';
 export 'blake2b.dart';

pubspec.yaml

@@ -1,7 +1,7 @@
 name: hashlib
 description: Secure hash functions, checksum generators, and key derivation algorithms optimized for Dart.
 homepage: https://github.com/bitanon/hashlib
-version: 1.22.0
+version: 1.23.0
 
 environment:
   sdk: '>=2.14.0 <4.0.0'