magic_lamp 1.5.2 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 41478cabfbc093d487b0dba06c3da1eda0f2cd7b
-  data.tar.gz: 739255d6adb9212a7353f1d5ab21100f8c91c589
+  metadata.gz: c8bca611448f6cd6086f0a9a17393ffce473d65d
+  data.tar.gz: adfc6d57c0e0a61d4a02c1c36ec8b137c1ca3ed9
 SHA512:
-  metadata.gz: 7f55d8114967531bf6da21d5863b9fdaa03822daf179e21de2f26fffbb16ff1eb33f86b705db85b4635c5a6e5fccfb7a24af44a7ffe48b93500fa0b1d5b52677
-  data.tar.gz: e8e0a9c49ee7403bf9735e8a9205f43fa513a3808e9507ffb2bacb7f2dbc54635ff35fdbd5c1a370ec174682b2e53345c03c1051017ded7a629eac48a83c59bd
+  metadata.gz: 8eeab2759a000a30e47eabd000e5c49fcf46c20de833026c9aa464c3647f1d95f85a138450010fab737387f01aab5fa82ee290d942b68747467aaba54cdcd768
+  data.tar.gz: 83aab308b53d110243d0c8132fdb96aa4a83c47e9d6bcd36e6a5dd4c231cfe790af3f483834bb29ed4da0540022d849d8f491925385ef4bee2b75bfeae8eb3cd

data/README.md

@@ -6,8 +6,6 @@ Magic Lamp helps you get your Rails templates into your JavaScript tests. This m
 if you change your templates _and_ you don't have to create so many fixtures. Plus, it lets you test your views in JavaScript.
 All you have to do is set up your data just like you would in a controller.
 
-It's not required that you use [Teaspoon](https://github.com/modeset/teaspoon) as your JavaScript test runner, but you should.
-
 Table of Contents
 -----------------
 1. [Installation](#installation)
@@ -31,12 +29,7 @@ And then execute:
 
     $ bundle install
 
-Or install it yourself with:
-
-    $ gem install magic_lamp
-
-Then paste `mount MagicLamp::Genie, at: "/magic_lamp" if defined?(MagicLamp)` into your `config/routes.rb`
-like so:
+Then paste `mount MagicLamp::Genie, at: "/magic_lamp" if defined?(MagicLamp)` into your `config/routes.rb` like so:
 ```ruby
 Rails.application.routes.draw do
   # ...
@@ -50,24 +43,29 @@ Then drop this:
 ```js
 //= require magic_lamp
 ```
-at the top of your `spec_helper.js` (assuming you're using [Teaspoon](https://github.com/modeset/teaspoon) or another JavaScript spec runner for Rails that allows the use of Sprockets directives).
+at the top of your `spec_helper.js` (assuming you're using JavaScript spec runner for Rails that allows the use of Sprockets directives).
 
-(I highly recommend that you use [Teaspoon](https://github.com/modeset/teaspoon) as your JavaScript spec runner.)
+If your JavaScript doesn't support XHR requests, you can drop this in instead:
 
-Now you've got the basic setup.
+```js
+//= require magic_lamp
+//= require magic_lamp/all_fixtures
+```
 
-In case you need it, [here's an example app](https://github.com/crismali/magic_lamp/tree/master/example).
+`//= require magic_lamp/all_fixtures` will load all of your fixtures without making any XHR requests. 
+
+Now you've got the basic setup.
 
 ### Debugging
 Visit `/magic_lamp/lint` in your browser to lint your fixtures. You can also run `rake magic_lamp:lint` (or `rake mll` for short) to lint your fixtures from the command line.
 
 ### Loading Helpers
 
-Simply `require` or `load` your helpers in the `magic_lamp_config.rb` file like so:
+Simply `load` your helpers in the `magic_lamp_config.rb` file like so:
 
 ```ruby
 # in magic_lamp_config.rb
-Dir[Rails.root.join("spec", "support", "magic_lamp_helpers/**/*.rb")].each { |f| require f }
+Dir[Rails.root.join("spec", "support", "magic_lamp_helpers/**/*.rb")].each { |f| load f }
 ```
 
 ### With Database Cleaner
@@ -399,6 +397,7 @@ It requires a block to which it yields the configuration object. Here you can se
 Example:
 
 ```ruby
+# spec/support/magic_lamp/helpers/auth_stub.rb
 module AuthStub
   def current_user
     @current_user ||= User.create!(
@@ -408,8 +407,11 @@ module AuthStub
   end
 end
 
+# spec/magic_lamp_config.rb (can be anywhere in /spec)
 MagicLamp.configure do |config|
 
+  Dir[Rails.root.join("spec", "support", "magic_lamp_helpers/**/*.rb")].each { |f| load f }
+
   # if you want to require the name parameter for the `fixture` method
   config.infer_names = false
 

data/app/assets/javascripts/magic_lamp/all_fixtures.js.erb

@@ -0,0 +1,12 @@
+<% all_fixtures = MagicLamp.generate_all_fixtures.to_json rescue nil %>
+
+<% if all_fixtures %>
+
+MagicLamp.genie.cacheOnly = true;
+MagicLamp.genie.cache = <%= MagicLamp.generate_all_fixtures.to_json %>;
+
+<% else %>
+
+throw new Error(MagicLamp.genericError);
+
+<% end %>

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

@@ -85,7 +85,7 @@
       if (this.xhrStatus(xhr) === 400) {
         this.handleError(xhr.responseText);
       } else if (this.xhrStatus(xhr) > 400) {
-        this.handleError('Something went wrong, please check the server log or run `rake magic_lamp:lint` for more information');
+        this.handleError(MagicLamp.genericError);
       }
       return xhr;
     },

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

@@ -17,7 +17,9 @@
 
     preload: function() {
       this.genie.preload.apply(this.genie, arguments);
-    }
+    },
+
+    genericError: 'Something went wrong, please check the server log, run `rake magic_lamp:lint`, or visit `/magic_lamp/lint` for more information'
   };
 
   MagicLamp.clean = function() {

data/lib/magic_lamp.rb

@@ -1,4 +1,4 @@
-require "rake"
+require "method_source"
 
 require "magic_lamp/engine"
 require "magic_lamp/constants"
@@ -9,8 +9,8 @@ require "magic_lamp/defaults_manager"
 require "magic_lamp/fixture_creator"
 require "magic_lamp/render_catcher"
 
-require "tasks/lint_task"
-require "tasks/fixture_names_task"
+require "tasks/lint"
+require "tasks/fixture_names"
 
 module MagicLamp
   class << self

data/lib/magic_lamp/version.rb

@@ -1,3 +1,3 @@
 module MagicLamp
-  VERSION = "1.5.2"
+  VERSION = "1.6.0"
 end

data/lib/tasks/fixture_names.rb

@@ -0,0 +1,12 @@
+MagicLamp::Genie.rake_tasks do
+  namespace :magic_lamp do
+    desc "Displays all Magic Lamp fixture names"
+    task fixture_names: :environment do
+      MagicLamp.load_lamp_files
+      puts MagicLamp.registered_fixtures.keys.sort
+    end
+  end
+
+  desc "Displays all Magic Lamp fixture names (alias for `magic_lamp:fixture_names`)"
+  task mlfn: "magic_lamp:fixture_names"
+end

data/lib/tasks/lint.rb

@@ -0,0 +1,88 @@
+MagicLamp::Genie.rake_tasks do
+  namespace :magic_lamp do
+    desc "Generates all Magic Lamp fixtures and displays errors for debugging"
+    task lint: ["magic_lamp:lint:config", "magic_lamp:lint:files", "magic_lamp:lint:fixtures"]
+
+    namespace :lint do
+      desc "Lints your Magic Lamp configuration and reports any errors"
+      task config: :environment do
+        puts "Linting Magic Lamp configuration..."
+        errors = MagicLamp.lint_config
+        if errors.present?
+          if errors[:config_file_load].present?
+            puts "Loading configuration failed with:"
+            puts "\n#{errors[:config_file_load]}"
+          end
+
+          [:before_each, :after_each].each do |callback|
+            if errors[callback].present?
+              puts "Executing #{callback} failed with:"
+              puts "\n#{errors[callback]}"
+            end
+          end
+          abort
+        else
+          puts "Configuration looks good!"
+        end
+      end
+
+      desc "Lints your Magic Lamp lamp files and reports any errors"
+      task files: :environment do
+        puts "Linting lamp files..."
+        errors = MagicLamp.lint_fixtures[:files]
+
+        if errors.present?
+          puts "The following files are broken:"
+          puts ""
+
+          errors.each do |path, error|
+            puts "File: #{path}"
+            puts "Error: #{error}"
+            puts ""
+          end
+          abort
+        else
+          puts "Lamp files look good!"
+        end
+      end
+
+      desc "Lints your Magic Lamp fixtures and reports any errors"
+      task fixtures: :environment do
+        puts "Linting Magic Lamp fixtures..."
+        errors = MagicLamp.lint_fixtures[:fixtures]
+
+        if errors.present?
+          puts "The following fixtures are broken:"
+          puts ""
+
+          errors.each do |name, fixture_info|
+            puts "Name: \"#{name}\""
+            render_block = fixture_info[:render_block]
+            puts "File: #{render_block.source_location.join(':')}"
+            puts "Controller: #{fixture_info[:controller]}"
+
+            if fixture_info[:extend].present?
+              extensions = fixture_info[:extend].join(", ")
+            else
+              extensions = "None"
+            end
+
+            puts "Extensions: #{extensions}"
+            puts ""
+            puts "Source code:"
+            puts render_block.source
+            puts ""
+            puts "Error: #{fixture_info[:error]}"
+            puts ""
+          end
+          abort
+        else
+          puts "Fixtures look good!"
+        end
+      end
+    end
+  end
+
+  desc "Generates all Magic Lamp fixtures and displays errors for debugging (alias for `magic_lamp:lint`)"
+  task mll: "magic_lamp:lint"
+end

data/spec/controllers/magic_lamp/lint_controller_spec.rb

@@ -2,7 +2,7 @@ require "rails_helper"
 
 module MagicLamp
   describe LintController do
-    routes { Engine.routes }
+    routes { MagicLamp::Engine.routes }
 
     describe "#index" do
       context "no errors" do

data/spec/javascripts/genie_spec.js

@@ -308,7 +308,7 @@ describe('Genie', function() {
       stub(subject, 'xhrStatus', 500);
       var path = '/magic_lamp/foo/bar';
       subject.xhrRequest(path);
-      expect(subject.handleError).to.have.been.calledWith('Something went wrong, please check the server log or run `rake magic_lamp:lint` for more information');
+      expect(subject.handleError).to.have.been.calledWith(MagicLamp.genericError);
     });
 
     it('calls handleError with the default error message if the status was 404', function() {
@@ -316,7 +316,7 @@ describe('Genie', function() {
       stub(subject, 'xhrStatus', 404);
       var path = '/magic_lamp/foo/bar';
       subject.xhrRequest(path);
-      expect(subject.handleError).to.have.been.calledWith('Something went wrong, please check the server log or run `rake magic_lamp:lint` for more information');
+      expect(subject.handleError).to.have.been.calledWith(MagicLamp.genericError);
     });
   });
 

data/spec/lib/all_fixtures_spec.rb

@@ -0,0 +1,32 @@
+require "rails_helper"
+
+describe "All fixtures js erb" do
+  subject do
+    sprockets_env = Sprockets::Environment.new
+    sprockets_env.append_path("app/assets/javascripts/")
+    sprockets_env["magic_lamp/all_fixtures.js"].to_s
+  end
+
+  it "sets cache only to true" do
+    expect(subject).to match(/MagicLamp.genie.cacheOnly = true/)
+  end
+
+  it "provides all of the fixtures as json in the cache" do
+    excaped_json = Regexp.escape(MagicLamp.generate_all_fixtures.to_json)
+    expect(subject).to match(/MagicLamp.genie.cache = #{excaped_json}/)
+  end
+
+  it "does not throw an error" do
+    expect(subject).to_not match(/throw new Error\(MagicLamp.genericError\)/)
+  end
+
+  context "errors" do
+    before do
+      allow(MagicLamp).to receive(:generate_all_fixtures).and_raise("Some error")
+    end
+
+    it "throws an error" do
+      expect(subject).to match(/throw new Error\(MagicLamp.genericError\)/)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -15,7 +15,6 @@
 #
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 require "fantaskspec"
-MAIN_OBJECT = self
 
 Dir[File.expand_path("../support/**/*.rb", __FILE__)].each { |file| require file }
 

data/spec/tasks/fixture_names_task_spec.rb

@@ -4,7 +4,7 @@ describe "magic_lamp:fixture_names" do
   it { is_expected.to depend_on(:environment) }
 
   it "outputs a sorted list of all the fixture names" do
-    expect(MAIN_OBJECT).to receive(:puts) do |output|
+    expect(MagicLamp::Genie.instance).to receive(:puts) do |output|
       fixture_names = MagicLamp.registered_fixtures.keys.sort
       expect(output).to_not be_empty
       expect(output).to eq(fixture_names)

data/spec/tasks/lint_task_spec.rb

@@ -34,7 +34,7 @@ describe "magic_lamp:lint:config" do
     end
 
     it "does not abort" do
-      expect(MAIN_OBJECT).to_not receive(:abort)
+      expect(MagicLamp::Genie.instance).to_not receive(:abort)
     end
   end
 
@@ -42,7 +42,7 @@ describe "magic_lamp:lint:config" do
     let!(:error_proc) { proc { raise "Nope" } }
 
     before do
-      allow(MAIN_OBJECT).to receive(:abort)
+      allow(MagicLamp::Genie.instance).to receive(:abort)
     end
 
     it "tells us if the file could be loaded" do
@@ -70,7 +70,7 @@ describe "magic_lamp:lint:config" do
       allow(MagicLamp).to receive(:load_config) do
         load Rails.root.join("error_specs", "config_file_load_error.rb")
       end
-      expect(MAIN_OBJECT).to receive(:abort)
+      expect(MagicLamp::Genie.instance).to receive(:abort)
       capture_stdout { subject.execute }
     end
   end
@@ -81,7 +81,7 @@ describe "magic_lamp:lint:files" do
   let(:output) { capture_stdout { subject.execute } }
 
   before do
-    allow(MAIN_OBJECT).to receive(:abort).and_return(:abort)
+    allow(MagicLamp::Genie.instance).to receive(:abort).and_return(:abort)
   end
 
   it { is_expected.to depend_on(:environment) }
@@ -93,7 +93,7 @@ describe "magic_lamp:lint:files" do
     end
 
     it "does not abort" do
-      expect(MAIN_OBJECT).to_not receive(:abort)
+      expect(MagicLamp::Genie.instance).to_not receive(:abort)
       capture_stdout { subject.execute }
     end
   end
@@ -120,7 +120,7 @@ describe "magic_lamp:lint:files" do
 
     it "aborts the task" do
       allow(MagicLamp).to receive(:lamp_files).and_return(lamp_file_paths)
-      expect(MAIN_OBJECT).to receive(:abort)
+      expect(MagicLamp::Genie.instance).to receive(:abort)
       capture_stdout { subject.execute }
     end
   end
@@ -139,14 +139,14 @@ describe "magic_lamp:lint:fixtures" do
     end
 
     it "does not abort" do
-      expect(MAIN_OBJECT).to_not receive(:abort)
+      expect(MagicLamp::Genie.instance).to_not receive(:abort)
       capture_stdout { subject.execute }
     end
   end
 
   context "errors" do
     before do
-      allow(MAIN_OBJECT).to receive(:abort).and_return(:abort)
+      allow(MagicLamp::Genie.instance).to receive(:abort).and_return(:abort)
       allow(MagicLamp).to receive(:lamp_files).and_return([Rails.root.join("error_specs", "broken_fixtures.rb").to_s])
     end
 
@@ -181,7 +181,7 @@ describe "magic_lamp:lint:fixtures" do
     end
 
     it "aborts the task" do
-      expect(MAIN_OBJECT).to receive(:abort)
+      expect(MagicLamp::Genie.instance).to receive(:abort)
       capture_stdout { subject.execute }
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: magic_lamp
 version: !ruby/object:Gem::Version
-  version: 1.5.2
+  version: 1.6.0
 platform: ruby
 authors:
 - Michael Crismali
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-28 00:00:00.000000000 Z
+date: 2015-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -245,6 +245,7 @@ files:
 - LICENSE
 - README.md
 - app/assets/javascripts/magic_lamp.js
+- app/assets/javascripts/magic_lamp/all_fixtures.js.erb
 - app/assets/javascripts/magic_lamp/application.js
 - app/assets/javascripts/magic_lamp/boot.js
 - app/assets/javascripts/magic_lamp/genie.js
@@ -270,8 +271,8 @@ files:
 - lib/magic_lamp/fixture_creator.rb
 - lib/magic_lamp/render_catcher.rb
 - lib/magic_lamp/version.rb
-- lib/tasks/fixture_names_task.rb
-- lib/tasks/lint_task.rb
+- lib/tasks/fixture_names.rb
+- lib/tasks/lint.rb
 - spec/controllers/magic_lamp/fixtures_controller_spec.rb
 - spec/controllers/magic_lamp/lint_controller_spec.rb
 - spec/dummy/README.rdoc
@@ -337,6 +338,7 @@ files:
 - spec/javascripts/support/chai-fuzzy.js
 - spec/javascripts/support/sinon-chai.js
 - spec/javascripts/support/underscore-1.6.js
+- spec/lib/all_fixtures_spec.rb
 - spec/lib/configuration_spec.rb
 - spec/lib/defaults_manager_spec.rb
 - spec/lib/fixture_creator_spec.rb
@@ -438,6 +440,7 @@ test_files:
 - spec/javascripts/support/chai-fuzzy.js
 - spec/javascripts/support/sinon-chai.js
 - spec/javascripts/support/underscore-1.6.js
+- spec/lib/all_fixtures_spec.rb
 - spec/lib/configuration_spec.rb
 - spec/lib/defaults_manager_spec.rb
 - spec/lib/fixture_creator_spec.rb

data/lib/tasks/fixture_names_task.rb

@@ -1,10 +0,0 @@
-namespace :magic_lamp do
-  desc "Displays all Magic Lamp fixture names"
-  task fixture_names: :environment do
-    MagicLamp.load_lamp_files
-    puts MagicLamp.registered_fixtures.keys.sort
-  end
-end
-
-desc "Displays all Magic Lamp fixture names (alias for `magic_lamp:fixture_names`)"
-task mlfn: "magic_lamp:fixture_names"

data/lib/tasks/lint_task.rb

@@ -1,88 +0,0 @@
-require "method_source"
-
-namespace :magic_lamp do
-  desc "Generates all Magic Lamp fixtures and displays errors for debugging"
-  task lint: ["magic_lamp:lint:config", "magic_lamp:lint:files", "magic_lamp:lint:fixtures"]
-
-  namespace :lint do
-    desc "Lints your Magic Lamp configuration and reports any errors"
-    task config: :environment do
-      puts "Linting Magic Lamp configuration..."
-      errors = MagicLamp.lint_config
-      if errors.present?
-        if errors[:config_file_load].present?
-          puts "Loading configuration failed with:"
-          puts "\n#{errors[:config_file_load]}"
-        end
-
-        [:before_each, :after_each].each do |callback|
-          if errors[callback].present?
-            puts "Executing #{callback} failed with:"
-            puts "\n#{errors[callback]}"
-          end
-        end
-        abort
-      else
-        puts "Configuration looks good!"
-      end
-    end
-
-    desc "Lints your Magic Lamp lamp files and reports any errors"
-    task files: :environment do
-      puts "Linting lamp files..."
-      errors = MagicLamp.lint_fixtures[:files]
-
-      if errors.present?
-        puts "The following files are broken:"
-        puts ""
-
-        errors.each do |path, error|
-          puts "File: #{path}"
-          puts "Error: #{error}"
-          puts ""
-        end
-        abort
-      else
-        puts "Lamp files look good!"
-      end
-    end
-
-    desc "Lints your Magic Lamp fixtures and reports any errors"
-    task fixtures: :environment do
-      puts "Linting Magic Lamp fixtures..."
-      errors = MagicLamp.lint_fixtures[:fixtures]
-
-      if errors.present?
-        puts "The following fixtures are broken:"
-        puts ""
-
-        errors.each do |name, fixture_info|
-          puts "Name: \"#{name}\""
-          render_block = fixture_info[:render_block]
-          puts "File: #{render_block.source_location.join(':')}"
-          puts "Controller: #{fixture_info[:controller]}"
-
-          if fixture_info[:extend].present?
-            extensions = fixture_info[:extend].join(", ")
-          else
-            extensions = "None"
-          end
-
-          puts "Extensions: #{extensions}"
-          puts ""
-          puts "Source code:"
-          puts render_block.source
-          puts ""
-          puts "Error: #{fixture_info[:error]}"
-          puts ""
-        end
-        abort
-      else
-        puts "Fixtures look good!"
-      end
-    end
-  end
-end
-
-desc "Generates all Magic Lamp fixtures and displays errors for debugging (alias for `magic_lamp:lint`)"
-task mll: "magic_lamp:lint"