steak 0.3.0

data/README.rdoc

@@ -0,0 +1,84 @@
+= Steak
+
+Minimalist acceptance testing on top of RSpec
+
+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:
+
+  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", 
+                   :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 and full Rails integration testing (meaning Webrat support, for instance)
+
+== Getting started
+
+=== Not in Rails
+
+Just install and require the damned gem!
+
+  $ [sudo] gem install steak
+
+Then in your spec or spec helper:
+
+  require 'rubygems'
+  require 'steak'
+  
+That's all. You don't really need to require RSpec.
+  
+=== In Rails
+
+Assuming you have already setup rspec-rails, add this to your project's <tt>config/environments/test.rb</tt>:
+
+  config.gem "steak"
+  
+Install the gem from the command line:
+  
+  $ [sudo] 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+ directory, already configured for +Webrat+.
+
+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
+  
+...or all together:
+
+  $ spec spec/acceptance
+  
+== Credits
+
+Steak is developed and maintained by Luismi Cavallé with the help and support of the rest of the BeBanjo team: Sergio Gil and Jorge Gómez Sancha.
+
+Copyright (c) 2009 Luismi Cavallé, released under the MIT license

data/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/generators/acceptance_spec/templates/acceptance_spec.rb

@@ -0,0 +1,13 @@
+require File.dirname(__FILE__) + '/acceptance_helper'
+
+feature "Feature name", %q{
+  In order to ...
+  As a ...
+  I want to ...
+} do
+  
+  scenario "Scenario name" do
+    true.should == true
+  end
+  
+end

data/generators/steak/USAGE

@@ -0,0 +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 `./script/generate rspec` to complete the set up.
+    
+Examples:
+    `./script/generate steak`

data/generators/steak/steak_generator.rb

@@ -0,0 +1,12 @@
+class SteakGenerator < Rails::Generator::Base
+  def manifest
+    record do |m|
+      m.directory 'spec/acceptance/support'
+      m.directory 'lib/tasks'
+      m.file "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
+end

data/generators/steak/templates/acceptance_helper.rb

@@ -0,0 +1,10 @@
+require File.dirname(__FILE__) + "/../spec_helper"
+require "steak"
+require "webrat"
+
+Webrat.configure do |config|
+  config.mode = :rails
+end
+
+# Put your acceptance spec helpers inside /spec/acceptance/support
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}

data/generators/steak/templates/helpers.rb

@@ -0,0 +1,4 @@
+module HelperMethods
+end
+
+Spec::Runner.configuration.include(HelperMethods)

data/generators/steak/templates/paths.rb

@@ -0,0 +1,7 @@
+module NavigationHelpers
+  def homepage
+    "/"
+  end
+end
+
+Spec::Runner.configuration.include(NavigationHelpers)

data/generators/steak/templates/steak.rake

@@ -0,0 +1,9 @@
+load File.dirname(__FILE__) + '/rspec.rake'
+
+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
+end

data/lib/steak.rb

@@ -0,0 +1,28 @@
+require 'rubygems'
+require 'spec'
+
+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/spec/acceptance/acceptance_helper.rb

@@ -0,0 +1,51 @@
+require 'rubygems'
+require 'spec'
+require File.dirname(__FILE__) + "/../../lib/steak"
+require 'tempfile'
+
+module Factories
+  def create_spec(options)
+    options = {:content => options} unless options.is_a?(Hash)
+    path = (options[:path] || Dir.tmpdir) + "/#{String.random}_spec.rb"
+    File.open(path, "w") do |file|
+      file.write options[:content]
+    end
+    path
+  end
+  
+  def create_rails_app(options = {})
+    path = Dir.tmpdir + "rails_app_#{String.random}"
+    FileUtils.rm_rf path
+    `rails #{path}`
+    File.open(path + "/config/environments/test.rb", "a") do |file|
+      file.write "\nconfig.gem 'rspec-rails', :lib => false\n"
+    end
+    FileUtils.cp_r File.dirname(__FILE__) + "/../../", path + "/vendor/plugins/steak"
+    
+    unless options[:setup_steak] == false
+      Dir.chdir path do
+        `script/generate rspec`
+        `script/generate steak`
+      end
+    end
+    
+    path
+  end
+  
+end
+
+module HelperMethods
+  def run_spec(file_path)
+    `spec #{file_path} 2>&1`
+  end
+end
+
+class String
+  CHARS = ('a'..'z').to_a + ('A'..'Z').to_a
+  def self.random(size = 8)
+    (0..size).map{ CHARS[rand(CHARS.length)] }.join
+  end
+end
+
+Spec::Runner.configuration.include(Factories)
+Spec::Runner.configuration.include(HelperMethods)

data/spec/acceptance/acceptance_spec_generator_spec.rb

@@ -0,0 +1,45 @@
+require File.dirname(__FILE__) + "/acceptance_helper.rb"
+
+feature "Acceptance spec generator for rails", %q{
+  In order to quickly add a new acceptance spec
+  As a developer
+  I want to run a generator that creates it for me
+} do
+  
+  background do
+    @rails_app = create_rails_app
+  end
+  
+  scenario "Adding new acceptance spec" do
+    Dir.chdir @rails_app do
+      `script/generate acceptance_spec document_creation`
+    end
+  
+    File.exist?(@rails_app + "/spec/acceptance/document_creation_spec.rb").should be_true
+  end
+  
+  scenario "Adding new acceptance spec (plural name)" do
+    Dir.chdir @rails_app do
+      `script/generate acceptance_spec creating_documents`
+    end
+  
+    File.exist?(@rails_app + "/spec/acceptance/creating_documents_spec.rb").should be_true
+  end
+  
+  scenario "Adding new acceptance spec (pascalized name)" do
+    Dir.chdir @rails_app do
+      `script/generate acceptance_spec DocumentCreation`
+    end
+  
+    File.exist?(@rails_app + "/spec/acceptance/document_creation_spec.rb").should be_true
+  end
+  
+  scenario "Adding new acceptance spec (name ending with _spec)" do
+    Dir.chdir @rails_app do
+      `script/generate acceptance_spec document_creation_spec`
+    end
+  
+    File.exist?(@rails_app + "/spec/acceptance/document_creation_spec.rb").should be_true
+  end
+
+end

data/spec/acceptance/basic_spec.rb

@@ -0,0 +1,51 @@
+require File.dirname(__FILE__) + "/acceptance_helper.rb"
+
+feature "Acceptance spec execution", %q{
+  In order to write better software
+  As a ruby developer
+  I want to execute acceptance specs
+} do
+  
+  scenario "Minimal acceptance spec" do
+    spec_file = create_spec <<-SPEC
+      require '#{File.dirname(__FILE__) + "/../../lib/steak"}'  
+      feature "Minimal spec" do
+        scenario "First scenario" do
+          true.should be_true
+        end
+      end
+    SPEC
+    output = run_spec spec_file
+    output.should =~ /1 example, 0 failures/
+  end
+  
+  scenario "Minimal acceptance spec that fails" do
+    spec_file = create_spec <<-SPEC
+      require '#{File.dirname(__FILE__) + "/../../lib/steak"}'  
+      feature "Minimal spec" do
+        scenario "First scenario" do
+          true.should be_false
+        end
+      end
+    SPEC
+    output = run_spec spec_file
+    output.should =~ /1 example, 1 failure/
+  end
+  
+  scenario "Acceptance spec with background" do
+    spec_file = create_spec <<-SPEC
+      require '#{File.dirname(__FILE__) + "/../../lib/steak"}'  
+      feature "Minimal spec" do
+        background do
+          @value = 17
+        end
+        scenario "First scenario" do
+          @value.should == 17
+        end
+      end
+    SPEC
+    output = run_spec spec_file
+    output.should =~ /1 example, 0 failures/
+  end
+  
+end

data/spec/acceptance/rails_spec.rb

@@ -0,0 +1,41 @@
+require File.dirname(__FILE__) + "/acceptance_helper.rb"
+
+feature "Acceptance spec execution", %q{
+  In order to write better web apps
+  As a rails developer
+  I want to execute acceptance specs
+} do
+  
+  scenario "Minimal acceptance spec" do
+    rails_app = create_rails_app
+    spec_file = create_spec :path    => rails_app + "/spec/acceptance", 
+                            :content => <<-SPEC
+      require File.dirname(__FILE__) + "/acceptance_helper.rb"
+      feature "Minimal spec" do
+        scenario "First scenario" do
+          RAILS_ENV.should_not be_empty
+          RAILS_ENV.should == "test"
+        end
+      end
+    SPEC
+    output = run_spec spec_file
+    output.should =~ /1 example, 0 failures/
+  end
+  
+  scenario "Integration stuff" do
+    rails_app = create_rails_app
+    spec_file = create_spec :path    => rails_app + "/spec/acceptance", 
+                            :content => <<-SPEC
+      require File.dirname(__FILE__) + "/acceptance_helper.rb"
+      feature "Minimal spec" do
+        scenario "First scenario" do
+          get "/"
+          response.should have_text(/No route matches/)
+        end
+      end
+    SPEC
+    output = run_spec spec_file
+    output.should =~ /1 example, 0 failures/
+  end
+  
+end

data/spec/acceptance/steak_generator_spec.rb

@@ -0,0 +1,24 @@
+require File.dirname(__FILE__) + "/acceptance_helper.rb"
+
+feature "Steak generator for rails", %q{
+  In order to quickly start to hack my rails project with steak
+  As a developer
+  I want to run a generator that sets everything up for me
+} do
+  
+  scenario "Running generator in an empty project" do
+  
+    rails_app = create_rails_app(:setup_steak => false)
+  
+    Dir.chdir rails_app do
+      `script/generate steak`
+    end
+  
+    File.exist?(rails_app + "/spec/acceptance/acceptance_helper.rb").should be_true
+    File.exist?(rails_app + "/spec/acceptance/support/helpers.rb").should be_true
+    File.exist?(rails_app + "/spec/acceptance/support/paths.rb").should be_true
+    File.exist?(rails_app + "/lib/tasks/steak.rake").should be_true
+    
+  end
+  
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification 
+name: steak
+version: !ruby/object:Gem::Version 
+  version: 0.3.0
+platform: ruby
+authors: 
+- "Luismi Cavall\xC3\xA9"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-01 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: Acceptance specs for Rails
+email: luismi@lmcavalle.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- README.rdoc
+- generators/acceptance_spec/USAGE
+- generators/acceptance_spec/acceptance_spec_generator.rb
+- generators/acceptance_spec/templates/acceptance_spec.rb
+- generators/steak/USAGE
+- generators/steak/steak_generator.rb
+- generators/steak/templates/acceptance_helper.rb
+- generators/steak/templates/helpers.rb
+- generators/steak/templates/paths.rb
+- generators/steak/templates/steak.rake
+- lib/steak.rb
+has_rdoc: true
+homepage: http://github.com/cavalle/steak
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A steak is a cucumber fermented in vinegar or brine
+test_files: 
+- spec/acceptance/acceptance_helper.rb
+- spec/acceptance/acceptance_spec_generator_spec.rb
+- spec/acceptance/basic_spec.rb
+- spec/acceptance/rails_spec.rb
+- spec/acceptance/steak_generator_spec.rb