autocuke 0.1.0

data/.gitignore

@@ -0,0 +1,7 @@
+*.gem
+.bundle
+.DS_Store
+Gemfile.lock
+pkg/*
+test/dummy_hooks/after_migrate.rb
+test/dummy

data/Gemfile

@@ -0,0 +1,2 @@
+source "http://rubygems.org"
+gemspec

data/LICENSE

@@ -0,0 +1,27 @@
+Copyright (c) 2011 Spencer Steffen and Citrus Media Group.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+
+    * Redistributions in binary form must reproduce the above copyright notice,
+      this list of conditions and the following disclaimer in the documentation
+      and/or other materials provided with the distribution.
+
+    * Neither the name of Citrus Media Group nor the names of its
+      contributors may be used to endorse or promote products derived from this
+      software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,61 @@
+Autocuke
+========
+
+Autocuke uses EventMachine to watch your .feature files, then automatically runs cucumber as they change. Use with spork for total awesomeness.
+
+
+
+Installation
+------------
+
+If you're using bundler, just add this to your Gemfile:
+    
+    group :test do
+      gem "autocuke", "0.1.0"
+    end
+
+Then create a bundle-of-joy with:
+
+    bundle
+
+
+Otherwise, just install from rubygems like so:
+
+    (sudo) gem install autocuke
+
+
+That's it!
+
+
+Usage
+-----
+
+First, add an autocuke profile to your `config/cucumber.yml`.
+
+    autocuke: -r features --format pretty --strict
+
+
+Then boot up the "autocuke-file-watcher-5000":
+
+    autocuke
+    
+
+Then 'cuke away... and next time you save your .feature, autocuke will run it for you.
+
+
+Have fun!
+
+
+Contributors
+------------
+
+So far it's just me; Spencer Steffen. 
+
+If you'd like to help out feel free to fork and send me pull requests!
+
+
+
+License
+-------
+
+Copyright (c) 2011 Spencer Steffen and Citrus, released under the New BSD License All rights reserved.

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test' << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+task :default => :test

data/autocuke.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "autocuke/version"
+
+Gem::Specification.new do |s|
+  s.name        = "autocuke"
+  s.version     = Autocuke::VERSION
+  s.authors     = ["Spencer Steffen"]
+  s.email       = ["spencer@citrusme.com"]
+  s.homepage    = "https://github.com/citrus/autocuke"
+  s.summary     = %q{Autocuke uses EventMachine to watch your .feature files, then automatically runs cucumber as they change. Use with Spork for total awesomeness.}
+  s.description = %q{Autocuke uses EventMachine to watch your .feature files, then automatically runs cucumber as they change. Use with Spork for total awesomeness. Please see README.md for more details.}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+  # Runtime
+  s.add_dependency('eventmachine', '>= 0.12.10')
+  
+  # Development
+  s.add_development_dependency('dummier',          '>= 0.2.0')
+  s.add_development_dependency('shoulda',          '>= 2.11.3')
+  s.add_development_dependency('rails',            '>= 3.0.0')
+  s.add_development_dependency('cucumber-rails',   '>= 1.0.2')
+  s.add_development_dependency('database_cleaner', '>= 0.6.7')
+	s.add_development_dependency('sqlite3',          '>= 1.3.3')
+
+end

data/bin/autocuke

@@ -0,0 +1,39 @@
+#!/usr/bin/env ruby
+$:.unshift File.expand_path("../../lib", __FILE__)
+
+require "autocuke"
+require "optparse"
+
+options = OpenStruct.new
+options.root     = File.join(Dir.getwd)
+options.features = File.join(options.root, "features")
+options.verbose  = false
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: autocuke [options]"
+
+  opts.on("-r", "--root DIRECTORY", "Set the root directory to DIRECTORY") do |dir|
+    options.root = dir
+  end
+
+  opts.on("-d", "--dir DIRECTORY", "Watch for .feature files in DIRECTORY") do |dir|
+    options.dir = dir
+  end
+
+  opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
+    options.verbose = v
+  end
+
+  opts.on_tail("-h", "--help", "Show this message") do
+    puts opts
+    exit
+  end
+
+  opts.on_tail("--version", "Show version") do
+    puts [ "autocuke v", Autocuke::VERSION ].join
+    exit
+  end
+  
+end.parse!
+
+Autocuke.start(options)

data/lib/autocuke.rb

@@ -0,0 +1,23 @@
+require "ostruct"
+require "fileutils"
+require "autocuke/runtime"
+require "autocuke/version"
+
+module Autocuke
+  
+  class NoFileError < Exception; end
+  
+  def self.start(options)
+    @active_runtime = Runtime.new(options)
+    @active_runtime.run!
+  end
+  
+  def self.set_active_runtime(runtime)
+    @active_runtime = runtime
+  end
+  
+  def self.active_runtime
+    @active_runtime
+  end
+  
+end

data/lib/autocuke/handler.rb

@@ -0,0 +1,63 @@
+module Autocuke
+  module Handler
+
+    # Triggered after a file has been modified
+    def file_modified
+      return if runtime.current_file
+      runtime.current_file = path
+      local = path.sub(/.*#{runtime.options.root}\/?/, '')
+      cmd   = "cd #{runtime.root}; bundle exec cucumber -p autocuke #{local}"
+      puts "#{local} modified - re-cuking it."
+      run_with_defer cmd      
+    end
+    
+    # Triggered after a file has been moved
+    def file_moved
+      stop! unless File.exists?(path)
+    end
+    
+    # Triggered after a file has been deleted.
+    # In text editors, the file is deleted and recreated rather than modified.
+    # If so, we'll start watching the new file and trigger `file_modified`
+    def file_deleted
+      if File.exists?(path)
+        file_modified
+        runtime.watch(path)
+      else      
+        stop!
+      end
+    end
+    
+    # Stop EM if the file doesn't exist
+    def unbind
+      stop! unless File.exists?(path)
+    end
+
+    private
+    
+      # Runs the cucumber command and triggers a callback when it's complete
+      def run_with_defer(cmd)
+        puts cmd if runtime.options.verbose
+        operation = proc {
+          system(cmd)
+        }
+        callback = proc {|result|
+          runtime.current_file = nil
+        }
+        EM.defer operation, callback
+      end
+    
+      # Just an alias to the active runtime
+      def runtime
+        Autocuke.active_runtime
+      end
+    
+      # Warns the user and stops the active runtime
+      def stop!
+        puts "*" * 88
+        puts "#{File.basename(path)} is no longer available! Autocuke stopping..."
+        runtime.stop!
+      end
+    
+  end
+end

data/lib/autocuke/runtime.rb

@@ -0,0 +1,65 @@
+require "eventmachine"
+require "autocuke/handler"
+
+module Autocuke
+  class Runtime
+    
+    attr_reader   :root,  :options
+    attr_accessor :files, :current_file
+    
+    def initialize(options)
+      @options = options
+      @root    = options.root
+      @files ||= Dir[File.join(options.root, "**/*.feature")]
+    end
+
+    # Starts the EM reactor and watches each of the runtime's files
+    # Raises an Autocuke::NoFileError if the list of files is empty
+    def run!
+      raise Autocuke::NoFileError.new("No files given to watch!") if files.empty?
+
+      log if options.verbose
+
+      # file watching requires kqueue on OSX
+      EM.kqueue = true if EM.kqueue?
+
+      EM.run {
+        watch_feature_files 
+        puts "autocuke is up and running!"        
+        trap "SIGINT", proc{
+          puts "\nbye-bye!"
+          exit          
+        }
+      }      
+    end
+    
+    # Logs the root and file list
+    def log
+      puts "Root Set To:"
+      puts root
+      puts         
+      puts "Watching files:"
+      puts "-" * 88
+      puts files
+      puts
+    end
+    
+    # Adds each of the runtime's files to EM's file watch list
+    def watch_feature_files
+      files.each do |file|
+        watch(file)
+      end 
+    end
+    
+    # Adds a file to EM's file watch list
+    def watch(file)
+      EM.watch_file(File.expand_path(file), handler)
+    end
+    
+    # Overwrite for custom handlers
+    def handler
+      Autocuke::Handler
+    end
+     
+  end # Runtime
+end # Autocuke

data/lib/autocuke/version.rb

@@ -0,0 +1,3 @@
+module Autocuke
+  VERSION = "0.1.0"
+end

data/test/dummy_hooks/after_migrate.rb.sample

@@ -0,0 +1 @@
+rake "db:migrate", :env => "development"

data/test/dummy_hooks/before_migrate.rb

@@ -0,0 +1,9 @@
+run "rails generate cucumber:install"
+
+run "rails generate cucumber:feature post title:string body:text published:boolean"
+run "rails generate scaffold post title:string body:text published:boolean"
+
+run "rails generate cucumber:feature comment post:references name:string body:text"
+run "rails generate scaffold comment post:references name:string body:text"
+
+append_file "config/cucumber.yml", "\nautocuke: -r features --format pretty --strict"

data/test/support/em.rb

@@ -0,0 +1,29 @@
+class Test::Unit::TestCase
+
+  def default_runtime_options
+    options = OpenStruct.new
+    options.root     = File.expand_path("../../dummy", __FILE__)
+    options.features = File.join(options.root, "features")
+    options.verbose  = false
+    options
+  end
+  
+  def current_runtime_options
+    @current_runtime_options ||= default_runtime_options
+  end
+
+  def within_loop(opts={}, &block)
+    output = capture_stdout do
+      EM.run {
+        options = default_runtime_options
+        opts.map{ |k,v| options.send("#{k}=", v) }
+        @current_runtime_options = options
+        Autocuke.start(options)
+        yield
+        EM.stop
+      }
+    end
+    outputs = output.string.split("\n").select{|i| i && 0 < i.length }
+  end
+
+end

data/test/support/kernel.rb

@@ -0,0 +1,18 @@
+# Captures output from `puts`
+#   thanks @ Rob Olson
+#   http://thinkingdigitally.com/archive/capturing-output-from-puts-in-ruby/
+
+require 'stringio'
+ 
+module Kernel
+ 
+  def capture_stdout
+    out = StringIO.new
+    $stdout = out
+    yield
+      return out
+    ensure
+      $stdout = STDOUT
+  end
+   
+end

data/test/test_helper.rb

@@ -0,0 +1,9 @@
+# require gems
+require 'bundler/setup'
+require 'shoulda'
+require 'autocuke'
+
+EM.kqueue = EM.kqueue?
+
+# require support
+Dir[File.expand_path("../support/**/*.rb", __FILE__)].map{ |f| require f }

data/test/unit/autocuke_test.rb

@@ -0,0 +1,40 @@
+require_relative '../test_helper'
+
+class AutocukeTest < Test::Unit::TestCase
+
+  def setup
+    @bin = File.expand_path("../../../bin/autocuke", __FILE__)    
+    @output = ""
+  end
+
+  def call(options)
+    `#{@bin} #{options}`
+  end
+  
+  should "have classes defined" do
+    assert defined?(Autocuke)
+    assert defined?(Autocuke::Runtime)
+    assert defined?(Autocuke::Handler)
+  end
+
+  should "have executable" do
+    assert File.exists?(@bin)
+    assert File.executable?(@bin)    
+  end
+  
+  context "Autocuke options" do
+      
+    should "display help" do
+      @output = call("-h")
+      assert @output.include?("Usage: autocuke [options]")
+      %w(-r --root -d --dir -v --[no-]verbose -h --help --version).map{|i| assert @output.include?(i) }
+    end
+  
+    should "display version and exit" do
+      @output = call("--version")
+      assert_equal "autocuke v#{Autocuke::VERSION}\n", @output
+    end
+  
+  end
+  
+end

data/test/unit/handler_test.rb

@@ -0,0 +1,72 @@
+require_relative '../test_helper'
+
+
+# Extends the original handler
+module MockHandler
+  
+  include Autocuke::Handler        
+  
+  def file_modified
+    $modified = true
+    super
+  end
+  
+  private   
+     
+    # don't run, just output the command
+    def run_with_defer(cmd)
+      operation = proc {
+        puts(cmd)
+        # simulate delay
+        #sleep 0.25
+      }
+      callback = proc {|result|
+        runtime.current_file = nil
+      }
+      EM.defer operation, callback
+    end
+    
+end
+
+
+# use the MockHandler
+module Autocuke
+  class Runtime
+    def handler
+      ::MockHandler
+    end
+  end
+end
+
+
+class HandlerTest < Test::Unit::TestCase
+
+  def setup
+    $modified = false
+    @features = Dir[File.expand_path("../../dummy/features/**/*.feature", __FILE__)]
+    @options = OpenStruct.new
+    @options.root     = File.expand_path("../../dummy", __FILE__)
+    @options.features = File.join(@options.root, "features")
+    @options.verbose  = false
+  end
+    
+  should "watch a file" do
+    
+    outputs = within_loop do
+      File.open(@features.first, 'w+'){ |f| f.write "\n" }
+    end
+    
+    # disregard the start-up message
+    outputs.shift
+    
+    assert $modified
+    
+    name = File.basename(@features.first)
+    assert_equal "features/#{name} modified - re-cuking it.", outputs.shift
+    
+    commands = outputs.shift.split("; ")
+    assert_equal "cd #{@options.root}", commands.first
+    assert_equal "bundle exec cucumber -p autocuke features/#{name}", commands.last
+  end
+
+end

data/test/unit/runtime_test.rb

@@ -0,0 +1,80 @@
+require_relative '../test_helper'
+
+class RuntimeTest < Test::Unit::TestCase
+
+  def setup
+    @features = Dir[File.expand_path("../../dummy/features/**/*.feature", __FILE__)]
+  end
+    
+  context "A new, invalid runtime" do
+    
+    setup do
+      options = OpenStruct.new
+      options.root     = File.expand_path("../../dummy/that/doesnt/exist", __FILE__)
+      options.features = File.join(options.root, "features")
+      options.verbose  = false
+      @rt = Autocuke::Runtime.new(options)    
+    end
+
+    should "raise error" do
+      assert_raises Autocuke::NoFileError do
+        @rt.run!
+      end
+    end
+
+  end
+
+
+  context "A new, valid runtime" do
+    
+    setup do
+      options = OpenStruct.new
+      options.root     = File.expand_path("../../dummy", __FILE__)
+      options.features = File.join(options.root, "features")
+      options.verbose  = false
+      @rt = Autocuke::Runtime.new(options)    
+    end
+
+    should "find features" do
+      assert_equal @features, @rt.files
+    end
+
+    should "start EM reactor" do
+      output = capture_stdout do
+        EM.run {
+          @rt.run!
+          EM.stop
+        }
+      end
+      assert_equal "autocuke is up and running!", output.string.strip
+    end
+    
+  end
+  
+  
+  context "The default test runtime" do
+  
+    should "also start the EM reactor" do
+      outputs = within_loop do
+        # nothing
+      end
+      assert_equal "autocuke is up and running!", outputs.first
+    end
+    
+    should "start the EM reactor in verbose mode" do
+      outputs = within_loop :verbose => true, do
+        # nothing
+      end
+      assert_equal "Root Set To:", outputs.shift
+      assert_equal current_runtime_options.root, outputs.shift
+      assert_equal "Watching files:", outputs.shift
+      # ignore the line
+      outputs.shift
+      @features.each do |feature|
+        assert_equal feature, outputs.shift
+      end
+      assert_equal "autocuke is up and running!", outputs.shift
+    end
+    
+  end
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification 
+name: autocuke
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Spencer Steffen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-14 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: eventmachine
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.12.10
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: dummier
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.2.0
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.11.3
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 3.0.0
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: cucumber-rails
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.2
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: database_cleaner
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.6.7
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: sqlite3
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.3.3
+  type: :development
+  version_requirements: *id007
+description: Autocuke uses EventMachine to watch your .feature files, then automatically runs cucumber as they change. Use with Spork for total awesomeness. Please see README.md for more details.
+email: 
+- spencer@citrusme.com
+executables: 
+- autocuke
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- autocuke.gemspec
+- bin/autocuke
+- lib/autocuke.rb
+- lib/autocuke/handler.rb
+- lib/autocuke/runtime.rb
+- lib/autocuke/version.rb
+- test/dummy_hooks/after_migrate.rb.sample
+- test/dummy_hooks/before_migrate.rb
+- test/support/em.rb
+- test/support/kernel.rb
+- test/test_helper.rb
+- test/unit/autocuke_test.rb
+- test/unit/handler_test.rb
+- test/unit/runtime_test.rb
+has_rdoc: true
+homepage: https://github.com/citrus/autocuke
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Autocuke uses EventMachine to watch your .feature files, then automatically runs cucumber as they change. Use with Spork for total awesomeness.
+test_files: 
+- test/dummy_hooks/after_migrate.rb.sample
+- test/dummy_hooks/before_migrate.rb
+- test/support/em.rb
+- test/support/kernel.rb
+- test/test_helper.rb
+- test/unit/autocuke_test.rb
+- test/unit/handler_test.rb
+- test/unit/runtime_test.rb