spinach 0.0.6 → 0.1.0

data/Gemfile

@@ -6,6 +6,7 @@ gemspec
 group :test do
   gem 'guard'
   gem 'guard-minitest'
+  gem 'pry', git: 'git://github.com/pry/pry.git'
 end
 
 group :darwin do

data/Readme.md

@@ -10,3 +10,6 @@ Spinach is a BDD framework on top of gherkin
 ![](http://www.80stees.com/images/products/Popeye_the_Sailor_Man_I_Popeye_Spinach-T-link.jpg)
 
 *Popeye the Sailor*
+
+# Build status
+[![Build Status](https://secure.travis-ci.org/codegram/spinach.png)](http://travis-ci.org/codegram/spinach)

data/bin/spinach

@@ -6,4 +6,6 @@ rescue LoadError
   require_relative '../lib/spinach'
 end
 
-exit Spinach::Cli.new(ARGV).run
+cli = Spinach::Cli.new(ARGV)
+cli.init_reporter
+exit cli.run

data/features/steps/error_reporting.rb

@@ -32,7 +32,7 @@ Feature "Error reporting" do
 
   Then 'I should see the error count along with their messages' do
     check_error_messages
-    all_stdout.wont_match /gems.*minitest.*assert_equal/
+    all_stderr.wont_match /gems.*minitest.*assert_equal/
   end
 
   Then 'I should see the error count along with their messages and backtrace' do
@@ -41,16 +41,12 @@ Feature "Error reporting" do
   end
 
   private
-
   def check_error_messages
-    all_stdout.must_include "Error summary"
-    all_stdout.must_match /errors.*This scenario will fail.*line 4/
+    all_stderr.must_match /Failures \(1\)/
   end
 
   def check_backtrace
-    all_stdout.must_include "Error summary"
-    all_stdout.must_match /errors.*This scenario will fail.*line 4/
-    all_stdout.must_match /gems.*minitest.*assert_equal/
+    all_stderr.must_match /Failures \(1\)/
+    all_stderr.must_match /gems.*minitest.*assert_equal/
   end
-
 end

data/features/steps/exit_status.rb

@@ -46,5 +46,4 @@ Feature "Exit status" do
   Then "the exit status should be 1" do
     last_exit_status.must_equal 1
   end
-
 end

data/features/steps/feature_name_guessing.rb

@@ -27,7 +27,6 @@ Feature "Feature name guessing" do
   end
 
   Then 'I want "MyCoolFeature" class to be used to run it' do
-    all_stderr.must_be_empty
+    last_exit_status.must_equal 0
   end
-
 end

data/features/support/spinach_runner.rb

@@ -5,10 +5,8 @@ module Integration
     include Aruba::Api
 
     private
-
     def run_feature(command, options=nil)
       run "../../bin/spinach #{command} #{options}"
     end
-
   end
 end

data/lib/spinach/capybara.rb

@@ -4,8 +4,7 @@ require_relative 'feature'
 
 module Spinach
   class Feature
-
-    # Spinach's capybara module integrates capybara into all features
+    # Spinach's capybara module makes Capybara DSL available in all features.
     #
     # @example
     #   require 'spinach/capybara'
@@ -16,20 +15,21 @@ module Spinach
     #   end
     #
     module Capybara
+      # Enhances a Feature with Capybara goodness.
+      #
+      # @param [Class] base
+      #   The host class.
+      #
+      # @api public
       def self.included(base)
         base.class_eval do
           include ::Capybara::DSL
-          include InstanceMethods
 
-          def after
+          after_scenario do
             ::Capybara.current_session.reset! if ::Capybara.app
           end
         end
       end
-      module InstanceMethods
-      end
     end
   end
 end
-
-Spinach::Feature.send(:include, Spinach::Feature::Capybara)

data/lib/spinach/cli.rb

@@ -2,21 +2,24 @@ require 'optparse'
 
 module Spinach
   # The cli is a class responsible of handling all the command line interface
-  # logic
+  # logic.
   #
   class Cli
     # @param [Array<String>] arguments
-    #   the command line arguments
+    #   The command line arguments
+    #
+    # @api public
     def initialize(args = ARGV)
       @args = args
     end
 
-    # Runs all the feature
+    # Runs all the features.
+    #
+    # @return [true, false]
+    #   The exit status - true for success, false for failure.
     #
-    # @return [Boolean]
-    #   the exit status - true for success, false for failure
+    # @api public
     def run
-      init_reporter
       parse_options
       features = if @args.any?
         @args
@@ -26,42 +29,51 @@ module Spinach
       Spinach::Runner.new(features).run
     end
 
-    # Inits the reporter with a default one
+    # Inits the reporter with a default one.
+    #
+    # @api public
     def init_reporter
-      Spinach.config.default_reporter =
+      reporter =
         Spinach::Reporter::Stdout.new(options[:reporter])
+      Spinach.config.default_reporter = reporter
+      reporter.bind
     end
 
-    # Returns a hash of options, separated by its type:
+    # @return [Hash]
+    #   A hash of options separated by its type.
     #
     # @example
-    #   {
-    #     reporter: { backtrace: true }
-    #   }
+    #   Cli.new.options
+    #   # => { reporter: { backtrace: true } }
     #
-    # @return [Hash]
+    # @api public
     def options
       @options ||= parse_options
     end
 
-  private
+    private
 
+    # Parses the arguments into options.
+    #
+    # @return [Hash]
+    #   A hash of options separated by its type.
+    #
+    # @api private
     def parse_options
       reporter_options = {}
       reporter_options[:backtrace] = false
 
       OptionParser.new do |opts|
-        opts.on('-b', '--backtrace', "Show backtrace of errors") do |v|
+        opts.on('-b', '--backtrace', 'Show backtrace of errors') do |v|
           reporter_options[:backtrace] = v
         end
-        opts.on_tail('--version', "Show version") do
+        opts.on_tail('--version', 'Show version') do
           puts Spinach::VERSION
           exit
         end
       end.parse!(@args)
+
       {reporter: reporter_options}
     end
-
-
   end
 end

data/lib/spinach/config.rb

@@ -1,10 +1,9 @@
 module Spinach
-
   # Accesses spinach config. Allows you to configure several runtime options,
   # like the step definitions path.
   #
-  # @return [Spinach::Config]
-  #   the config object
+  # @return [Config]
+  #   The config object
   #
   # @example
   #   Spinach.config[:step_definitions_path]
@@ -12,6 +11,7 @@ module Spinach
   #   Spinach.config[:step_definitions_path] = 'integration/steps'
   #     # => 'integration/steps'
   #
+  # @api public
   def self.config
     @config ||= Config.new
   end
@@ -22,16 +22,24 @@ module Spinach
   class Config
     attr_writer :step_definitions_path, :default_reporter, :support_path
 
-    # The "step definitions path" helds the place where your feature classes
+    # The "step definitions path" holds the place where your feature classes
     # will be searched for. Defaults to 'features/steps'
     #
+    # @return [String]
+    #   The step definitions path.
+    #
+    # @api public
     def step_definitions_path
       @step_definitions_path || 'features/steps'
     end
 
-    # The "support path" helds the place where your can put your configuration
-    # files
+    # The "support path" helds the place where you can put your configuration
+    # files.
+    #
+    # @return [String]
+    #   The support file path.
     #
+    # @api public
     def support_path
       @support_path || 'features/support'
     end
@@ -46,22 +54,33 @@ module Spinach
 
     # Allows you to read the config object using a hash-like syntax.
     #
+    # @param [String] attribute
+    #   The attribute to fetch.
+    #
     # @example
     #   Spinach.config[:step_definitions_path]
-    #     # => 'features/steps'
+    #   # => 'features/steps'
     #
+    # @api public
     def [](attribute)
       self.send(attribute)
     end
 
-    # Allows you to set config properties using a hash-like syntax
+    # Allows you to set config properties using a hash-like syntax.
+    #
+    # @param [#to_s] attribute
+    #   The attribute to set.
+    #
+    # @param [Object] value
+    #   The value to set the attribute to.
     #
     # @example
     #   Spinach.config[:step_definitions_path] = 'integration/steps'
     #     # => 'integration/steps'
     #
-    def []=(attribute, params)
-      self.send("#{attribute}=", params)
+    # @api public
+    def []=(attribute, value)
+      self.send("#{attribute}=", value)
     end
   end
 end

data/lib/spinach/dsl.rb

@@ -1,34 +1,53 @@
+require 'hooks'
+
 module Spinach
-  # Spinach DSL aims to provide an easy way to define steps and other domain
-  # specific actions into your feature classes
+  # Spinach DSL aims to provide an easy way to define steps and hooks into your
+  # feature classes.
   #
   module DSL
-
+    # @param [Class] base
+    #   The host class.
+    #
+    # @api public
     def self.included(base)
       base.class_eval do
         include InstanceMethods
         extend ClassMethods
+        include Hooks
+
+        define_hook :before
+        define_hook :after
+        define_hook :before_scenario
+        define_hook :after_scenario
+        define_hook :before_step
+        define_hook :after_step
+
       end
     end
 
+    # Class methods to extend the host class.
+    #
     module ClassMethods
-
+      # The feature name.
+      attr_reader :feature_name
       # Defines an action to perform given a particular step literal.
       #
-      # @param [String] step name
-      #   The step literal
+      # @param [String] step
+      #   The step name.
+      #
       # @param [Proc] block
-      #   action to perform in that step
+      #   Action to perform in that step.
       #
       # @example
-      #   class MyFeature << Spinach::Feature
+      #   class MyFeature < Spinach::Feature
       #     When "I go to the toilet" do
       #       @sittin_on_the_toilet.must_equal true
       #     end
       #   end
       #
-      def Given(string, &block)
-        define_method(string, &block)
+      # @api public
+      def Given(step, &block)
+        define_method(step, &block)
       end
 
       alias_method :When, :Given
@@ -36,39 +55,44 @@ module Spinach
       alias_method :And, :Given
       alias_method :But, :Given
 
-      # Defines this feature's name
+      # Sets the feature name.
+      #
+      # @param [String] name
+      #   The name.
       #
       # @example
       #   class MyFeature < Spinach::Feature
       #     feature "Satisfy needs"
       #   end
       #
+      # @api public
       def feature(name)
         @feature_name = name
       end
-
-      # @return [String] this feature's name
-      #
-      attr_reader :feature_name
     end
 
+    # Instance methods to include in the host class.
+    #
     module InstanceMethods
-
-      # Execute a given step.
+      # Executes a given step.
       #
       # @param [String] step
-      #   the step to execute
+      #   The step name to execute.
+      #
+      # @return [String]
+      #   The file and line where the step was defined.
       #
+      # @api public
       def execute_step(step)
         if self.respond_to?(step)
           self.send(step)
         else
-          raise Spinach::StepNotDefinedException.new(
-            self, step
-          )
+          raise Spinach::StepNotDefinedException.new(self, step)
         end
       end
 
+      # @return [String]
+      #   The feature name.
       def name
         self.class.feature_name
       end

data/lib/spinach/exceptions.rb

@@ -1,28 +1,41 @@
 module Spinach
-  # This class represents the feature raised when Spniach can't find a class
+  # This class represents the exception raised when Spinach can't find a class
   # for a feature.
+  #
   class FeatureNotFoundException < StandardError
+    # @param [Array] options
+    #   An array consisting of the missing class and the feature.
+    #
+    # @api pulic
     def initialize(options)
-      @not_found_class = options.first
-      @feature = options.last
+      @missing_class, @feature = options
     end
 
+    # @return [String]
+    #   A custom message when a feature class is not found.
+    #
+    # @api public
     def message
-      "Could not find class for `#{@feature}` feature. Please create a #{@not_found_class}.rb file at #{Spinach.config[:step_definitions_path]}"
+      "Could not find class for `#{@feature}` feature. Please create a #{@missing_class}.rb file at #{Spinach.config[:step_definitions_path]}"
     end
   end
 
-  # This class represents the step raised when Spinach can't find a step for a
-  # Scenario.
+  # This class represents the exception raised when Spinach can't find a step
+  # for a {Scenario}.
   #
   class StepNotDefinedException < StandardError
-
     attr_reader :feature, :step
 
+    # @param [Feature] feature
+    #   The container feature.
+    #
+    # @param [Hash] step
+    #   The missing step.
+    #
+    # @api pulic
     def initialize(feature, step)
       @feature = feature
       @step = step
     end
   end
-
 end

data/lib/spinach/feature.rb

@@ -2,21 +2,25 @@ require 'minitest/spec'
 MiniTest::Spec.new nil
 
 module Spinach
-  # The feature class is the class where all the features must inherit from.
+  # The feature class is the class which all the features must inherit from.
   #
   class Feature
     include DSL
     include MiniTest::Assertions
 
-    def before; end;
-    def after; end;
-
+    # Registers the feature class for later use.
+    #
+    # @param [Class] base
+    #   The host class.
+    #
+    # @api public
     def self.inherited(base)
       Spinach.features << base
     end
   end
 end
 
+# Syntactic sugar. Define the "Feature do" syntax.
 Object.send(:define_method, :Feature) do |name, &block|
   Class.new(Spinach::Feature) do
     feature name

data/lib/spinach/parser.rb

@@ -2,29 +2,35 @@ require 'gherkin'
 require 'gherkin/formatter/json_formatter'
 
 module Spinach
-  # Spinach's parser uses Gherkin in the guts to extract all the information
-  # needed from the plain feature definition.
+  # Parser leverages Gherkin to parse the feature definition.
   #
   class Parser
-
     # @param [String] filename
-    #   the file to parse
+    #   The filename to parse.
     #
+    # @api public
     def initialize(filename)
       @filename = filename
       @formatter = Gherkin::Formatter::JSONFormatter.new(nil)
       @parser = Gherkin::Parser::Parser.new(@formatter)
     end
 
-    # Gets the plain text content of the feature file.
+    # Gets the plain text content out of the feature file.
+    #
     # @return [String]
-    #   the plain feature content
+    #   The plain feature content.
     #
+    # @api public
     def content
       File.read(@filename)
     end
 
-    # @return [Hash] the parsed gerkin output
+    # Parses the feature file and returns an AST as a Hash.
+    #
+    # @return [Hash]
+    #   The parsed Gherkin output.
+    #
+    # @api public
     def parse
       @parser.parse(content, @filename, __LINE__-1)
       @formatter.gherkin_object