magic_lamp 0.9.0 → 0.9.9

data/spec/dummy/spec/magical/magic_lamp.rb

@@ -0,0 +1,12 @@
+MagicLamp.register_fixture do
+  render "orders/foo"
+end
+
+MagicLamp.register_fixture do
+  render "orders/bar"
+end
+
+MagicLamp.register_fixture do
+  @order = Order.new
+  render partial: "orders/form"
+end

data/spec/dummy/tmp/pids/server.pid

@@ -0,0 +1 @@
+88207

data/spec/javascripts/genie_spec.js

@@ -0,0 +1,210 @@
+describe('Genie', function() {
+  var subject;
+  beforeEach(function() {
+    subject = new MagicLamp.Genie;
+  });
+
+  describe('class', function() {
+    it('is a function', function() {
+      expect(MagicLamp.Genie).to.be.a('function');
+    });
+  });
+
+  describe('cache', function() {
+    it('is an object', function() {
+      expect(subject.cache).to.be.a('object');
+    });
+  });
+
+  describe('cacheOnly', function() {
+    it('is false by default', function() {
+      expect(subject.cacheOnly).to.equal(false);
+    });
+  });
+
+  describe('namespace', function() {
+    it('is MagicLamp', function() {
+      expect(subject.namespace).to.equal(MagicLamp);
+    });
+  });
+
+  describe('#load', function() {
+    var path;
+    beforeEach(function() {
+      path = 'orders/foo';
+    });
+
+    afterEach(function() {
+      removeNode(subject.fixtureContainer);
+    });
+
+    describe('cacheOnly false', function() {
+      it('requests the fixture and adds it to the cache', function() {
+        spyOn(subject, 'xhrRequest');
+        subject.load(path);
+        expect(subject.xhrRequest).to.have.been.calledOnce;
+        expect(subject.cache[path]).to.equal('foo\n');
+      });
+
+      it('appends the fixture container with the fixture to the dom', function() {
+        expect(testFixtureContainer()).to.equal(null);
+        subject.load(path);
+        expect(testFixtureContainer().innerHTML).to.equal('foo\n');
+      });
+
+
+      describe('cached', function() {
+        beforeEach(function() {
+          subject.cache[path] = 'howdy';
+        });
+
+        it('does not make a request', function() {
+          spyOn(subject, 'xhrRequest');
+          subject.load(path);
+          expect(subject.xhrRequest).to.not.have.been.calledOnce;
+        });
+
+        it('appends the fixture container to the dom with the cached fixture', function() {
+          expect(testFixtureContainer()).to.equal(null);
+          subject.load(path);
+          expect(testFixtureContainer().innerHTML).to.equal('howdy');
+        });
+      });
+    });
+
+    describe('cacheOnly true', function() {
+      beforeEach(function() {
+        subject.cacheOnly = true;
+      });
+
+      it('does not make a request', function() {
+        spyOn(subject, 'xhrRequest');
+        subject.cache[path] = 'howdy';
+        subject.load(path);
+        expect(subject.xhrRequest).to.not.have.been.calledOnce;
+      });
+
+      it('throws an error if the fixture is not in the cache', function() {
+        expect(function() {
+          subject.load(path);
+        }).to.throw(/The fixture "orders\/foo" was not preloaded. Is the fixture registered\? Such a bummer./);
+      });
+    });
+  });
+
+  describe('#preload', function() {
+    it('requests all of the fixtures and puts them in the cache', function() {
+      subject.preload();
+      expect(subject.cache).to.have.keys(['orders/foo', 'orders/bar', 'orders/form']);
+    });
+
+    it('sets cacheOnly to true', function() {
+      subject.preload();
+      expect(subject.cacheOnly).to.equal(true);
+    });
+
+    it('makes a request to the specified path if defined', function() {
+      var path = MagicLamp.path = '/normal_lamp';
+      stub(subject, 'xhrRequest', { responseText: '{}' });
+      subject.preload();
+
+      delete MagicLamp.path;
+
+      expect(subject.xhrRequest).to.have.been.calledWith(path);
+    });
+  });
+
+  describe('#createFixtureContainer', function() {
+    it('creates a div with an id of "magic-lamp" and caches it', function() {
+      subject.createFixtureContainer();
+      expect(subject.fixtureContainer.tagName).to.equal('DIV');
+      expect(subject.fixtureContainer.id).to.equal('magic-lamp');
+    });
+
+    it('creates a div with an id of MagicLamp.id if present', function() {
+      var id = MagicLamp.id = 'footastic';
+      subject.createFixtureContainer();
+      delete MagicLamp.id;
+      expect(subject.fixtureContainer.id).to.equal(id);
+    });
+  });
+
+  describe('#appendFixtureContainer', function() {
+    beforeEach(function() {
+      subject.createFixtureContainer();
+    });
+
+    afterEach(function() {
+      removeNode(subject.fixtureContainer);
+    });
+
+    it('appends the fixtureContainer to the body', function() {
+      expect(testFixtureContainer()).to.equal(null);
+      subject.appendFixtureContainer();
+      expect(testFixtureContainer()).to.equal(subject.fixtureContainer);
+    });
+  });
+
+  describe('#removeFixtureContainer', function() {
+    beforeEach(function() {
+      subject.createFixtureContainer();
+      subject.appendFixtureContainer();
+    });
+
+    afterEach(function() {
+      removeNode(subject.fixtureContainer);
+    });
+
+    it('removes the fixture container from the dom', function() {
+      expect(testFixtureContainer()).to.equal(subject.fixtureContainer);
+      subject.removeFixtureContainer();
+      expect(testFixtureContainer()).to.equal(null);
+      expect(subject.fixtureContainer).to.be.undefined;
+    });
+
+    it('removes the fixture container from the genie instance', function() {
+      expect(testFixtureContainer()).to.equal(subject.fixtureContainer);
+      subject.removeFixtureContainer();
+      expect(subject.fixtureContainer).to.be.undefined;
+    });
+  });
+
+  describe('#handleError', function() {
+    it('throws an informative error', function() {
+      var message = 'something informative';
+
+      expect(function() {
+        subject.handleError(message);
+      }).to.throw(message);
+    });
+  });
+
+  describe('#xhrRequest', function() {
+    it('makes an get request to the specified path', function() {
+      var xhrProto = XMLHttpRequest.prototype;
+      stub(subject, 'handleError', true);
+      stub(xhrProto, 'open', true);
+      stub(xhrProto, 'send', true);
+      var path = '/magic_lamp';
+      subject.xhrRequest(path);
+
+      expect(xhrProto.open).to.have.been.calledWith('GET', path, false);
+      expect(xhrProto.send).to.have.been.calledOnce;
+
+    });
+
+    it('returns the xhr object', function() {
+      var path = '/magic_lamp';
+      var result = subject.xhrRequest(path);
+
+      expect(result.constructor).to.equal(XMLHttpRequest);
+    });
+
+    it('calls handleError if the status is not 200', function() {
+      stub(subject, 'handleError', true);
+      var path = '/magic_lamp/foo/bar';
+      var xhr = subject.xhrRequest(path);
+      expect(subject.handleError).to.have.been.calledWith(xhr.responseText);
+    });
+  });
+});

data/spec/javascripts/magic_lamp_spec.js

@@ -0,0 +1,185 @@
+describe('MagicLamp', function() {
+  var subject;
+  beforeEach(function() {
+    subject = MagicLamp;
+  });
+
+  it('is an object', function() {
+    expect(subject).to.be.a('object');
+  });
+
+  describe('#initialize', function() {
+    beforeEach(function() {
+      subject.initialize();
+    });
+
+    afterEach(function() {
+      delete subject.genie;
+    });
+
+    it('sets genie to a new genie instance', function() {
+      expect(subject.genie).to.be.an.instanceof(subject.Genie);
+    });
+  });
+
+  describe('#globalize', function() {
+    beforeEach(function() {
+      subject.globalize();
+    });
+
+    afterEach(function() {
+      _(['load', 'preload', 'clean']).each(function(method) {
+        delete window[method];
+      });
+    });
+
+    it('puts #load on window', function() {
+      expect(window.load).to.be.a('function');
+    });
+
+    it('binds #load', function() {
+      stub(subject, 'load', true);
+      load('orders/foo');
+      expect(subject.load).to.have.been.calledWith('orders/foo');
+    });
+
+    it('puts #clean on window', function() {
+      expect(window.clean).to.be.a('function');
+    });
+
+    it('binds #clean', function() {
+      stub(subject, 'clean', true);
+      clean();
+      expect(subject.clean).to.have.been.calledOnce;
+    });
+  });
+
+  describe('#load', function() {
+    beforeEach(function() {
+      subject.initialize();
+      stub(subject.genie, 'load', true);
+      subject.load('foo', 'bar', 'baz');
+    });
+
+    afterEach(function() {
+      delete subject.genie;
+    });
+
+    it('passes through to its genie instance', function() {
+      expect(subject.genie.load).to.have.been.calledWith('foo', 'bar', 'baz');
+    });
+  });
+
+  describe('#preload', function() {
+    beforeEach(function() {
+      subject.initialize();
+      stub(subject.genie, 'preload', true);
+      subject.preload('foo', 'bar', 'baz');
+    });
+
+    afterEach(function() {
+      delete subject.genie;
+    });
+
+    it('passes through to its genie instance', function() {
+      expect(subject.genie.preload).to.have.been.calledWith('foo', 'bar', 'baz');
+    });
+  });
+
+  describe('#clean', function() {
+    beforeEach(function() {
+      subject.initialize();
+      stub(subject.genie, 'removeFixtureContainer', true);
+      subject.clean();
+    });
+
+    afterEach(function() {
+      delete subject.genie;
+    });
+
+    it('calls removeFixtureContainer on its genie instance', function() {
+      expect(subject.genie.removeFixtureContainer).to.have.been.calledOnce;
+    });
+  });
+
+  describe('aliases', function() {
+    it('preload as "massage"', function() {
+      expect(subject.massage).to.equal(subject.preload);
+    });
+
+    it('preload as "wishForMoreWishes"', function() {
+      expect(subject.wishForMoreWishes).to.equal(subject.preload);
+    });
+
+    it('load as "rub"', function() {
+      expect(subject.rub).to.equal(subject.load);
+    });
+
+    it('load as "wish"', function() {
+      expect(subject.wish).to.equal(subject.load);
+    });
+
+    it('clean as "polish"', function() {
+      expect(subject.polish).to.equal(subject.clean);
+    });
+  });
+
+  describe('integration', function() {
+    beforeEach(function() {
+      subject.initialize();
+    });
+
+    afterEach(function() {
+      delete subject.genie;
+    });
+
+    it('can load the foo template and clean up', function() {
+      expect(testFixtureContainer()).to.equal(null);
+      subject.load('orders/foo');
+      expect(testFixtureContainer().innerHTML).to.equal('foo\n');
+      subject.clean();
+      expect(testFixtureContainer()).to.equal(null);
+    });
+
+    it('can preload the templates and clean up', function() {
+      subject.preload();
+      expect(testFixtureContainer()).to.equal(null);
+      subject.load('orders/foo');
+      expect(testFixtureContainer().innerHTML).to.equal('foo\n');
+      subject.clean();
+      expect(testFixtureContainer()).to.equal(null);
+      subject.load('orders/bar');
+      expect(testFixtureContainer().innerHTML).to.equal('bar\n');
+      subject.clean();
+      expect(testFixtureContainer()).to.equal(null);
+    });
+
+    it('can specify the id used for the fixture container', function() {
+      var newId = subject.id = 'the-eye';
+      subject.load('orders/foo');
+      expect(testFixtureContainer()).to.equal(null);
+      expect(document.getElementById(newId)).to.exist;
+      expect(document.getElementById(newId).innerHTML).to.equal('foo\n');
+      subject.clean();
+      expect(document.getElementById(newId)).to.not.exist;
+      delete subject.id;
+    });
+
+    it('throws an error when it cannot find the template', function() {
+      expect(function() {
+        subject.load('not/gonna/happen');
+      }).to.throw(/'not\/gonna\/happen' is not a registered fixture$/);
+
+      expect(testFixtureContainer()).to.equal(null);
+    });
+
+    it('throws an error when it cannot find the preloaded template', function() {
+      subject.preload();
+      expect(function() {
+        subject.load('still/not/gonna/happen');
+      }).to.throw();
+
+      expect(testFixtureContainer()).to.equal(null);
+    });
+  });
+});