edx-platform/cms/static/js/spec/models/textbook_spec.js

define(["backbone", "js/models/textbook", "js/collections/textbook", "js/models/chapter", "js/collections/chapter", "cms/js/main"],
function(Backbone, Textbook, TextbookSet, Chapter, ChapterSet, main) {

    describe("Textbook model", function() {
        beforeEach(function() {
            main();
            this.model = new Textbook();
            CMS.URL.TEXTBOOKS = "/textbooks";
        });

        afterEach(() => delete CMS.URL.TEXTBOOKS);

        describe("Basic", function() {
            it("should have an empty name by default", function() {
                expect(this.model.get("name")).toEqual("");
            });

            it("should not show chapters by default", function() {
                expect(this.model.get("showChapters")).toBeFalsy();
            });

            it("should have a ChapterSet with one chapter by default", function() {
                const chapters = this.model.get("chapters");
                expect(chapters).toBeInstanceOf(ChapterSet);
                expect(chapters.length).toEqual(1);
                expect(chapters.at(0).isEmpty()).toBeTruthy();
            });

            it("should be empty by default", function() {
                expect(this.model.isEmpty()).toBeTruthy();
            });

            it("should have a URL root", function() {
                const urlRoot = _.result(this.model, 'urlRoot');
                expect(urlRoot).toBeTruthy();
            });

            it("should be able to reset itself", function() {
                this.model.set("name", "foobar");
                this.model.reset();
                expect(this.model.get("name")).toEqual("");
            });

            it("should not be dirty by default", function() {
                expect(this.model.isDirty()).toBeFalsy();
            });

            it("should be dirty after it's been changed", function() {
                this.model.set("name", "foobar");
                expect(this.model.isDirty()).toBeTruthy();
            });

            it("should not be dirty after calling setOriginalAttributes", function() {
                this.model.set("name", "foobar");
                this.model.setOriginalAttributes();
                expect(this.model.isDirty()).toBeFalsy();
            });
        });

        describe("Input/Output", function() {
            var deepAttributes = function(obj) {
                if (obj instanceof Backbone.Model) {
                    return deepAttributes(obj.attributes);
                } else if (obj instanceof Backbone.Collection) {
                    return obj.map(deepAttributes);
                } else if (_.isArray(obj)) {
                    return _.map(obj, deepAttributes);
                } else if (_.isObject(obj)) {
                    const attributes = {};
                    for (let prop of Object.keys(obj)) {
                        const val = obj[prop];
                        attributes[prop] = deepAttributes(val);
                    }
                    return attributes;
                } else {
                    return obj;
                }
            };

            it("should match server model to client model", function() {
                const serverModelSpec = {
                    "tab_title": "My Textbook",
                    "chapters": [
                        {"title": "Chapter 1", "url": "/ch1.pdf"},
                        {"title": "Chapter 2", "url": "/ch2.pdf"},
                    ]
                };
                const clientModelSpec = {
                    "name": "My Textbook",
                    "showChapters": false,
                    "editing": false,
                    "chapters": [{
                            "name": "Chapter 1",
                            "asset_path": "/ch1.pdf",
                            "order": 1
                        }, {
                            "name": "Chapter 2",
                            "asset_path": "/ch2.pdf",
                            "order": 2
                        }
                    ]
                };

                const model = new Textbook(serverModelSpec, {parse: true});
                expect(deepAttributes(model)).toEqual(clientModelSpec);
                expect(model.toJSON()).toEqual(serverModelSpec);
            });
        });

        describe("Validation", function() {
            it("requires a name", function() {
                const model = new Textbook({name: ""});
                expect(model.isValid()).toBeFalsy();
            });

            it("requires at least one chapter", function() {
                const model = new Textbook({name: "foo"});
                model.get("chapters").reset();
                expect(model.isValid()).toBeFalsy();
            });

            it("requires a valid chapter", function() {
                const chapter = new Chapter();
                chapter.isValid = () => false;
                const model = new Textbook({name: "foo"});
                model.get("chapters").reset([chapter]);
                expect(model.isValid()).toBeFalsy();
            });

            it("requires all chapters to be valid", function() {
                const chapter1 = new Chapter();
                chapter1.isValid = () => true;
                const chapter2 = new Chapter();
                chapter2.isValid = () => false;
                const model = new Textbook({name: "foo"});
                model.get("chapters").reset([chapter1, chapter2]);
                expect(model.isValid()).toBeFalsy();
            });

            it("can pass validation", function() {
                const chapter = new Chapter();
                chapter.isValid = () => true;
                const model = new Textbook({name: "foo"});
                model.get("chapters").reset([chapter]);
                expect(model.isValid()).toBeTruthy();
            });
        });
    });


    describe("Textbook collection", function() {
        beforeEach(function() {
            CMS.URL.TEXTBOOKS = "/textbooks";
            this.collection = new TextbookSet();
        });

        afterEach(() => delete CMS.URL.TEXTBOOKS);

        it("should have a url set", function() {
            const url = _.result(this.collection, 'url');
            expect(url).toEqual("/textbooks");
        });
    });


    describe("Chapter model", function() {
        beforeEach(function() {
            this.model = new Chapter();
        });

        describe("Basic", function() {
            it("should have a name by default", function() {
                expect(this.model.get("name")).toEqual("");
            });

            it("should have an asset_path by default", function() {
                expect(this.model.get("asset_path")).toEqual("");
            });

            it("should have an order by default", function() {
                expect(this.model.get("order")).toEqual(1);
            });

            it("should be empty by default", function() {
                expect(this.model.isEmpty()).toBeTruthy();
            });
        });

        describe("Validation", function() {
            it("requires a name", function() {
                const model = new Chapter({name: "", asset_path: "a.pdf"});
                expect(model.isValid()).toBeFalsy();
            });

            it("requires an asset_path", function() {
                const model = new Chapter({name: "a", asset_path: ""});
                expect(model.isValid()).toBeFalsy();
            });

            it("can pass validation", function() {
                const model = new Chapter({name: "a", asset_path: "a.pdf"});
                expect(model.isValid()).toBeTruthy();
            });
        });
    });


    describe("Chapter collection", function() {
        beforeEach(function() {
            this.collection = new ChapterSet();
        });

        it("is empty by default", function() {
            expect(this.collection.isEmpty()).toBeTruthy();
        });

        it("is empty if all chapters are empty", function() {
            this.collection.add([{}, {}, {}]);
            expect(this.collection.isEmpty()).toBeTruthy();
        });

        it("is not empty if a chapter is not empty", function() {
            this.collection.add([{}, {name: "full"}, {}]);
            expect(this.collection.isEmpty()).toBeFalsy();
        });

        it("should have a nextOrder function", function() {
            expect(this.collection.nextOrder()).toEqual(1);
            this.collection.add([{}]);
            expect(this.collection.nextOrder()).toEqual(2);
            this.collection.add([{}]);
            expect(this.collection.nextOrder()).toEqual(3);
            // verify that it doesn't just return an incrementing value each time
            expect(this.collection.nextOrder()).toEqual(3);
            // try going back one
            this.collection.remove(this.collection.last());
            expect(this.collection.nextOrder()).toEqual(2);
        });
    });
});