reachitect grade-school

Author: wolf99

exercises/practice/grade-school2/.docs/instructions.md

@@ -0,0 +1,38 @@
+# Instructions
+
+Given students' names along with the grade that they are in, create a roster
+for the school.
+
+In the end, you should be able to:
+
+- Add a student's name to the roster for a grade
+  - "Add Jim to grade 2."
+  - "OK."
+- Get a list of all students enrolled in a grade
+  - "Which students are in grade 2?"
+  - "We've only got Jim just now."
+- Get a sorted list of all students in all grades.  Grades should sort
+  as 1, 2, 3, etc., and students within a grade should be sorted
+  alphabetically by name.
+  - "Who all is enrolled in school right now?"
+  - "Let me think. We have
+  Anna, Barb, and Charlie in grade 1,
+  Alex, Peter, and Zoe in grade 2
+  and Jim in grade 5.
+  So the answer is: Anna, Barb, Charlie, Alex, Peter, Zoe and Jim"
+
+Note that all our students only have one name.  (It's a small town, what
+do you want?)
+
+## For bonus points
+
+Did you get the tests passing and the code clean? If you want to, these
+are some additional things you could try:
+
+- If you're working in a language with mutable data structures and your
+  implementation allows outside code to mutate the school's internal DB
+  directly, see if you can prevent this. Feel free to introduce additional
+  tests.
+
+Then please share your thoughts in a comment on the submission. Did this
+experiment make the code better? Worse? Did you learn anything from it?

exercises/practice/grade-school2/.meta/example.c

@@ -0,0 +1,81 @@
+#include "grade_school2.h"
+#include <stdlib.h>
+#include <string.h>
+
+static roster_t roster = { 0 };
+
+static bool student_is_on_roster(char *name, roster_t roster)
+{
+   bool is_on_roster = false;
+   for (size_t i = 0; i < roster.count; ++i) {
+      if (!strncmp(roster.students[i].name, name, MAX_NAME_LENGTH)) {
+         is_on_roster = true;
+         break;
+      }
+   }
+   return is_on_roster;
+}
+
+static int compare_student_names(const void *s1, const void *s2)
+{
+   const student_t *student1 = (const student_t *)s1;
+   const student_t *student2 = (const student_t *)s2;
+   return strncmp(student1->name, student2->name, MAX_NAME_LENGTH);
+}
+
+static int compare_student_grades_and_names(const void *s1, const void *s2)
+{
+   const student_t *student1 = (const student_t *)s1;
+   const student_t *student2 = (const student_t *)s2;
+
+   if (student1->grade > student2->grade)
+      return 1;
+   else if (student1->grade < student2->grade)
+      return -1;
+   else
+      return compare_student_names(student1, student2);
+}
+
+bool add_student(char *name, uint8_t grade)
+{
+   bool added = false;
+
+   if (student_is_on_roster(name, roster)) {
+      added = false;
+   } else if (roster.count < MAX_STUDENTS && strlen(name) < MAX_NAME_LENGTH) {
+      strcpy(roster.students[roster.count].name, name);
+      roster.students[roster.count].grade = grade;
+      ++roster.count;
+      qsort(roster.students, roster.count, sizeof(roster.students[0]),
+            compare_student_grades_and_names);
+      added = true;
+   }
+
+   return added;
+}
+
+roster_t get_roster(void)
+{
+   return roster;
+}
+
+roster_t get_grade(uint8_t grade)
+{
+   roster_t grade_roster = { 0 };
+
+   for (size_t i = 0; i < roster.count && grade_roster.count < MAX_STUDENTS;
+        ++i) {
+      if (roster.students[i].grade == grade) {
+         strcpy(grade_roster.students[grade_roster.count].name,
+                roster.students[i].name);
+         grade_roster.students[grade_roster.count].grade = grade;
+         ++grade_roster.count;
+      }
+   }
+   return grade_roster;
+}
+
+void clear_roster(void)
+{
+   memset(&roster, 0, sizeof(roster));
+}

exercises/practice/grade-school2/.meta/example.h

@@ -0,0 +1,29 @@
+#ifndef GRADE_SCHOOL2_H
+#define GRADE_SCHOOL2_H
+
+#include <stddef.h>
+#include <stdint.h>
+#include <stdbool.h>
+
+#define MAX_NAME_LENGTH 20
+#define MAX_STUDENTS 20
+
+typedef struct {
+   uint8_t grade;
+   char name[MAX_NAME_LENGTH];
+} student_t;
+
+typedef struct {
+   size_t count;
+   student_t students[MAX_STUDENTS];
+} roster_t;
+
+bool add_student(char *name, uint8_t grade);
+
+roster_t get_roster(void);
+
+roster_t get_grade(uint8_t grade);
+
+void clear_roster(void);
+
+#endif

exercises/practice/grade-school2/grade_school2.c

@@ -0,0 +1,3 @@
+#include "grade_school2.h"
+
+static roster_t roster = { 0 };

exercises/practice/grade-school2/grade_school2.h

@@ -0,0 +1,20 @@
+#ifndef GRADE_SCHOOL2_H
+#define GRADE_SCHOOL2_H
+
+#include <stddef.h>
+#include <stdint.h>
+
+#define MAX_NAME_LENGTH 20
+#define MAX_STUDENTS 20
+
+typedef struct {
+   uint8_t grade;
+   char name[MAX_NAME_LENGTH];
+} student_t;
+
+typedef struct {
+   size_t count;
+   student_t students[MAX_STUDENTS];
+} roster_t;
+
+#endif

exercises/practice/grade-school2/makefile

@@ -0,0 +1,37 @@
+### If you wish to use extra libraries (math.h for instance),
+### add their flags here (-lm in our case) in the "LIBS" variable.
+
+LIBS = -lm
+
+###
+CFLAGS  = -std=c99
+CFLAGS += -g
+CFLAGS += -Wall
+CFLAGS += -Wextra
+CFLAGS += -pedantic
+CFLAGS += -Werror
+CFLAGS += -Wmissing-declarations
+CFLAGS += -DUNITY_SUPPORT_64
+
+ASANFLAGS  = -fsanitize=address
+ASANFLAGS += -fno-common
+ASANFLAGS += -fno-omit-frame-pointer
+
+.PHONY: test
+test: tests.out
+	@./tests.out
+
+.PHONY: memcheck
+memcheck: ./*.c ./*.h
+	@echo Compiling $@
+	@$(CC) $(ASANFLAGS) $(CFLAGS) test-framework/unity.c ./*.c -o memcheck.out $(LIBS)
+	@./memcheck.out
+	@echo "Memory check passed"
+
+.PHONY: clean
+clean:
+	rm -rf *.o *.out *.out.dSYM
+
+tests.out: ./*.c ./*.h
+	@echo Compiling $@
+	@$(CC) $(CFLAGS) test-framework/unity.c ./*.c -o tests.out $(LIBS)