magic_lamp 0.9.9 → 1.0.0

data/spec/dummy/persisted_specs/magic_lamp.rb

@@ -0,0 +1,5 @@
+# Don't pass name argument here for the sake of the db cleaner spec
+MagicLamp.register_fixture do
+  @order = Order.create!
+  render partial: "orders/form"
+end

data/spec/dummy/persisted_specs/magic_lamp_config.rb

@@ -0,0 +1,14 @@
+require "database_cleaner"
+
+MagicLamp.configure do |config|
+
+  DatabaseCleaner.strategy = :transaction
+
+  config.before_each do
+    DatabaseCleaner.start
+  end
+
+  config.after_each do
+    DatabaseCleaner.clean
+  end
+end

data/spec/dummy/spec/magical/a_lamp_file_with_a_different_name_lamp.rb

@@ -0,0 +1,7 @@
+MagicLamp.register_fixture(name: "custom_name") do
+  render "orders/foo"
+end
+
+MagicLamp.register_fixture(controller: OrdersController, name: "super_specified") do
+  render :foo
+end

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

@@ -2,7 +2,7 @@ MagicLamp.register_fixture do
   render "orders/foo"
 end
 
-MagicLamp.register_fixture do
+MagicLamp.register_fixture(controller: OrdersController) do
   render "orders/bar"
 end
 

data/spec/dummy/spec/magical/magic_lamp_config.rb

@@ -0,0 +1 @@
+MagicLamp.registered_fixtures

data/spec/javascripts/genie_spec.js

@@ -28,6 +28,26 @@ describe('Genie', function() {
     });
   });
 
+  describe('#fixtureNames', function() {
+    beforeEach(function() {
+      stub(console, 'log', true);
+      subject.cache = { foo: 'template', bar: 'other template' };
+    });
+
+    it('returns all of the fixtures named in the cache', function() {
+      expect(subject.fixtureNames()).to.be.like(['bar', 'foo']);
+      console.log.restore();
+    });
+
+    it('logs all of the fixture names in the cache', function() {
+      subject.fixtureNames();
+      expect(console.log).to.have.been.calledWith('bar');
+      expect(console.log).to.have.been.calledWith('foo');
+      expect(console.log.args).to.be.like([['bar'], ['foo']]);
+      console.log.restore();
+    });
+  });
+
   describe('#load', function() {
     var path;
     beforeEach(function() {
@@ -38,6 +58,13 @@ describe('Genie', function() {
       removeNode(subject.fixtureContainer);
     });
 
+    it('does not double append fixture containers', function() {
+      subject.cache[path] = 'some template';
+      subject.cacheOnly = true;
+      _(2).times(function() { subject.load(path); });
+      expect(document.getElementsByClassName('magic-lamp').length).to.equal(1);
+    });
+
     describe('cacheOnly false', function() {
       it('requests the fixture and adds it to the cache', function() {
         spyOn(subject, 'xhrRequest');
@@ -47,12 +74,11 @@ describe('Genie', function() {
       });
 
       it('appends the fixture container with the fixture to the dom', function() {
-        expect(testFixtureContainer()).to.equal(null);
+        expect(testFixtureContainer()).to.be.undefined;
         subject.load(path);
         expect(testFixtureContainer().innerHTML).to.equal('foo\n');
       });
 
-
       describe('cached', function() {
         beforeEach(function() {
           subject.cache[path] = 'howdy';
@@ -65,7 +91,7 @@ describe('Genie', function() {
         });
 
         it('appends the fixture container to the dom with the cached fixture', function() {
-          expect(testFixtureContainer()).to.equal(null);
+          expect(testFixtureContainer()).to.be.undefined;
           subject.load(path);
           expect(testFixtureContainer().innerHTML).to.equal('howdy');
         });
@@ -87,7 +113,7 @@ describe('Genie', function() {
       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./);
+        }).to.throw(/The fixture "orders\/foo" was not preloaded. Is the fixture registered\? Call `MagicLamp.fixtureNames\(\)` to see what is registered./);
       });
     });
   });
@@ -95,7 +121,7 @@ describe('Genie', function() {
   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']);
+      expect(subject.cache).to.have.keys(['orders/foo', 'orders/bar', 'orders/form', 'custom_name', 'super_specified']);
     });
 
     it('sets cacheOnly to true', function() {
@@ -103,6 +129,12 @@ describe('Genie', function() {
       expect(subject.cacheOnly).to.equal(true);
     });
 
+    it('does not set cacheOnly to true if the request fails', function() {
+      subject.xhrRequest = function() { throw new Error(); }
+      expect(function() { subject.preload(); }).to.throw();
+      expect(subject.cacheOnly).to.equal(false);
+    });
+
     it('makes a request to the specified path if defined', function() {
       var path = MagicLamp.path = '/normal_lamp';
       stub(subject, 'xhrRequest', { responseText: '{}' });
@@ -115,17 +147,17 @@ describe('Genie', function() {
   });
 
   describe('#createFixtureContainer', function() {
-    it('creates a div with an id of "magic-lamp" and caches it', function() {
+    it('creates a div with a class of "magic-lamp" and caches it', function() {
       subject.createFixtureContainer();
       expect(subject.fixtureContainer.tagName).to.equal('DIV');
-      expect(subject.fixtureContainer.id).to.equal('magic-lamp');
+      expect(subject.fixtureContainer.className).to.equal('magic-lamp');
     });
 
-    it('creates a div with an id of MagicLamp.id if present', function() {
-      var id = MagicLamp.id = 'footastic';
+    it('creates a div with a class of MagicLamp.class if present', function() {
+      var specifiedClass = MagicLamp.class = 'footastic';
       subject.createFixtureContainer();
-      delete MagicLamp.id;
-      expect(subject.fixtureContainer.id).to.equal(id);
+      delete MagicLamp.class;
+      expect(subject.fixtureContainer.className).to.equal(specifiedClass);
     });
   });
 
@@ -139,34 +171,57 @@ describe('Genie', function() {
     });
 
     it('appends the fixtureContainer to the body', function() {
-      expect(testFixtureContainer()).to.equal(null);
+      expect(testFixtureContainer()).to.be.undefined;
       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;
+    describe('without the fixture container', function() {
+      it('logs a message saying that this is a weird thing to do', function() {
+        expect(function() {
+          _(3).times(function() { subject.removeFixtureContainer(); });
+        }).to.not.throw()
+      });
     });
 
-    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('with the fixture container created', function() {
+      beforeEach(function() {
+        subject.createFixtureContainer();
+      });
+
+      it('removes the fixture container from the genie instance', function() {
+        expect(subject.fixtureContainer).to.be.defined;
+        subject.removeFixtureContainer();
+        expect(subject.fixtureContainer).to.be.undefined;
+      });
+    });
+
+    describe('with the fixture there', function() {
+      beforeEach(function() {
+        subject.createFixtureContainer();
+        subject.appendFixtureContainer();
+      });
+
+      it('removes the fixture container from the dom', function() {
+        expect(testFixtureContainer()).to.equal(subject.fixtureContainer);
+        subject.removeFixtureContainer();
+        expect(testFixtureContainer()).to.be.undefined;
+        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() {
@@ -190,7 +245,6 @@ describe('Genie', function() {
 
       expect(xhrProto.open).to.have.been.calledWith('GET', path, false);
       expect(xhrProto.send).to.have.been.calledOnce;
-
     });
 
     it('returns the xhr object', function() {
@@ -200,11 +254,26 @@ describe('Genie', function() {
       expect(result.constructor).to.equal(XMLHttpRequest);
     });
 
-    it('calls handleError if the status is not 200', function() {
+    it('calls handleError with the response text if the status was 400', 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);
     });
+
+    it('calls handleError with the default error message if the status was 500', function() {
+      stub(subject, 'handleError', true);
+      stub(subject, 'xhrStatus', 500);
+      var path = '/magic_lamp/foo/bar';
+      var xhr = subject.xhrRequest(path);
+      expect(subject.handleError).to.have.been.calledWith('Something went wrong while generating the fixture, please check the server log or run `rake magic_lamp:lint` for more information');
+    });
+  });
+
+  describe('#xhrStatus', function() {
+    it('returns the status of the xhr', function() {
+      var status = 200;
+      expect(subject.xhrStatus({ status: status })).to.equal(status);
+    });
   });
 });

data/spec/javascripts/magic_lamp_spec.js

@@ -22,6 +22,26 @@ describe('MagicLamp', function() {
     });
   });
 
+  describe('#fixtureNames', function() {
+    beforeEach(function() {
+      subject.initialize();
+      stub(subject.genie, 'fixtureNames', true);
+      subject.fixtureNames();
+    });
+
+    afterEach(function() {
+      delete subject.genie;
+    });
+
+    it('passes through to its genie instance', function() {
+      expect(subject.genie.fixtureNames).to.have.been.calledOnce;
+    });
+
+    it('returns the genie instance\'s return value', function() {
+      expect(subject.fixtureNames()).to.equal(true);
+    });
+  });
+
   describe('#globalize', function() {
     beforeEach(function() {
       subject.globalize();
@@ -130,47 +150,50 @@ describe('MagicLamp', function() {
     });
 
     afterEach(function() {
+      subject.clean();
       delete subject.genie;
     });
 
     it('can load the foo template and clean up', function() {
-      expect(testFixtureContainer()).to.equal(null);
+      expect(testFixtureContainer()).to.be.undefined;
       subject.load('orders/foo');
       expect(testFixtureContainer().innerHTML).to.equal('foo\n');
       subject.clean();
-      expect(testFixtureContainer()).to.equal(null);
+      expect(testFixtureContainer()).to.be.undefined;
     });
 
     it('can preload the templates and clean up', function() {
       subject.preload();
-      expect(testFixtureContainer()).to.equal(null);
-      subject.load('orders/foo');
+      expect(testFixtureContainer()).to.be.undefined;
+      _(2).times(function() { subject.load('orders/foo'); });
+      expect(document.getElementsByClassName('magic-lamp').length).to.equal(1);
       expect(testFixtureContainer().innerHTML).to.equal('foo\n');
       subject.clean();
-      expect(testFixtureContainer()).to.equal(null);
+      expect(testFixtureContainer()).to.be.undefined;
       subject.load('orders/bar');
       expect(testFixtureContainer().innerHTML).to.equal('bar\n');
-      subject.clean();
-      expect(testFixtureContainer()).to.equal(null);
+      _(3).times(function() { subject.clean(); });
+      expect(testFixtureContainer()).to.be.undefined;
     });
 
-    it('can specify the id used for the fixture container', function() {
-      var newId = subject.id = 'the-eye';
+    it('can specify the class used for the fixture container', function() {
+      var newClass = subject.class = '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');
+      expect(testFixtureContainer()).to.be.undefined;
+      expect(findByClassName(newClass)).to.exist;
+      expect(findByClassName(newClass).innerHTML).to.equal('foo\n');
       subject.clean();
-      expect(document.getElementById(newId)).to.not.exist;
-      delete subject.id;
+      expect(findByClassName(newClass)).to.not.exist;
+      delete subject.class;
     });
 
     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);
+      _(3).times(function() { subject.clean(); });
+      subject.clean();
+      expect(testFixtureContainer()).to.be.undefined;
     });
 
     it('throws an error when it cannot find the preloaded template', function() {
@@ -178,8 +201,18 @@ describe('MagicLamp', function() {
       expect(function() {
         subject.load('still/not/gonna/happen');
       }).to.throw();
+      _(3).times(function() { subject.clean(); });
+      expect(testFixtureContainer()).to.be.undefined;
+    });
+
+    it('can load fixtures with specified names', function() {
+      subject.load('custom_name');
+      expect(testFixtureContainer().innerHTML).to.equal('foo\n');
+    });
 
-      expect(testFixtureContainer()).to.equal(null);
+    it('can load fixtures with specified names and controllers', function() {
+      subject.load('super_specified')
+      expect(testFixtureContainer().innerHTML).to.equal('foo\n');
     });
   });
 });