steak 1.1.0 → 2.0.0.beta1

data/{MIT-LICENSE → LICENSE}

@@ -1,4 +1,4 @@
-Copyright (c) 2009 Luismi Cavallé
+Copyright (c) 2009-2011 Luismi Cavallé
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -0,0 +1,110 @@
+## TODO
+* Rake stats
+* Manual test different scenarios: rspec-rails already present, upgrade from Steak-1… 
+
+# Steak
+
+The delicious combination of RSpec and Capybara for Acceptance BDD
+
+![Steak!!](http://dl.dropbox.com/u/645329/steak_small.jpg "Steak!!")
+
+## What is Steak?
+
+Steak is a minimal extension of RSpec-Rails that adds several conveniences to do acceptance testing of Rails applications using Capybara. It's an alternative to Cucumber in plain Ruby. This is how and acceptance spec looks like in Steak:
+
+    feature 'Main page' do
+
+      background do
+        create_user :login => 'jdoe'
+      end
+
+      scenario 'should show existing quotes' do
+        create_quote :text => 'The language of friendship is not words, but meanings',
+                     :author => 'Henry David Thoreau'
+
+        login_as 'jdoe'
+        visit '/'
+
+        within('.quote') do
+          page.should have_content('The language of friendship is not words, but meanings')
+          page.should have_content('Henry David Thoreau')
+        end
+      end
+      
+    end
+
+No givens, whens or thens. No steps, no english, just Ruby. The delicious combination of RSpec and Capybara. That's Steak!
+
+## Why Steak?
+
+If, after all, this is just RSpec + Capybara, why does Steak even exist? Do I really need it?
+
+Basically Steak exists for three reasons:
+
+1. **Making a point**. First of all, Steak proposes that using RSpec and Capybara for acceptance testing is a sensible alternative to Cucumber. It also sets a name to refer to that approach.
+1. **Adding convenience**. As a gem, Steak aims to make the experience as convenient as possible. It provides Rails integration testing support and several generators and rake tasks so that setting up a new project or creating and running specs are quick and seamless tasks. A natural extension of RSpec-Rails.
+1. **Building a community**. No development approach or ruby gem is really valuable without an active community behind it. The mailing list, the IRC channel, the wiki or the twitter account are useful tools to build a community of users that help each other by sharing knowledge, resources and best practices.
+
+## Getting Started
+
+_NOTE: The latest version of Steak assumes that you're testing a Rails 3 application, with RSpec 2 and Capybara. For Rails 2, RSpec 1 or Webrat you should use Steak 1.x (or consider upgrading to non-obsolete technologies ;P)_
+
+It's super-easy to get you started. Just add the gem to your `Gemfile`…
+
+    group :test, :development do
+      gem 'steak'
+      # ...
+
+…and then install the gem and run the generator:
+
+    $ bundle
+    $ rails g steak:install
+
+You're now set up! Take a look at the default directory structure you've got under `spec/acceptance`. It will help you organize the helpers and configurations for your acceptance specs.
+
+Note that Steak is the only dependency you really need, you can safely remove any reference to `capybara`, `rspec-rails` or `rspec` from your `Gemfile`, they will be included by Steak. Also note that, unless previously executed, Steak will run the RSpec generator so you don't need to invoke it.
+
+## Creating and running specs
+
+You can create your specs by hand, however you may prefer to use the generator:
+
+    $ rails g steak:spec my_first_feature
+
+To run your acceptance specs you just do like with any other spec…
+
+    $ rspec spec/acceptance/my_first_feature_spec.rb
+
+…or using rake:
+
+    $ rake spec:acceptance
+
+## Resources
+
+* [Source code](http://github.com/cavalle/steak) – Lurking and forking
+* [Issues](http://github.com/cavalle/steak/issues) – Bugs and feature requests
+* [Google Group](http://groups.google.com/group/steakrb) & [IRC channel](irc://irc.freenode.net/jenkinsci) – Help and discussion
+* [Twitter](http://twitter.com/steakrb) – Announcements and mentions
+* [Wiki](https://github.com/cavalle/steak/wiki) – Tutorials, docs and other resources
+
+## Credits
+
+Steak was created by [Luismi Cavallé](http://lmcavalle.com) and improved thanks to the love from:
+
+* Álvaro Bautista
+* Felipe Talavera
+* Paco Guzmán
+* Jeff Kreeftmeijer
+* Jaime Iniesta
+* Emili Parreño
+* Andreas Wolff
+* Wincent Colaiuta
+* Falk Pauser
+* Francesc Esplugas
+* Raúl Murciano
+* Enable Interactive
+* Vojto Rinik
+* Fred Wu
+* Sergio Espeja
+* Joao Carlos
+
+Copyright © 2009 - 2011 Luismi Cavallé, released under the MIT license

data/lib/generators/steak/install_generator.rb

@@ -0,0 +1,12 @@
+module Steak
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.join(File.dirname(__FILE__), 'templates')
+
+      def main
+        generate    'rspec:install'
+        directory   'spec/acceptance'
+      end
+    end
+  end
+end

data/lib/generators/steak/spec_generator.rb

@@ -0,0 +1,11 @@
+module Steak
+  module Generators
+    class SpecGenerator < Rails::Generators::NamedBase
+      source_root File.join(File.dirname(__FILE__), 'templates')
+
+      def main
+        template 'acceptance_spec.rb', File.join('spec/acceptance', class_path, "#{file_name}_spec.rb")
+      end
+    end
+  end
+end

data/lib/generators/steak/templates/acceptance_spec.rb

@@ -0,0 +1,13 @@
+require 'acceptance/acceptance_helper'
+
+feature '<%= human_name %>', %q{
+  In order to ...
+  As a ...
+  I want ...
+} do
+
+  scenario 'first scenario' do
+    true.should == true
+  end
+
+end

data/lib/generators/steak/templates/spec/acceptance/acceptance_helper.rb

@@ -0,0 +1,4 @@
+require 'spec_helper'
+
+# Put your acceptance spec helpers inside spec/acceptance/support
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}

data/lib/generators/steak/templates/spec/acceptance/support/helpers.rb

@@ -0,0 +1,6 @@
+module HelperMethods
+  # Put helper methods you need to be available in all acceptance specs here.
+
+end
+
+RSpec.configuration.include HelperMethods, :type => :acceptance

data/lib/{rspec-2/rails/generators/templates → generators/steak/templates/spec/acceptance/support}/paths.rb

@@ -6,4 +6,4 @@ module NavigationHelpers
   end
 end
 
-RSpec.configuration.include NavigationHelpers, :type => :acceptance
+RSpec.configuration.include NavigationHelpers, :type => :acceptance

data/lib/steak.rb

@@ -1,11 +1,5 @@
-begin
-  require 'rspec/core'
-rescue LoadError
-  require 'spec'       
-end
+require 'capybara/rspec'
+require 'rspec-rails'
 
-if defined?(RSpec::Core)
-  require 'rspec-2/steak'
-else
-  require 'rspec-1/steak'
-end
+require 'steak/railtie'
+require 'steak/acceptance_example_group'

data/lib/steak/acceptance_example_group.rb

@@ -0,0 +1,12 @@
+module Steak  
+  module AcceptanceExampleGroup
+    extend ActiveSupport::Concern
+    
+    included do
+      include RSpec::Rails::RequestExampleGroup
+      metadata[:type] = :acceptance
+    end
+  end
+end
+
+RSpec.configuration.include Steak::AcceptanceExampleGroup, :capybara_feature => true

data/lib/steak/railtie.rb

@@ -0,0 +1,7 @@
+module Steak
+  class Railtie < ::Rails::Railtie
+    rake_tasks do
+      load 'tasks/steak_tasks.rake'
+    end
+  end
+end

data/lib/steak/version.rb

@@ -0,0 +1,3 @@
+module Steak
+  VERSION = '2.0.0.beta1'
+end

data/lib/tasks/steak_tasks.rake

@@ -0,0 +1,14 @@
+namespace :spec do
+  desc 'Run the acceptance specs in spec/acceptance'
+  RSpec::Core::RakeTask.new(:acceptance => 'db:test:prepare') do |t|
+    t.pattern = 'spec/acceptance/**/*_spec.rb'
+  end
+  
+  task :statsetup do
+    if File.exist?('spec/acceptance')
+      require 'rails/code_statistics'
+      ::STATS_DIRECTORIES << ['Acceptance specs', 'spec/acceptance'] 
+      ::CodeStatistics::TEST_TYPES << 'Acceptance specs'
+    end
+  end
+end

data/spec/acceptance/creating_specs_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+
+feature 'Creating acceptance specs', %q{
+  In order to not having to do it manually
+  As a lazy Rails developer
+  I want empty new specs to be generated for me
+} do
+
+  scenario 'using the spec generator' do
+    new_project_from :rails_project_with_steak
+
+    run 'rails g steak:spec my_first_feature'
+
+    path('spec/acceptance/my_first_feature_spec.rb').should exist
+    content_of('spec/acceptance/my_first_feature_spec.rb').should include("require 'acceptance/acceptance_helper'")
+    content_of('spec/acceptance/my_first_feature_spec.rb').should include("feature 'My first feature'")
+
+    run 'rspec spec/acceptance/my_first_feature_spec.rb'
+
+    output.should =~ /1 example, 0 failures/
+  end
+
+  scenario 'under a subdirectory' do
+    new_project_from :rails_project_with_steak
+
+    run 'rails g steak:spec subdir/my_first_feature'
+
+    content_of('spec/acceptance/subdir/my_first_feature_spec.rb').should include("feature 'My first feature'")
+
+    run 'rspec spec/acceptance/subdir/my_first_feature_spec.rb'
+
+    output.should =~ /1 example, 0 failures/
+  end
+  
+  scenario 'with Capybara and paths' do
+    new_project_from :rails_project_with_steak
+    
+    create_file 'spec/acceptance/capybara_spec.rb', <<-RSPEC
+      require 'acceptance/acceptance_helper'
+
+      feature 'Capybara and paths' do
+        scenario 'should visit homepage' do
+          visit homepage
+          
+          page.should have_content("Ruby on Rails: Welcome aboard")
+        end
+      end
+    RSPEC
+    
+    run 'rspec spec/acceptance/capybara_spec.rb'
+
+    output.should =~ /1 example, 0 failures/
+  end
+  
+  scenario 'with Rails integration testing support' do
+    new_project_from :rails_project_with_steak
+    
+    create_file 'spec/acceptance/integration_spec.rb', <<-RSPEC
+      require 'acceptance/acceptance_helper'
+
+      feature 'Capybara and paths' do
+        scenario 'should visit homepage' do
+          get '/'
+          
+          status.should == 200
+        end
+      end
+    RSPEC
+    
+    run 'rspec spec/acceptance/integration_spec.rb'
+
+    output.should =~ /1 example, 0 failures/
+  end
+
+end

data/spec/acceptance/getting_started_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+feature 'Getting started', %q{
+  In order to start coding my awesome new project
+  As a Rails developer
+  I want set up my project for Acceptance BDD
+} do
+
+  scenario 'from an empty Rails project' do
+    new_project_from :rails_project
+
+    append_to 'Gemfile', <<-GEMS
+      group :test, :development do
+        gem 'steak', :path => '#{root_path}'
+      end
+    GEMS
+
+    run 'bundle --local'
+    run 'rails g steak:install'
+
+    # rspec-rails should be present
+    path('spec').should exist
+    path('spec/spec_helper.rb').should exist
+
+    # steak should be present
+    path('spec/acceptance').should exist
+    path('spec/acceptance/acceptance_helper.rb').should exist
+    path('spec/acceptance/support').should exist
+    path('spec/acceptance/support/helpers.rb').should exist
+    path('spec/acceptance/support/paths.rb').should exist
+  end
+
+end

data/spec/acceptance/rake_support_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+feature 'Rake support', %q{
+  In order to conveniently run my specs along with the rest of my test suite
+  As a Rails developer
+  I want rake support in Steak
+} do
+
+  background do
+    new_project_from :rails_project_with_steak
+    create_file 'spec/models/model_spec.rb', <<-RSPEC
+      require 'spec_helper'
+
+      describe Object do
+        it { should respond_to :to_s }
+      end
+    RSPEC
+    run 'rails g steak:spec my_spec'
+  end
+
+  scenario 'to run acceptance specs as part of the test suite' do
+    run 'rake spec'
+    output.should =~ /2 examples, 0 failures/
+
+    run 'rake'
+    output.should =~ /2 examples, 0 failures/
+  end
+
+  scenario 'to run only acceptance specs' do
+    run 'rake spec:acceptance'
+    output.should =~ /1 example, 0 failures/
+  end
+  
+  scenario "to get stats" do
+    run 'rake stats'
+    output.should =~ /Model specs \D+ 5 /
+    output.should =~ /Acceptance specs \D+ [1-9]+ /
+  end
+
+end

data/spec/fixtures/rails_project/.gitignore

@@ -0,0 +1,5 @@
+.bundle
+db/*.sqlite3
+log/*.log
+tmp/
+.sass-cache/

data/spec/fixtures/rails_project/Gemfile

@@ -0,0 +1,55 @@
+source 'http://rubygems.org'
+
+gem 'rails', '3.1.0.rc1'
+
+# Bundle edge Rails instead:
+# gem 'rails',     :git => 'git://github.com/rails/rails.git'
+
+platforms :ruby do
+  gem 'sqlite3'
+end
+
+platforms :jruby do
+  gem 'activerecord-jdbc-adapter'
+
+  # As rails --database switch does not support derby, hsqldb, h2 nor mssql
+  # as valid values, if you are not using SQLite, comment out the SQLite gem
+  # below and uncomment the gem declaration for the adapter you are using.
+  # If you are using oracle, db2, sybase, informix or prefer to use the plain
+  # JDBC adapter, comment out all the adapter gems below.
+
+  # SQLite JDBC adapter
+  gem 'jdbc-sqlite3', :require => false
+
+  # Derby JDBC adapter
+  #gem 'activerecord-jdbcderby-adapter'
+
+  # HSQL JDBC adapter
+  #gem 'activerecord-jdbchsqldb-adapter'
+
+  # H2 JDBC adapter
+  #gem 'activerecord-jdbch2-adapter'
+
+  # SQL Server JDBC adapter
+  #gem 'activerecord-jdbcmssql-adapter'
+
+end
+
+
+# Asset template engines
+gem 'json'
+gem 'sass'
+gem 'coffee-script'
+gem 'uglifier'
+
+gem 'jquery-rails'
+
+# Use unicorn as the web server
+# gem 'unicorn'
+
+# Deploy with Capistrano
+# gem 'capistrano'
+
+# To use debugger
+# gem 'ruby-debug'
+