Temperature changes

.github/workflows/test.yml

@@ -0,0 +1,18 @@
+on:
+  pull_request:
+
+jobs:
+  unit-test:
+    name: Unit Test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v3 # docs https://pnpm.io/continuous-integration#github-actions
+        with:
+          version: 9
+      # Further steps for your build/test process
+      - name: Install dependencies
+        run: pnpm install
+      - name: Run tests
+        run: pnpm test

package.json

@@ -0,0 +1,24 @@
+{
+  "name": "temperature",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js",
+    "start": "node src/index.js"
+  },
+  "type": "module",
+  "keywords": [
+    "chingu",
+    "roundtables",
+    "git",
+    "advanced",
+    "temperature"
+  ],
+  "author": "Andres Court",
+  "license": "GNU",
+  "devDependencies": {
+    "@jest/globals": "^29.7.0",
+    "jest": "^29.7.0"
+  }
+}

src/constants.js

@@ -0,0 +1,11 @@
+/** @type {number} conversion factor from farenheit to celcius */
+export const CelciusFactor = 5;
+
+/** @type {number} conversion factor from celcius to farenheit */
+export const FarenheitFactor = 9 / 5;
+
+/** @type {number} Offset between celcius and farenheit zero value */
+export const TemperatureOffset = 32;
+
+/** @type {number} Factor to convert from feet to meters */
+export const DistanceFactor = 3.28084;

src/distance/ConvertToMeters.js

@@ -0,0 +1,12 @@
+import { DistanceFactor } from "../constants";
+
+/**
+ * Converts a distance expressed in feet to meters
+ *
+ * @type val {number} distance in feet
+ * @returns {number} the distance in meters
+ */
+
+export function ConvertToMeters(val) {
+    return val / DistanceFactor;
+}

src/distance/feet.js

@@ -0,0 +1,11 @@
+import { DistanceFactor } from "../constants";
+
+/**
+ * Converts a distance expressed in meters to feet
+ *
+ * @type val {number} distance in meters
+ * @returns {number} the distance in feet
+ */
+export function ConvertToFeet(val) {
+    return val * DistanceFactor;
+}

src/distance/meters.js

@@ -0,0 +1,11 @@
+import { DistanceFactor } from "../constants";
+
+/**
+ * Converts a distance expressed in feet to meters
+ *
+ * @type val {number} distance in feet
+ * @returns {number} the distance in meters
+ */
+export function ConvertToMeters(val) {
+    return val / DistanceFactor;
+}

src/index.js

@@ -0,0 +1,8 @@
+import ConvertToFarenheit from "./temperature/farenheit.js";
+import ConverToCelcius from "./temperature/celcius.js";
+
+const far = ConvertToFarenheit(21);
+const cel = ConverToCelcius(69.8);
+
+console.log(far);
+console.log(cel);

src/temperature/celcius.js

@@ -0,0 +1,22 @@
+import { CelciusFactor, TemperatureOffset } from "../constants.js";
+
+/**
+ * Convert a temperature that is in Farenheit to Celcius
+ *
+ * Formula used
+ * celcius = (farenheit - 32) * 5/9
+ *
+ * @param {number} temp The temperature in farenheit
+ * @returns {number} The converted celcius value
+ *
+ * @author Andres Court
+ */
+function ConverToCelcius(temp) {
+    /** @type {number} */
+    var value = temp - TemperatureOffset;
+    value = value * CelciusFactor;
+
+    return value;
+}
+
+export default ConverToCelcius;

src/temperature/farenheit.js

@@ -0,0 +1,22 @@
+import { FarenheitFactor, TemperatureOffset } from "../constants";
+
+/**
+ * Convert a temperature that is in Celcius to farenheit
+ *
+ * Formula used
+ * farenheit = 32 + (9/5 * celcius)
+ *
+ * @param {number} temp The temperature in celcius
+ * @returns {number} The converted farenheit value
+ *
+ * @author Andres Court
+ */
+function ConvertToFarenheit(temp) {
+    /** @type {number} */
+    let value = temp * FarenheitFactor;
+    value = value + TemperatureOffset;
+
+    return value;
+}
+
+export default ConvertToFarenheit;

tests/distance/feet.test.js

@@ -0,0 +1,10 @@
+import { describe, it, expect } from "@jest/globals";
+import { ConvertToFeet } from "../../src/distance/feet";
+
+describe("Convert to Feet", () => {
+    it("should convert 10 meters to equal 32.8084 feet", () => {
+        const res = ConvertToFeet(10);
+
+        expect(res).toBeCloseTo(32.8084);
+    });
+});

tests/distance/meter.test.js

@@ -0,0 +1,10 @@
+import { describe, it, expect } from "@jest/globals";
+import { ConvertToMeters } from "../../src/distance/meters";
+
+describe("Convert to meters", () => {
+    it("should convert 32.8084 feet to equal 10 meters", () => {
+        const res = ConvertToMeters(32.808);
+
+        expect(res).toBeCloseTo(10);
+    });
+});

tests/temperature/celsius.test.js

@@ -0,0 +1,16 @@
+import { it, describe, expect } from "@jest/globals";
+import convertToCelcius from "../../src/temperature/celcius.js";
+
+describe("Convert to Celcius", () => {
+    it("should convert 32°F to equal 0°C", () => {
+        const cel = convertToCelcius(32);
+
+        expect(cel).toBe(0);
+    });
+
+    it("should convert 69.8°F to 21°C", () => {
+        const cel = convertToCelcius(69.8);
+
+        expect(cel).toBe(21);
+    });
+});

tests/temperature/farenheit.test.js

@@ -0,0 +1,16 @@
+import { it, describe, expect } from "@jest/globals";
+import convertToFarenheit from "../../src/temperature/farenheit.js";
+
+describe("Convert to Celcius", () => {
+    it("should convert 0°C to equal 32°F", () => {
+        const far = convertToFarenheit(0);
+
+        expect(far).toBe(32);
+    });
+
+    it("should convert 21°C to 69.8°F", () => {
+        const far = convertToFarenheit(21);
+
+        expect(far).toBeCloseTo(69.8);
+    });
+});