steak 0.4.0.beta.1 → 1.0.0.beta.1

data/README.rdoc

@@ -6,33 +6,39 @@ http://dl.dropbox.com/u/645329/steak_small.jpg
 
 == What is Steak?
 
-Steak is like Cucumber but in plain Ruby. This is how an acceptance spec looks like in Steak:
+Steak is like Cucumber but in plain Ruby. This is how an acceptance spec looks
+like in Steak:
 
   feature "Main page" do
-  
+
     background do
       create_user :login => "jdoe"
       login_as "jdoe"
     end
-  
+
     scenario "should show existing quotes" do
-      create_quote :text => "The language of friendship is not words, but meanings", 
+      create_quote :text => "The language of friendship is not words, but meanings",
                    :author => "Henry David Thoreau"
 
       visit "/"
-    
+
       page.should have_css(".quote", :count => 1)
       within(:css, ".quote") do
         page.should have_css(".text", :text => "The language of friendship is not words, but meanings")
         page.should have_css(".author", :text => "Henry David Thoreau")
       end
     end
-    
+
   end
-  
-No explicit givens, whens or thens. No steps, no english, just Ruby: RSpec, Steak and, in this example, some factories and Capybara. That's all.
 
-If you are not in Rails but use RSpec, then Steak is just some aliases providing you with the language of acceptance testing (+feature+, +scenario+, +background+). If you are in Rails, you also have a couple of generators, a rake task and full Rails integration testing (meaning Webrat support, for instance)
+No explicit givens, whens or thens. No steps, no english, just Ruby: RSpec,
+Steak and, in this example, some factories and Capybara. That's all.
+
+If you are not in Rails but use RSpec, then Steak is just some aliases
+providing you with the language of acceptance testing (+feature+, +scenario+,
++background+). If you are in Rails, you also have a couple of generators, a
+rake task and full Rails integration testing (meaning Webrat support, for
+instance)
 
 == Getting started
 
@@ -42,27 +48,32 @@ Just install and require the damned gem!
 
   $ gem install steak
 
+(Add the <tt>--pre</tt> modifier to be on top of RSpec 2 instead of RSpec 1.x)
+
 Then in your spec or spec helper:
 
   require 'steak'
-  
+
 That's all. You don't really need to require RSpec.
 
 === In Rails 2.x (stable branch)
 
-Assuming you have already setup rspec-rails, add this to your project's <tt>config/environments/test.rb</tt>:
+Assuming you have already setup rspec-rails, add this to your project's
+<tt>config/environments/test.rb</tt>:
+
+  config.gem "steak", :lib => false
 
-  config.gem "steak"
-  
 Install the gem from the command line:
-  
+
   $ RAILS_ENV=test rake gems:install
-  
+
 Run the generator:
 
   $ script/generate steak
-  
-That will create some basic helper files and directory structure under the +spec/acceptance+ directory, already configured for +Capybara+. If you want to use +Webrat+, just pass it to the generator:
+
+That will create some basic helper files and directory structure under the
+<tt>spec/acceptance</tt> directory, already configured for +Capybara+. If you want to
+use +Webrat+, just pass it to the generator:
 
   $ script/generate steak --webrat
 
@@ -71,64 +82,92 @@ Spend one minute on getting familiar with the structure and files you've got.
 Now you may want to create your first acceptance spec:
 
   $ script/generate acceptance_spec this_is_my_first_feature
-  
+
 You run your acceptance specs just like your regular specs. Individually...
 
-  $ spec spec/acceptance/this_is_my_first_feature_spec.rb
-  
+  $ rspec spec/acceptance/this_is_my_first_feature_spec.rb
+
 ...or all together:
 
-  $ spec spec/acceptance
-  
+  $ rspec spec/acceptance
+
 ...you can also do:
 
   $ rake spec:acceptance
-  
+
 === In Rails 3 (master branch)
 
 Add this to your project's <tt>Gemfile</tt>:
 
-  gem 'steak', '>= 0.4.0.a5'
-  
-And install it:
-  
+  group :development, :test do
+    gem 'rspec-rails', '>= 2.0.0.beta.19'
+    gem 'steak', :git => 'git://github.com/cavalle/steak.git'
+    gem 'capybara'
+    
+    # Other usual suspects:
+    # gem 'delorean'
+    # gem 'database_cleaner'
+    # gem 'spork'
+  end
+
+And install:
+
   $ bundle install
-  
-Run the generator:
 
-  $ rails generate steak
-  
-That will create some basic helper files and directory structure under the +spec/acceptance+ directory, already configured for +Capybara+. If you want to use +Webrat+, just pass it to the generator:
+Run the generators:
+
+  $ rails g rspec:install
+  $ rails g steak:install
 
-  $ rails generate steak --webrat
+That will create some basic helper files and directory structure under the
+<tt>spec/acceptance</tt> directory, already configured for +Capybara+.
 
 Spend one minute on getting familiar with the structure and files you've got.
 
 Now you may want to create your first acceptance spec:
 
-  $ rails generate acceptance_spec this_is_my_first_feature
-  
+  $ rails generate steak:spec this_is_my_first_feature
+
 You run your acceptance specs just like your regular specs. Individually...
 
-  $ spec spec/acceptance/this_is_my_first_feature_spec.rb
-  
+  $ rspec spec/acceptance/this_is_my_first_feature_spec.rb
+
 ...or all together:
 
-  $ spec spec/acceptance
-  
+  $ rspec spec/acceptance
+
 ...you can also do:
 
   $ rake spec:acceptance
   
+== RSpec & Metadata
+
+Steak scenarios are just regular RSpec examples with their metadata attribute 
+<tt>:type</tt> set to <tt>:acceptance</tt>. That's useful if you want to make sure you 
+include helpers or set hooks only for your acceptance specs and not for the 
+rest of the specs in your suite.
+
+You'd do it this way:
+
+  RSpec.configure do |config|
+    # include MyHelpers module in every acceptance spec
+    config.include MyHelpers, :type => :acceptance 
+    
+    config.before(:each, :type => :acceptance) do
+      # Some code to run before any acceptance spec
+    end
+  end
+
 == Resources
 
-  * Source: http://github.com/cavalle/steak
-  * Issues: http://github.com/cavalle/steak/issues
-  * Hashtag: #steakrb
-  * Group: http://groups.google.com/group/steakrb
-  * IRC channel: #steakrb on freenode
-  * Tutorial: http://jeffkreeftmeijer.com/2010/steak-because-cucumber-is-for-vegetarians/
-  
+- Source: http://github.com/cavalle/steak
+- Issues: http://github.com/cavalle/steak/issues
+- Group: http://groups.google.com/group/steakrb
+- IRC channel: #steakrb on freenode
+- Tutorial: http://jeffkreeftmeijer.com/2010/steak-because-cucumber-is-for-vegetarians/
+- Hashtag: #steakrb
+- More resources: http://wiki.github.com/cavalle/steak/resources
+
 == Credits
 
 Steak was created by Luismi Cavallé and improved thanks to the love from:
@@ -140,5 +179,12 @@ Steak was created by Luismi Cavallé and improved thanks to the love from:
 - Jaime Iniesta
 - Emili Parreño
 - Andreas Wolff
-
-Copyright (c) 2009, 2010 Luismi Cavallé, released under the MIT license
+- Wincent Colaiuta
+- Falk Pauser
+- Francesc Esplugas
+- Raúl Murciano
+- Enable Interactive
+- Vojto Rinik
+- Fred Wu
+
+Copyright (c) 2009, 2010 Luismi Cavallé, released under the MIT license

data/Rakefile

@@ -7,7 +7,7 @@ desc 'Default: run specs.'
 task :default => :spec
 
 desc 'Run specs for the steak plugin.'
-Rspec::Core::RakeTask.new(:spec) do |t|
+RSpec::Core::RakeTask.new(:spec) do |t|
   t.pattern = FileList["spec/**/*_spec.rb"]
 end
 

data/lib/rspec-1/rails/generators/acceptance_spec/USAGE

@@ -0,0 +1 @@
+s

data/lib/rspec-1/rails/generators/acceptance_spec/acceptance_spec_generator.rb

@@ -0,0 +1,9 @@
+class AcceptanceSpecGenerator < Rails::Generator::NamedBase
+  def manifest
+    record do |m|
+      m.directory File.join('spec/acceptance', class_path)
+      file_name.gsub!(/_spec$/,"")
+      m.template 'acceptance_spec.rb', File.join('spec/acceptance', class_path, "#{file_name}_spec.rb")
+    end
+  end
+end

data/lib/{generators → rspec-1/rails/generators}/acceptance_spec/templates/acceptance_spec.rb

@@ -5,9 +5,8 @@ feature "Feature name", %q{
   As a ...
   I want to ...
 } do
-  
+
   scenario "Scenario name" do
     true.should == true
   end
-  
-end
+end

data/lib/{generators → rspec-1/rails/generators}/steak/USAGE

@@ -1,8 +1,8 @@
 Description:
     Sets up Steak in your Rails project. This will generate the spec/acceptance directory
     and the necessary files.
-    
-    If you haven't already, You should also run `rails generate rspec:install` to complete the set up.
-    
+
+    If you haven't already, You should also run `./script/generate rspec` to complete the set up.
+
 Examples:
-    `rails generate steak`
+    `./script/generate steak`

data/lib/rspec-1/rails/generators/steak/steak_generator.rb

@@ -0,0 +1,26 @@
+class SteakGenerator < Rails::Generator::Base
+  default_options :driver => 'capybara'
+
+  def initialize(runtime_args, runtime_options = {})
+    puts "Defaulting to Capybara..." if runtime_args.empty?
+    super
+  end
+
+  def manifest
+    record do |m|
+      m.directory 'spec/acceptance/support'
+      m.directory 'lib/tasks'
+      m.template "acceptance_helper.rb", "spec/acceptance/acceptance_helper.rb"
+      m.file "helpers.rb",               "spec/acceptance/support/helpers.rb"
+      m.file "paths.rb",                 "spec/acceptance/support/paths.rb"
+      m.file "steak.rake",               "lib/tasks/steak.rake"
+    end
+  end
+
+  def add_options!(opt)
+    opt.separator ''
+    opt.separator 'Options:'
+    opt.on('--capybara', 'Use Capybara (default).') { |v| options[:driver] = 'capybara' }
+    opt.on('--webrat', 'Use Webrat.') { |v| options[:driver] = 'webrat' }
+  end
+end

data/lib/rspec-1/rails/generators/steak/templates/acceptance_helper.rb

@@ -0,0 +1,18 @@
+require File.dirname(__FILE__) + "/../spec_helper"
+require "steak"
+<%- if options[:driver] == 'webrat' %>
+require "webrat"
+
+Webrat.configure do |config|
+  config.mode = :rails
+end
+<%- else -%>
+require 'capybara/rails'
+
+Spec::Runner.configure do |config|
+  config.include Capybara
+end
+<%- end -%>
+
+# Put your acceptance spec helpers inside /spec/acceptance/support
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}

data/lib/rspec-1/rails/generators/steak/templates/helpers.rb

@@ -0,0 +1,5 @@
+module HelperMethods
+  # Put helper methods you need to be available in all tests here.
+end
+
+Spec::Runner.configuration.include(HelperMethods)

data/lib/rspec-1/rails/generators/steak/templates/paths.rb

@@ -0,0 +1,9 @@
+module NavigationHelpers
+  # Put helper methods related to the paths in your application here.
+
+  def homepage
+    "/"
+  end
+end
+
+Spec::Runner.configuration.include(NavigationHelpers)

data/lib/rspec-1/rails/generators/steak/templates/steak.rake

@@ -0,0 +1,19 @@
+unless ARGV.any? {|a| a =~ /^gems/} # Don't load anything when running the gems:* tasks
+
+require 'spec/rake/spectask'
+
+namespace :spec do
+  desc "Run the code examples in spec/acceptance"
+  Spec::Rake::SpecTask.new(:acceptance => "db:test:prepare") do |t|
+    t.spec_opts = ['--options', "\"#{RAILS_ROOT}/spec/spec.opts\""]
+    t.spec_files = FileList["spec/acceptance/**/*_spec.rb"]
+  end
+
+  # Setup stats to include acceptance specs
+  task :statsetup do
+    require 'code_statistics'
+    ::STATS_DIRECTORIES << %w(Acceptance\ specs spec/acceptance) if File.exist?('spec/acceptance')
+    ::CodeStatistics::TEST_TYPES << "Acceptance specs" if File.exist?('spec/acceptance')
+  end
+end
+end

data/lib/rspec-1/steak.rb

@@ -0,0 +1,23 @@
+module Spec::Example::ExampleGroupMethods
+  alias scenario example
+  alias background before
+end
+
+module Spec::DSL::Main
+  alias feature describe
+end
+
+if defined?(Spec::Rails)
+  module Spec::Rails::Example
+    class AcceptanceExampleGroup < IntegrationExampleGroup
+      include ActionController::RecordIdentifier
+      Spec::Example::ExampleGroupFactory.register(:acceptance, self)
+
+      def method_missing(sym, *args, &block)
+        return Spec::Matchers::Be.new(sym, *args)  if sym.to_s =~ /^be_/
+        return Spec::Matchers::Has.new(sym, *args) if sym.to_s =~ /^have_/
+        super
+      end
+    end
+  end
+end

data/lib/rspec-2/rails/generators/install_generator.rb

@@ -0,0 +1,39 @@
+require 'rails/generators'
+
+module Steak
+  class InstallGenerator < Rails::Generators::Base
+    class_option :webrat, :desc => 'Use Webrat.', :type => :boolean
+    class_option :capybara, :desc => 'Use Capybara.', :type => :boolean
+
+    source_root File.join(File.dirname(__FILE__), 'templates')
+
+    desc <<-DESC
+Description:
+    Sets up Steak in your Rails project. This will generate the
+    spec/acceptance directory and the necessary files.
+
+    If you haven't already, You should also run
+    `rails generate rspec:install` to complete the set up.
+
+Examples:
+    `rails generate steak:install`
+DESC
+
+    def initialize(args=[], options={}, config={})
+      puts "Defaulting to Capybara..." if options.empty?
+      super
+    end
+
+    def manifest
+      empty_directory 'spec/controllers'
+      empty_directory 'spec/acceptance/support'
+      template "acceptance_helper.rb", "spec/acceptance/acceptance_helper.rb"
+      copy_file "helpers.rb",           "spec/acceptance/support/helpers.rb"
+      copy_file "paths.rb",             "spec/acceptance/support/paths.rb"
+    end
+
+    def driver
+      @driver = options.webrat? ? 'webrat' : 'capybara'
+    end
+  end
+end

data/lib/rspec-2/rails/generators/spec_generator.rb

@@ -0,0 +1,33 @@
+require 'rails/generators'
+require 'active_support/inflector/inflections'
+
+module Steak
+  class SpecGenerator < Rails::Generators::NamedBase
+    source_root File.join(File.dirname(__FILE__), 'templates')
+
+    desc <<-DESC
+Description:
+    Create an acceptance spec for the feature NAME in the
+    'spec/acceptance' folder.
+
+Example:
+    `rails generate steak:spec checkout`
+
+    Creates an acceptance spec for the "checkout" feature:
+        spec/acceptance/checkout_spec.rb
+DESC
+
+    def manifest
+      empty_directory File.join('spec/acceptance', class_path)
+      file_name.gsub!(/_spec$/, "")
+
+      @feature_name  = file_name.titleize
+      @relative_path = "../" * class_path.size
+      
+      target = File.join('spec/acceptance', class_path, 
+                         "#{file_name}_spec.rb")
+
+      template 'acceptance_spec.rb', target
+    end
+  end
+end