guard-konacha 0.3.1 → 1.0.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YTQ3Njc0ZWMxYmZjYzM1N2RlMjgzNzc4M2ZmYzUyZGQ5NmQ3NTkzZg==
+  data.tar.gz: !binary |-
+    ZjZjNmI1ZDMzMWIzZDZhNzY1ZjNiYmM2M2JiZjliZWM5NTRmZmExMg==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    MmJmM2FlNTA1MTY1YzM2NDkxYzc2MWIzZjZmMWJmZDMwYTU5NWI1MGU2OGNj
+    Y2E1OWIxMWY3NTk0NzFlM2IzOTA1ZTk1MmVlMmE4NTRmYjZkYmZhZmEyYTEw
+    YzY2NDRlMWQ4YjkxYmYwNWY2NTJmMjcyZDU3NzQwZGJlOThmYWY=
+  data.tar.gz: !binary |-
+    MzJjMjFjMjk2YWQ2ZmY5MjA4MWFkMmUzNzk1N2FjYjZlY2ViZmJjMmFlNDMy
+    OWVhZDA5Zjc1Mzc0YjMyYjVjZjZjYzg2MDc2NzU1MDM1MzE1Zjc2MGFiYzI1
+    OTc3NzNhNGI5Mzc3ZmNiMmUyNDkzNWY4ZDI1OTljOGVmOGM1OTg=

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010 Alex Gibbons
+Copyright (c) 2013 Alex Gibbons
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Readme.md

@@ -1,55 +1,35 @@
-# Guard::Konacha [![Build Status](https://travis-ci.org/alexgb/guard-konacha.png)](https://travis-ci.org/alexgb/guard-konacha)
+# Guard::Konacha [![Build Status](https://travis-ci.org/alexgb/guard-konacha.png?branch=master)](https://travis-ci.org/alexgb/guard-konacha)
 
 Automatically run your [Konacha](https://github.com/jfirebaugh/konacha) tests through [Guard](https://github.com/guard/guard/).
 
 ## Install
 
-Install the gem:
-
-    $ gem install guard-konacha
-
-Or add to your Gemfile:
+If you haven't already, start by installing and configuring [Konacha](https://github.com/jfirebaugh/konacha). Then add the `guard-konacha` gem to your Gemfile:
 
+    # Gemfile
     gem 'guard-konacha'
 
-## Usage
-
-Add guard definitions to your `Guardfile`
-
-    guard :konacha do
-      watch(%r{^app/assets/javascripts/(.*)\.js(\.coffee)?$}) { |m| "#{m[1]}_spec.js" }
-      watch(%r{^spec/javascripts/.+_spec(\.js|\.js\.coffee)$})
-    end
+And install
 
-## Configuration
+    $ bundle install
 
-If your specs live outside of `spec/javascripts` then tell Konacha where to find them.
+## Setup
 
-    guard :konacha, :spec_dir => 'spec/front-end' do
-      # ...
-    end
+Add the default configurations to your Guardfile.
 
-If you want to use [capybara-webkit](https://github.com/thoughtbot/capybara-webkit) instead of the default selenium
-driver:
+    $ bundle exec guard init konacha
 
-    require 'capybara-webkit'
-    guard :konacha, :driver => :webkit do
-      # ...
-    end
+## Run
 
-Or use [Poltergeist](https://github.com/jonleighton/poltergeist):
+And that's it. Your Konacha powered JavaScript tests will now run whenever your JavaScript assets or spec files change.
 
-    require 'capybara/poltergeist'
-    guard :konacha, :driver => :poltergeist do
-      # ...
-    end
+    $ bundle exec guard
 
-If you are running konacha:serve on a different host or port than the
-default `localhost` and `3500`, the configuration settings `:host` and `:port` will help you there.
+## Additionally
 
-## Development
+I recommend using the [capybara-webkit](https://github.com/thoughtbot/capybara-webkit) or [poltergeist](https://github.com/jonleighton/poltergeist) drivers rather than the default selenium based driver. See [Konacha instructions](https://github.com/jfirebaugh/konacha#configuration). 
 
-This is a work in progress and could use some help.
+To get system notifications see [Guard instructions](https://github.com/guard/guard/wiki/System-notifications).
 
 ## Contributors
 

data/lib/guard/konacha.rb

@@ -1,10 +1,15 @@
 require 'guard'
 require 'guard/guard'
+require 'rails'
+require 'konacha'
 
 module Guard
   class Konacha < Guard
 
     autoload :Runner, 'guard/konacha/runner'
+    autoload :Formatter, 'guard/konacha/formatter'
+    autoload :Server, 'guard/konacha/server'
+
     attr_accessor :runner
 
     def initialize(watchers=[], options={})
@@ -13,18 +18,11 @@ module Guard
     end
 
     def start
-      runner.kill_konacha
-      runner.launch_konacha("Start")
-      runner.run_all_on_start
-    end
-
-    def reload
-      runner.kill_konacha
-      runner.launch_konacha("Reload")
+      runner.start
     end
 
     def run_all
-      runner.run_all
+      runner.run
     end
 
     def run_on_changes(paths)
@@ -33,9 +31,5 @@ module Guard
     # for guard 1.0.x and earlier
     alias :run_on_change :run_on_changes
 
-    def stop
-      runner.kill_konacha
-    end
-
   end
 end

data/lib/guard/konacha/formatter.rb

@@ -0,0 +1,66 @@
+module Guard
+  class Konacha
+    class Formatter < ::Konacha::Formatter
+
+      def initialize
+        super($stdout)
+      end
+
+      def reset
+        io.puts ""
+        @examples = []
+      end
+
+      def dump_summary(duration, example_count, failure_count, pending_count); end
+      def dump_failures; end
+      def dump_pending; end
+
+      def success?
+        failed_examples.empty?
+      end
+
+      def write_summary
+        io.puts ""
+        io.puts [
+          failed_examples_message,
+          pending_examples_message
+        ].reject(&:empty?).join("\n\n")
+        io.puts ""
+        io.puts summary_line
+      end
+
+      def summary_line
+        "#{examples.size} examples, #{failed_examples.size} failed, #{pending_examples.size} pending"
+      end
+
+
+      private
+
+
+      def failed_examples
+        @examples.select(&:failed?).select(&:exception)
+      end
+
+      def pending_examples
+        @examples.select(&:pending?)
+      end
+
+      def failed_examples_message
+        failed_examples.map { |e| failure_message(e) }.join("\n\n")
+      end
+
+      def failure_message(example)
+        "  \xE2\x9C\x96 ".red + "#{example.metadata['path']}\n" + super
+      end
+
+      def pending_examples_message
+        pending_examples.map { |e| pending_message(e) }.join("\n\n")
+      end
+
+      def pending_message(example)
+        "  \xE2\x97\x8B ".yellow + "#{example.metadata['path']}\n" + super
+      end
+
+    end
+  end
+end

data/lib/guard/konacha/runner.rb

@@ -1,182 +1,89 @@
-require 'net/http'
-require 'childprocess'
-require 'capybara'
-require 'active_support/core_ext/module/delegation'
-require 'active_support/core_ext/object/blank'
-require 'konacha/reporter'
-require 'konacha/formatter'
-require 'konacha/runner'
-
 module Guard
   class Konacha
     class Runner
 
       DEFAULT_OPTIONS = {
-        :bundler  => true,
-        :spec_dir => 'spec/javascripts',
-        :run_all  => true,
-        :all_on_start => true,
-        :driver   => :selenium,
-        :host     => 'localhost',
-        :port     => 3500,
+        :run_all_on_start => :true,
         :notification => true,
-        :spawn_wait => 20
+        :rails_environment_file => './config/environment'
       }
 
-      attr_reader :options
+      attr_reader :options, :formatter
 
       def initialize(options={})
         @options = DEFAULT_OPTIONS.merge(options)
-        UI.info "Guard::Konacha Initialized"
-      end
-
-      def launch_konacha(action)
-        UI.info "#{action}ing Konacha", :reset => true
-        spawn_konacha
-      end
-
-      def kill_konacha
-        clear_session!
-        if @process
-          @process.stop(5)
-          UI.info "Konacha Stopped", :reset => true
-        end
-      end
-
-      def run(paths=[])
-        return UI.info("Konacha server not running") unless konacha_running?
 
-        UI.info "Konacha Running: #{paths.empty? ? 'All tests' : paths.join(' ')}"
+        # Require project's rails environment file to load Konacha 
+        # configuration
+        require_rails_environment
+        raise "Konacha not loaded" unless defined? ::Konacha
 
-        urls = paths.map { |p| konacha_url(p) }
-        urls = [konacha_url] if paths.empty?
+        # Custom formatter to handle multiple runs
+        @formatter = Formatter.new
+        ::Konacha.config.formatters = [@formatter]
 
-        test_results = {
-          :examples => 0,
-          :failures => 0,
-          :pending  => 0,
-          :duration => 0
-        }
+        # Reusable session to increase performance
+        @session = Capybara::Session.new(::Konacha.driver, Server.new)
 
-        urls.each_with_index do |url, index|
-          individual_result = run_tests(url, paths[index])
+        ::Konacha.mode = :runner
 
-          test_results[:examples] += individual_result[:examples]
-          test_results[:failures] += individual_result[:failures]
-          test_results[:pending]  += individual_result[:pending]
-          test_results[:duration] += individual_result[:duration]
-        end
-
-        result_line = "#{test_results[:examples]} examples, #{test_results[:failures]} failures"
-        result_line << ", #{test_results[:pending]} pending" if test_results[:pending] > 0
-        text = [
-          result_line,
-          "in #{"%.2f" % test_results[:duration]} seconds"
-        ].join "\n"
-
-        UI.info text if urls.length > 1
+        UI.info "Guard::Konacha Initialized"
+      end
 
-        if @options[:notification]
-          image = test_results[:failures] > 0 ? :failed : :success
-          ::Guard::Notifier.notify(text, :title => 'Konacha Specs', :image => image )
-        end
+      def start
+        run if options[:run_all_on_start]
       end
 
-      EMPTY_RESULT = {
-        :examples => 0,
-        :failures => 0,
-        :pending  => 0,
-        :duration => 0,
-      }
+      def run(paths = [''])
+        formatter.reset
 
-      def run_tests(url, path)
-        session.reset!
-        unless valid_spec? url
-          UI.warning "No spec found for: #{path}"
-          return EMPTY_RESULT
+        paths.each do |path|
+          runner.run konacha_path(path)
         end
 
-        runner = ::Konacha::Runner.new session
-        runner.run url
-        return {
-          :examples => runner.reporter.example_count,
-          :failures => runner.reporter.failure_count,
-          :pending  => runner.reporter.pending_count,
-          :duration => runner.reporter.duration
-        }
+        formatter.write_summary
+        notify
       rescue => e
-        UI.error e.inspect
-        @session = nil
-      end
-
-      def run_all
-        run if @options[:run_all]
+        UI.error(e)
       end
 
-      def run_all_on_start
-         run_all if @options[:all_on_start]
-      end
 
       private
 
-      def konacha_url(path = nil)
-        url_path = path.gsub(/^#{@options[:spec_dir]}\/?/, '').gsub(/\.coffee$/, '').gsub(/\.js$/, '') unless path.nil?
-        "#{konacha_base_url}/#{url_path}?mode=runner&unique=#{unique_id}"
-      end
-
-      def unique_id
-        "#{Time.now.to_i}#{rand(100)}"
-      end
-
-      def session
-        UI.info "Starting Konacha-Capybara session using #{@options[:driver]} driver, this can take a few seconds..." if @session.nil?
-        @session ||= Capybara::Session.new @options[:driver]
-      end
 
-      def clear_session!
-        return unless @session
-        @session.reset!
-        @session = nil
-      end
-
-      def spawn_konacha_command
-        cmd_parts = ''
-        cmd_parts << "bundle exec " if bundler?
-        cmd_parts << "rake konacha:serve"
-        cmd_parts.split
-      end
-
-      def spawn_konacha
-        unless @process
-          @process = ChildProcess.build(*spawn_konacha_command)
-          @process.io.inherit! if ::Guard.respond_to?(:options) && ::Guard.options && ::Guard.options[:verbose]
-          @process.start
-
-           Timeout::timeout(@options[:spawn_wait]) do
-            until konacha_running?
-              sleep(0.2)
+      def require_rails_environment
+        if @options[:rails_environment_file]
+          require @options[:rails_environment_file]
+        else
+          dir = '.'
+          while File.expand_path(dir) != '/' do
+            env_file = File.join(dir, 'config/environment.rb')
+            if File.exist?(env_file)
+              require File.expand_path(env_file)
+              break
             end
+            dir = File.join(dir, '..')
           end
         end
       end
 
-      def konacha_base_url
-        "http://#{@options[:host]}:#{@options[:port]}"
+      def runner
+        ::Konacha::Runner.new(@session)
       end
 
-      def konacha_running?
-        Net::HTTP.get_response(URI.parse(konacha_base_url))
-      rescue Errno::ECONNREFUSED
+      def konacha_path(path)
+        '/' + path.gsub(/^#{::Konacha.config[:spec_dir]}\/?/, '').gsub(/\.coffee$/, '').gsub(/\.js$/, '')
       end
 
-      def bundler?
-        @bundler ||= options[:bundler] != false && File.exist?("#{Dir.pwd}/Gemfile")
+      def unique_id
+        "#{Time.now.to_i}#{rand(100)}"
       end
 
-      def valid_spec? url
-        session.visit url
-        konacha_spec = session.evaluate_script('typeof window.top.Konacha')
-        konacha_spec == 'object'
+      def notify
+        if options[:notification]
+          image = @formatter.success? ? :success : :failed
+          ::Guard::Notifier.notify(@formatter.summary_line, :title => "Konacha Specs", :image => image)
+        end
       end
 
     end

data/lib/guard/konacha/server.rb

@@ -0,0 +1,32 @@
+module Guard
+  class Konacha
+    class Server < Rack::Builder
+
+      def self.new
+        super do
+          use CacheBuster
+          run ::Konacha.application
+        end
+      end
+
+      class CacheBuster
+
+        def initialize(app)
+          @app = app
+        end
+
+        def call(env)
+          status, headers, body = @app.call(env)
+
+          headers.delete('Last-Modified')
+          headers.delete('ETag')
+          headers.delete('Cache-Control')
+
+          [status, headers, body]
+        end
+
+      end
+
+    end
+  end
+end

data/lib/guard/konacha/templates/Guardfile

@@ -1,7 +1,9 @@
 ### Guard::Konacha
 #  available options:
-#  - :spec_dir, defaults to 'spec/javascripts'
-#  - :driver, defaults to :selenium
+#  - :run_all_on_start, defaults to :true
+#  - :notification, defaults to :true
+#  - :rails_environment_file, location of rails environment file,
+#    should be able to find it automatically
 guard :konacha do
   watch(%r{^app/assets/javascripts/(.*)\.js(\.coffee)?$}) { |m| "#{m[1]}_spec.js" }
   watch(%r{^spec/javascripts/.+_spec(\.js|\.js\.coffee)$})

data/lib/guard/konacha/version.rb

@@ -1,5 +1,5 @@
 module Guard
   module KonachaVersion
-    VERSION = "0.3.1"
+    VERSION = "1.0.0"
   end
 end

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: guard-konacha
 version: !ruby/object:Gem::Version
-  version: 0.3.1
-  prerelease: 
+  version: 1.0.0
 platform: ruby
 authors:
 - Alex Gibbons
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-12 00:00:00.000000000 Z
+date: 2013-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -30,55 +27,34 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: konacha
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '2.2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '2.2'
-- !ruby/object:Gem::Dependency
-  name: childprocess
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.2.5
-  type: :runtime
+        version: '2.13'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.2.5
+        version: '2.13'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: timecop
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -86,15 +62,13 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: timecop
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -102,15 +76,13 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: poltergeist
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -118,7 +90,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -130,14 +101,18 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/guard/konacha/formatter.rb
 - lib/guard/konacha/runner.rb
+- lib/guard/konacha/server.rb
 - lib/guard/konacha/templates/Guardfile
 - lib/guard/konacha/version.rb
 - lib/guard/konacha.rb
 - LICENSE
 - Readme.md
 homepage: https://github.com/alexgb/guard-konacha
-licenses: []
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options:
 - --charset=UTF-8
@@ -146,27 +121,19 @@ rdoc_options:
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -145410006532593905
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -145410006532593905
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
-summary: Guard gem for Konacha
+specification_version: 4
+summary: Guard plugin for Konacha
 test_files: []