CPSC 421-010 Object-Oriented Programming (OOP) Spring 2023

Archive

• Week 4 Class 8 Thu Feb 02 Posted: Feb 02

  After Class

  • Crosswords

    Crossword Labs had an update in the past couple of days. Printing is much more standard. So now you can

    1. Print using the Print feature in your browser
    2. Use the print button

  • Project 1 v1d General principles that I carefully went over and emphasized, but are being overlooked.

    • A design change must not break the build. If you extract a function and the program does not build, you must fix it before going on. E.g., make
    • A design change must not change the output of the program. If you extract a function and the output of the program is not the same, you must fix it before going on. E.g., make run, and verify the result.
    • Proper Direction of parameters
    • XML Interface Concepts are the only things that our XML functions can pass OUT.
    • Accessor::Predicate Stereotype
    • When to Use an Accessor::Predicate Stereotype

  Announcements

  • A question was raised that either Aggregate.hpp or Aggregate.cpp did not have a newline at the EOF for one of the commits. For a demonstration that they did, Rainfall-010
  • Spring 2023 Career Fair Class attendance is still expected. If you want to attend the other section of OOP, email me for class to check
  • Project 1 Do not wait until the last minute. This part is much more involved and have you extracting multiple functions.

  • Project 1 Pull Request

    I created a pull request for Project 1 to create the (empty) files, xml_parser.hpp and xml_parser.cpp for part v1d. The easiest way to merge this into your code is the Merge pull request at GitHub. Once you merge, then remember to do a git pull in all of your cloned repositories.

    Note that xml_parser.{hpp,cpp} expands to xml_parser.hpp and xml_parser.cpp in a shell.

  • Guide: srcML

  Class

  • Notes: Concerns

  • Exercise 16: srcFacts Concerns- Handout in class, due by the end of the class meeting

    • srcFacts.cpp#L433-L473
    • srcFacts.cpp#L283-L292
    • srcFacts.cpp#L548-L556
    • srcFacts.cpp#L317-L324
  • Exercise 17: Concerns Crossword
  • Notes: Vertical Development
  • Interlude: Guide: Benchmarks
  • Notes: Function Generalization
  • Notes: Naming

  Unless noted otherwise, all exercises are due by 4:30 pm on Monday, Feb 6.

• Week 4 Class 7 Tue Jan 31 Posted: Jan 31

  After Class

  • A question was raised that either Aggregate.hpp or Aggregate.cpp did not have a newline at the EOF for one of the commits. For a demonstration that they did, Rainfall-010

  • Project 1 Pull Request

    I created a pull request for Project 1 to create the (empty) files, xml_parser.hpp and xml_parser.cpp for part v1d. The easiest way to merge this into your code is the Merge pull request at GitHub. Once you merge, then remember to do a git pull in all of your cloned repositories.

    Note that xml_parser.{hpp,cpp} expands to xml_parser.hpp and xml_parser.cpp in a shell.

  Announcements

  • Policy Enforcement Change Starting with the class on Tuesday, Jan 31, attendance is required to get credit for any exercises. For example, to get credit for Exercise 14: Coding Style Crossword, you must be in class today as I present those notes. Any exceptions must be from a valid, excused absence. This applies to all exercises, including crosswords and coding exercises. If you attend, you still have until the due date (typically 4:30 pm the next day) to complete the assignment. I encourage those of you not attending regularly to start doing so.
  • Rainfall IV Feedback I posted Report4 in branch feedback4, and scores in Brightspace along with some notes
  • Project 1 I adjusted the due date for v1c

  • GitHub Desktop & Atom Users Keep your software updated. It is easy to forget about any virtual environments and not update them.

    On Windows, Windows Update does not update the Ubuntu in WSL. So for WSL (and Ubuntu):

    On macOS, macOS updates do not update the software in brew. So for brew:

    Also, before you install a package, do the above first.

  • Cleaning Up Package managers download packages and installs them. Once they are installed, the downloads are not needed, unless you want to reinstall at some point. And, they can be downloaded again if needed.

    For WSL (and Ubuntu):

    For brew:

  Class

  • Notes: XML

  • Exercise 13: XML Crossword

  • Notes: Coding Style

  • Exercise 14: Coding Style Crossword

  • Notes: Free-Function Stereotypes

  • Exercise 15: Free-Function Stereotypes Crossword

  • Notes: Concerns

  Unless noted otherwise, all exercises are due by 4:30 pm on Wed Feb 01

• Week 3 Class 6 Thu Jan 26 Posted: Jan 26

  After Class

  • Policy Enforcement Change Starting with the class on Tuesday, Jan 31, attendance is required to get credit for any exercises. For example, to get credit for the Separate Compilation Crossword, you must be in class when I present those notes. Any exceptions must be from a valid, excused absence. This applies to all exercises, including crosswords and coding exercises. If you attend, you still have until the due date (typically 4:30 pm the next day) to complete the assignment. I encourage those of you not attending regularly to start doing so.
  • Exercise 13: XML Crossword Due after next class

  Announcements

  • Good Practices Always perform a git pull before you start making any changes to your code. That prevents the need for a git merge after. That would have prevented some of the git warnings that students were getting.
  • Rainfall IV Feedback I did not get to this yet
  • Project 1
    • I posted feedback for Project 1 v1a as GitHub Issues. The scores are in Brightspace. Note that I will not always grade each part as we go along.
    • There is a GitHub issue, Coding Practices Task List, for Project 1 part v1c
    • I adjusted some of the due dates
  • Guide: Compilers

  Class

  • Notes: Separate Compilation
  • OOPS23-Rainfall-010
  • Exercise 11: Separate Compilation Crossword
  • Notes: Rainfall Coding Practices
  • Notes: XML
  • Exercise 13: XML Crossword Due after next class (did not complete XML slides in 2 - 3:15 pm 020 section)

  Unless noted otherwise, all exercises are due by 4:30 pm on Monday, Jan 30

• Week 3 Class 5 Tue Jan 24 Posted: Jan 24

  After Class

  • I posted feedback for Project 1 v1a as GitHub Issues. The scores are in Brightspace.
  • Always perform a git pull before you start making any changes to your code. That prevents the need for a git merge after. For the 010 section, that would have prevented some of the git warnings that students were getting.
  • For Rainfall IV, I am not concerned with the order or number of commits. Get your program up to the point that I showed in class (and you can view on GitHub)

  Announcements

  • Rainfall III Feedback Posted as Report3.md on branch, feedback3
  • Due Dates Unless I give you a specific time, all deadlines are by 11:59:59 pm of the day listed
  • Project 1
    • Not all parts of the project have the same level of difficulty or take the same amount of time. I definitely suggest you work ahead of the due dates
    • The function already in srcFacts is refillContent(). I accidentally showed code in class that was from another version that used the name refillBuffer()
    • I changed the due date for v1b
  • Guide: Git Tags

  Class

  • Notes: Algorithmic Decomposition

  • Exercise 10: Algorithmic Decomposition Crossword

  • Notes: Separate Compilation - Will finish on Thursday

  • Exercise 11: Separate Compilation Crossword - Delayed until after next class

  • Exercise 12: Rainfall IV

    We continue on with the notes on Rainfall Coding Practices. Refer to Exercise 5: Rainfall I.

    OOPS23-Rainfall-010

  Unless noted otherwise, all exercises are due by 4:30 pm on Wed Jan 25

• Week 2 Class 4 Thu Jan 19 Posted: Jan 19

  After Class

  • All deadlines for projects are by 11:59:59 pm of the day listed
  • I definitely suggest working ahead of the due dates

  Announcements

  • Repo Issues Only affected a few of you, and currently fixed

  • Navigation In WSL, if you enter the following command in the WSL shell:

    the Windows File Explorer will open with the directory you are at in the WSL shell.

    Carefully note that there is a single dot, ., in the command. A single dot in a shell is the current directory. Two dots, .., refer to the parent directory (as in cmake ..)

  • Rainfall II Feedback Posted as Report2.md on branch, feedback2
  • Project 1 GitHub Classroom link on Brightspace

  Class

  • Exercise 8: Build & Run srcFacts

    Create your srcFacts repository from GitHub Classroom and clone the repository on your machine. Build and run the program to verify it works in your development environment. At the end of the commands, enter the following:

    Upload a screenshot (or multiple) to Brightspace of these commands executing.

  • Exercise 9: Rainfall III

    We continue on with the notes on Rainfall Coding Practices. Refer to Exercise 5: Rainfall I.

    OOPS23-Rainfall-010

  • Notes: Algorithmic Decomposition - Delayed until next class
  • Exercise 10: Algorithmic Decomposition Crossword - Delayed until next class

  Unless noted otherwise, all exercises are due by 4:30 pm on Fri Jan 20

• Project 1: srcFacts Posted: Jan 18

  One approach to understanding the source code of a system is to count things, e.g., the number of statements, functions, classes, expressions, LOC (Lines Of Code), etc. The program srcFacts produces a report of these counts.

  It is very difficult for a program to directly parse C++ source code, i.e., identify the syntactic parts of the code. So the srcFacts program does not parse the C++ source code. It uses another tool, srcML, to convert the C++ source code into an XML format. The srcFacts program inputs this XML format, parses the XML collecting counts, and produces the report.

  The srcFacts program is one large, main() function using almost no design features. It does have high scalability and performance as it is extremely fast and, for example, can produce a report on the entire Linux kernel in under 6 seconds. However, it is not easy in its current form to debug the XML parsing, add additional program element counts, or even understand what is going on. It includes code for parsing all parts of XML, but it would not be easy to adapt the XML parsing code for another purpose, e.g., another report. The only way to reuse this code is by copy/paste reuse. It has no modularity, extensibility, reusability, and specifically no maintainability.

  Your task is to take the srcFacts code, improve the overall design, and extract the XML parsing part of the code. When completed, a set of functions in the files xml_parser.hpp and xml_parser.cpp will handle as much XML parsing as possible, while the main program, srcFacts.cpp, generates the report using the XML parser functions for parsing.

  • You do not have to understand how to parse XML. You are only repackaging XML parsing code, not writing from scratch.
  • The existing code is brittle, so you need to work carefully not to break the code
  • The repository includes example input
  • Keep in mind all aspects of design as we discuss them in class

  The steps (in order) with the associated (git) tag are:

  Tag v1a Without changing the design, add the code necessary for the report to include the number of return statements. The heading in the table must be "Returns". Due Jan 24

  Tag v1b Move the refillContent() function into the separate refillContent.hpp and refillContent.cpp files. Due Jan 26 27

  Tag v1c Apply the specific design changes from the Coding Practices Task List (to appear). As you verify that the code follows the practices given, check them off. Once you have completed all of them, close the issue. Due Jan 29 31 Feb 1

  Tag v1d Extract a set of (free) functions to handle the low-level details of the XML parsing. Extract one function at a time, i.e., each commit can only include a single extracted function. These function declarations and definitions belong in the files xml_parser.hpp and xml_parser.cpp, as described above. Due Feb 2 6 9

  Tag v1e Add the necessary code to count the number of line comments and the number of literal strings. The headings in the table must be "Line Comments" and "Strings". Due Feb 6 7 10

  Your repository for this project is through GitHub Classroom with a link on the Brightspace course page.

  • Steps must be completed in order, e.g., Step v1a must be completed before step v1b.
  • Your code must compile with both g++ and clang. An easy way to verify is with GitHub Codespaces
  • Be sure to follow the good practices we discuss in class
  • There are absolutely no classes or structs created for this project. You are extracting a set of free functions. Any class you create to solve this problem now would not solve the primary problem of how the srcFacts code uses an XML parser.
  • The main() handles XML errors (invalid XML format) with a direct return 1; so the program exits with the status of 1. To exit the program from within any function, use exit(1); which requires the include file stdlib.h.
  • While you are free to create and use other branches, only the work on the main branch counts. The main branch is the default when you git clone and git checkout.

• Week 2 Class 3 Tue Jan 17 Posted: Jan 17

  After Class

  • Missing Repositories

    I did some cleanup of membership on UAComputerScience, the organization used for GitHub Classroom.

    Unfortunately, if you were a member of UAComputerScience, it may have removed your access to your repository.

    For most of you, this should not be a problem.

    I am restoring access. If you don't have access, send me an email, or a message via Teams.

    Update Going through all the repositories, it is only those who took another class of mine (e.g,. Software Engineering) and were members (instead of "outside collaborators"). For those few, I sent out invitations to restore access to your repository.

  • Navigation In WSL, if you enter the following command in the WSL shell:

    the Windows File Explorer will open with the directory you are at in the WSL shell.

    Carefully note that there is a single dot, ., in the command. A single dot in a shell is the current directory. Two dots, .., refer to the parent directory (as in cmake ..)

  Announcements

  • After Class

  • Ubuntu 20.04

    If you are having issues installing gh in WSL, then you probably have Ubuntu 20.04 installed instead of Ubuntu 22.04. To check your version of Ubuntu:

    At some point you will need to update. In the meantime, you can use the following commands to directly install gh:

    Note that to install an updated CMake, you will have to follow the directions at apt.kitware.com for Ubuntu Focal Fossa (20.04)

  • Scores I posted the scores for the Exercises 3 & 4. From now on, I will not announce posted scores. I will only announce when they are delayed.
  • Rainfall I Feedback
  • Workflow

  Class

  • Notes: Software Design Characteristics
  • Exercise 6: Software Design Characteristics Crossword

  • Exercise 7: Rainfall II

    We continue on with the notes on Rainfall Coding Practices. Refer to Exercise 5: Rainfall I.

    OOPS23-Rainfall-010

  Unless noted otherwise, all exercises are due by 4:30 pm on Wed Jan 18

• Exercise 5: Rainfall I Feedback Posted: Jan 17

  The scores and feedback for Exercise 6: rainfall.cpp is in two parts:

  • The file Report.md in the feedback1 branch of your repository. Best to view this on GitHub.
  • Scores and comments in Brightspace

  The report check/shows the following:

  • The most recent rainfall.cpp with indentation and line endings marked
  • Changed files - Should only be rainfall.cpp (and README.md from a github bot)
  • Results of cmake ..; make; make run; make check
  • Word difference with the oracle commit messages
  • For each commit:
    • git show
    • Results of cmake ..; make; make run; make check for the code in this commit
    • diff of rainfall.cpp with what I entered

  I use the report to give feedback. In some cases, the report can be off, e.g., if you had extra commits.

  Overall observations:

  • All commits, including changes to code and commit messages, were in GitHub as soon as I did a git push.
  • The first word in a commit message is always capitalized
  • Commit messages use an imperative form, e.g., Add, Change, Comment, Move, Remove, Rename, Replace, and Separate. Not Added, Adding, Changed, Commented, Moved, Removed, Renamed, Replaced, or Separated
  • Spelling is important. Letter case is important.

  • Valid commit messages:

  • Invalid commit messages:

  • The code in every commit must build. Do not commit if you have a compile error. Build and run your code and fix any errors before committing.

• Week 1 Class 2 Thu Jan 12 Posted: Jan 12

  After Class

  If you are having issues installing gh in WSL, then you probably have Ubuntu 20.04 installed instead of Ubuntu 22.04. To check your version of Ubuntu:

  At some point you will need to update. In the meantime, you can use the following commands to directly install gh:

  Note that to install an updated CMake, you will have to follow the directions at apt.kitware.com for Ubuntu Focal Fossa (20.04)

  If this doesn't work, then use GitHub Codespaces to work on Rainfall.

  Announcements

  • TA Mr. Andrew Murphy
  • Scores I posted the scores for the Exercises 1 & 2
  • Syllabus In the syllabus, "3460" is replaced by "CPSC"
  • Notes The class notes have a bunch of default and custom hot keys. Type a "?" to see a list.
  • Archive The post for the first class session are now in the Archive. I only keep relevant posts on the course page.
  • Class Survey Results

  Class

  • Exercise 3: Development Environment Survey
  • Notes: Software Design
  • Exercise 4: Software Design Crossword
  • Steps to work on Coding Exercises:
    • Development Environment: Tools Setup your local machine with the proper tools
    • GitHub Authentication Authenticate your local machine with GitHub
    • Git Setup Setup your local machine to properly use Git
  • Alternative work on Exercises in GitHub Codespace. But you will need to update CMake. See the Guide.

  • Exercise 5: Rainfall I

    Note Due to the required setup, Exercise 5 is due by 8 am on Monday, Jan 16. Even with this extra time, there is a lot of setup, so start early.

  Unless noted otherwise, all exercises are due by 4:30 pm on Fri Jan 13

• Exercise Rainfall I Posted: Jan 12

  Take the starting rainfall.cpp code and make the same changes that I make in class.

  Your code is in a repository from GitHub Classroom:

  1. Log in to your GitHub account.
  2. Click on the invitation link (GitHub Classroom Rainfall) on the main course page in Brightspace.
  3. Follow the directions to link your GitHub account to your UA ID.

  Then you clone the repository. Cloning creates a local repository that is a copy of your repository at GitHub.

  Now to setup the build:

  Git Workflow on Rainfall

  1. Edit files locally, e.g., add a header comment to the file rainfall.cpp
  2. Build, run, and check your work
  3. View your changes
  4. Commit current changes to the local repository:
  5. Push your local commits to the GitHub repository:
  6. View and verify your changes at GitHub in your browser
  7. View your commits locally

  Note Your code must build and compile. If you have a build warning or error, fix these before making any more changes to the code.

  Note You must commit each change that I make separately and use the exact commit message that I use in class

  You can follow along and see the commits that I make in class:

  OOPS23-Rainfall-010

  If you have any questions or issues, make sure to contact me.

• Week 1 Class 1 Tue Jan 10 Posted: Jan 10

  After Class

  • Course Content Crossword:

  

  Announcements

  • Syllabus
  • GitHub We use GitHub and GitHub Classroom in the class to manage source code for projects, exercises, and examples. You are required to have a GitHub account. The account email (not necessarily the account name) should be your @uakron.edu email address. If it is, you can apply for the Student Github Developer Pack and get a free GitHub Pro account. You will need your GitHub account for Thursday's class.
  • Development Environment: Tools Follow the directions in the guide to set up your development environment. Department servers have older versions of g++ and cmake, so do not rely on them.
  • GitHub Codespaces I am considering using these for exercises at least. Will know more soon.

  • O'Reilly Online Learning The course textbooks are available in O'Reilly Online Learning.

    You do not have to be on the campus network (e.g., via VPN) to access O'Reilly Online Learning.

    To access content, click the "Institution not listed?" link below the dropdown and enter your UA email. You will then create an account and use that account from now on.

    For more information: Library LibGuide

  • During Office Hours, I monitor Teams

  Exercises

  • Exercise 1: OOP Survey

  • Exercise 2: Course Content Crossword

    Upload a PDF of the completed crossword to Brightspace in Assessments/Assignments, Exercise 2: Course Content Crossword

    Make sure to follow the print directions given in class to create a PDF of the crossword.

    Also, try to include the headers and footers in the pdf.

  • Notes: Software Design

  All exercises are due by 4:30 pm on Wed Jan 11

• Welcome Posted: Jan 08

  Greetings and welcome to CPSC 421 Object-Oriented Programming (OOP) for Spring 2023.

  • Syllabus The syllabus for the course is on the main course page. It is a draft, but I will finalize it before our first class meeting.
  • Survey The first exercise is to fill out the class survey. The survey is due after our first class meeting, but you can complete it before.
  • Development Environment Development Environment: Tools is a guide for setting up your programming development environment for the class. It is good to start early as you will need this early in the course.
  • GitHub We use GitHub and GitHub Classroom in the class to manage source code for projects, exercises, and examples. You are required to have a GitHub account. The account email (not necessarily the account name) should be your @uakron.edu email address. If it is, you can apply for the Student Github Developer Pack and get a free GitHub Pro account.

  See you on Tuesday, Jan 10 at 10:45 am - 12:00 pm in Arts & Sciences (CAS) room 136