lab05 : Sorting

num	ready?	description	assigned	due
lab05	true	Sorting	Thu 10/17 04:00PM	Mon 10/28 04:00PM

In this lab:

• New concepts:
  • Sorting using lambda functions
• More on:
  • using packages
  • writing your own JUnit tests
  • test coverage

Step-by-Step

Step 0: Set up your repo

Create your repo

• under the organization
• name should be lab05-githubid OR lab05-githubid1-githubid2 as appropriate
• private, and initially empty (no README.md, .gitignore or LICENSE).
• if applicable add your pair partner as a collaborator

Clone this empty repo into your ~/cs56 directory, or wherever you prefer to work.

Also clone this repo as a “sibling” (i.e. side by side in the same directory) with your lab05 repo:

• git clone https://github.com/ucsb-cs56-f19/STARTER-lab05

Your starter code will be your lab03 repo, with a small number of additional files from: https://github.com/ucsb-cs56-f19/STARTER-lab05. So we’ll define a remote for your lab03 repo:

git remote add lab03 git@github.com:ucsb-cs56-f19/lab03-cgaucho1-ldelplaya22.git

Pull from your lab03 repo into your lab05 repo, and then push to github.

git pull lab03 master git push origin master

Now, we’ll copy a few files from the https://github.com/ucsb-cs56-f19/STARTER-lab05 repo into your new lab05 repo. That’s described in Step 1 below.

Step 1: Copy code for a new class and a new set of tests into your repo.

Though there is starter code for this week, it is not a full repo; instead it has just a few that you need to copy to their proper spots. In that repo, https://github.com/ucsb-cs56-f19/STARTER-lab05, you’ll find these files:

File	Where to copy it in your lab05 repo
.gitignore	root of repo
pom.xml	root of repo
Menu.java	src/main/java/edu/ucsb/cs56/pconrad/menuitem
MenuTest.java	src/test/java/edu/ucsb/cs56/pconrad/menuitem
site.xml	src/site (you may need to create this directory)

To copy these to their proper spots, you could do any of the following. How you get the file there is up to you. At this point, you will be expected to have the skills to do that, but if you need some suggestions, here you go:

1. If you cloned this repo to another directory (not inside of your lab05 repo directory, but as a sibling, for example), then you can use the Unix cp or mv file to copy the file into it’s proper spot.
2. Another approch is to use the “raw” tab on the github site to expose a version of the file that doesn’t have any extra formatting (line numbers, etc.). Then any of the following techniques:
   • Use “save as” in your web browser to save a copy into the correct directory
   • Copy the URL, then cd into the target directory, and use wget url to get the file.
   • Open the target filename in an editor as an empty file, and use copy/paste to paste in the contents.

Step 2: Start writing code to make tests pass

In the previous lab, lab03, you implemented several methods of a class called MenuItem that represents item on a restaurant Menu. Now, we will implement the Menu class. The details about the Menu class appear below.

Ideally, we’d need to discuss sorting, java.lang.Comparable, java.util.Comparator, and Java lambda expressions in lecture first; instead, here is a link to some materials you can read to learn what you need to know:

• https://ucsb-cs56-pconrad.github.io/topics/java_sorting/

Just like last week, note that the starter code:

• Has stubs for SOME of the needed methods, but NOT ALL of them
• Has unit tests for SOME of the needed methods, but NOT ALL of them

I suggest that you work in this order:

• First, Add stubs for all of the methods that don’t have them yet.
  • Until you do this, you won’t be able to run any of the instructor unit tests on Gradescope.
  • The reasons is that the instructor tests won’t compile against your code unless and until you have those methods.
• Then, try submitting on Gradescope
  • At this point, you should have a clean compile for both the student and instructor code, though you won’t be passing most of the unit tests.
• Then, one at a time, work on each method
  • If the method doesn’t have a unit test yet, write the test first and see it fail.
  • Then make the test pass.
  • Then submit on Gradescope and see if the test for that method passes on Gradescope
  • Continue until all of your methods work.

Details about methods of Menu

The methods for Menu are as follows:

Modifier and Type	Method	Description
void | add(MenuItem mi)	add a menu item to the menu (to the wrapped ArrayList<MenuItem>)
String	csv()	Produce a listing of each item in csv format, with newlines between each item. Order is whatever order the items are currently in the ArrayList
String	csvSortedByName()	same as csv(), but the items should be sorted in lexicographic order by name.
String	csvSortedByCategoryThenName()	same as csv(), but the items should be sorted by category. With the same category, the items should be sorted by name.
String	csvSortedByCategoryThenPriceDescendingThenByName()	same as csv(), but the items should be sorted by category. With the same category, the items should be sorted by name.
String	csvSortedByPriceThenName()	same as csv(), but the items should be sorted by price, from lowest to highest. When more than one items has the same price, the items of the same price should be sorted by name.

Step 3: Checking Test Case Coverage

As you did last week, be sure that you’ve added your pair partner to your submissions on Gauchospace

Then, check your test coverage:

• Run: mvn test jacoco:report
• Then, open the file target/site/jacoco/index.html in a browser:
  • In CSIL or Phelps 3525, from your top level repo directory, use either firefox target/site/jacoco/index.html or google-chrome target/site/jacoco/index.html
  • That will also work if you are ssh-ing in to CSIL, but only if you have X11 forwarding enabled.
  • If working directly on your own machine (i.e. not ssh-ing in), you can probably just double-click on the file target/site/jacoco/index.html to open it.

Some of the points in the manual inspection may be awarded on the basis of having good test coverage.
While 100% test coverage is not always the goal, in this particular exercise, it should be possible.

So if you see that you don’t have 100% test coverage, go back and write some additional unit tests.

For a review of how to read the test coverage reports provided by Jacoco, see: https://ucsb-cs56.github.io/topics/testing_jacoco_reports/

End of description for lab05