## 1.7.0

* Change loader format * Remove asset loader * Update logo * Update documentation * Add flag obfuscate * Remove flutter from pubspec
Nialixus · Oct 11, 2023 · ef9236f · ef9236f
1 parent 490a638
commit ef9236f
Show file tree

Hide file tree

Showing 14 changed files with 119 additions and 191 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -27,4 +27,12 @@
 * Automatically add output into .gitignore
 
 ## 1.6.0
-* Update pubspec
+* Update pubspec
+
+## 1.7.0
+* Change loader format
+* Remove asset loader
+* Update logo
+* Update documentation
+* Add flag obfuscate
+* Remove flutter from pubspec
diff --git a/bin/env_reader.dart b/bin/env_reader.dart
@@ -13,20 +13,25 @@ void main(List<String> arguments) async {
   ArgParser runner = ArgParser()
     ..addOption('input',
         abbr: 'i', help: 'Input path of the .env file', mandatory: true)
-    ..addOption('password',
-        abbr: 'p', help: 'Password for encryption & decryption')
     ..addOption('output',
-        abbr: 'o',
-        help: 'Custom output path for the encrypted .env file',
-        defaultsTo: 'assets/env/')
-    ..addOption('model', help: 'Generate model.dart file to your desired path')
-    ..addFlag('help', abbr: 'h', help: 'Print this usage information')
+        abbr: 'o', help: 'Output path for the encrypted .env file')
+    ..addOption('key',
+        abbr: 's', help: 'Secret key for encryption & decryption')
+    ..addOption('model', help: 'Generate dart model to your desired file path')
     ..addFlag('null-safety',
         defaultsTo: false, negatable: false, help: 'Make the model null safety')
+    ..addFlag('obfuscate',
+        defaultsTo: true, help: 'Obfuscating generated values of model')
     ..addFlag('pubspec',
         defaultsTo: true, help: 'Inserting asset path to pubspec.yaml')
     ..addFlag('gitignore',
-        defaultsTo: true, help: 'Inserting .env input file into .gitignore');
+        defaultsTo: true,
+        help: 'Inserting .env input & output file into .gitignore')
+    ..addFlag('help',
+        defaultsTo: false,
+        abbr: 'h',
+        negatable: false,
+        help: 'Print this usage information');
   try {
     ArgResults argument = runner.parse(arguments);
     if (argument["help"]) {

diff --git a/bin/src/file.dart b/bin/src/file.dart
@@ -4,31 +4,33 @@ part of '../env_reader.dart';
 /// A function to take the .env file from given [input] into a more secured version inside [directory].
 void insertFile({required ArgResults from}) {
   String input = from['input']!.toString();
-  String output = from["output"]!.toString();
-  String target = output.contains("/")
-      ? output.replaceAll(RegExp(r'/[^/]+$'), "/")
-      : Directory.current.path;
-  String data = File(input).readAsStringSync();
-  Directory directory = Directory(target)..createSync(recursive: true);
-  String name = output.endsWith("/")
-      ? (input.contains("/") ? input.split("/").last : input)
-      : output.contains("/")
-          ? output.split("/").last
-          : output;
+  String? output = from["output"]?.toString();
+  if (output != null) {
+    String target = output.contains("/")
+        ? output.replaceAll(RegExp(r'/[^/]+$'), "/")
+        : output;
+    String data = File(input).readAsStringSync();
+    Directory directory = Directory(target)..createSync(recursive: true);
+    String name = output.endsWith("/")
+        ? (input.contains("/") ? input.split("/").last : input)
+        : output.contains("/")
+            ? output.split("/").last
+            : output;
 
-  String? password = from['password']?.toString();
-  if (password != null) {
-    File asset = File(directory.path + name)
-      ..writeAsStringSync(Encryptor.encrypt(password, data));
-    print(
-        "\x1B[32m$input\x1B[0m successfully encrypted into \x1B[34m${asset.path}\x1B[0m 🚀");
-  } else {
-    File asset = File(directory.path + name)..writeAsStringSync(data);
-    print(
-        "\x1B[32m$input\x1B[0m successfully duplicated into \x1B[34m${asset.path}\x1B[0m 🚀");
-    if (asset.path.startsWith("assets/")) {
+    String? key = from['key']?.toString();
+    if (key != null) {
+      File asset = File(directory.path + name)
+        ..writeAsStringSync(Encryptor.encrypt(key, data));
       print(
-          "\x1B[31mWarning:\x1B[0m Avoid openly placing exposed .env variables in assets 🔥");
+          "\x1B[32m$input\x1B[0m successfully encrypted into \x1B[34m${asset.path}\x1B[0m 🚀");
+    } else {
+      File asset = File(directory.path + name)..writeAsStringSync(data);
+      print(
+          "\x1B[32m$input\x1B[0m successfully duplicated into \x1B[34m${asset.path}\x1B[0m 🚀");
+      if (asset.path.startsWith("assets/")) {
+        print(
+            "\x1B[31mWarning:\x1B[0m Avoid openly placing exposed .env variables in assets 🔥");
+      }
     }
   }
 }
diff --git a/bin/src/gitignore.dart b/bin/src/gitignore.dart
@@ -6,7 +6,7 @@ void insertGitignore({required ArgResults from}) {
   if (insert) {
     File gitignore = File('.gitignore');
     String input = from["input"]!.toString();
-    String output = from["output"]!.toString();
+    String? output = from["output"]?.toString();
     List<String> lines = gitignore.readAsLinesSync();
     bool inputExisted = false;
     bool outputExisted = false;
@@ -18,10 +18,12 @@ void insertGitignore({required ArgResults from}) {
       }
     }
 
-    for (var item in lines) {
-      if (item.contains(output)) {
-        outputExisted = true;
-        break;
+    if (output != null) {
+      for (var item in lines) {
+        if (item.contains(output)) {
+          outputExisted = true;
+          break;
+        }
       }
     }
 
@@ -36,7 +38,7 @@ void insertGitignore({required ArgResults from}) {
       }
     }
 
-    if (!outputExisted) {
+    if (!outputExisted && output != null) {
       String comment = "# Env Reader related";
       int index =
           lines.lastIndexWhere((line) => line.trim().startsWith(comment));

diff --git a/bin/src/json.dart b/bin/src/json.dart
@@ -16,6 +16,7 @@ void insertJson({required ArgResults from}) {
         .map((e) => capitalize(e))
         .join("");
     String input = from["input"]!.toString();
+    bool obfuscate = from['obfuscate'];
     String data = File(input).readAsStringSync();
     bool nullSafety = from["null-safety"];
 
@@ -26,28 +27,35 @@ void insertJson({required ArgResults from}) {
     String cast = json.entries.map((e) {
       Type type = e.value.runtimeType;
       String name = dartNamed(e.key);
-      String variable = nullSafety
-          ? "Env.read<$type>('${e.key}') ?? ${type == bool ? 'false' : type == int ? '0' : type == double ? '0.0' : "'${e.key}'"}"
-          : "Env.read<$type>('${e.key}')";
+      if (obfuscate) {
+        String variable = nullSafety
+            ? "Env.read<$type>('${e.key}') ?? ${type == bool ? 'false' : type == int ? '0' : type == double ? '0.0' : "'${e.key}'"}"
+            : "Env.read<$type>('${e.key}')";
 
-      return """
+        return """
   /// Value of `${e.key}` in environment variable. This is equal to
   /// ```dart
   /// $variable;
   /// ```
   static $type${nullSafety ? "" : "?"} $name = $variable;
 """;
+      } else {
+        return """
+  /// Value of `${e.key}` in environment variable. This is equal to
+  /// ```dart
+  /// $type $name = Env.read<$type>('${e.key}') ?? ${type == bool ? 'false' : type == int ? '0' : type == double ? '0.0' : "'${e.key}'"};
+  /// print($name); // ${e.value}
+  /// ```
+  static const $type $name = ${type == String ? "'${e.value}'" : e.value ?? 'e.key'};
+""";
+      }
     }).join("\n");
     String write = """
 // Env Reader Auto-Generated Model File
 // Created at ${DateTime.now()}
 // 🍔 [Buy me a coffee](https://www.buymeacoffee.com/nialixus) 🚀
-import 'package:env_reader/env_reader.dart';
-
-/// Auto-generated environment model class.
-///
-/// This class represents environment variables parsed from the .env file.
-/// Each static variable corresponds to an environment variable,${nullSafety ? "\n/// with default values provided for safety\n/// `false` for [bool], `0` for [int], `0.0` for [double] and `VARIABLE_NAME` for [String]." : ""}
+${obfuscate ? "import 'package:env_reader/env_reader.dart';\n" : ''}
+${obfuscate ? "/// This class represents environment variables parsed from the .env file.\n/// Each static variable corresponds to an environment variable,${nullSafety ? "\n/// with default values provided for safety\n/// `false` for [bool], `0` for [int], `0.0` for [double] and `VARIABLE_NAME` for [String]." : ""}" : "/// Class wrapper for duplicated values copied directly from env file"}
 class $name {
 $cast
 }

diff --git a/bin/src/pubspec.dart b/bin/src/pubspec.dart
@@ -6,7 +6,8 @@ part of '../env_reader.dart';
 void insertPubspec({required ArgResults from}) {
   bool insert = from["pubspec"] ?? true;
   String input = from["input"]!.toString();
-  if (insert) {
+  String? output = from['output']?.toString();
+  if (insert && output != null) {
     String output =
         from["output"]!.toString().replaceAll(RegExp(r'/[^/]+$'), "/");
     if (output.startsWith("assets/")) {

diff --git a/example/.gitignore b/example/.gitignore
@@ -1,3 +1,6 @@
+# Env Reader related
+.env
+assets/env/
 
 # Miscellaneous
 *.class

diff --git a/example/assets/env/.env b/example/assets/env/.env
@@ -1 +1 @@
-GDE6V1uW1u0Z+LmxdgzW/vHCm1FtH2rCTcfJk+2bZeOXd9t/bRSNbuZXnT8ByDIMflCDX4FYXCzNCf6j27saxCSeN+ezKOvpoURTVY95aKpXfkVJyEChQ0k4ulE3NHMfpzJxOh2zc0neNh8Aw212LcNimPEtm7TlF2odThW6WW+cEFEsD2cu7rlOe3Zc7vdO5WlQaI9xsXjVAzgRbK0yKRXW8cNtZGL5xwHUb+MtVd9PlPQMCgtXgCObLH2n6BsOEotni8jAP6T7Bm7oCbi9lGx+QQ8VkNfxqgc4NH2DRnUFWyLYhuGxCTG8hKu7QuoQlG9qUGatPtOiCU3h9uo128SZZMMDl9QGqPCdveE7O626zGoBYxCXy2bw/AqgZ254Lb7p1ve+RqYQYlf99cNEYy0cbf28aHH0sRC/GwHf86PYeUkAtVMc8t6TPUpKVhyHig2GCmDY/ARek/nxe+0qVWyRf1WpqeFsT6VfY7Ib4AzzsgivVIKnb7aPkt6tpywTicSeymbXisctBk/KrXyNHadATfwXVT9mK3oW95vjCD1+JcXoO6QDHTT9UKB4fXcRT8KOS1vnC/jSUu7bF/s4Qawa+HAp9mR732Hl4CyC+hrPXroCuqXZGChrzpTAW4qeqL2UxdlEMODn5HmAltdnaRqBGqbfOx3CTks7HhUkOC5Lm+OiuFWRqa3iT0SgNTKxHcEnhZk9upi2ZPzShV1mZRJP5EiaeJdBBczGXjMlgW8Rk136BSjvZNQRyHREVoFvC72NzXfwQmc3I2e6tCKW94kwSJCvA7QwCpOqwNCnzjeOgUh6uRiYMJFfqfRvgkpRRcau8Y0UsqsRcAPzUPu3JKFowk0tugkq1WBobrJ7X+tw8Hca9Ov7YeT0m8A3BYLD3ugLTaiP4fBaMM4ZcqyZ5ErNCQ+Bk24gbol509kgG1Ve6ng6NWmYN065wQkeugdcJCXu/Pl+zEHHF2/GIzWterBpYaR5Gtf4/oUb2X6v7sGeaAfyqSRhuI0OXLRTRQrPGTqItmAoUJF5Y+G/ylaoVPLt75DrkqJWRpt4N0M36M9OXV11S1FmklSHciJukFZ4P/0N2NDUpcDJOIwVZWOaK+Q4nB0gWAXmgKvkaFiBdD90tRGObrwEUVbpLfOidIH5TLyCH3h3Ax7ySF8kR7M227ibYjGdPvDQmwwFMNGJnpc=
+z3gM+hS2FTGRUz+dnNPh0zwh7Zuc2XdZPIAwAaSZvNYkLFjYX8MTcSFmLPEq2u9K6e98vW8vRSq11OOx8FMSyyElp2mO1FtcxYfjV2DrQMVqWK03wbBmbu6erbPwcDnXhbPsIwIOIHFMpipUVJRl9tFfL4UdZyvQBDdOIn9l0sPVIf+r3SQ2e8Z5OzZFJzRnBsz6j3pFfFClWQpULRYF4tyZdHs0Xsmv5zxe5A+ij0dsWBGl3mv0GWrsXxfWo4P+e9inOuxhur/UmqYT7JTtr2SXSHGwz5e+gVlozEYT01OI0h403YyuYhpZgs3ZCCl6gEotJ1E5GjMVGC92+4I/uLg2SDffvhC9L2rLtBIxYLzJsOSNrmmGA5Ybftsi3ubqpQdR3rsn5EwEodye3fYNq1B1vJFOYPgjHSTCk3Zbd2epqKYQl8WItGSNhuXXSktgl6sYd+9Civ/fnv5NLrKmCQPEw5E6+Lif7zQJUZTElFtuV/vqJBhiGkbw2C0CzhwQHHKz4goH55nIlZUjEpOPFGZldBE4RK/5VmX4bYpF2tqUREizzJoKbFyWsRjmL2qPMKszI1eu5aIgc8JwWpps4yOyVv4DDg9W18X0BJ5Bs32d8tzymDG7VSJ7OqPREfhMeRK/QsvJVpLo8XHfZqVJJm61B2PZMq3iyzhI7WxP0ZUx6DpJnYOK7BnDp4CHYWzkAOgaZNibKsw9wB20PlwlieZlw8x5jZnTjIS5OvDmu5bGGDCzdVZOnA8iTI3upc7amJEZUiFX0Ckf2DWfuUAh+BaT7GmFD7pqKiIjCy4MWD2MRW1/MLugy5xIUTxPNCCeZJIUT6bjo7i7RJS75Jx/C70Sjsai8tvXBi0o+t65hLVlY/sq+eZ9qTEXlGJ1edQTTlVZ4zL6VcCKwoVS66J3yPf/UFKL11lsO35//GhSRqllMnFPvtmf7S2MCIycYMQ8JR8QiK/fm2qbNaH3OjM7h9J63+wVNxoGp+l/x+X7wHl+MN/7klc606bOFf46mXsI4T9nm6BJtFCG8MZ1wWT/2uy4HJDHqJnjI/Xn46IUv8VRAgCX37p3MfA4BoeUDTd/1KV2dl+urlZfZ51BSJao/HgfGftlp/MlZfi8M5fs32EthtvxqIZJbB+cNp8vfDHKfYXfN+D4ZW1ci2H8tqMK4T0Z4kMTBayZlIXhWBEwX2w=
diff --git a/example/lib/main.dart b/example/lib/main.dart
@@ -1,12 +1,13 @@
 import 'package:env_reader/env_reader.dart';
 import 'package:example/src/env_model.dart';
 import 'package:flutter/material.dart';
+import 'package:flutter/services.dart';
 
 Future<void> main(List<String> arguments) async {
   WidgetsFlutterBinding.ensureInitialized();
   await Env.load(
-    source: EnvLoader.asset('assets/env/.env'),
-    password: "MyStrongPassword",
+    EnvLoader.string(await rootBundle.loadString('assets/env/.env')),
+    "MyOptionalSecretKey",
   );
   runApp(
     const MaterialApp(

diff --git a/example/lib/src/env_model.dart b/example/lib/src/env_model.dart
@@ -1,10 +1,8 @@
 // Env Reader Auto-Generated Model File
-// Created at 2023-08-29 10:08:02.009503
+// Created at 2023-10-11 15:28:35.710424
 // 🍔 [Buy me a coffee](https://www.buymeacoffee.com/nialixus) 🚀
 import 'package:env_reader/env_reader.dart';
 
-/// Auto-generated environment model class.
-///
 /// This class represents environment variables parsed from the .env file.
 /// Each static variable corresponds to an environment variable,
 /// with default values provided for safety
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		GDE6V1uW1u0Z+LmxdgzW/vHCm1FtH2rCTcfJk+2bZeOXd9t/bRSNbuZXnT8ByDIMflCDX4FYXCzNCf6j27saxCSeN+ezKOvpoURTVY95aKpXfkVJyEChQ0k4ulE3NHMfpzJxOh2zc0neNh8Aw212LcNimPEtm7TlF2odThW6WW+cEFEsD2cu7rlOe3Zc7vdO5WlQaI9xsXjVAzgRbK0yKRXW8cNtZGL5xwHUb+MtVd9PlPQMCgtXgCObLH2n6BsOEotni8jAP6T7Bm7oCbi9lGx+QQ8VkNfxqgc4NH2DRnUFWyLYhuGxCTG8hKu7QuoQlG9qUGatPtOiCU3h9uo128SZZMMDl9QGqPCdveE7O626zGoBYxCXy2bw/AqgZ254Lb7p1ve+RqYQYlf99cNEYy0cbf28aHH0sRC/GwHf86PYeUkAtVMc8t6TPUpKVhyHig2GCmDY/ARek/nxe+0qVWyRf1WpqeFsT6VfY7Ib4AzzsgivVIKnb7aPkt6tpywTicSeymbXisctBk/KrXyNHadATfwXVT9mK3oW95vjCD1+JcXoO6QDHTT9UKB4fXcRT8KOS1vnC/jSUu7bF/s4Qawa+HAp9mR732Hl4CyC+hrPXroCuqXZGChrzpTAW4qeqL2UxdlEMODn5HmAltdnaRqBGqbfOx3CTks7HhUkOC5Lm+OiuFWRqa3iT0SgNTKxHcEnhZk9upi2ZPzShV1mZRJP5EiaeJdBBczGXjMlgW8Rk136BSjvZNQRyHREVoFvC72NzXfwQmc3I2e6tCKW94kwSJCvA7QwCpOqwNCnzjeOgUh6uRiYMJFfqfRvgkpRRcau8Y0UsqsRcAPzUPu3JKFowk0tugkq1WBobrJ7X+tw8Hca9Ov7YeT0m8A3BYLD3ugLTaiP4fBaMM4ZcqyZ5ErNCQ+Bk24gbol509kgG1Ve6ng6NWmYN065wQkeugdcJCXu/Pl+zEHHF2/GIzWterBpYaR5Gtf4/oUb2X6v7sGeaAfyqSRhuI0OXLRTRQrPGTqItmAoUJF5Y+G/ylaoVPLt75DrkqJWRpt4N0M36M9OXV11S1FmklSHciJukFZ4P/0N2NDUpcDJOIwVZWOaK+Q4nB0gWAXmgKvkaFiBdD90tRGObrwEUVbpLfOidIH5TLyCH3h3Ax7ySF8kR7M227ibYjGdPvDQmwwFMNGJnpc=
		z3gM+hS2FTGRUz+dnNPh0zwh7Zuc2XdZPIAwAaSZvNYkLFjYX8MTcSFmLPEq2u9K6e98vW8vRSq11OOx8FMSyyElp2mO1FtcxYfjV2DrQMVqWK03wbBmbu6erbPwcDnXhbPsIwIOIHFMpipUVJRl9tFfL4UdZyvQBDdOIn9l0sPVIf+r3SQ2e8Z5OzZFJzRnBsz6j3pFfFClWQpULRYF4tyZdHs0Xsmv5zxe5A+ij0dsWBGl3mv0GWrsXxfWo4P+e9inOuxhur/UmqYT7JTtr2SXSHGwz5e+gVlozEYT01OI0h403YyuYhpZgs3ZCCl6gEotJ1E5GjMVGC92+4I/uLg2SDffvhC9L2rLtBIxYLzJsOSNrmmGA5Ybftsi3ubqpQdR3rsn5EwEodye3fYNq1B1vJFOYPgjHSTCk3Zbd2epqKYQl8WItGSNhuXXSktgl6sYd+9Civ/fnv5NLrKmCQPEw5E6+Lif7zQJUZTElFtuV/vqJBhiGkbw2C0CzhwQHHKz4goH55nIlZUjEpOPFGZldBE4RK/5VmX4bYpF2tqUREizzJoKbFyWsRjmL2qPMKszI1eu5aIgc8JwWpps4yOyVv4DDg9W18X0BJ5Bs32d8tzymDG7VSJ7OqPREfhMeRK/QsvJVpLo8XHfZqVJJm61B2PZMq3iyzhI7WxP0ZUx6DpJnYOK7BnDp4CHYWzkAOgaZNibKsw9wB20PlwlieZlw8x5jZnTjIS5OvDmu5bGGDCzdVZOnA8iTI3upc7amJEZUiFX0Ckf2DWfuUAh+BaT7GmFD7pqKiIjCy4MWD2MRW1/MLugy5xIUTxPNCCeZJIUT6bjo7i7RJS75Jx/C70Sjsai8tvXBi0o+t65hLVlY/sq+eZ9qTEXlGJ1edQTTlVZ4zL6VcCKwoVS66J3yPf/UFKL11lsO35//GhSRqllMnFPvtmf7S2MCIycYMQ8JR8QiK/fm2qbNaH3OjM7h9J63+wVNxoGp+l/x+X7wHl+MN/7klc606bOFf46mXsI4T9nm6BJtFCG8MZ1wWT/2uy4HJDHqJnjI/Xn46IUv8VRAgCX37p3MfA4BoeUDTd/1KV2dl+urlZfZ51BSJao/HgfGftlp/MlZfi8M5fs32EthtvxqIZJbB+cNp8vfDHKfYXfN+D4ZW1ci2H8tqMK4T0Z4kMTBayZlIXhWBEwX2w=