bumps 0.0.1

data/lib/bumps/configuration.rb

@@ -0,0 +1,48 @@
+require 'uri'
+
+module Bumps
+  class Configuration
+    
+    def self.method_missing method, *args, &block
+      singleton.send method, *args, &block  
+    end
+    
+    def self.singleton
+      @singleton = Configuration.new unless defined? @singleton
+      @singleton 
+    end
+    
+    def initialize
+      @config = {
+        :output_stream => STDOUT,
+        :results_formatter => Cucumber::Formatter::Html
+      }
+    end
+    
+    def method_missing method, *args
+      return @config[method] if @config.has_key?(method)
+      method.to_s.end_with?('=') ? @config[method.to_s.chop.to_sym] = args[0] : super(method, args)
+    end
+    
+    def configure &block
+      instance_eval(&block)
+    end
+    
+    def use_server server
+      @config[:pull_url] = URI.join(server, 'features/content').to_s
+      @config[:push_url] = URI.join(server, 'features/results').to_s
+    end
+    
+    def push_to url
+      @config[:push_url] = url
+    end
+    
+    def pull_from url
+      @config[:pull_url] = url
+    end
+    
+    def format_results_with formatter_class
+      @config[:results_formatter] = formatter_class
+    end
+  end
+end  

data/lib/bumps/feature.rb

@@ -0,0 +1,54 @@
+module Bumps
+  class Feature
+    
+    attr_accessor :name, :content
+    
+    def initialize
+      @name = ''
+      @content = ''
+    end  
+    
+    def self.pull
+      Configuration.output_stream << "\nRetrieving features from #{Configuration.pull_url} ...\n"
+      begin
+        features = RemoteFeature.fetch(Configuration.pull_url)
+      rescue Exception => e
+        Configuration.output_stream << "\nCould not pull features: #{e}\n"
+        features = []
+      end
+        
+      features.each do |feature|
+        feature.write_to Configuration.feature_directory
+      end
+      Configuration.output_stream << "Wrote #{features.size} features to #{Configuration.feature_directory}\n\n"
+    end
+    
+    def write_to directory
+      write_content_to absolute_path_under(directory)
+    end
+    
+    def write_content_to file_path
+      FileUtils.makedirs File.dirname(file_path)
+      File.open(file_path, 'w') {|f| f.write(content) }
+    end
+    
+    def absolute_path_under directory
+      expanded_directory = File.expand_path directory
+      file_path = File.expand_path(File.join(directory, name))
+      unless file_path.start_with? expanded_directory
+         raise "Could not write feature to path #{file_path}, path is not below #{expanded_directory}"
+       end
+      file_path
+    end
+    
+    def eql? match
+      self.instance_variables.each do |attr|
+        self_attr = self.instance_variable_get(attr)
+        match_attr = match.instance_variable_get(attr)
+        return false unless self_attr == match_attr
+      end
+        
+      true
+    end   
+  end
+end  

data/lib/bumps/hook_tasks.rb

@@ -0,0 +1,25 @@
+module Bumps::HookTasks
+  
+  SetFeatureDirectoryTask = lambda do
+    # nasty? hell yeah. got any better ideas? need access to that protected method...
+    feature_directories = configuration.send :feature_dirs
+    
+    error_message = 'More than one feature directory/file was specified. ' +
+          'Please only specify a single feature directory when using bumps'
+    raise error_message if feature_directories.size > 1
+    Bumps::Configuration.feature_directory = feature_directories.first
+  end
+  
+  PullFeaturesTask = lambda do
+    Bumps::Feature.pull 
+  end
+  
+  RegisterPushFormatterTask = lambda do
+    configuration.options[:formats]['Bumps::ResultsPushFormatter'] = Bumps::Configuration.output_stream
+  end
+  
+  SetOutputStreamTask = lambda do
+    Bumps::Configuration.output_stream = @out_stream
+  end
+  
+end

data/lib/bumps/pre_feature_load_hook.rb

@@ -0,0 +1,27 @@
+module Bumps
+  class PreFeatureLoadHook
+    def self.register_on clazz
+      clazz.class_eval do
+        
+        alias_method :original_load_plain_text_features, :load_plain_text_features
+        
+        def bumps_load_plain_text_features
+          Bumps::PreFeatureLoadHook.tasks.each { |task| instance_eval(&task) }
+          original_load_plain_text_features
+        end
+        
+        alias_method :load_plain_text_features, :bumps_load_plain_text_features
+
+      end
+    end
+    
+    def self.tasks
+      [
+        HookTasks::SetFeatureDirectoryTask,
+        Bumps::HookTasks::SetOutputStreamTask,
+        HookTasks::PullFeaturesTask,
+        HookTasks::RegisterPushFormatterTask
+      ]
+    end
+  end
+end

data/lib/bumps/remote_feature.rb

@@ -0,0 +1,23 @@
+require 'nokogiri'
+
+require 'open-uri'
+
+module Bumps
+  
+  class RemoteFeature
+    
+    def self.fetch location
+      parse(open(location){|f| f.read})
+    end
+    
+    def self.parse xml
+      document = Nokogiri::XML xml
+      document.search('feature').collect do |feature_element|
+        feature = Feature.new
+        feature.content = feature_element.text.strip
+        feature.name = feature_element.attribute('name').to_s
+        feature
+      end  
+    end  
+  end
+end  

data/lib/bumps/results_push_formatter.rb

@@ -0,0 +1,37 @@
+require 'cucumber/formatter/html'
+require 'net/http'
+
+module Bumps
+  class ResultsPushFormatter < Cucumber::Ast::Visitor
+    
+    def initialize(step_mother, io, options)
+      super step_mother
+      @step_mother = step_mother
+      @io = io
+      @options = options
+    end
+
+    def visit_features features
+      push results_of_running(features)
+    end
+    
+    def push results
+      uri = URI.parse(Bumps::Configuration.push_url)
+      response, body = Net::HTTP.post_form uri, {:results => results}
+      if response.code_type == Net::HTTPOK
+        @io << "Successfully pushed results to #{Bumps::Configuration.push_url}\n\n"
+      else
+        @io << "Failed to push results to #{Bumps::Configuration.push_url} - HTTP #{response.code}: \n#{response.body}\n\n"
+      end
+    end
+    
+    def results_of_running features
+      StringIO.open do |io|
+        formatter = Bumps::Configuration.results_formatter.new step_mother, io, options
+        formatter.visit_features features
+        
+        io.string
+      end
+    end
+  end
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/bumps.rb'}"
+puts "Loading bumps gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/spec/bumps/configuration_spec.rb

@@ -0,0 +1,78 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+describe Bumps::Configuration do
+  
+  before {@output_stream = mock('output stream').as_null_object}
+  subject {Bumps::Configuration.new}
+
+  it 'should provide access to the output stream' do
+    out_stream = mock 'out stream'
+    subject.output_stream = out_stream
+    
+    subject.output_stream.should == out_stream
+  end  
+  
+  it 'should allow configuration using a block' do
+    subject.should_receive(:configuration_call)
+    
+    subject.configure { configuration_call }
+  end
+  
+  it 'should derive pull URL from server' do
+    subject.use_server 'http://server'
+    
+    subject.pull_url.should == 'http://server/features/content'
+  end
+  
+  it 'should derive push URL from server' do
+    subject.use_server 'http://server'
+    
+    subject.push_url.should == 'http://server/features/results'
+  end
+  
+  it 'should be able to handle a server URL with a trailing slash' do
+    subject.use_server 'http://server/'
+    
+    subject.pull_url.should match(/^http:\/\/server\/[a-z]/)
+  end
+  
+  it 'should allow a non-default push URL to be specified' do
+    subject.push_to 'http://url.com'
+    
+    subject.push_url.should == 'http://url.com'    
+  end
+
+  it 'should allow a non-default pull URL to be specified' do
+    subject.pull_from 'http://url.com'
+    
+    subject.pull_url.should == 'http://url.com'    
+  end
+    
+  it 'should allow the feature directory to be set' do
+    subject.feature_directory = 'feature_directory'
+    
+    subject.feature_directory.should == 'feature_directory'
+  end
+  
+  it 'should allow results formatter to be specified' do
+    formatter_class = mock 'formatter class'
+    
+    subject.format_results_with formatter_class
+    
+    subject.results_formatter.should == formatter_class
+  end
+  
+  it 'should default the results formatter to Cucumber HTML formatter' do
+    subject.results_formatter.should == Cucumber::Formatter::Html
+  end
+  
+  it 'should allow access to configuration via class' do
+    singleton = mock 'singleton'
+    Bumps::Configuration.stub!(:singleton).and_return singleton
+    
+    singleton.should_receive(:configuration_property=).with 'arg'
+    
+    Bumps::Configuration.configuration_property = 'arg'
+  end
+  
+end

data/spec/bumps/feature_spec.rb

@@ -0,0 +1,119 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+describe Bumps::Feature do
+  describe 'when pulling' do
+    
+    before do
+      @output_stream = mock('output stream').as_null_object
+      Bumps::Configuration.stub!(:output_stream).and_return @output_stream
+    end
+
+    subject {Bumps::Feature}
+
+    it 'should write fetched features to the feature directory' do
+      Bumps::Configuration.stub!(:feature_directory).and_return 'feature_directory'
+      Bumps::Configuration.stub!(:pull_url).and_return 'location'
+  
+      features = 3.times.collect do |index|
+        feature = mock "feature #{index}"
+        feature.should_receive(:write_to).with 'feature_directory'
+        feature  
+      end
+     
+      Bumps::RemoteFeature.stub!(:fetch).with('location').and_return features 
+    
+      Bumps::Configuration.stub!(:feature_directory).and_return 'feature_directory'
+
+      subject.pull
+    end 
+    
+    it 'should output an error message if the features could not be fetched' do
+      Bumps::Configuration.stub! :pull_url
+      Bumps::Configuration.stub! :feature_directory
+      Bumps::RemoteFeature.stub!(:fetch).and_raise "exception message"
+      
+      @output_stream.should_receive(:<<).with "\nCould not pull features: exception message\n" 
+      
+      subject.pull
+    end
+    
+    it 'should display which location the features are being retrieved from' do
+      Bumps::RemoteFeature.stub!(:fetch).and_return []
+      Bumps::Configuration.stub!(:pull_url).and_return 'pull_url'
+      Bumps::Configuration.stub! :feature_directory
+      
+      @output_stream.should_receive(:<<).with "\nRetrieving features from pull_url ...\n"
+      
+      subject.pull
+    end  
+    
+    it 'should display the total number of features retrieved and location they were written to' do
+      features = 3.times.collect{|index| mock("feature #{index}").as_null_object}
+      Bumps::RemoteFeature.stub!(:fetch).and_return features
+      Bumps::Configuration.stub!(:feature_directory).and_return 'feature_directory'
+      Bumps::Configuration.stub! :pull_url
+      
+      @output_stream.should_receive(:<<).with "Wrote 3 features to feature_directory\n\n"
+      
+      subject.pull
+    end
+  end
+
+  describe 'when writing self to file' do 
+    
+    it 'should determine absolute path before writing contents' do
+      subject.stub(:absolute_path_under).with('directory').and_return 'path'
+      
+      subject.should_receive(:write_content_to).with 'path'
+      
+      subject.write_to 'directory'
+    end
+  end
+  
+  describe 'when determining absolute feature file path' do
+      
+    it 'should construct file name from expanded directory and feature name' do
+      subject.stub!(:name).and_return 'name'
+      
+      subject.absolute_path_under('/a/b/c/..').should == '/a/b/name'
+    end
+      
+    it 'should fail if given path does not resolve to one below the feature directory' do
+      subject.stub!(:name).and_return '../../etc/bashrc'
+      File.stub! :open # just in case
+      
+      lambda {subject.absolute_path_under '/stuff/features'}.should raise_error 'Could not write feature to path /etc/bashrc, path is not below /stuff/features'
+    end
+  end
+  
+  describe 'when writing content' do
+    
+    it 'should overwrite existing files' do
+      FileUtils.stub! :makedirs
+      
+      File.should_receive(:open).with anything, 'w'
+     
+      subject.write_content_to ''
+    end
+
+    it 'should force the creation of directories in the feature name' do
+      File.stub! :open
+      
+      FileUtils.should_receive(:makedirs).with 'features_dir/subdir'
+      
+      subject.write_content_to 'features_dir/subdir/featurename.feature'
+    end
+  
+    it 'should write content to file' do
+      FileUtils.stub! :makedirs
+      @file = mock 'file'
+      File.stub!(:open).and_yield @file
+      subject.stub!(:content).and_return 'content'
+    
+      @file.should_receive(:write).with 'content' 
+    
+      subject.write_content_to ''
+    end
+  end
+
+end