cuukie 0.1.4 → 0.2.0

data/Gemfile

@@ -1,8 +1,9 @@
 source :rubygems
 
-gem 'sinatra'
-gem 'rest-client'
-gem 'cucumber'
+gem 'sinatra',      "~> 1.3"
+gem 'cucumber',     "~> 1.1"
+gem 'rest-client',  "~> 1.6"
+gem 'launchy'
 gem 'syntax'
 
 group :development do

data/README.markdown

@@ -4,48 +4,48 @@ Cuukie shows your Cucumber results on a web page.
 
 [![Build Status](https://secure.travis-ci.org/nusco/cuukie.png)](http://travis-ci.org/nusco/cuukie.png)
 
-## Using it
-
-Install Cuukie:
+Install Cuukie via Bundler, or directly with:
 
     gem install cuukie
 
-(Or better still, you can use Bundler).
-
-Require Cuukie from any file in your _features/support_ directory:
+Go to your Cucumber folder and add this line to any file in _features/support_:
 
     require 'cuukie'
 
-Add this line to any Ruby file in your _features/support_ directory:
+Run Cuukie:
 
-    require 'cuukie'
+    cuukie --showpage
+
+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.
 
-Start the Cuukie server from a terminal window:
+## Advanced Cuuking
 
-    cuukie_server
+Cuukie is actually two things: a server that displays running features on a web page, and a Cucumber formatter that sends data to the server. You can run these two components independently. For example, you might want to keep the server running all the time:
 
-Leave the server running. When you run Cucumber, ask it to use the _cuukie_ formatter:
+    cuukie --server
+
+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, open this page in a browser:
 
-    http://localhost:4569
+To look at the results, visit:
 
-## Custom port/server
+    http://localhost:4569
 
-You can pick a port when you start the cuukie_server...
+You can pick a port when you start the cuukie server...
 
-    cuukie_server 4570
+    cuukie --server --cuukieport 4570
 
 ...and you can tell the cuukie formatter where to look for the server:
 
     cucumber --format cuukie CUUKIE_SERVER=http://my.server:4570
 
-## Cuukie Vision
+This stuff is useful if you want to put the Cuukie server on your build machine. For more options:
+
+    cuukie --help
 
-Right now, Cuukie is not any more useful than Cucumber's own HTML formatter. My plan is to make it more dynamic. You'll be able to see your steps as they run, just like you do with the default command-line formatter - but on a web page. Cuukie wants to be a good choice both when you want to run Cucumber tests locally, and when you want to show Cucumber tests on your build machine.
+Enjoy!
 
 ## License
 
-MIT License. Copyright (c) 2011 Paolo "Nusco" Perrotta. I ripped a few lines of code off Cucumber's HTML formatter.
+MIT License. Copyright (c) 2011 Paolo "Nusco" Perrotta. I also ripped a few lines of code off Cucumber's HTML formatter.

data/Rakefile

@@ -7,8 +7,8 @@ namespace :test do
   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 :smoke do
+  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
@@ -19,8 +19,8 @@ Jeweler::Tasks.new do |gem|
   gem.name = "cuukie"
   gem.homepage = "http://github.com/nusco/cuukie"
   gem.license = "MIT"
+  gem.description = %Q{A drop-in replacement for the "cucumber" command. It shows running features on a web page.}
   gem.summary = %Q{A continuous view on Cucumber features}
-  gem.description = %Q{Shows Cucumber results on a web page as they run.}
   gem.email = "paolo.nusco.perrotta@gmail.com"
   gem.authors = ['Paolo "Nusco" Perrotta']
 end

data/VERSION

@@ -1 +1 @@
-0.1.4
+0.2.0

data/bin/cuukie

@@ -0,0 +1,42 @@
+#!/usr/bin/env ruby
+lib = File.dirname(__FILE__) + '/../lib'
+$:.unshift lib unless $:.include? lib
+
+require 'cuukie/cli'
+include Cuukie::Cli
+options = parse_options ARGV
+
+exit if options.empty?
+
+server_command = "ruby #{File.dirname(__FILE__)}/../lib/cuukie/server.rb #{options[:cuukieport]}"
+if options[:server]
+  system server_command
+  exit 
+else
+  Process.detach(fork { system "#{server_command} >/dev/null 2>&1" })
+end
+
+unless options[:keepserver]
+  at_exit do
+    require 'rest-client'
+    begin
+      RestClient.delete "http://localhost:#{options[:cuukieport]}"
+    rescue; end
+  end
+end
+
+if options[:showpage]
+  require 'launchy'
+  Launchy.open("http://localhost:#{options[:cuukieport]}")
+else
+  puts "View your features at http://localhost:#{options[:cuukieport]}" 
+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"
+
+unless options[:nowait]
+  puts 'Press a key to exit'
+  gets
+end

data/cuukie.gemspec

@@ -5,14 +5,14 @@
 
 Gem::Specification.new do |s|
   s.name = "cuukie"
-  s.version = "0.1.4"
+  s.version = "0.2.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-08"
-  s.description = "Shows Cucumber results on a web page as they run."
+  s.date = "2011-12-15"
+  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_server"]
+  s.executables = ["cuukie"]
   s.extra_rdoc_files = [
     "README.markdown"
   ]
@@ -24,19 +24,21 @@ Gem::Specification.new do |s|
     "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",
@@ -59,24 +61,27 @@ Gem::Specification.new do |s|
     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_runtime_dependency(%q<sinatra>, ["~> 1.3"])
+      s.add_runtime_dependency(%q<cucumber>, ["~> 1.1"])
+      s.add_runtime_dependency(%q<rest-client>, ["~> 1.6"])
+      s.add_runtime_dependency(%q<launchy>, [">= 0"])
       s.add_runtime_dependency(%q<syntax>, [">= 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<sinatra>, ["~> 1.3"])
+      s.add_dependency(%q<cucumber>, ["~> 1.1"])
+      s.add_dependency(%q<rest-client>, ["~> 1.6"])
+      s.add_dependency(%q<launchy>, [">= 0"])
       s.add_dependency(%q<syntax>, [">= 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<sinatra>, ["~> 1.3"])
+    s.add_dependency(%q<cucumber>, ["~> 1.1"])
+    s.add_dependency(%q<rest-client>, ["~> 1.6"])
+    s.add_dependency(%q<launchy>, [">= 0"])
     s.add_dependency(%q<syntax>, [">= 0"])
     s.add_dependency(%q<rake>, [">= 0"])
     s.add_dependency(%q<jeweler>, [">= 0"])

data/doc/backlog.txt

@@ -1,12 +1,12 @@
-MMF 0.1.5
-  - show incomplete suite
-  - show undefined Scenarios/suite
-  - show undefined Steps
-  - show incomplete wrap-up for steps/scenarios
-  - show incomplete running time
-MMF 0.1.6
+MMF 0.2.1
+  - better error messages
+  - work on any cucumber project out of the box (no need to add require())
+MMF 0.2.2
   - deal with Scenario Examples
+MMF 0.2.3
   - open/close steps
+MMF 0.2.4
+  - show incomplete wrap-up for steps/scenarios
 MMF 1.0.0
   - nice graphics
   - self-updating Steps
@@ -22,6 +22,9 @@ Then...
 
 - filter by tag
 
+- default policy for open/close elements (like: close
+  successfull scenarios/steps, open unsuccessful ones)
+  
 - instead of showing scenarios that appear one by one,
   show the entire suite ASAP, and then proceed to make
   each scenario red or green (or whatever). this

data/doc/pomodoro.txt

@@ -1,6 +1,28 @@
 I use this file to track my own work on the project. Each line is a pomodoro (a 25' slot).
 Latest pomodoro comes first:
 
+- release
+- refactoring and README
+- refactoring
+- command-line options
+- roll bin/cuukie_server into bin/cuukie
+- command-line options
+- command-line options
+- command-line options
+- command-line options
+- command-line options
+- command-line options
+- command-line options
+- hide stats until run completion
+- show incomplete running time
+- show incomplete running time
+- fix feature keywords
+- "cuukie" command
+- "cuukie" command
+- show undefined scenarios and steps
+- show incomplete status bar suite
+- refactoring
+- refactoring
 - show code snippets (and release 0.1.4)
 - show code snippets
 - show code snippets

data/lib/cuukie.rb

@@ -1 +1 @@
-require File.dirname(__FILE__) + '/cuukie/cucumber/formatter/cuukie'
+require File.dirname(__FILE__) + '/cuukie/formatter'

data/lib/cuukie/cli.rb

@@ -0,0 +1,48 @@
+require 'optparse'
+
+Version = File.read File.dirname(__FILE__) + '/../../VERSION' unless Kernel.const_defined? :Version
+
+module Cuukie
+  module Cli
+    def parse_options(options)
+      to_options_hash extract_cuukie_options(options)
+    end
+
+    private
+
+    def extract_cuukie_options(options)
+      result = []
+      ['--server', '--showpage', '--nowait', '--keepserver', '-h', '--help'].each do |opt|
+        result << options.delete(opt) 
+      end
+      if (options.include? '--cuukieport')
+        port = options.delete_at(options.index('--cuukieport') + 1)
+        result << options.delete('--cuukieport') << port
+      end
+      result.compact!
+    end
+    
+    def to_options_hash(options)
+      result = { :cuukieport  => 4569 }
+      [:server, :showpage, :nowait, :keepserver].each do |opt|
+        result[opt] = false
+      end
+      
+      OptionParser.new do |opts|
+        opts.banner = "cuukie #{::Version}\nUsage: cuukie [options] [cucumber-options]"
+        
+        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("--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 {}
+        end
+      end.parse! options
+      result
+    end
+  end
+end

data/lib/cuukie/code_snippets.rb

@@ -0,0 +1,25 @@
+module Cuukie
+  module CodeSnippets
+    def code_snippet(file, line)
+      return null_snippet unless File.exist? file
+
+      all_lines = File.open(file) {|f| f.readlines}
+      return null_snippet unless line <= all_lines.size
+
+      first_line = [1, line - 2].max
+      
+      { :raw_lines   => all_lines[(first_line - 1)..line].join,
+        :first_line  => first_line,
+        :marked_line => line }
+    end
+
+    def backtrace_to_snippet(backtrace)
+      return null_snippet unless backtrace[0] =~ /(.*):(\d+)/
+      code_snippet $1, $2.to_i
+    end
+    
+    private
+    
+    def null_snippet; Hash.new; end
+  end
+end

data/lib/cuukie/formatter.rb

@@ -0,0 +1,88 @@
+require File.dirname(__FILE__) + '/code_snippets'
+require 'rest-client'
+require 'json'
+
+module Cuukie
+  class Formatter
+    include CodeSnippets
+    
+    def initialize(*)
+      @server = ENV['CUUKIE_SERVER'] || 'http://localhost:4569'
+      RestClient.get "#{@server}/ping"
+    rescue
+      puts "I cannot find the cuukie server on #{@server}."
+      puts "Please start the server with cuukie --server."
+      exit
+    end
+
+    def before_features(*)
+      post 'before_features'
+    end
+
+    def before_feature(feature)
+      post 'before_feature', { :short_name => feature.short_name,
+                               :description => feature.description }
+    end
+
+    def feature_name(keyword, *)
+      post 'feature_name', { :keyword => keyword }
+    end
+    
+    def scenario_name(keyword, name, file_colon_line, *)
+      post 'scenario_name', { :keyword => keyword,
+                              :name => name,
+                              :file_colon_line => file_colon_line }
+    end
+
+    def before_step(step)
+      post 'before_step', { :keyword => step.keyword,
+                            :name => step.name,
+                            :file_colon_line => step.file_colon_line }
+    end
+
+    def before_table_row(*)
+      post 'before_table_row'
+    end
+    
+    def table_cell_value(value, *)
+      post 'table_cell_value', { :value => value }
+    end
+    
+    def doc_string(string)
+      post 'doc_string', { :multiline_string => string }
+    end
+
+    def exception(exception, *)
+      source = backtrace_to_snippet(exception.backtrace)
+      post 'exception', { :message => exception.message,
+                          :backtrace => exception.backtrace.join('\n'),
+                          :raw_lines => source[:raw_lines],
+                          :first_line => source[:first_line],
+                          :marked_line => source[:marked_line]  }
+    end
+    
+    def after_step_result(keyword, step_match, multiline_arg, status, *)
+      post 'after_step_result', { :status => status }
+    end
+
+    def after_steps(*)
+      post 'after_steps'
+    end
+    
+    def after_features(features)
+      post 'after_features', { :duration => features.duration }
+    end
+
+    private
+
+    def post(url, params = {})
+      RestClient.post "#{@server}/#{url}", params.to_json
+    end
+  end
+end
+
+require 'cucumber/cli/options'
+Cucumber::Cli::Options::BUILTIN_FORMATS['cuukie'] = [
+  'Cuukie::Formatter',
+  'Shows Cucumber results on a web page as they run'
+]