rutabaga 2.0.2 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cc0dcdb391810d9fd1f6bc91700dc5da886f8e24
-  data.tar.gz: 5aa5d5f6fb08f311e386583871c82dac4b7896ea
+  metadata.gz: dc9f8613aa7909bb48702020985d606fb913714f
+  data.tar.gz: 8e729b8b2db01db9412101f6d992dff950b995aa
 SHA512:
-  metadata.gz: 07a3659dfc4de315f0c950d347aabc56ebaefc3630e807ff2b73d8c233e674465c00bdde7a3dbf74548255d6957ae0c42c4bb87219ddd5ba7291ab765a18b719
-  data.tar.gz: 295d4bbdb7399f75e6d9da728786c8f3889c98f32d145e37be63f9e342e80342f65083915711990dad0b9c31b3f4dd8b290c6abf211ed7f9e840b588a3ebd46d
+  metadata.gz: a9bfd33defd258d57e80832cbded5661362a6e171e141ada65b806d22dece3e001fdcf94c98a0bdd6c80769912f27cefe0b46c073a51bb0c2b3ed03dee14835f
+  data.tar.gz: 9fc5f56fbeb390ac53a749879e84285e82774d4aa302e444b742dbe59d206b7fb9f0bee80c59db1e36f0ba2e7dd387776e56f9eabe7942722a02d2a7c7272964

data/README.md

@@ -2,7 +2,7 @@
 
 ![image](rutabaga-vs-turnip.jpg)
 
-[Turnip](https://github.com/jnicklas/turnip) hacks to enable running turnips from inside spec files, rather than outside.
+[Turnip](https://github.com/jnicklas/turnip) extension to enable running turnip features 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. The steps are then scoped to that particular test.
 
@@ -27,21 +27,28 @@ group :test do
 end
 ```
 
-Now edit the `.rspec` file in your project directory (create it if doesn't
+Choose which mode you want to use: __Turnip compatibility mode__ or __No Turnip mode__.
+
+### Turnip compatibility mode
+
+In this mode, you can still have and call classic Turnip features directly, as long
+as they are situated under the `spec/features` directory.
+
+Edit the `.rspec` file in your project directory (create it if doesn't
 exist), and add the following:
 
 ```
 -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:
+Add the following line to the bottom of your `spec_helper.rb` in order to use
+Turnip global step definitions:
 
 ```ruby
-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)
+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).
 
 ```ruby
 if defined? RSpec # otherwise fails on non-live environments
@@ -52,6 +59,22 @@ if defined? RSpec # otherwise fails on non-live environments
 end
 ```
 
+### No Turnip Mode
+
+If you do not want to use Turnip features then you can disable turnip by adding the following to you `.rspec` file instead of `-r rutabaga`:
+
+```ruby
+-r rutabaga/no_turnip
+```
+
+### Capybara support
+
+Add the following line to the bottom of your `spec_helper.rb` in order to use Capybara javascript driver (when features are tagged with `@javascript`):
+
+```ruby
+require 'turnip/capybara'
+```
+
 ## Usage
 
 ### Running a feature file from a spec file
@@ -100,14 +123,12 @@ Steps are defined in the same way as in Turnip, however, steps can be defined wi
 
 ```ruby
 feature "step will only be in this context" do
-
   step "action :named" do |named| do
     expect(named).to eq("a name")
   end
 end
 
 feature "step 'action :named' is not available here" do
-
   # missing step will cause tests to be marked as pending"
 end
 ```
@@ -120,9 +141,9 @@ Other than these differences, Rutabaga is a tiny shim over Turnip and all featur
 
 ## Why?
 
-* Document business rules in Gherkin/Turnip/Cucumber human readable language
-* Test those rules whereever/however appropriate (not just through Capybara/black box)
-* Use the full power of RSpec (so being able to describe a class and then test it)
+* Allows you to document business rules in Gherkin/Turnip/Cucumber human readable language
+* Test those rules wherever/however appropriate (not just through Capybara/black box)
+* Use the full power of RSpec (being able to describe a class and then test it)
 
 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 to test premium changes when a customer changes their insurance coverage.
 
@@ -130,12 +151,15 @@ These rules are often implemented in a Model, a lib class, or some other specifi
 
 In any case, business rules are usually implemented somewhere inside a class tested by a unit test. Those business rules should be tested in Cucumber/Turnip without having to go through the whole system, and without having to have duplicate tests, one inside rspec and another inside features.
 
-The goal is to test just the business rule, in Rutabaga, and not the login, the html, the steps to get there, etc. That way, when the rule changes, only the feature, the test code and the class in question need to change. The test is not affected by wider ranging changes, and is therefore less brittle. The features run at the unit code level, but are acceptance tests.
+The goal is to test just the business rule in Rutabaga, and not the login, the html, the steps to get there, etc. That way, when the rule changes, only the feature, the test code and the class in question need to change. The test is not affected by wider ranging changes, and is therefore less brittle. The features run at the unit code level, but are acceptance tests.
 
 ## Notes/Issues
 
-1. Capybara's rspec extension also redefines feature, so rutabaga will block capaybara's feature example groups
-   from working.
+1. Capybara's rspec extension also redefines feature, so rutabaga will block
+   capaybara's feature example groups from working.
+1. In order to call a specific scenario, you can use `rspec`'s filtering. Here is an example:
+    `$ rspec spec/test_file_spec.rb -e "Title of my scenario"`.
+   This will only call the Scenario titled `Title of my scenario` in file `spec/test_file_spec.rb`
 
 ## Contributing
 
@@ -157,7 +181,7 @@ Put the following (example in a `Gemfile_for_xxx`) to test other versions of gem
 # Use global Gemfile and customize
 eval(IO.read('Gemfile'), binding)
 
-gem 'turnip', '1.3.1'
+gem 'turnip', '2.0.0'
 ```
 
 ## Copyright

data/examples/pattern/test_pattern_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe "it prints out the RSpec.configuration.pattern" do
+  it "examples/test2.feature" do
+    puts "RSpec.configuration.pattern: #{RSpec.configuration.pattern}"
+  end
+end

data/lib/rutabaga/no_turnip.rb

@@ -0,0 +1,27 @@
+module Rutabaga
+  NO_TURNIP = true
+end
+
+require 'rutabaga'
+##
+#
+# Disables turnip completely
+#
+module Turnip
+  module RSpec
+    module Loader
+      def load(*a, &b)
+        if a.first.end_with?('.feature')
+          ::RSpec.warning "Calling features directly has been disabled by rutabaga. To re-enable, do not require rutabaga/no_turnip."
+        else
+          super
+        end
+      end
+    end
+  end
+end
+
+::RSpec.configure do |c|
+  # Blow away rutabaga's pattern if still there
+  c.pattern.gsub!(",features/**/*.feature", "")
+end

data/lib/rutabaga/turnip.rb

@@ -0,0 +1,35 @@
+require 'rutabaga'
+##
+#
+# Enables turnip in the spec/features
+#
+module Turnip
+  module RSpec
+    module Loader
+      def load(*a, &b)
+        if a.first.end_with?('.feature')
+          if legal_directories.none? {|d| a.first.end_with? d }
+            ::RSpec.warning "Features can only be called from turnip enable directories. These are configured " \
+                            "in RSpec.configuration.pattern which is currently '#{::RSpec.configuration.pattern}'"
+          else
+            require_if_exists 'turnip_helper'
+            require_if_exists 'spec_helper'
+
+            Turnip::RSpec.run(a.first)
+          end
+        else
+          super
+        end
+      end
+
+      private
+
+      def legal_directories
+        @legal_directories ||= ::RSpec.configuration.pattern.split(',')
+          .select {|p| /\.feature\Z/ =~ p}
+          .map {|d| Dir.glob(File.join(::RSpec.configuration.default_path,d)) }
+          .flatten
+      end
+    end
+  end
+end

data/lib/rutabaga/util.rb

@@ -64,5 +64,9 @@ 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")
+  if defined?(Rutabaga::NO_TURNIP)
+    c.pattern.gsub!(",**/*.feature", "")
+  else
+    c.pattern.gsub!(",**/*.feature", ",features/**/*.feature")
+  end
 end

data/lib/rutabaga/version.rb

@@ -1,3 +1,3 @@
 module Rutabaga
-  VERSION = '2.0.2'
+  VERSION = '2.1.1'
 end

data/lib/rutabaga.rb

@@ -4,3 +4,4 @@ require 'turnip'
 require 'rutabaga/feature'
 require 'rutabaga/example_group/feature'
 require 'rutabaga/util'
+require 'rutabaga/turnip' # is disabled by 'rutabaga/no_turnip'

data/spec/features/fixture.feature

@@ -0,0 +1,7 @@
+Feature: This tests whether features are loaded from feature directory
+
+This is here for file glob testing purposes
+
+Scenario: Tester
+  Given this step does not have a definition
+  Then this test will fail

data/spec/no_turnip_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+
+describe 'no_turnip', :type => :integration do
+  describe 'turnip disabled' do
+    before(:all) do
+      @result = %x(rspec -r rutabaga -r rutabaga/no_turnip examples/test.feature 2>&1)
+    end
+
+    it "should raise an error when trying to call turnip features directly" do
+      expect(@result).to include("Calling features directly has been disabled by rutabaga")
+      expect(@result).to include("rutabaga/no_turnip")
+    end
+
+    it "has the correct file pattern" do
+      result = %x(rspec -r rutabaga/no_turnip -r rutabaga examples/pattern/test_pattern_spec.rb)
+      expect(result).to include("RSpec.configuration.pattern: **{,/*/**}/*_spec.rb\n")
+      result = %x(rspec -r rutabaga -r rutabaga/no_turnip -r rutabaga examples/pattern/test_pattern_spec.rb)
+      expect(result).to include("RSpec.configuration.pattern: **{,/*/**}/*_spec.rb\n")
+      result = %x(rspec -r rutabaga/no_turnip examples/pattern/test_pattern_spec.rb)
+      expect(result).to include("RSpec.configuration.pattern: **{,/*/**}/*_spec.rb\n")
+    end
+  end
+
+  describe 'turnip enabled' do
+    describe "in correct directory" do
+      it "should be able to call features directly" do
+        @result = %x(rspec -r rutabaga/turnip spec/features/fixture.feature 2>&1)
+        expect(@result).to include("No such step")
+      end
+
+      it "rutabaga turnip is the default" do
+        @result = %x(rspec -r rutabaga spec/features/fixture.feature 2>&1)
+        expect(@result).to include("No such step")
+      end
+    end
+
+    describe "outside of the correct directory" do
+      before(:all) do
+        @result = %x(rspec -r rutabaga examples/test.feature 2>&1)
+      end
+
+      it "warns about the directory" do
+        expect(@result).to include("WARNING: Features can only be called from turnip enable directories")
+      end
+    end
+
+    it "has the correct file pattern" do
+      result = %x(rspec -r rutabaga examples/pattern/test_pattern_spec.rb)
+      expect(result).to include("RSpec.configuration.pattern: **{,/*/**}/*_spec.rb,features/**/*.feature\n")
+      result = %x(rspec -r rutabaga/turnip -r rutabaga examples/pattern/test_pattern_spec.rb)
+      expect(result).to include("RSpec.configuration.pattern: **{,/*/**}/*_spec.rb,features/**/*.feature\n")
+      result = %x(rspec -r rutabaga -r rutabaga/turnip -r rutabaga examples/pattern/test_pattern_spec.rb)
+      expect(result).to include("RSpec.configuration.pattern: **{,/*/**}/*_spec.rb,features/**/*.feature\n")
+      result = %x(rspec -r rutabaga/turnip examples/pattern/test_pattern_spec.rb)
+      expect(result).to include("RSpec.configuration.pattern: **{,/*/**}/*_spec.rb,features/**/*.feature\n")
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rutabaga
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.1.1
 platform: ruby
 authors:
 - Lukas Oberhuber
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-26 00:00:00.000000000 Z
+date: 2016-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: turnip
@@ -109,6 +109,7 @@ files:
 - README.md
 - Rakefile
 - examples/compatibility/compatibility_spec.rb
+- examples/pattern/test_pattern_spec.rb
 - examples/spec_helper.rb
 - examples/test.feature
 - examples/test2.feature
@@ -120,11 +121,15 @@ files:
 - lib/rutabaga.rb
 - lib/rutabaga/example_group/feature.rb
 - lib/rutabaga/feature.rb
+- lib/rutabaga/no_turnip.rb
+- lib/rutabaga/turnip.rb
 - lib/rutabaga/util.rb
 - lib/rutabaga/version.rb
 - rutabaga-vs-turnip.jpg
 - rutabaga.gemspec
 - spec/feature_spec.rb
+- spec/features/fixture.feature
+- spec/no_turnip_spec.rb
 - spec/rutabaga/util_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/simplybusiness/rutabaga
@@ -154,6 +159,8 @@ summary: Calling Turnip feature files from RSpec, which allows encapsulating a f
   inside a describe block
 test_files:
 - spec/feature_spec.rb
+- spec/features/fixture.feature
+- spec/no_turnip_spec.rb
 - spec/rutabaga/util_spec.rb
 - spec/spec_helper.rb
 has_rdoc: