refactor: Renamed bundle from osmd to oensheetmusicdisplay

demo/index.js

@@ -1,9 +1,9 @@
-import { OSMD } from '../src/OSMD/OSMD';
+import { OpenSheetMusicDisplay } from '../src/OpenSheetMusicDisplay/OpenSheetMusicDisplay';
 
 /*jslint browser:true */
 (function () {
     "use strict";
-    var osmdObj;
+    var openSheetMusicDisplay;
     // The folder of the demo files
     var folder = process.env.STATIC_FILES_SUBFOLDER ? process.env.STATIC_FILES_SUBFOLDER + "/" : "",
     // The available demos
@@ -97,8 +97,8 @@ import { OSMD } from '../src/OSMD/OSMD';
         };
 
         // Create OSMD object and canvas
-        osmdObj = new OSMD(canvas, false, backendSelect.value);
-        osmdObj.setLogLevel('info');
+        openSheetMusicDisplay = new OpenSheetMusicDisplay(canvas, false, backendSelect.value);
+        openSheetMusicDisplay.setLogLevel('info');
         document.body.appendChild(canvas);
 
         // Set resize event handler
@@ -110,7 +110,7 @@ import { OSMD } from '../src/OSMD/OSMD';
                 var width = document.body.clientWidth;
                 canvas.width = width;
                 try {
-                osmdObj.render();
+                openSheetMusicDisplay.render();
                 } catch (e) {}
                 enable();
             }
@@ -119,28 +119,28 @@ import { OSMD } from '../src/OSMD/OSMD';
         window.addEventListener("keydown", function(e) {
             var event = window.event ? window.event : e;
             if (event.keyCode === 39) {
-                osmdObj.cursor.next();
+                openSheetMusicDisplay.cursor.next();
             }
         });
         nextCursorBtn.addEventListener("click", function() {
-            osmdObj.cursor.next();
+            openSheetMusicDisplay.cursor.next();
         });
         resetCursorBtn.addEventListener("click", function() {
-            osmdObj.cursor.reset();
+            openSheetMusicDisplay.cursor.reset();
         });
         hideCursorBtn.addEventListener("click", function() {
-            osmdObj.cursor.hide();
+            openSheetMusicDisplay.cursor.hide();
         });
         showCursorBtn.addEventListener("click", function() {
-            osmdObj.cursor.show();
+            openSheetMusicDisplay.cursor.show();
         });
 
         backendSelect.addEventListener("change", function(e) {
             var value = e.target.value;
             // clears the canvas element
             canvas.innerHTML = "";
-            osmdObj = new OSMD(canvas, false, value);
-            osmdObj.setLogLevel('info');
+            openSheetMusicDisplay = new OpenSheetMusicDisplay(canvas, false, value);
+            openSheetMusicDisplay.setLogLevel('info');
             selectOnChange();
 
         });
@@ -182,9 +182,9 @@ import { OSMD } from '../src/OSMD/OSMD';
             str = folder + select.value;
         }
         zoom = 1.0;
-        osmdObj.load(str).then(
+        openSheetMusicDisplay.load(str).then(
             function() {
-                return osmdObj.render();
+                return openSheetMusicDisplay.render();
             },
             function(e) {
                 error("Error reading sheet: " + e);
@@ -216,8 +216,8 @@ import { OSMD } from '../src/OSMD/OSMD';
     function scale() {
         disable();
         window.setTimeout(function(){
-            osmdObj.zoom = zoom;
-            osmdObj.render();
+            openSheetMusicDisplay.zoom = zoom;
+            openSheetMusicDisplay.render();
             enable();
         }, 0);
     }

package.json

@@ -2,8 +2,8 @@
   "name": "opensheetmusicdisplay",
   "version": "0.2.1",
   "description": "An open source JavaScript engine for displaying MusicXML based on VexFlow.",
-  "main": "dist/src/OSMD/OSMD.js",
-  "typings": "dist/src/OSMD/OSMD",
+  "main": "dist/src/OpenSheetMusicDisplay/OpenSheetMusicDisplay.js",
+  "typings": "dist/src/OpenSheetMusicDisplay/OpenSheetMusicDisplay",
   "scripts": {
     "docs": "typedoc --out ./build/docs --name OpenSheetMusicDisplay --module commonjs --target ES5 --mode file ./src/**/*.ts",
     "eslint": "eslint .",

src/Common/Logging.ts

@@ -7,15 +7,15 @@
  */
 export class Logging {
     public static debug(...args: any[]): void {
-        console.debug("[OSMD] ", args.join(" "));
+        console.debug("[opensheetmusicdisplay] ", args.join(" "));
     }
     public static log(...args: any[]): void {
-        console.log("[OSMD] ", args.join(" "));
+        console.log("[opensheetmusicdisplay] ", args.join(" "));
     }
     public static error(...args: any[]): void {
-        console.error("[OSMD] ", args.join(" "));
+        console.error("[opensheetmusicdisplay] ", args.join(" "));
     }
     public static warn(...args: any[]): void {
-        console.warn("[OSMD] ", args.join(" "));
+        console.warn("[opensheetmusicdisplay] ", args.join(" "));
     }
 }

src/MusicalScore/VoiceData/Expressions/UnknownExpression.ts

@@ -2,10 +2,6 @@ import {PlacementEnum, AbstractExpression} from "./AbstractExpression";
 import {TextAlignment} from "../../../Common/Enums/TextAlignment";
 
 export class UnknownExpression extends AbstractExpression {
-    //constructor(label: string, placementEnum: PlacementEnum, staffNumber: number) {
-    //    this(label, placementEnum, OSMDTextAlignment.LeftBottom, staffNumber);
-    //
-    //}
     constructor(label: string, placementEnum: PlacementEnum, textAlignment: TextAlignment, staffNumber: number) {
         super();
         this.label = label;

src/OSMD/Cursor.ts → src/OpenSheetMusicDisplay/Cursor.ts

@@ -3,16 +3,16 @@ import {MusicPartManager} from "../MusicalScore/MusicParts/MusicPartManager";
 import {VoiceEntry} from "../MusicalScore/VoiceData/VoiceEntry";
 import {VexFlowStaffEntry} from "../MusicalScore/Graphical/VexFlow/VexFlowStaffEntry";
 import {MusicSystem} from "../MusicalScore/Graphical/MusicSystem";
-import {OSMD} from "./OSMD";
+import {OpenSheetMusicDisplay} from "./OpenSheetMusicDisplay";
 import {GraphicalMusicSheet} from "../MusicalScore/Graphical/GraphicalMusicSheet";
 
 /**
  * A cursor which can iterate through the music sheet.
  */
 export class Cursor {
-  constructor(container: HTMLElement, osmd: OSMD) {
+  constructor(container: HTMLElement, openSheetMusicDisplay: OpenSheetMusicDisplay) {
     this.container = container;
-    this.osmd = osmd;
+    this.openSheetMusicDisplay = openSheetMusicDisplay;
     const curs: HTMLElement = document.createElement("img");
     curs.style.position = "absolute";
     curs.style.zIndex = "-1";
@@ -21,7 +21,7 @@ export class Cursor {
   }
 
   private container: HTMLElement;
-  private osmd: OSMD;
+  private openSheetMusicDisplay: OpenSheetMusicDisplay;
   private manager: MusicPartManager;
   private iterator: MusicPartManagerIterator;
   private graphic: GraphicalMusicSheet;
@@ -44,11 +44,11 @@ export class Cursor {
     this.update();
     // Forcing the sheet to re-render is not necessary anymore,
     // since the cursor is an HTML element.
-    // this.osmd.render();
+    // this.openSheetMusicDisplay.render();
   }
 
   public update(): void {
-    // Warning! This should NEVER call this.osmd.render()
+    // Warning! This should NEVER call this.openSheetMusicDisplay.render()
     if (this.hidden) {
       return;
     }
@@ -90,10 +90,10 @@ export class Cursor {
 
     // This the current HTML Cursor:
     const cursorElement: HTMLImageElement = this.cursorElement;
-    cursorElement.style.top = (y * 10.0 * this.osmd.zoom) + "px";
-    cursorElement.style.left = ((x - 1.5) * 10.0 * this.osmd.zoom) + "px";
-    cursorElement.height = (height * 10.0 * this.osmd.zoom);
-    const newWidth: number = 3 * 10.0 * this.osmd.zoom;
+    cursorElement.style.top = (y * 10.0 * this.openSheetMusicDisplay.zoom) + "px";
+    cursorElement.style.left = ((x - 1.5) * 10.0 * this.openSheetMusicDisplay.zoom) + "px";
+    cursorElement.height = (height * 10.0 * this.openSheetMusicDisplay.zoom);
+    const newWidth: number = 3 * 10.0 * this.openSheetMusicDisplay.zoom;
     if (newWidth !== cursorElement.width) {
       cursorElement.width = newWidth;
       this.updateStyle(newWidth);
@@ -113,7 +113,7 @@ export class Cursor {
     //this.graphic.Cursors.length = 0;
     // Forcing the sheet to re-render is not necessary anymore
     //if (!this.hidden) {
-    //    this.osmd.render();
+    //    this.openSheetMusicDisplay.render();
     //}
     this.hidden = true;
   }

src/OSMD/OSMD.ts → src/OpenSheetMusicDisplay/OpenSheetMusicDisplay.ts

@@ -14,7 +14,7 @@ import {Promise} from "es6-promise";
 import {AJAX} from "./AJAX";
 import * as log from "loglevel";
 
-export class OSMD {
+export class OpenSheetMusicDisplay {
     /**
      * The easy way of displaying a MusicXML sheet music file
      * @param container is either the ID, or the actual "div" element which will host the music sheet
@@ -30,7 +30,7 @@ export class OSMD {
             this.container = <HTMLElement>container;
         }
         if (!this.container) {
-            throw new Error("Please pass a valid div container to OSMD");
+            throw new Error("Please pass a valid div container to OpenSheetMusicDisplay");
         }
 
         if (backend === "svg") {
@@ -72,7 +72,7 @@ export class OSMD {
         this.reset();
         if (typeof content === "string") {
             const str: string = <string>content;
-            const self: OSMD = this;
+            const self: OpenSheetMusicDisplay = this;
             if (str.substr(0, 4) === "\x50\x4b\x03\x04") {
                 // This is a zip file, unpack it first
                 return MXLHelper.MXLtoXMLstring(str).then(
@@ -81,7 +81,7 @@ export class OSMD {
                     },
                     (err: any) => {
                         log.debug(err);
-                        throw new Error("OSMD: Invalid MXL file");
+                        throw new Error("OpenSheetMusicDisplay: Invalid MXL file");
                     }
                 );
             }
@@ -100,7 +100,7 @@ export class OSMD {
         }
 
         if (!content || !(<any>content).nodeName) {
-            return Promise.reject(new Error("OSMD: The document which was provided is invalid"));
+            return Promise.reject(new Error("OpenSheetMusicDisplay: The document which was provided is invalid"));
         }
         const children: NodeList = (<Document>content).childNodes;
         let elem: Element;
@@ -112,7 +112,7 @@ export class OSMD {
             }
         }
         if (!elem) {
-            return Promise.reject(new Error("OSMD: Document is not a valid 'partwise' MusicXML"));
+            return Promise.reject(new Error("OpenSheetMusicDisplay: Document is not a valid 'partwise' MusicXML"));
         }
         const score: IXmlElement = new IXmlElement(elem);
         const calc: MusicSheetCalculator = new VexFlowMusicSheetCalculator();
@@ -129,7 +129,7 @@ export class OSMD {
      */
     public render(): void {
         if (!this.graphic) {
-            throw new Error("OSMD: Before rendering a music sheet, please load a MusicXML file");
+            throw new Error("OpenSheetMusicDisplay: Before rendering a music sheet, please load a MusicXML file");
         }
         const width: number = this.container.offsetWidth;
         // Before introducing the following optimization (maybe irrelevant), tests
@@ -208,7 +208,7 @@ export class OSMD {
      * Attach the appropriate handler to the window.onResize event
      */
     private autoResize(): void {
-        const self: OSMD = this;
+        const self: OpenSheetMusicDisplay = this;
         this.handleResize(
             () => {
                 // empty

test/Common/FileIO/Xml_Test.ts

@@ -1,6 +1,6 @@
 import {IXmlElement} from "../../../src/Common/FileIO/Xml";
 import {TestUtils} from "../../Util/TestUtils";
-import {OSMD} from "../../../src/OSMD/OSMD";
+import {OpenSheetMusicDisplay} from "../../../src/OpenSheetMusicDisplay/OpenSheetMusicDisplay";
 
 // Test XML simple document
 const xmlTestData: string = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\
@@ -48,8 +48,8 @@ describe("XML interface", () => {
             // Load the xml file content
             const score: Document = TestUtils.getScore(scoreName);
             const div: HTMLElement = document.createElement("div");
-            const osmd: OSMD = new OSMD(div);
-            osmd.load(score);
+            const openSheetMusicDisplay: OpenSheetMusicDisplay = new OpenSheetMusicDisplay(div);
+            openSheetMusicDisplay.load(score);
             done();
         }).timeout(3000);
     }

test/Common/OSMD/OSMD_Test.ts

@@ -1,14 +1,14 @@
 import chai = require("chai");
-import {OSMD} from "../../../src/OSMD/OSMD";
+import {OpenSheetMusicDisplay} from "../../../src/OpenSheetMusicDisplay/OpenSheetMusicDisplay";
 import {TestUtils} from "../../Util/TestUtils";
 
 
-describe("OSMD Main Export", () => {
+describe("OpenSheetMusicDisplay Main Export", () => {
     let container1: HTMLElement;
 
     it("no container", (done: MochaDone) => {
         chai.expect(() => {
-            return new OSMD(undefined);
+            return new OpenSheetMusicDisplay(undefined);
         }).to.throw(/container/);
         done();
     });
@@ -16,7 +16,7 @@ describe("OSMD Main Export", () => {
     it("container", (done: MochaDone) => {
         const div: HTMLElement = document.createElement("div");
         chai.expect(() => {
-            return new OSMD(div);
+            return new OpenSheetMusicDisplay(div);
         }).to.not.throw(Error);
         done();
     });
@@ -24,10 +24,10 @@ describe("OSMD Main Export", () => {
     it("load MXL from string", (done: MochaDone) => {
         const mxl: string = TestUtils.getMXL("MozartTrio.mxl");
         const div: HTMLElement = document.createElement("div");
-        const osmd: OSMD = new OSMD(div);
-        osmd.load(mxl).then(
+        const opensheetmusicdisplay: OpenSheetMusicDisplay = new OpenSheetMusicDisplay(div);
+        opensheetmusicdisplay.load(mxl).then(
             (_: {}) => {
-                osmd.render();
+                opensheetmusicdisplay.render();
                 done();
             },
             done
@@ -37,8 +37,8 @@ describe("OSMD Main Export", () => {
     it("load invalid MXL from string", (done: MochaDone) => {
         const mxl: string = "\x50\x4b\x03\x04";
         const div: HTMLElement = document.createElement("div");
-        const osmd: OSMD = new OSMD(div);
-        osmd.load(mxl).then(
+        const opensheetmusicdisplay: OpenSheetMusicDisplay = new OpenSheetMusicDisplay(div);
+        opensheetmusicdisplay.load(mxl).then(
             (_: {}) => {
                 done(new Error("Corrupted MXL appears to be loaded correctly"));
             },
@@ -56,10 +56,10 @@ describe("OSMD Main Export", () => {
         const score: Document = TestUtils.getScore("MuzioClementi_SonatinaOpus36No1_Part1.xml");
         const xml: string = new XMLSerializer().serializeToString(score);
         const div: HTMLElement = document.createElement("div");
-        const osmd: OSMD = new OSMD(div);
-        osmd.load(xml).then(
+        const opensheetmusicdisplay: OpenSheetMusicDisplay = new OpenSheetMusicDisplay(div);
+        opensheetmusicdisplay.load(xml).then(
             (_: {}) => {
-                osmd.render();
+                opensheetmusicdisplay.render();
                 done();
             },
             done
@@ -69,10 +69,10 @@ describe("OSMD Main Export", () => {
     it("load XML Document", (done: MochaDone) => {
         const score: Document = TestUtils.getScore("MuzioClementi_SonatinaOpus36No1_Part1.xml");
         const div: HTMLElement = document.createElement("div");
-        const osmd: OSMD = new OSMD(div);
-        osmd.load(score).then(
+        const opensheetmusicdisplay: OpenSheetMusicDisplay = new OpenSheetMusicDisplay(div);
+        opensheetmusicdisplay.load(score).then(
             (_: {}) => {
-                osmd.render();
+                opensheetmusicdisplay.render();
                 done();
             },
             done
@@ -82,10 +82,10 @@ describe("OSMD Main Export", () => {
     it("load MXL Document by URL", (done: MochaDone) => {
         const url: string = "base/test/data/MozartTrio.mxl";
         const div: HTMLElement = document.createElement("div");
-        const osmd: OSMD = new OSMD(div);
-        osmd.load(url).then(
+        const opensheetmusicdisplay: OpenSheetMusicDisplay = new OpenSheetMusicDisplay(div);
+        opensheetmusicdisplay.load(url).then(
             (_: {}) => {
-                osmd.render();
+                opensheetmusicdisplay.render();
                 done();
             },
             done
@@ -95,8 +95,8 @@ describe("OSMD Main Export", () => {
     it("load MXL Document by invalid URL", (done: MochaDone) => {
         const url: string = "https://www.google.com";
         const div: HTMLElement = document.createElement("div");
-        const osmd: OSMD = new OSMD(div);
-        osmd.load(url).then(
+        const opensheetmusicdisplay: OpenSheetMusicDisplay = new OpenSheetMusicDisplay(div);
+        opensheetmusicdisplay.load(url).then(
             (_: {}) => {
                 done(new Error("Invalid URL appears to be loaded correctly"));
             },
@@ -113,8 +113,8 @@ describe("OSMD Main Export", () => {
     it("load invalid XML string", (done: MochaDone) => {
         const xml: string = "<?xml";
         const div: HTMLElement = document.createElement("div");
-        const osmd: OSMD = new OSMD(div);
-        osmd.load(xml).then(
+        const opensheetmusicdisplay: OpenSheetMusicDisplay = new OpenSheetMusicDisplay(div);
+        opensheetmusicdisplay.load(xml).then(
             (_: {}) => {
                 done(new Error("Corrupted XML appears to be loaded correctly"));
             },
@@ -130,9 +130,9 @@ describe("OSMD Main Export", () => {
 
     it("render without loading", (done: MochaDone) => {
         const div: HTMLElement = document.createElement("div");
-        const osmd: OSMD = new OSMD(div);
+        const opensheetmusicdisplay: OpenSheetMusicDisplay = new OpenSheetMusicDisplay(div);
         chai.expect(() => {
-            return osmd.render();
+            return opensheetmusicdisplay.render();
         }).to.throw(/load/);
         done();
     });
@@ -150,11 +150,11 @@ describe("OSMD Main Export", () => {
     it("test width 500", (done: MochaDone) => {
         const div: HTMLElement = container1;
         div.style.width = "500px";
-        const osmd: OSMD = new OSMD(div);
+        const opensheetmusicdisplay: OpenSheetMusicDisplay = new OpenSheetMusicDisplay(div);
         const score: Document = TestUtils.getScore("MuzioClementi_SonatinaOpus36No1_Part1.xml");
-        osmd.load(score).then(
+        opensheetmusicdisplay.load(score).then(
             (_: {}) => {
-                osmd.render();
+                opensheetmusicdisplay.render();
                 chai.expect(div.offsetWidth).to.equal(500);
                 done();
             },
@@ -165,11 +165,11 @@ describe("OSMD Main Export", () => {
     it("test width 200", (done: MochaDone) => {
         const div: HTMLElement = container1;
         div.style.width = "200px";
-        const osmd: OSMD = new OSMD(div);
+        const opensheetmusicdisplay: OpenSheetMusicDisplay = new OpenSheetMusicDisplay(div);
         const score: Document = TestUtils.getScore("MuzioClementi_SonatinaOpus36No1_Part1.xml");
-        osmd.load(score).then(
+        opensheetmusicdisplay.load(score).then(
             (_: {}) => {
-                osmd.render();
+                opensheetmusicdisplay.render();
                 chai.expect(div.offsetWidth).to.equal(200);
                 done();
             },

webpack.common.js

@@ -4,7 +4,7 @@ var webpack = require('webpack')
 
 module.exports = {
     entry: {
-        'osmd': './src/OSMD/OSMD.ts', // Main library
+        'opensheetmusicdisplay': './src/OpenSheetMusicDisplay/OpenSheetMusicDisplay.ts', // Main library
         'demo': './demo/index.js' // Demo index
     },
     output: {