@pixwel/pixwel-sdk 1.1.0

package/test/Filename.spec.js

@@ -0,0 +1,728 @@
+import Filename from "../lib/Filename";
+let mocks = require("./mocks/mocks");
+
+describe("Filename", function() {
+	describe("render", function() {
+		it("renders tags as an underscore-separated string", function() {
+			let asset = {
+				name: "Test Asset A",
+				slug: "test-asset-a",
+				type: "trailer.intl",
+				mediaType: "video",
+				project: {
+					filePrefix: "TESTPROJECT"
+				}
+			};
+			let options = {
+				language: "ENG",
+				country: "WW",
+				tags: {
+					Text: "txtd",
+					Extra: ["COMING-SOON", "HOJE"],
+					Codec: "PRORES",
+					Resolution: "640x480",
+					Framerate: "23.98",
+					"Frame Mode": "progressive"
+				}
+			};
+			expect(Filename.render(mocks.tags, mocks.types, asset, options)).toBe(
+				"TESTPROJECT_ITR-TEST-ASSET-A_ENG_TXTD_COMING-SOON_HOJE_PRORES_480p2398"
+			);
+		});
+
+		it("displays resolution for images", function () {
+			let asset = {
+				name: "Test Asset A",
+				slug: "test-asset-a",
+				type: "trailer.intl",
+				mediaType: "video",
+				project: {
+					filePrefix: "TESTPROJECT"
+				}
+			};
+			let options = {
+				language: "ENG",
+				country: "WW",
+				tags: {
+					Text: 'txtd',
+					Resolution: "640x480"
+				}
+			};
+			expect(Filename.render(mocks.tags, mocks.types, asset, options, 'image')).toBe(
+				"TESTPROJECT_ITR-TEST-ASSET-A_ENG_TXTD_640x480"
+			);
+		});
+
+		it("renders asset names with contractions correctly", function() {
+			let asset = {
+				name: "Can't Int'l 10",
+				slug: "cant-intl-10",
+				type: "trailer.intl",
+				mediaType: "video",
+				project: {
+					filePrefix: "TESTPROJECT"
+				}
+			};
+			let options = {
+				language: "ENG",
+				tags: {
+					Text: "txtd",
+					Codec: "prores",
+					Resolution: "640x480",
+					Framerate: "23.98",
+					"Frame Mode": "progressive"
+				}
+			};
+			expect(Filename.render(mocks.tags, mocks.types, asset, options)).toBe(
+				"TESTPROJECT_ITR-CANT-INTL-10_ENG_TXTD_PRORES_480p2398"
+			);
+		});
+
+		it("renders version", function() {
+			let asset = {
+				name: "Test Asset A",
+				slug: "test-asset-a",
+				type: "trailer.intl",
+				mediaType: "video",
+				project: {
+					filePrefix: "TESTPROJECT"
+				}
+			};
+			let options = {
+				version: "rev",
+				language: "ENG",
+				tags: {
+					Text: "txtd",
+					Codec: "prores",
+					Resolution: "640x480",
+					Framerate: "23.98",
+					"Frame Mode": "progressive"
+				}
+			};
+			expect(Filename.render(mocks.tags, mocks.types, asset, options)).toBe(
+				"TESTPROJECT_ITR-TEST-ASSET-A_ENG_TXTD_REV_PRORES_480p2398"
+			);
+		});
+
+		it("throws exception if missing asset.project", function() {
+			let asset = {
+				name: "Test Asset A",
+				slug: "test-asset-a",
+				type: "trailer.intl",
+				mediaType: "video"
+				// project: {
+				// 	filePrefix: 'TESTPROJECT'
+				// }
+			};
+			let options = {
+				language: "ENG"
+			};
+			expect(() => {
+				Filename.render(mocks.tags, mocks.types, asset, options);
+			}).toThrow("missing asset.project");
+		});
+
+		it("throws exception if missing asset.length (film-clip)", function() {
+			let asset = {
+				name: "Test Asset A",
+				slug: "test-asset-a",
+				type: "film-clip",
+				mediaType: "video",
+				project: {
+					filePrefix: "TESTPROJECT"
+				}
+			};
+			let options = {
+				language: "ENG"
+			};
+			expect(() => {
+				Filename.render(mocks.tags, mocks.types, asset, options);
+			}).toThrow("missing asset.length");
+		});
+
+		// it('throws exception if SubDub and Text is both supplied', function() {
+		//     let asset = {
+		//         name: 'Test Asset A',
+		//         slug: 'test-asset-a',
+		//         type: 'trailer.intl',
+		//         mediaType: 'video',
+		//         project: {
+		//             filePrefix: 'TESTPROJECT'
+		//         }
+		//     };
+		//     let options = {
+		//         language: 'ENG',
+		//         tags: {
+		//             Codec: 'prores',
+		//             Resolution: '640x480',
+		//             Framerate: '23.98',
+		//             "Frame Mode": 'progressive',
+		//             SubDub: {
+		//                 dub: true
+		//             },
+		//             Text: 'txtd'
+		//         }
+		//     };
+		//     expect(() => {
+		//         Filename.render(mocks.tags, mocks.types, asset, options)
+		//     }).toThrow('conflicting options supplied: SubDub and Text');
+		// });
+
+		it("throws exception if both SubDub and Text is not supplied", function() {
+			let asset = {
+				name: "Test Asset A",
+				slug: "test-asset-a",
+				type: "trailer.intl",
+				mediaType: "video",
+				project: {
+					filePrefix: "TESTPROJECT"
+				}
+			};
+			let options = {
+				language: "ENG",
+				tags: {
+					Codec: "prores",
+					Resolution: "640x480",
+					Framerate: "23.98",
+					"Frame Mode": "progressive"
+				}
+			};
+			expect(() => {
+				Filename.render(mocks.tags, mocks.types, asset, options);
+			}).toThrow("missing options.tags.Text or options.tags.SubDub");
+		});
+
+		// it("throws exception if mediaType=video is missing Codec", function() {
+		// 	let asset = {
+		// 		name: "Test Asset A",
+		// 		slug: "test-asset-a",
+		// 		type: "trailer.intl",
+		// 		mediaType: "video",
+		// 		project: {
+		// 			filePrefix: "TESTPROJECT"
+		// 		}
+		// 	};
+		// 	let options = {
+		// 		language: "ENG",
+		// 		tags: {
+		// 			// Codec: 'prores',
+		// 			Text: "txtd",
+		// 			Resolution: "640x480",
+		// 			Framerate: "23.98",
+		// 			"Frame Mode": "progressive"
+		// 		}
+		// 	};
+		// 	expect(() => {
+		// 		Filename.render(mocks.tags, mocks.types, asset, options);
+		// 	}).toThrow("missing options.tags.Codec");
+		// });
+
+		it("throws exception if missing Resolution", function() {
+			let asset = {
+				name: "Test Asset A",
+				slug: "test-asset-a",
+				type: "trailer.intl",
+				mediaType: "video",
+				project: {
+					filePrefix: "TESTPROJECT"
+				}
+			};
+			let options = {
+				language: "ENG",
+				tags: {
+					Codec: "prores",
+					Text: "txtd",
+					// Resolution: '640x480',
+					Framerate: "23.98",
+					"Frame Mode": "progressive"
+				}
+			};
+			expect(() => {
+				Filename.render(mocks.tags, mocks.types, asset, options, 'video');
+			}).toThrow("missing options.tags.Resolution");
+		});
+
+		it("throws exception if missing Framerate", function() {
+			let asset = {
+				name: "Test Asset A",
+				slug: "test-asset-a",
+				type: "trailer.intl",
+				mediaType: "video",
+				project: {
+					filePrefix: "TESTPROJECT"
+				}
+			};
+			let options = {
+				language: "ENG",
+				tags: {
+					Codec: "prores",
+					Text: "txtd",
+					Resolution: "640x480",
+					// Framerate: '23.98',
+					"Frame Mode": "progressive"
+				}
+			};
+			expect(() => {
+				Filename.render(mocks.tags, mocks.types, asset, options, 'video');
+			}).toThrow("missing options.tags.Framerate");
+		});
+
+		it("throws exception if missing Frame Mode", function() {
+			let asset = {
+				name: "Test Asset A",
+				slug: "test-asset-a",
+				type: "trailer.intl",
+				mediaType: "video",
+				project: {
+					filePrefix: "TESTPROJECT"
+				}
+			};
+			let options = {
+				language: "ENG",
+				tags: {
+					Codec: "prores",
+					Text: "txtd",
+					Resolution: "640x480",
+					Framerate: "23.98"
+					// "Frame Mode": 'progressive'
+				}
+			};
+			expect(() => {
+				Filename.render(mocks.tags, mocks.types, asset, options, 'video');
+			}).toThrow("missing options.tags[Frame Mode]");
+		});
+
+		it("throws exception if missing asset.length (featurette)", function() {
+			let asset = {
+				name: "Test Asset A",
+				slug: "test-asset-a",
+				type: "featurette",
+				mediaType: "video",
+				project: {
+					filePrefix: "TESTPROJECT"
+				}
+			};
+			let options = {
+				language: "ENG"
+			};
+			expect(() => {
+				Filename.render(mocks.tags, mocks.types, asset, options);
+			}).toThrow("missing asset.length");
+		});
+
+		it("throws exception if missing asset.project.filePrefix", function() {
+			let asset = {
+				name: "Test Asset A",
+				slug: "test-asset-a",
+				type: "trailer.intl",
+				project: {
+					// 	filePrefix: 'TESTPROJECT'
+				}
+			};
+			let options = {
+				language: "ENG"
+			};
+			expect(() => {
+				Filename.render(mocks.tags, mocks.types, asset, options);
+			}).toThrow("missing asset.project.filePrefix");
+		});
+
+		it("throws exception if missing asset.name", function() {
+			let asset = {
+				// name: 'Test Asset A',
+				slug: "test-asset-a",
+				type: "trailer.intl",
+				project: {
+					filePrefix: "TESTPROJECT"
+				}
+			};
+			let options = {
+				language: "ENG"
+			};
+			expect(() => {
+				Filename.render(mocks.tags, mocks.types, asset, options);
+			}).toThrow("missing asset.name");
+		});
+
+		it("throws exception if missing asset.type", function() {
+			let asset = {
+				name: "Test Asset A",
+				slug: "test-asset-a",
+				// type: 'trailer.intl',
+				project: {
+					filePrefix: "TESTPROJECT"
+				}
+			};
+			let options = {
+				language: "ENG"
+			};
+			expect(() => {
+				Filename.render(mocks.tags, mocks.types, asset, options);
+			}).toThrow("missing asset.type");
+		});
+
+		it("throws exception if missing options.language", function() {
+			let asset = {
+				name: "Test Asset A",
+				slug: "test-asset-a",
+				type: "trailer.intl",
+				mediaType: "video",
+				project: {
+					filePrefix: "TESTPROJECT"
+				}
+			};
+			expect(() => {
+				Filename.render(mocks.tags, mocks.types, asset);
+			}).toThrow("missing options.language");
+		});
+
+		it("throws exception if missing options.tags.Text", function() {
+			let asset = {
+				name: "Test Asset A",
+				slug: "test-asset-a",
+				type: "trailer.intl",
+				mediaType: "video",
+				project: {
+					filePrefix: "TESTPROJECT"
+				}
+			};
+			let options = {
+				tags: {
+					Text: ""
+				}
+			};
+			expect(() => {
+				Filename.render(mocks.tags, mocks.types, asset);
+			}).toThrow("missing options.language");
+		});
+
+		it("renders country and territory", function() {
+			let asset = {
+				name: "Test Asset A",
+				slug: "test-asset-a",
+				type: "trailer.intl",
+				mediaType: "video",
+				project: {
+					filePrefix: "TESTPROJECT"
+				}
+			};
+			let options = {
+				language: "ENG",
+				country: "US",
+				tags: {
+					Text: "txtd",
+					Codec: "prores",
+					Resolution: "640x480",
+					Framerate: "23.98",
+					"Frame Mode": "progressive"
+				}
+			};
+			expect(Filename.render(mocks.tags, mocks.types, asset, options)).toBe(
+				"TESTPROJECT_ITR-TEST-ASSET-A_ENG-US_TXTD_PRORES_480p2398"
+			);
+		});
+
+		it("renders domestic trailer type with custom name", function() {
+			let asset = {
+				name: "Test Asset A",
+				slug: "test-asset-a",
+				type: "trailer.us",
+				mediaType: "video",
+				project: {
+					filePrefix: "TESTPROJECT"
+				}
+			};
+			let options = {
+				language: "ENG",
+				tags: {
+					Text: "txtd",
+					Codec: "prores",
+					Resolution: "640x480",
+					Framerate: "23.98",
+					"Frame Mode": "progressive"
+				}
+			};
+			expect(Filename.render(mocks.tags, mocks.types, asset, options)).toBe(
+				"TESTPROJECT_DTR-TEST-ASSET-A_ENG_TXTD_PRORES_480p2398"
+			);
+		});
+
+		it("renders generic trailer type", function() {
+			let asset = {
+				name: "Generic Trailer",
+				slug: "generic-trailer",
+				type: "trailer",
+				mediaType: "video",
+				project: {
+					filePrefix: "TESTPROJECT"
+				}
+			};
+			let options = {
+				language: "ENG",
+				tags: {
+					Text: "txtd",
+					Codec: "prores",
+					Resolution: "640x480",
+					Framerate: "23.98",
+					"Frame Mode": "progressive"
+				}
+			};
+			expect(Filename.render(mocks.tags, mocks.types, asset, options)).toBe(
+				"TESTPROJECT_TR-GENERIC-TRAILER_ENG_TXTD_PRORES_480p2398"
+			);
+		});
+
+		it("renders non-trailer types", function() {
+			let asset = {
+				name: "Cool Spot 15",
+				slug: "cool-spot-15",
+				type: "tv-spot.intl",
+				mediaType: "video",
+				project: {
+					filePrefix: "TESTPROJECT"
+				}
+			};
+			let options = {
+				language: "ENG",
+				tags: {
+					Text: "txtd",
+					Codec: "prores",
+					Resolution: "640x480",
+					Framerate: "23.98",
+					"Frame Mode": "progressive"
+				}
+			};
+			expect(Filename.render(mocks.tags, mocks.types, asset, options)).toBe(
+				"TESTPROJECT_TV-SPOT-INTL_COOL-SPOT-15_ENG_TXTD_PRORES_480p2398"
+			);
+		});
+
+		it("throws an error if asset type does not exist", function() {
+			let asset = {
+				name: "Cool Spot 15",
+				slug: "cool-spot-15",
+				type: "doesnt-exist",
+				mediaType: "video",
+				project: {
+					filePrefix: "TESTPROJECT"
+				}
+			};
+			let options = {
+				language: "ENG",
+				tags: {
+					Text: "txtd",
+					Codec: "prores",
+					Resolution: "640x480",
+					Framerate: "23.98",
+					"Frame Mode": "progressive"
+				}
+			};
+			expect(function() {
+				Filename.render(mocks.tags, mocks.types, asset, options);
+			}).toThrow('Asset type "doesnt-exist" could not be found');
+		});
+
+		it("contains running time from film clips", function() {
+			let asset = {
+				name: "Ultra Violence",
+				slug: "ultra-violence",
+				type: "film-clip.intl",
+				length: 63,
+				mediaType: "video",
+				project: {
+					filePrefix: "TESTPROJECT"
+				}
+			};
+			let options = {
+				language: "ENG",
+				tags: {
+					Text: "txtd",
+					Codec: "prores",
+					Resolution: "640x480",
+					Framerate: "23.98",
+					"Frame Mode": "progressive"
+				}
+			};
+			expect(Filename.render(mocks.tags, mocks.types, asset, options)).toBe(
+				"TESTPROJECT_FILM-CLIP-INTL_ULTRA-VIOLENCE_1MIN3SEC_ENG_TXTD_PRORES_480p2398"
+			);
+
+			asset.length = 60;
+
+			expect(Filename.render(mocks.tags, mocks.types, asset, options)).toBe(
+				"TESTPROJECT_FILM-CLIP-INTL_ULTRA-VIOLENCE_1MIN_ENG_TXTD_PRORES_480p2398"
+			);
+
+			asset.length = 45;
+
+			expect(Filename.render(mocks.tags, mocks.types, asset, options)).toBe(
+				"TESTPROJECT_FILM-CLIP-INTL_ULTRA-VIOLENCE_45SEC_ENG_TXTD_PRORES_480p2398"
+			);
+		});
+
+		it("renders `set` tags when all tags in `set` are specified but retains `codec`", function() {
+			let asset = {
+				name: "Test Asset A",
+				slug: "test-asset-a",
+				type: "trailer.intl",
+				mediaType: "video",
+				project: {
+					filePrefix: "TESTPROJECT"
+				}
+			};
+			let options = {
+				language: "ENG",
+				tags: {
+					Codec: "h264",
+					Resolution: "1920x1080",
+					Usage: "online",
+					Text: "txtd",
+					Framerate: "23.98",
+					"Frame Mode": "progressive"
+				}
+			};
+			expect(Filename.render(mocks.tags, mocks.types, asset, options)).toBe(
+				"TESTPROJECT_ITR-TEST-ASSET-A_ENG_TXTD_H264_1080p2398"
+			);
+		});
+
+		it("includes `Frame mode` and `Framerate`", function() {
+			let asset = {
+				name: "Test Asset A",
+				slug: "test-asset-a",
+				type: "trailer.intl",
+				mediaType: "video",
+				project: {
+					filePrefix: "TESTPROJECT"
+				}
+			};
+			let options = {
+				language: "ENG",
+				country: "WW",
+				tags: {
+					Resolution: "1920x1080",
+					"Frame Mode": "progressive",
+					Framerate: "29.97",
+					Text: "txtd",
+					Extra: ["COMING-SOON", "HOJE"],
+					Codec: "PRORES"
+				}
+			};
+			expect(Filename.render(mocks.tags, mocks.types, asset, options)).toBe(
+				"TESTPROJECT_ITR-TEST-ASSET-A_ENG_TXTD_COMING-SOON_HOJE_PRORES_1080p2997"
+			);
+		});
+
+		it("does not redundantly include tag info", function() {
+			let asset = {
+				name: "Test Asset A",
+				slug: "test-asset-a",
+				type: "trailer.intl",
+				mediaType: "video",
+				project: {
+					filePrefix: "TESTPROJECT"
+				}
+			};
+			let options = {
+				language: "ENG",
+				country: "WW",
+				tags: {
+					Resolution: "1080i",
+					"Frame Mode": "progressive",
+					Framerate: "29.97",
+					Text: "txtd",
+					Extra: ["COMING-SOON", "HOJE"],
+					Codec: "PRORES"
+				}
+			};
+			expect(Filename.render(mocks.tags, mocks.types, asset, options)).toBe(
+				"TESTPROJECT_ITR-TEST-ASSET-A_ENG_TXTD_COMING-SOON_HOJE_PRORES_1080i2997"
+			);
+
+			options = {
+				language: "ENG",
+				country: "WW",
+				tags: {
+					Usage: "online",
+					Aspect: "16:9",
+					Codec: "h264",
+					Resolution: "1920x1080",
+					"Frame Mode": "progressive",
+					Framerate: "29.97",
+					Text: "txtd",
+					Extra: ["COMING-SOON", "HOJE"]
+				}
+			};
+
+			expect(Filename.render(mocks.tags, mocks.types, asset, options)).toBe(
+				"TESTPROJECT_ITR-TEST-ASSET-A_ENG_TXTD_COMING-SOON_HOJE_H264_1080p2997"
+			);
+		});
+
+		it("converts asset names containing `int'l` to `intl`", function() {
+			let asset = {
+				type: "tv-spot.intl",
+				name: "Test Asset Int'l 10",
+				slug: "test-asset-intl-10",
+				mediaType: "video",
+				project: {
+					filePrefix: "TESTPROJECT"
+				}
+			};
+			let options = {
+				language: "ENG",
+				country: "WW",
+				tags: {
+					Text: "txtd",
+					Extra: ["COMING-SOON", "HOJE"],
+					Codec: "prores",
+					Resolution: "640x480",
+					Framerate: "23.98",
+					"Frame Mode": "progressive"
+				}
+			};
+			expect(Filename.render(mocks.tags, mocks.types, asset, options)).toBe(
+				"TESTPROJECT_TV-SPOT-INTL_TEST-ASSET-INTL-10_ENG_TXTD_COMING-SOON_HOJE_PRORES_480p2398"
+			);
+		});
+
+		it("renders sub and dub tags", function() {
+			let asset = {
+				type: "tv-spot.intl",
+				name: "Test Asset Int'l 10",
+				slug: "test-asset-int-l-10",
+				mediaType: "video",
+				project: {
+					filePrefix: "TESTPROJECT"
+				}
+			};
+			let options = {
+				language: "ENG",
+				country: "WW",
+				tags: {
+					SubDub: {
+						sub: true,
+						dub: false
+					},
+					Extra: ["COMING-SOON", "HOJE"],
+					Codec: "PRORES",
+					Resolution: "640x480",
+					Framerate: "23.98",
+					"Frame Mode": "progressive"
+				}
+			};
+			expect(Filename.render(mocks.tags, mocks.types, asset, options)).toBe(
+				"TESTPROJECT_TV-SPOT-INTL_TEST-ASSET-INTL-10_ENG_SUB_COMING-SOON_HOJE_PRORES_480p2398"
+			);
+
+			Object.assign(options.tags.SubDub, {
+				sub: true,
+				dub: true
+			});
+
+			expect(Filename.render(mocks.tags, mocks.types, asset, options)).toBe(
+				"TESTPROJECT_TV-SPOT-INTL_TEST-ASSET-INTL-10_ENG_SUB_DUB_COMING-SOON_HOJE_PRORES_480p2398"
+			);
+		});
+	});
+});