cuukie 0.1.0 → 0.1.1

data/README.markdown

@@ -2,4 +2,4 @@ Cuukie shows your Cucumber results in a web page as they run.
 
 [![Build Status](https://secure.travis-ci.org/nusco/cuukie.png)](http://travis-ci.org/nusco/cuukie.png)
 
-No gem yet. This project is still pre-alpha anyway.
+There is a gem out, but it's still an early version. I'll update this README when Cuukie is a tad more solid.

data/Rakefile

@@ -1,23 +1,24 @@
-# FIXME: why does this fail after loading Bundler?
-require 'rspec/core/rake_task'
+require 'bundler/setup'
 
-require 'bundler'
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
+task :default => 'test:specs'
 
-task :default => :spec
+namespace :test do
+  require 'rspec/core/rake_task'
+  desc "Run all specs"
+  RSpec::Core::RakeTask.new(:specs)
 
-desc "Run all specs"
-RSpec::Core::RakeTask.new(:spec)
+  desc "Run Cuukie on the test project (needs a cuukie_server on localhost, default port)"
+  task :smoke do
+    system "cucumber spec/test_project/features \
+            --require spec/test_project/features/step_definitions/ \
+            --require lib/cuukie/formatter \
+            --format Cuukie \
+            --guess"
+  end
+end
 
 require 'jeweler'
 Jeweler::Tasks.new do |gem|
-  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
   gem.name = "cuukie"
   gem.homepage = "http://github.com/nusco/cuukie"
   gem.license = "MIT"
@@ -25,16 +26,5 @@ Jeweler::Tasks.new do |gem|
   gem.description = %Q{Cuukie shows the result of running Cucumber feature on a remote server.}
   gem.email = "paolo.nusco.perrotta@gmail.com"
   gem.authors = ['Paolo "Nusco" Perrotta']
-  # dependencies defined in Gemfile
 end
 Jeweler::RubygemsDotOrgTasks.new
-
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "cuukie #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/cuukie.gemspec

@@ -0,0 +1,74 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "cuukie"
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Paolo \"Nusco\" Perrotta"]
+  s.date = "2011-12-04"
+  s.description = "Cuukie shows the result of running Cucumber feature on a remote server."
+  s.email = "paolo.nusco.perrotta@gmail.com"
+  s.executables = ["cuukie_server"]
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.markdown"
+  ]
+  s.files = [
+    ".autotest",
+    ".rspec",
+    ".travis.yml",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.markdown",
+    "Rakefile",
+    "VERSION",
+    "bin/cuukie_server",
+    "cuukie.gemspec",
+    "lib/cuukie/formatter/cuukie.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",
+    "pomodoro.txt",
+    "spec/commands_spec.rb",
+    "spec/cuukie_spec.rb",
+    "spec/test_project/features/create_user.feature",
+    "spec/test_project/features/delete_user.feature",
+    "spec/test_project/features/step_definitions/example_steps.rb"
+  ]
+  s.homepage = "http://github.com/nusco/cuukie"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.10"
+  s.summary = "A continuous view on Cucumber features"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<sinatra>, [">= 0"])
+      s.add_runtime_dependency(%q<rest-client>, [">= 0"])
+      s.add_runtime_dependency(%q<cucumber>, [">= 0"])
+      s.add_development_dependency(%q<rake>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+    else
+      s.add_dependency(%q<sinatra>, [">= 0"])
+      s.add_dependency(%q<rest-client>, [">= 0"])
+      s.add_dependency(%q<cucumber>, [">= 0"])
+      s.add_dependency(%q<rake>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<sinatra>, [">= 0"])
+    s.add_dependency(%q<rest-client>, [">= 0"])
+    s.add_dependency(%q<cucumber>, [">= 0"])
+    s.add_dependency(%q<rake>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+  end
+end
+

data/lib/cuukie/formatter/cuukie.rb

@@ -29,6 +29,14 @@ class Cuukie
     post 'after_step_result', { 'status' => status }
   end
   
+  def after_steps(*)
+    post 'after_steps', {}
+  end
+  
+  def after_features(*)
+    post 'after_features', {}
+  end
+  
   private
   
   def post(url, params)

data/lib/cuukie/public/{scenarios.js → cuukie.js}

@@ -20,11 +20,15 @@ $(document).ready(function() {
 function moveProgressBar(percentDone) {
   $("cucumber-header").css('width', percentDone +"%");
 }
-function makeRed(element_id) {
+function failedColors(element_id) {
   $('#'+element_id).css('background', '#C40D0D');
   $('#'+element_id).css('color', '#FFFFFF');
 }
-function makeYellow(element_id) {
+function pendingColors(element_id) {
   $('#'+element_id).css('background', '#FAF834');
   $('#'+element_id).css('color', '#000000');
 }
+function passedColors(element_id) {
+  $('#'+element_id).css('background', '#65c400');
+  $('#'+element_id).css('color', '#000000');
+}

data/lib/cuukie/server.rb

@@ -1,24 +1,25 @@
 require 'sinatra/base'
 require 'json'
 
-require 'sinatra/base'
-
 module Cuukie
   class Server < Sinatra::Base
     set :port, 4569
     set :features, []
-
+    set :build_status, nil
+    
     get '/' do
       @features = settings.features
+      @build_status = settings.build_status
       erb :index
     end
 
     post '/before_features' do
       settings.features.clear
+      settings.build_status = nil
     end
 
     post '/before_feature' do
-      feature = JSON.parse(request.body.read)
+      feature = read_from_request
       feature['description'] = feature['description'].split("\n")
       feature['scenarios'] = []
       feature['id'] = settings.features.size + 1
@@ -27,7 +28,7 @@ module Cuukie
     end
 
     post '/scenario_name' do
-      scenario = JSON.parse(request.body.read)
+      scenario = read_from_request
       scenario['steps'] = []
       scenario['id'] = "scenario_#{current_feature['id']}_#{current_scenarios.size + 1}"
       current_scenarios << scenario
@@ -35,15 +36,31 @@ module Cuukie
     end
 
     post '/before_step_result' do
-      current_scenario['steps'] << JSON.parse(request.body.read)
+      current_scenario['steps'] << read_from_request
       'OK'
     end
 
     post '/after_step_result' do
-      current_step.merge! JSON.parse(request.body.read)
+      current_step.merge! read_from_request
+      if current_step['status'] == 'failed'
+        current_scenario['status'] = settings.build_status = 'failed' 
+      elsif current_step['status'] == 'pending'
+        current_scenario['status'] = 'pending'
+        settings.build_status ||= 'pending' 
+      end
       'OK'
     end
 
+    post '/after_steps' do
+      current_scenario['status'] ||= 'passed'
+      'OK'
+    end
+
+    post '/after_features' do
+      settings.build_status ||= 'passed'
+      'OK'
+    end
+    
     get('/ping') { 'pong!' }
     delete('/') { exit! }
 
@@ -62,5 +79,12 @@ module Cuukie
     def current_step
       current_scenario['steps'].last
     end
+    
+    include Rack::Utils
+    
+    def read_from_request
+      result = JSON.parse(request.body.read)
+      result.each {|k, v| result[k] = escape_html v }
+    end
   end
 end

data/lib/cuukie/views/index.erb

@@ -3,7 +3,7 @@
     <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1">
     <link rel="stylesheet" type="text/css" href="cucumber.css">
     <script type="text/javascript" src="jquery-1.7.min.js"></script>
-    <script type="text/javascript" src="scenarios.js"></script>
+    <script type="text/javascript" src="cuukie.js"></script>
     <title>Cuukie</title>
   </head>
 
@@ -13,6 +13,8 @@
         <div id="expand-collapse"><p id="expander">Expand All</p><p id="collapser">Collapse All</p></div>
       </div>
     </div>
+    
+    <script><%= @build_status %>Colors('cucumber-header')</script>
 
     <% @features.each do |feature| %>
       <div class="feature">
@@ -25,13 +27,9 @@
             <h3 style="cursor: pointer;" id="<%= scenario['id'] %>">
               <span class="keyword">Scenario: </span><span class="val"><%= scenario['name'] %></span>
             </h3>
+            <script><%= scenario['status'] %>Colors('<%= scenario['id'] %>');</script>
             <ol style="display: block;">
-              <% scenario['steps'].each do |step| %>
-              <% if step['status'] == 'failed' %>
-                <script>makeRed('cucumber-header');makeRed('<%= scenario['id'] %>');</script>
-              <% elsif step['status'] == 'pending' %>
-                <script>makeRed('cucumber-header');makeYellow('<%= scenario['id'] %>');</script>
-              <% end %>
+            <% scenario['steps'].each do |step| %>
               <li id="features_" class="step <%= step['status'] %>">
                 <div class="step_name">
                   <span class="keyword"><%= step['keyword'] %></span><span class="step val"><%= step['name'] %></span>

data/pomodoro.txt

@@ -1,6 +1,13 @@
 I use this file to track my own work on the project. Each line is a pomodoro (a 25' slot).
 Latest pomodoro comes first:
 
+- refactor build status
+- status for entire suite
+- better scenario status
+- HTML escaping
+- HTML escaping (in progress)
+- cleanup
+- jewelized and released first version of gem
 - scenario status, cuukie_server binary
 - struggle to show scenario status (broken tests)
 - mark step status (finally done)

data/spec/cuukie_spec.rb

@@ -1,18 +1,44 @@
-describe 'Cuukie' do
+describe 'The Cuukie header' do
   before(:all) do
-    Server.start
-    run_cucumber
+    start_server
   end
   
   after(:all) do
-    Server.stop
+    stop_server
   end
-
-  it "shows a html page" do
+  
+  it "contains essential information" do
+    run_cucumber
     html.should match '<h1>Cucumber Features</h1>'
     html.should match '<title>Cuukie</title>'
   end
 
+  it "is red if any steps failed" do
+    run_cucumber 'spec/test_project/features/create_user.feature'
+    html.should match /failedColors\('cucumber-header'\)/
+  end
+
+  it "is yellow if no steps failed but some are pending" do
+    run_cucumber 'spec/test_project/features/create_user.feature:17'
+    html.should match /pendingColors\('cucumber-header'\)/
+  end
+
+  it "is green if all steps passed" do
+    run_cucumber 'spec/test_project/features/create_user.feature:6'
+    html.should match /passedColors\('cucumber-header'\)/
+  end
+end
+
+describe 'The Cuukie content panel' do
+  before(:all) do
+    start_server
+    run_cucumber
+  end
+  
+  after(:all) do
+    stop_server
+  end
+
   it "cleans up previous data at the beginning of a run" do
     run_cucumber
     html.scan('Feature: Create User').size.should == 1
@@ -33,7 +59,19 @@ describe 'Cuukie' do
   end
 
   it "shows the scenario source position" do
-    html.should match '>spec/test_project/features/create_user.feature:6<'
+    html.should match '>spec&#x2F;test_project&#x2F;features&#x2F;create_user.feature:6<'
+  end
+  
+  it "shows the passed scenarios in green" do
+    html.should match /passedColors\('scenario_1_1'\)/
+  end
+  
+  it "shows the failed scenarios in red" do
+    html.should match /failedColors\('scenario_1_2'\)/
+  end
+  
+  it "shows the pending scenarios in yellow" do
+    html.should match /pendingColors\('scenario_1_3'\)/
   end
 
   it "assigns a sequential id to scenarios" do
@@ -42,62 +80,57 @@ describe 'Cuukie' do
 
   it "shows the step names" do
     html.should match '>Given </span><span class="step val">I am on the Admin page</span>'
-    html.should match '>And </span><span class="step val">I press "OK"</span>'
-  end
-
-  it "shows the step source position" do
-    html.should match '>spec/test_project/features/step_definitions/example_steps.rb:5<'
-  end
-
-  it "shows the test result" do
-     html.should match /makeRed\('cucumber-header'\)/
+    html.should match '>When </span><span class="step val">I create a new User</span>'
   end
   
-  it "shows the scenario status" do
-    html.should match /makeRed\('scenario_1_2'\)/
-    html.should match /makeYellow\('scenario_1_3'\)/
+  it "shows the step source position" do
+    html.should match '>spec&#x2F;test_project&#x2F;features&#x2F;step_definitions&#x2F;example_steps.rb:4<'
   end
   
   it "shows the step status" do
     html.should match 'class="step passed"'
     html.should match 'class="step pending"'
   end
+  
+  it "escapes step names" do
+    html.should match 'I press &quot;Delete&quot;'
+  end
 end
 
 require 'rest-client'
 
-class Server
-  class << self
-    def start
-      Process.detach fork { exec "ruby bin/cuukie_server >/dev/null 2>&1" }
-
-      # wait until it's up
-      loop do
-        begin
-          GET '/ping'
-          return
-        rescue; end
-      end
-    end
-
-    def stop
-      # the server dies without replying, so we expect an error here
-      DELETE '/'
-    rescue
-    end
-
-    def method_missing(name, *args)
-      super unless [:GET, :POST, :PUT, :DELETE].include? name.to_sym
-      args[0] = "http://localhost:4569#{args[0]}"
-      RestClient.send name.downcase, *args
-    end
+[:GET, :POST, :PUT, :DELETE].each do |method|
+  Kernel.send :define_method, method do |*args|
+    args[0] = "http://localhost:4569#{args[0]}"
+    RestClient.send method.downcase, *args
   end
 end
 
+def start_server
+  Process.detach fork { exec "ruby bin/cuukie_server >/dev/null 2>&1" }
+
+  # wait until it's up
+  loop do
+    begin
+      GET '/ping'
+      return
+    rescue; end
+  end
+end
+
+def stop_server
+  # the server dies without replying, so we expect an error here
+  DELETE '/'
+rescue
+end
+
 def html
-  Server.GET('/').body
+  GET('/').body
 end
 
-def run_cucumber
-  system 'cucumber spec/test_project/features --require spec/test_project/features/step_definitions/ --require lib/cuukie/formatter  --format Cuukie --guess'
+def run_cucumber(features = 'spec/test_project/features')
+  system "cucumber #{features} \
+          --require spec/test_project/features/step_definitions/ \
+          --require lib/cuukie/formatter --format Cuukie \
+          --guess"
 end

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

@@ -1,3 +1,6 @@
+When /^I press "([^"]*)"$/ do |button|
+end
+
 When /I create a User with an existing id/ do
   raise "Crash!"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cuukie
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2011-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
-  requirement: &70338782023200 !ruby/object:Gem::Requirement
+  requirement: &70139875173140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70338782023200
+  version_requirements: *70139875173140
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &70338782022400 !ruby/object:Gem::Requirement
+  requirement: &70139875172540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70338782022400
+  version_requirements: *70139875172540
 - !ruby/object:Gem::Dependency
   name: cucumber
-  requirement: &70338782019600 !ruby/object:Gem::Requirement
+  requirement: &70139875171960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70338782019600
+  version_requirements: *70139875171960
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70338782017260 !ruby/object:Gem::Requirement
+  requirement: &70139875171300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70338782017260
+  version_requirements: *70139875171300
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70338782056720 !ruby/object:Gem::Requirement
+  requirement: &70139875170740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70338782056720
+  version_requirements: *70139875170740
 description: Cuukie shows the result of running Cucumber feature on a remote server.
 email: paolo.nusco.perrotta@gmail.com
 executables:
@@ -84,14 +84,14 @@ files:
 - Rakefile
 - VERSION
 - bin/cuukie_server
+- cuukie.gemspec
 - lib/cuukie/formatter/cuukie.rb
 - lib/cuukie/public/cucumber.css
+- lib/cuukie/public/cuukie.js
 - lib/cuukie/public/jquery-1.7.min.js
-- lib/cuukie/public/scenarios.js
 - lib/cuukie/server.rb
 - lib/cuukie/views/index.erb
 - pomodoro.txt
-- smoke_test.sh
 - spec/commands_spec.rb
 - spec/cuukie_spec.rb
 - spec/test_project/features/create_user.feature
@@ -112,7 +112,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2959144282346188564
+      hash: -3260506594562917697
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:

data/smoke_test.sh

@@ -1 +0,0 @@
-cucumber spec/test_project/features --require spec/test_project/features/step_definitions/ --require lib/cuukie/formatter  --format Cuukie --guess