📝 add code doc comments

Signed-off-by: birjuvachhani <[email protected]>

CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.1.0
+
+- added dart class generator
+- fix pub.dev warnings
+- add code documentation
+
 ## 0.0.1
 
 - pre-alpha release

bin/main.dart

@@ -23,6 +23,7 @@ import 'package:args/args.dart';
 import 'package:path/path.dart' as path;
 import 'package:spider/spider.dart';
 
+/// Handles all the commands
 void main(List<String> arguments) {
   var pubspec_path = path.join(Directory.current.path, 'pubspec.yaml');
   if (!File(pubspec_path).existsSync()) {

lib/spider.dart

@@ -26,6 +26,8 @@ import 'package:spider/src/dart_class_generator.dart';
 
 import 'src/utils.dart';
 
+/// Entry point of all the command process
+/// provides varios functions to execute commands
 class Spider {
   final String _path;
   Configuration configs;
@@ -34,15 +36,10 @@ class Spider {
       caseSensitive: false);
 
   Spider(this._path) {
-    _initialize();
     configs = Configuration(_path);
   }
 
-  void _initialize() async {
-    if (!await Directory(_path).exists()) {}
-  }
-
-  void listen_for_changes() {
+  void _listen_for_changes() {
     print('Watching for changes in directory ${configs["path"]}...');
     Directory(configs['path'])
         .watch(events: FileSystemEvent.all)
@@ -55,6 +52,7 @@ class Spider {
     });
   }
 
+  /// generates dart code for given [configs] parsed from spider.yaml
   void generate_code() {
     var properties = createFileMap(configs['path']);
     var generator = DartClassGenerator(
@@ -75,6 +73,7 @@ class Spider {
     processing = false;
   }
 
+  /// initializes config file (spider.yaml) in the root of the project
   static void init_configs() async {
     var configFile = File(Constants.CONFIG_FILE_NAME);
     await configFile.writeAsString(Constants.DEFAULT_CONFIGS_STRING);

lib/src/configuration.dart

@@ -35,6 +35,7 @@ class Configuration {
     _initialize();
   }
 
+  /// loads spider.yaml file
   void _initialize() {
     if (!Directory(_path).existsSync()) {
       print('$_path does not exists!');
@@ -50,5 +51,6 @@ class Configuration {
     }
   }
 
-  operator [](String name) => _configs[name] ?? _defaults[name];
+  /// allows to access yaml data directly
+  dynamic operator [](String name) => _configs[name] ?? _defaults[name];
 }

lib/src/constants.dart

@@ -17,6 +17,7 @@
 // Author: Birju Vachhani
 // Created Date: February 02, 2020
 
+/// Holds all the constants
 class Constants {
   static final String CONFIG_FILE_NAME = 'spider.yaml';
   static final String DEFAULT_CONFIGS_STRING =

lib/src/dart_class_generator.dart

@@ -19,6 +19,7 @@
 
 import 'package:meta/meta.dart';
 
+/// Generates dart class code using given data
 class DartClassGenerator {
   final String className;
   bool useStatic = false;
@@ -35,11 +36,12 @@ class DartClassGenerator {
   DartClassGenerator(
       {@required this.className,
       @required this.properties,
-      this.use_underscores,
-      this.useConst,
-      this.useStatic,
-      this.prefix});
+        this.use_underscores = false,
+        this.useConst = true,
+        this.useStatic = true,
+        this.prefix = ''});
 
+  /// generates dart class code and returns it as a single string
   String generate() {
     var properties_strings = properties.keys.map<String>((name) {
       var str = useStatic ? '\tstatic ' : '\t';
@@ -82,5 +84,6 @@ ${properties_strings.join('\n')}
                 (match) => match.group(2).toUpperCase());
   }
 
+  /// formats path string to match with flutter's standards
   String formatPath(String value) => value.replaceAll('\\', '/');
 }

lib/src/utils.dart

@@ -23,11 +23,13 @@ import 'package:path/path.dart' as p;
 
 import 'constants.dart';
 
+/// Returns an instance of [File] if given [path] exists, null otherwise.
 File file(String path) {
   var file = File(path);
   return file.existsSync() ? file : null;
 }
 
+/// formats file name according to effective dart
 String formatFileName(String name) {
   name = name
       .replaceAllMapped(
@@ -36,6 +38,7 @@ String formatFileName(String name) {
   return name.contains('.dart') ? name : name + '.dart';
 }
 
+/// Writes given [content] to the file with given [name] at given [path].
 void writeToFile({String name, String path, String content}) {
   if (!Directory(p.join(Constants.LIB_FOLDER, path)).existsSync()) {
     Directory(p.join(Constants.LIB_FOLDER, path)).createSync(recursive: true);

pubspec.yaml

@@ -1,6 +1,6 @@
 name: spider
 description: A small dart library to generate Assets dart code from assets folder. It generates dart class with static const variables in it which can be used to reference the assets safely anywhere in the flutter app.
-version: 0.0.1
+version: 0.1.0
 homepage: https://github.com/BirjuVachhani/spider
 
 environment:
@@ -11,6 +11,7 @@ dependencies:
   intl: ^0.16.1
   yaml: ^2.2.0
   args: ^1.5.2
+  meta: ^1.1.8
 
 dev_dependencies:
   pedantic: ^1.8.0

test/spider_test.dart

@@ -17,10 +17,42 @@
 // Author: Birju Vachhani
 // Created Date: February 02, 2020
 
+import 'package:spider/src/dart_class_generator.dart';
 import 'package:test/test.dart';
 
+/// runs all the test cases
 void main() {
-  test('calculate', () {
-//    expect(calculate(), 42);
+  test('format name test', () {
+    var generator = DartClassGenerator(className: '', properties: {});
+    expect(generator.formatName('test_case'), 'testCase');
+    expect(generator.formatName('test case'), 'testCase');
+    expect(generator.formatName('Test Case'), 'testCase');
+    expect(generator.formatName('__Test Case'), 'testCase');
+    expect(generator.formatName('Test   Case'), 'testCase');
+    expect(generator.formatName('Test@)(Case'), 'testCase');
+    expect(generator.formatName('TestCase'), 'testCase');
+    expect(generator.formatName('test-case-with some_word'),
+        'testCaseWithSomeWord');
+    generator = DartClassGenerator(
+        className: '', properties: {}, use_underscores: true);
+    expect(generator.formatName('test_case'), 'test_case');
+    expect(generator.formatName('test case'), 'test_case');
+    expect(generator.formatName('Test Case'), 'test_case');
+    expect(generator.formatName('__Test Case'), 'test_case');
+    expect(generator.formatName('Test   Case'), 'test_case');
+    expect(generator.formatName('Test@)(Case'), 'test_case');
+    expect(generator.formatName('TestCase'), 'test_case');
+    expect(generator.formatName('test-case-with some_word'),
+        'test_case_with_some_word');
+  });
+
+  test('format path test', () {
+    var generator = DartClassGenerator(className: '', properties: {});
+    expect(generator.formatPath('assets\\abc.png'), 'assets/abc.png');
+    expect(generator.formatPath('assets/temp.png'), 'assets/temp.png');
+    expect(
+        generator.formatPath('assets/temp/temp.png'), 'assets/temp/temp.png');
+    expect(
+        generator.formatPath('assets\\temp\\temp.png'), 'assets/temp/temp.png');
   });
 }