guard-jstd 0.0.1 → 0.1.0

data/.gitignore

@@ -2,3 +2,4 @@ pkg/*
 *.gem
 .bundle
 Gemfile.lock
+notes.txt

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 aRailsDemo.com
+
+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.md

@@ -2,7 +2,7 @@
 
 Guard::Jstd provides autotest functionality for your test driven JavaScript development with JsTestDriver. This gem was inspired by the [jstdutil gem](http://cjohansen.no/en/javascript/jstdutil_a_ruby_wrapper_over_jstestdriver) and modeled after the [Guard::RSpec gem.](https://github.com/guard/guard-rspec)
 
-## Installing the gem:
+## Installing the gem
 
 From the command line:
 
@@ -24,6 +24,32 @@ See the [Guard](http://github.com/guard/guard) gem README for more information a
 
 If you want to use CoffeeScript in your development, add the [guard-coffeescript gem.](https://github.com/guard/guard-coffeescript)
 
+## Configuration
+
+You can specify some configuration options by passing a block to Jstd.configure. This must appear after the 'guard "jstd"' definition in your Guardfile. An example configuration is given below.
+
+    guard "jstd" do
+      # mappings here
+    end
+
+    Jstd.configure do |c|
+      c.java_path = "~/my/path/JsTestDriver-1.3.2.jar"
+      c.browser_paths = "\`which open\`"
+      c.jstd_config_path = 'someJsTestDriver.conf'
+      c.start_server = false
+      c.capture_browser = false    # false is the default
+    end
+
+## Defaults
+
+If you have a "$JSTESTDRIVER_HOME" environment variable set on your system, Jstd will automatically look for your JsTestDriver .jar file there. Otherwise, you have to configure the path with "c.java_path".
+
+On start up, Jstd will attempt to start the JsTestDriver server. You can prevent this with "c.start_server = false". The server_port is determined from your JsTestDriver configuration file. If this file does not exist, then the default port is 4224. If you really want Jstd to start the server in a specified port, then you can do that with "c.server_port = 1234".
+
+If you set "c.capture_browser = true", then Jstd will attempt to capture the browser(s) defined in "c.browser_path" when the server is started. Otherwise, you have to manually capture browsers after the server starts.
+
+The default JsTestDriver configuration file name is 'jsTestDriver.conf'. If you are using something else, then use "c.jstd_config_path".
+
 ## JsTestDriver
 
-Currently, Guard::Jstd requires that you define an environment variable, $JSTESTDRIVER_HOME, to specify where JsTestDriver .jar file is located at on your system. More information about setting up JsTestDriver on your system can be [found here.](http://www.arailsdemo.com/posts/46) or on the JsTestDriver [homepage.](http://code.google.com/p/js-test-driver/)
+Information about setting up JsTestDriver on your system can be [found here](http://www.arailsdemo.com/posts/46) or on the JsTestDriver [homepage.](http://code.google.com/p/js-test-driver/)

data/lib/guard/jstd/configuration.rb

@@ -0,0 +1,71 @@
+module Guard
+  class Jstd
+    module Configuration
+      class << self
+        METHODS = [:java_path, :browser_paths, :server_port,
+                    :jstd_config_path, :start_server, :capture_browser]
+
+        METHODS.each do |method|
+          attr_writer method
+        end
+
+        def reset!
+          METHODS.each { |method| instance_variable_set("@#{method.to_s}", nil) }
+          @jar_home = nil
+        end
+
+        def java_path
+          @java_path ||= jar_path
+        end
+
+        def browser_paths
+          @browser_paths ||= "\`which open\`"
+        end
+
+       def jstd_config_path
+          @jstd_config_path ||= 'jsTestDriver.conf'
+        end
+
+        def server_port
+          @server_port ||= default_server_port
+        end
+
+        def start_server
+          @start_server == nil ? true : @start_server
+        end
+
+        def capture_browser
+          @capture_browser == nil ? false : @capture_browser
+        end
+
+        def default_server_port
+          begin
+            conf = File.read(jstd_config_path)
+            conf.scan(/server:.*:(\d+)$/).to_s
+          rescue
+            '4224'
+          end
+        end
+
+        def jar_path
+          path = File.join(jar_home, 'jstest*.jar')
+          files = Dir.glob(File.expand_path(path), File::FNM_CASEFOLD)
+          if files.empty?
+            alert = "\e[31mGuard::Jstd could not find your JsTestDriver.jar file. "
+            alert << "Please specify it in the configuration.\e[0m"
+            UI.info(alert, :reset => true)
+            exit
+          else
+            files.first
+          end
+        end
+
+        def jar_home
+          return @jar_home if @jar_home
+          echo = `echo $JSTESTDRIVER_HOME`
+          @jar_home = echo == "" ? '~/bin' : echo.gsub!("\n", "")
+        end
+      end
+    end
+  end
+end

data/lib/guard/jstd/runner.rb

@@ -1,16 +1,38 @@
+require 'Forwardable'
+
 module Guard
   class Jstd
     module Runner
       class << self
-        def java_command
-          "java -jar $JSTESTDRIVER_HOME/JsTestDriver-1.3.2.jar --tests"
+        extend Forwardable
+
+        [:java_path, :browser_paths, :server_port,
+        :jstd_config_path].each do |config|
+          def_delegator Configuration, config, config
         end
 
         def run(tests="all")
           UI.info("Running #{tests}")
-          results = `#{java_command} #{tests}`
+          results = `#{java_command} --tests #{tests}`
           Formatter.notify(results)
         end
+
+        def start_server
+          if Configuration.start_server
+            browser_opt = Configuration.capture_browser ?
+                          " --browser #{browser_paths}" : ""
+            pid = fork {
+              trap('QUIT', 'IGNORE')
+              `#{java_command} --port #{server_port}#{browser_opt}`
+            }
+            Process.detach(pid)
+            UI.info "JsTestDriver server started on port #{server_port}"
+          end
+        end
+
+        def java_command
+          "java -jar #{java_path} --config #{jstd_config_path}"
+        end
       end
     end
   end

data/lib/guard/jstd/templates/Guardfile

@@ -2,3 +2,9 @@ guard "jstd" do
   watch(%r{^javascripts/.+_test\.js})
   watch(%r{^javascripts/src/(.+)\.js}) { |m| "javascripts/test/#{m[1]}_test.js"}
 end
+
+# See the README for configuration options.
+Jstd.configure do |c|
+  c.browser_paths = "\`which open\`"
+  c.capture_browser = true
+end

data/lib/guard/jstd/version.rb

@@ -1,5 +1,5 @@
 module Guard
   module JstdVersion
-    VERSION = "0.0.1"
+    VERSION = "0.1.0"
   end
 end

data/lib/guard/jstd.rb

@@ -6,9 +6,11 @@ module Guard
     autoload :Runner, 'guard/jstd/runner'
     autoload :CaseFinder, 'guard/jstd/case_finder'
     autoload :Formatter, 'guard/jstd/formatter'
+    autoload :Configuration, 'guard/jstd/configuration'
 
     def start
       UI.info "Guard::Jstd is running."
+      Runner.start_server
     end
 
     def run_all
@@ -19,5 +21,9 @@ module Guard
       cases = CaseFinder.find(paths)
       Runner.run(cases)
     end
+
+    def self.configure
+      yield Configuration
+    end
   end
 end

data/spec/guard/jstd/configuration_spec.rb

@@ -0,0 +1,118 @@
+require "spec_helper"
+
+describe Guard::Jstd::Configuration do
+  let(:_module) { Guard::Jstd::Configuration }
+
+  after do
+    subject.reset!
+  end
+
+  describe ".jar_home" do
+    it "uses $JSTESTDRIVER_HOME when present" do
+      dir = "path\n"
+      subject.should_receive("`").with(
+        "echo $JSTESTDRIVER_HOME"
+      ).and_return(dir)
+      subject.jar_home.should == "path"
+    end
+
+    it "uses the default when $JSTESTDRIVER_HOME isn't present" do
+      subject.should_receive("`").with(
+        "echo $JSTESTDRIVER_HOME"
+      ).and_return("")
+      subject.jar_home.should == '~/bin'
+    end
+  end
+
+  describe ".jar_path" do
+    before { subject.stub(:jar_home).and_return("/path") }
+
+    it "finds the .jar file in the jar_home" do
+      Dir.should_receive(:glob).with("/path/jstest*.jar", File::FNM_CASEFOLD) { ["file.jar"] }
+      subject.jar_path.should == "file.jar"
+    end
+
+    it "exits if the .jar file isn't found" do
+      Dir.should_receive(:glob).with("/path/jstest*.jar", File::FNM_CASEFOLD) { [] }
+      Guard::UI.should_receive(:info)
+      expect { subject.jar_path }.to raise_error
+    end
+  end
+
+  describe ".default_server_port" do
+    def conf
+      <<-FILE
+server: http://0.0.0.0:2345
+
+load:
+  - javascripts/lib/*.js
+  - javascripts/src/*.js
+  - javascripts/test/*.js
+      FILE
+    end
+
+    before do
+      subject.stub(:jstd_config_path) { 'foo' }
+    end
+
+    it "gets the default from the JsTestDriver configuration file" do
+      File.should_receive(:read).with("foo") { conf }
+      subject.default_server_port.should == "2345"
+    end
+
+    it "returns 4224 if there is no configuration file" do
+      subject.default_server_port.should == "4224"
+    end
+  end
+
+  describe ".reset!" do
+    it "sets the java_path to the default" do
+      subject.stub(:jar_path) { "home" }
+
+      subject.java_path = 'foo/bar.jar'
+      subject.java_path.should == 'foo/bar.jar'
+      subject.reset!
+
+      subject.java_path.should == 'home'
+    end
+
+    it "sets the browser_paths to the default" do
+      subject.browser_paths = 'path'
+      subject.browser_paths.should == 'path'
+      subject.reset!
+
+      subject.browser_paths.should == "\`which open\`"
+    end
+
+    it "sets the server_port to the default" do
+      subject.stub(:default_server_port) { 123 }
+      subject.reset!
+
+      subject.server_port.should == 123
+    end
+
+    it "sets the jstd_config_path to the default" do
+      subject.jstd_config_path = 'hi'
+      subject.jstd_config_path.should == 'hi'
+      subject.reset!
+
+      subject.jstd_config_path.should == 'jsTestDriver.conf'
+    end
+
+    it "sets the start_server option to true" do
+      subject.start_server = false
+      subject.start_server.should == false
+      subject.reset!
+
+      subject.start_server.should == true
+    end
+
+    it "sets the capture_browser option to false" do
+      subject.capture_browser = true
+      subject.capture_browser.should == true
+      subject.reset!
+
+      subject.capture_browser.should == false
+    end
+  end
+end

data/spec/guard/jstd/formatter_spec.rb

@@ -85,7 +85,7 @@ describe Guard::Jstd::Formatter do
       subject.notify(failed)
     end
 
-    it "call #display" do
+    it "call #to_terminal" do
       @formatter.should_receive(:to_terminal)
       subject.notify(failed)
     end

data/spec/guard/jstd/runner_spec.rb

@@ -1,6 +1,8 @@
 require "spec_helper"
 
 describe Guard::Jstd::Runner do
+  let(:config) { Guard::Jstd::Configuration }
+
   describe ".run" do
     let(:test) { "HelloTest" }
 
@@ -10,21 +12,33 @@ describe Guard::Jstd::Runner do
       subject.run
     end
 
-    context "--JsTestDriver command--" do
-      let(:java_command) { Guard::Jstd::Runner::java_command }
+    it ".java_command uses Configuration java_path and jstd_config_path" do
+      Guard::Jstd::Formatter.stub(:notify)
+      config.java_path = 'foo'
+      config.jstd_config_path = 'bar'
+      subject.should_receive(:"`").with(
+        "java -jar foo --config bar --tests all"
+      )
+      subject.run
+      Guard::Jstd::Configuration.reset!
+    end
 
-      before { Guard::Jstd::Formatter.stub(:notify) }
+    context "--JsTestDriver command--" do
+      before do
+        subject.stub(:java_command) { 'hooha' }
+        Guard::Jstd::Formatter.stub(:notify)
+      end
 
       it "can run all tests" do
         subject.should_receive(:"`").with(
-          "#{java_command} all"
+          "hooha --tests all"
         )
         subject.run
       end
 
       it "can run a single TestCase" do
         subject.should_receive(:"`").with(
-          "#{java_command} #{test}"
+          "hooha --tests #{test}"
         )
         subject.run(test)
       end
@@ -39,4 +53,66 @@ describe Guard::Jstd::Runner do
       subject.run(test)
     end
   end
+
+  describe ".start_server" do
+    context "--given some configuration--" do
+      before do
+        config.java_path = 'java'
+        config.browser_paths = 'browsers'
+        config.server_port = 1234
+      end
+
+      after { config.reset! }
+
+      it "does not start the server if configuration is false" do
+        config.start_server = false
+        subject.should_not_receive(:fork)
+        subject.start_server
+      end
+
+      it "detaches a forked process" do
+        subject.stub(:fork) { 1 }
+        Process.should_receive(:detach).with(1)
+        subject.start_server
+      end
+
+      it "sends a message to UI" do
+        subject.stub(:fork)
+        Process.stub(:detach)
+        Guard::UI.should_receive(:info).with(
+          "JsTestDriver server started on port 1234"
+        )
+        subject.start_server
+      end
+
+      context "--in the forked process--" do
+        before do
+          subject.stub(:java_command) { 'hooha' }
+          Process.stub(:detach)
+        end
+
+        it "starts the JsTestDriver server" do
+          subject.should_receive("`").with('hooha --port 1234') { 'hooha' }
+          subject.should_receive(:fork) { |&block|
+            block.call.should == 'hooha'
+          }
+          subject.start_server
+        end
+
+        it "opens the browser if configurated to do so" do
+          config.capture_browser = true
+          subject.should_receive("`").with('hooha --port 1234 --browser browsers') { 'hooha' }
+          subject.should_receive(:fork) { |&block| block.call }
+          subject.start_server
+        end
+
+        it "traps the 'QUIT' signal before sending it to the child process" do
+          subject.should_receive("`").with('hooha --port 1234') { 'hooha' }
+          subject.should_receive(:trap).with('QUIT', 'IGNORE')
+          subject.should_receive(:fork) { |&block| block.call }
+          subject.start_server
+        end
+      end
+    end
+  end
 end

data/spec/guard/jstd_spec.rb

@@ -7,11 +7,19 @@ describe Guard::Jstd do
     klass.ancestors.should include Guard::Guard
   end
 
-  it "#start sends a message to UI" do
-    ::Guard::UI.should_receive(:info).with(
-      "Guard::Jstd is running."
-    )
-    subject.start
+  describe "#start" do
+    it "sends a message to UI" do
+      klass::Runner.stub(:start_server)
+      ::Guard::UI.should_receive(:info).with(
+        "Guard::Jstd is running."
+      )
+      subject.start
+    end
+
+    it "calls Runner.start_server" do
+      klass::Runner.should_receive(:start_server)
+      subject.start
+    end
   end
 
   it " #run_all runs all tests" do
@@ -28,4 +36,10 @@ describe Guard::Jstd do
       subject.run_on_change(paths)
     end
   end
+
+  it ".configure yields the Configuration module" do
+    Guard::Jstd.configure do |c|
+      c.should == Guard::Jstd::Configuration
+    end
+  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: guard-jstd
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
-  - 0
   - 1
-  version: 0.0.1
+  - 0
+  version: 0.1.0
 platform: ruby
 authors: 
 - aRailsDemo
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-07 00:00:00 Z
+date: 2011-04-08 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: guard
@@ -62,16 +62,19 @@ files:
 - .gitignore
 - Gemfile
 - Guardfile
+- LICENSE
 - README.md
 - Rakefile
 - guard-jstd.gemspec
 - lib/guard/jstd.rb
 - lib/guard/jstd/case_finder.rb
+- lib/guard/jstd/configuration.rb
 - lib/guard/jstd/formatter.rb
 - lib/guard/jstd/runner.rb
 - lib/guard/jstd/templates/Guardfile
 - lib/guard/jstd/version.rb
 - spec/guard/jstd/case_finder_spec.rb
+- spec/guard/jstd/configuration_spec.rb
 - spec/guard/jstd/formatter_spec.rb
 - spec/guard/jstd/runner_spec.rb
 - spec/guard/jstd_spec.rb
@@ -111,6 +114,7 @@ specification_version: 3
 summary: A Guard for JsTestDriver
 test_files: 
 - spec/guard/jstd/case_finder_spec.rb
+- spec/guard/jstd/configuration_spec.rb
 - spec/guard/jstd/formatter_spec.rb
 - spec/guard/jstd/runner_spec.rb
 - spec/guard/jstd_spec.rb