spinach 0.6.0 → 0.6.1

data/Gemfile

@@ -9,7 +9,7 @@ group :test do
   gem 'guard'
   gem 'guard-minitest'
   gem 'guard-spinach'
-  gem 'capybara', '~> 1.1.3'
+  gem 'capybara', '~> 2.0.0'
 end
 
 group :darwin do

data/README.markdown

@@ -6,7 +6,7 @@ executable specifications of your application or library's acceptance criteria.
 
 Conceived as an alternative to Cucumber, here are some of its design goals:
 
-* Step maintanability: since features map to their own classes, their steps are
+* Step maintainability: since features map to their own classes, their steps are
   just methods of that class. This encourages step encapsulation.
 
 * Step reusability: In case you want to reuse steps across features, you can
@@ -149,6 +149,65 @@ end
 
 Then run your feature again running `spinach` and watch it all turn green! :)
 
+## Shared Steps
+
+You'll often find that some steps need to be used in many
+features. In this case, it makes sense to put these steps in reusable
+modules. For example, let's say you need a step that logs the
+user into the site.
+
+This is one way to make that reusable:
+
+```ruby
+# ... features/steps/common_steps/login.rb
+module CommonSteps
+  module Login
+    extend ActiveSupport::Concern
+
+    def self.included(mod)
+      mod.send(:Given, 'I am logged in') do
+        # log in stuff...
+      end
+    end
+  end
+end
+
+# within a rails app, you might want to use ActiveSupport::Concern
+module CommonSteps
+  module Login
+    extend ActiveSupport::Concern
+
+    included do
+      Given 'I am logged in' do
+        # log in stuff...
+      end
+    end
+  end
+end
+```
+
+Using the module (in any feature):
+
+```ruby
+# ... features/steps/buying_a_widget.rb
+class BuyAWidget < Spinach::FeatureSteps
+  # simply include this module and you are good to go
+  include CommonSteps::Login
+end
+```
+
+Also, don't forgot to require all of these common steps in your env.rb:
+
+```ruby
+# env.rb
+common_steps = Dir.glob(Rails.root.join("features/steps/common_steps/**/*.rb"))
+
+common_steps.each do |f|
+  require f
+end
+```
+
+
 ## Tags
 
 Feature and Scenarios can be marked with tags in the form: `@tag`. Tags can be
@@ -275,6 +334,7 @@ Check out our [spinach-sinatra demo](https://github.com/codegram/spinach-sinatra
 
 * [guard-spinach](http://github.com/codegram/guard-spinach)
 * [spinach-rails](http://github.com/codegram/spinach-rails)
+* [spinach-console-reporter](https://github.com/ywen/spinach-console-reporter) (to be used with Jenkins)
 
 ### Demos
 

data/features/support/env.rb

@@ -1 +1,6 @@
 require 'minitest/spec'
+require_relative 'filesystem'
+
+Spinach.hooks.after_run do |scenario|
+  FileUtils.rm_rf(Filesystem.dirs)
+end

data/features/support/filesystem.rb

@@ -4,6 +4,10 @@ require 'fileutils'
 # and lets the host know about it.
 #
 module Filesystem
+  def self.dirs
+    ['tmp/fs']
+  end
+
   # Writes a file with some contents.
   #
   # @param [String] filename

data/lib/spinach/cli.rb

@@ -21,7 +21,13 @@ module Spinach
     # @api public
     def run
       options
-      Spinach::Runner.new(feature_files).run
+
+      # only generating steps, do not run tests
+      if Spinach.config.generate
+        exit 0
+      else
+        Spinach::Runner.new(feature_files).run
+      end
     end
 
     # @return [Hash]
@@ -36,6 +42,38 @@ module Spinach
       @options ||= parse_options
     end
 
+    # Uses given args to list the feature files to run. It will find a single
+    # feature, features in a folder and subfolders or every feature file in the
+    # feature path.
+    #
+    # @return [Array]
+    #   An array with the feature file names.
+    #
+    # @api public
+    def feature_files
+      files_to_run = []
+
+      @args.each do |arg|
+        if arg.match /\.feature/
+          if File.exists? arg.gsub(/:\d*/, '')
+            files_to_run << arg
+          else
+            fail! "#{arg} could not be found"
+          end
+        elsif File.directory?(arg)
+          files_to_run << Dir.glob(File.join(arg, '**', '*.feature'))
+        else
+          fail! "invalid argument - #{arg}"
+        end
+      end
+
+      if !files_to_run.empty?
+        files_to_run.flatten
+      else
+        Dir.glob(File.join(Spinach.config[:features_path], '**', '*.feature'))
+      end
+    end
+
     private
 
     # Parses the arguments into options.
@@ -73,7 +111,8 @@ module Spinach
 
           opts.on('-g', '--generate',
                   'Auto-generate the feature steps files') do
-            Spinach::Generators.bind
+            config[:generate] = true
+            Spinach::Generators.run(feature_files)
           end
 
           opts.on_tail('--version', 'Show version') do
@@ -104,24 +143,10 @@ module Spinach
       end
     end
 
-    # Uses given args to list the feature files to run. It will find a single
-    # feature, features in a folder and subfolders or every feature file in the
-    # feature path.
-    #
-    # @return [Array]
-    #   An array with the feature file names.
-    #
-    # @api private
-    def feature_files
-      path = @args.first.to_s
-
-      if File.file?(path.split(":").first.to_s)
-        @args
-      elsif File.directory?(path)
-        Dir.glob(File.join(path, '**', '*.feature'))
-      else
-        Dir.glob(File.join(Spinach.config[:features_path], '**', '*.feature'))
-      end
+    # exit test run with an optional message to the user
+    def fail!(message=nil)
+      puts message if message
+      exit 1
     end
   end
 end

data/lib/spinach/config.rb

@@ -29,6 +29,7 @@ module Spinach
                 :failure_exceptions,
                 :config_path,
                 :tags,
+                :generate,
                 :save_and_open_page_on_failure,
                 :reporter_class,
                 :reporter_options
@@ -85,6 +86,10 @@ module Spinach
       @support_path || "#{self.features_path}/support"
     end
 
+    def generate
+      @generate || false
+    end
+
     # Allows you to read the config object using a hash-like syntax.
     #
     # @param [String] attribute

data/lib/spinach/generators.rb

@@ -3,21 +3,19 @@ module Spinach
   # given some parsed feature data.
   #
   module Generators
-    # Binds the feature generator to the "feature not found" hook
-    def self.bind
-      Spinach.hooks.on_undefined_feature do |data|
-        Spinach::Generators.generate_feature(data)
-      end
-    end
+    # generates steps for features
+    # @files [Array]
+    #   filenames to evaluate for step generation
+    def self.run(files)
+      files.each do |file|
+        feature = Parser.open_file(file).parse
 
-    # Generates a feature given a parsed feature data
-    #
-    # @param [Hash] data
-    #   the parsed feature data
-    def self.generate_feature(data)
-      FeatureGenerator.new(data).store
-    rescue FeatureGeneratorException => e
-      $stderr.puts e
+        begin
+          FeatureGenerator.new(feature).store
+        rescue FeatureGeneratorException
+          # probably not optimal, but ignoring this
+        end
+      end
     end
   end
 end

data/lib/spinach/generators/feature_generator.rb

@@ -75,6 +75,7 @@ module Spinach
           FileUtils.mkdir_p path
           File.open(filename_with_path, 'w') do |file|
             file.write(generate)
+            puts "generating #{File.basename(filename_with_path)}"
           end
         end
       end

data/lib/spinach/version.rb

@@ -1,4 +1,4 @@
 module Spinach
   # Spinach version.
-  VERSION = "0.6.0"
+  VERSION = "0.6.1"
 end

data/spinach.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'mocha'
   gem.add_development_dependency 'sinatra'
-  gem.add_development_dependency 'capybara', '~> 1.1.3'
+  gem.add_development_dependency 'capybara', '~> 2.0.0'
   gem.add_development_dependency 'pry'
   gem.add_development_dependency 'simplecov'
   gem.add_development_dependency 'rspec'

data/test/spinach/cli_test.rb

@@ -1,6 +1,17 @@
 require_relative '../test_helper'
 
 describe Spinach::Cli do
+  describe '#run' do
+    it 'gets the options and runs the features' do
+      cli = Spinach::Cli.new(['features/some_feature.feature'])
+      cli.stubs(:feature_files).returns(['features/some_feature.feature'])
+
+      cli.expects(:options)
+      Spinach::Runner.any_instance.expects(:run)
+      cli.run
+    end
+  end
+
   describe '#options' do
     it 'sets the default options' do
       config = Spinach::Config.new
@@ -131,7 +142,7 @@ tags:
     describe 'generate' do
       %w{-g --generate}.each do |opt|
         it 'inits the generator if #{opt}' do
-          Spinach::Generators.expects(:bind)
+          Spinach::Generators.expects(:run)
           cli = Spinach::Cli.new([opt])
           options = cli.options
         end
@@ -185,59 +196,67 @@ tags:
     end
   end
 
-  describe '#run' do
+  describe '#feature_files' do
     describe 'when a particular feature list is passed' do
-      it 'runs the feature' do
+      describe 'the feature really exists' do
+        it 'runs the feature' do
+          cli = Spinach::Cli.new(['features/some_feature.feature'])
+          File.stubs(:exists?).returns(true)
+          cli.feature_files.must_equal ['features/some_feature.feature']
+        end
+      end
+
+      describe 'it fails if the feature does not exist' do
         cli = Spinach::Cli.new(['features/some_feature.feature'])
-        File.expects(:file?).with('features/some_feature.feature').returns(true)
+        File.stubs(:exists?).returns(false)
+        cli.expects(:fail!).with('features/some_feature.feature could not be found')
 
-        Spinach::Runner.expects(:new).with(['features/some_feature.feature']).
-          returns(stub(:run))
-        cli.run
+        cli.feature_files
       end
     end
 
     describe 'when a particular feature list is passed with line' do
-      it 'runs the feature' do
+      it 'returns the feature with the line number' do
         cli = Spinach::Cli.new(['features/some_feature.feature:10'])
-        File.expects(:file?).with('features/some_feature.feature').returns(true)
+        File.stubs(:exists?).returns(true)
 
-        Spinach::Runner.expects(:new).with(['features/some_feature.feature:10']).
-          returns(stub(:run))
-        cli.run
+        cli.feature_files.must_equal ['features/some_feature.feature:10']
       end
     end
 
     describe 'when no feature is passed' do
-      it 'runs the feature' do
+      it 'returns all the features' do
         cli = Spinach::Cli.new([])
-        Dir.expects(:glob).with('features/**/*.feature').
-          returns(['features/some_feature.feature'])
-        Spinach::Runner.expects(:new).with(['features/some_feature.feature']).
-          returns(stub(:run))
-        cli.run
+        Dir.expects(:glob).with('features/**/*.feature')
+
+        cli.feature_files
       end
     end
 
     describe 'when a folder is given' do
-      it 'runs all feature files in the folder and subfolders' do
+      it 'returns all feature files in the folder and subfolders' do
         cli = Spinach::Cli.new(['path/to/features'])
 
-        File.expects(:directory?).with('path/to/features').returns(true)
-        Dir.expects(:glob).with('path/to/features/**/*.feature').
-          returns(['path/to/features/feature1.feature', 
-                  'path/to/features/feature2.feature',
-                  'path/to/features/feature3.feature',
-                  'path/to/features/domain/feature4.feature'])
-
-        Spinach::Runner.expects(:new).with([
-                                           'path/to/features/feature1.feature', 
-                                           'path/to/features/feature2.feature',
-                                           'path/to/features/feature3.feature',
-                                           'path/to/features/domain/feature4.feature']).
-                                           returns(stub(:run))
-
-                                           cli.run
+        File.stubs(:directory?).returns(true)
+        Dir.expects(:glob).with('path/to/features/**/*.feature')
+
+        cli.feature_files
+      end
+    end
+
+    describe 'when multiple arguments are passed in' do
+      describe 'a folder followed by file' do
+        it 'returns the features in the folder and the particular file' do
+          cli = Spinach::Cli.new(['path/to/features', 'some_feature.feature'])
+
+          File.stubs(:directory?).returns(true)
+          Dir.expects(:glob).with('path/to/features/**/*.feature')
+            .returns(['several features'])
+
+          File.stubs(:exists?).returns(true)
+
+          cli.feature_files.must_equal ['several features', 'some_feature.feature']
+        end
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spinach
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
   prerelease: 
 platform: ruby
 authors:
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-27 00:00:00.000000000 Z
+date: 2012-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gherkin-ruby
@@ -101,7 +101,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.1.3
+        version: 2.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -109,7 +109,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.1.3
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -316,7 +316,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -489699544028213773
+      hash: -2192107922436848750
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -325,10 +325,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -489699544028213773
+      hash: -2192107922436848750
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Spinach is a BDD framework on top of gherkin