guard-bdd 0.0.1

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in guard-bdd.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,6 @@
+guard 'bdd' do
+  watch(%r{lib/(.*)\.rb$}) { |m| "spec/unit/#{File.basename(m[1])}_spec.rb" }
+  watch(%r{spec/.*_spec\.rb$})
+end
+
+

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2012 Nikolay Sturm <sturm@erisiandiscord.de>
+
+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/README.md

@@ -0,0 +1,70 @@
+Guard::BDD
+==========
+
+BDD guard is an opinionated RSpec and Cucumber runner.
+
+I like to partition my test suite into 3 or 4 groups:
+- fast unit tests
+- slower integration tests for interfaces to external libraries or services
+- slow RSpec acceptance tests and/or
+  slow Cucumber features
+
+Whenever the test suite goes from red to green, I like my tests to be run in
+the order given above. As soon as one group of tests fails to run successfully,
+test execution stops.
+
+Install
+-------
+
+Install the gem:
+
+    $ gem install guard-bdd
+
+or add it to your Gemfile:
+
+``` ruby
+gem 'guard-bdd'
+```
+
+Add guard definition to your Guardfile by running this command:
+
+    $ guard init bdd
+
+Guardfile
+---------
+
+``` ruby
+guard 'bdd' do
+  watch(%r{lib/(.*)\.rb$}) { |m| "spec/unit/#{File.basename(m[1])}_spec.rb"}
+  watch(%r{spec/.*_spec\.rb})
+end
+```
+
+Options
+-------
+
+You can configure the paths to the different test groups:
+
+- `:unit_paths` defaults to `['spec/unit']`
+- `:integration_paths` defaults to `['spec/integration']`
+- `:acceptance_paths` defaults to `['spec/acceptance']`
+- `:feature_paths` defaults to `['features']`
+
+Development
+-----------
+
+* Source hosted at [GitHub](https://github.com/nistude/guard-bdd)
+* Report Issues/Questions/Feature requests on [GitHub Issues](https://github.com/nistude/guard-bdd/issues)
+
+Pull requests are very welcome! Make sure your patches are well tested. Please
+create a topic branch for every separate change you make.
+
+Bugs
+----
+
+Cucumber support is still missing.
+
+Author
+------
+
+[Nikolay Sturm](http://blog.nistu.de/)

data/Rakefile

@@ -0,0 +1,154 @@
+require 'rubygems'
+require 'rake'
+require 'date'
+
+#############################################################################
+#
+# Helper functions
+#
+#############################################################################
+
+def name
+  @name ||= Dir['*.gemspec'].first.split('.').first
+end
+
+def shortname
+  @shortname ||= name.split('-')[1]
+end
+
+def version
+  line = File.read("lib/guard/#{shortname}.rb")[/^\s*VERSION\s*=\s*.*/]
+  line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1]
+end
+
+def date
+  Date.today.to_s
+end
+
+def rubyforge_project
+  name
+end
+
+def gemspec_file
+  "#{name}.gemspec"
+end
+
+def gem_file
+  "#{name}-#{version}.gem"
+end
+
+def replace_header(head, header_name)
+  head.sub!(/(\.#{header_name}\s*= ').*'/) { "#{$1}#{send(header_name)}'"}
+end
+
+#############################################################################
+#
+# Standard tasks
+#
+#############################################################################
+
+task :default => :test
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+desc "Generate RCov test coverage and open in your browser"
+task :coverage do
+  require 'rcov'
+  sh "rm -fr coverage"
+  sh "rcov test/test_*.rb"
+  sh "open coverage/index.html"
+end
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "#{name} #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -r ./lib/guard/#{shortname}.rb"
+end
+
+#############################################################################
+#
+# Custom tasks (add your own tasks here)
+#
+#############################################################################
+
+
+
+#############################################################################
+#
+# Packaging tasks
+#
+#############################################################################
+
+desc "Create tag v#{version} and build and push #{gem_file} to Rubygems"
+task :release => :build do
+  unless `git branch` =~ /^\* master$/
+    puts "You must be on the master branch to release!"
+    exit!
+  end
+  sh "git commit --allow-empty -a -m 'Release #{version}'"
+  sh "git tag v#{version}"
+  sh "git push origin master"
+  sh "git push origin v#{version}"
+  sh "gem push pkg/#{name}-#{version}.gem"
+end
+
+desc "Build #{gem_file} into the pkg directory"
+task :build => :gemspec do
+  sh "mkdir -p pkg"
+  sh "gem build #{gemspec_file}"
+  sh "mv #{gem_file} pkg"
+end
+
+desc "Generate #{gemspec_file}"
+task :gemspec => :validate do
+  # read spec file and split out manifest section
+  spec = File.read(gemspec_file)
+  head, manifest, tail = spec.split("  # = MANIFEST =\n")
+
+  # replace name version and date
+  replace_header(head, :name)
+  replace_header(head, :version)
+  replace_header(head, :date)
+  #comment this out if your rubyforge_project has a different name
+  #replace_header(head, :rubyforge_project)
+
+  # determine file list from git ls-files
+  files = `git ls-files`.
+    split("\n").
+    sort.
+    reject { |file| file =~ /^\./ }.
+    reject { |file| file =~ /^(rdoc|pkg)/ }.
+    map { |file| "    #{file}" }.
+    join("\n")
+
+  # piece file back together and write
+  manifest = "  s.files = %w[\n#{files}\n  ]\n"
+  spec = [head, manifest, tail].join("  # = MANIFEST =\n")
+  File.open(gemspec_file, 'w') { |io| io.write(spec) }
+  puts "Updated #{gemspec_file}"
+end
+
+desc "Validate #{gemspec_file}"
+task :validate do
+  libfiles = Dir['lib/guard/*'] - ["lib/guard/#{shortname}.rb", "lib/guard/#{shortname}"]
+  unless libfiles.empty?
+    puts "Directory `lib/guard` should only contain a `#{shortname}.rb` file and `#{shortname}` dir."
+    exit!
+  end
+  unless Dir['VERSION*'].empty?
+    puts "A `VERSION` file at root level violates Gem best practices."
+    exit!
+  end
+end

data/guard-bdd.gemspec

@@ -0,0 +1,50 @@
+Gem::Specification.new do |s|
+  s.specification_version = 2 if s.respond_to? :specification_version=
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.rubygems_version = '1.3.5'
+
+  s.name              = 'guard-bdd'
+  s.version           = '0.0.1'
+  s.date              = '2012-04-15'
+  s.rubyforge_project = 'guard-bdd'
+
+  s.summary     = "An opinionated RSpec and Cucumber runner for guard"
+  s.description = "Opinionated guard plugin for BDD workflow with Cucumber and RSpec"
+
+  s.authors  = ["Nikolay Sturm"]
+  s.email    = 'sturm@erisiandiscord.de'
+  s.homepage = 'http://github.com/nistude/guard-bdd'
+
+  s.require_paths = %w[lib]
+
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.extra_rdoc_files = %w[README.md LICENSE]
+
+  s.add_dependency('guard', '~> 1.0')
+  s.add_dependency('guard-cucumber', '~> 0.7')
+  s.add_dependency('guard-rspec', '~> 0.7')
+  s.add_dependency('rspec', '~> 2.9')
+  s.add_dependency('state_machine', '~> 1.1')
+
+  #s.add_development_dependency('DEVDEPNAME', [">= 1.1.0", "< 2.0.0"])
+
+  # = MANIFEST =
+  s.files = %w[
+    Gemfile
+    Guardfile
+    LICENSE
+    README.md
+    Rakefile
+    doc/flowchart.dia
+    guard-bdd.gemspec
+    lib/guard/bdd.rb
+    lib/guard/bdd/state_machine.rb
+    lib/guard/bdd/templates/Guardfile
+    spec/unit/state_machine_spec.rb
+  ]
+  # = MANIFEST =
+
+  ## Test files will be grabbed from the file list. Make sure the path glob
+  ## matches what you actually use.
+  ##s.test_files = s.files.select { |path| path =~ /^test\/test_.*\.rb/ }
+end

data/lib/guard/bdd.rb

@@ -0,0 +1,53 @@
+require 'guard'
+require 'guard/guard'
+require 'guard/bdd/state_machine'
+
+module Guard
+  class Bdd < Guard
+    VERSION = '0.0.1'
+
+    # Initialize a Guard.
+    # @param [Array<Guard::Watcher>] watchers the Guard file watchers
+    # @param [Hash] options the custom Guard options
+    def initialize(watchers = [], options = {})
+      super
+      options = {
+        :acceptance_paths  => ['spec/acceptance'],
+        :feature_paths     => ['features'],
+        :integration_paths => ['spec/integration'],
+        :unit_paths        => ['spec/unit']
+      }.merge(options)
+      @state_machine = StateMachine.new(options)
+    end
+
+    # Call once when Guard starts. Please override initialize method to init
+    # stuff.
+    # @raise [:task_has_failed] when start has failed
+    def start
+      @state_machine.startup
+    end
+
+    # Called when just `enter` is pressed
+    # This method should be principally used for long action like running all
+    # specs/tests/...
+    # @raise [:task_has_failed] when run_all has failed
+    def run_all
+      @state_machine.run_all
+    end
+
+    # Called on file(s) modifications that the Guard watches.
+    # @param [Array<String>] paths the changes files or paths
+    # @raise [:task_has_failed] when run_on_change has failed
+    def run_on_change(paths)
+      @state_machine.changed_paths = paths
+      @state_machine.run_on_change
+    end
+
+    # Called on file(s) deletions that the Guard watches.
+    # @param [Array<String>] paths the deleted files or paths
+    # @raise [:task_has_failed] when run_on_change has failed
+    def run_on_deletion(paths)
+      @state_machine.remove(paths)
+    end
+  end
+end

data/lib/guard/bdd/state_machine.rb

@@ -0,0 +1,180 @@
+require 'state_machine'
+require 'guard/rspec/runner'
+require 'guard/rspec/inspector'
+
+module Guard
+  class Bdd < Guard
+    class StateMachine
+      attr_writer :changed_paths
+
+      state_machine :bdd, :initial => :cold do
+        # startup
+        state :cold
+
+        event :startup do
+          transition :from => :cold, :to => :run_all
+        end
+
+        # generic states
+        state :run_all
+        after_transition :to => :run_all, :do => :run_all_unit_specs
+
+        state :test_failure
+        after_transition :to => :test_failure, :do => :throw_up
+
+        state :test_success
+
+        # generic events
+        event :run_all do
+          transition :to => :run_all
+        end
+
+        state :run_on_change_green
+        after_transition :to => :run_on_change_green, :do => :run_changed
+
+        state :run_on_change_red
+        after_transition :to => :run_on_change_red, :do => :run_changed
+
+        event :run_on_change do
+          transition :from => :test_success, :to => :run_on_change_green
+          transition :from => :test_failure, :to => :run_on_change_red
+        end
+
+        event :run_changed_success do
+          transition :from => :run_on_change_green, :to => :test_success
+          transition :from => :run_on_change_red, :to => :run_all
+        end
+
+        event :run_changed_failure do
+          transition :to => :test_failure
+        end
+
+        # unit specs
+        event :unit_specs_success do
+          transition :to => :unit_specs_green
+        end
+        event :unit_specs_failure do
+          transition :to => :test_failure
+        end
+
+        state :unit_specs_green
+        after_transition :to => :unit_specs_green, :do => :run_all_integration_specs
+
+        # integration specs
+        event :integration_specs_success do
+          transition :to => :integration_specs_green
+        end
+        event :integration_specs_failure do
+          transition :to => :test_failure
+        end
+
+        state :integration_specs_green
+        after_transition :to => :integration_specs_green, :do => :run_all_acceptance_specs
+
+        # acceptance specs
+        event :acceptance_specs_success do
+          transition :to => :acceptance_specs_green
+        end
+        event :acceptance_specs_failure do
+          transition :to => :test_failure
+        end
+
+        state :acceptance_specs_green
+        after_transition :to => :acceptance_specs_green, :do => :run_all_cucumber_features
+
+        # cucumber features
+        event :cucumber_features_success do
+          transition :to => :test_success
+        end
+        event :cucumber_features_failure do
+          transition :to => :test_failure
+        end
+      end
+
+      def initialize(options)
+        @options = options
+        @changed_paths = []
+        @failed_paths = []
+
+        @rspec_runner = RSpec::Runner.new(@options)
+
+        super()
+      end
+
+      def remove(paths)
+        @failed_paths -= paths
+      end
+
+      private
+      def run_all_acceptance_specs
+        paths = @options[:acceptance_paths].select { |path| File.exist?(path) }
+        if paths.empty?
+          acceptance_specs_success
+        else
+          passed = @rspec_runner.run(paths)
+          passed ? acceptance_specs_success : acceptance_specs_failure
+        end
+      end
+
+      def run_all_cucumber_features
+        # passed = @cucumber_runner.run(@options[:feature_paths])
+        # if passed
+        #   @failed_paths = []
+            cucumber_features_success
+        # else
+        #   cucumber_features_failure
+        # end
+      end
+
+      def run_all_integration_specs
+        paths = @options[:integration_paths].select { |path| File.exist?(path) }
+        if paths.empty?
+          integration_specs_success
+        else
+          passed = @rspec_runner.run(paths)
+          passed ? integration_specs_success : integration_specs_failure
+        end
+      end
+
+      def run_all_unit_specs
+        paths = @options[:unit_paths].select { |path| File.exist?(path) }
+        if paths.empty?
+          unit_specs_success
+        else
+          passed = @rspec_runner.run(paths)
+          passed ? unit_specs_success : unit_specs_failure
+        end
+      end
+
+      def run_changed
+        paths = @changed_paths
+        paths += @failed_paths
+
+        spec_paths = []
+        [:acceptance_paths, :integration_paths, :unit_paths].each do |path|
+          spec_paths += @options[path]
+        end
+        paths = RSpec::Inspector.new(:spec_paths => spec_paths).clean(paths)
+
+        if paths.empty?
+          @changed_paths = []
+          run_changed_success
+        else
+          passed = @rspec_runner.run(paths)
+          @changed_paths = []
+          if passed
+            @failed_paths -= paths
+            run_changed_success
+          else
+            @failed_paths = (@failed_paths + paths).uniq
+            run_changed_failure
+          end
+        end
+      end
+
+      def throw_up
+        throw :task_has_failed
+      end
+    end
+  end
+end

data/lib/guard/bdd/templates/Guardfile

@@ -0,0 +1,4 @@
+guard 'bdd' do
+  watch(%r{lib/.*\.rb$})        { |m| "spec/unit/#{m[1]}_spec.rb" }
+  watch(%r{spec/.*_spec\.rb$})
+end

data/spec/unit/state_machine_spec.rb

@@ -0,0 +1,61 @@
+require 'guard/bdd'
+
+describe Guard::Bdd::StateMachine do
+  let(:runner) { double(Guard::RSpec::Runner) }
+  let(:state_machine) {
+    state_machine = Guard::Bdd::StateMachine.new(
+      :acceptance_paths  => ['acceptance'],
+      :features_path     => ['feature'],
+      :integration_paths => ['integration'],
+      :unit_paths        => ['unit']
+    )
+  }
+
+  before(:each) do
+    runner.stub(:run).and_return(true)
+    Guard::RSpec::Runner.stub(:new).and_return(runner)
+
+    File.stub(:exist?).and_return(true)
+  end
+
+  context 'on startup' do
+    it 'runs all test groups' do
+      state_machine.startup
+
+      state_machine.bdd.should == 'test_success'
+    end
+  end
+
+  context 'when a test directory does not exist' do
+    %w{unit integration acceptance feature}.each do |kind|
+      it "skips missing #{kind} tests" do
+        File.stub(:exist?).with(kind).and_return(false)
+
+        runner.should_not_receive(:run).with([kind])
+
+        state_machine.startup
+      end
+    end
+  end
+
+  context 'when a single test fails' do
+    it 'keeps that test on the run list until all tests succeed' do
+      state_machine.bdd = 'test_success'
+
+      inspector = double(Guard::RSpec::Inspector)
+      inspector.stub(:clean).and_return(['foo'], ['bar', 'foo'])
+      Guard::RSpec::Inspector.stub(:new).and_return(inspector)
+
+      runner.stub(:run).with(['foo']).and_return(false)
+      state_machine.changed_paths = ['foo']
+      expect { state_machine.run_on_change }.to throw_symbol(:task_has_failed)
+      state_machine.instance_variable_get(:@failed_paths).should == ['foo']
+      state_machine.bdd.should == 'test_failure'
+
+      state_machine.changed_paths = ['bar']
+      state_machine.run_on_change
+      state_machine.bdd.should == 'test_success'
+      state_machine.instance_variable_get(:@failed_paths).should == []
+    end
+  end
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: guard-bdd
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Nikolay Sturm
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: &7296460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *7296460
+- !ruby/object:Gem::Dependency
+  name: guard-cucumber
+  requirement: &7295060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: *7295060
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: &7294380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: *7294380
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &7293780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: *7293780
+- !ruby/object:Gem::Dependency
+  name: state_machine
+  requirement: &7293100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: *7293100
+description: Opinionated guard plugin for BDD workflow with Cucumber and RSpec
+email: sturm@erisiandiscord.de
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE
+files:
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- doc/flowchart.dia
+- guard-bdd.gemspec
+- lib/guard/bdd.rb
+- lib/guard/bdd/state_machine.rb
+- lib/guard/bdd/templates/Guardfile
+- spec/unit/state_machine_spec.rb
+homepage: http://github.com/nistude/guard-bdd
+licenses: []
+post_install_message: 
+rdoc_options:
+- --charset=UTF-8
+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: guard-bdd
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 2
+summary: An opinionated RSpec and Cucumber runner for guard
+test_files: []