Tijl/ /rc calendar

.gitignore

@@ -5,3 +5,4 @@ target/
 tests/rust_tests.rs
 _logs/
 js-api/
+tests/jsons/stable/tijl-goals

Cargo.toml

@@ -17,7 +17,7 @@ with-logging = []
 
 new-tests = []
 
-default = [ "new-tests", "with-logging" ]
+default = ["new-tests", "with-logging"]
 
 [lib]
 #see https://github.com/rust-lang/cargo/issues/6659#issuecomment-463335095
@@ -54,9 +54,6 @@ console_error_panic_hook = "0.1.7"
 log = "0.4.19"
 env_logger = "0.10.0"
 
-# soft assertions without panic
-soft = "0.1.1"
-
 # random number generator for tests
 rand = "0.8.5"
 # getrandom with js features should be included to make sure the wasm-unknown build target can use the crate in js context (even though we only use this crate in test code)

build_templates/run_test.rs

@@ -1,8 +1,8 @@
 #![cfg_attr(rustfmt, rustfmt_skip)] //skip cargo fmt on autogenerated file
 
 extern crate scheduler;
-extern crate soft;
-mod common;
+use scheduler::technical::input_output::Input;
+use scheduler::models::calendar;
 
 /// AUTO-GENERATED FILE. Do not change.
 /// Will be overwritten on build. Edit the file in build_templates or change test generation in build.rs

build_templates/tests_mod.rs

@@ -2,15 +2,19 @@
 mod TEST_MODULE_NAME {
 
     // stable tests
-//TEST_FUNCTIONS_STABLE
+    //TEST_FUNCTIONS_STABLE
 
     // experimental tests
-//TEST_FUNCTIONS_EXPERIMENTAL
+    //TEST_FUNCTIONS_EXPERIMENTAL
 
-    use scheduler::legacy::{input::Input, output::FinalTasks};
+    use crate::calendar::Calendar;
+    use crate::Input;
+    use scheduler::models::activity::Activity;
+    use scheduler::services::{activity_generator, activity_placer};
+
+    use scheduler::technical::input_output;
     use std::path::Path;
-    use crate::common;
-
+
     fn test(folder: &str) {
         let (actual_output, desired_output) = generate_outputs(folder);
         assert_eq!(actual_output, desired_output);
@@ -26,13 +30,46 @@ mod TEST_MODULE_NAME {
         let output_path = Path::new(&output_path_str[..]);
         let actual_output_path = Path::new(&actual_output_path_str[..]);
 
-        let input: Input = common::get_input_from_json(input_path).unwrap();
-        let desired_output: String = common::get_output_string_from_json(output_path).unwrap();
+        let input: Input = input_output::get_input_from_json(input_path).unwrap();
+        let desired_output: String =
+            input_output::get_output_string_from_json(output_path).unwrap();
+
+        // ONLY do this if expected is malformatted ... check that contents don't change!
+        // input_output::write_to_file(output_path, &desired_output).unwrap();
+
+        let mut calendar = Calendar::new(input.start_date, input.end_date);
+
+        calendar.add_budgets_from(&input.goals);
+
+        //generate and place simple goal activities
+        let simple_goal_activities =
+            activity_generator::generate_simple_goal_activities(&calendar, &input.goals);
+        dbg!(&simple_goal_activities);
+        activity_placer::place(&mut calendar, simple_goal_activities);
+
+        //generate and place budget goal activities
+        let budget_goal_activities: Vec<Activity> =
+            activity_generator::generate_budget_goal_activities(&calendar, &input.goals);
+        dbg!(&calendar);
+        activity_placer::place(&mut calendar, budget_goal_activities);
+
+        calendar.log_impossible_min_day_budgets();
+
+        let get_to_week_min_budget_activities =
+            activity_generator::generate_get_to_week_min_budget_activities(&calendar, &input.goals);
+        activity_placer::place(&mut calendar, get_to_week_min_budget_activities);
+
+        calendar.log_impossible_min_week_budgets();
+
+        let top_up_week_budget_activities =
+            activity_generator::generate_top_up_week_budget_activities(&calendar, &input.goals);
+        activity_placer::place(&mut calendar, top_up_week_budget_activities);
+
+        let output = calendar.print();
 
-        let output: FinalTasks = scheduler::run_scheduler(input);
         let actual_output = serde_json::to_string_pretty(&output).unwrap();
 
-        common::write_to_file(actual_output_path, &actual_output).unwrap();
+        input_output::write_to_file(actual_output_path, &actual_output).unwrap();
 
         (actual_output, desired_output)
     }

pkg/README.md

@@ -3,7 +3,28 @@
 If you like Rust and scheduling algorithms you've come to the right place :) We
 can talk big-O, add features or optimize hot loops.
 
-> Please contact me [email protected] or open an issue.
+> Please contact me [email protected] or open an issue.
+
+
+## ZinZen®
+ZinZen® is a platform for stress-free life planning. It works by defining life goals with constraints and dependencies.
+An automatic scheduler then schedules tasks in a calendar to reach these goals, auto-magically updating the schedule when
+goals or constraints change.
+
+This repository contains the ZinZen®-scheduler. The scheduler consists of a WASM-module written in Rust
+that can be called from the React-based UI application.
+
+The ZinZen® UI application can be found here: [ZinZen® Github](https://github.com/tijlleenders/ZinZen)
+
+
+
+## Getting started
+All documentation can be found in the folder [documentation](documentation/Readme.md).
+In this folder you will find a [technical know-how base](documentation/technical/Readme.md),
+as well as all the necessary [functional documentation](documentation/functional/Readme.md) to understand the
+scheduling algorithms and all the concepts introduced in the ZinZen®-scheduler.
+
+For a quick set-up guide see the [Development Setup page](documentation/technical/Development-Setup.md).
 
 ## Legal stuff
 

pkg/package.json

@@ -1,7 +1,7 @@
 {
   "name": "zinzen",
   "description": "Algorithm for auto-scheduling time-constrained tasks on a timeline",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "license": "AGPL-3.0",
   "repository": {
     "type": "git",
@@ -14,9 +14,11 @@
     "LICENSE.md"
   ],
   "module": "scheduler.js",
-  "homepage": "https://github.com/tijlleenders/ZinZen-scheduler/wiki",
+  "homepage": "https://github.com/tijlleenders/ZinZen-scheduler",
   "types": "scheduler.d.ts",
-  "sideEffects": false,
+  "sideEffects": [
+    "./snippets/*"
+  ],
   "keywords": [
     "zinzen",
     "scheduler",

pkg/scheduler.d.ts

@@ -1,6 +1,7 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
+* The main wasm function to call
 * @param {any} input
 * @returns {any}
 */
@@ -19,19 +20,23 @@ export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembl
 export interface InitOutput {
   readonly memory: WebAssembly.Memory;
   readonly schedule: (a: number, b: number) => void;
-  readonly __wbindgen_malloc: (a: number) => number;
-  readonly __wbindgen_realloc: (a: number, b: number, c: number) => number;
+  readonly __wbindgen_malloc: (a: number, b: number) => number;
+  readonly __wbindgen_realloc: (a: number, b: number, c: number, d: number) => number;
   readonly __wbindgen_add_to_stack_pointer: (a: number) => number;
+  readonly __wbindgen_free: (a: number, b: number, c: number) => void;
+  readonly __wbindgen_exn_store: (a: number) => void;
 }
 
+export type SyncInitInput = BufferSource | WebAssembly.Module;
 /**
-* Synchronously compiles the given `bytes` and instantiates the WebAssembly module.
+* Instantiates the given `module`, which can either be bytes or
+* a precompiled `WebAssembly.Module`.
 *
-* @param {BufferSource} bytes
+* @param {SyncInitInput} module
 *
 * @returns {InitOutput}
 */
-export function initSync(bytes: BufferSource): InitOutput;
+export function initSync(module: SyncInitInput): InitOutput;
 
 /**
 * If `module_or_path` is {RequestInfo} or {URL}, makes a request and
@@ -41,4 +46,4 @@ export function initSync(bytes: BufferSource): InitOutput;
 *
 * @returns {Promise<InitOutput>}
 */
-export default function init (module_or_path?: InitInput | Promise<InitInput>): Promise<InitOutput>;
+export default function __wbg_init (module_or_path?: InitInput | Promise<InitInput>): Promise<InitOutput>;