rutabaga 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+  # Gherkin currently failing to build in ruby-head
+  # - ruby-head
+  - rbx-19mode
+
+script: bundle exec rspec spec

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in activeadmin-mongoid.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Xbridge Ltd, trading as Simply Business
+
+MIT License
+
+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,112 @@
+# Rutabaga
+
+Turnip hacks to enable running turnips from inside spec files, rather than outside.
+
+Rutabaga allows you to invert the control of feature files, so that features are called from your `_spec.rb` files rather than the other way around. Step definitions are then put into the `_spec.rb` files as well.
+
+This means that it is simple to create tests that are described by a class (such as controller tests in rspec-rails).
+
+## Installation
+
+Install the gem
+
+```
+gem install rutabaga
+```
+
+Or add it to your Gemfile and run `bundle`.
+
+``` ruby
+group :test do
+  gem "rutabaga", :git => 'git://github.com/simplybusiness/rutabaga.git'
+end
+```
+
+Now edit the `.rspec` file in your project directory (create it if doesn't
+exist), and add the following line:
+
+```
+-r rutabaga
+```
+
+Add the follwing lines to the bottom of your `spec_helper.rb` (assuming you want to use Capybara and the final one if you wish to have step definitions outside of your spec files:
+
+```
+require 'turnip/capybara'
+Dir.glob("spec/features/step_definitions/**/*_steps.rb") { |f| load f, true }
+```
+
+In order to get `rake` or `bundle exec rake` to work properly, you might need to add this in the file `lib/tasks/rspec.rake` (at least for rails)
+
+```
+if defined? RSpec # otherwise fails on non-live environments
+  desc "Run all specs/features in spec directory"
+  RSpec::Core::RakeTask.new(:spec => 'db:test:prepare') do |t|
+    t.pattern = './spec/{**/*_spec.rb,features/**/*.feature}'
+  end
+end
+```
+
+## Usage
+
+### Running a feature file from a spec file
+
+Please look in `spec/controllers/feature_test_spec.rb` and `spec/controllers/feature_test.feature` for more.
+
+For file `spec/controllers/test_feature_spec.rb`
+
+```
+it "should run feature" do
+  feature
+end
+```
+
+Will run `spec/controllers/test_feature.feature`.
+
+Features are found either with the same name as the spec file, or as specified in the example name `it "/path/to/feature/file.feature"`. So, if you have:
+
+`spec/controllers/feature_test_spec.rb`
+
+Then the feature will be:
+
+`spec/controllers/feature_test.feature`
+
+Alternatively, if the feature is specified in the `it`, that takes precedence:
+
+```
+it "spec/features/test.feature" do
+    feature
+end
+```
+
+Will run `spec/features/test.feature`.
+
+### Differences from Turnip
+
+Other than these differences, Rutabaga is a tiny shim over Turnip and all features will work as expected.
+
+* Turnip looks anywhere below the `spec` directory for `.feature` files. Rutabaga will only load `.feature` files from below the `spec/features` directory in the old way. This is to avoid conflicts with `.feature` files that are loaded from `_spec.rb` files.
+
+## Why?
+
+The fundamental purpose of Turnip/Cucumber is to document the system in end-user readable form.
+
+The most important functionality in a system is the business rules. These range from what appears on a page, to complex rules around when emails should be sent to who. For example, we've written Gherkin tests for what amount to charge a customer when they change what's covered on their insurance policy.
+
+Those rules are often implemented in a Model, a lib class, or some other specific class in the system, especially if the application is well modularized.
+
+In any case, business rules are usually implemented somewhere inside a class tested by a unit test. I want to get those business rules tested in Cucumber/Turnip without having to go through the whole system, and without having to have duplicate tests, one inside my rspec and another inside my features.
+
+My goal is to test just the business rule, in Turnip, and not the login, the html, the steps to get there, etc. That way, when the rule changes, I change the Turnip, the test code and the class in question. My test is not affected by wider ranging changes, and therefore less brittle. (This should all be familiar territory.) I guess, in that sense, the code runs at the unit code level, but is an acceptance test.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Copyright
+
+Copyright © 2012 SimplyBusiness. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/examples/test.feature

@@ -0,0 +1,5 @@
+Feature: Test that rspec will call the feature
+
+Scenario: ensures the feature is called
+Given that 2 + 2 is calculated
+Then my result is 4

data/examples/test2.feature

@@ -0,0 +1,5 @@
+Feature: Test that rspec will call the feature
+
+Scenario: ensures the feature is called and fails
+Given that 2 + 3 is calculated
+Then my result is 4

data/examples/test_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe "test" do
+	it "should run feature" do
+		feature
+	end
+
+	step "that :first + :second is calculated" do |first, second|
+		@first = first
+		@second = second
+	end
+
+	step "my result is :result" do |result|
+		result.to_i.should == @first.to_i + @second.to_i
+	end
+end
+
+describe "should find the feature file using the root (and monkey patching the result)" do
+	it "examples/test2.feature" do
+		feature
+	end
+
+	step "that :first + :second is calculated" do |first, second|
+		@first = first
+		@second = second
+	end
+
+	step "my result is :result" do |result|
+		result.to_i.should == @first.to_i + @second.to_i - 1
+	end
+
+end
+
+describe "causes a failing test" do
+	it "examples/test2.feature" do
+		feature
+	end
+
+	step "that :first + :second is calculated" do |first, second|
+		@first = first
+		@second = second
+	end
+
+	step "my result is :result" do |result|
+		result.to_i.should == @first.to_i + @second.to_i
+	end
+
+end

data/lib/rutabaga/feature.rb

@@ -0,0 +1,49 @@
+require 'turnip'
+
+module Rutabaga
+  module Feature
+    def feature
+      feature_file = find_feature
+
+      rspec_class = self.class
+      builder = Turnip::Builder.build(feature_file)
+      builder.features.each do |feature|
+        rspec_class.describe(feature.name, feature.metadata_hash) do
+          rspec_class.before do
+            # This is kind of a hack, but it will make RSpec throw way nicer exceptions
+            example.metadata[:file_path] = feature_file
+
+            feature.backgrounds.map(&:steps).flatten.each do |step|
+              run_step(feature_file, step)
+            end
+          end
+          feature.scenarios.each do |scenario|
+            rspec_class.describe(scenario.name, scenario.metadata_hash) do
+              it scenario.steps.map(&:description).join(' -> ') do
+                scenario.steps.each do |step|
+                  run_step(feature_file, step)
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+
+    def find_feature
+      return example.description if File.exists?(example.description)
+
+      spec_file = caller(2).first.split(':').first
+      feature_file = spec_file.gsub(/_spec.rb\Z/, '.feature')
+      return feature_file if File.exists?(feature_file)
+
+      raise "Feature file not found. Tried: #{example.description} and #{feature_file}"
+    end
+  end
+end
+
+::RSpec.configure do |c|
+  c.include Rutabaga::Feature
+  # Blow away turnip's pattern, and focus just on features directory
+  c.pattern.gsub!(",**/*.feature", ",features/**/*.feature")
+end

data/lib/rutabaga/version.rb

@@ -0,0 +1,3 @@
+module Rutabaga
+  VERSION = '0.0.1'
+end

data/lib/rutabaga.rb

@@ -0,0 +1,3 @@
+require 'rutabaga/version'
+require 'turnip'
+require 'rutabaga/feature'

data/rutabaga.gemspec

@@ -0,0 +1,20 @@
+# coding: utf-8
+require File.expand_path('../lib/rutabaga/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ['Lukas Oberhuber']
+  gem.email         = ['lukas.oberhuber@simplybusiness.co.uk']
+  gem.description   = %q{Allows using feature from within RSpec and is built on top of Turnip}
+  gem.summary       = %q{Calling Turnip feature files from RSpec, which allows encapsulating a feature inside a describe block}
+  gem.homepage      = 'https://github.com/simplybusiness/rutabaga'
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = 'rutabaga'
+  gem.require_paths = ['lib']
+  gem.version       = Rutabaga::VERSION
+  gem.license       = 'MIT'
+
+  gem.add_runtime_dependency 'turnip',     '>= 1.0.0'
+end

data/spec/feature_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe 'integration', :type => :integration do
+  before do
+    @result = %x(rspec -r rutabaga -fs examples/*_spec.rb)
+  end
+
+  it "shows the correct description" do
+    @result.should include('ensures the feature is called')
+    @result.should include('that 2 + 2 is calculated')
+    @result.should include('my result is 4')
+  end
+
+  it "should not show any pending steps" do
+  	@result.should_not include('PENDING')
+  	@result.should_not include('No such step')
+  end
+
+  it "prints out failures and successes" do
+    @result.should include('6 examples, 1 failure')
+  end
+
+  it "should find features relative to the root" do
+  	@result.should_not include('Feature file not found')
+  end
+
+  it "should scope steps to describe blocks" do
+  	@result.should_not include('Turnip::Ambiguous')
+  end
+
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: rutabaga
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Lukas Oberhuber
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: turnip
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+description: Allows using feature from within RSpec and is built on top of Turnip
+email:
+- lukas.oberhuber@simplybusiness.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- examples/spec_helper.rb
+- examples/test.feature
+- examples/test2.feature
+- examples/test_spec.rb
+- lib/.DS_Store
+- lib/rutabaga.rb
+- lib/rutabaga/feature.rb
+- lib/rutabaga/version.rb
+- rutabaga.gemspec
+- spec/feature_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/simplybusiness/rutabaga
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+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: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Calling Turnip feature files from RSpec, which allows encapsulating a feature
+  inside a describe block
+test_files:
+- spec/feature_spec.rb
+- spec/spec_helper.rb