qlive-rails 0.1.0

data/README.md

@@ -0,0 +1,57 @@
+# Qlive-Rails
+
+Qlive-Rails is a Ruby on Rails engine for running qunit javascript tests using server-side factories and user login.
+
+
+Using the [qlive](https://github.com/proxv/qlive) gem, it provides hooks for setting server state
+before the request is processed by your app, so you can do things like popuplate the page's content with
+your favorite fixtures library (like factory_girl) and log in a user.
+Qlive inserts the qunit framework and all of your test sources into the page's response.
+
+It is mainly intended to be used for testing javascript-heavy, single-page web applications
+(like those built using backbone, angularjs, emberjs, etc.)
+
+
+## Benefits:
+
+* Precisely set fixture content and user login state for your qunit tests
+* Run the same tests in a browser or headlessly, alongside your normal integration test suite. (with the [qlive-headless](https://github.com/proxv/qlive-headless) gem)
+* A dashboard page to link to all of your qlive test suites
+
+
+## Installation
+
+To run qlive headlessly as well as in the browser, use [qlive-headless](https://github.com/proxv/qlive-headless).
+
+For browser-only testing against Ruby on Rails 3, do the following:
+
+* Add qlive-rails to your Gemfile:
+
+    ```ruby
+    group :development do
+      gem 'qlive-rails', :require => 'qlive/engine'
+    end
+    ```
+
+
+* Mount the engine in routes.rb:
+
+    ```ruby
+    if Rails.env == 'development'
+      mount Qlive::Engine => '/qlive'
+    end
+    ```
+
+
+## Usage
+
+
+Wiki pages:
+
+* [Qlive-suites](https://github.com/proxv/qlive/wiki/qlive-suites) for how to use qlive and create suites.
+
+* [Factory_girl Tips](https://github.com/proxv/qlive/wiki/factory-girl-tips) for how to use factory girl in your qlive suites.
+
+* [Devise Tips](https://github.com/proxv/qlive/wiki/devise-tips) for logging in users with devise in your qlive suites.
+
+* Once you have some qlive suites in place, visit /qlive in your app and follow the links within to run them.

data/Rakefile

@@ -0,0 +1,39 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Qlive'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/app/assets/javascripts/qlive/suites.js

@@ -0,0 +1,3 @@
+/*
+ *= require_tree ./suites
+ */

data/app/assets/stylesheets/qlive/suites.css

@@ -0,0 +1,13 @@
+/*
+ *= require_tree ./suites
+ *= require_self
+ */
+
+#qunit-tests li.fail li {
+  list-style: none;
+}
+
+#qunit-tests ol li a.test-page-link {
+  text-decoration: underline;
+  color: #333;
+}

data/app/controllers/qlive/sources_controller.rb

@@ -0,0 +1,14 @@
+module Qlive
+  class SourcesController < ActionController::Base
+
+    def show
+      base_path = Qlive.setup[:base_path]
+      rel_path = params[:rel_path]
+      path = File.expand_path("./#{rel_path}#{rel_path.end_with?('.js') ? '' : '.js'}", base_path)
+      raise "Illegal path: #{path}" unless path.start_with?(base_path)
+      headers['Content-Type'] = 'application/javascript'  # serve other types?  If so: (Mime::Type.lookup_by_extension(params[:format]).to_s rescue 'text/text')
+      render :text => IO.read(path), :status => 200
+    end
+
+  end
+end

data/app/controllers/qlive/suites_controller.rb

@@ -0,0 +1,14 @@
+module Qlive
+  class SuitesController < ActionController::Base
+
+    def index
+      Qlive::DevReload.reload_main if Qlive.setup[:gem_dev_mode]
+      Qlive::Registry.find_suites
+      @suites = Qlive::Registry.suites.keys.map do |suite_name|
+        Qlive::Registry.build_suite(suite_name)
+      end
+    end
+
+
+  end
+end

data/app/helpers/qlive/suites_helper.rb

@@ -0,0 +1,45 @@
+module Qlive
+  module SuitesHelper
+
+    def hrefs_for_suite(suite)
+      return [] unless suite.respond_to?(:pages_to_test)
+      href_array(suite, suite.pages_to_test)
+    end
+
+
+    private
+
+    def href_array(suite, val)
+      if val.nil?
+        [ ]
+      elsif val.kind_of?(String)
+        [ append_suite_command(suite, val) ]
+      elsif val.kind_of?(Array)
+        val.map { |v| append_suite_command(suite, v)}
+      else
+        href_array(suite, val.call)
+      end
+    end
+
+
+    def append_suite_command(suite, href)
+      param = "qlive=#{suite.name}"
+      # todo: use url/uri library to make this cleaner
+      pos = href.index('?')
+      if pos
+        res = "#{href[0, pos + 1]}#{param}&#{href[(pos + 1)..-1]}"
+      else
+        pos = href.index('#')
+        if pos
+          res = "#{href[0, pos]}?#{param}#{href[pos..-1]}"
+        else
+          res = "#{href}?#{param}"
+        end
+      end
+      res
+    end
+
+
+
+  end
+end

data/app/views/layouts/qlive/suites.html.haml

@@ -0,0 +1,11 @@
+!!! 5
+%html{ :xmlns => "http://www.w3.org/1999/xhtml", :lang => "en", "xml:lang" => "en" }
+  %head
+    %meta{ :charset => "utf-8" }
+    %meta{ "http-equiv" => "X-UA-Compatible", :content => "IE=edge,chrome=1" }
+    = stylesheet_link_tag "/qlive/qunit-1.9.0/qunit.css", :media => 'all'
+    = stylesheet_link_tag "qlive/suites", :media => 'all'
+    %title= 'Qlive Suites'
+
+  %body
+    = yield

data/app/views/qlive/suites/index.html.haml

@@ -0,0 +1,27 @@
+%h1#qunit-header
+  %strong Qlive-Rails
+%h2.qunit-pass#qunit-banner
+  -# leave banner empty (its a thin green strip, dunno why they used an h2)
+#qunit-testrunner-toolbar
+  = "Found #{pluralize(@suites.length, 'qlive suite')} in #{Qlive.setup[:base_path].sub(Rails.root.to_s + '/', '')} directory tree."
+%h2#qunit-userAgent
+  Pages registered to run qunit qlive suites:
+
+%ol#qunit-tests
+  - if @suites.length > 0
+    - @suites.each do |suite|
+      - hrefs = hrefs_for_suite(suite)
+      - has_links = hrefs.length > 0
+      %li{ :class => has_links ? 'pass' : 'fail' }
+        %strong.module-name= "Suite '#{suite.name}' has #{pluralize(hrefs.length, 'test page')}."
+        %ol
+          - if has_links
+            - hrefs.each do |href|
+              %li.pass
+                %a.test-message.test-page-link{ :href => href}= href
+          - else
+            %li
+              .test-message This suite is not declaring any links to pages in your app. <i>Set them with suite#pages_to_test()</i>
+  - else
+    %li.fail
+      %strong No Qlive Suites Found

data/config/routes.rb

@@ -0,0 +1,4 @@
+Qlive::Engine.routes.draw do
+  match '/' => 'qlive/suites#index'
+  match '/sources/*rel_path' => 'qlive/sources#show'
+end

data/lib/qlive/engine.rb

@@ -0,0 +1,27 @@
+require 'qlive/rack'
+require 'qlive/dev_reload'
+require 'qlive/suite'
+
+module Qlive
+  class Engine < Rails::Engine
+
+    initializer "qlive" do |app|
+      Qlive.setup[:base_path] ||= "#{Rails.root}/spec/qunits"
+
+      puts "Mounting Qlive::Rack to allow qunit testing against your server's backend. (Never use this rack on production systems.)"
+      if Qlive.setup[:hand_mounted]
+        Qlive.setup[:hand_mounted].call
+      else
+        app.middleware.insert_after(::ActionDispatch::ParamsParser, Qlive::Rack, {
+          :base_path => Qlive.setup[:base_path]
+        })
+        app.middleware.insert_after ::ActionDispatch::Static, ::ActionDispatch::Static, "#{root}/public"
+      end
+
+      if Qlive.setup[:gem_dev_mode]
+        app.middleware.insert_before(::ActionDispatch::ParamsParser, Qlive::DevReload)
+      end
+    end
+
+  end
+end

data/lib/qlive/version.rb

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

data/lib/qlive.rb

@@ -0,0 +1,7 @@
+#require 'qlive/headless/matchers'
+#require 'qlive/headless/dsl'
+#require 'qlive/headless/runner'
+
+module Qlive
+
+end

data/lib/tasks/qlive_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :qlive do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: qlive-rails
+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: qlive
+  requirement: &2152342160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2152342160
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &2152340180 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2152340180
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: &2152337900 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: *2152337900
+description: Ruby on Rails engine for running qunit javascript tests using server-side
+  factories and user login
+email:
+- support@proxv.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- app/assets/javascripts/qlive/suites.js
+- app/assets/stylesheets/qlive/suites.css
+- app/controllers/qlive/sources_controller.rb
+- app/controllers/qlive/suites_controller.rb
+- app/helpers/qlive/suites_helper.rb
+- app/views/layouts/qlive/suites.html.haml
+- app/views/qlive/suites/index.html.haml
+- config/routes.rb
+- lib/qlive/engine.rb
+- lib/qlive/version.rb
+- lib/qlive.rb
+- lib/tasks/qlive_tasks.rake
+- Rakefile
+- README.md
+homepage: https://github.com/proxv/qlive-rails/
+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: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Ruby on Rails engine for running qunit javascript tests using server-side
+  factories and user login
+test_files: []