cmscal

package module
v0.0.0-...-9348dde Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 18, 2020 License: Apache-2.0 Imports: 5 Imported by: 0

README

The cmscal program generates an iCalendar version of the Clark Middle School block schedule; it's written in the Go programming language.

Copying and Distributing

Copyright 2020 Lucas Bergman

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

https://www.apache.org/licenses/LICENSE-2.0

or in the LICENSE file in this program's code.

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Usage

cmscal serves HTTP on the port specified by the PORT environment variable, because that's the convention used by the Google Cloud Run service. The default is 8080.

Building

To build, you only need to install the Bazel build system and run bazel build:

$ bazel build -c opt //cmd/cmscal
Starting local Bazel server and connecting to it...
INFO: Analyzed target //cmd/cmscal:cmscal (38 packages loaded, 6935 targets configured).
INFO: Found 1 target...
Target //cmd/cmscal:cmscal up-to-date:
  bazel-out/k8-opt-ST-5e46445d989a/bin/cmd/cmscal/cmscal_/cmscal
INFO: Elapsed time: 30.361s, Critical Path: 10.07s
INFO: 7 processes: 7 linux-sandbox.
INFO: Build completed successfully, 11 total actions

If you already use Go, you can build with Go:

$ go install -i github.com/lucasbergman/cmscal/cmd/cmscal
$ PORT=12345 ~/go/bin/cmscal

Container builds are supported. You can build a container tar based on Alpine Linux:

$ bazel build -c opt //container:cmscal

If you have Docker installed, you can load that tar into your machine's Docker daemon by using bazel run instead of bazel build:

$ bazel run -c opt //container:cmscal
$ docker run -d -p 8080 --rm bazel/container:cmscal

Documentation

Index

Constants

This section is empty.

Variables

View Source
var ScheduleEighth = GradeSchedule{
	Name:        "CMS Eighth Grade 2020-2021",
	Description: "Block schedule for CMS Eighth Grade 2020-2021",
	ScheduleMap: map[BlockDayType]DaySchedule{
		BlueDay: {
			{StartHour: 8, StartMinute: 47, Duration: time.Minute * 32, Description: "Advisory/Period 1"},
			{StartHour: 9, StartMinute: 24, Duration: time.Minute * 90, Description: "Period 2"},
			{StartHour: 10, StartMinute: 59, Duration: time.Minute * 90, Description: "Period 3"},
			{StartHour: 12, StartMinute: 34, Duration: time.Minute * 30, Description: "Lunch"},
			{StartHour: 13, StartMinute: 9, Duration: time.Minute * 90, Description: "Period 4"},
			{StartHour: 14, StartMinute: 44, Duration: time.Minute * 45, Description: "Period 8"},
			{StartHour: 15, StartMinute: 32, Duration: time.Minute * 8, Description: "Period 1"},
		},
		WhiteDay: {
			{StartHour: 8, StartMinute: 47, Duration: time.Minute * 32, Description: "Advisory/Period 1"},
			{StartHour: 9, StartMinute: 24, Duration: time.Minute * 90, Description: "Period 5"},
			{StartHour: 10, StartMinute: 59, Duration: time.Minute * 90, Description: "Period 6"},
			{StartHour: 12, StartMinute: 34, Duration: time.Minute * 30, Description: "Lunch"},
			{StartHour: 13, StartMinute: 9, Duration: time.Minute * 90, Description: "Period 7"},
			{StartHour: 14, StartMinute: 44, Duration: time.Minute * 45, Description: "Period 8"},
			{StartHour: 15, StartMinute: 32, Duration: time.Minute * 8, Description: "Period 1"},
		},
		NonBlockDay: {
			{StartHour: 8, StartMinute: 47, Duration: time.Minute * 25, Description: "Advisory/Period 1"},
			{StartHour: 9, StartMinute: 12, Duration: time.Minute * 45, Description: "Period 2"},
			{StartHour: 10, StartMinute: 2, Duration: time.Minute * 45, Description: "Period 3"},
			{StartHour: 10, StartMinute: 52, Duration: time.Minute * 45, Description: "Period 4"},
			{StartHour: 11, StartMinute: 42, Duration: time.Minute * 45, Description: "Period 5"},
			{StartHour: 12, StartMinute: 32, Duration: time.Minute * 30, Description: "Lunch"},
			{StartHour: 13, StartMinute: 7, Duration: time.Minute * 45, Description: "Period 6"},
			{StartHour: 13, StartMinute: 57, Duration: time.Minute * 45, Description: "Period 7"},
			{StartHour: 14, StartMinute: 47, Duration: time.Minute * 45, Description: "Period 8"},
			{StartHour: 15, StartMinute: 35, Duration: time.Minute * 5, Description: "Period 1 (Return Chromebooks)"},
		},
		ShortWednesday: {
			{StartHour: 8, StartMinute: 47, Duration: time.Minute * 35, Description: "Period 2"},
			{StartHour: 9, StartMinute: 27, Duration: time.Minute * 35, Description: "Period 3"},
			{StartHour: 10, StartMinute: 7, Duration: time.Minute * 35, Description: "Period 4"},
			{StartHour: 10, StartMinute: 47, Duration: time.Minute * 35, Description: "Period 5"},
			{StartHour: 11, StartMinute: 27, Duration: time.Minute * 30, Description: "Lunch"},
			{StartHour: 12, StartMinute: 2, Duration: time.Minute * 35, Description: "Period 6"},
			{StartHour: 12, StartMinute: 42, Duration: time.Minute * 35, Description: "Period 7"},
			{StartHour: 13, StartMinute: 22, Duration: time.Minute * 35, Description: "Period 8"},
			{StartHour: 14, StartMinute: 0, Duration: time.Minute * 5, Description: "Period 1 (Return Chromebooks)"},
		},
	},
}
View Source
var ScheduleSeventh = GradeSchedule{
	Name:        "CMS Seventh Grade 2020-2021",
	Description: "Block schedule for CMS Seventh Grade 2020-2021",
	ScheduleMap: map[BlockDayType]DaySchedule{
		BlueDay: {
			{StartHour: 8, StartMinute: 47, Duration: time.Minute * 32, Description: "Advisory/Period 1"},
			{StartHour: 9, StartMinute: 24, Duration: time.Minute * 90, Description: "Period 2"},
			{StartHour: 10, StartMinute: 59, Duration: time.Minute * 30, Description: "Lunch"},
			{StartHour: 11, StartMinute: 34, Duration: time.Minute * 90, Description: "Period 3"},
			{StartHour: 13, StartMinute: 9, Duration: time.Minute * 90, Description: "Period 4"},
			{StartHour: 14, StartMinute: 44, Duration: time.Minute * 45, Description: "Period 8"},
			{StartHour: 15, StartMinute: 32, Duration: time.Minute * 8, Description: "Period 1"},
		},
		WhiteDay: {
			{StartHour: 8, StartMinute: 47, Duration: time.Minute * 32, Description: "Advisory/Period 1"},
			{StartHour: 9, StartMinute: 24, Duration: time.Minute * 90, Description: "Period 5"},
			{StartHour: 10, StartMinute: 59, Duration: time.Minute * 30, Description: "Lunch"},
			{StartHour: 11, StartMinute: 34, Duration: time.Minute * 90, Description: "Period 6"},
			{StartHour: 13, StartMinute: 9, Duration: time.Minute * 90, Description: "Period 7"},
			{StartHour: 14, StartMinute: 44, Duration: time.Minute * 45, Description: "Period 8"},
			{StartHour: 15, StartMinute: 32, Duration: time.Minute * 8, Description: "Period 1"},
		},
		NonBlockDay: {
			{StartHour: 8, StartMinute: 47, Duration: time.Minute * 25, Description: "Advisory/Period 1"},
			{StartHour: 9, StartMinute: 12, Duration: time.Minute * 45, Description: "Period 2"},
			{StartHour: 10, StartMinute: 2, Duration: time.Minute * 45, Description: "Period 3"},
			{StartHour: 10, StartMinute: 52, Duration: time.Minute * 45, Description: "Period 4"},
			{StartHour: 11, StartMinute: 42, Duration: time.Minute * 30, Description: "Lunch"},
			{StartHour: 12, StartMinute: 17, Duration: time.Minute * 45, Description: "Period 5"},
			{StartHour: 13, StartMinute: 7, Duration: time.Minute * 45, Description: "Period 6"},
			{StartHour: 13, StartMinute: 57, Duration: time.Minute * 45, Description: "Period 7"},
			{StartHour: 14, StartMinute: 47, Duration: time.Minute * 45, Description: "Period 8"},
			{StartHour: 15, StartMinute: 35, Duration: time.Minute * 5, Description: "Period 1 (Return Chromebooks)"},
		},
		ShortWednesday: {
			{StartHour: 8, StartMinute: 47, Duration: time.Minute * 35, Description: "Period 2"},
			{StartHour: 9, StartMinute: 27, Duration: time.Minute * 35, Description: "Period 3"},
			{StartHour: 10, StartMinute: 7, Duration: time.Minute * 35, Description: "Period 4"},
			{StartHour: 10, StartMinute: 47, Duration: time.Minute * 30, Description: "Lunch"},
			{StartHour: 11, StartMinute: 22, Duration: time.Minute * 35, Description: "Period 5"},
			{StartHour: 12, StartMinute: 2, Duration: time.Minute * 35, Description: "Period 6"},
			{StartHour: 12, StartMinute: 42, Duration: time.Minute * 35, Description: "Period 7"},
			{StartHour: 13, StartMinute: 22, Duration: time.Minute * 35, Description: "Period 8"},
			{StartHour: 14, StartMinute: 0, Duration: time.Minute * 5, Description: "Period 1 (Return Chromebooks)"},
		},
	},
}
View Source
var ScheduleSixth = GradeSchedule{
	Name:        "CMS Sixth Grade 2020-2021",
	Description: "Block schedule for CMS Sixth Grade 2020-2021",
	ScheduleMap: map[BlockDayType]DaySchedule{
		BlueDay: {
			{StartHour: 8, StartMinute: 47, Duration: time.Minute * 32, Description: "Advisory/Period 1"},
			{StartHour: 9, StartMinute: 24, Duration: time.Minute * 90, Description: "Period 2"},
			{StartHour: 10, StartMinute: 59, Duration: time.Minute * 45, Description: "Period 3"},
			{StartHour: 11, StartMinute: 49, Duration: time.Minute * 30, Description: "Lunch"},
			{StartHour: 12, StartMinute: 19, Duration: time.Minute * 45, Description: "Period 3"},
			{StartHour: 13, StartMinute: 9, Duration: time.Minute * 90, Description: "Period 4"},
			{StartHour: 14, StartMinute: 44, Duration: time.Minute * 45, Description: "Period 8"},
			{StartHour: 15, StartMinute: 32, Duration: time.Minute * 8, Description: "Period 1"},
		},
		WhiteDay: {
			{StartHour: 8, StartMinute: 47, Duration: time.Minute * 32, Description: "Advisory/Period 1"},
			{StartHour: 9, StartMinute: 24, Duration: time.Minute * 90, Description: "Period 5"},
			{StartHour: 10, StartMinute: 59, Duration: time.Minute * 45, Description: "Period 6"},
			{StartHour: 11, StartMinute: 49, Duration: time.Minute * 30, Description: "Lunch"},
			{StartHour: 12, StartMinute: 19, Duration: time.Minute * 45, Description: "Period 6"},
			{StartHour: 13, StartMinute: 9, Duration: time.Minute * 90, Description: "Period 7"},
			{StartHour: 14, StartMinute: 44, Duration: time.Minute * 45, Description: "Period 8"},
			{StartHour: 15, StartMinute: 32, Duration: time.Minute * 8, Description: "Period 1"},
		},
		NonBlockDay: {
			{StartHour: 8, StartMinute: 47, Duration: time.Minute * 25, Description: "Advisory/Period 1"},
			{StartHour: 9, StartMinute: 12, Duration: time.Minute * 45, Description: "Period 2"},
			{StartHour: 10, StartMinute: 2, Duration: time.Minute * 45, Description: "Period 3"},
			{StartHour: 10, StartMinute: 52, Duration: time.Minute * 30, Description: "Lunch"},
			{StartHour: 11, StartMinute: 27, Duration: time.Minute * 50, Description: "Period 4"},
			{StartHour: 12, StartMinute: 17, Duration: time.Minute * 45, Description: "Period 5"},
			{StartHour: 13, StartMinute: 7, Duration: time.Minute * 45, Description: "Period 6"},
			{StartHour: 13, StartMinute: 57, Duration: time.Minute * 45, Description: "Period 7"},
			{StartHour: 14, StartMinute: 47, Duration: time.Minute * 45, Description: "Period 8"},
			{StartHour: 15, StartMinute: 35, Duration: time.Minute * 5, Description: "Period 1 (Return Chromebooks)"},
		},
		ShortWednesday: {
			{StartHour: 8, StartMinute: 47, Duration: time.Minute * 35, Description: "Period 2"},
			{StartHour: 9, StartMinute: 27, Duration: time.Minute * 35, Description: "Period 3"},
			{StartHour: 10, StartMinute: 7, Duration: time.Minute * 30, Description: "Lunch"},
			{StartHour: 10, StartMinute: 42, Duration: time.Minute * 35, Description: "Period 4"},
			{StartHour: 11, StartMinute: 22, Duration: time.Minute * 35, Description: "Period 5"},
			{StartHour: 12, StartMinute: 2, Duration: time.Minute * 35, Description: "Period 6"},
			{StartHour: 12, StartMinute: 42, Duration: time.Minute * 35, Description: "Period 7"},
			{StartHour: 13, StartMinute: 22, Duration: time.Minute * 35, Description: "Period 8"},
			{StartHour: 14, StartMinute: 0, Duration: time.Minute * 5, Description: "Period 1 (Return Chromebooks)"},
		},
	},
}

Functions

func ICalForSchedule

func ICalForSchedule(bs *BuildingSchedule, gs *GradeSchedule) string

Types

type BlockDayType

type BlockDayType int
const (
	BlueDay BlockDayType = iota
	WhiteDay
	NonBlockDay
	ShortWednesday
)

func (BlockDayType) String

func (t BlockDayType) String() string

type BuildingSchedule

type BuildingSchedule struct {
	// contains filtered or unexported fields
}

func MakeBuildingSchedule

func MakeBuildingSchedule(loc *time.Location) *BuildingSchedule

type ClassPeriod

type ClassPeriod struct {
	StartHour   int
	StartMinute int
	Duration    time.Duration
	Description string
}

type DaySchedule

type DaySchedule []ClassPeriod

type GradeSchedule

type GradeSchedule struct {
	Name        string
	Description string
	ScheduleMap map[BlockDayType]DaySchedule
}

Directories

Path Synopsis
cmd
cmscal command

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL