qlive 0.1.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

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

data/README.md

@@ -0,0 +1,44 @@
+# Qlive
+
+Qlive is rack middleware for running qunit javascript tests against a live server.
+It is mainly intended to be used for testing javascript-heavy, single-page web applications
+(like those built using backbone, angularjs, emberjs, etc.)
+
+Qlive inserts the qunit framework and your test sources into the page's response.
+Qlive provides hooks for setting server state before the request is processed by your app, so you can
+do things like popuplate content with your favorite fixtures library (like factory_girl) and log in a user for the qunit test page.
+
+
+## Benefits:
+
+* Precisely set fixture content and user login state for your qunit tests
+* Insert qunit tests and any custom html into live pages generated by your server
+* Run the same qunit tests in a browser or headlessly, alongside your normal integration test suite. (When used with Ruby on Rails and the [qlive-headless](https://github.com/proxv/qlive-headless) gem.)
+
+
+## Installation
+
+### Ruby on Rails
+
+If you are using Ruby on Rails, you should use one of these gems:
+
+* [qlive-rails](https://github.com/proxv/qlive-rails). Configures most of qlive for you and provides an index page linking to your test suites.
+* [qlive-headless](https://github.com/proxv/qlive-headless). Run your qunit tests headlessly as part of your rspec or test suite. (Builds on qlive-rails.)
+
+
+### Non-rails:
+
+* Configure base path, the top of the directory tree that contains your qlive suites. (See suites section below)
+    <pre>Qlive.setup[:base_path] = /absolute/path/to/qunit/tests/tree</pre>
+* Configure url prefix for serving your test sources in this tree.
+    * The default is /qlive/sources.
+    * So a request to /qlive/sources/my_suite/test-stuff.js would need to resolve to #{base_path}/my_suite/test-stuff.js
+* Mount Qlive::Rack late enough for it to access the database or whatever else the suite needs for preparing page state
+
+todo: improve/complete non-rails instructions should anyone want to use it.
+
+
+## Usage
+
+See [suites wiki page](https://github.com/proxv/qlive/wiki/qlive-suites).
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/qlive.rb

@@ -0,0 +1,8 @@
+require "qlive/version"
+require "qlive/setup"
+require "qlive/registry"
+require "qlive/suite"
+require "qlive/rack"
+
+module Qlive
+end

data/lib/qlive/dev_reload.rb

@@ -0,0 +1,21 @@
+module Qlive
+  class DevReload
+
+    def initialize(app, opts={})
+      @app = app
+    end
+
+    def call(env)
+      self.class.reload_main if env['QUERY_STRING'].include?('qlive=')
+      @app.call(env)
+    end
+
+
+    def self.reload_main
+      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__)}"
+    end
+  end
+end

data/lib/qlive/qunit_assets.rb

@@ -0,0 +1,75 @@
+module Qlive
+  module QunitAssets
+
+    # default is to serve assets for qlive-rails. Override if your qunit assets are elsewhere.
+    def prepare_assets
+      before_body_close.concat(
+        qunit_html_structure |
+        qunit_support_assets |
+        qunit_framework |
+        qunit_disable_autostart |
+        qunit_javascript_test_sources |
+        qunit_finalize
+      )
+    end
+
+    def qunit_framework
+      [
+        '<link rel="stylesheet" href="/qlive/qunit-1.9.0/qunit.css" type="text/css" media="screen" />',
+        '<script type="text/javascript" src="/qlive/qunit-1.9.0/qunit.js"></script>'
+      ]
+    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
+    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)
+    end
+
+    def qunit_html_structure
+      [
+        '<div class="qlive-structure">',
+        "<h1 id='qunit-header'>Qlive Suite: #{suite_name}</h1>",
+        '<h2 id="qunit-banner"></h2>',
+        '<div id="qunit-testrunner-toolbar"></div>',
+        '<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
+
+    def qunit_disable_autostart
+      [
+        '<script>QUnit.config.autostart = false;</script>'
+      ]
+    end
+
+    def qunit_finalize
+      [
+        '<script>QUnit.done = function(failed, passed, total, runtime) { window.qunitComplete = true; };</script>'
+      ]
+    end
+
+    def glob_script_tags(src_base_path, url_prefix)
+      sources = Dir.glob("#{src_base_path}#{src_base_path.end_with?('/') ? '' : '/'}**/*.js").sort.flatten
+      sources.map do |src|
+        src = src.to_s
+        href = "#{url_prefix}#{src.sub(src_base_path, '')}"
+        "<script type='text/javascript' src='#{href}'></script>"
+      end
+    end
+
+  end
+end

data/lib/qlive/rack.rb

@@ -0,0 +1,76 @@
+require 'qlive/setup'
+require 'qlive/registry'
+
+module Qlive
+  class Rack
+
+    def initialize(app, opts)
+      Qlive.setup.merge!(opts)
+      @app = app
+      @regex_qs = /#{opts[:magic_param] || 'qlive'}=([^&\?]+)/i
+      Registry.find_suites
+    end
+
+    def call(env)
+      suite = nil
+      if env["REQUEST_METHOD"].upcase == 'GET'
+        m = @regex_qs.match(env['QUERY_STRING'])
+        if m && m.length > 0
+          request = ::Rack::Request.new(env)
+          suite = Registry.build_suite(m[1])
+          suite.prepare({
+                          :request => request,
+                          :session => env["rack.session"]
+                        })
+          suite.before_each_request(request)
+        end
+      end
+
+      status, headers, body = @app.call(env)
+
+      if suite
+        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)
+        inject_html(:before_close, :body, suite.html_before_body_close, body, headers)
+      end
+
+      [status, headers, body]
+    end
+
+
+    protected
+
+
+    private
+
+    def inject_html(place, tag_type, html, body, headers)
+      return if !html || html.length == 0
+      html = html.join("\n") if html.kind_of?(Array)
+
+      if place == :before_close
+        regex = /<\/#{tag_type}>/i
+        substitution = "\n#{html}\n</#{tag_type}>"
+      else # :after_open
+        regex = /<#{tag_type}[^>]*>/i
+        substitution = "\\0\n#{html}\n"
+      end
+
+      body.each do |part|
+        if part =~ regex
+          part.sub!(regex, substitution)
+          fix_content_length(headers, html)
+          break
+        end
+      end
+    end
+
+    def fix_content_length(headers, inserted_text)
+      if headers['Content-Length'] && inserted_text && inserted_text.length > 0
+        headers['Content-Length'] = (headers['Content-Length'].to_i + inserted_text.length).to_s
+      end
+    end
+
+
+  end
+end

data/lib/qlive/registry.rb

@@ -0,0 +1,72 @@
+require 'qlive/setup'
+require 'qlive/suite'
+
+module Qlive
+  module Registry
+
+    unless String.public_method_defined?(:underscore)
+      String.class_eval do
+        def underscore
+          self.gsub(/(.)([A-Z])/,'\1_\2').downcase
+        end
+      end
+    end
+
+
+    $qlive_all_suites ||= {}
+    #@all_suites ||= {} # use module instance variable
+
+    def self.suites
+      $qlive_all_suites
+    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
+        name = self.extract_suite_name_from_path(path)
+        suites[name] ||= {}
+        suites[name][:path] = path
+      end
+
+      $qlive_all_suites = suites
+    end
+
+    def self.build_suite(suite_name)
+      meta = Registry.suites[suite_name]
+      unless meta || Qlive.setup[:skip_suite_reloader]
+        Registry.find_suites
+        meta = Registry.suites[suite_name]
+      end
+      raise "Qlive Suite not found: #{suite_name}" unless meta
+      load meta[:path]
+      klass = meta[: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
+    end
+
+
+    def self.extract_suite_name_from_path(path)
+      res = path.split('/')[-1]
+      res = res.split('.')[0]
+      res = res.downcase.sub(/_qlive$/, '')
+      res
+    end
+
+    def self.extract_suite_name_from_class(klass)
+      klass.name.underscore.sub(/_qlive$/, '')
+    end
+
+  end
+end

data/lib/qlive/setup.rb

@@ -0,0 +1,14 @@
+module Qlive
+  @qlive_config = {
+    :base_path => nil, # required. qlive-rails sets this to "#{Rails.root}/spec/qunits"
+    :url_prefix => '/qlive/sources',
+    :magic_param => 'qlive',
+    :js_support_relpath => '/qunit_support',  # gets loaded before all of the qunit js tests
+    :skip_suite_reloader => false,  # when true, does not re-crawl base_path looking for suites whenever a suite_name is missing
+    :gem_dev_mode => true
+  }
+
+  def self.setup
+    @qlive_config
+  end
+end

data/lib/qlive/suite.rb

@@ -0,0 +1,67 @@
+require 'qlive/setup'
+require 'qlive/qunit_assets'
+
+module Qlive
+  module Suite
+    include QunitAssets
+
+    attr_reader :request, :session
+
+    InsertionPoints ||= [ 'after_head_open', 'before_head_close', 'after_body_open', 'before_body_close']
+
+    def self.included(base)
+      meta = Registry.register_class(base)
+      base.class_eval do
+        class << self
+          attr_reader :suite_meta_data
+        end
+      end
+      base.instance_variable_set(:@suite_meta_data, meta)
+
+      InsertionPoints.each do |place|
+        attr_accessor place
+
+        define_method "html_#{place}" do
+          htmls = instance_variable_get("@#{place}")
+          has_content = htmls.length > 0
+          htmls.unshift "\n<!-- Begin Qlive Insertions (#{place}) -->" if has_content
+          htmls << "<!-- End Qlive Insertions (#{place}) -->\n" if has_content
+          htmls.join("\n")
+        end
+      end
+    end
+
+
+
+    def prepare(args={})
+      @session = args[:session]
+      @request = args[:request]
+      InsertionPoints.each do |place|
+        instance_variable_set("@#{place}", [ ])
+      end
+      prepare_assets
+    end
+
+
+    def name
+      self.meta_data[:name]
+    end
+
+    def meta_data
+      self.class.suite_meta_data
+    end
+
+
+    def suite_name
+      self.name
+    end
+
+
+    protected
+
+    def before_each_request(rack_request)
+      # override to create server-side fixtures here for the qlive request
+    end
+
+  end
+end

data/lib/qlive/version.rb

@@ -0,0 +1,3 @@
+module Qlive
+  VERSION = "0.1.0"
+end

data/qlive.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "qlive/version"
+
+Gem::Specification.new do |s|
+  s.name        = "qlive"
+  s.version     = Qlive::VERSION
+  s.authors     = ["ProxV"]
+  s.email       = ["support@proxv.com"]
+  s.homepage    = "https://github.com/proxv/qlive/"
+  s.summary     = "run qunit tests against actual back-end server with prepared test fixtures"
+  s.description = s.summary
+
+  s.rubyforge_project = "qlive"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'rack', '~> 1.4'
+  s.add_development_dependency "rspec", '~> 2.8.0'
+end

data/spec/fixtures/qunit_support/start-qunit.js

@@ -0,0 +1,5 @@
+$(document).ready(function() {
+  nextTick(function() {
+    QUnit.start();
+  });
+});

data/spec/fixtures/suites/fancy_workflow/fancy_workflow_qlive.rb

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

data/spec/fixtures/suites/fancy_workflow/post-new-recipe.js

@@ -0,0 +1,5 @@
+$(document).ready(function() {
+  module("post-new-recipe.js");
+
+  test("creation pages", 26, window.ns.goodQunitTestFunction);
+});

data/spec/fixtures/suites/fancy_workflow/verify-creds.js

@@ -0,0 +1,5 @@
+$(document).ready(function() {
+  module("verify-creds.js");
+
+  test("permissions", 3, window.ns.permissionCheckB);
+});

data/spec/qlive/rack_spec.rb

@@ -0,0 +1,51 @@
+require File.expand_path("../../spec_helper.rb", __FILE__)
+
+describe Qlive::Rack do
+  class HappyGoLuckyQlive
+    include Qlive::Suite
+
+    def before_each_request(rack_request)
+      rack_request.session[:logged_in_as] = 1255
+    end
+  end
+
+  before(:each) do
+    suite = HappyGoLuckyQlive.new
+    Qlive::Registry.stub!(:build_suite).and_return suite
+  end
+
+  let(:environment) { Rack::MockRequest.env_for('/webapp/tinfoiled?qlive=happy_go_lucky#frontpage') }
+  let(:application) { lambda{|env| [200, {'Content-Type' => 'text/html'}, [ html_page ]]} }
+  let(:middleware) do
+    Qlive::Rack.new(application, { :base_path => fixtures_base_path })
+  end
+
+  it "should insert qunit test resources when magic_param is present in query string" do
+    body = middleware.call(environment)[2].join('')
+    body.should match(/qunit\.js/)
+  end
+
+  it "should allow suite to modify session data" do
+    middleware.call(environment)
+    environment['rack.session'].should == {:logged_in_as => 1255} # see before_each_request
+  end
+
+  #todo: describe "magic param" do
+  #  it "should do nothing when magic param is missing"
+  #  it "should permit configuration of magic_param to use a query param other than 'qlive'"
+  #end
+
+
+  def html_page
+    <<-END.gsub(/^\s+/, '')
+      <html><head>
+      <title>Why Jasmine Is Annoying</title>
+      <script src='/app-ui.js'></script>
+      </head>
+      <body class="webapp">
+      <div class="app-content-holder"></div>
+      </body></html>
+    END
+  end
+
+end

data/spec/qlive/registry_spec.rb

@@ -0,0 +1,18 @@
+require File.expand_path("../../spec_helper.rb", __FILE__)
+
+describe Qlive::Registry, "find_suites" do
+  it "should find qlive suites" do
+    suites = Qlive::Registry.find_suites
+    suites.length.should > 0
+    suites['fancy_workflow'].should_not be_nil
+  end
+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'
+
+  end
+end

data/spec/qlive/suite_spec.rb

@@ -0,0 +1,60 @@
+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
+
+  let(:suite) do
+    suite = BlueSuite.new
+    suite.prepare
+    suite.after_head_open << '<script> doSomethingEarly();</script>'
+    suite
+  end
+
+  it "should provide array of desired html at all insertion points" do
+    suite.after_head_open.length.should == 1
+    suite.html_after_head_open.should match(/doSomethingEarly/) # it also adds before & after comments
+    suite.html_before_body_close.should match(/qunit\.js/)
+  end
+
+end
+
+
+describe Qlive::Suite, "qunit source" do
+  before(:each) do
+    @suite = Qlive::Registry.build_suite('fancy_workflow')
+    @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")}/)
+  end
+
+end
+
+
+describe Qlive::Suite, "insertion helper methods" do
+  class GreenSuite
+    include Qlive::Suite
+  end
+
+  let(:suite) { GreenSuite.new }
+
+  it "should not mess up metacoding too much" do
+    a = GreenSuite.new
+    b = GreenSuite.new
+    a.after_head_open = [ 8 ]
+    b.after_head_open = [ 9 ]
+    a.after_head_open[0].should == 8
+    b.after_head_open[0].should == 9
+  end
+end
+

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--color
+--backtrace

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+QliveHome = File.expand_path('../..', __FILE__)
+require 'rack/mock'
+require "#{QliveHome}/lib/qlive"
+
+def fixtures_base_path
+  "#{QliveHome}/spec/fixtures"
+end
+
+
+RSpec.configure do |config|
+  Qlive.setup[:base_path] = fixtures_base_path
+
+end
+

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: qlive
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- ProxV
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: &2152313360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2152313360
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2152310660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: *2152310660
+description: run qunit tests against actual back-end server with prepared test fixtures
+email:
+- support@proxv.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- lib/qlive.rb
+- lib/qlive/.DS_Store
+- lib/qlive/dev_reload.rb
+- lib/qlive/qunit_assets.rb
+- lib/qlive/rack.rb
+- lib/qlive/registry.rb
+- lib/qlive/setup.rb
+- lib/qlive/suite.rb
+- lib/qlive/version.rb
+- qlive.gemspec
+- spec/.DS_Store
+- spec/fixtures/qunit_support/start-qunit.js
+- spec/fixtures/suites/fancy_workflow/fancy_workflow_qlive.rb
+- spec/fixtures/suites/fancy_workflow/post-new-recipe.js
+- spec/fixtures/suites/fancy_workflow/verify-creds.js
+- spec/qlive/rack_spec.rb
+- spec/qlive/registry_spec.rb
+- spec/qlive/suite_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+homepage: https://github.com/proxv/qlive/
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: qlive
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: run qunit tests against actual back-end server with prepared test fixtures
+test_files:
+- spec/fixtures/qunit_support/start-qunit.js
+- spec/fixtures/suites/fancy_workflow/fancy_workflow_qlive.rb
+- spec/fixtures/suites/fancy_workflow/post-new-recipe.js
+- spec/fixtures/suites/fancy_workflow/verify-creds.js
+- spec/qlive/rack_spec.rb
+- spec/qlive/registry_spec.rb
+- spec/qlive/suite_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb