qlive 0.2.0 → 0.4.0

data/Gemfile

@@ -1,4 +1,3 @@
 source "http://rubygems.org"
 
-# Specify your gem's dependencies in qlive.gemspec
 gemspec

data/lib/qlive/dev_reload.rb

@@ -12,10 +12,12 @@ module Qlive
 
 
     def self.reload_main
+      Registry.reset_all
       load "#{File.expand_path('../rack.rb', __FILE__)}"
       load "#{File.expand_path('../qunit_assets.rb', __FILE__)}"
       load "#{File.expand_path('../suite.rb', __FILE__)}"
       load "#{File.expand_path('../registry.rb', __FILE__)}"
+      Registry.find_suites
     end
   end
 end

data/lib/qlive/qunit_assets.rb

@@ -5,9 +5,9 @@ module Qlive
     def prepare_assets
       before_body_close.concat(
         qunit_html_structure |
-        qunit_support_assets |
         qunit_framework |
         qunit_disable_autostart |
+        qunit_support_assets |
         qunit_javascript_test_sources |
         qunit_finalize
       )
@@ -21,19 +21,11 @@ module Qlive
     end
 
     def qunit_support_assets
-      support_relpath = Qlive.setup[:js_support_relpath]
-      path = "#{Qlive.setup[:base_path]}#{support_relpath}"
-      if (File.exist?(path))
-        glob_script_tags(path, "#{Qlive.setup[:url_prefix] || ''}#{support_relpath}")
-      else
-        []
-      end
+      glob_script_tags("#{sans_slash(base_path)}#{Qlive.setup[:js_support_relpath]}")
     end
 
     def qunit_javascript_test_sources
-      test_path = File.expand_path('..', self.meta_data[:path])
-      url_prefix = "#{Qlive.setup[:url_prefix] || ''}/#{suite_name}"
-      glob_script_tags(test_path, url_prefix)
+      glob_script_tags(File.expand_path('..', self.registration.path))
     end
 
     def qunit_html_structure
@@ -45,7 +37,6 @@ module Qlive
         '<h2 id="qunit-userAgent"></h2>',
         '<ol id="qunit-tests"></ol>',
         '<div id="qunit-fixture">test markup, will be hidden</div>',
-        '<div id="display-proxified-tests"></div>',
         '</div>'
       ]
     end
@@ -57,19 +48,48 @@ module Qlive
     end
 
     def qunit_finalize
-      [
-        '<script>QUnit.done = function(failed, passed, total, runtime) { window.qunitComplete = true; };</script>'
-      ]
+      js=<<EOJS
+      <script>
+        window.endQlive = function() {
+          if (!$('#qlive-complete').length) {
+            $('body').append('<div id="qlive-complete"></div>');
+          }
+        };
+        QUnit.done = function(failed, passed, total, runtime) {
+          window.endQlive();
+        };
+      </script>
+EOJS
+      [ js ]
     end
 
-    def glob_script_tags(src_base_path, url_prefix)
-      sources = Dir.glob("#{src_base_path}#{src_base_path.end_with?('/') ? '' : '/'}**/*.js").sort.flatten
+    def glob_script_tags(src_base_path)
+      return [] unless File.exist?(src_base_path)
+      sources = Dir.glob("#{src_base_path}#{trailing_slash(src_base_path)}**/*.js").sort.flatten
       sources.map do |src|
         src = src.to_s
-        href = "#{url_prefix}#{src.sub(src_base_path, '')}"
+        href = "#{url_prefix}#{src.sub(base_path, '')}"
         "<script type='text/javascript' src='#{href}'></script>"
       end
     end
 
+    private
+
+    def url_prefix
+      @url_prefix ||= sans_slash(Qlive.setup[:url_prefix] || '')
+    end
+
+    def sans_slash(path)
+      path.end_with?('/') ? path[0..-1] : path
+    end
+
+    def base_path
+      Qlive.setup[:base_path]
+    end
+
+    def trailing_slash(path)
+      path.end_with?('/') ? '' : '/'
+    end
+
   end
 end

data/lib/qlive/rack.rb

@@ -22,13 +22,14 @@ module Qlive
                           :request => request,
                           :session => env["rack.session"]
                         })
-          suite.before_each_request(request)
+          suite.before_each_suite(request)
         end
       end
 
       status, headers, body = @app.call(env)
 
       if suite
+        suite.before_suite_response(status, headers, body)
         inject_html(:after_open, :head, suite.html_after_head_open, body, headers)
         inject_html(:before_close, :head, suite.html_before_head_close, body, headers)
         inject_html(:after_open, :body, suite.html_after_body_open, body, headers)

data/lib/qlive/registry.rb

@@ -1,62 +1,81 @@
+require 'uri'
 require 'qlive/setup'
 require 'qlive/suite'
 
 module Qlive
   module Registry
 
-    $qlive_all_suites ||= {}
+    $qlive_registrations_by_name ||= {}
+    $qlive_registrations_by_class ||= {}
 
-    def self.suites
-      $qlive_all_suites
-    end
+    class Registration
+      attr_accessor :name
+      attr_accessor :path
+      attr_accessor :klass
+      attr_accessor :extras
 
+      def initialize(args)
+        [ :name, :path, :klass ].each do |var|
+          instance_variable_set("@#{var}", args[var])
+        end
+      end
+    end
 
     def self.find_suites
-      suites = {}
       base_path = Qlive.setup[:base_path]
-      sources = Dir.glob("#{base_path}#{base_path.end_with?('/') ? '' : '/'}**/*_qlive.rb").sort.flatten
-      sources.each do |path|
-        path = path.to_s
+      Dir.glob("#{base_path}#{base_path.end_with?('/') ? '' : '/'}**/*qlive.rb").sort.flatten.each do |path|
         name = self.extract_suite_name_from_path(path)
-        suites[name] ||= {}
-        suites[name][:path] = path
+        unless all_by_name[name]
+          all_by_name[name] = Registration.new(
+              :name => name,
+              :path => path)
+          @qlive_current_suite_name = name
+          load(path.to_s)
+          @qlive_current_suite_name = nil
+        end
       end
-
-      $qlive_all_suites = suites
+      all_by_name
     end
 
     def self.build_suite(suite_name)
-      meta = Registry.suites[suite_name]
-      unless meta || Qlive.setup[:skip_suite_reloader]
+      suite_name = URI.unescape(suite_name)
+      registration = Registry.all_by_name[suite_name]
+      unless registration || Qlive.setup[:skip_suite_reloader]
         Registry.find_suites
-        meta = Registry.suites[suite_name]
+        registration = Registry.all_by_name[suite_name]
       end
-      raise "Qlive Suite not found: #{suite_name}" unless meta
-      load meta[:path]
-      klass = meta[:klass]
+      raise "Qlive Suite not found: #{suite_name}" unless registration
+      load registration.path
+      klass = registration.klass
       raise "Qlive could not find class for suite: #{suite_name}" unless klass
       klass.new
     end
 
     def self.register_class(klass)
-      name = self.extract_suite_name_from_class(klass)
-      meta = Registry.suites[name] || {}
-      meta.merge!(:name => name,
-                  :klass => klass)
-      meta
+      registration = $qlive_registrations_by_class[klass]
+      registration ||= Registry.all_by_name[@qlive_current_suite_name]
+      if registration
+        registration.klass = klass
+        $qlive_registrations_by_class[klass] = registration
+      else
+        Qlive.logger.warn "Ignoring Qlive class '#{klass}'. File must be placed within the Qlive base_path: #{Qlive.setup[:base_path]}. Or you can change the base_path with Qlive.setup[:base_path] = /some/other/path"
+      end
+      registration
     end
 
-    private
+    def self.reset_all
+      $qlive_registrations_by_name = {}
+      $qlive_registrations_by_class = {}
+    end
 
-    def self.extract_suite_name_from_path(path)
-      res = path.sub(Qlive.setup[:base_path], '').sub(/^\//, '')
-      res.split('/')[0..-2].join('/')
+    def self.all_by_name
+      $qlive_registrations_by_name
     end
 
-    def self.extract_suite_name_from_class(klass)
-      parts = klass.name.split('::')
-      parts = parts.map { |part| part.gsub(/(.)([A-Z])/,'\1_\2').downcase }
-      parts.join('/').sub(/_qlive$/, '')
+    private
+
+    def self.extract_suite_name_from_path(path)
+      path.sub(Qlive.setup[:base_path], '').sub(/_?qlive\.rb$/, '').sub(/^\//, '').sub(/\/$/, '')
     end
 
   end

data/lib/qlive/setup.rb

@@ -12,7 +12,15 @@ module Qlive
     @qlive_config
   end
 
+  class DefaultLogger
+    %w( debug info warn error).each do |level|
+      define_method(level) do |raw|
+        $stdout.write("#{level.upcase}: #{raw.to_s}\n")
+      end
+    end
+  end
+
   def self.logger
-    self.setup[:logger]
+    self.setup[:logger] ||= DefaultLogger.new
   end
 end

data/lib/qlive/suite.rb

@@ -10,13 +10,13 @@ module Qlive
     InsertionPoints ||= [ 'after_head_open', 'before_head_close', 'after_body_open', 'before_body_close']
 
     def self.included(base)
-      meta = Registry.register_class(base)
+      registration = Registry.register_class(base)
       base.class_eval do
         class << self
-          attr_reader :suite_meta_data
+          attr_reader :suite_registration
         end
       end
-      base.instance_variable_set(:@suite_meta_data, meta)
+      base.instance_variable_set(:@suite_registration, registration)
 
       InsertionPoints.each do |place|
         attr_accessor place
@@ -42,25 +42,26 @@ module Qlive
       prepare_assets
     end
 
-
-    def name
-      self.meta_data[:name]
-    end
-
-    def meta_data
-      self.class.suite_meta_data
+    def registration
+      self.class.suite_registration
     end
 
-
     def suite_name
-      self.name
+      self.registration.name
     end
 
+    def before_each_suite(rack_request)
+      # override in suite
+    end
 
-    protected
+    def before_suite_response(status, headers, body)
+      # override in suite
+    end
 
+    # DEPRECATED
     def before_each_request(rack_request)
-      # override to create server-side fixtures here for the qlive request
+      Qlive.logger.warn("Qlive suite '#{suite_name}' uses deprecated 'before_each_request' method. Rename it to 'before_each_suite'.")
+      before_each_suite(rack_request)
     end
 
   end

data/lib/qlive/version.rb

@@ -1,3 +1,3 @@
 module Qlive
-  VERSION = "0.2.0"
+  VERSION = "0.4.0"
 end

data/qlive.gemspec

@@ -19,5 +19,5 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_dependency 'rack', '~> 1.4'
-  s.add_development_dependency "rspec", '~> 2.8.0'
+  s.add_development_dependency "rspec", '~> 2.11'
 end

data/spec/fixtures/fancy_workflow/as_admin_qlive.rb

@@ -0,0 +1,11 @@
+module FancyWorkflow
+  class AsAdmin
+    include Qlive::Suite
+    # would normally include QliveHelper
+
+    def before_each_suite(rack_request)
+      # would login_as Factory(:admin)
+    end
+
+  end
+end

data/spec/fixtures/fancy_workflow/as_user_qlive.rb

@@ -0,0 +1,11 @@
+module FancyWorkflow
+  class AsUser
+    include Qlive::Suite
+    # would normally include QliveHelper
+
+    def before_each_suite(rack_request)
+      # would login_as Factory(:user)
+    end
+
+  end
+end

data/spec/fixtures/regressions/stay_unbroken/{stay_unbroken_qlive.rb → qlive.rb}

@@ -2,7 +2,7 @@ module Regressions
   class StayUnbrokenQlive
     include Qlive::Suite
 
-    def before_each_request(rack_request)
+    def before_each_suite(rack_request)
       # fixtures that reproduce the original bug
     end
 

data/spec/qlive/rack_spec.rb

@@ -1,20 +1,21 @@
 require File.expand_path("../../spec_helper.rb", __FILE__)
 
-describe Qlive::Rack do
-  class HappyGoLuckyQlive
-    include Qlive::Suite
+Registry = Qlive::Registry
 
-    def before_each_request(rack_request)
-      rack_request.session[:logged_in_as] = 1255
-    end
-  end
+describe Qlive::Rack do
 
   before(:each) do
-    suite = HappyGoLuckyQlive.new
-    Qlive::Registry.stub!(:build_suite).and_return suite
+    Registry.find_suites
+    suite = FancyWorkflow::AsUser.new
+    class << suite
+      def before_each_suite(rack_request)
+        rack_request.session[:logged_in_as] = 1255
+      end
+    end
+    Registry.stub!(:build_suite).with('fancy_workflow/as_user').and_return(suite)
   end
 
-  let(:environment) { Rack::MockRequest.env_for('/webapp/tinfoiled?qlive=happy_go_lucky#frontpage') }
+  let(:environment) { Rack::MockRequest.env_for('/webapp/tinfoiled?qlive=fancy_workflow/as_user#frontpage') }
   let(:application) { lambda{|env| [200, {'Content-Type' => 'text/html'}, [ html_page ]]} }
   let(:middleware) do
     Qlive::Rack.new(application, { :base_path => fixtures_base_path })
@@ -27,7 +28,7 @@ describe Qlive::Rack do
 
   it "should allow suite to modify session data" do
     middleware.call(environment)
-    environment['rack.session'].should == {:logged_in_as => 1255} # see before_each_request
+    environment['rack.session'].should == {:logged_in_as => 1255} # see before_each_suite
   end
 
   #todo: describe "magic param" do

data/spec/qlive/registry_spec.rb

@@ -1,15 +1,15 @@
 require File.expand_path("../../spec_helper.rb", __FILE__)
 
 describe Qlive::Registry, "find_suites" do
-  it "should find qlive suites" do
+  it "should find qlive suites in the qlive base_path" do
     suites = Qlive::Registry.find_suites
     suites.length.should > 0
-    suites['fancy_workflow'].should_not be_nil
   end
 
-  it "should support subdirectories namespaced by modules" do
+  it "should name suites by pathname within the base path, trimming qlive.rb and lead/trail slashes" do
     suites = Qlive::Registry.find_suites
-    suites.length.should == 2
+    suites['fancy_workflow/as_user'].should_not be_nil
+    suites['fancy_workflow/as_admin'].should_not be_nil
     suites['regressions/stay_unbroken'].should_not be_nil
   end
 end
@@ -18,13 +18,14 @@ end
 describe Qlive::Registry, "build_suite" do
 
   it "should instantiate suite and add class to meta data registry" do
-    suite = Qlive::Registry.build_suite('fancy_workflow')
-    suite.class.name.should == 'FancyWorkflowQlive'
+    suite = Qlive::Registry.build_suite('fancy_workflow/as_user')
+    suite.class.name.should == 'FancyWorkflow::AsUser'
   end
 
-  it "should work with namespaced subdirs " do
-    suite = Qlive::Registry.build_suite('regressions/stay_unbroken')
-    suite.class.name.should == 'Regressions::StayUnbrokenQlive'
+  it "should raise an error when suite is not found" do
+    lambda {
+      suite = Qlive::Registry.build_suite('stay_unbroken')
+    }.should raise_error
   end
 
 end

data/spec/qlive/suite_spec.rb

@@ -1,20 +1,14 @@
 require File.expand_path("../../spec_helper.rb", __FILE__)
 
-describe Qlive::Suite do
-  class BlueSuite
-    include Qlive::Suite
-
-    def before_each_request(rack_request)
-      @pretend_factory_girl = true
-      @pretend_devise_user_login = true
-    end
-  end
+Registry = ::Qlive::Registry
 
+describe Qlive::Suite do
   let(:suite) do
-    suite = BlueSuite.new
-    suite.prepare
-    suite.after_head_open << '<script> doSomethingEarly();</script>'
-    suite
+    Registry.find_suites
+    res = Registry.build_suite('fancy_workflow/as_user')
+    res.prepare # normally called by rack
+    res.after_head_open << '<script> doSomethingEarly();</script>'
+    res
   end
 
   it "should provide array of desired html at all insertion points" do
@@ -28,29 +22,25 @@ end
 
 describe Qlive::Suite, "qunit source" do
   before(:each) do
-    @suite = Qlive::Registry.build_suite('fancy_workflow')
+    @suite = Qlive::Registry.build_suite('fancy_workflow/as_user')
     @suite.prepare
   end
 
   it "should insert qunit resources and all js files in the same directory as the suite" do
     source_tags = @suite.qunit_javascript_test_sources
     source_tags.length.should == 2
-    source_tags.join("\n").should match(/#{Regexp.escape("/qlive/sources/fancy_workflow/post-new-recipe.js")}/)
+    source_tags.join("\n").should match(/#{Regexp.escape("/qlive/sources/fancy_workflow/as_user/post-new-recipe.js")}/)
   end
 
 end
 
 
 describe Qlive::Suite, "insertion helper methods" do
-  class GreenSuite
-    include Qlive::Suite
-  end
-
-  let(:suite) { GreenSuite.new }
+  let(:registration) { Registry.find_suites; Registry.all_by_name['fancy_workflow/as_user'] }
 
   it "should not mess up metacoding too much" do
-    a = GreenSuite.new
-    b = GreenSuite.new
+    a = registration.klass.new
+    b = registration.klass.new
     a.after_head_open = [ 8 ]
     b.after_head_open = [ 9 ]
     a.after_head_open[0].should == 8

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: qlive
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-31 00:00:00.000000000 Z
+date: 2013-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
-  requirement: &2152316140 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,18 +21,28 @@ dependencies:
         version: '1.4'
   type: :runtime
   prerelease: false
-  version_requirements: *2152316140
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2152315360 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.8.0
+        version: '2.11'
   type: :development
   prerelease: false
-  version_requirements: *2152315360
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
 description: run qunit tests against actual back-end server with prepared test fixtures
 email:
 - support@proxv.com
@@ -52,11 +62,12 @@ files:
 - lib/qlive/suite.rb
 - lib/qlive/version.rb
 - qlive.gemspec
-- spec/fixtures/fancy_workflow/fancy_workflow_qlive.rb
+- spec/fixtures/fancy_workflow/as_admin_qlive.rb
+- spec/fixtures/fancy_workflow/as_user_qlive.rb
 - spec/fixtures/fancy_workflow/post-new-recipe.js
 - spec/fixtures/fancy_workflow/verify-creds.js
 - spec/fixtures/qunit_support/start-qunit.js
-- spec/fixtures/regressions/stay_unbroken/stay_unbroken_qlive.rb
+- spec/fixtures/regressions/stay_unbroken/qlive.rb
 - spec/fixtures/regressions/stay_unbroken/test-never-again.js
 - spec/qlive/rack_spec.rb
 - spec/qlive/registry_spec.rb
@@ -83,16 +94,17 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: qlive
-rubygems_version: 1.8.10
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: run qunit tests against actual back-end server with prepared test fixtures
 test_files:
-- spec/fixtures/fancy_workflow/fancy_workflow_qlive.rb
+- spec/fixtures/fancy_workflow/as_admin_qlive.rb
+- spec/fixtures/fancy_workflow/as_user_qlive.rb
 - spec/fixtures/fancy_workflow/post-new-recipe.js
 - spec/fixtures/fancy_workflow/verify-creds.js
 - spec/fixtures/qunit_support/start-qunit.js
-- spec/fixtures/regressions/stay_unbroken/stay_unbroken_qlive.rb
+- spec/fixtures/regressions/stay_unbroken/qlive.rb
 - spec/fixtures/regressions/stay_unbroken/test-never-again.js
 - spec/qlive/rack_spec.rb
 - spec/qlive/registry_spec.rb

data/spec/fixtures/fancy_workflow/fancy_workflow_qlive.rb

@@ -1,9 +0,0 @@
-class FancyWorkflowQlive
-  include Qlive::Suite
-  # include QliveHelper
-
-  def before_each_request(rack_request)
-    # login_as Factory(:user)
-  end
-
-end