cuukie 0.2.2 → 0.3.0

data/README.markdown

@@ -8,15 +8,23 @@ Install Cuukie via Bundler, or directly with:
 
     gem install cuukie
 
-Go to your Cucumber folder and add this line to any file in _features/support_:
+Go to a folder where you would normally run _cucumber_, and run _cuukie_ instead:
 
-    require 'cuukie'
+    cuukie --showpage
 
-Run Cuukie:
+That's basically it.
 
-    cuukie --showpage
+# Command-line Arguments
+
+Cuukie passes arguments that it doesn't recognize to Cucumber, so feel free to mix Cuukie arguments and Cucumber arguments:
 
-Cuukie passes any command-line argument that it doesn't recognize to Cucumber, so just use _cuukie_ instead of _cucumber_ when you want to see your features in the browser.
+    cuukie --showpage --dry-run --format pretty --out out.txt
+
+Only thing to notice: Cuukie uses its own Cucumber formatter, so remember to use --out if you want to use additional formatters. 
+
+For more options:
+
+    cuukie --help
 
 ## Advanced Cuuking
 
@@ -24,13 +32,17 @@ Cuukie is actually two things: a server that displays running features on a web
 
     cuukie --server
 
+You can visit the server on port 4569 by default.
+
+Now you need to tell Cucumber about the Cuukie formatter. Go to your Cucumber folder and add this line to any file in _features/support_:
+
+    require 'cuukie'
+
 When you run Cucumber, ask it to use the _cuukie_ formatter to send data to the server:
 
     cucumber --format cuukie
 
-To look at the results, visit:
-
-    http://localhost:4569
+## Even More Advanced Cuuking
 
 You can pick a port when you start the cuukie server...
 
@@ -40,9 +52,7 @@ You can pick a port when you start the cuukie server...
 
     cucumber --format cuukie CUUKIE_SERVER=http://my.server:4570
 
-This stuff is useful if you want to put the Cuukie server on your build machine. For more options:
-
-    cuukie --help
+This stuff is useful if you want to put the Cuukie server on your build machine.
 
 Enjoy!
 

data/Rakefile

@@ -1,18 +1,10 @@
 require 'bundler/setup'
 
-task :default => 'test:specs'
+task :default => :test
 
-namespace :test do
-  require 'rspec/core/rake_task'
-  desc "Run all specs"
-  RSpec::Core::RakeTask.new(:specs)
-
-  desc "Run Cuukie on the test project (needs a cuukie server on localhost, default port)"
-  task :manual do
-    system "cd spec/test_project && \
-            cucumber --format cuukie"
-  end
-end
+require 'rspec/core/rake_task'
+desc "Run all specs"
+RSpec::Core::RakeTask.new(:test)
 
 require 'jeweler'
 Jeweler::Tasks.new do |gem|

data/VERSION

@@ -1 +1 @@
-0.2.2
+0.3.0

data/bin/cuukie

@@ -1,14 +1,15 @@
 #!/usr/bin/env ruby
 lib = File.dirname(__FILE__) + '/../lib'
 $:.unshift lib unless $:.include? lib
+require 'cuukie'
 
-require 'cuukie/cli'
 include Cuukie::Cli
 options = parse_options ARGV
+exit if options[:help]
 
-exit if options.empty?
+port = options[:cuukieport]
 
-server_command = "ruby #{File.dirname(__FILE__)}/../lib/cuukie/server.rb #{options[:cuukieport]}"
+server_command = "ruby #{File.dirname(__FILE__)}/../lib/cuukie/server/server.rb #{port}"
 if options[:server]
   system server_command
   exit 
@@ -16,31 +17,24 @@ else
   Process.detach(fork { system "#{server_command} >/dev/null 2>&1" })
 end
 
-require 'cuukie/client'
 include Cuukie::Client
-wait_for_server_on_port options[:cuukieport]
-
-unless options[:keepserver]
-  at_exit do
-    require 'rest-client'
-    begin
-      RestClient.delete "http://localhost:#{options[:cuukieport]}"
-    rescue; end
-  end
-end
+wait_for_server_at port
+
+at_exit { stop_server_at port } unless options[:keepserver]
 
 if options[:showpage]
   require 'launchy'
-  Launchy.open("http://localhost:#{options[:cuukieport]}")
+  Launchy.open "http://localhost:#{port}"
 else
-  puts "View your features at http://localhost:#{options[:cuukieport]}" 
+  puts "View your features at http://localhost:#{port}" 
 end
 
-# TODO: auto-require formatter (warning: if you tell Cucumber to --require
-# something, it will want to --require everything!)
-system "cucumber #{ARGV.join(' ')} --format cuukie"
+require 'cucumber'
+runtime = Cucumber::Runtime.new
+runtime.load_programming_language('rb')
+Cucumber::Cli::Main.new(ARGV + ['--format', 'cuukie']).execute!(runtime)
 
 unless options[:nowait]
-  puts 'Press a key to exit'
-  gets
+  puts 'RETURN to exit'
+  STDIN.getc
 end

data/cuukie.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "cuukie"
-  s.version = "0.2.2"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Paolo \"Nusco\" Perrotta"]
-  s.date = "2011-12-15"
+  s.date = "2011-12-16"
   s.description = "A drop-in replacement for the \"cucumber\" command. It shows running features on a web page."
   s.email = "paolo.nusco.perrotta@gmail.com"
   s.executables = ["cuukie"]
@@ -34,11 +34,11 @@ Gem::Specification.new do |s|
     "lib/cuukie/client.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",
+    "lib/cuukie/server/public/cucumber.css",
+    "lib/cuukie/server/public/cuukie.js",
+    "lib/cuukie/server/public/jquery-1.7.min.js",
+    "lib/cuukie/server/server.rb",
+    "lib/cuukie/server/views/index.erb",
     "spec/cli_spec.rb",
     "spec/code_snippets_spec.rb",
     "spec/commands_spec.rb",
@@ -49,8 +49,7 @@ Gem::Specification.new do |s|
     "spec/test_project/features/3_failed_background.feature",
     "spec/test_project/features/4_exception_with_no_source.feature",
     "spec/test_project/features/step_definitions/exception_steps.rb",
-    "spec/test_project/features/step_definitions/main_steps.rb",
-    "spec/test_project/features/support/formatters.rb"
+    "spec/test_project/features/step_definitions/main_steps.rb"
   ]
   s.homepage = "http://github.com/nusco/cuukie"
   s.licenses = ["MIT"]

data/doc/backlog.txt

@@ -1,15 +1,11 @@
-MMF 0.2.1
-  - "ruby bug" fixed
   - better error messages
-  - work on any cucumber project out of the box (no need to add require())
-MMF 0.2.2
   - don't launch server if it's already up
   - give detailed instructions if the port is unavailable 
-MMF 0.2.3
+MMF 
   - deal with Scenario Examples
-MMF 0.2.4
+MMF 
   - show incomplete wrap-up for steps/scenarios
-MMF 0.2.5
+MMF 
   - open/close steps
 MMF 1.0.0
   - nice graphics
@@ -57,5 +53,8 @@ Then...
   numbers from tests b/c of this, and b/c they made the
   tests fragile. Try to put back the line numbers,
   and test under rbx)
+
+- windows compatibility
   
 - test against rbx
+

data/doc/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:
 
+- autorequire formatter
+- refactoring
+- debugging
+- debugging
+- multiple formatters
+- debugging
+- fix race condition, debugging
 - testing/debugging
 - testing
 - release

data/lib/cuukie.rb

@@ -1,2 +1,3 @@
+require File.dirname(__FILE__) + '/cuukie/cli'
 require File.dirname(__FILE__) + '/cuukie/formatter'
 require File.dirname(__FILE__) + '/cuukie/client'

data/lib/cuukie/cli.rb

@@ -24,7 +24,7 @@ module Cuukie
     
     def to_options_hash(options)
       result = { :cuukieport  => 4569 }
-      [:server, :showpage, :nowait, :keepserver].each do |opt|
+      [:server, :showpage, :nowait, :keepserver, :help].each do |opt|
         result[opt] = false
       end
       
@@ -34,12 +34,12 @@ module Cuukie
         opts.on("--cuukieport PORT", Integer, "Start the server on PORT") {|port| result[:cuukieport] = port }
         opts.on("--server", "Run as a server")                            { result[:server] = true           }
         opts.on("--showpage", "Open the features in the default browser") { result[:showpage] = true         }
-        opts.on("--nowait", "Don't wait for keypress on exit")            { result[:nowait] = true           }
+        opts.on("--nowait", "Don't wait for ENTER on exit")               { result[:nowait] = true           }
         opts.on("--keepserver", "Leave the server running on exit")       { result[:keepserver] = true       }
         
         opts.on_tail("-h", "--help", "You're looking at it") do
           puts opts.help
-          return {}
+          result[:help] = true
         end
       end.parse! options
       result

data/lib/cuukie/client.rb

@@ -2,20 +2,20 @@ require 'rest-client'
 
 module Cuukie
   module Client
-    def ping_on_port(port)
+    def ping_at(port)
       RestClient.get "http://localhost:#{port}/ping"
     end
 
-    def wait_for_server_on_port(port)
+    def wait_for_server_at(port)
       loop do
         begin
-          ping_on_port port
+          ping_at port
           return
         rescue; end
       end
     end
 
-    def stop_server_on_port(port)
+    def stop_server_at(port)
       # the server dies without replying, so we expect an error here
       RestClient.delete "http://localhost:#{port}/"
     rescue

data/lib/cuukie/{server.rb → server/server.rb}

@@ -1,3 +1,4 @@
+require 'rubygems'
 require 'sinatra/base'
 require 'json'
 require 'syntax/convertors/html'

data/spec/cli_spec.rb

@@ -74,8 +74,8 @@ describe "The parse_options method" do
     @out.should match /cuukie \d+\.\d+\.\d+/
   end
 
-  it "returns no result after showing help" do
-    parse_options(['-h']).should be_empty
+  it "leaves behind a help option after showing help" do
+    parse_options(['-h'])[:help].should be_true
   end
   
   it "consumes recognized options" do

data/spec/commands_spec.rb

@@ -13,29 +13,35 @@ describe "The cuukie formatter" do
   it "expects a server on localhost:4569 by default" do
     begin
       start_process "ruby bin/cuukie --server >/dev/null 2>&1"
-      wait_for_server_on_port 4569
+      wait_for_server_at 4569
       cmd = "cd spec/test_project && \
              cucumber features/1_show_scenarios.feature:9 \
-                      --format cuukie >#{@out.path}"
+                      --require ../../lib/cuukie \
+                      --require features \
+                      --format Cuukie::Formatter \
+                      >#{@out.path}"
       system(cmd).should be_true
       @out.read.should == ''
     ensure
-      stop_server_on_port 4569
+      stop_server_at 4569
     end
   end
 
   it "can point to a different server" do
     start_process "ruby bin/cuukie --server --cuukieport 4570 >/dev/null 2>&1"
     begin
-      wait_for_server_on_port 4570
+      wait_for_server_at 4570
       cmd = "cd spec/test_project && \
              cucumber features/1_show_scenarios.feature:9 \
                       CUUKIE_SERVER=http://localhost:4570 \
-                      --format cuukie >#{@out.path}"
+                      --require ../../lib/cuukie \
+                      --require features \
+                      --format Cuukie::Formatter \
+                      >#{@out.path}"
       system(cmd).should be_true
       @out.read.should == ''
     ensure
-      stop_server_on_port 4570
+      stop_server_at 4570
     end
   end
   
@@ -43,7 +49,10 @@ 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}"
+                    --require ../../lib/cuukie \
+                    --require features \
+                    --format Cuukie::Formatter \
+                    >#{@out.path}"
     system(cmd).should be_true
     @out.read.should match 'I cannot find the cuukie server on http://some.server:4570'
   end
@@ -67,7 +76,7 @@ describe "The cuukie command" do
                             >/dev/null 2>&1"
 
     html.should match "Passing Scenario"
-    stop_server_on_port 4569
+    stop_server_at 4569
   end
   
   it "gives instructions to access the page if --showpage is not enabled" do
@@ -89,28 +98,28 @@ describe "The cuukie command" do
                             --cuukieport 4570 \
                             >/dev/null 2>&1"
     
-    lambda { ping_on_port 4570 }.should raise_error
+    lambda { ping_at 4570 }.should raise_error
   end
 
   describe "when used with the --server switch" do
-    it "starts the Cuukie server on port 4569 by default" do
+    it "starts the 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
+      wait_for_server_at 4569
+      stop_server_at 4569
     end
 
-    it "starts the Cuukie server on any given port" do
+    it "starts the 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
+      wait_for_server_at 4570
+      stop_server_at 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
+      wait_for_server_at 4569
       html.should match /Cuukie/
       html.should_not match /Feature:/
-      stop_server_on_port 4569
+      stop_server_at 4569
     end
   end
 end

data/spec/cuukie_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe 'Cuukie' do
   describe "before Cucumber has run" do
     before(:all) { start_server }
-    after(:all) { stop_server_on_port 4569 }
+    after(:all) { stop_server_at 4569 }
     
     it "shows a grey status bar" do
       html.should match /undefinedColors\('cucumber-header'\)/
@@ -26,7 +26,7 @@ describe 'Cuukie' do
   shared_examples_for "while Cucumber is running" do
     require 'ostruct'
     
-    after(:all) { stop_server_on_port 4569 }
+    after(:all) { stop_server_at 4569 }
 
     it "shows a grey status bar" do
       html.should match /undefinedColors\('cucumber-header'\)/
@@ -96,7 +96,7 @@ describe 'Cuukie' do
       run_cucumber
     end
 
-    after(:all) { stop_server_on_port 4569 }
+    after(:all) { stop_server_at 4569 }
 
     it "cleans up previous data at the beginning of a run" do
       run_cucumber

data/spec/spec_helper.rb

@@ -10,7 +10,10 @@ end
 
 def run_cucumber(feature = '')
   system "cd spec/test_project &&
-          cucumber features/#{feature} --format cuukie"
+          cucumber features/#{feature} \
+                   --require ../../lib/cuukie \
+                   --require features \
+                   --format Cuukie::Formatter"
 end
 
 require 'rest-client'
@@ -28,5 +31,5 @@ end
 
 def start_server
   start_process "ruby bin/cuukie --server >/dev/null 2>&1"
-  wait_for_server_on_port 4569
+  wait_for_server_at 4569
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cuukie
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-15 00:00:00.000000000 Z
+date: 2011-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
-  requirement: &70200450735700 !ruby/object:Gem::Requirement
+  requirement: &70137970663940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '1.3'
   type: :runtime
   prerelease: false
-  version_requirements: *70200450735700
+  version_requirements: *70137970663940
 - !ruby/object:Gem::Dependency
   name: cucumber
-  requirement: &70200450735220 !ruby/object:Gem::Requirement
+  requirement: &70137976108560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '1.1'
   type: :runtime
   prerelease: false
-  version_requirements: *70200450735220
+  version_requirements: *70137976108560
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &70200450734740 !ruby/object:Gem::Requirement
+  requirement: &70137976108080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: '1.6'
   type: :runtime
   prerelease: false
-  version_requirements: *70200450734740
+  version_requirements: *70137976108080
 - !ruby/object:Gem::Dependency
   name: launchy
-  requirement: &70200450734260 !ruby/object:Gem::Requirement
+  requirement: &70137976107600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70200450734260
+  version_requirements: *70137976107600
 - !ruby/object:Gem::Dependency
   name: syntax
-  requirement: &70200450733780 !ruby/object:Gem::Requirement
+  requirement: &70137976107120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70200450733780
+  version_requirements: *70137976107120
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70200450733300 !ruby/object:Gem::Requirement
+  requirement: &70137976106640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70200450733300
+  version_requirements: *70137976106640
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70200450732820 !ruby/object:Gem::Requirement
+  requirement: &70137976106160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,7 +87,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70200450732820
+  version_requirements: *70137976106160
 description: A drop-in replacement for the "cucumber" command. It shows running features
   on a web page.
 email: paolo.nusco.perrotta@gmail.com
@@ -114,11 +114,11 @@ files:
 - lib/cuukie/client.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
+- lib/cuukie/server/public/cucumber.css
+- lib/cuukie/server/public/cuukie.js
+- lib/cuukie/server/public/jquery-1.7.min.js
+- lib/cuukie/server/server.rb
+- lib/cuukie/server/views/index.erb
 - spec/cli_spec.rb
 - spec/code_snippets_spec.rb
 - spec/commands_spec.rb
@@ -130,7 +130,6 @@ files:
 - spec/test_project/features/4_exception_with_no_source.feature
 - spec/test_project/features/step_definitions/exception_steps.rb
 - spec/test_project/features/step_definitions/main_steps.rb
-- spec/test_project/features/support/formatters.rb
 homepage: http://github.com/nusco/cuukie
 licenses:
 - MIT
@@ -146,7 +145,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2139021619406699883
+      hash: 787056299110256408
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:

data/spec/test_project/features/support/formatters.rb

@@ -1 +0,0 @@
-require '../../lib/cuukie'