test_squad 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8558931146248c1acab78a3a1927c68d27fac067
-  data.tar.gz: f852e96638b6e735c0380aef4067c5660d207a5e
+  metadata.gz: 8d8a0e6e00da040f75e75852c90c0596c0febad6
+  data.tar.gz: 23449b3538b4afc02ed5f771438bff21cb31d56a
 SHA512:
-  metadata.gz: 7f4084ca3a280d2fc46c8a152e28832b507cb2f49899650ad07ab17d7c55c01737add06d838afbce4680d92fb9e5600d927ee3ed3320f0555946502ff58a04dc
-  data.tar.gz: 8793c9502f41d95046be6aed10cdcfbaee7176f0b30b6e371bd4228bd275f44d84202962d238a91f1927f33273b9968041abd1f142be486597f50f6a054feb56
+  metadata.gz: b51083b6c2848eb848e8d668e4857ab5b0d4bcb6b24153a1d33cde3bb91d3409bb381ba42625bf22410938c2e759182ca8c9734a2e797a789acdd880ca4f444f
+  data.tar.gz: a54bc57fa49a7b2e27af6f25a395dfe804860dc84b6249517381cebfadb0fce3ee2139e44f7d8a04c1826713252900e458dc7f570937f67ba395ecb254d01fc2

data/README.md

@@ -1,15 +1,20 @@
 # TestSquad
 
+[![Build Status](https://travis-ci.org/fnando/test_squad.svg)](https://travis-ci.org/fnando/test_squad)
+[![Code Climate](https://codeclimate.com/github/fnando/test_squad/badges/gpa.svg)](https://codeclimate.com/github/fnando/test_squad)
+[![Test Coverage](https://codeclimate.com/github/fnando/test_squad/badges/coverage.svg)](https://codeclimate.com/github/fnando/test_squad)
+
 Running JavaScript tests on your Rails app, the easy way.
 
-- Supports QUnit, Ember.js, Mocha and Jasmine
+- Supports [QUnit](http://qunitjs.com), [Ember.js](http://emberjs.com), [Mocha](http://mochajs.org) and [Jasmine](http://jasmine.github.io/)
 - Go headless with [Phantom.js](http://phantomjs.org)
 - Colored output
 - Asset pipeline support
+- [Rails Assets](http://rails-assets.org) support (Bower Proxy)
 
 ## Installation
 
-Add these lines to your application's Gemfile:
+Add these lines to your application's `Gemfile`:
 
 ```ruby
 group :development, :test do
@@ -25,7 +30,7 @@ $ bundle
 
 ## Usage
 
-After installing TestSquad, generate your tests skeleton. The generator will detect if you're using RSpec or TestUnit and will generate the `javascript` directory basead on that detection. Just use the command `rails generate test_squad:install --framework FRAMEWORK`.
+After installing TestSquad, generate your tests skeleton. The generator will detect if you're using RSpec or TestUnit and will generate the `javascript` directory based on that detection. Just use the command `rails generate test_squad:install --framework FRAMEWORK`.
 
 ```console
 $ rails generate test_squad:install --framework jasmine
@@ -49,6 +54,8 @@ You can run your tests with `rake test_squad`. You can also visit `http://localh
 
 ![Terminal](https://github.com/fnando/test_squad/raw/master/screenshots/terminal.png)
 
+![Ember](https://github.com/fnando/test_squad/raw/master/screenshots/terminal-ember.png)
+
 ### Configure Ember
 
 When using the Ember framework, you must configure your application name. It'll default to your Rails application name.
@@ -148,11 +155,24 @@ Otherwise you won't be able to to run your in-browser tests.
 
 The rake task accepts some env variables.
 
-- `HOST`: the binding host. Defaults to `localhost`.
-- `PORT`: the server port. Defaults to `50000`.
-- `TIMEOUT`: how much time a test can take. Defaults to `10` (seconds).
-- `LOG`: set if console messages should be logged. Defaults to `false`.
-- `PHANTOMJS_BIN`: set the PhantomJS binary. Defaults to `phantomjs`.
+- `TEST_SQUAD_SERVER_HOST`: the binding host. Defaults to `localhost`.
+- `TEST_SQUAD_SERVER_PORT`: the server port. Defaults to `50000`.
+- `TEST_SQUAD_SERVER_PATH`: the server path. Defaults to `/tests`.
+- `TEST_SQUAD_TIMEOUT`: how much time a test can take. Defaults to `10` (seconds).
+- `TEST_SQUAD_PHANTOMJS_BIN`: set the PhantomJS binary. Defaults to `phantomjs`.
+
+You can configure these options using the `{test,spec}/javascript/test_squad.rb` file.
+
+```ruby
+TestSquad.configure do |config|
+  config.framework = 'qunit'
+  config.server_host = '127.0.0.1'
+  config.server_port = 50000
+  config.server_path = '/tests'
+  config.timeout = 10
+  config.phantomjs_bin = 'phantomjs'
+end
+```
 
 ## Contributing
 

data/Rakefile

@@ -13,6 +13,7 @@ Rake::TestTask.new(:test) do |t|
   t.libs << 'test'
   t.pattern = 'test/**/*_test.rb'
   t.verbose = false
+  t.warning = false
 end
 
 task default: :test

data/lib/generators/test_squad/install/install_generator.rb

@@ -1,86 +1,116 @@
-class TestSquad::InstallGenerator < Rails::Generators::Base
-  source_root File.expand_path('../templates', __FILE__)
+module TestSquad
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path("../templates", __FILE__)
 
-  class_option :framework,
-    type: 'string',
-    desc: 'Select the JavaScript framework. Can be jasmine, qunit, mocha or ember.',
-    aliases: '-f',
-    required: true
+    SKIP_RAILS_ASSETS = %w[jasmine]
 
-  def generate
-    send "generate_#{options[:framework]}"
-  end
+    class_option :framework,
+      type: "string",
+      desc: "Select the JavaScript framework. Can be jasmine, qunit, mocha or ember.",
+      aliases: "-f",
+      required: true
 
-  def generate_defaults
-    add_source 'https://rails-assets.org'
-    empty_directory test_directory
-    template 'test_squad.rb.erb', "#{test_directory}/test_squad.rb"
-  end
+    class_option :skip_source,
+      type: "boolean",
+      desc: "Skip adding gem source to Gemfile",
+      aliases: "-s"
 
-  private
+    def generate
+      send "generate_#{framework}"
+    end
 
-  def test_directory
-    TestSquad.test_directory
-  end
+    def generate_defaults
+      empty_directory test_directory
+      template "test_squad.rb.erb", "#{test_directory}/test_squad.rb"
+    end
 
-  def app_name
-    app_class_name.underscore
-  end
+    private
 
-  def app_class_name
-    TestSquad.app_class_name
-  end
+    def framework
+      options[:framework]
+    end
 
-  def generate_qunit
-    empty_directory "#{test_directory}/#{app_name}"
-    create_file "#{test_directory}/#{app_name}/.keep"
-    template 'qunit/test_helper.js.erb', "#{test_directory}/test_helper.js"
-    copy_file 'qunit/answer_test.js', "#{test_directory}/#{app_name}/answer_test.js"
+    def test_directory
+      if File.exist?(File.join(destination_root, "spec"))
+        "spec/javascript"
+      else
+        "test/javascript"
+      end
+    end
 
-    gem_group :development, :test do
-      gem 'rails-assets-qunit'
+    def app_name
+      app_class_name.underscore
     end
-  end
 
-  def generate_jasmine
-    empty_directory "#{test_directory}/#{app_name}"
-    create_file "#{test_directory}/#{app_name}/.keep"
-    template 'jasmine/spec_helper.js.erb', "#{test_directory}/spec_helper.js"
-    copy_file 'jasmine/answer_spec.js', "#{test_directory}/#{app_name}/answer_spec.js"
-  end
+    def app_class_name
+      TestSquad.app_class_name
+    end
 
-  def generate_mocha
-    empty_directory "#{test_directory}/#{app_name}"
-    create_file "#{test_directory}/#{app_name}/.keep"
-    template 'mocha/spec_helper.js.erb', "#{test_directory}/spec_helper.js"
-    copy_file 'mocha/answer_spec.js', "#{test_directory}/#{app_name}/answer_spec.js"
+    def generate_qunit
+      empty_directory "#{test_directory}/#{app_name}"
+      create_file "#{test_directory}/#{app_name}/.keep"
+      template "qunit/test_helper.js.erb", "#{test_directory}/test_helper.js"
+      copy_file "qunit/answer_test.js", "#{test_directory}/#{app_name}/answer_test.js"
 
-    gem_group :development, :test do
-      gem 'rails-assets-mocha'
-      gem 'rails-assets-expect'
+      rails_assets do
+        gem "rails-assets-qunit"
+      end unless options[:skip_source]
     end
-  end
 
-  def generate_ember
-    empty_directory "#{test_directory}/unit"
-    copy_file 'ember/router_test.js', "#{test_directory}/unit/router_test.js"
+    def generate_jasmine
+      empty_directory "#{test_directory}/#{app_name}"
+      create_file "#{test_directory}/#{app_name}/.keep"
+      template "jasmine/spec_helper.js.erb", "#{test_directory}/spec_helper.js"
+      copy_file "jasmine/answer_spec.js", "#{test_directory}/#{app_name}/answer_spec.js"
+    end
+
+    def generate_mocha
+      empty_directory "#{test_directory}/#{app_name}"
+      create_file "#{test_directory}/#{app_name}/.keep"
+      template "mocha/spec_helper.js.erb", "#{test_directory}/spec_helper.js"
+      copy_file "mocha/answer_spec.js", "#{test_directory}/#{app_name}/answer_spec.js"
+
+      rails_assets do
+        gem_group :development, :test do
+          gem "rails-assets-mocha"
+          gem "rails-assets-expect"
+        end
+      end unless options[:skip_source]
+    end
+
+    def generate_ember
+      empty_directory "#{test_directory}/unit"
+      copy_file "ember/router_test.js", "#{test_directory}/unit/router_test.js"
+
+      empty_directory "#{test_directory}/routes"
+      create_file "#{test_directory}/routes/.keep"
+
+      empty_directory "#{test_directory}/components"
+      create_file "#{test_directory}/components/.keep"
 
-    empty_directory "#{test_directory}/routes"
-    create_file "#{test_directory}/routes/.keep"
+      empty_directory "#{test_directory}/views"
+      create_file "#{test_directory}/views/.keep"
 
-    empty_directory "#{test_directory}/components"
-    create_file "#{test_directory}/components/.keep"
+      empty_directory "#{test_directory}/models"
+      create_file "#{test_directory}/models/.keep"
 
-    empty_directory "#{test_directory}/views"
-    create_file "#{test_directory}/views/.keep"
+      template "ember/test_helper.js.erb", "#{test_directory}/test_helper.js"
+
+      rails_assets do
+        gem_group :development, :test do
+          gem "rails-assets-qunit"
+        end
+      end unless options[:skip_source]
+    end
 
-    empty_directory "#{test_directory}/models"
-    create_file "#{test_directory}/models/.keep"
+    def rails_assets(&block)
+      in_root do
+        append_file "Gemfile", %[\nsource "https://rails-assets.org" do], force: true
 
-    template 'ember/test_helper.js.erb', "#{test_directory}/test_helper.js"
+        instance_eval(&block)
 
-    gem_group :development, :test do
-      gem 'rails-assets-qunit'
+        append_file "Gemfile", "\nend\n", force: true
+      end
     end
   end
 end

data/lib/generators/test_squad/install/templates/test_squad.rb.erb

@@ -1,5 +1,28 @@
 TestSquad.configure do |config|
   # Set the testing framework.
   # Can be jasmine, qunit, mocha or ember.
-  config.framework = '<%= options[:framework] %>'
+  config.framework = "<%= options[:framework] %>"
+
+  # Set the test server host.
+  # This can also be set through the TEST_SQUAD_SEVER_HOST env var.
+  # config.server_host = "127.0.0.1"
+
+  # Set the test server port.
+  # This can also be set through the TEST_SQUAD_SERVER_PORT env var.
+  # config.server_port = 50000
+
+  # Set the test server path.
+  # You may map the tests path to something else. This change
+  # must be reflected here. This can also be set through the
+  # TEST_SQUAD_SERVER_PATH env var.
+  # config.server_path = "/tests"
+
+  # Set the test timeout.
+  # This can also be set through the TEST_SQUAD_TIMEOUT env var.
+  # It defaults to 10 seconds.
+  # config.timeout = 10
+
+  # Set the phantomjs bin path.
+  # This can also be set through the TEST_SQUAD_PHANTOMJS_BIN env var.
+  # config.phantomjs_bin = "phantomjs"
 end

data/lib/tasks/test_squad_tasks.rake

@@ -1,39 +1,11 @@
-desc 'Run JavaScript tests'
+desc "Run JavaScript tests"
 task :test_squad do
-  ENV['RAILS_ENV'] = 'test'
-  ENV['RACK_ENV'] = 'test'
+  ENV["RAILS_ENV"] = "test"
+  ENV["RACK_ENV"] = "test"
 
-  require './config/environment'
-  require 'stringio'
+  require "./config/environment"
+  config_file = Rails.root.join(TestSquad.test_directory, "test_squad.rb")
+  load config_file if config_file.exist?
 
-  phantomjs_bin = ENV.fetch('PHANTOMJS_BIN', 'phantomjs')
-  port = ENV.fetch('PORT', 50000)
-  host = ENV.fetch('HOST', 'localhost')
-  path = ENV.fetch('TEST_PATH', '/tests')
-  timeout = ENV.fetch('TIMEOUT', '10')
-  log = ENV.fetch('LOG', 'false')
-  url = File.join("http://#{host}:#{port}", path)
-  logger = Logger.new(StringIO.new)
-
-  handler = Rack::Handler.pick(['puma', 'thin', 'webrick'])
-
-  Rails.configuration.logger = logger
-
-  thread = Thread.new {
-    handler.run Rails.application,
-      Port: port,
-      Host: host,
-      Logger: logger,
-      AccessLog: []
-  }
-
-  thread.abort_on_exception = true
-
-  system phantomjs_bin,
-    File.expand_path('../../../phantomjs/runner.js', __FILE__),
-    url,
-    timeout,
-    log
-
-  exit $?.exitstatus
+  TestSquad::Runner.run
 end

data/lib/test_squad.rb

@@ -1,9 +1,10 @@
-require 'test_squad/engine'
-require 'ostruct'
+require "test_squad/engine"
+require "test_squad/runner"
+require "test_squad/configuration"
 
 module TestSquad
   def self.configuration
-    @configuration ||= OpenStruct.new
+    @configuration ||= Configuration.new
   end
 
   def self.configure(&block)
@@ -11,15 +12,15 @@ module TestSquad
   end
 
   def self.app_class_name
-    Rails.application.class.name.split('::').first
+    Rails.application.class.name.split("::").first
   end
 
   def self.test_directory
     @test_directory ||= begin
-      if Rails.root.join('spec').exist?
-        'spec/javascript'
+      if Rails.root.join("spec").exist?
+        "spec/javascript"
       else
-        'test/javascript'
+        "test/javascript"
       end
     end
   end

data/lib/test_squad/configuration.rb

@@ -0,0 +1,65 @@
+module TestSquad
+  class Configuration
+    # Set the enabled JavaScript library.
+    attr_accessor :framework
+
+    # Set the phantomjs bin path.
+    # This can also be set through the TEST_SQUAD_PHANTOMJS_BIN env var.
+    # It defaults to `phantomjs`.
+    attr_writer :phantomjs_bin
+
+    # Set the test server host.
+    # This can also be set through the TEST_SQUAD_SERVER_HOST env var.
+    # It defaults to `127.0.0.1`
+    attr_writer :server_host
+
+    # Set the test server port.
+    # This can also be set through the TEST_SQUAD_SERVER_PORT env var.
+    # It defaults to `42424`
+    attr_writer :server_port
+
+    # Set the test server path.
+    # You may map the tests path to something else. This change
+    # must be reflected here. This can also be set through the
+    # TEST_SQUAD_SERVER_PATH env var.
+    # It defaults to `/tests`.
+    attr_writer :server_path
+
+    # Set the test timeout.
+    # This can also be set through the TEST_SQUAD_TIMEOUT env var.
+    # It defaults to `10` seconds.
+    attr_writer :timeout
+
+    def server_uri
+      File.join("http://#{server_host}:#{server_port}", server_path)
+    end
+
+    def phantomjs_bin
+      get_value("TEST_SQUAD_PHANTOMJS_BIN", __method__, "phantomjs")
+    end
+
+    def server_host
+      get_value("TEST_SQUAD_SERVER_HOST", __method__, "127.0.0.1")
+    end
+
+    def server_port
+      get_value("TEST_SQUAD_SERVER_PORT", __method__, 42_424)
+    end
+
+    def server_path
+      get_value("TEST_SQUAD_SERVER_PATH", __method__, "/tests")
+    end
+
+    def timeout
+      get_value("TEST_SQUAD_TIMEOUT", __method__, 10)
+    end
+
+    private
+
+    def get_value(env_var, option_name, default_value)
+      ENV[env_var] ||
+        instance_variable_get("@#{option_name}") ||
+        default_value
+    end
+  end
+end