RubyGems - teabag - Versions diffs - 0.3.0 - Mend

teabag 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (486) hide show

data/app/controllers/teabag/spec_controller.rb ADDED

@@ -0,0 +1,25 @@
+class Teabag::SpecController < ActionController::Base
+  helper Teabag::SpecHelper rescue nil
+  layout false
+  unless Rails.application.config.assets.debug
+    rescue_from Teabag::AssetNotServable, with: :javascript_exception
+  end
+  def index
+    @suite = Teabag::Suite.new(params[:suite])
+  end
+  def fixtures
+    prepend_view_path Teabag.configuration.root.join(Teabag.configuration.fixture_path)
+    render "/#{params[:filename]}"
+  end
+  private
+  def javascript_exception(exception)
+    err  = "#{exception.class.name}: #{exception.message}"
+    render text: "<script>throw Error(#{err.inspect})</script>"
+  end
+end

data/app/views/teabag/spec/index.html.erb ADDED

@@ -0,0 +1,18 @@
+<!DOCTYPE>
+<html>
+  <head>
+    <title>Teabag :: Javascript Test Runner</title>
+    <%= stylesheet_link_tag *@suite.stylesheets %>
+    <%= javascript_include_tag *@suite.javascripts %>
+    <%= csrf_meta_tags %>
+  </head>
+  <body>
+    <div id="teabag-fixtures"></div>
+    <script type="text/javascript">
+      Teabag.version = "<%= Teabag::VERSION %>";
+      Teabag.fixturePath = "<%= Teabag.configuration.mount_at %>/fixtures";
+      Teabag.execute()
+    </script>
+  </body>
+</html>

data/config/routes.rb ADDED

@@ -0,0 +1,8 @@
+Teabag::Engine.routes.draw do
+  match "/fixtures/*filename", to: "spec#fixtures"
+  match "/(:suite)", :to => "spec#index", defaults: { suite: nil }
+end
+Rails.application.routes.draw do
+  mount Teabag::Engine => Teabag.configuration.mount_at
+end

data/lib/generators/teabag/install/POST_INSTALL ADDED

@@ -0,0 +1,6 @@
++============================================================================+
+Congratulations! Teabag was successfully installed. Documentation and more can
+be found at: https://github.com/modeset/teabag
+Configure Teabag by editing config/initializers/teabag.rb

data/lib/generators/teabag/install/install_generator.rb ADDED

@@ -0,0 +1,24 @@
+module Teabag::Generators
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path("../", __FILE__)
+    desc "Installs the Teabag initializer into your application."
+    def copy_initializer
+      copy_file "templates/initializer.rb", "config/initializers/teabag.rb"
+    end
+    def create_structure
+      empty_directory "spec/javascripts/support"
+      empty_directory "spec/javascripts/fixtures"
+    end
+    def copy_spec_helper
+      copy_file "templates/spec_helper.js", "spec/javascripts/spec_helper.js"
+    end
+    def display_readme
+      readme "POST_INSTALL" if behavior == :invoke
+    end
+  end
+end

data/lib/generators/teabag/install/templates/initializer.rb ADDED

@@ -0,0 +1,115 @@
+Teabag.setup do |config|
+  # Mounting / Route
+  # This determines where the Teabag spec path will be mounted. Changing this to `"/jasmine"` would allow you to browse
+  # to `http://localhost:3000/jasmine` to run your specs.
+  #
+  # default: "/teabag"
+  config.mount_at = "/teabag"
+  # Root
+  # The root path defaults to Rails.root if left nil, but if you're testing an engine using a dummy application it's
+  # useful to be able to set this to your engines root.. E.g. `Teabag::Engine.root`
+  #
+  # default: nil, which forces defaulting to Rails.root
+  config.root = nil
+  # Asset paths
+  # These paths are appended to the rails assets paths (relative to config.root), and by default is an array that you
+  # can replace or add to.
+  #
+  # default: ["spec/javascripts", "spec/javascripts/stylesheets"]
+  config.asset_paths << "app/assets/some_other_path"
+  # Fixtures
+  # Fixtures are different than the specs, in that Rails is rendering them directly through a controller. This means you
+  # can use haml, erb builder, rabl, etc. to render content in the views available in this path.
+  #
+  # default: "spec/javascripts/fixtures"
+  config.fixture_path = "spec/javascripts/fixtures"
+  # Server timeout
+  # Timeout for starting the server in seconds. If your server is slow to start you may have to bump the timeout, or you
+  # may want to lower this if you know it shouldn't take long to start.
+  #
+  # default: 20
+  config.server_timeout = 20
+  # Failing Fast
+  # When you're running several suites it can be useful to make Teabag fail directly after any suite fails (not
+  # continuing on to the next suite), but in environments like CI this isn't as desirable. You can also configure this
+  # using the fail_fast environment variable.
+  #
+  # default: true
+  # Note: override this directive by running `rake teabag fail_fast=false`
+  config.fail_fast = true
+  # Suppressing Logs
+  # When you run Teabag from the console, it will pipe all console.log/debug/etc. calls to the console. This is useful
+  # to catch places where you've forgotten to remove console.log calls, but in verbose applications that use logging
+  # heavily this may not be desirable.
+  #
+  # default: false
+  # Note: override this directive by running `rake teabag suppress_log=true`
+  config.suppress_log = false
+  # Suites
+  # You can modify the default suite configuration or create new suites here. Suites can be entirely isolated from one
+  # another. When defining a suite you can provide a name and a block. If the name is left blank, :default is assumed.
+  # When defining suites, you can omit various directives and the defaults will be used.
+  #
+  # To run a specific suite
+  #   - in the browser: http://localhost/teabag/[suite_name]
+  #   - from the command line: rake teabag suite=[suite_name]
+  config.suite do |suite|
+    # File Matcher
+    # You can specify a file matcher for your specs, and the matching files will be automatically loaded when the suite
+    # is run. It's important that these files are serve-able from sprockets (aka the asset pipeline), otherwise you'll
+    # receive a warning about it.
+    #
+    # default: "{spec/javascripts,app/assets}/**/*_spec.{js,js.coffee,coffee}"
+    # Note: set to nil if you want to load your spec files using a manifest from within the spec helper file.
+    suite.matcher = "{spec/javascripts,app/assets}/**/*_spec.{js,js.coffee,coffee}"
+    # Spec Helper
+    # Each suite can load a different spec helper, which can in turn require additional files since this file is also
+    # served via the asset pipeline. This file is loaded before your specs are loaded -- so could potentially include
+    # all of your specs (if you set the matcher to nil).
+    #
+    # default: "spec_helper"
+    suite.helper = "spec_helper"
+    # Javascripts
+    # These are the core Teabag javascripts. Spec files should not go here -- but if you want to add additional support
+    # for jasmine matchers, switch to mocha, include expectation libraries etc., this is a good place to do that.
+    #
+    # To use mocha, you should switch this to:
+    #   "teabag-mocha"
+    #
+    # To use the coffeescript source files:
+    #   "teabag/jasmine" or "teabag/mocha"
+    #
+    # default: ["teabag-jasmine"]
+    suite.javascripts = ["teabag-jasmine"]
+    # Stylesheets
+    # If you want to change how Teabag looks, or include your own stylesheets you can do that here. The default is the
+    # stylesheet for the HTML reporter.
+    #
+    # default: ["teabag"]
+    suite.stylesheets = ["teabag"]
+  end
+  # Here's an example of creating a named suite.  Since we're actually just filtering specs to files already within the
+  # root spec/javascripts, these files will also be run in the default suite -- but can be focused into a more specific
+  # suite.
+  #
+  # To run this suite
+  #   - in the browser: http://localhost/teabag/targeted
+  #   - from the command line: rake teabag suite=targeted
+  #config.suite :targeted do |suite|
+  #  suite.matcher = "spec/javascripts/targeted/*_spec.{js,js.coffee,coffee}"
+  #end
+end if defined?(Teabag) && Teabag.respond_to?(:setup) # let Teabag be undefined outside of development/test/asset groups

data/lib/generators/teabag/install/templates/spec_helper.js ADDED

@@ -0,0 +1,31 @@
+// This is your spec helper.
+//
+// You can require other javascript files here.
+//
+// Teabag includes some useful javascripts for you, and you can include them here.
+// require jasmine-jquery
+// require sinon
+// require expect
+//
+// You're also able to include any of the files in support as well.
+// require support/your-support-file
+//
+// Deferring execution
+// This is useful if you're using CommonJS or RequireJS or some other asynchronous loading method. To defer test
+// execution until everything has been loaded asynchronously you can tell Teabag to defer, which then allows you to call
+// Teabag.execute() at a later time. Here's a simple example:
+//
+// Teabag.defer = true
+// setTimeout(function() { Teabag.execute() }, 1000)
+//
+// Spec files
+// By default Teabag will go looking for files that match the _spec.{js,js.coffee,.coffee} naming convention, so just
+// start dropping filename_spec.js files into this, or any nested path, and they'll automatically be picked up and
+// included in the default suite.  If you're interested in creating custom suites, check out the configuration in
+// config/initializers/teabag.rb
+//
+// If you'd rather just require your spec files here manually (to control order for instance) you can disable the suite
+// matcher in the configuration and then use this file as a manifest.
+//
+// For more information:
+// http://github.com/modeset/teabag

data/lib/tasks/teabag.rake ADDED

@@ -0,0 +1,5 @@
+desc "Run the javascript specs"
+task :teabag => :environment do
+  require "teabag/console"
+  fail if Teabag::Console.new(ENV["suite"]).execute
+end

data/lib/teabag.rb ADDED

@@ -0,0 +1,6 @@
+require "teabag/version"
+require "teabag/exceptions"
+require "teabag/configuration"
+require "teabag/suite"
+require "teabag/engine"

data/lib/teabag/configuration.rb ADDED

@@ -0,0 +1,68 @@
+require "singleton"
+require "teabag/formatters/progress_formatter"
+module Teabag
+  class Configuration
+    include Singleton
+    cattr_accessor :root, :mount_at, :asset_paths, :fixture_path, :formatters, :server_timeout, :fail_fast, :suppress_log, :suites
+    @@mount_at          = "/teabag"
+    @@root              = nil # will default to Rails.root if left unset
+    @@asset_paths       = ["spec/javascripts", "spec/javascripts/stylesheets"]
+    @@fixture_path      = "spec/javascripts/fixtures"
+    @@suites            = {}
+    # console runner specific
+    @@formatters        = "progress"
+    @@default_formatter = Teabag::Formatters::ProgressFormatter
+    @@server_timeout    = 20
+    @@fail_fast         = true
+    @@suppress_log      = false
+    def self.root=(path)
+      @@root = Pathname.new(path.to_s) if path.present?
+    end
+    def self.suite(name = :default, &block)
+      @@suites[name.to_s] = block
+    end
+    self.suite(:default) {}
+    class Suite
+      attr_accessor :matcher, :helper, :stylesheets, :javascripts
+      def initialize
+        @matcher     = "{spec/javascripts,app/assets}/**/*_spec.{js,js.coffee,coffee}"
+        @helper      = "spec_helper"
+        @javascripts = ["teabag-jasmine"]
+        @stylesheets = ["teabag"]
+        yield self if block_given?
+      end
+    end
+  end
+  mattr_accessor :configuration
+  @@configuration = Configuration
+  def self.setup
+    yield @@configuration
+    override_from_env
+  end
+  private
+  def self.override_from_env
+    %w(FAIL_FAST SUPPRESS_LOG).each do |directive|
+      next unless ENV[directive].present?
+      @@configuration.send("#{directive.downcase}=", ENV[directive] == "true")
+    end
+    %w(FORMATTERS).each do |directive|
+      next unless ENV[directive].present?
+      @@configuration.send("#{directive.downcase}=", ENV[directive])
+    end
+  end
+end

data/lib/teabag/console.rb ADDED

@@ -0,0 +1,57 @@
+require "teabag/server"
+require "teabag/runner"
+require "phantomjs"
+module Teabag
+  class Console
+    def initialize(suite_name = nil)
+      # force asset debugging off -- gives us nicer errors on missing files, bad coffeescript, etc
+      Rails.application.config.assets.debug = false
+      if suite_name
+        @suites = [suite_name]
+      else
+        @suites = Teabag.configuration.suites.keys
+      end
+    end
+    def execute
+      STDOUT.print "Starting server...\n"
+      start_server
+      failure_count = 0
+      @suites.each do |suite|
+        STDOUT.print "Teabag running #{suite} suite at #{url(suite)}...\n"
+        failure_count += run_specs(suite)
+      end
+      failure_count > 0
+    rescue Teabag::Failure
+      true
+    rescue Teabag::RunnerException
+      true
+    end
+    def start_server
+      @server = Teabag::Server.new
+      @server.start
+    end
+    def run_specs(suite)
+      runner = Teabag::Runner.new(suite)
+      Phantomjs.run(script, url(suite)) do |line|
+        runner.process(line)
+      end
+      runner.failure_count
+    end
+    protected
+    def script
+      File.expand_path("../phantomjs/runner.coffee", __FILE__)
+    end
+    def url(suite)
+      ["#{@server.url}#{Teabag.configuration.mount_at}", suite].join("/")
+    end
+  end
+end

data/lib/teabag/engine.rb ADDED

@@ -0,0 +1,16 @@
+module Teabag
+  class Engine < ::Rails::Engine
+    isolate_namespace Teabag
+    initializer :assets, :group => :all do |app|
+      # default the root if it's not set
+      Teabag.configuration.root ||= app.root
+      # append the asset paths from the configuration
+      Teabag.configuration.asset_paths.each do |path|
+        app.config.assets.paths << Teabag.configuration.root.join(path).to_s
+      end
+    end
+  end
+end

data/lib/teabag/exceptions.rb ADDED

@@ -0,0 +1,6 @@
+module Teabag
+  class Failure < Exception; end
+  class UnknownSuite < Exception; end
+  class RunnerException < Exception; end
+  class AssetNotServable < Exception; end
+end

data/lib/teabag/formatters/base_formatter.rb ADDED

@@ -0,0 +1,32 @@
+module Teabag
+  module Formatters
+    class BaseFormatter
+      attr_accessor :total, :passes, :pendings, :failures, :errors
+      def initialize
+        @total    = 0
+        @passes   = []
+        @pendings = []
+        @failures = []
+        @errors   = []
+      end
+      def spec(result)
+        @total += 1
+        if result.passing?
+          @passes << result
+        elsif result.pending?
+          @pendings << result
+        else
+          @failures << result
+        end
+      end
+      # Exceptions come from startup errors in the server
+      def exception(exception = {})
+        raise Teabag::RunnerException
+      end
+    end
+  end
+end

data/lib/teabag/formatters/progress_formatter.rb ADDED

@@ -0,0 +1,93 @@
+require 'teabag/formatters/base_formatter'
+module Teabag
+  module Formatters
+    class ProgressFormatter < BaseFormatter
+      RED = 31
+      GREEN = 32
+      YELLOW = 33
+      CYAN = 36
+      def spec(result)
+        super
+        if result.passing?
+          log ".", GREEN
+        elsif result.pending?
+          log "*", YELLOW
+        else
+          log "F", RED
+        end
+      end
+      # Errors are reported from the onError handler in Phantom, so they're not linked to a result
+      def error(error)
+        log "#{error["msg"]}\n", RED
+        for trace in error["trace"] || []
+          log "  # #{filename(trace["file"])}:#{trace["line"]}#{trace["function"].present? ? " -- #{trace["function"]}" : ""}\n", CYAN
+        end
+        log "\n"
+      end
+      def results(results)
+        log "\n\n"
+        pending_log if pendings.size > 0
+        failure_log if failures.size > 0
+        status(results)
+        failed_examples if failures.size > 0
+        raise Teabag::Failure if failures.size > 0 && Teabag.configuration.fail_fast
+      end
+      private
+      def log(str, color_code = nil)
+        STDOUT.print(color_code ? colorize(str, color_code) : str)
+      end
+      def colorize(str, color_code)
+        "\e[#{color_code}m#{str}\e[0m"
+      end
+      def pluralize(str, value)
+        value == 1 ? "#{value} #{str}" : "#{value} #{str}s"
+      end
+      def filename(file)
+        file.gsub(%r(^http://127.0.0.1:\d+/assets/), "").gsub(/[\?|&]?body=1/, "")
+      end
+      def failure_log
+        log "Failures:\n"
+        failures.each_with_index do |failure, index|
+          log "\n  #{index + 1}) #{failure["spec"]}\n"
+          log "     Failure/Error: #{failure["message"]}\n", RED
+        end
+        log "\n"
+      end
+      def failed_examples
+        log "\nFailed examples:\n"
+        failures.each do |failure|
+          log "\n#{Teabag.configuration.mount_at}/#{failure.teabag_suite}#{failure.link}", RED
+        end
+        log "\n\n"
+      end
+      def pending_log
+        log "Pending:"
+        pendings.each do |result|
+          log "\n  #{result.spec}\n", YELLOW
+          log "    # Not yet implemented\n", CYAN
+        end
+        log "\n"
+      end
+      def status(results)
+        log "Finished in #{results["elapsed"]} seconds\n"
+        stats = "#{pluralize("example", total)}, #{pluralize("failure", failures.size)}"
+        stats << ", #{pendings.size} pending" if pendings.size > 0
+        log "#{stats}\n", failures.size > 0 ? RED : pendings.size > 0 ? YELLOW : GREEN
+      end
+    end
+  end
+end