spinach 0.1.4 → 0.1.5

data/.gitignore

@@ -1,5 +1,6 @@
 *.gem
 *.rbc
+.rbx
 .bundle
 .config
 .yardoc

data/.yardopts

@@ -0,0 +1,6 @@
+--title "Spinach"
+--no-private
+-m markdown
+-r Readme.md
+lib/**/*.rb
+Readme.md

data/Gemfile

@@ -6,6 +6,7 @@ gemspec
 group :test do
   gem 'guard'
   gem 'guard-minitest'
+  gem 'guard-spinach'
 end
 
 group :darwin do

data/Guardfile

@@ -3,3 +3,10 @@ guard 'minitest' do
   watch(%r|^lib/(.*)([^/]+)\.rb|)     { |m| "test/#{m[1]}#{m[2]}_test.rb" }
   watch(%r|^test/test_helper\.rb|)    { "test" }
 end
+
+guard 'spinach' do
+  watch(%r|^features/(.*)\.feature|)
+  watch(%r|^features/steps/(.*)([^/]+)\.rb|) do |m|
+    "features/#{m[1]}#{m[2]}.feature"
+  end
+end

data/Rakefile

@@ -9,6 +9,7 @@ Rake::TestTask.new do |t|
   # t.loader = :direct
 end
 
+desc 'Run spinach features'
 task :spinach do
   exec "bundle exec spinach"
 end

data/Readme.md

@@ -1,15 +1,152 @@
-# About Spinach
-Spinach is a BDD framework on top of gherkin
+# Spinach - BDD framework on top of Gherkin [![Build Status](https://secure.travis-ci.org/codegram/spinach.png)](http://travis-ci.org/codegram/spinach)
 
-![](http://farm1.static.flickr.com/58/200481513_a1a0aa265a.jpg)
+Spinach is a high-level BDD framework that leverages the expressive
+[Gherkin language][gherkin] (used by [Cucumber][cucumber]) to help you define
+executable specifications of your application or library's acceptance criteria.
 
-# Documentation
-[Spinach documentation at rubydoc.info](http://rubydoc.info/github/codegram/spinach/master/frames)
+Conceived as an alternative to Cucumber, here are some of its design goals:
 
-# Testimonials
-![](http://www.80stees.com/images/products/Popeye_the_Sailor_Man_I_Popeye_Spinach-T-link.jpg)
+* Step maintanability: since features map to their own classes, their steps are
+  just methods of that class. This encourages step encapsulation.
 
-*Popeye the Sailor*
+* Step reusability: In case you want to reuse steps across features, you can
+  always wrap those in plain ol' Ruby modules.
 
-# Build status
-[![Build Status](https://secure.travis-ci.org/codegram/spinach.png)](http://travis-ci.org/codegram/spinach)
+Spinach is tested against MRI 1.9.2, 1.9.3. Rubinius 2.0 support is on the
+works.
+
+We are not planning to make it compatible with MRI 1.8.7 since, you know, this
+would be irresponsible :)
+
+## Getting started
+
+Start by adding spinach to your Gemfile:
+
+    group :test do
+      gem 'spinach'
+      # along with gem 'minitest' or gem 'rspec'
+    end
+
+Spinach works with your favorite test suite, you just have to tell it which
+one are you going to use in `features/support/env.rb`:
+
+    # If you want to use minitest:
+    require 'minitest/spec'
+
+    # If you want to use rspec:
+    require 'rspec'
+
+Now create a `features` folder in your app or library and write your first
+feature:
+
+    ## features/test_how_spinach_works.feature
+
+    Feature: Test how spinach works
+      In order to know what the heck is spinach
+      As a developer
+      I want it to behave in an expected way
+
+      Scenario: Formal greeting
+        Given I have an empty array
+        And I append my first name and my last name to it
+        When I pass it to my super-duper method
+        Then the output should contain a formal greeting
+
+      Scenario: Informal greeting
+        Given I have an empty array
+        And I append only my first name to it
+        When I pass it to my super-duper method
+        Then the output should contain a casual greeting
+
+Now for the steps file. Remember that in Spinach steps are just Ruby classes,
+following a camelcase naming convention. Spinach generator will do some
+scaffolding for you:
+
+    $ spinach --generate
+
+Spinach will detect your features and generate the following class:
+
+    ## features/steps/test_how_spinach_works.rb
+
+    class TestHowSpinachWorks < Spinach::FeatureSteps
+      Given 'I have an empty array' do
+      end
+
+      And 'I append my first name and my last name to it' do
+      end
+
+      When 'I pass it to my super-duper method' do
+      end
+
+      Then 'the output should contain a formal greeting' do
+      end
+
+      And 'I append only my first name to it' do
+      end
+
+      Then 'the output should contain a casual greeting' do
+      end
+    end
+
+Then, you can fill it in with your logic - remember, it's just a class, you can
+use private methods, mix in modules or whatever!
+
+    class TestHowSpinachWorks < Spinach::FeatureSteps
+      Given 'I have an empty array' do
+        @array = Array.new
+      end
+
+      And 'I append my first name and my last name to it' do
+        @array += ["John", "Doe"]
+      end
+
+      When 'I pass it to my super-duper method' do
+        @output = capture_output do
+          Greeter.greet(@array)
+        end
+      end
+
+      Then 'the output should contain a formal salutation' do
+        @output.must_include "Hello, mr. John Doe"
+      end
+
+      And 'I append only my first name to it' do
+        @array += ["John"]
+      end
+
+      Then 'the output should contain a casual salutation' do
+        @output.must_include "Yo, John! Whassup?"
+      end
+
+      private
+
+      def capture_output
+        out = StreamIO.new
+        $stdout = out
+        $stderr = out
+        yield
+        $stdout = STDOUT
+        $stderr = STDERR
+        out.string
+      end
+    end
+
+Then run your feature again running `spinach` and watch it all turn green! :)
+
+## Contributing
+
+You can easily contribute to Spinach. Its codebase is simple and
+[extensively documented][documentation].
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add specs for it. This is important so we don't break it in a future
+  version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  If you want to have your own version, that is fine but bump version
+  in a commit by itself I can ignore when I pull.
+* Send me a pull request. Bonus points for topic branches.
+
+[gherkin]: http://github.com/cucumber/gherkin
+[cucumber]: http://github.com/cucumber/cucumber
+[documentation]: http://rubydoc.info/github/codegram/spinach/master/frames

data/features/steps/automatic_feature_generation.rb

@@ -1,4 +1,7 @@
-Feature 'Automatic feature generation' do
+class AutomaticFeatureGeneration < Spinach::FeatureSteps
+
+  feature 'Automatic feature generation'
+
   include Integration::SpinachRunner
   Given 'I have defined a "Cheezburger can I has" feature' do
     write_file('features/cheezburger_can_i_has.feature',
@@ -20,7 +23,7 @@ Feature 'Automatic feature generation' do
       File.exists?(@file).must_equal true
     end
   end
-  
+
   And "that feature should have the example feature steps" do
     in_current_dir do
       content = File.read(@file)

data/features/steps/exit_status.rb

@@ -1,4 +1,7 @@
-Feature "Exit status" do
+class ExitStatus < Spinach::FeatureSteps
+
+  feature "Exit status"
+
   include Integration::SpinachRunner
 
   Given "I have a feature that has no error or failure" do
@@ -9,7 +12,8 @@ Feature "Exit status" do
         Then I succeed
      ')
     write_file('features/steps/success_feature.rb',
-    'Feature "A success feature" do
+    'class ASuccessFeature < Spinach::FeatureSteps
+      feature "A success feature"
       Then "I succeed" do
       end
      end')
@@ -24,7 +28,8 @@ Feature "Exit status" do
         Then I fail
      ')
     write_file('features/steps/failure_feature.rb',
-    'Feature "A failure feature" do
+    'class AFailureFeature < Spinach::FeatureSteps
+      feature "A failure feature"
       Then "I fail" do
         true.must_equal false
       end

data/features/steps/feature_name_guessing.rb

@@ -1,4 +1,7 @@
-Feature "Feature name guessing" do
+class FeatureNameGuessing < Spinach::FeatureSteps
+
+  feature "Feature name guessing"
+
   include Integration::SpinachRunner
 
   Given 'I am writing a feature called "My cool feature"' do

data/features/steps/reporting/display_run_summary.rb

@@ -1,6 +1,9 @@
 require 'aruba/api'
 
-Feature "Display run summary" do
+class DisplayRunSummary < Spinach::FeatureSteps
+
+  feature 'automatic'
+
   include Integration::SpinachRunner
 
   Given "I have a feature that has some successful, undefined, failed and error steps" do
@@ -24,7 +27,9 @@ Feature "Display run summary" do
         Then I must succeed
      ')
     write_file('features/steps/test_feature.rb',
-    'Feature "A test feature" do
+    'class ATestFeature < Spinach::FeatureSteps
+      feature "A test feature"
+
       Given "I am a fool" do
       end
 
@@ -65,5 +70,3 @@ Feature "Display run summary" do
     )
   end
 end
-
-

data/features/steps/reporting/error_reporting.rb

@@ -1,4 +1,7 @@
-Feature "Error reporting" do
+class ErrorReporting < Spinach::FeatureSteps
+
+  feature "Error reporting"
+
   include Integration::SpinachRunner
   include Integration::ErrorReporting
 
@@ -12,7 +15,9 @@ Feature "Error reporting" do
                ')
 
     write_file('features/steps/failure_feature.rb',
-               'Feature "Feature with failures" do
+               'class FeatureWithFailures < Spinach::FeatureSteps
+                  feature "Feature with failures"
+
                   Given "true is false" do
                     true.must_equal false
                   end

data/features/steps/reporting/show_step_source_location.rb

@@ -1,6 +1,9 @@
 require 'aruba/api'
 
-Feature "Show step source location" do
+class ShowStepSourceLocation < Spinach::FeatureSteps
+
+  feature "Show step source location"
+
   include Integration::SpinachRunner
 
   Given "I have a feature that has no error or failure" do
@@ -11,7 +14,8 @@ Feature "Show step source location" do
         Then I succeed
      ')
     write_file('features/steps/success_feature.rb',
-    'Feature "A success feature" do
+    'class ASuccessFeature < Spinach::FeatureSteps
+      feature "A success feature"
       Then "I succeed" do
       end
      end')
@@ -24,7 +28,7 @@ Feature "Show step source location" do
 
   Then "I should see the source location of each step of every scenario" do
     all_stdout.must_match(
-      /I succeed.*features\/steps\/success_feature\.rb.*2/
+      /I succeed.*features\/steps\/success_feature\.rb.*3/
     )
   end
 
@@ -36,7 +40,8 @@ Feature "Show step source location" do
         Given this is a external step
      ')
     write_file('features/steps/success_feature.rb',
-    'Feature "A feature that uses external steps" do
+    'class AFeatureThatUsesExternalSteps < Spinach::FeatureSteps
+      feature "A feature that uses external steps"
       include ExternalSteps
      end')
     write_file('features/support/external_steps.rb',
@@ -54,4 +59,3 @@ Feature "Show step source location" do
     )
   end
 end
-

data/features/steps/reporting/undefined_feature_reporting.rb

@@ -1,4 +1,7 @@
-Feature "Undefined feature reporting" do
+class UndefinedFeatureReporting < Spinach::FeatureSteps
+
+  feature "Undefined feature reporting"
+
   include Integration::SpinachRunner
 
   Given "I've written a feature but not its steps" do

data/features/steps/rspec_compatibility.rb

@@ -1,4 +1,7 @@
-Feature "RSpec compatibility" do
+class RSpecCompatibility < Spinach::FeatureSteps
+
+  feature "RSpec compatibility"
+
   include Integration::SpinachRunner
   include Integration::ErrorReporting
 
@@ -12,7 +15,8 @@ Feature "RSpec compatibility" do
                ')
 
     write_file('features/steps/failure_feature.rb',
-               'Feature "Feature with failures" do
+               'class FeatureWithFailures < Spinach::FeatureSteps
+                  feature "Feature with failures"
                   Given "true is false" do
                     true.should == false
                   end

data/features/support/spinach_runner.rb

@@ -5,15 +5,8 @@ module Integration
     include Aruba::Api
 
     def self.included(base)
-      base.class_eval do
-        before_scenario do
-          in_current_dir do
-            FileUtils.rm_rf("features")
-          end
-        end
-        before_scenario do
-          @aruba_timeout_seconds = 6
-        end
+      Spinach.hooks.before_scenario do
+        @aruba_timeout_seconds = 6
       end
     end
 

data/lib/spinach/capybara.rb

@@ -24,10 +24,9 @@ module Spinach
       def self.included(base)
         base.class_eval do
           include ::Capybara::DSL
-
-          after_scenario do
-            ::Capybara.current_session.reset! if ::Capybara.app
-          end
+        end
+        Spinach.hooks.before_scenario do
+          ::Capybara.current_session.reset! if ::Capybara.app
         end
       end
     end

data/lib/spinach/cli.rb

@@ -35,7 +35,6 @@ module Spinach
     def init_reporter
       reporter =
         Spinach::Reporter::Stdout.new(options[:reporter])
-      Spinach.config.default_reporter = reporter
       reporter.bind
     end
 

data/lib/spinach/config.rb

@@ -45,14 +45,6 @@ module Spinach
       @support_path || 'features/support'
     end
 
-    # The default reporter is the reporter spinach will use if there's no other
-    # specified. Defaults to Spinach::Reporter::Stdout, which will print all
-    # output to the standard output
-    #
-    def default_reporter
-      @default_reporter || Spinach::Reporter::Stdout.new
-    end
-
     # Allows you to read the config object using a hash-like syntax.
     #
     # @param [String] attribute

data/lib/spinach/dsl.rb

@@ -1,5 +1,3 @@
-require 'hooks'
-
 module Spinach
   # Spinach DSL aims to provide an easy way to define steps and hooks into your
   # feature classes.
@@ -13,13 +11,6 @@ module Spinach
       base.class_eval do
         include InstanceMethods
         extend ClassMethods
-        include Hooks
-
-        define_hook :before_scenario
-        define_hook :after_scenario
-        define_hook :before_step
-        define_hook :after_step
-
       end
     end
 
@@ -82,11 +73,11 @@ module Spinach
       #
       # @api public
       def execute_step(step)
-        undercored_step = Spinach::Support.underscore(step)
+        underscored_step = Spinach::Support.underscore(step)
         location = nil
-        if self.respond_to?(undercored_step)
-          location = method(undercored_step).source_location
-          self.send(undercored_step)
+        if self.respond_to?(underscored_step)
+          location = method(underscored_step).source_location
+          self.send(underscored_step)
         else
           raise Spinach::StepNotDefinedException.new(step)
         end

data/lib/spinach/exceptions.rb

@@ -23,7 +23,7 @@ module Spinach
   end
 
   # This class represents the exception raised when Spinach can't find a step
-  # for a {Scenario}.
+  # for a {FeatureSteps}.
   #
   class StepNotDefinedException < StandardError
     attr_reader :feature, :step

data/lib/spinach/feature_steps.rb

@@ -11,15 +11,7 @@ module Spinach
     #
     # @api public
     def self.inherited(base)
-      Spinach.features << base
+      Spinach.feature_steps << base
     end
   end
 end
-
-# Syntactic sugar. Define the "Feature do" syntax.
-Object.send(:define_method, :Feature) do |name, &block|
-  Class.new(Spinach::FeatureSteps) do
-    feature name
-    class_eval &block
-  end
-end

data/lib/spinach/generators/feature_generator.rb

@@ -1,6 +1,6 @@
 module Spinach
   module Generators
-    # A feature generator generates and/or writes an example feature steps class 
+    # A feature generator generates and/or writes an example feature steps class
     # given the parsed feture data
     class FeatureGenerator
 
@@ -43,7 +43,8 @@ module Spinach
       #   an example feature steps definition
       def generate
         result = StringIO.new
-        result.puts "Feature '#{Spinach::Support.escape_single_commas name}' do"
+        result.puts "class #{Spinach::Support.camelize name} < Spinach::FeatureSteps"
+        result.puts "  feature \'#{Spinach::Support.escape_single_commas name}\'\n"
         generated_steps = steps.map do |step|
           step_generator = Generators::StepGenerator.new(step)
           step_generator.generate.split("\n").map do |line|

data/lib/spinach/generators.rb

@@ -5,7 +5,7 @@ module Spinach
   module Generators
     # Binds the feature generator to the "feature not found" hook
     def self.bind
-      Spinach::Runner::Feature.when_not_found do |data|
+      Spinach.hooks.on_undefined_feature do |data|
         Spinach::Generators.generate_feature(data)
       end
     end

data/lib/spinach/hookable.rb

@@ -0,0 +1,81 @@
+module Spinach
+  # The hookable module includes subscription capabilities to the class in which
+  # it is included.
+  #
+  # Take in account that while most subscription/notification mechanism work
+  # at the class level, Hookable defines hooks at the instance level - so they
+  # are not the same in all the class instances.
+  module Hookable
+
+    def self.included(base)
+      base.class_eval do
+        extend ClassMethods
+        include InstanceMethods
+      end
+    end
+
+    module ClassMethods
+      # Adds a new hook to this class. Every hook defines two methods used to
+      # add new callbacks and to run them passing a bunch of parameters.
+      #
+      # @example
+      #   class
+      def hook(hook)
+        define_method hook do |&block|
+          add_hook(hook, &block)
+        end
+        define_method "run_#{hook}" do |*args|
+          run_hook(hook, *args)
+        end
+      end
+    end
+
+    module InstanceMethods
+      attr_writer :hooks
+
+      # @return [Hash]
+      #   hash in which the key is the hook name and the value an array of any
+      #   defined callbacks, or nil.
+      def hooks
+        @hooks ||= {}
+      end
+
+      # Resets all this class' hooks to a pristine state
+      def reset
+        self.hooks = {}
+      end
+
+      # Runs a particular hook given a set of arguments
+      #
+      # @param [String] name
+      #   the hook's name
+      #
+      def run_hook(name, *args)
+        if callbacks = hooks[name.to_sym]
+          callbacks.each{ |c| c.call(*args) }
+        end
+      end
+
+      # @param [String] name
+      #   the hook's identifier
+      #
+      # @return [Array]
+      #   array of hooks for that particular identifier
+      def hooks_for(name)
+        hooks[name.to_sym] || []
+      end
+
+      # Adds a hook to the queue
+      #
+      # @param [String] name
+      #   the hook's identifier
+      #
+      # @param [Proc] block
+      #   an action to perform once that hook is executed
+      def add_hook(name, &block)
+        hooks[name.to_sym] ||= []
+        hooks[name.to_sym] << block
+      end
+    end
+  end
+end