bumps 0.0.1

data/History.txt

@@ -0,0 +1,5 @@
+== 0.0.1 2009-07-09
+
+* 1 major enhancement:
+  * Initial release
+  * mmmm...has that new gem smell

data/Manifest.txt

@@ -0,0 +1,36 @@
+History.txt
+Manifest.txt
+README.rdoc
+Rakefile
+TODO
+examples/feature_server
+features/pull_remote_features.feature
+features/push_feature_results.feature
+features/steps/command_output.rb
+features/steps/cucumber_run.rb
+features/steps/env.rb
+features/steps/feature_report.rb
+features/steps/feature_server.rb
+features/steps/helpers/scenario_process.rb
+lib/bumps.rb
+lib/bumps/configuration.rb
+lib/bumps/feature.rb
+lib/bumps/hook_tasks.rb
+lib/bumps/pre_feature_load_hook.rb
+lib/bumps/remote_feature.rb
+lib/bumps/results_push_formatter.rb
+script/console
+script/destroy
+script/generate
+spec/bumps/configuration_spec.rb
+spec/bumps/feature_spec.rb
+spec/bumps/hook_tasks_spec.rb
+spec/bumps/pre_feature_load_hook_spec.rb
+spec/bumps/remote_feature_spec.rb
+spec/bumps/results_push_formatter_spec.rb
+spec/bumps_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+tasks/rspec.rake
+test_features/remote_content/destroy_dr_thaddeus_venture.feature
+test_features/requires/env.rb

data/README.rdoc

@@ -0,0 +1,59 @@
+= Bumps
+
+* http://github.com/brentsnook/bumps
+
+Bumps shakes up {Cucumber}[http://cukes.info] by allowing you to pull feature content and push run results to and from a remote server. This means that your feature files no longer need to live with your steps and other code. This also means that you can publish the results of a Cucumber run to another system.
+
+See the {wiki}[http://wiki.github.com/brentsnook/bumps] for more details.
+
+== Installation
+
+  sudo gem install bumps
+
+=== Building the Gem yourself
+
+Grab the code from github:
+
+  git clone git://github.com/brentsnook/bumps.git
+  cd bumps
+  rake install_gem
+
+== How do I use it?
+
+First, start up a server that meets the {push/pull contract}[http://wiki.github.com/brentsnook/bumps/push-pull-contract].
+
+Secondly, bung this inside of your *env.rb* (or equivalent, just make sure it is under the feature directory):
+
+  require 'bumps'
+  Bumps.configure { use_server 'http://mycompliantserver.com' }
+
+Lastly, just run Cukes as normal.
+
+  cucumber my_feature_directory
+
+Bumps will pull feature files into the specified feature directory, run cukes and then push the results back to the server.
+
+== License
+
+(The MIT License)
+
+Copyright (c) 2009 Brent Snook http://fuglylogic.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/Rakefile

@@ -0,0 +1,29 @@
+%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
+require File.dirname(__FILE__) + '/lib/bumps'
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new('bumps', Bumps::VERSION) do |p|
+  p.developer 'Brent Snook', 'brent@fuglylogic.com'
+  p.summary = %q{Remote feature management for Cucumber.}
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.rubyforge_name = p.name
+  p.extra_deps = [
+    ['cucumber', ">= #{Bumps::LOWEST_SUPPORTED_CUCUMBER_VERSION}"],
+    ['nokogiri','>= 1.1.1'],
+  ]
+  p.extra_dev_deps = [
+    ['newgem', ">= #{::Newgem::VERSION}"],
+    ['rspec', '>= 1.2.7'],
+  ]
+
+  p.clean_globs |= %w[**/.DS_Store tmp *.log]
+  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
+  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
+  p.rsync_args = '-av --delete --ignore-errors'
+end
+
+require 'newgem/tasks' # load /tasks/*.rake
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+task :default => [:spec, :features]

data/TODO

@@ -0,0 +1,20 @@
+- tag release
+- release gem on rubyforge
+
+- register google group and update wiki doco
+
+
+- add blog post on what it is, how to use it and why
+
+- publish on twitter
+- post to wave google group (links to blog)
+- post to cucumber google group (links to blog)
+
+--- LATER ---
+
+- add validation for config and some nicer messages?
+- get rid of treetop gibberish
+- can it be more of a synch than a straight clobber??? for speed mainly
+- extract process control logic out into a new gem
+- support obtaining details for a single feature ???
+- create lighthouse project

data/examples/feature_server

@@ -0,0 +1,61 @@
+require 'webrick'
+require 'stringio'
+
+include WEBrick
+
+class PullServlet < HTTPServlet::AbstractServlet
+
+  def do_GET(request, response)
+    response.body = feature_content
+    response['Content-Type'] = 'text/xml'
+  end
+
+  private
+
+  def feature_content
+    content = StringIO.new 
+    content.puts '<?xml version="1.0"?>'
+    content.puts '<features>'
+
+    Dir.glob(features_pattern).each do |file|
+      content << feature_within(file) if File.file?(file)
+    end
+
+    content.puts '</features>'
+
+    content.string
+  end
+
+  def feature_within file
+    relative_path = file[(@options[0].length)..-1]
+    "<feature name=\"#{relative_path}\"> #{IO.read(file)}\n  </feature>"
+  end
+
+  def features_pattern
+    File.join @options[0], '**', '*'
+  end
+
+end
+
+class PushServlet < HTTPServlet::AbstractServlet
+
+  def do_POST(request, response)
+    File.open(@options[0], 'w'){ |f| f.write(request.query['results']) }
+    response['Content-Type'] = 'text/html'
+  end
+
+end
+
+server = WEBrick::HTTPServer.new :Port => 1981
+
+server.mount "/features/content", PullServlet, ARGV[0]
+server.mount "/features/results", PushServlet, ARGV[1]
+
+%w(INT TERM).each do |signal|
+  trap signal do
+    server.shutdown
+    exit!
+  end
+end
+
+server.start

data/features/pull_remote_features.feature

@@ -0,0 +1,17 @@
+Feature: Pull remote features
+
+  As a developer
+  I want to pull Cucumber features from a remote location
+  So that the features can be authored using a separate tool
+    
+  Scenario: Remote features pulled successfully
+
+    Given that a feature server is running
+    When a cucumber run is performed
+    Then the feature report will contain all remote features
+
+  Scenario: Feature server not reachable
+
+    Given that a feature server is not running
+    When a cucumber run is performed
+    Then the command output should show that features could not be pulled

data/features/push_feature_results.feature

@@ -0,0 +1,11 @@
+Feature: Serve feature results
+
+  As a remote feature authoring tool
+  I want to be informed of the results of a feature run
+  So that I can format my local feature data accordingly
+    
+  Scenario: Push all feature results after a run
+
+    Given that a feature server is running
+    When a cucumber run is performed
+    Then the results of the feature run will be sent to the feature server

data/features/steps/command_output.rb

@@ -0,0 +1,3 @@
+Then /^the command output should show that features could not be pulled$/ do
+  command_output.should match(/Could not pull features/)
+end

data/features/steps/cucumber_run.rb

@@ -0,0 +1,3 @@
+Given /^a cucumber run is performed$/ do
+  ScenarioProcess.run_and_wait "cucumber -o #{feature_report_file} -r #{test_require_file} #{test_features_directory}", 'cucumber'
+end

data/features/steps/env.rb

@@ -0,0 +1,88 @@
+require File.dirname(__FILE__) + "/../../lib/bumps"
+
+gem 'cucumber'
+require 'cucumber'
+gem 'rspec'
+require 'spec'
+
+module CucumberWorld
+
+  def feature_report_file
+    File.expand_path File.join(root, 'tmp', 'cucumber.out')
+  end
+  
+  def feature_report
+    IO.read feature_report_file
+  end
+  
+  def command_output
+    IO.read command_output_file
+  end
+  
+  def feature_server_script
+    File.expand_path File.join(root, 'examples', 'feature_server')
+  end
+
+  def push_request_file
+    File.expand_path File.join(root, 'tmp', 'results.xml')
+  end
+  
+  def push_request
+    IO.read push_request_file
+  end
+  
+  def test_require_file
+    File.expand_path File.join(root, 'test_features', 'requires', 'env.rb')
+  end
+  
+  def test_features_directory
+    File.expand_path File.join(root, 'tmp')
+  end
+  
+  def feature_server_command
+    "ruby #{feature_server_script} #{remote_features_directory} #{push_request_file}"
+  end  
+  
+  def each_feature
+    Dir.glob("#{remote_features_directory}/**/*") do |feature_file|
+      content = IO.read(feature_file).strip
+      yield content.first.strip
+    end
+  end
+  
+  def clean
+    FileUtils.remove_entry_secure test_features_directory
+    FileUtils.mkdir test_features_directory
+    [
+      feature_report_file,
+      push_request_file
+    ].each do |file|
+      FileUtils.remove_entry_secure file if File.exist? file
+    end
+  end
+  
+  private
+  
+  def root
+    File.expand_path File.join(File.dirname(__FILE__), '..', '..')
+  end
+  
+  def command_output_file
+    File.expand_path File.join(root, 'tmp', 'cucumber.log')
+  end
+  
+  def remote_features_directory
+    File.expand_path File.join(root, 'test_features', 'remote_content')
+  end
+
+end
+
+World CucumberWorld
+
+Before do
+  clean
+end
+
+After do
+  ScenarioProcess.kill_all
+end

data/features/steps/feature_report.rb

@@ -0,0 +1,6 @@
+Then /^the feature report will contain all remote features$/ do
+  each_feature do |feature|
+    feature_report.should match(/#{feature}/)
+  end
+end
+

data/features/steps/feature_server.rb

@@ -0,0 +1,14 @@
+Given /^that a feature server is running$/ do
+  ScenarioProcess.run feature_server_command, 'feature_server'
+end
+
+Given /^that a feature server is not running$/ do
+  ScenarioProcess.kill feature_server_command
+end
+
+Then /^the results of the feature run will be sent to the feature server$/ do
+  each_feature do |feature|
+    push_request.should match(/#{feature}/)
+  end
+end
+

data/features/steps/helpers/scenario_process.rb

@@ -0,0 +1,67 @@
+class ScenarioProcess
+
+  @commands = []
+  
+  def initialize command, name
+    @command = command
+    @name = name
+  end  
+  
+  def run
+    remove log
+    IO.popen(full_command).sync = true
+    wait_for log
+  end
+  
+  def run_and_wait
+    remove log
+    `#{full_command}`
+  end
+  
+  def self.run command, name
+    new(command,name).run
+    @commands << command
+  end
+ 
+  def self.run_and_wait command, name
+    new(command,name).run_and_wait
+  end
+  
+  def self.kill_all
+    @commands.each { |command| kill command }
+  end
+  
+  def self.kill command
+    # this method of killing stuff sucks, feels brittle
+    
+    `ps`.each do |process|
+      # the space at the front of the pattern is essential...
+      # otherwise this will only work intermittently; if the pid you want to kill
+      # is shorter than others in the process list then the group will not capture it        
+      matches = process.match /\s*(\d*).*#{Regexp.escape(command)}/
+      `kill #{matches[1]}` if matches
+    end
+  end
+  
+  private
+  
+  def log
+    File.expand_path(File.dirname(__FILE__) + "/../../../tmp/#{@name}.log")
+  end 
+  
+  def remove file
+    FileUtils.rm file, :force => true
+  end 
+  
+  def full_command
+    "(#{@command}) > #{log} 2>&1"
+  end
+  
+  def wait_for file
+    until File.exists? file
+      sleep 0.2
+    end
+    
+  end
+
+end

data/lib/bumps.rb

@@ -0,0 +1,25 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'rubygems'
+require 'cucumber'
+
+[
+  'remote_feature',
+  'feature',
+  'configuration',
+  'results_push_formatter',
+  'hook_tasks',
+  'pre_feature_load_hook'
+].each {|file| require "bumps/#{file}"}
+
+module Bumps
+  
+  VERSION = '0.0.1'
+  LOWEST_SUPPORTED_CUCUMBER_VERSION = '0.3.11'
+  
+  def self.configure &block
+    Configuration.configure(&block)
+    PreFeatureLoadHook.register_on Cucumber::Cli::Main
+  end
+end