spinach 0.0.6 → 0.1.0

data/lib/spinach/runner.rb

@@ -1,22 +1,38 @@
+require 'hooks'
+
 module Spinach
-  # Spinach's runner gets the parsed data from the feature and performs the
-  # actual calls to the feature classes.
+  # Runner gets the parsed data from the feature and performs the actual calls
+  # to the feature classes.
   #
   class Runner
+    include Hooks
+
+    # The feature files to run
+    attr_reader :filenames
+
+    # The default path where the steps are located
+    attr_reader :step_definitions_path
+
+    # The default path where the support files are located
+    attr_reader :support_path
+
+    define_hook :before_run
+    define_hook :after_run
 
     # Initializes the runner with a parsed feature
     #
     # @param [Array<String>] filenames
-    #   an array of feature filenames to run
+    #   A list of feature filenames to run
     #
     # @param [Hash] options
     #
     # @option options [String] :step_definitions_path
-    #   The path in which step definitions are found
+    #   The path in which step definitions are found.
     #
     # @option options [String] :support_path
-    #   The path with the support ruby files
+    #   The path with the support ruby files.
     #
+    # @api public
     def initialize(filenames, options = {})
       @filenames = filenames
 
@@ -25,13 +41,9 @@ module Spinach
 
       @support_path = options.delete(:support_path ) ||
         Spinach.config.support_path
-
-    end
-
-    def reporter
-      @reporter ||= Spinach::config.default_reporter
     end
 
+    # The feature files to run
     attr_reader :filenames
 
     # The default path where the steps are located
@@ -42,45 +54,53 @@ module Spinach
 
     # Runs this runner and outputs the results in a colorful manner.
     #
+    # @return [true, false]
+    #   Whether the run was succesful.
+    #
+    # @api public
     def run
       require_dependencies
 
+      successful = true
+
       filenames.each do |filename|
-        success = Feature.new(filename, reporter).run
-        @failed = true unless success
+        success = Feature.new(filename).run
+        successful = false unless success
       end
-      reporter.end
-      @failed ? false : true
+
+      run_hook :after_run, successful
+
+      successful
     end
 
-    # Requires step definitions and support files
+    # Loads step definitions and support files.
     #
+    # @api public
     def require_dependencies
       (support_files + step_definition_files).each do |file|
         require file
       end
     end
 
-    # List of step definition files
-    #
     # @return [Array<String>] files
+    #   The step definition files.
     #
+    # @api public
     def step_definition_files
       Dir.glob(
         File.expand_path File.join(step_definitions_path, '**', '*.rb')
       )
     end
 
-    # List of support files
-    #
     # @return [Array<String>] files
+    #   The support files.
     #
+    # @api public
     def support_files
       Dir.glob(
         File.expand_path File.join(support_path, '**', '*.rb')
       )
     end
-
   end
 end
 

data/lib/spinach/support.rb

@@ -1,19 +1,20 @@
-require 'active_support/inflector/methods'
-
 module Spinach
-  # A module to offer common helpers
+  # A module to offer helpers for string mangling.
+  #
   module Support
-    # A helper to camelize string that proxies ActiveSupport#camelize
-    #
     # @param [String] name
+    #   The name to camelize.
     #
-    # @returns [String]
+    # @return [String]
+    #   The +name+ in camel case.
     #
     # @example
     #   Spinach::Support.camelize('User authentication')
     #   => 'UserAuthentication'
+    #
+    # @api public
     def self.camelize(name)
-      ActiveSupport::Inflector.camelize(name.to_s.downcase.strip.squeeze(' ').gsub(' ','_'))
+      name.to_s.strip.split(/[^a-z0-9]/i).map{|w| w.capitalize}.join
     end
   end
 end

data/lib/spinach/version.rb

@@ -1,3 +1,4 @@
 module Spinach
-  VERSION = "0.0.6"
+  # Spianch version.
+  VERSION = "0.1.0"
 end

data/lib/spinach.rb

@@ -9,35 +9,43 @@ require_relative 'spinach/feature'
 require_relative 'spinach/reporter'
 require_relative 'spinach/cli'
 
-
-# Spinach is a BDD framework in top of gherkin. Its main goals are:
-#   * No magic: All features are implemented using actual classes.
-#   * Reusability: Steps are methods, so they can be put inside modules.
+# Spinach is a BDD framework leveraging the great Gherkin language. This
+# language is the one used defining features in Cucumber, the BDD framework
+# Spinach is inspired upon.
+#
+# Its main design goals are:
+#
+#   * No magic: All features are implemented using normal Ruby classes.
+#   * Reusability: Steps are methods, so they can be reused using modules, a
+#     common, normal practice among rubyists.
 #   * Proper encapsulation: No conflicts between steps from different
 #     scenarios.
 #
 module Spinach
   @@features = []
 
-  # @return [Array<Spinach::Feature>]
-  #   all the registered features
+  # @return [Array<Feature>]
+  #   All the registered features.
   #
+  # @api public
   def self.features
     @@features
   end
 
-  # Resets Spinach to a pristine state, as if any feature was registered.
+  # Resets Spinach to a pristine state, as if no feature was ever registered.
   # Mostly useful in Spinach's own testing.
   #
+  # @api semipublic
   def self.reset_features
     @@features = []
   end
 
-  # Finds a feature given a feature name
+  # Finds a feature given a feature name.
   #
   # @param [String] name
-  #   the feature name
+  #   The feature name.
   #
+  # @api public
   def self.find_feature(name)
     klass = Spinach::Support.camelize(name)
     @@features.detect do |feature|

data/spinach.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency 'gherkin'
   gem.add_runtime_dependency 'minitest'
   gem.add_runtime_dependency 'colorize'
-  gem.add_runtime_dependency 'activesupport'
+  gem.add_runtime_dependency 'hooks'
   gem.add_development_dependency 'purdytest'
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'mocha'
@@ -20,6 +20,7 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'capybara'
   gem.add_development_dependency 'aruba'
   gem.add_development_dependency 'pry'
+  gem.add_development_dependency 'simplecov'
 
   gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   gem.files         = `git ls-files`.split("\n")

data/test/spinach/capybara_test.rb

@@ -9,19 +9,48 @@ describe Spinach::Feature::Capybara do
         'Hello world!'
       end
     end
+
     Capybara.app = @sinatra_app
+
     @feature = Class.new(Spinach::Feature) do
+      include Spinach::Feature::Capybara
+      Given 'Hello' do
+      end
+      Then 'Goodbye' do
+      end
       def go_home
-        visit "/"
+        visit '/'
         page
       end
     end.new
   end
-  it "includes capybara into all features" do
+
+  it 'includes capybara into all features' do
     @feature.kind_of? Capybara
   end
-  it "goes to a capybara page and returns its result" do
+
+  it 'goes to a capybara page and returns its result' do
     page = @feature.go_home
     page.has_content?('Hello world').must_equal true
   end
+
+  it 'resets the capybara session after each scenario' do
+    @feature_runner = Spinach::Runner::Feature.new(
+      stub_everything)
+
+    Spinach::Parser.any_instance.stubs(content: '
+      Feature: A test feature
+        Scenario: A test scenario
+          Given Hello
+          Then Goodbye
+        Scenario: Another test scenario
+          Given Hello
+          Then Goodbye
+    ').at_least_once
+
+    @feature_runner.stubs(feature: @feature).at_least_once
+    Capybara.current_session.expects(:reset!).twice
+
+    @feature_runner.run
+  end
 end

data/test/spinach/cli_test.rb

@@ -1,38 +1,59 @@
 require_relative '../test_helper'
 
 describe Spinach::Cli do
-  describe "#options" do
-    it "defaults" do
+  describe '#options' do
+    it 'sets the default options' do
       cli = Spinach::Cli.new([])
       options = cli.options
       options[:reporter][:backtrace].must_equal false
     end
-    describe "backtrace" do
+
+    describe 'backtrace' do
       %w{-b --backtrace}.each do |opt|
-        it "sets the backtrace if #{opt}" do
+        it 'sets the backtrace if #{opt}' do
           cli = Spinach::Cli.new([opt])
           options = cli.options
           options[:reporter][:backtrace].must_equal true
         end
       end
     end
+    describe "version" do
+      %w{-v --version}.each do |opt|
+        it "outputs the version" do
+          cli = Spinach::Cli.new([opt])
+          cli.expects(:exit)
+          cli.expects(:puts).with(Spinach::VERSION)
+          output = capture_stdout do
+            cli.options
+          end
+        end
+      end
+    end
   end
-  describe "#init_reporter" do
-    it "inits the default reporter" do
+
+  describe '#init_reporter' do
+    it 'inits the default reporter' do
+      cli = Spinach::Cli.new([])
+      reporter = stub
+      reporter.expects(:bind)
+      Spinach::Reporter::Stdout.stubs(new: reporter)
+      cli.init_reporter
       Spinach.config.default_reporter.wont_equal nil
     end
   end
-  describe "#run" do
-    describe "when a particular feature list is passed" do
-      it "runs the feature" do
+
+  describe '#run' do
+    describe 'when a particular feature list is passed' do
+      it 'runs the feature' do
         cli = Spinach::Cli.new(['features/some_feature.feature'])
         Spinach::Runner.expects(:new).with(['features/some_feature.feature']).
           returns(stub(:run))
         cli.run
       end
     end
-    describe "when no feature is passed" do
-      it "runs the feature" do
+
+    describe 'when no feature is passed' do
+      it 'runs the feature' do
         cli = Spinach::Cli.new([])
         Dir.expects(:glob).with('features/**/*.feature').
           returns(['features/some_feature.feature'])

data/test/spinach/config_test.rb

@@ -1,20 +1,23 @@
 require_relative '../test_helper'
 
 describe Spinach::Config do
-  describe "#step_definitions_path" do
-    it "returns a default" do
+  describe '#step_definitions_path' do
+    it 'returns a default' do
       (Spinach.config[:step_definitions_path].kind_of? String).must_equal true
     end
-    it "can be overwritten" do
+
+    it 'can be overwritten' do
       Spinach.config[:step_definitions_path] = 'steps'
       Spinach.config[:step_definitions_path].must_equal 'steps'
     end
   end
-  describe "#support_path" do
-    it "returns a default" do
+
+  describe '#support_path' do
+    it 'returns a default' do
       (Spinach.config[:support_path].kind_of? String).must_equal true
     end
-    it "can be overwritten" do
+
+    it 'can be overwritten' do
       Spinach.config[:support_path] = 'support'
       Spinach.config[:support_path].must_equal 'support'
     end

data/test/spinach/dsl_test.rb

@@ -8,7 +8,7 @@ describe Spinach::DSL do
   end
 
   describe 'class methods' do
-    describe "#When" do
+    describe '#When' do
       it 'defines a method with the step name' do
         @feature.When('I say goodbye') do
           'You say hello'
@@ -32,5 +32,12 @@ describe Spinach::DSL do
         @feature.feature_name.must_equal 'User salutes'
       end
     end
+
+    describe "#name" do
+      it "responds with a feature's name" do
+        @feature.feature("A cool feature")
+        @feature.new.name.must_equal "A cool feature"
+      end
+    end
   end
 end

data/test/spinach/feature_test.rb

@@ -1,7 +1,7 @@
 require_relative '../test_helper'
 
 describe Spinach::Feature do
-  describe "ancestors" do
+  describe 'ancestors' do
     it 'includes minitest helpers' do
       Spinach::Feature.ancestors.must_include MiniTest::Assertions
     end
@@ -26,8 +26,8 @@ describe Spinach::Feature do
   end
 
   describe 'instance methods' do
-    before do
-      @feature = Class.new(Spinach::Feature) do
+    let(:feature) do
+      Class.new(Spinach::Feature) do
         When 'I go to the toilet' do
           @pee = true
         end
@@ -37,30 +37,33 @@ describe Spinach::Feature do
 
     describe 'execute_step' do
       it 'runs defined step correctly' do
-        @feature.execute_step('I go to the toilet')
+        feature.execute_step('I go to the toilet')
 
-        @feature.pee.must_equal true
+        feature.pee.must_equal true
       end
 
       it 'raises an exception if step is not defined' do
         proc {
-          @feature.execute_step 'I am lost'
+          feature.execute_step 'I am lost'
         }.must_raise Spinach::StepNotDefinedException
       end
     end
   end
 
-  describe "Object#Feature" do
-    it "creates a feature class" do
-      feature = Feature("Hola") do
+  describe 'Object#Feature' do
+    it 'creates a feature class' do
+      feature = Feature('Hola') do
         attr_accessor :test
-        When "Test" do
+        When 'Test' do
           self.test = true
         end
       end
+
       Spinach.features.must_include feature
+
       instance = feature.new
-      instance.execute_step("Test")
+      instance.execute_step('Test')
+
       instance.test.must_equal true
     end
   end

data/test/spinach/parser_test.rb

@@ -2,36 +2,49 @@ require_relative '../test_helper'
 
 describe Spinach::Parser do
   before do
-    @parser = Spinach::Parser.new("feature_definition.feature")
-    @parser.stubs(:content).returns('
-      Feature: User authentication
-         Scenario: User logs in
-           Given I am on the front page
-           When I fill in the login form and press "login"
-           Then I should be on my dashboard
-    ')
+    @parser = Spinach::Parser.new('feature_definition.feature')
   end
-  describe "#parse" do
+
+  let(:parsed) { @parser.parse }
+
+  describe '#parse' do
     before do
-      @parsed = @parser.parse
+      @parser.stubs(:content).returns("
+        Feature: User authentication
+           Scenario: User logs in
+             Given I am on the front page
+             When I fill in the login form and press 'login'
+             Then I should be on my dashboard
+      ")
     end
-    it "parses the feature name" do
-      @parsed['name'].must_equal "User authentication"
+
+    it 'parses the feature name' do
+      parsed['name'].must_equal 'User authentication'
     end
-    describe "scenario" do
+
+    describe 'scenario' do
       before do
-        @scenario = @parsed['elements'][0]
+        @scenario = parsed['elements'][0]
       end
-      it "parses the scenario name" do
-        @scenario['name'].must_equal "User logs in"
+
+      it 'parses the scenario name' do
+        @scenario['name'].must_equal 'User logs in'
       end
-      it "parses the scenario steps" do
-        @scenario['steps'][0]['name'].must_equal "I am on the front page"
+
+      it 'parses the scenario steps' do
+        @scenario['steps'][0]['name'].must_equal 'I am on the front page'
         @scenario['steps'][1]['name'].must_equal(
-         "I fill in the login form and press \"login\""
+         'I fill in the login form and press \'login\''
         )
-        @scenario['steps'][2]['name'].must_equal "I should be on my dashboard"
+        @scenario['steps'][2]['name'].must_equal 'I should be on my dashboard'
       end
     end
   end
+
+  describe '#content' do
+    it 'reads the disk and returns the file content' do
+      File.expects(:read).with('feature_definition.feature')
+      @parser.content
+    end
+  end
 end