qlive-rspec 0.1.0

data/.gitignore

@@ -0,0 +1,9 @@
+.bundle/
+log/*.log
+pkg/
+spec/dummy/db/*.sqlite3
+spec/dummy/log/*.log
+spec/dummy/tmp/
+*.iml
+*.gem
+Gemfile.lock

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 TODO: Write your name
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,77 @@
+# Qlive-Rspec
+
+Run qlive-rails qunit javascript tests headlessly alongside your normal rspec integration examples.
+
+This builds on the [qlive-rails](https://github.com/proxv/qlive-rails) gem. If you are using Ruby on Rails and rspec,
+this gem will let you run your qlive tests in both a browser and headlessly as an rspec example/test.
+
+Qlive-rspec has relatively heavy dependencies: virtual X11 frame buffer, headless webkit, capybara, and rspec.
+If this doesn't work for you, it should be possible to incorporate your qlive tests into other automated testing
+or continuous integration enviornments (eg, with a selenium-related library.)
+
+
+
+## Installation
+
+* Install webkit-qt and xvfb on your system. Eg:
+<pre>sudo aptitude install libqt4-dev xvfb</pre>
+
+note: more detailed instructions at [capybara-webkit](https://github.com/thoughtbot/capybara-webkit) and [headless](https://github.com/leonid-shevtsov/headless) gems.
+
+
+* Add qlive-rails and qlive-rspec to your Gemfile as follows:
+
+    ```ruby
+    group :test, :development do
+      gem 'qlive-rails', :require => 'qlive/engine'
+    end
+
+    group :test do
+      gem 'qlive-rspec'
+    end
+    ```
+
+* As in qlive-rails, mount the engine in routes.rb:
+
+    ```ruby
+    if Rails.env == 'development'
+      mount Qlive::Engine => '/qlive'
+    end
+    ```
+
+
+
+
+## Usage
+
+### qunits_spec.rb
+
+* After you have your [qlive suites](https://github.com/proxv/qlive/wiki/qlive-suites) working in a browser,
+create ``spec/qunits/qunits_spec.rb``:
+
+```ruby
+  require "my_spec_helper.rb"
+
+  describe "qunits" do
+    include Qlive::RSpec
+  end
+```
+
+
+* It will now run as a normal rspec example:
+<pre>rspec spec/qunits</pre>
+
+
+### Configuration
+
+* Optionally run setup/teardown code before and after the qlive tests are run.
+<pre>
+Qlive.setup[:before_suites] lambda { my_setup_code }
+Qlive.setup[:after_suites] lambda { my_teardown_code }
+</pre>
+
+* Optionally set xvfb/headless gem to a custom configuration hash with: ``Qlive.setup[:headless_config] = my_settings_hash``
+
+* Optionally disable xvfb with ``Qlive.setup[:start_xvfb] = false`` if you plan on configuring it externally
+
+* Optionally change per-page timeout in seconds with: ``Qlive.setup[:capybara_wait_time] = 30``

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/qlive-rspec.rb

@@ -0,0 +1,12 @@
+require "qlive-rspec/version"
+require "qlive/rspec"
+
+
+module QliveRSpec
+  Qlive.setup[:start_xvfb] = true unless Qlive.setup.has_key?(:start_xvfb)
+  Qlive.setup[:headless_config] = {
+    :display => 99
+    # :destroy_at_exit => true, :reuse => false
+  }
+  Qlive.setup[:capybara_wait_time] = 30
+end

data/lib/qlive-rspec/version.rb

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

data/lib/qlive/matchers.rb

@@ -0,0 +1,28 @@
+module Qlive
+  module Matchers
+    def self.add_matchers
+      ::RSpec::Matchers.define :pass_qunit_tests do |failure_text|
+        match do |page_actual|
+          url = page_actual.current_url
+          passed = page_actual.find('#qunit-testresult .passed').text.to_i rescue 0
+          failed = page_actual.find('#qunit-testresult .failed').text.to_i rescue 1
+          Qlive.logger.info "#{url } passed: #{passed}, failed: #{failed}"
+
+          failed == 0 && passed > 0
+        end
+
+        failure_message_for_should do |page_actual|
+          "qunit failure text: #{failure_text}"
+        end
+
+        failure_message_for_should_not do |page_actual|
+          "expected qunit test to fail but all passed."
+        end
+
+        description do
+          "pass qunit tests"
+        end
+      end
+    end
+  end
+end

data/lib/qlive/rspec.rb

@@ -0,0 +1,74 @@
+require 'capybara/rspec'
+require 'headless'  # https://github.com/leonid-shevtsov/headless
+require 'qlive/matchers'
+require "#{Qlive::Engine.root}/app/helpers/qlive/suites_helper.rb"
+
+module Qlive
+  module RSpec
+
+    describe "qlive" do
+      Qlive::Matchers.add_matchers
+
+      it "should define all qlive suites" do
+        # nested it/describe hackery explained: Rails.root path is needed before we can programmatically declare
+        # qunit examples, but it is not available until the examples start running. This hacky workaround nests the
+        # describe examples and example group that we want in another "it" declaration. todo: investigate better rspec integration
+
+        Qlive.setup[:base_path] ||= "#{Rails.root}/spec/qunits"
+        Qlive.setup[:logger] ||= Rails.logger
+        Qlive::Registry.find_suites
+
+        describe "pages", :type => :request do
+          extend Qlive::SuitesHelper
+
+          def visit_qunit_page(suite_name, href)
+            using_wait_time(Qlive.setup[:capybara_wait_time]) do  # perhaps let suites override this value
+              Qlive.logger.info "Qlive sending capybara to run '#{suite_name}' on #{href}"
+              visit href
+              page.html.should_not be_nil
+              page.wait_until(Qlive.setup[:capybara_wait_time]) do # hmmmm
+                page.evaluate_script('!!window.qunitComplete')
+              end
+              failure_text = page.evaluate_script("$('li.fail li.fail').text();")
+              page.should pass_qunit_tests(failure_text)
+            end
+          end
+
+          Qlive::Registry.suites.values.each do |suite_meta|
+            load suite_meta[:path]
+            suite = Qlive::Registry.build_suite(suite_meta[:name])
+            hrefs_for_suite(suite).each do |href|
+              it "should pass qunit tests when visiting: #{href}" do
+                visit_qunit_page(suite.name, href)
+              end
+            end
+          end
+
+          before(:all) do
+            Qlive.setup[:before_suites].call if Qlive.setup[:before_suites]
+            if Qlive.setup[:start_xvfb]
+              @headless = ::Headless.new(Qlive.setup[:headless_config])
+              @headless.start
+            end
+          end
+
+          before(:each) do
+            page.reset!
+          end
+
+          after(:all) do
+            puts "\nGetting rough with headless webkit_server. In the event of a fatal IO error, use your judgement regarding calling the police."
+            @headless.destroy if @headless
+            if Qlive.setup[:after_suites]
+              Qlive.setup[:after_suites].call
+            end
+          end
+
+        end
+      end
+
+    end
+
+  end
+end
+

data/qlive-rspec.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/qlive-rspec/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["ProxV"]
+  gem.email         = ["support@proxv.com"]
+  gem.summary       = "Run qlive-rails qunit javascript tests headlessly alongside your normal rspec integration examples"
+  gem.description   = gem.summary
+  gem.homepage      = "https://github.com/proxv/qlive-rspec/"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "qlive-rspec"
+  gem.require_paths = ["lib"]
+  gem.version       = QliveRSpec::VERSION
+
+  gem.add_dependency "qlive-rails", "~> 0.1.2"
+  gem.add_dependency "capybara-webkit", "0.10.0"
+  gem.add_dependency "rspec-rails", "~> 2.8.1"
+  gem.add_dependency "headless", "~> 0.3"
+  gem.add_development_dependency "rspec-rails", "~> 2.8.0"
+  gem.add_development_dependency "factory_girl_rails", "~> 3.5.0"
+end

data/spec/dummy/Gemfile

@@ -0,0 +1,29 @@
+source 'https://rubygems.org'
+
+gem 'rails', '~> 3.2.3'
+gem 'sqlite3'
+gem 'haml-rails'
+
+group :assets do
+  gem 'sass-rails',   '~> 3.2.3'
+  gem 'coffee-rails', '~> 3.2.1'
+  gem 'uglifier', '>= 1.0.3'
+end
+
+gem 'jquery-rails'
+gem 'backbone-on-rails'
+
+group :development do
+end
+
+group :test, :development do
+  gem 'factory_girl_rails', '3.5.0'
+  gem 'qlive-rails', :require => 'qlive/engine' # https://github.com/proxv/qlive
+end
+
+group :test do
+  gem 'rspec-rails', '~> 2.8.1'
+  gem 'capybara-webkit', '0.10.0'
+  gem 'headless', '~> 0.2'
+  gem 'qlive-rspec', :path => File.expand_path('../../..', __FILE__)
+end

data/spec/dummy/README.md

@@ -0,0 +1,19 @@
+
+# Dummy App
+
+I randomly grabbed a demo app that uses rails and backbone:
+https://github.com/mulderp/Backbone-on-Rails-todoDemo
+
+
+## Run dummy app qlive suites in browser
+```
+cd qlive-rspec/spec/dummy
+rails s
+http://localhost/qlive
+```
+
+## Run dummy app qlive suites headlessly
+```
+rspec spec/qunits
+```
+

data/spec/dummy/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+BackboneOnRailsTodo::Application.load_tasks

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,25 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require underscore
+//= require backbone
+
+//= require backbone_on_rails_todo
+
+//= require_tree ../templates
+//= require_tree ./models
+//= require_tree ./collections
+//= require_tree ./views
+//= require_tree ./routers
+//= require_tree .

data/spec/dummy/app/assets/javascripts/backbone_on_rails_todo.js.coffee

@@ -0,0 +1,11 @@
+window.BackboneOnRailsTodo =
+  Models: {}
+  Collections: {}
+  Views: {}
+  Routers: {}
+  init: ->
+    new BackboneOnRailsTodo.Routers.TodoApp
+    Backbone.history.start()
+
+$(document).ready ->
+  BackboneOnRailsTodo.init()

data/spec/dummy/app/assets/javascripts/collections/todos.js.coffee

@@ -0,0 +1,5 @@
+class BackboneOnRailsTodo.Collections.Todos extends Backbone.Collection
+  model: BackboneOnRailsTodo.Models.Todo
+  url: '/todos'
+
+

data/spec/dummy/app/assets/javascripts/models/todo.js.coffee

@@ -0,0 +1,3 @@
+class BackboneOnRailsTodo.Models.Todo extends Backbone.Model
+
+

data/spec/dummy/app/assets/javascripts/routers/todo_app_router.js.coffee

@@ -0,0 +1,14 @@
+class BackboneOnRailsTodo.Routers.TodoApp extends Backbone.Router
+  routes: 
+    '': 'index'
+    'colors/:color': 'index'
+
+  initialize: ->
+    @todos = new BackboneOnRailsTodo.Collections.Todos()
+    @todos.fetch()
+
+  index: (color) ->
+    view = new BackboneOnRailsTodo.Views.TodoApp({collection: @todos})
+    $('#todo-list').html(view.render().el)
+    $('<style>#todo-list li { color: ' + (color || 'green') + ';}</style>').appendTo('body')
+

data/spec/dummy/app/assets/javascripts/views/todo_app/todo_app.js.coffee

@@ -0,0 +1,29 @@
+class BackboneOnRailsTodo.Views.TodoApp extends Backbone.View
+
+  el: $('#todoapp')
+
+  initialize: ->
+    @collection.on('reset', @addAll, this)
+    @collection.on('add', this.addOne, this)
+    $('#new-todo').on "keypress", {collection: @collection}, @keyTodoInput
+
+  addAll: ->
+    @collection.each(@addOne)
+
+  addOne: (todo) ->
+    console.log(todo)
+    view = new BackboneOnRailsTodo.Views.Todo({model: todo})
+    $("#todo-list").append(view.render().el)
+  
+  createTodo: (event) ->
+    event.preventDefault()
+    BackboneOnRailsTodo.Collections.Todos.create content: $('#new-todo-content').val()
+
+  keyTodoInput: (e) ->
+    # console.log(event.type, event.keyCode)
+    return if (e.keyCode != 13)
+    return if (!this.value)
+    console.log(e.data.collection)
+
+    e.data.collection.create content: this.value
+    this.value = ''

data/spec/dummy/app/assets/javascripts/views/todos/todo.js.coffee

@@ -0,0 +1,12 @@
+class BackboneOnRailsTodo.Views.Todo extends Backbone.View
+
+  tagName: 'li'
+
+  template: JST['todos/index']
+
+  initialize: (todo) ->
+    @todo = todo.model
+
+  render: ->
+    $(@el).html(@template(todo: @todo))
+    this