diff --git a/README.md b/README.md index 10287ca..d0a1af1 100644 --- a/README.md +++ b/README.md @@ -1,83 +1,8 @@ # Project #1 - Library Project using Dart - -Congratulations on reaching the project phase! This project will assess your ability to develop a "Library Project using Dart" with a Command Line Interface (CLI) to manage a library's book inventory and user interactions. Below are the key requirements and evaluation criteria: - - -## Description: - -The "Library Project using Dart" is an exciting software application designed to efficiently manage a library's book inventory and streamline user interactions through a Command Line Interface (CLI). This capstone project provides you, as a student, with an excellent opportunity to apply your knowledge and skills in Flutter Development, showcasing your proficiency in Dart programming. - -The primary goal of the project is to develop a user-friendly and efficient CLI that caters to both library staff and patrons. With this CLI, users can effortlessly query books, view the number of available copies, add new books to the library, delete books from the inventory, make book purchases, and receive detailed invoices after each purchase. Additionally, the project demands an essential feature - updating the number of book copies after a purchase is made to maintain accurate inventory records. - -To begin, you will create a new Dart project, ensuring that the project structure is appropriately organized for a clean and manageable codebase. As you progress, it is crucial to write code that is clear, well-organized, and scalable, adhering to standard coding conventions to enhance code readability. Demonstrating your comprehensive understanding of programming concepts and techniques is essential for a successful outcome. - -Your CLI should allow users to search for books by title, author, or category, providing a straightforward and accessible way to retrieve information about the library's collection. Implementing a method to add new books to the library with the appropriate updates to the book count will further enhance the system's usability. - -Managing the library's inventory also involves implementing a method to delete books, ensuring smooth handling of cases where a book to be deleted does not exist. Facilitating book purchases through the CLI is another critical aspect, requiring you to decrease the number of book copies according to the books purchased and generate an informative invoice for the user. - -As an extra credit opportunity, you can implement features such as displaying all book categories in the library, returning a list of books belonging to a selected category. Additionally, providing a method to count the number of purchased books will further showcase your skills. - -The project must be written entirely in the Dart language and fully submitted through GitHub using version control (Git). Remember to create descriptive commits to showcase your progress and follow the provided guidelines for academic integrity. - - - -## Minimum Requirements: - -1. **Project Structure**: Create a new Dart project and organize its structure appropriately. Set up the necessary folders, files, and ensure a clean and organized project layout. - -2. **Clean Code**: Write clear, well-organized, and scalable code. Use meaningful variable and function names, following standard coding conventions to improve code readability. Well-structured and easily maintainable code is essential. - -3. **Applying Concepts**: Demonstrate a comprehensive understanding of programming concepts and techniques. Implement the CLI features with efficiency and correctness. - -4. **Query Books**: Develop a simple CLI user interface that allows users to query books and view the number of available copies. Users should be able to search for books by title, author, or category. - -5. **Add New Book**: Provide a method to add a new book to the library and update the number of book copies accordingly. Ensure proper error handling for invalid inputs. - -6. **Delete Book**: Implement a method to delete a book from the library and update the book count. Handle cases where the book to be deleted does not exist. - -7. **Purchase**: Implement the purchase process, allowing users to buy books from the library. Ensure that the number of book copies is decreased according to the books purchased. - -8. **Invoice**: Display a detailed invoice after the purchase, showing the books purchased, their prices, and the total cost. - -9. **Editing Capability**: Add the ability to modify book data, such as title, author, and price. Users should be able to update book information easily. - -## Ideas for Extra Credit: - -- **Display all Book Categories**: Provide a method to display a list of all book categories in the library. When a category is selected, return a list of all books belonging to that category. -- **Reporting:** Provide a method to present a report that contains the number of all purchased books from the library, and calculate their amount. - - -## Delivery Requirements: - -- **Language**: The project should be written in Dart language. - -- **GitHub Submission**: - - Create a Fork from the exam’s GitHub repository. - - Create a new branch with your name, i.e., Nawaf-Alshawan. - - Commit frequently with descriptive messages to show your progress. - - Finally, create a Pull Request to the exam’s original repository containing your solution. - -- **README.md File**: Include a README.md file with instructions on how to run and test the project. This file should provide a clear guide for users to understand how to interact with the CLI. - -- **Screenshots**: Include relevant screenshots of the app to showcase its appearance and functionalities. Visuals can help users understand the app's design and layout. - -## Schedule & Deadlines: - -- Exam Start Date: 27/7/2023 - 3:00 PM -- Exam Submission Deadline: 30/7/2023 – 11:59 PM - -## Evaluation Criteria: - -The project will be evaluated based on the following criteria: - -- **Completion**: The extent to which the project meets all the minimum requirements, including the extra credit ideas if implemented. - -- **Quality**: The overall quality of the project, including the coding style, organization, and ease of maintenance. Well-structured and readable code will be favorably evaluated. - -- **Use of Programming Concepts**: How well you utilize programming concepts such as classes, abstracts, functions, and other relevant techniques. - -## Resources - -- [Dart Tutorials](https://dart.dev/tutorials) - -Good luck with the project, and feel free to ask any additional questions if needed! +In this project i made a simple library management system that has a lot of services like adding a book or deleting, +- first of all i wanted the services that change the data of the system seperated from the other services so i made two users Admin or a client +and because this is not a real life application i made the password ='1234' easily accessed just for testing the app. +- if you choose that you are an admin you have to enter the password else you can enter the client menu easiely. +- all the choices in the application are choosen by entering a number. +- you can add multiable catagories when adding a book and when you are finished just press 'q'. +Screenshot 2023-07-30 213626 diff --git a/library_cli/.gitignore b/library_cli/.gitignore new file mode 100644 index 0000000..3c8a157 --- /dev/null +++ b/library_cli/.gitignore @@ -0,0 +1,6 @@ +# Files and directories created by pub. +.dart_tool/ +.packages + +# Conventional directory for build output. +build/ diff --git a/library_cli/CHANGELOG.md b/library_cli/CHANGELOG.md new file mode 100644 index 0000000..effe43c --- /dev/null +++ b/library_cli/CHANGELOG.md @@ -0,0 +1,3 @@ +## 1.0.0 + +- Initial version. diff --git a/library_cli/README.md b/library_cli/README.md new file mode 100644 index 0000000..3816eca --- /dev/null +++ b/library_cli/README.md @@ -0,0 +1,2 @@ +A sample command-line application with an entrypoint in `bin/`, library code +in `lib/`, and example unit test in `test/`. diff --git a/library_cli/analysis_options.yaml b/library_cli/analysis_options.yaml new file mode 100644 index 0000000..dee8927 --- /dev/null +++ b/library_cli/analysis_options.yaml @@ -0,0 +1,30 @@ +# This file configures the static analysis results for your project (errors, +# warnings, and lints). +# +# This enables the 'recommended' set of lints from `package:lints`. +# This set helps identify many issues that may lead to problems when running +# or consuming Dart code, and enforces writing Dart using a single, idiomatic +# style and format. +# +# If you want a smaller set of lints you can change this to specify +# 'package:lints/core.yaml'. These are just the most critical lints +# (the recommended set includes the core lints). +# The core lints are also what is used by pub.dev for scoring packages. + +include: package:lints/recommended.yaml + +# Uncomment the following section to specify additional rules. + +# linter: +# rules: +# - camel_case_types + +# analyzer: +# exclude: +# - path/to/excluded/files/** + +# For more information about the core and recommended set of lints, see +# https://dart.dev/go/core-lints + +# For additional information about configuring this file, see +# https://dart.dev/guides/language/analysis-options diff --git a/library_cli/bin/books_data.dart b/library_cli/bin/books_data.dart new file mode 100644 index 0000000..d3ac3e2 --- /dev/null +++ b/library_cli/bin/books_data.dart @@ -0,0 +1,31 @@ +//my books are saved in a list of maps +final List booksList = [ + { + 'title': 'the blue elephant', + 'author': 'ahmed mourad', + 'category': ['mystery', 'thriller'], + 'avaliable copies': 5, + 'price': 10.0 + }, + { + 'title': 'the handmaid tale', + 'author': 'margaret atoowd', + 'category': ['science', 'fiction'], + 'avaliable copies': 3, + 'price': 8.0 + }, + { + 'title': 'the invisible man', + 'author': 'mohammed reda', + 'category': ['short stories', 'fiction'], + 'avaliable copies': 8, + 'price': 12.0 + }, + { + 'title': 'memory of the body', + 'author': 'ahlam mosteghanemi', + 'category': ['fiction', 'romance'], + 'avaliable copies': 2, + 'price': 7.0 + } +]; diff --git a/library_cli/bin/class_book.dart b/library_cli/bin/class_book.dart new file mode 100644 index 0000000..bd78797 --- /dev/null +++ b/library_cli/bin/class_book.dart @@ -0,0 +1,20 @@ +class Book { + late String title; + late String author; + late List category; + late int numCopies; // number of avaliable books + late double price; + + //constructor .. + Book( + {required this.title, + required this.author, + required this.category, + required this.numCopies, + required this.price}); + +// a method to display the books + display() { + print('Title: $title, Author: $author, Category: $category, Avaliable copies: $numCopies, Price: $price'); + } +} diff --git a/library_cli/bin/library_cli.dart b/library_cli/bin/library_cli.dart new file mode 100644 index 0000000..e4bf629 --- /dev/null +++ b/library_cli/bin/library_cli.dart @@ -0,0 +1,94 @@ +import 'books_data.dart'; +import 'class_book.dart'; +import 'library_methods.dart'; +import 'dart:io'; + +void main() { + + //adding the data to a list of book object + List booklist = []; + for (int i = 0; i < booksList.length; i++) { + booklist.add(Book( + title: booksList[i]['title'], + author: booksList[i]['author'], + category: booksList[i]['category'], + numCopies: booksList[i]['avaliable copies'], + price: booksList[i]['price'])); + } + /* for (var element in booklist) { + element.display(); + }*/ + + int adminPass = 1234; // a password to enter the the library's admin menu + + print("Hello, Welcome to Reema's Library!!"); + + print('Choose are you an 1-Admin or 2-Client (1 or 2): '); + int userType = int.parse(stdin.readLineSync()!); + + //if the user choose 1 he has to give the password so that he can add or delete a book + if (userType == 1) { + print('Enter the password:'); + int passCheck = int.parse(stdin.readLineSync()!); + //check if the password is correct + if (passCheck == adminPass) { + //Correct --> displaying the admin menu + var count = 0; + + while (count < 10) { + print("please select a number from the admin menu for any services: "); + + print(" 1:Add new book\n 2:Delete a book\n 3:Edit a book\n 4: quit"); + + int selectedNum = int.parse(stdin.readLineSync()!); + switch (selectedNum) { + case 1: + addBook(booklist); + break; + case 2: + deleteBook(booklist); + break; + case 3: + editBooks(booklist); + break; + case 4: + exit(0); + default: + print("Wrong choice, Please choose from the menu"); + } + count++; + } + } else { + print("Wrong password try again"); + } + //else if for the outer if statement + } else if (userType == 2) { + var count = 0; + while (count < 10) { + print('please select a number from the client menu for any services:'); + print( + " 1:Purchase a book\n 2:Search for a book\n 3:Display all the catgories\n 4: quit"); + + int selectedNum = int.parse(stdin.readLineSync()!); + switch (selectedNum) { + case 1: + purchaseBook(booklist); + break; + case 2: + searchBooks(booklist); + break; + case 3: + catagoryDisplay(booklist); + break; + case 4: + exit(0); + default: + print("Wrong choice, Please choose from the menu"); + } + count++; + } + //else for the outer if statement if the user did not choose 1 or 2 + } else { + print('wrong number choose 1 or 2'); + } +} diff --git a/library_cli/bin/library_methods.dart b/library_cli/bin/library_methods.dart new file mode 100644 index 0000000..d5ffbec --- /dev/null +++ b/library_cli/bin/library_methods.dart @@ -0,0 +1,193 @@ +// this file has all the methods for the library application to make the file more clean +// ignore_for_file: iterable_contains_unrelated_type + +import 'dart:io'; +import 'class_book.dart'; + +// method for adding a new book +addBook(List bookList) { + //enter all the book information + try { + print("please enter the name of the book:"); + String titlein = stdin.readLineSync()!; + + print("please enter the author name: "); + String authorin = stdin.readLineSync()!; + + print("please enter the price of the book: "); + double pricein = double.parse(stdin.readLineSync()!); + + print("please enter the number of avaliable copies of the book:"); + int numCopiesin = int.parse(stdin.readLineSync()!); + + print("please enter the catagories of the book:(press q for stopping)"); + List categoryin = []; + do { + String enterCatagory = stdin.readLineSync()!; + if (enterCatagory == "q") { + break; + } else { + categoryin.add(enterCatagory.toLowerCase().trim()); + } + } while (true); + //add all the information into an object + + bookList.add(Book( + title: titlein, + author: authorin, + category: categoryin, + numCopies: numCopiesin, + price: pricein)); + + print("Your book has been added successfully"); + + //update the number of copies + if (bookList.contains(titlein)) { + for (var item in bookList) { + if (item.title == titlein) { + item.numCopies += numCopiesin; + } + } + } + } catch (error) { + print("error $error"); + } +} + +// method for deleting a book +deleteBook(List bookList) { + //enter all the book information + print("please enter the name of the book you want to delete:"); + String titlein = stdin.readLineSync()!; + if (bookList.contains(titlein.toLowerCase().trim())) { + print("please enter the number of copies you want to delete:"); + int numCopiesin = int.parse(stdin.readLineSync()!); + //delete and update the number of copies + for (var item in bookList) { + if (item.title == titlein) { + if (item.numCopies < numCopiesin) { + item.numCopies -= numCopiesin; + print('the book {$item.title} is deleted successfully!'); + } else if (item.numCopies == numCopiesin) { + int index = bookList.indexWhere((element) => element == item); + bookList.removeAt(index); + print('the book {$item.title} is deleted successfully!'); + } else { + print('sorry the number of books exceeds the avaliable'); + } + } + } + } else { + print('there is no book with this name check again'); + } +} + +//method for query books through title, category, author and display the number of avaliable copies +searchBooks(List bookList) { + print( + 'please enter your search (you can search by author or category or title):'); + String text = stdin.readLineSync()!; + if (bookList.contains(text)) { + for (var item in bookList) { + if (item.title == text.toLowerCase().trim()) { + item.display(); + } else if (item.author == text.toLowerCase().trim()) { + item.display(); + } else if (item.category.contains(text.toLowerCase().trim())) { + item.display(); + } else { + print("No item with this name please try again"); + } + } + } +} + +//method for purchasing the book and printing the invoice +purchaseBook(List bookList) { + //enter all the book information + print("please enter the name of the book you want to purchase:"); + String titlein = stdin.readLineSync()!; + if (bookList.contains(titlein.toLowerCase().trim())) { + print("please enter the number of copies you want to purchase:"); + int numCopiesin = int.parse(stdin.readLineSync()!); + //purchase and update the number of copies + for (var item in bookList) { + if (item.title == titlein) { + double total = item.price * numCopiesin; + if (item.numCopies < numCopiesin) { + item.numCopies -= numCopiesin; + print('the book is purchased successfully!'); + print( + 'your invoice is:\nBook --- Price\n{$item.title} --- {$item.price}\nTotal cost:$total'); + } else if (item.numCopies == numCopiesin) { + int index = bookList.indexWhere((element) => element == item); + bookList.removeAt(index); + print('the book is purchased successfully!'); + print( + 'your invoice is:\nBook --- Price\n{$item.title} --- {$item.price}\nTotal cost:$total'); + } else { + print('sorry the number of books exceeds the avaliable'); + } + } + } + } else { + print('there is no book with this name check again'); + } +} + +//method for editing the book informations +editBooks(List bookList) { + print('what do you want to edit:'); + print('1:title,\n2:author,\n3:catagory'); + int choice = int.parse(stdin.readLineSync()!); + + print('enter the origional item'); + String orgText = stdin.readLineSync()!.toLowerCase().trim(); + + print('enter the edit'); + String editText = stdin.readLineSync()!.toLowerCase().trim(); + + switch (choice) { + case 1: + for (var item in bookList) { + if (item.title == orgText) { + item.title = editText; + print('edit is successful'); + } + } + break; + case 2: + for (var item in bookList) { + if (item.author == orgText) { + item.author = editText; + print('edit is successful'); + } + } + break; + case 3: + for (var item in bookList) { + if (item.category.contains(orgText)) { + item.category = [editText]; + print('edit is successful'); + } + } + break; + } +} + +//method for displaying all Book Categories +catagoryDisplay(List bookList) { + print('Our catagories:'); + for (var item in bookList) { + print(item.category); + } + print('enter the catagory you want:'); + String catagory = stdin.readLineSync()!; + for (var item in bookList) { + if (item.category.contains(catagory)) { + item.display(); + } else { + print('wrong name'); + } + } +} diff --git a/library_cli/lib/library_cli.dart b/library_cli/lib/library_cli.dart new file mode 100644 index 0000000..f64ad72 --- /dev/null +++ b/library_cli/lib/library_cli.dart @@ -0,0 +1,3 @@ +int calculate() { + return 6 * 7; +} diff --git a/library_cli/pubspec.lock b/library_cli/pubspec.lock new file mode 100644 index 0000000..62b3be9 --- /dev/null +++ b/library_cli/pubspec.lock @@ -0,0 +1,327 @@ +# Generated by pub +# See https://dart.dev/tools/pub/glossary#lockfile +packages: + _fe_analyzer_shared: + dependency: transitive + description: + name: _fe_analyzer_shared + url: "https://pub.dartlang.org" + source: hosted + version: "54.0.0" + analyzer: + dependency: transitive + description: + name: analyzer + url: "https://pub.dartlang.org" + source: hosted + version: "5.6.0" + args: + dependency: transitive + description: + name: args + url: "https://pub.dartlang.org" + source: hosted + version: "2.4.1" + async: + dependency: transitive + description: + name: async + url: "https://pub.dartlang.org" + source: hosted + version: "2.11.0" + boolean_selector: + dependency: transitive + description: + name: boolean_selector + url: "https://pub.dartlang.org" + source: hosted + version: "2.1.1" + collection: + dependency: transitive + description: + name: collection + url: "https://pub.dartlang.org" + source: hosted + version: "1.18.0" + convert: + dependency: transitive + description: + name: convert + url: "https://pub.dartlang.org" + source: hosted + version: "3.1.1" + coverage: + dependency: transitive + description: + name: coverage + url: "https://pub.dartlang.org" + source: hosted + version: "1.6.3" + crypto: + dependency: transitive + description: + name: crypto + url: "https://pub.dartlang.org" + source: hosted + version: "3.0.2" + file: + dependency: transitive + description: + name: file + url: "https://pub.dartlang.org" + source: hosted + version: "6.1.4" + frontend_server_client: + dependency: transitive + description: + name: frontend_server_client + url: "https://pub.dartlang.org" + source: hosted + version: "3.2.0" + glob: + dependency: transitive + description: + name: glob + url: "https://pub.dartlang.org" + source: hosted + version: "2.1.1" + http_multi_server: + dependency: transitive + description: + name: http_multi_server + url: "https://pub.dartlang.org" + source: hosted + version: "3.2.1" + http_parser: + dependency: transitive + description: + name: http_parser + url: "https://pub.dartlang.org" + source: hosted + version: "4.0.2" + io: + dependency: transitive + description: + name: io + url: "https://pub.dartlang.org" + source: hosted + version: "1.0.4" + js: + dependency: transitive + description: + name: js + url: "https://pub.dartlang.org" + source: hosted + version: "0.6.5" + lints: + dependency: "direct dev" + description: + name: lints + url: "https://pub.dartlang.org" + source: hosted + version: "2.0.1" + logging: + dependency: transitive + description: + name: logging + url: "https://pub.dartlang.org" + source: hosted + version: "1.1.1" + matcher: + dependency: transitive + description: + name: matcher + url: "https://pub.dartlang.org" + source: hosted + version: "0.12.16" + meta: + dependency: transitive + description: + name: meta + url: "https://pub.dartlang.org" + source: hosted + version: "1.9.1" + mime: + dependency: transitive + description: + name: mime + url: "https://pub.dartlang.org" + source: hosted + version: "1.0.4" + node_preamble: + dependency: transitive + description: + name: node_preamble + url: "https://pub.dartlang.org" + source: hosted + version: "2.0.2" + package_config: + dependency: transitive + description: + name: package_config + url: "https://pub.dartlang.org" + source: hosted + version: "2.1.0" + path: + dependency: transitive + description: + name: path + url: "https://pub.dartlang.org" + source: hosted + version: "1.8.3" + pool: + dependency: transitive + description: + name: pool + url: "https://pub.dartlang.org" + source: hosted + version: "1.5.1" + pub_semver: + dependency: transitive + description: + name: pub_semver + url: "https://pub.dartlang.org" + source: hosted + version: "2.1.4" + shelf: + dependency: transitive + description: + name: shelf + url: "https://pub.dartlang.org" + source: hosted + version: "1.4.1" + shelf_packages_handler: + dependency: transitive + description: + name: shelf_packages_handler + url: "https://pub.dartlang.org" + source: hosted + version: "3.0.2" + shelf_static: + dependency: transitive + description: + name: shelf_static + url: "https://pub.dartlang.org" + source: hosted + version: "1.1.2" + shelf_web_socket: + dependency: transitive + description: + name: shelf_web_socket + url: "https://pub.dartlang.org" + source: hosted + version: "1.0.4" + source_map_stack_trace: + dependency: transitive + description: + name: source_map_stack_trace + url: "https://pub.dartlang.org" + source: hosted + version: "2.1.1" + source_maps: + dependency: transitive + description: + name: source_maps + url: "https://pub.dartlang.org" + source: hosted + version: "0.10.12" + source_span: + dependency: transitive + description: + name: source_span + url: "https://pub.dartlang.org" + source: hosted + version: "1.10.0" + stack_trace: + dependency: transitive + description: + name: stack_trace + url: "https://pub.dartlang.org" + source: hosted + version: "1.11.1" + stream_channel: + dependency: transitive + description: + name: stream_channel + url: "https://pub.dartlang.org" + source: hosted + version: "2.1.1" + string_scanner: + dependency: transitive + description: + name: string_scanner + url: "https://pub.dartlang.org" + source: hosted + version: "1.2.0" + term_glyph: + dependency: transitive + description: + name: term_glyph + url: "https://pub.dartlang.org" + source: hosted + version: "1.2.1" + test: + dependency: "direct dev" + description: + name: test + url: "https://pub.dartlang.org" + source: hosted + version: "1.24.3" + test_api: + dependency: transitive + description: + name: test_api + url: "https://pub.dartlang.org" + source: hosted + version: "0.6.0" + test_core: + dependency: transitive + description: + name: test_core + url: "https://pub.dartlang.org" + source: hosted + version: "0.5.3" + typed_data: + dependency: transitive + description: + name: typed_data + url: "https://pub.dartlang.org" + source: hosted + version: "1.3.2" + vm_service: + dependency: transitive + description: + name: vm_service + url: "https://pub.dartlang.org" + source: hosted + version: "11.2.0" + watcher: + dependency: transitive + description: + name: watcher + url: "https://pub.dartlang.org" + source: hosted + version: "1.0.2" + web_socket_channel: + dependency: transitive + description: + name: web_socket_channel + url: "https://pub.dartlang.org" + source: hosted + version: "2.4.0" + webkit_inspection_protocol: + dependency: transitive + description: + name: webkit_inspection_protocol + url: "https://pub.dartlang.org" + source: hosted + version: "1.2.0" + yaml: + dependency: transitive + description: + name: yaml + url: "https://pub.dartlang.org" + source: hosted + version: "3.1.1" +sdks: + dart: ">=2.18.0 <3.0.0" diff --git a/library_cli/pubspec.yaml b/library_cli/pubspec.yaml new file mode 100644 index 0000000..2e21bc7 --- /dev/null +++ b/library_cli/pubspec.yaml @@ -0,0 +1,14 @@ +name: library_cli +description: A sample command-line application. +version: 1.0.0 +# homepage: https://www.example.com + +environment: + sdk: '>=2.18.0 <3.0.0' + +# dependencies: +# path: ^1.8.0 + +dev_dependencies: + lints: ^2.0.0 + test: ^1.16.0 diff --git a/library_cli/test/library_cli_test.dart b/library_cli/test/library_cli_test.dart new file mode 100644 index 0000000..0ce4ecd --- /dev/null +++ b/library_cli/test/library_cli_test.dart @@ -0,0 +1,8 @@ +import 'package:library_cli/library_cli.dart'; +import 'package:test/test.dart'; + +void main() { + test('calculate', () { + expect(calculate(), 42); + }); +}