Skip to content

Commit

Permalink
Major refactoring of project
Browse files Browse the repository at this point in the history
  • Loading branch information
Justin-Byrne committed Oct 11, 2023
1 parent fb8c5d7 commit 6154c3e
Show file tree
Hide file tree
Showing 28 changed files with 481 additions and 1,295 deletions.
3 changes: 2 additions & 1 deletion .gitattributes
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
source/tests/cases/source/* linguist-vendored
source/tests/cases/source/sub/* linguist-vendored
source/tests/cases/source/sub/* linguist-vendored
build/* linguist-vendored
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ _dump/

## Tests
*-test-[0-9].*
tests

## Stashes
**/*-{stash-[0-9]}.*
Expand Down
156 changes: 76 additions & 80 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# ClassGenerator

![issues](https://img.shields.io/github/issues/Justin-Byrne/ClassGenerator)
![forks](https://img.shields.io/github/forks/Justin-Byrne/ClassGenerator)
![stars](https://img.shields.io/github/stars/Justin-Byrne/ClassGenerator)
![license](https://img.shields.io/github/license/Justin-Byrne/ClassGenerator)
<img src="https://img.shields.io/badge/Python-3.11.2-blue" />
<img src="https://img.shields.io/badge/PlantUML-1.2.023.4-purple" />
<img src="https://img.shields.io/badge/Graphviz-8.0.5-green" />

<img src=https://img.shields.io/badge/Python-3.11.2-blue />
<img src=https://img.shields.io/badge/PlantUML-1.2.023.4-purple />
<img src=https://img.shields.io/badge/Graphviz-8.0.5-gray />
<img src=https://img.shields.io/badge/Version-0.8.8-green />
<img src=https://img.shields.io/github/languages/code-size/Justin-Byrne/ClassGenerator />

PlantUML class generator for JavaScript

- [Requirements](#requirements)
Expand All @@ -17,7 +17,6 @@ PlantUML class generator for JavaScript
- [Examples](#examples)
- [Support](#support)
- [Structure](#structure)
- [Copyright](#copyright)

## Requirements

Expand Down Expand Up @@ -45,45 +44,45 @@ python3 BuildClass.py {<source>} [<destination>] [flags] [args[|args...]]
PATHS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
source File or directory location of javascript file(s) to convert
source File or directory location of javascript file(s) to convert
usage:
(single) "/javascript/classes/one.js"
(multiple) "/javascript/classes"
usage:
(single) "/javascript/classes/one.js"
(multiple) "/javascript/classes"
destination File or directory location to save class diagrams
destination File or directory location to save class diagrams
usage:
(single) "/javascript/classes/output/one.txt"
(multiple) "/javascript/classes/output"
usage:
(single) "/javascript/classes/output/one.txt"
(multiple) "/javascript/classes/output"
FLAGS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
-o, --omit "<filename>" Omit the following filenames from the source directory
-o, --omit "<filename>" Omit the following filenames from the source directory
usage:
(single) --omit "file1"
(multiple) --omit "file1|file2|file3"
usage:
(single) --omit "file1"
(multiple) --omit "file1|file2|file3"
-s, --skin "<skinparam>" Embed skin parameters within the class uml generated
-s, --skin "<skinparam>" Embed skin parameters within the class uml generated
usage:
(single) --skin "skinparam+one+1"
(multiple) --skin "skinparam+one+1|skinparam+two+2"
usage:
(single) --skin "skinparam+one+1"
(multiple) --skin "skinparam+one+1|skinparam+two+2"
-m, --make "<image_type>" Make the class generated diagram into an image
-m, --make "<image_type>" Make the class generated diagram into an image
usage:
(single) --make "png"
(multiple) --make "png|svg|eps"
usage:
(single) --make "png"
(multiple) --make "png|svg|eps"
-l, --link Link available classes to generated class diagrams
-l, --link Link available classes to generated class diagrams
usage: --link
usage: --link
-h, --help Display this help menu
-h, --help Display this help menu
usage: --help
usage: --help
```

## Configuration
Expand All @@ -93,18 +92,18 @@ Configurations settings for each generated file can be set within `../app/config
> These settings are commented out by default
```bash
#### FILE OMISSIONS
#### FILE OMISSIONS
one
two
three

#### SKIN PARAM
#### SKIN PARAM
left to right direction
skinparam DefaultFontSize 16
skinparam DefaultFontName Courier 10 Pitch
skinparam DefaultFontName Courier New
skinparam ClassAttributeIconSize 0

#### IMAGE OUTPUT
#### IMAGE OUTPUT
png
svg
eps
Expand All @@ -120,7 +119,7 @@ latex
latex:nopreamble
braille

#### PLANTUML PATH
#### PLANTUML PATH
path=~/Programs/PlantUML

```
Expand Down Expand Up @@ -307,62 +306,59 @@ prop3
</tr>
</table>


## Support

Please [open an issue](https://github.com/Justin-Byrne/ClassGenerator/issues/new) for support.


## Structure

```
.
├── LICENSE
├── README.md
├── docs
│   └── CHANGELOG.md
└── source
└── app
├── BuildClass.py
├── config
│   └── config.txt
├── core
│   ├── generator.py
│   └── linker.py
├── test-generator.py
└── utilities
├── custom
│   ├── cleanup
│   │   └── clean_properties.py
│   ├── debug
│   │   └── view_arguments.py
│   └── validation
│   ├── is_extension.py
│   └── is_js_class.py
├── system
│   ├── file
│   │   ├── get_eof.py
│   │   └── get_files.py
│   ├── get_command_type.py
│   ├── get_commands.py
│   ├── list
│   │   ├── create_2d_list.py
│   │   ├── entry_padding.py
│   │   └── list_to_string.py
│   ├── parse_commands.py
│   ├── string
│   │   └── repeat_character.py
│   └── validation
│   ├── is_directory.py
│   ├── is_file.py
│   ├── is_flag.py
│   └── is_program.py
└── util.py
│   ├── CHANGELOG.md
│   └── FUNDING.yml
├── source
│   └── app
│   ├── config
│   │   └── config.txt
│   ├── core
│   │   ├── generator.py
│   │   └── linker.py
│   ├── utilities
│   │   ├── custom
│   │   │   ├── debug
│   │   │   │   └── view_arguments.py
│   │   │   ├── filter
│   │   │   │   ├── filter_properties.py
│   │   │   │   └── filter_type.py
│   │   │   ├── list
│   │   │   │   └── get_column_max.py
│   │   │   └── validation
│   │   │   ├── is_extension.py
│   │   │   └── is_js_class.py
│   │   ├── system
│   │   │   ├── file
│   │   │   │   ├── get_file_bounds.py
│   │   │   │   ├── get_file_omissions.py
│   │   │   │   ├── get_files.py
│   │   │   │   └── set_file.py
│   │   │   ├── validation
│   │   │   │   ├── is_directory.py
│   │   │   │   ├── is_file.py
│   │   │   │   ├── is_flag.py
│   │   │   │   └── is_program.py
│   │   │   ├── get_command_type.py
│   │   │   ├── get_commands.py
│   │   │   └── parse_commands.py
│   │   └── util.py
│   └── BuildClass.py
├── LICENSE
└── README.md
```

## Copyright

![Byrne-Systems](https://github.com/Justin-Byrne/ClassGenerator/blob/main/images/cube_sm.png)

== Byrne-Systems © 2023 - All rights reserved. ==

:lotus_position:
21 changes: 21 additions & 0 deletions docs/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,27 @@
# Changelog
All notable changes to this project will be documented in this file.

## [0.8.8] - 2023-10-11
### Changed
- Refactored and cleaned entire `generator` class

### Added
- Added the following utilities
- `filter_properties ( )`
- `filter_type ( )`
- `get_column_max ( )`
- `get_file_bounds ( )`
- `set_file ( )`

### Removed
- Removed the following utilities
- `get_eof ( )`
- `entry_padding ( )`
- `create_2d_list ( )`
- `repeat_character ( )`
- `list_to_string ( )`
- `clean_properties ( )`

## [0.7.8] - 2023-05-03
### Added
- Help menu to `get_commands ( )`
Expand Down
4 changes: 2 additions & 2 deletions source/app/config/config.txt
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@

#### SKIN PARAM
# left to right direction
# skinparam DefaultFontSize 16
# skinparam DefaultFontName Courier 10 Pitch
skinparam DefaultFontSize 16
skinparam DefaultFontName Courier New
# skinparam ClassAttributeIconSize 0

#### IMAGE OUTPUT
Expand Down
Loading

0 comments on commit 6154c3e

Please sign in to comment.