init

Phil · Phil · commit c031e631cef3 · 2024-02-14T18:45:44.000+02:00
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,7 @@
+# https://dart.dev/guides/libraries/private-files
+# Created by `dart pub`
+.dart_tool/
+
+# Avoid committing pubspec.lock for library packages; see
+# https://dart.dev/guides/libraries/private-files#pubspeclock.
+pubspec.lock
diff --git a/.idea/libraries/Dart_SDK.xml b/.idea/libraries/Dart_SDK.xml
diff --git a/.idea/modules.xml b/.idea/modules.xml
diff --git a/.idea/workspace.xml b/.idea/workspace.xml
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,3 @@
+## 1.0.0
+
+- Initial version.
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,11 @@
+Copyright <2024> <Callmephil>
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
diff --git a/README.md b/README.md
@@ -0,0 +1,63 @@
+## Encoder
+
+This Dart package provides utility functions for encoding and decoding strings and JSON objects into safe URL formats. It's useful for scenarios where you need to encode data to be included in a URL, or decode data received from a URL.
+
+## Features
+
+Encode and decode strings to and from a URL-safe Base64 format.
+Encode and decode JSON objects to and from a URL-safe Base64 format.
+Getting Started
+To use this package, add encoder as a dependency in your pubspec.yaml file.
+
+## Usage
+
+Here's a simple example of using the Encoder class to encode and decode a string:
+
+```dart
+import 'package:encoder/encoder.dart';
+
+void main() {
+  const originalText = 'Hello World!';
+  final encodedText = Encoder.encodeString(originalText);
+  print('Encoded Text: $encodedText');
+
+  final decodedText = Encoder.decodeString(encodedText);
+  print('Decoded Text: $decodedText');
+}
+```
+
+And here's an example of encoding and decoding a JSON object:
+
+```dart
+import 'package:encoder/encoder.dart';
+
+void main() {
+  const originalJson = {
+    'name': 'John Doe',
+    'age': 30,
+    'email': 'john.doe@gmail.com',
+    'active': true,
+    'roles': ['user', 'admin'],
+    'address': {
+      'street': '123 Main St',
+      'city': 'Springfield',
+      'state': 'IL',
+      'zip': '62701',
+    },
+    'children': [
+      {'name': 'Jane Doe', 'age': 5},
+      {'name': 'Alex Doe', 'age': 8},
+    ],
+  };
+
+  final encodedJson = Encoder.encodeJson(originalJson);
+  print('Encoded JSON: $encodedJson');
+
+  final decodedJson = Encoder.decodeJson(encodedJson);
+  print('Decoded JSON: $decodedJson');
+}
+```
+
+## Additional Information
+
+For more information, please refer to the Encoder class in the source code. If you have any issues or suggestions, feel free to open an issue on the project's GitHub page. Contributions are also welcome.
diff --git a/analysis_options.yaml b/analysis_options.yaml
@@ -0,0 +1,30 @@
+# This file configures the static analysis results for your project (errors,
+# warnings, and lints).
+#
+# This enables the 'recommended' set of lints from `package:lints`.
+# This set helps identify many issues that may lead to problems when running
+# or consuming Dart code, and enforces writing Dart using a single, idiomatic
+# style and format.
+#
+# If you want a smaller set of lints you can change this to specify
+# 'package:lints/core.yaml'. These are just the most critical lints
+# (the recommended set includes the core lints).
+# The core lints are also what is used by pub.dev for scoring packages.
+
+include: package:lints/recommended.yaml
+
+# Uncomment the following section to specify additional rules.
+
+# linter:
+#   rules:
+#     - camel_case_types
+
+# analyzer:
+#   exclude:
+#     - path/to/excluded/files/**
+
+# For more information about the core and recommended set of lints, see
+# https://dart.dev/go/core-lints
+
+# For additional information about configuring this file, see
+# https://dart.dev/guides/language/analysis-options
diff --git a/example/encoder_example.dart b/example/encoder_example.dart
@@ -0,0 +1,13 @@
+import 'package:encoder/encoder.dart';
+
+void main() {
+  // Encode String
+  print(Encoder.encodeString('Hello, World!'));
+  // Decode String
+  print(Encoder.decodeString('SGVsbG8sIFdvcmxkIQ%3D%3D'));
+
+  // Encode JSON
+  print(Encoder.encodeJson({'message': 'Hello, World!'}));
+  // Decode JSON
+  print(Encoder.decodeJson('eyJtZXNzYWdlIjoiSGVsbG8sIFdvcmxkISJ9'));
+}
diff --git a/lib/encoder.dart b/lib/encoder.dart
@@ -0,0 +1,3 @@
+library;
+
+export 'src/encoder_base.dart';
diff --git a/lib/src/encoder_base.dart b/lib/src/encoder_base.dart
@@ -0,0 +1,45 @@
+import 'dart:convert';
+
+/// A utility class for encoding and decoding strings into safe url formats
+/// {@tool snippet}
+///
+/// Example usage of the [Encoder] class
+///
+/// ```dart
+/// const originalText = 'Hello World!';
+/// final encodedText = Encoder.encodeBase64UrlSafe(originalText);
+/// print('Encoded Text: $encodedText');
+///
+/// final decodedText = Encoder.decodeBase64UrlSafe(encodedText);
+/// print('Decoded Text: $decodedText');
+/// ```
+/// {@end-tool}
+class Encoder {
+  const Encoder._();
+
+  /// Encodes the input string to base64 and then URL encodes the base64 string
+  static String encodeString(String input) {
+    return Uri.encodeComponent(base64.encode(utf8.encode(input)));
+  }
+
+  /// Decodes the URL encoded base64 string to its original form
+  static String decodeString(String input) {
+    return utf8.decode(base64.decode(Uri.decodeComponent(input)));
+  }
+
+  /// Encodes the input Map to a JSON string, converts the JSON string to bytes,
+  /// encodes the bytes to a Base64 string, and then URL encodes the Base64 string
+  static String encodeJson(Map<String, dynamic> input) {
+    final bytes = utf8.encode(jsonEncode(input));
+    final base64Encoded = base64.encode(bytes);
+
+    return Uri.encodeComponent(base64Encoded);
+  }
+
+  /// Decodes the URL encoded Base64 string to its original form as a Map<String, dynamic>
+  static Map<String, dynamic> decodeJson(String input) {
+    final base64Decoded = base64.decode(Uri.decodeComponent(input));
+
+    return jsonDecode(utf8.decode(base64Decoded)) as Map<String, dynamic>;
+  }
+}
diff --git a/pubspec.yaml b/pubspec.yaml
@@ -0,0 +1,11 @@
+name: encoder
+description: A library for encoding string and json data into viable URI param.
+version: 1.0.0
+repository: https://github.com/callmephil/encoder
+
+environment:
+  sdk: ^3.2.6
+
+dev_dependencies:
+  lints: ^3.0.0
+  test: ^1.24.0
diff --git a/test/encoder_test.dart b/test/encoder_test.dart
@@ -0,0 +1,57 @@
+import 'package:encoder/encoder.dart';
+import 'package:test/test.dart';
+
+void main() {
+  group('Encoder', () {
+    test('encodeString', () {
+      const input = 'Hello, World!';
+      final encoded = Encoder.encodeString(input);
+
+      // Check that the encoded string is not the same as the input
+      expect(encoded, isNot(equals(input)));
+
+      // Check that the encoded string can be decoded back to the original input
+      final decoded = Encoder.decodeString(encoded);
+      expect(decoded, equals(input));
+    });
+
+    test('decodeString', () {
+      const input =
+          'SGVsbG8sIFdvcmxkIQ%3D%3D'; // Base64 URL Safe encoded 'Hello, World!'
+      final decoded = Encoder.decodeString(input);
+
+      // Check that the decoded string is 'Hello, World!'
+      expect(decoded, equals('Hello, World!'));
+
+      // Check that the decoded string can be encoded back to the original input
+      final encoded = Encoder.encodeString(decoded);
+      expect(encoded, equals(input));
+    });
+  });
+  group('encodeJson', () {
+    test('encodeJson', () {
+      const input = {'message': 'Hello, World!'};
+      final encoded = Encoder.encodeJson(input);
+
+      // Check that the encoded string is not the same as the input
+      expect(encoded, isNot(equals(input)));
+
+      // Check that the encoded string can be decoded back to the original input
+      final decoded = Encoder.decodeJson(encoded);
+      expect(decoded, equals(input));
+    });
+
+    test('decodeJson', () {
+      // Base64 URL Safe encoded '{"message":"Hello, World!"}'
+      const input = 'eyJtZXNzYWdlIjoiSGVsbG8sIFdvcmxkISJ9';
+      final decoded = Encoder.decodeJson(input);
+
+      // Check that the decoded string is '{"message":"Hello, World!"}'
+      expect(decoded, equals({'message': 'Hello, World!'}));
+
+      // Check that the decoded string can be encoded back to the original input
+      final encoded = Encoder.encodeJson(decoded);
+      expect(encoded, equals(input));
+    });
+  });
+}

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+## 1.0.0`
	`2`	`+`
	`3`	`+- Initial version.`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+library;`
	`2`	`+`
	`3`	`+export 'src/encoder_base.dart';`