diff --git a/README.md b/README.md index 11fb1b0..0e4093f 100644 --- a/README.md +++ b/README.md @@ -1,92 +1,80 @@ -# SAE5 +# Quali'Nomme 📚 +Quali'Nomme est un outil conçu pour améliorer la qualité du nommage dans le code en facilitant l'identification des termes métiers et leur comparaison avec les glossaires spécifiés. Il a été développé dans le cadre d'une Situation d'Apprentissage et d'Évaluation (SAE). +## Objectif 🎯 -## Getting started +L'objectif de Quali'Nomme est de faciliter l'amélioration de la qualité de nommage dans le code en fournissant les fonctionnalités suivantes : -To make it easy for you to get started with GitLab, here's a list of recommended next steps. +- Ajout de un ou plusieurs glossaires en fonction des besoins du projet. +- Parsing d'un code ou d'un projet pour identifier les termes métiers utilisés et leur fréquence. +- Comparaison entre les termes saisis dans les glossaires et ceux identifiés dans le code. +- Visualisation des données comparatives pour une meilleure compréhension. -Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)! +## Sommaire 📝 -## Add your files +- [Objectif](#objectif-) 🎯 +- [Sommaire](#sommaire-) 📝 +- [Technologies Utilisées](#technologies-utilisées-) 💻 +- [Technologies Prise En Charge Par Le Projet](#technologies-prise-en-charge-par-le-projet-) 🚀 +- [Installation](#installation-) 🔧 +- [Utilisation](#utilisation-) 🛠️ +- [Auteurs](#auteurs-) 👥 +- [Contact](#contact-) 📞 -- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files -- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command: +## Technologies Utilisées 💻 -``` -cd existing_repo -git remote add origin https://git.unilim.fr/odabasioglu1/sae5.git -git branch -M main -git push -uf origin main +- ![Kotlin](https://img.shields.io/badge/Kotlin-0095D5?style=flat&logo=kotlin&logoColor=white) +- ![JetPack Compose](https://img.shields.io/badge/Jetpack%20Compose-6200EE?style=flat&logo=android&logoColor=white) + +## Technologies Prise En Charge Par Le Projet 🚀 + +- ![Kotlin](https://img.shields.io/badge/Kotlin-0095D5?style=flat&logo=kotlin&logoColor=white) +- ![Java](https://img.shields.io/badge/Java-007396?style=flat&logo=java&logoColor=white) +- ![Python](https://img.shields.io/badge/Python-3776AB?style=flat&logo=python&logoColor=white) +- ![JavaScript](https://img.shields.io/badge/JavaScript-F7DF1E?style=flat&logo=javascript&logoColor=black) + +## Installation 🔧 + +Pour installer Quali'Nomme, suivez les étapes suivantes : + +1. Clonez le dépôt + +```sh +git clone ``` -## Integrate with your tools +2. Installez les dépendances -- [ ] [Set up project integrations](http://git.unilim.fr/odabasioglu1/sae5/-/settings/integrations) +```sh +./gradlew build +``` -## Collaborate with your team +3. Exécutez le projet -- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/) -- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html) -- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically) -- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/) -- [ ] [Automatically merge when pipeline succeeds](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html) +```sh +./gradlew run +``` -## Test and Deploy +## Utilisation 🛠️ -Use the built-in continuous integration in GitLab. +Pour utiliser Quali'Nomme, suivez les étapes suivantes : -- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html) -- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing(SAST)](https://docs.gitlab.com/ee/user/application_security/sast/) -- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html) -- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/) -- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html) +1. Ajoutez un ou plusieurs glossaires en fonction des besoins du projet. +2. Parsez un code ou un projet pour identifier les termes métiers utilisés et leur fréquence. +3. Comparez les termes saisis dans les glossaires et ceux identifiés dans le code. +4. Visualisez les données comparatives pour une meilleure compréhension. +5. Améliorez la qualité de nommage dans le code. +6. Répétez les étapes 2 à 5 pour chaque itération du projet. -*** +## Auteurs 👥 -# Editing this README +- [Maxime CAPEL](https://github.com/fortyup/) +- [Thomas BREIL](https://github.com/ThomasBreil) +- [Bayram Gokcen](https://github.com/ByrmGkcn) +- [Cemal ODABASIOGLU](https://github.com/sonwayy) +- [Clement Carpentier](https://github.com/ClementCrpt) -When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thank you to [makeareadme.com](https://www.makeareadme.com/) for this template. +## Contact 📞 -## Suggestions for a good README -Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information. - -## Name -Choose a self-explaining name for your project. - -## Description -Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors. - -## Badges -On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge. - -## Visuals -Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method. - -## Installation -Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection. - -## Usage -Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README. - -## Support -Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc. - -## Roadmap -If you have ideas for releases in the future, it is a good idea to list them in the README. - -## Contributing -State if you are open to contributions and what your requirements are for accepting them. - -For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self. - -You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser. - -## Authors and acknowledgment -Show your appreciation to those who have contributed to the project. - -## License -For open source projects, say how it is licensed. - -## Project status -If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers. +Pour toute question, veuillez contacter l'équipe de développement. diff --git a/src/main/kotlin/main/Form.kt b/src/main/kotlin/main/Form.kt index fa57ae3..96b824e 100644 --- a/src/main/kotlin/main/Form.kt +++ b/src/main/kotlin/main/Form.kt @@ -189,7 +189,7 @@ fun formPage(glossary: Glossary, onCancelClick: () -> Unit) { ) { listToShow.forEach { word -> - + item { Box( modifier = Modifier diff --git a/src/main/kotlin/main/Glossary.kt b/src/main/kotlin/main/Glossary.kt index 01a67c8..1d2ae44 100644 --- a/src/main/kotlin/main/Glossary.kt +++ b/src/main/kotlin/main/Glossary.kt @@ -26,6 +26,8 @@ import java.io.File import java.io.FileInputStream import java.io.FileWriter import java.io.IOException +import javax.swing.JFileChooser +import javax.swing.filechooser.FileSystemView data class Glossary(val name: String, val jsonFilePath: String) @@ -354,6 +356,21 @@ fun selectFile(extensions: Set, onFileSelected: (String) -> Unit) { frame.dispose() } + +fun selectDirectory(onDirectorySelected: (String) -> Unit) { + val fileChooser = JFileChooser(FileSystemView.getFileSystemView().homeDirectory) + fileChooser.fileSelectionMode = JFileChooser.DIRECTORIES_ONLY + + val returnValue = fileChooser.showDialog(null, "Select") + if (returnValue == JFileChooser.APPROVE_OPTION) { + val selectedDirectory = fileChooser.selectedFile.absolutePath + println("Selected directory: $selectedDirectory") + onDirectorySelected(selectedDirectory) + } else { + println("Open command cancelled by user.") + } +} + fun exportToCSV(glossary: Glossary, csvFilePath: String) { val glossary = loadDatasFromFile(glossary.jsonFilePath) val csvContent = buildString { diff --git a/src/main/kotlin/main/Main.kt b/src/main/kotlin/main/Main.kt index 1de9d3b..9dbf6c6 100644 --- a/src/main/kotlin/main/Main.kt +++ b/src/main/kotlin/main/Main.kt @@ -10,7 +10,6 @@ import androidx.compose.ui.graphics.Color import androidx.compose.ui.res.painterResource import androidx.compose.ui.unit.dp import androidx.compose.ui.window.* -import main.AppState.selectedGlossary import java.awt.FileDialog import java.awt.Frame import java.io.File @@ -182,6 +181,13 @@ fun app() { choixLangagePage( languageManager, onBackClick = { currentPage.value = "accueil" }, + onKotlinClick = { + selectDirectory() { onDirectorySelected -> + mostUsedWordList = directoryParse(onDirectorySelected) // Change by parser functions + println("Kotlin directory selected: $onDirectorySelected") + currentPage.value = "occurrence" + } + }, onPythonClick = { selectFile(pythonExtensions) { filePath -> println("Python file selected: $filePath") // Change by parser functions @@ -194,7 +200,7 @@ fun app() { }, onJavaScriptClick = { selectFile(jsExtensions) { filePath -> - mostUsedWordList = parser(filePath) // Change by parser functions + mostUsedWordList = parserJS(filePath) // Change by parser functions isJavaScriptFileSelected = true } }, diff --git a/src/main/kotlin/main/Verify.kt b/src/main/kotlin/main/Verify.kt index 56e1a14..1c96504 100644 --- a/src/main/kotlin/main/Verify.kt +++ b/src/main/kotlin/main/Verify.kt @@ -16,6 +16,7 @@ import main.component.dropdownButtonComponent fun choixLangagePage( languageManager: LanguageManager, onBackClick: () -> Unit, + onKotlinClick: () -> Unit, onPythonClick: () -> Unit, onJavaClick: () -> Unit, onJavaScriptClick: () -> Unit, @@ -42,6 +43,19 @@ fun choixLangagePage( horizontalAlignment = Alignment.CenterHorizontally ) { + Button( + onClick = onKotlinClick, + modifier = Modifier + .width(150.dp), + colors = ButtonDefaults.buttonColors( + backgroundColor = customRedColor, + contentColor = Color.White + ), + enabled = true + ) { + Text("Kotlin") + } + Button( onClick = onPythonClick, modifier = Modifier diff --git a/src/main/kotlin/main/parser.kt b/src/main/kotlin/main/parser.kt index 333a5dd..34632d2 100644 --- a/src/main/kotlin/main/parser.kt +++ b/src/main/kotlin/main/parser.kt @@ -1,8 +1,6 @@ package main -import androidx.compose.ui.text.toLowerCase import java.io.File -import java.util.* fun delStrings(line : String) : String { @@ -45,11 +43,13 @@ fun splitLanguages(file : String){ } } + + } -fun parser(fileName : String) : MutableMap { +fun parserJS(fileName : String) : MutableMap { val delimiter1 = " " val regex = "[^a-zA-Z^éà]".toRegex() val array = mutableListOf() @@ -70,3 +70,41 @@ fun parser(fileName : String) : MutableMap { } +fun ktWords(code : Map) : Map{ + val js = File("src/main/kotlin/main/sampleKt.txt").readText().split(",") + + return code.filter { it.key !in js } +} +fun parserKt(fileName : String) : MutableMap { + val delimiter1 = " " + val regex = "[^a-zA-Z^éà]".toRegex() + val array = mutableListOf() + + val line = delStrings(File(fileName).readText()).replace(regex, " ") + line.split(delimiter1).forEach { + + if (it != "") { + array.add(it) + } + } + val map = ktWords(array.groupingBy { it }.eachCount()) + + return map.toMutableMap() +} + + +fun directoryParse(directory : String) : MutableMap { + val files = File(directory).walk().filter { it.isFile }.toList() + val map = mutableMapOf() + files.forEach { + + + if (it.extension == "kt" && it.toString().contains("bin") == false) { + println(it.absolutePath) + val map2 = parserKt(it.toString()) + map2.forEach { (t, u) -> map[t] = map.getOrDefault(t, 0) + u } + } + + } + return map +} diff --git a/src/main/kotlin/main/sampleKt.txt b/src/main/kotlin/main/sampleKt.txt new file mode 100644 index 0000000..9469ef6 --- /dev/null +++ b/src/main/kotlin/main/sampleKt.txt @@ -0,0 +1 @@ +androidx,abstract,actual,annotation,anonymous,apply,as,as?,assert,break,by,byte,catch,char,class,companion,const,constructor,continue,crossinline,data,delegate,do,double,dynamic,else,enum,expect,external,false,field,file,final,finally,float,for,fun,get,if,implements,import,in,infix,init,inline,inner,interface,internal,is,it,lateinit,long,module,native,new,noinline,null,object,open,operator,out,override,package,private,protected,public,receiver,reified,return,sealed,set,short,super,suspend,tailrec,this,throw,true,try,typealias,typeof,val,var,vararg,when,where,while,abstract,actual,annotation,anonymous,apply,as,as?,assert,break,by,byte,catch,char,class,companion,const,constructor,continue,crossinline,data,delegate,do,double,dynamic,else,enum,expect,external,false,field,file,final,finally,float,for,fun,get,if,implements,import,in,infix,init,inline,inner,interface,internal,is,it,lateinit,long,module,native,new,noinline,null,object,open,operator,out,override,package,private,protected,public,receiver,reified,return,sealed,set,short,super,suspend,tailrec,this,throw,true,try,typealias,typeof,val,var,vararg,when,where,while,AccessibleObject,BitSet,Calendar,Date,GregorianCalendar,Locale,Objects,Observable,Optional,Random,Timer,TimeZone,UUID,Vector,AbstractCollection,AbstractList,AbstractMap,AbstractQueue,AbstractSequentialList,AbstractSet,ArrayList,Arrays,Base64,Calendar,Collections,Comparator,Date,DateFormat,DateFormatSymbols,DecimalFormat,EnumMap,EnumSet,GregorianCalendar,HashMap,HashSet,Hashtable,IdentityHashMap,LinkedHashMap,LinkedHashSet,LinkedList,ListResourceBundle,Locale,Objects,Observable,Optional,PriorityQueue,Properties,PropertyPermission,Random,ResourceBundle,Scanner,SimpleTimeZone,Stack,StringTokenizer,Timer,TimeZone,TreeMap,TreeSet,UUID,Vector,WeakHashMap,AssertionError,Exception,RuntimeException,ArithmeticException,ArrayIndexOutOfBoundsException,ClassCastException,ClassNotFoundException,CloneNotSupportedException,EnumConstantNotPresentException,IllegalAccessException,IllegalArgumentException,IllegalMonitorStateException,IllegalStateException,IllegalThreadStateException,IndexOutOfBoundsException,InstantiationException,InterruptedException,NegativeArraySizeException,NoSuchFieldException,NoSuchMethodException,NullPointerException,NumberFormatException,ReflectiveOperationException,SecurityException,StringIndexOutOfBoundsException,TypeNotPresentException,UnsupportedOperationException \ No newline at end of file diff --git a/src/test/kotlin/ParserTest.kt b/src/test/kotlin/ParserTest.kt index 11dbd24..fabb1d9 100644 --- a/src/test/kotlin/ParserTest.kt +++ b/src/test/kotlin/ParserTest.kt @@ -63,11 +63,11 @@ class ParserTest { val puissance4File = "src/test/resources/puissance4.html" // Call the parser function - parser(puissance4File) + parserJS(puissance4File) // Verify the output by capturing the printed content val printedContent = captureStandardOutput { - parser(puissance4File) + parserJS(puissance4File) } // Assert the expected output based on the content of your sample HTML file