Feature/add subgroups #50

Sanlovty · 2022-06-29T20:01:17Z

Description of the Change

Add a subgroup system to allow the user to create one class that includes different asset groups with unique file prefixes, paths, and extensions.

Benefits

Now you can create more flexible aseet-classes by providing different paths, file extensions and prefixes into the same class:

Config:

  generate_tests: true
  no_comments: true
  export: true
  use_part_of: true
  use_references_list: false
  package: resources
  groups:
    - class_name: Assets
      subgroups:
        - path: assets/images
          types: [ jpg ]
          prefix: jpg
        - paths: 
          - assets/images
          - assets/imgs
          types: [ png ]
          prefix: png

Result:

part of 'resources.dart';

class Assets{
  Assets ._();
  
  static const String jpgTest2 = 'assets/images/test2.jpg';
  static const String pngTest1 = 'assets/images/test1.png';
  static const String pngTest3 = 'assets/imgs/test3.png';
}

Possible Drawbacks

deeper (complicated) structure of config file.
not the best name ('subgroups').

Verification Process

What process did you follow to verify that your change has the desired effects?

test adaptation.
validateConfigs adaptation.

Applicable Issues

#49

BirjuVachhani · 2022-06-30T08:20:52Z

@Sanlovty Let's not add a dependency to tuple if you're only using Tuple2. We can have a local class model that makes more sense!

Sanlovty · 2022-06-30T08:24:10Z

@Sanlovty Let's not add a dependency to tuple if you're only using Tuple2. We can have a local class model that makes more sense!

Sure, i'll make it <3

Sanlovty · 2022-06-30T08:37:04Z

@BirjuVachhani, can u assign me to pr?

BirjuVachhani · 2022-06-30T10:47:03Z

@Sanlovty When I said Replace tuple with something more meaningful I meant something like this!

class SubgroupProperty {
  final String prefix;
  final Map<String, String> files;
}

Its fine if you don't have time for now to do this or if you don't want to. I can always take a look later.

Sanlovty · 2022-06-30T10:49:44Z

Its fine if you don't have time for now to do this or if you don't want to. I can always take a look later.

Oh, my bad. I'll fix it. I have time and i want to do it.

- add optional types - add optional paths - add optional prefix - make subgroups optional - refactor fromJson method The properties (types,prefix) of the group are now overriding the sub_groups' properties. If a group has a path\paths property, it simply does not use a sub_groups at all due to their futility

BirjuVachhani · 2022-06-30T13:27:19Z

@Sanlovty Thank you! Appreciate that! 😊

Sanlovty · 2022-06-30T13:27:50Z

@BirjuVachhani, I think it’s working as you want now. I want to add effective tests to touch each case, but I also need to rewrite some of the existing ones. I’m waiting for your feedback.

Example of using:

generate_tests: true
no_comments: true
export: true
use_part_of: true
use_references_list: false
package: resources

groups:
  - class_name: Images
    path: assets/images
    types: [ .png, .jpg, .jpeg, .webp, .webm, .bmp ]
  
  - class_name: Svgs
    sub_groups:
      - path: assets/svgsMenu
        prefix: menu
        types: [ .svg ]

      - path: assets/svgsOther
        prefix: other
        types: [ .svg ]
  
  - class_name: Ico
    types: [ .ico ]
    prefix: ico
    sub_groups:
      - path: assets/icons
        prefix: test1
        types: [ .ttf ]

      - path: assets/vectors
        prefix: test2
        types: [ .pdf ]
  
  - class_name: Video
    types: [ .mp4 ]
    path: assets/moviesOnly
    sub_groups:
      - path: assets/movies
        prefix: common

      - path: assets/moviesExtra
        prefix: extra

I am online from 7:00 to 22:00 (GMT)

lib/src/asset_group.dart

lib/src/dart_class_generator.dart

BirjuVachhani · 2022-06-30T17:03:30Z

lib/src/data/yaml_config.dart

+  
+  - class_name: Svgs
+    sub_groups:
+      - path: assets/svgsMenu
+        prefix: menu
+        types: [ .svg ]
+
+      - path: assets/svgsOther
+        prefix: other
+        types: [ .svg ]
+  
+  - class_name: Ico
+    types: [ .ico ]
+    prefix: ico
+    sub_groups:
+      - path: assets/icons
+        prefix: test1
+        types: [ .ttf ]
+
+      - path: assets/vectors
+        prefix: test2
+        types: [ .pdf ]
+  
+  - class_name: Video
+    types: [ .mp4 ]
+    path: assets/moviesOnly
+    sub_groups:
+      - path: assets/movies
+        prefix: common
+
+      - path: assets/moviesExtra
+        prefix: extra


Lets not change default configs. Users mostly don't do this! We'll document this at https://birjuvachhani.github.io/spider

Suggested change

- class_name: Svgs

sub_groups:

- path: assets/svgsMenu

prefix: menu

types: [ .svg ]

- path: assets/svgsOther

prefix: other

types: [ .svg ]

- class_name: Ico

types: [ .ico ]

prefix: ico

sub_groups:

- path: assets/icons

prefix: test1

types: [ .ttf ]

- path: assets/vectors

prefix: test2

types: [ .pdf ]

- class_name: Video

types: [ .mp4 ]

path: assets/moviesOnly

sub_groups:

- path: assets/movies

prefix: common

- path: assets/moviesExtra

prefix: extra

This config is used in createConfigs method. I need to change it to run the tests

If you only require this in tests then maybe we can change some things there to have it for tests only. I'd still prefer to not have all this when you actually run spider create command.

Okay, i'll rework the createConfig method

lib/src/utils.dart

test/spider_test.dart

BirjuVachhani · 2022-06-30T17:13:25Z

@Sanlovty Over all look good. Nice work! 👍🏻 Just some minor changes and tests, other than that, it should be good to merge.

Sanlovty · 2022-07-01T20:57:27Z

@BirjuVachhani if u agree with commits after cd55a39, than i start making the tests. Also, pls check email ^-^

I will appreciate if u suggest the naming ideas for vars\getters. I also was thinking about not making testConfigs 'getters' but we easily can change it if needed

BirjuVachhani · 2022-07-02T06:21:58Z

@Sanlovty Those commits look good. I like names you have given to var/getters.

I also was thinking about not making testConfigs 'getters' but we easily can change it if needed

Agreed. I am fine either way.

codecov-commenter · 2022-07-02T06:25:20Z

Codecov Report

Merging #50 (a8a1887) into main (4e4cc97) will increase coverage by 2.26%.
The diff coverage is 89.43%.

@@            Coverage Diff             @@
##             main      #50      +/-   ##
==========================================
+ Coverage   68.30%   70.56%   +2.26%     
==========================================
  Files          13       15       +2     
  Lines         489      564      +75     
==========================================
+ Hits          334      398      +64     
- Misses        155      166      +11

Impacted Files	Coverage Δ
lib/src/constants.dart	`50.00% <ø> (ø)`
lib/spider.dart	`40.62% <33.33%> (+0.94%)`	⬆️
lib/src/asset_subgroup.dart	`81.81% <81.81%> (ø)`
lib/src/asset_group.dart	`83.87% <86.95%> (+0.53%)`	⬆️
lib/src/dart_class_generator.dart	`91.87% <92.10%> (-2.57%)`	⬇️
lib/src/utils.dart	`78.74% <92.30%> (+1.54%)`	⬆️
lib/src/data/test_template.dart	`80.00% <100.00%> (+13.33%)`	⬆️
lib/src/subgroup_property.dart	`100.00% <100.00%> (ø)`

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 537e608...a8a1887. Read the comment docs.

BirjuVachhani

LGTM

BirjuVachhani · 2022-07-10T15:55:17Z

Thank you @Sanlovty for your contributions. 😊

BirjuVachhani · 2022-07-18T11:23:34Z

Released in v3.2.0

Sanlovty added 7 commits June 29, 2022 22:42

⬆️ add tuple package

1e8ea7b

🎨 refactor example configs

793ae10

✨ add subgroup model

2388502

🎨 remove data used in subgroup, add subgroups

93e2874

🎨 adapt for new model system

acf88f3

🎨 refactor config files

2cf3124

✅ adapt tests

a0db003

Sanlovty mentioned this pull request Jun 29, 2022

Feature/add subgroups support #49

Closed

Sanlovty and others added 2 commits June 30, 2022 09:14

🎨 fix missing prefix

5e5dcca

🩹 previous commit is a mistake

b3d5ae3

BirjuVachhani added the feature indicates that a feature is requested label Jun 30, 2022

Sanlovty added 3 commits June 30, 2022 13:05

➖ remove tuple package

f3c6723

✨ add local pair class

6b4b10f

♻️ swap removed tuple class with local pair

12ba104

BirjuVachhani assigned Sanlovty Jun 30, 2022

Sanlovty added 7 commits June 30, 2022 16:10

🔥 remove pair class due to futility

9eedc1d

✨ add subgroup property

c335641

♻️ refactor configs for new system

bc58cef

♻️ refactor generator for new system

fccd74b

♻️ refactor validator to handle new style of config

7f9f94f

✅ update tests for new system

beba30c

🎨 format fix

b18f9d2

BirjuVachhani requested changes Jun 30, 2022

View reviewed changes

Sanlovty added 8 commits June 30, 2022 20:47

🎨 add some formatting

3eca7ab

📝 add docs to _assertDir()

cd55a39

🎨 small formatting

ae7b55e

🚚🎨 rename var and file of json-config(example)

e555f62

🚚🎨 rename var and file of yaml-config(example)

b8b4f63

♻️ force createConfigs to genereate test config in test case

1054d65

✨ add getters for test configs

52510b7

🎨 formatting

a8a1887

Repository owner deleted a comment from codecov-commenter Jul 2, 2022

Sanlovty requested a review from BirjuVachhani July 6, 2022 14:37

BirjuVachhani approved these changes Jul 10, 2022

View reviewed changes

BirjuVachhani merged commit 09665c8 into BirjuVachhani:main Jul 10, 2022

Feature/add subgroups #50

Feature/add subgroups #50

Uh oh!

Conversation

Sanlovty commented Jun 29, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description of the Change

Benefits

Config:

Result:

Possible Drawbacks

Verification Process

Applicable Issues

Uh oh!

BirjuVachhani commented Jun 30, 2022

Uh oh!

Sanlovty commented Jun 30, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Sanlovty commented Jun 30, 2022

Uh oh!

BirjuVachhani commented Jun 30, 2022

Uh oh!

Sanlovty commented Jun 30, 2022

Uh oh!

BirjuVachhani commented Jun 30, 2022

Uh oh!

Sanlovty commented Jun 30, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

BirjuVachhani Jun 30, 2022

Choose a reason for hiding this comment

Uh oh!

Sanlovty Jun 30, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

BirjuVachhani Jun 30, 2022

Choose a reason for hiding this comment

Uh oh!

Sanlovty Jun 30, 2022

Choose a reason for hiding this comment

Uh oh!

BirjuVachhani Jun 30, 2022

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

BirjuVachhani commented Jun 30, 2022

Uh oh!

Sanlovty commented Jul 1, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

BirjuVachhani commented Jul 2, 2022

Uh oh!

codecov-commenter commented Jul 2, 2022

Codecov Report

Uh oh!

BirjuVachhani left a comment

Choose a reason for hiding this comment

Uh oh!

BirjuVachhani commented Jul 10, 2022

Uh oh!

BirjuVachhani commented Jul 18, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Sanlovty commented Jun 29, 2022 •

edited

Loading

Sanlovty commented Jun 30, 2022 •

edited

Loading

Sanlovty commented Jun 30, 2022 •

edited

Loading

Sanlovty Jun 30, 2022 •

edited

Loading

Sanlovty commented Jul 1, 2022 •

edited

Loading