magic_lamp 1.6.2 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 24d10bfc30e19c36245d5a06668c291d78974e95
-  data.tar.gz: b927c195fc7bcf1cb16ea7d9779cfe00f60596c1
+  metadata.gz: 59341749511aa8a67d1add3ab349b34efdf2ed38
+  data.tar.gz: 281fb70cc9c9bfacee96a46840aca2e8d619988a
 SHA512:
-  metadata.gz: fa83054ff11497292adf67fd25e1b485eabc4640f4ab9603368ddb5c2724edcf679ba40da953e0f37f5d8c565a9d08cc0198afa3ab9358980c943fc2517d9a6f
-  data.tar.gz: 8dda7d8275c106a2492613fc35d55140589e95291fa3851835f42c20fa426408d7779e9055accb0929597d83f953edc481bd18f9945189a744446dcfb4a8d13f
+  metadata.gz: 531159bceb7d43fa85994b61834cbb3e503b1eae418e70102b5fa50d27835273b2ad2b0b40c972308e3555c41a6ef3557dbb8faccf80fa2fea641f45286c9737
+  data.tar.gz: 31a71c1c45690d3a65a2260f4b39301477d536f3496ff159a9f4a0d8e3fe694d06db45072eae1bad1ae186383788cdde327f2bf0bf53c6f45c793198f7dbc7e7

data/README.md

@@ -46,7 +46,7 @@ Then drop this:
 ```
 at the top of your `spec_helper.js` (assuming you're using JavaScript spec runner for Rails that allows the use of Sprockets directives).
 
-If your JavaScript doesn't support XHR requests, you can drop this in instead:
+If your JavaScript test runner doesn't support XHR requests, you can drop this in instead:
 
 ```js
 //= require magic_lamp
@@ -531,14 +531,28 @@ describe("Foo", function() {
 ```
 Errors
 ------
-If there are errors rendering any of your templates, Magic Lamp will often throw a JavaScript
-error. Errors will also appear in your server log (if you're running the in-browser specs).
+If there are errors rendering any of your templates, Magic Lamp will often throw a JavaScript error. Errors will also appear in your server log (if you're running the in-browser specs).
 
 To see errors outside of the server log (which may be noisy), you can run [`rake magic_lamp:lint`](#tasks) (or `rake mll`) or visit `/magic_lamp/lint` in your browser and display any errors in your fixtures.
 
+You can debug into your fixture generation code or even the templates themselves just as you normally would in any other part of your Rails app. If you start seeing a bunch of `RenderCatcher` objects instead of the code you expected, just continue through and wait for the debugger to catch again and things go back to normal. If you want to skip continuing through, simply provide an explicit name for the fixture.
+
 If you get an `ActionView::MissingTemplate` error, try specifying the controller. This error is caused by a template that renders a partial
 without using the fully qualified path to the partial. Specifying the controller should help Rails find the template.
 
+When rails is inferring routes for `form_for`, `link_to`, and a few other methods you'll sometimes need to change `request.env["action_dispatch.request.path_parameters"]` by setting `action` and `controller`. When the route is nested with with a parameter in the url like `/orders/:order_id/foos/new` you'll need to add the `:order_id` to it like so:
+
+```ruby
+fixture do
+  request.env["action_dispatch.request.path_parameters"] = {
+    action: "new",
+    controller: "foos",
+    order_id: 3
+  }
+  render :new
+end
+```
+
 Sweet aliases
 -------------
 ### Ruby

data/app/assets/javascripts/magic_lamp/genie.js

@@ -25,12 +25,17 @@
     retrieveFixture: function(path) {
       var fixture = this.cache[path];
 
+      throwEmptyFixtureErrorIfEmpty(fixture, path);
+
       if (!fixture && this.cacheOnly) {
         throw new Error('The fixture "' + path + '" was not preloaded. Is the fixture registered? Call `MagicLamp.fixtureNames()` to see what is registered.');
       } else if (!fixture) {
         var xhr = this.xhrRequest(getPath() + '/' + path);
         this.cache[path] = fixture = xhr.responseText;
       }
+
+      throwEmptyFixtureErrorIfEmpty(fixture, path);
+
       return fixture;
     },
 
@@ -112,6 +117,12 @@
     };
   }
 
+  function throwEmptyFixtureErrorIfEmpty(fixture, path) {
+    if (fixture === '') {
+      throw new Error('The fixture "' + path + '" is an empty string. Run `rake magic_lamp:lint` for more information.');
+    }
+  }
+
   function newXhr() {
     var xhr;
     if (window.XMLHttpRequest) { // Mozilla, Safari, ...

data/lib/magic_lamp/constants.rb

@@ -15,5 +15,6 @@ module MagicLamp
   ArgumentError = Class.new(StandardError)
   AttemptedRedirectError = Class.new(StandardError)
   DoubleRenderError = Class.new(StandardError)
+  EmptyFixtureError = Class.new(StandardError)
   UnregisteredFixtureError = Class.new(StandardError)
 end

data/lib/magic_lamp/fixture_creator.rb

@@ -5,11 +5,17 @@ module MagicLamp
     attr_accessor :render_arguments
 
     def generate_template(controller_class, extensions, &block)
-      execute_callbacks_around do
+      fixture = execute_callbacks_around do
         controller = new_controller(controller_class, extensions, &block)
         controller.request.env["action_dispatch.request.path_parameters"] = { action: "index", controller: controller.controller_name }
         fetch_rendered(controller, block)
       end
+
+      if fixture.empty?
+        raise EmptyFixtureError, "Fixture was an empty string. This is probably not what you meant to have happen."
+      end
+
+      fixture
     end
 
     def new_controller(controller_class, extensions, &block)

data/lib/magic_lamp/version.rb

@@ -1,3 +1,3 @@
 module MagicLamp
-  VERSION = "1.6.2"
+  VERSION = "1.7.0"
 end

data/spec/dummy/test/test_lamp.rb

@@ -1,3 +1,3 @@
 MagicLamp.fixture(name: "from_test_directory") do
-  render text: ""
+  render text: "something something"
 end

data/spec/javascripts/genie_spec.js

@@ -105,6 +105,13 @@ describe('Genie', function() {
         expect(subject.retrieveFixture(path)).to.equal(fixtureContent);
       });
 
+      it('throws an error if the fixture is an empty string', function() {
+        stub(subject, 'xhrRequest', { responseText: '' });
+        expect(function() {
+          subject.retrieveFixture(path);
+        }).to.throw(/The fixture "orders\/foo" is an empty string. Run `rake magic_lamp:lint` for more information./);
+      });
+
       describe('cached', function() {
         beforeEach(function() {
           fixtureContent = subject.cache[path] = 'howdy';
@@ -119,6 +126,13 @@ describe('Genie', function() {
         it('returns the fixture', function() {
           expect(subject.retrieveFixture(path)).to.equal(fixtureContent);
         });
+
+        it('throws an error if the fixture is an empty string', function() {
+          subject.cache[path] = '';
+          expect(function() {
+            subject.retrieveFixture(path);
+          }).to.throw(/The fixture "orders\/foo" is an empty string. Run `rake magic_lamp:lint` for more information./);
+        });
       });
     });
 
@@ -144,6 +158,13 @@ describe('Genie', function() {
           subject.retrieveFixture(path);
         }).to.throw(/The fixture "orders\/foo" was not preloaded. Is the fixture registered\? Call `MagicLamp.fixtureNames\(\)` to see what is registered./);
       });
+
+      it('throws an error if the fixture is an empty string', function() {
+        subject.cache[path] = '';
+        expect(function() {
+          subject.retrieveFixture(path);
+        }).to.throw(/The fixture "orders\/foo" is an empty string. Run `rake magic_lamp:lint` for more information./);
+      });
     });
   });
 

data/spec/lib/fixture_creator_spec.rb

@@ -90,6 +90,16 @@ describe MagicLamp::FixtureCreator do
         end
       end
     end
+
+    context "fixture is empty" do
+      it "raises an error" do
+        expect do
+          subject.generate_template(OrdersController, []) do
+            ""
+          end
+        end.to raise_error(MagicLamp::EmptyFixtureError, /fixture was an empty string. This is probably not what you meant to have happen./i)
+      end
+    end
   end
 
   describe "#new_controller" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: magic_lamp
 version: !ruby/object:Gem::Version
-  version: 1.6.2
+  version: 1.7.0
 platform: ruby
 authors:
 - Michael Crismali
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-07 00:00:00.000000000 Z
+date: 2015-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails