CS257 Software Design
Wednesday, 21 September 2022

0. Unix things-of-the-day
    #! -- "shebang" (shell/hash/sharp + bang)
    chmod +x
    which
    ./blah

1. CLI design recap
- Observations from the readings
    - follow design conventions
    - provide defaults
    - provide verbose & terse option synonyms
    - don't force user to remember order of options
    - support help, version, verbose
- let's look at a few teams' submissions (see below)

2. Test-driven development & unit testing
- General ideas from TDD reading
    - write tests while designing code
        (back and forth process)
        tests come before implementation
    - code/implementation should only address the tests
        excess, untested code shouldn't be there
    - why? you have tests and some confidence your
        code does what it's supposed to do
    - why? you can repeat the tests later
        "regression testing"
- Unit testing coverage issues
- Quick walk-through of my sample code
- Work on the lab

=======
SYNOPSIS
    python3 books.py author
    python3 books.py title [-t, -p]
    python3 books.py A B
    python3 books.py [-h --help]

=======
Synopsis
    python3 books.py [-h|--help]

    python3 books.py [-t|--title-search] [search term] [title]
    python3 books.py [-t|--title-search] [search term] [publication-year]
    
    python3 books.py [-a|--author-search] [search term]

    python3 books.py [-y|--year-search] [yearA] [yearB]
=======
NAME
    searchb - Search for books
SYNOPSIS
    searchb <S>
DESCRIPTION
    searchb takes a search string S and prints a list of books whose titles contain the string

NAME
    searcha - Search for authors
SYNOPSIS
    searcha <S>
DESCRIPTION
    searcha takes a search string S and prints a list of authors whose names contain the string
        
NAME
    range - Search range of years
SYNOPSIS
    range <A> <B> 
DESCRIPTION
    range prints a list of books published between years A and B, inclusive
    
=======
SYNOPSIS
    search [--help] <string>... <file> <option>
    
DESCRIPTION
    lists all results from <file> matching <string> according to <option>
    
    -t, --title[=SORT]
        search for <string> in titles within <file> and list in alphabetical order by title; SORT can
        be 'title' or 'year'
    
    -a, --author
        search for <string> in author names within <file> and list in alphabetical order by surname
        
    --help
        prints usage statement
        
    -y, --year
        search for years within <file> in the range <string> to <string> and list in order by year
=======
SYNOPSIS
    python3 books.py [-b | -a | -y | -h] [S1] [S2]
=======
SYNOPSIS
    bs --help
    Python3 books.py <file> [--books | --authors] [--keyword]
    Python3 books.py <file> [--books] [--start year] [--end year]

=======
SYNOPSIS
     python3 books.py title [-h] [-t | -y] string
     python3 books.py author [-h] string
     python3 books.py year [-h] year1 year2

DESCRIPTION 

For title:
    Given a search string print a list of books whose titles contain it (case-insensitive).

For author: 
    Given a search string print a list of books by authors whose names contain the search string (case-insensitive). Printed alphabetically by surname.

For year: 
    Given two years, print a list of books whose release year is between the range year1-year2 (inclusive)
        
    
OPTIONS
    
General:
    -h, --help  Prints usage statement

For title:
    -t, --title Sorts the resulting books by title alphabetically. Default.
    -y, --year  Sorts the resulting books by release year chronologically.

=======
SYNOPSIS
    books [-h | --help] [-t | --title <title>] [-a | --author <name>] [-d | --date <start year>[,<end year>]] [-s | --sort title|date]

DESCRIPTION
    books is a search tool to find a books from a CSV database. It allows you to search by any combination of book title, author or date published. The results can be sorted by title or date published.
  
OPTIONS
    -h, --help
        Prints the usage statement.
    
    -t, --title <title>
        Filters results to books whose title matches <title>.
    
    -a, --author <name>
        Filters results to books whose author's name matches <name>.

    -d, --date <start year>[,<end year>]
        Filters results to books whose start year is after <start year> inclusive, and before <end year> inclusive, if it is specified

books --author willis --title all



    -s, --sort title|date
        Sorts the results by either the title or the date published