cuukie 0.1.4 → 0.2.0

data/spec/commands_spec.rb

@@ -1,22 +1,7 @@
 require 'spec_helper'
-
-describe "The cuukie_server command" do
-  it "starts the Cuukie server on port 4569 by default" do
-    start_process "ruby bin/cuukie_server >/dev/null 2>&1"
-    wait_for_server_on_port 4569
-    stop_server_on_port 4569
-  end
-
-  it "starts the Cuukie server on any given port" do
-    start_process "ruby bin/cuukie_server 4570 >/dev/null 2>&1"
-    wait_for_server_on_port 4570
-    stop_server_on_port 4570
-  end
-end
+require 'tempfile'
 
 describe "The cuukie formatter" do
-  require 'tempfile'
-
   before :each do
     @out = Tempfile.new('cuukie.tmp')
   end
@@ -27,11 +12,11 @@ describe "The cuukie formatter" do
   
   it "expects a server on localhost:4569 by default" do
     begin
-      start_process "ruby bin/cuukie_server 4569 >/dev/null 2>&1"
+      start_process "ruby bin/cuukie --server >/dev/null 2>&1"
       wait_for_server_on_port 4569
       cmd = "cd spec/test_project && \
              cucumber features/1_show_scenarios.feature:9 \
-                      --format cuukie > #{@out.path}"
+                      --format cuukie >#{@out.path}"
       system(cmd).should be_true
       @out.read.should == ''
     ensure
@@ -40,13 +25,13 @@ describe "The cuukie formatter" do
   end
 
   it "can point to a different server" do
-    start_process "ruby bin/cuukie_server 4570 >/dev/null 2>&1"
+    start_process "ruby bin/cuukie --server --cuukieport 4570 >/dev/null 2>&1"
     begin
       wait_for_server_on_port 4570
       cmd = "cd spec/test_project && \
              cucumber features/1_show_scenarios.feature:9 \
                       CUUKIE_SERVER=http://localhost:4570 \
-                      --format cuukie > #{@out.path}"
+                      --format cuukie >#{@out.path}"
       system(cmd).should be_true
       @out.read.should == ''
     ensure
@@ -58,8 +43,74 @@ describe "The cuukie formatter" do
     cmd = "cd spec/test_project && \
            cucumber features/1_show_scenarios.feature:9 \
                     CUUKIE_SERVER=http://some.server:4570 \
-                    --format cuukie > #{@out.path}"
+                    --format cuukie >#{@out.path}"
     system(cmd).should be_true
-    @out.read.should match 'I cannot find the cuukie_server on http://some.server:4570'
+    @out.read.should match 'I cannot find the cuukie server on http://some.server:4570'
+  end
+end
+
+describe "The cuukie command" do
+  before(:each) { @out = Tempfile.new('cuukie.tmp') }
+  after(:each) { @out.delete }
+
+  it "shows help with --help" do
+    system "ruby bin/cuukie --help >#{@out.path}"
+    @out.read.should match /Usage: cuukie \[options\]/
+  end
+
+  it "starts the server and runs cucumber with the cuukie formatter" do
+    system "ruby bin/cuukie spec/test_project/features/ \
+                            --require spec/test_project/features/step_definitions/ \
+                            --require lib/cuukie \
+                            --nowait \
+                            --keepserver \
+                            >/dev/null 2>&1"
+
+    html.should match "Passing Scenario"
+    stop_server_on_port 4569
+  end
+  
+  it "gives instructions to access the page if --showpage is not enabled" do
+    system "ruby bin/cuukie spec/test_project/features/ \
+                            --require spec/test_project/features/step_definitions/ \
+                            --require lib/cuukie \
+                            --nowait \
+                            --cuukieport 4570 \
+                            >#{@out.path}"
+    
+    @out.read.should match 'View your features at http://localhost:4570'
+  end
+
+  it "closes the server on exit" do
+    system "ruby bin/cuukie spec/test_project/features/ \
+                            --require spec/test_project/features/step_definitions/ \
+                            --require lib/cuukie \
+                            --nowait \
+                            --cuukieport 4570 \
+                            >/dev/null 2>&1"
+    
+    lambda { ping_on_port 4570 }.should raise_error
+  end
+
+  describe "when used with the --server switch" do
+    it "starts the Cuukie server on port 4569 by default" do
+      start_process "ruby bin/cuukie --server >/dev/null 2>&1"
+      wait_for_server_on_port 4569
+      stop_server_on_port 4569
+    end
+
+    it "starts the Cuukie server on any given port" do
+      start_process "ruby bin/cuukie --server --cuukieport 4570 >/dev/null 2>&1"
+      wait_for_server_on_port 4570
+      stop_server_on_port 4570
+    end
+
+    it "exits immediately after starting the server" do
+      start_process "ruby bin/cuukie --server >/dev/null 2>&1"
+      wait_for_server_on_port 4569
+      html.should match /Cuukie/
+      html.should_not match /Feature:/
+      stop_server_on_port 4569
+    end
   end
 end

data/spec/cuukie_spec.rb

@@ -1,11 +1,102 @@
 require 'spec_helper'
 
 describe 'Cuukie' do
-  before(:all) { start_server }
-  after(:all) { stop_server_on_port 4569 }
+  describe "before Cucumber has run" do
+    before(:all) { start_server }
+    after(:all) { stop_server_on_port 4569 }
+    
+    it "shows a grey status bar" do
+      html.should match /undefinedColors\('cucumber-header'\)/
+    end
+
+    it "shows no features" do
+      html.should_not match "Feature:"
+    end
+
+    it "shows zero running time" do
+      html.should match "Running time: <strong>0':0''</strong>"
+    end
+
+     it "doesn't show end-of-features stats" do
+       html.should_not match /\d+ scenarios \(.*\)/
+       html.should_not match /\d+ steps \(.*\)/
+     end
+  end
+
+  shared_examples_for "while Cucumber is running" do
+    require 'ostruct'
+    
+    after(:all) { stop_server_on_port 4569 }
+
+    it "shows a grey status bar" do
+      html.should match /undefinedColors\('cucumber-header'\)/
+    end
+    
+    it "shows incomplete description for features" do
+      html.should match '>...: Stuff That Works<'
+      @formatter.feature_name 'Feature'
+      html.should match '>Feature: Stuff That Works<'
+    end
+    
+    it "shows incomplete scenarios in grey" do
+      @formatter.scenario_name 'Scenario','Do Stuff', 'file.rb:10'
+      html.should match /undefinedColors\('scenario_1_1'\)/
+    end
+    
+    it "shows incomplete steps in grey" do
+      @formatter.before_step OpenStruct.new(:keyword => 'Given',
+                                            :name => 'I do something',
+                                            :file_colon_line => 'file.rb:11' )
+      html.should match 'class="step undefined"'
+    end
+    
+    it "shows partial running time" do
+      html.should_not match "Finished in"
+      html.should match /Running time: <strong>\d+\':\d+\'\'<\/strong>/
+    end
+     
+    it "doesn't show end-of-features stats" do
+      html.should_not match /\d+ scenarios \(.*\)/
+      html.should_not match /\d+ steps \(.*\)/
+    end
+  end
+  
+  describe "while Cucumber is running for the first time" do
+    before(:all) do
+      start_server
+      @formatter = Cuukie::Formatter.new
+      
+      @formatter.before_features
+      @formatter.before_feature OpenStruct.new(:short_name => 'Stuff That Works',
+                                               :description => 'As somebody...')
+    end
+
+    it_behaves_like "while Cucumber is running"
+  end
   
-  describe 'in the content area' do
-    before(:all) { run_cucumber }
+  describe "while Cucumber is running for the nth time" do
+    before(:all) do
+      start_server
+      @formatter = Cuukie::Formatter.new
+      
+      @formatter.before_features
+      @formatter.after_features OpenStruct.new(:duration => 70)
+
+      @formatter.before_features
+      @formatter.before_feature OpenStruct.new(:short_name => 'Stuff That Works',
+                                               :description => 'As somebody...')
+    end
+
+    it_behaves_like "while Cucumber is running"
+  end
+  
+  describe "once Cucumber has run" do
+    before(:all) do
+      start_server
+      run_cucumber
+    end
+
+    after(:all) { stop_server_on_port 4569 }
 
     it "cleans up previous data at the beginning of a run" do
       run_cucumber
@@ -30,11 +121,11 @@ describe 'Cuukie' do
       html.should match '>features&#x2F;1_show_scenarios.feature:'
     end
   
-    it "shows the passed scenarios in green" do
+    it "shows passed scenarios in green" do
       html.should match /passedColors\('scenario_1_1'\)/
     end
   
-    it "shows the failed scenarios in red" do
+    it "shows failed scenarios in red" do
       html.should match /failedColors\('scenario_3_1'\)/
     end
   
@@ -54,7 +145,7 @@ describe 'Cuukie' do
     end
   
     it "shows the step source position" do
-      html.should match '>features&#x2F;step_definitions&#x2F;main_steps.rb:'
+      html.should match '>.&#x2F;features&#x2F;step_definitions&#x2F;main_steps.rb:'
     end
   
     it "shows the step status" do
@@ -63,17 +154,17 @@ describe 'Cuukie' do
     end
 
     it "shows exception messages" do
-      html.should match /main_steps.rb:7<\/span><\/div>[ \n]*<div class="message"><pre>Crash!<\/pre><\/div>/
+      html.should match /1_show_scenarios.feature:16<\/span><\/div>[ \n]*<div class=\"message\"><pre>Crash!/
     end
 
     it "shows exception backtraces" do
-      html.should match 'backtrace"><pre>.&#x2F;features&#x2F;step_definitions&#x2F;main_steps.rb:8:in `&#x2F;I do'
-      html.should match '3_failed_background.feature:7:in `Given I do'
+      html.should match 'features&#x2F;3_failed_background.feature:7:in `Given a Background Step fails&#x27;'
+      html.should match '3_failed_background.feature:7:in `Given a Background Step'
     end
 
     it "shows exception source snippets" do
       html.should match '<pre class="ruby"><code><span class="linenum">6<\/span>'
-      html.should match '<span class="constant">I</span> <span class="keyword">do</span> <span class="ident">something'
+      html.should match '<span class="keyword">raise</span> <span class="punct">&quot;</span><span class="string">Crash!'
     end
     
     it "marks the exception source in snippets" do
@@ -93,8 +184,8 @@ describe 'Cuukie' do
       html.should match '<pre class=\"val\">  Cuukie is sweet!\n  Let&#x27;s try it out.</pre>'
     end
     
-    it "shows total duration" do
-      html.should match /Finished in <strong>\d+m\d+\.\d+s seconds<\/strong>/
+    it "shows total running time" do
+      html.should match /Duration: <strong>\d+\':\d+\'\'<\/strong>/
     end
     
     it "shows end-of-features stats" do
@@ -102,26 +193,23 @@ describe 'Cuukie' do
       html.should match /3 scenarios \(1 failed, 1 pending, 1 passed\)/
       html.should match /11 steps \(1 failed, 2 skipped, 1 pending, 7 passed\)/
     end
-  end
-  
-  describe 'in the page header' do
-    it "contains essential information" do
-      run_cucumber
+
+    it "contains essential information in the status bar" do
       html.should match '<h1>Cucumber Features</h1>'
       html.should match '<title>Cuukie</title>'
     end
 
-    it "shows green if all scenarios passed" do
+    it "shows a green status bar if all scenarios passed" do
       run_cucumber '1_show_scenarios.feature:9'
       html.should match /passedColors\('cucumber-header'\)/
     end
 
-    it "shows red if any scenario failed" do
+    it "shows a red status bar if any scenario failed" do
       run_cucumber '1_show_scenarios.feature'
       html.should match /failedColors\('cucumber-header'\)/
     end
 
-    it "shows yellow if no scenarios failed but some are pending" do
+    it "shows a yellow status bar if no scenarios failed but some are pending" do
       run_cucumber '1_show_scenarios.feature:19'
       html.should match /pendingColors\('cucumber-header'\)/
     end

data/spec/spec_helper.rb

@@ -1,4 +1,5 @@
 require 'bundler/setup'
+require 'cuukie'
 
 def start_process(command)
   Process.detach fork { exec command }
@@ -23,14 +24,18 @@ def html
 end
 
 def start_server
-  start_process "ruby bin/cuukie_server >/dev/null 2>&1"
+  start_process "ruby bin/cuukie --server >/dev/null 2>&1"
   wait_for_server_on_port 4569
 end
 
+def ping_on_port(port)
+  RestClient.get "http://localhost:#{port}/ping"
+end
+
 def wait_for_server_on_port(port)
   loop do
     begin
-      RestClient.get "http://localhost:#{port}/ping"
+      ping_on_port port
       return
     rescue; end
   end

data/spec/test_project/features/1_show_scenarios.feature

@@ -4,7 +4,7 @@ Feature: Visualize Scenarios
   So that I know which steps are not passing
 
 Background: Common Steps
-  Given I execute a Background step
+  Given a Background step
 
 Scenario: Passing Scenario
   And I do something
@@ -13,9 +13,9 @@ Scenario: Passing Scenario
   Then the entire Scenario should pass
 
 Scenario: Failing Scenario
-  When I do something that results in an error
+  When a Step fails
   Then the entire Scenario should fail
 
 Scenario: Pending Scenario
-  When I call a pending Step
+  When a Step is pending
   Then the entire Scenario should be pending

data/spec/test_project/features/2_show_multiline_args.feature

@@ -1,4 +1,4 @@
-Feature:
+Feature: Show Multiline Arguments
   As a Cuker
   I want to see multiline arguments in the result
   To see everything about steps

data/spec/test_project/features/3_failed_background.feature

@@ -4,12 +4,10 @@ Feature: Show Failed Background
   So that I know that everything else is skipped
 
 Background: Failing Background
-  Given I do something that results in an error
+  Given a Background Step fails
 
-Scenario: Skipped Scenario
-  When I do something
-  Then the entire Scenario should be skipped anyway
+Scenario: First Scenario
+  Then the first Scenario should be failing
 
-Scenario: Another Skipped Scenario
-  When I do something else
-  Then the entire Scenario should be skipped anyway
+Scenario: Other Scenarios
+  Then the following Scenarios should be skipped

data/spec/test_project/features/step_definitions/main_steps.rb

@@ -4,21 +4,22 @@ end
 When /^I pass an "([^"]*)"$/ do |argument|
 end
 
-When /I do something that results in an error/ do
+When /^a.+Step fails$/ do
   raise "Crash!"
 end
 
-When /I call a pending Step/ do
+When /^a Step is pending$/ do
   pending
 end
 
-Given /^I execute a Background step$/ do; end
+Given /^a Background step$/ do; end
 Given /^I do something$/ do; end
 When /^I do something else$/ do; end
 Then /^I should see stuff$/ do; end
 Then /^the entire Scenario should pass$/ do; end
 Then /^the entire Scenario should fail$/ do; end
 Then /^the entire Scenario should be pending$/ do; end
-Then /^the entire Scenario should be skipped anyway$/ do; end
+Then /^the first Scenario should be failing$/ do; end
+Then /^the following Scenarios should be skipped$/ do; end
 Then /^Cuukie should be OK with it$/ do; end
 Given /^I say$/ do |smart_stuff|; end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cuukie
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,33 +9,44 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-08 00:00:00.000000000 Z
+date: 2011-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
-  requirement: &70339163759300 !ruby/object:Gem::Requirement
+  requirement: &70206687427700 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70206687427700
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: &70206687427220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
   type: :runtime
   prerelease: false
-  version_requirements: *70339163759300
+  version_requirements: *70206687427220
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &70339163757860 !ruby/object:Gem::Requirement
+  requirement: &70206687426740 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.6'
   type: :runtime
   prerelease: false
-  version_requirements: *70339163757860
+  version_requirements: *70206687426740
 - !ruby/object:Gem::Dependency
-  name: cucumber
-  requirement: &70339163755420 !ruby/object:Gem::Requirement
+  name: launchy
+  requirement: &70206687442620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70339163755420
+  version_requirements: *70206687442620
 - !ruby/object:Gem::Dependency
   name: syntax
-  requirement: &70339163753560 !ruby/object:Gem::Requirement
+  requirement: &70206687442140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +65,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70339163753560
+  version_requirements: *70206687442140
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70339163760240 !ruby/object:Gem::Requirement
+  requirement: &70206687441660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70339163760240
+  version_requirements: *70206687441660
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70339163758480 !ruby/object:Gem::Requirement
+  requirement: &70206687441180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,11 +87,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70339163758480
-description: Shows Cucumber results on a web page as they run.
+  version_requirements: *70206687441180
+description: A drop-in replacement for the "cucumber" command. It shows running features
+  on a web page.
 email: paolo.nusco.perrotta@gmail.com
 executables:
-- cuukie_server
+- cuukie
 extensions: []
 extra_rdoc_files:
 - README.markdown
@@ -92,19 +104,21 @@ files:
 - README.markdown
 - Rakefile
 - VERSION
-- bin/cuukie_server
+- bin/cuukie
 - cuukie.gemspec
 - doc/LICENSE.txt
 - doc/backlog.txt
 - doc/pomodoro.txt
 - lib/cuukie.rb
-- lib/cuukie/cucumber/formatter/code_snippets.rb
-- lib/cuukie/cucumber/formatter/cuukie.rb
+- lib/cuukie/cli.rb
+- lib/cuukie/code_snippets.rb
+- lib/cuukie/formatter.rb
 - lib/cuukie/public/cucumber.css
 - lib/cuukie/public/cuukie.js
 - lib/cuukie/public/jquery-1.7.min.js
 - lib/cuukie/server.rb
 - lib/cuukie/views/index.erb
+- spec/cli_spec.rb
 - spec/code_snippets_spec.rb
 - spec/commands_spec.rb
 - spec/cuukie_spec.rb
@@ -131,7 +145,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2459400379263552476
+      hash: -4010332035183604014
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: