guard-phantomjs-jasmine 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 48928802607fd6aa08d3923da19cca1b34768ba6
+  data.tar.gz: b609c7140a2d62a0fb6bc68eb267ef27da4cd939
+SHA512:
+  metadata.gz: a42058b63d5165c35a67379985bc588b3fd3fb134ae8b4e82189524c283189d7b3f5a0a4c64e212e6617ce905284ccb6ff58aa162222256557f56b4ddd32aef9
+  data.tar.gz: 58b7c95bd227fb0f9aeb0e34bd8a93b6feb99b95dcea7b182a7f111e5c9691ca41d8943594ed21b72f82c20df9fb6455bff0bc1827dc3e7122212e1cf4765b76

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,15 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in guard-phantomjs-jasmine.gemspec
+gemspec
+
+require 'rbconfig'
+
+if RbConfig::CONFIG['target_os'] =~ /darwin/i
+  gem 'rb-fsevent'
+  gem 'growl'
+end
+if RbConfig::CONFIG['target_os'] =~ /linux/i
+  gem 'rb-inotify'
+  gem 'libnotify'
+end

data/Guardfile

@@ -0,0 +1,5 @@
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/(.*)_spec.rb})
+  watch(%r{^lib/(.*)\.rb})                              { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^spec/spec_helper.rb})                       { "spec" }
+end

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Stas Suscov
+
+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.rdoc

@@ -0,0 +1,72 @@
+= guard-phantomjs-jasmine
+
+{<img src="https://secure.travis-ci.org/stas/guard-phantomjs-jasmine.png" alt="Build Status" />}[http://travis-ci.org/stas/guard-phantomjs-jasmine]
+
+PhantomJS Jasmine Guard automatically runs Jasmine specs with PhantomJS. It executes the tests and displays the test result.
+No webserver is required!
+
+== Install
+
+Please be sure to have {Guard}[https://github.com/guard/guard] installed before continue.
+
+Add guard definition to your Guardfile by running this command:
+
+    guard init phantomjs-jasmine
+
+You will need the Jasmine html runner next. If you have it already, just update your Guardfile pointing :runner to the relevant html file.
+
+== Usage
+
+Please read {Guard usage doc}[https://github.com/guard/guard#readme]
+
+== CI usecase
+
+You can use builtin rake task if you want to run your specs with Rake
+
+Create a Rakefile with the following
+
+    require 'guard/phantomjs-jasmine/task'
+    Guard::PhantomJsJasmineTask.new
+
+if you want to customize the task, you can use options
+
+    require 'guard/phantomjs-jasmine/task'
+    Guard::PhantomJsJasmineTask.new(:ci) do |task|
+      task.options[:runner] = 'path/to/jasmine.html'
+      task.options[:runner_script] = 'path/to/runner.coffee'
+    end
+
+== Options
+
+The location of the test runner:
+
+    guard 'phantomjs-jasmine', :runner => '...' do
+      ...
+    end
+
+== AMD / Require.js support
+
+To make sure the Jasmine is initialized correctly
+before any test gets executed, we need to detect when Jasmine is loaded.
+
+Add this callback:
+
+    if ( window['beforeJasmineExecution'] ) {
+      beforeJasmineExecution();
+    }
+
+right before:
+
+    jasmineEnv.execute();
+
+== Development
+
+- Report issues, questions, feature requests on {GitHub Issues}[https://github.com/stas/guard-phantomjs-jasmine/issues]
+
+Pull requests are very welcome! Make sure your patches are well tested. Please create a topic branch for every separate change you make.
+
+== Authors
+
+{Stas Suscov}[https://github.com/stas]
+
+Thanks to {Klaus Hartl}[https://github.com/carhartl] for guard-phantomjs project.

data/Rakefile

@@ -0,0 +1,21 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec
+
+namespace(:spec) do
+  desc "Run all specs on multiple ruby versions (requires rvm)"
+  task(:portability) do
+    %w[1.8.6 1.8.7 1.9.2].each do |version|
+      system <<-BASH
+        bash -c 'source ~/.rvm/scripts/rvm;
+                 rvm #{version};
+                 echo "--------- version #{version} ----------\n";
+                 bundle install;
+                 rake spec'
+      BASH
+    end
+  end
+end

data/guard-phantomjs-jasmine.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = 'guard-phantomjs-jasmine'
+  s.version     = '0.0.1'
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Stas Suscov']
+  s.email       = ['stas@nerd.ro']
+  s.homepage    = 'http://github.com/stas/guard-phantomjs-jasmine'
+  s.summary     = 'Guard for running Jasmine specs using PhantomJS'
+  s.description = 'PhantomJS guard allows to automatically run PhantomJS (headless, WebKit-based browser) Jasmine specs.'
+
+  s.rubyforge_project = 'guard-phantomjs-jasmine'
+
+  s.add_dependency 'guard'
+
+  s.add_development_dependency 'bundler'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'guard-rspec'
+
+  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']
+end

data/lib/guard/phantomjs-jasmine.rb

@@ -0,0 +1,57 @@
+require 'guard'
+require 'guard/plugin'
+require 'guard/phantomjs-jasmine/cli'
+
+module Guard
+  class PhantomJsJasmine < Plugin
+    include PhantomJsJasmineCli
+
+    # Initialize Guard::PhantomJsJasmine
+    #
+    # @param [Hash] options the options for the Guard
+    # @option options [String] :runner_script, path to the runner script
+    # @option options [String] :runner, path to the jasmine runner
+    def initialize(options = {})
+      super
+
+      @options = options
+    end
+
+    # Gets called once when Guard starts.
+    def start
+      ::Guard::UI.info( "#{self.class} is running!" )
+    end
+
+    # Gets called when watched paths and files have changes.
+    #
+    # @param [Array<String>] paths the changed paths and files
+    def run_on_change(paths)
+      return if paths.empty?
+
+      run(@options)
+    end
+
+    private
+
+    # Wrapper against Guard::Notifier#notify
+    # @param [String] message, the text to output
+    # @param [Symbol] image, the text image
+    def notify(message, image)
+      ::Guard::Notifier.notify(
+        message, :title => 'PhantomJS Jasmine Guard', :image => image)
+    end
+
+    # Wrapper against Guard::UI#error
+    # @param [String] message, the text to output
+    def error(message)
+      ::Guard::UI.error(message)
+    end
+
+    # Wrapper against Guard::UI#info
+    # @param [String] message, the text to output
+    def info(message)
+      ::Guard::UI.info(message)
+    end
+
+  end
+end

data/lib/guard/phantomjs-jasmine/cli.rb

@@ -0,0 +1,73 @@
+require 'json'
+
+module Guard
+  # PhantomJS Jasmine command line utils
+  #
+  module PhantomJsJasmineCli
+
+    # Command line runner
+    # Separated from guard so it's possible to be used in rake tasks too
+    # @param [Hash] options, to be passed to phantomjs
+    #
+    def run(options)
+      options[:runner] ||= 'spec/runner.html'
+      options[:runner_script] ||= File.expand_path(
+        'js/jasmine_runner.coffee',
+        File.dirname(__FILE__))
+
+      cmd = "phantomjs #{options[:runner_script]} #{options[:runner]}"
+      result = IO.popen(cmd)
+
+      begin
+        parsed_result = JSON.parse(result.read, {
+          :max_nesting => false, :symbolize_names => true })
+        result.close
+      rescue Exception => exc
+        error(exc.message)
+        return
+      end
+
+      passed = parsed_result[:passed]
+      failed = parsed_result[:total] - passed
+      run_time = (parsed_result[:ended] - parsed_result[:started]).round(3)
+
+      parsed_result[:suites].each do |suite|
+        msg = "\n" + "#{suite[:desc]} #{suite[:name]}\n\t#{suite[:spec]}".lstrip
+
+        if suite[:passed]
+          info( msg )
+        else
+          error( "#{msg}\n\t\t#{suite[:trace]}" )
+        end
+      end
+
+      if failed > 0
+        notify("#{failed} Jasmine spec(s) failed.", :failed)
+        info("\n#{failed}/#{parsed_result[:total]} failed in #{run_time} ms.")
+      else
+        notify("Jasmine specs passed.", :success)
+        info("\n#{parsed_result[:total]} passed in #{run_time} ms.")
+      end
+    end
+
+    # Helper to output info messages
+    # @param [String] msg, the text to output
+    def info(msg)
+      puts msg
+    end
+
+    # Helper to output error messages, colors in red
+    # @param [String] msg, the text to output
+    def error(msg)
+      puts "\e[0;31m#{ msg }\e[0m"
+    end
+
+    # Helper to send notifications, not implemented
+    # We don't use notify in CLI sessions
+    # @param [String] msg, the text to output
+    # @param [Symbol] image, the text image
+    def notify(msg, image)
+    end
+
+  end
+end

data/lib/guard/phantomjs-jasmine/js/console_json_reporter.js

@@ -0,0 +1,74 @@
+/**
+ * Jasmine JSON Console Reporter
+ * Uses console.log to output JSONified Jasmine results
+ */
+(function(window, console) {
+  /**
+   * Console Reporter constructor
+   */
+  var ConsoleReporter = function() {};
+
+  /**
+   * Reporter prototype
+   */
+  ConsoleReporter.prototype = {
+    /**
+     * Instance storage for result details
+     */
+    results: {
+      started: (new Date()).getTime(),
+      ended: null,
+      total: 0,
+      passed: 0,
+      suites: []
+    },
+
+    /**
+     * Is called when runner is done.
+     * Outputs the stringified `results` value
+     * Ends with the exit code.
+     */
+    reportRunnerResults: function() {
+      this.results.ended = (new Date()).getTime();
+      var return_code = 0;
+
+      if ( this.results.total - this.results.passed !== 0 ) {
+        return_code = 1;
+      }
+
+      console.log( JSON.stringify(this.results) );
+      console.log('EXIT ' + return_code);
+    },
+
+    /**
+     * Is called when a spec is processed
+     * Stores all the details in `results` attribute
+     */
+    reportSpecResults: function( spec ) {
+      var spec_result, items;
+
+      this.results.total++;
+
+      if (spec.results().passed()) {
+        this.results.passed++;
+      }
+
+      spec_result = {
+        desc: spec.suite.parentSuite ? spec.suite.parentSuite.description : '',
+        name: spec.suite.description,
+        spec: spec.description,
+        passed: spec.results().passed(),
+        trace: null
+      };
+
+      items = spec.results().getItems()
+      spec_result.trace = items[0].trace.message || items[0].trace;
+
+      this.results.suites.push( spec_result );
+    }
+
+  };
+
+  // Exposes Console Reporter class
+  window.ConsoleReporter = ConsoleReporter;
+})(window, console);

data/lib/guard/phantomjs-jasmine/js/jasmine_runner.coffee

@@ -0,0 +1,28 @@
+if phantom.args.length == 0
+  console.log 'Missing mandatory parameter.'
+  phantom.exit 1
+
+runner = phantom.args[0]
+page = new WebPage()
+
+page.onInitialized = ->
+  page.injectJs 'console_json_reporter.js'
+  page.evaluate ->
+    window.onload = ->
+      # If this is an AMD environment, add console reporter using a callback
+      if ( window['define'] )
+        window.beforeJasmineExecution = ->
+          jasmine.getEnv().addReporter( new ConsoleReporter )
+      else
+        jasmine.getEnv().addReporter( new ConsoleReporter )
+
+page.onConsoleMessage = (msg) ->
+  if return_code = msg.match /EXIT (\d)/
+    phantom.exit(return_code[1])
+  else
+    console.log msg
+
+page.open runner, (status) ->
+  if status != 'success'
+    console.log 'File/URL can not be loaded.'
+    phantom.exit 1

data/lib/guard/phantomjs-jasmine/task.rb

@@ -0,0 +1,49 @@
+require 'rake/tasklib'
+require 'guard/phantomjs-jasmine/cli'
+
+module Guard
+
+  # Provides a method to define a Rake task that
+  # runs the PhatomJS Jasmine specs.
+  #
+  class PhantomJsJasmineTask < ::Rake::TaskLib
+    include ::Guard::PhantomJsJasmineCli
+
+    # Name of the main, top level task
+    attr_accessor :name
+
+    # CLI options
+    attr_accessor :options
+
+    # Initialize the Rake task
+    #
+    # @param [Symbol] name the name of the Rake task
+    # @param [Hash] options the CLI options
+    # @yield [PhantomJsJasmineTask] the task
+    #
+    def initialize(name = 'jasmine:ci', options = {})
+      @name = name
+      @options = options
+
+      yield self if block_given?
+
+      namespace :phantomjs do
+        desc 'Run all PhantomJS Jasmine specs'
+        task(name) do
+          begin
+            run(self.options)
+
+          rescue SystemExit => e
+            case e.status
+            when 1
+              fail 'Some specs have failed'
+            when 2
+              fail "The spec couldn't be run: #{ e.message }'"
+            end
+          end
+        end
+      end
+    end
+
+  end
+end

data/lib/guard/phantomjs-jasmine/templates/Guardfile

@@ -0,0 +1,4 @@
+guard 'phantomjs-jasmine', :runner => 'spec/runner.html' do
+  watch(%r{src/.+\.js})
+  watch(%r{^spec/.+_spec\.js})
+end

data/spec/guard/phantomjs-jasmine_spec.rb

@@ -0,0 +1,95 @@
+require 'spec_helper'
+
+module Guard
+  describe PhantomJsJasmine do
+
+    describe "#run_on_change" do
+
+      context "with modifications" do
+        let(:mock_results) {
+          {
+            :passed => 1,
+            :total => 1,
+            :started => Time.now.to_f,
+            :ended => Time.now.to_f,
+            :suites => [{
+              :name => 'Suite',
+              :spec => 'Spec',
+              :passed => false,
+              :trace => { :message => 'Error Message' }
+            }]
+          }
+        }
+
+        it "executes phantomjs" do
+          Notifier.stub(:notify)
+          guard = PhantomJsJasmine.new({
+            :runner => 'spec/run.html',
+            :runner_script => 'run.coffee'
+          })
+
+          io_mock = double('IO Connection').as_null_object
+          IO.should_receive(:popen).with(
+            'phantomjs run.coffee spec/run.html'
+          ).and_return(io_mock)
+
+          JSON.should_receive(:parse).and_return(mock_results)
+
+          guard.should_receive(:error)
+
+          guard.run_on_change(['foo'])
+        end
+
+        it "notifies on success" do
+          io_mock = double('IO Connection').as_null_object
+          io_mock.should_receive(:read).and_return(mock_results.to_json)
+          IO.should_receive(:popen).and_return(io_mock)
+
+          Notifier.should_receive(:notify).with('Jasmine specs passed.',
+            :title => 'PhantomJS Jasmine Guard', :image => :success)
+
+          subject.should_receive(:info)
+          subject.should_receive(:error)
+
+          subject.run_on_change(['foo'])
+        end
+
+        it "notifies on failures" do
+          failed_mock_results = mock_results
+          failed_mock_results[:passed] = 0
+
+          io_mock = double('IO Connection').as_null_object
+          io_mock.should_receive(:read).and_return(mock_results.to_json)
+          IO.should_receive(:popen).and_return(io_mock)
+
+          subject.should_receive(:error)
+          subject.should_receive(:info)
+
+          Notifier.should_receive(:notify).with('1 Jasmine spec(s) failed.',
+            :title => 'PhantomJS Jasmine Guard', :image => :failed)
+
+          subject.run_on_change(['foo'])
+        end
+
+        it "handles invalid phantomjs return data" do
+          io_mock = double('IO Connection').as_null_object
+          io_mock.should_receive(:read).and_return('THIS IS WRONG!')
+          IO.should_receive(:popen).and_return(io_mock)
+
+          subject.should_receive(:error)
+
+          subject.run_on_change(['foo'])
+        end
+      end
+
+      context "without modifications" do
+        it "skips executing phantomjs" do
+          IO.should_not_receive(:popen)
+          subject.run_on_change([])
+        end
+      end
+
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'guard/phantomjs-jasmine'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: guard-phantomjs-jasmine
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Stas Suscov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: PhantomJS guard allows to automatically run PhantomJS (headless, WebKit-based
+  browser) Jasmine specs.
+email:
+- stas@nerd.ro
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Guardfile
+- LICENSE
+- README.rdoc
+- Rakefile
+- guard-phantomjs-jasmine.gemspec
+- lib/guard/phantomjs-jasmine.rb
+- lib/guard/phantomjs-jasmine/cli.rb
+- lib/guard/phantomjs-jasmine/js/console_json_reporter.js
+- lib/guard/phantomjs-jasmine/js/jasmine_runner.coffee
+- lib/guard/phantomjs-jasmine/task.rb
+- lib/guard/phantomjs-jasmine/templates/Guardfile
+- spec/guard/phantomjs-jasmine_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/stas/guard-phantomjs-jasmine
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: guard-phantomjs-jasmine
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Guard for running Jasmine specs using PhantomJS
+test_files: []