bbq 0.0.1 → 0.0.2.beta.1

data/.gitignore

@@ -2,3 +2,11 @@
 .bundle
 Gemfile.lock
 pkg/*
+bin/*
+tmp/*
+test/dummy/db/*.sqlite3
+test/dummy/log/*.log
+test/dummy/tmp/
+test/dummy/test/acceptance/*
+test/dummy/spec/acceptance/*
+nbproject/

data/.travis.yml

@@ -0,0 +1,8 @@
+script: bundle exec rake test
+rvm:
+  - 1.9.2
+  - 1.8.7
+  - ree
+  - jruby
+  - rbx
+  - rbx-2.0

data/Gemfile

@@ -1,4 +1,5 @@
 source "http://rubygems.org"
 
-# Specify your gem's dependencies in bbq.gemspec
 gemspec
+
+gem "jruby-openssl", :platforms => :jruby

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011 DRUG, Dolnośląska Grupa Użytkowników Ruby
+
+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,152 @@
+Warning & disclaimer
+====================
+
+This gem is currently under development. We're targeting most popular use case - Rails. However the philosophy behind it is not limited to Rails nor web applications in general. There is even example usage with EventMachine. Feel free to modify it for your own needs.
+
+[![Build Status](https://secure.travis-ci.org/drugpl/bbq.png)](http://travis-ci.org/drugpl/bbq)
+
+BBQ
+===
+
+Object oriented acceptance testing using personas.
+
+* Ruby
+* OOP
+* DCI (Data Context Interaction) - for roles/personas
+* Test framework independent, based on Capybara
+* Opinionated
+
+Difference from Cucumber
+========================
+
+* No Gherkin
+* Objects and methods instead of steps
+* Easier code reuse
+* No factories/fixtures
+
+Example applications
+====================
+
+* https://github.com/pawelpacana/roundtrip
+* https://github.com/pawelpacana/eventmachine-bbq-example
+* https://github.com/drugpl/drug-site
+
+Installation
+============
+
+First, add BBQ to your apps Gemfile:
+
+```ruby
+# Gemfile
+gem "bbq", :git => "git://github.com/drugpl/bbq.git"
+```
+
+Run install generator:
+
+```
+rails generate bbq:install
+```
+
+Require BBQ in test/test_helper.rb:
+
+```ruby
+require "bbq/test"
+```
+
+Feature generator
+=================
+
+```
+rails g bbq:test MyFeatureName
+```
+
+Examples
+========
+
+```ruby
+test "admin can browse all user tickets" do
+  summaries = ["Forgot my password", "Page is not displayed correctly"]
+  descriptions = ["I lost my yellow note with password under the table!",
+                  "My IE renders crap instead of crispy fonts!"]
+
+  alice = Roundtrip::TestUser.new
+  alice.extend(Roundtrip::TestUser::TicketReporter)
+  alice.register_and_login
+  alice.open_ticket(summaries.first, descriptions.first)
+
+  bob = Roundtrip::TestUser.new
+  bob.extend(Roundtrip::TestUser::TicketReporter)
+  bob.register_and_login
+  bob.open_ticket(summaries.second, descriptions.second)
+
+  bofh = Roundtrip::TestUser.new(:email => @admin.email)
+  bofh.extend(Roundtrip::TestUser::TicketManager)
+  bofh.login
+  bofh.visit "/support/admin/tickets"
+  assert bofh.see?(*summaries)
+  bofh.click_on(summaries.second)
+  assert bofh.see?(summaries.second, descriptions.second)
+  assert bofh.not_see?(summaries.first, descriptions.first)
+end
+```
+
+Deal with Devise
+================
+
+```ruby
+require "bbq/test_user"
+require "bbq/devise"
+
+class TestUser < Bbq::TestUser
+  include Bbq::Devise
+end
+```
+
+After that TestUser have *login*, *logout*, *register*, *register_and_login* methods.
+
+```ruby
+test "user register with devise" do
+  user = TestUser.new # or TestUser.new(:email => "email@example.com", :password => "secret")
+  user.register_and_login
+  user.see?("Stuff after auth")
+end
+```
+
+Development environment
+=======================
+
+```
+bundle install
+bundle exec rake test
+```
+
+Additional information
+======================
+
+* 2 problems with Cucumber http://andrzejonsoftware.blogspot.com/2011/03/2-problems-with-cucumber.html
+* Object oriented acceptance testing http://andrzejonsoftware.blogspot.com/2011/04/object-oriented-acceptance-testing.html
+* Events in acceptance tests http://andrzejonsoftware.blogspot.com/2011/04/events-in-acceptance-tests.html
+
+Maintainers
+===========
+
+* Paweł Pacana (http://github.com/pawelpacana)
+* Andrzej Krzywda (http://andrzejkrzywda.com)
+* Michał Łomnicki (http://mlomnicki.com)
+* Robert Pankowecki (http://robert.pankowecki.pl)
+* Piotr Niełacny (http://ruby-blog.pl)
+
+Contributors
+============
+
+* Peter Suschlik (http://peter.suschlik.de)
+
+Future plans
+============
+
+* Events (http://andrzejonsoftware.blogspot.com/2011/04/events-in-acceptance-tests.html)
+
+License
+=======
+
+MIT License

data/Rakefile

@@ -1,2 +1,30 @@
-require 'bundler'
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
 Bundler::GemHelper.install_tasks
+require 'rdoc/task'
+
+RDoc::Task.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Bbq'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/bbq.gemspec

@@ -6,11 +6,11 @@ Gem::Specification.new do |s|
   s.name        = "bbq"
   s.version     = Bbq::VERSION
   s.platform    = Gem::Platform::RUBY
-  s.authors     = ["Paweł Pacana"]
-  s.email       = ["pawel.pacana@gmail.com"]
+  s.authors     = ["DRUG - Dolnośląska Grupa Użytkowników Ruby"]
+  s.email       = ["bbq@drug.org.pl"]
   s.homepage    = ""
-  s.summary     = %q{Acceptance testing philosophy for grown-ups}
-  s.description = %q{Objected oriented acceptance testing using personas and events.}
+  s.description = %q{Objected oriented acceptance testing for Rails, using personas.}
+  s.summary     = %q{Objected oriented acceptance testing for Rails, using personas.}
 
   s.rubyforge_project = "bbq"
 
@@ -18,4 +18,14 @@ Gem::Specification.new do |s|
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
+
+  s.add_dependency "capybara",  "~> 1.0.0"
+  s.add_dependency "rails",     ">= 3.0.0"
+
+  s.add_development_dependency "sqlite3",     "~> 1.3.3"
+  s.add_development_dependency "rake",        "~> 0.8.7"
+  s.add_development_dependency "rdoc",        "~> 3.7"
+  s.add_development_dependency "devise",      "~> 1.4.0"
+  s.add_development_dependency "rspec-rails", "~> 2.6.0"
+
 end

data/lib/bbq.rb

@@ -1,3 +1,7 @@
+require 'bbq/railtie' if defined?(Rails)
+
 module Bbq
-  # Your code goes here...
+  def self.root
+    @root ||= Pathname.new(File.expand_path(File.join(File.dirname(__FILE__), '..')))
+  end
 end

data/lib/bbq/devise.rb

@@ -0,0 +1,53 @@
+if defined?(Devise)
+
+  require 'bbq/test'
+
+  module Bbq
+    module Devise
+
+      attr_accessor :devise_authentication_key, :email, :password, :scope
+
+      def self.included(other)
+        other.add_callback(self)
+      end
+
+      def self.init(user)
+        user.devise_authentication_key = ::Devise.authentication_keys.first
+        user.email = user.options[user.devise_authentication_key.to_sym] || next_email
+        user.password = user.options[:password] || next_password
+        user.scope = ::Devise.mappings.first.second.singular.to_s
+      end
+
+      def register
+        visit send("new_#{self.scope}_registration_path")
+        fill_in "#{self.scope}_#{self.devise_authentication_key}", :with => @email
+        fill_in "#{self.scope}_password", :with => @password
+        fill_in "#{self.scope}_password_confirmation", :with => @password
+        find(:xpath, "//input[@name='commit']").click
+      end
+
+      def login
+        visit send("new_#{self.scope}_session_path")
+        fill_in "#{self.scope}_#{self.devise_authentication_key}", :with => @email
+        fill_in "#{self.scope}_password", :with => @password
+        find(:xpath, "//input[@name='commit']").click
+      end
+
+      def logout
+        visit send("destroy_#{self.scope}_session_path")
+      end
+
+      def register_and_login
+        register
+      end
+
+      def self.next_email
+        "#{ActiveSupport::SecureRandom.hex(3)}@example.com"
+      end
+
+      def self.next_password
+        ActiveSupport::SecureRandom.hex(8)
+      end
+    end
+  end
+end

data/lib/bbq/railtie.rb

@@ -0,0 +1,7 @@
+module Bbq
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load Bbq.root.join("lib/tasks/bbq.rake")
+    end
+  end
+end

data/lib/bbq/rspec.rb

@@ -0,0 +1,86 @@
+require 'rspec/core'
+require 'bbq/test_user'
+require 'capybara/rspec/matchers'
+
+module Bbq
+  module RSpecFeature
+    def self.included(base)
+      base.instance_eval do
+        alias :background :before
+        alias :scenario :it
+      end
+    end
+  end
+
+  class TestUser
+    def see!(*args)
+      args.each do |arg|
+        page.should have_content(arg)
+      end
+    end
+
+    def not_see!(*args)
+      args.each do |arg|
+        page.should have_no_content(arg)
+      end
+    end
+  end
+
+  module RSpecMatchers
+    class TestUserEyes
+      def initialize(negative, *args)
+        @args, @negative = args, negative
+      end
+
+      def matches?(actual)
+        @negative ? actual.not_see?(*@args) : actual.see?(*@args)
+      end
+
+      def failure_message_for_should
+        "expected to #{@negative ? negative_description : positive_description}"
+      end
+
+      def failure_message_for_should_not
+        "expected to #{@negative ? positive_description : negative_description}"
+      end
+
+      def description
+        @negative ? negative_description : positive_description
+      end
+
+      protected
+
+      def negative_description
+        "not see any of the following: #{@args.join(', ')}"
+      end
+
+      def positive_description
+        "see all of the following: #{@args.join(', ')}"
+      end
+    end
+
+    def see(*args)
+      TestUserEyes.new(false, *args)
+    end
+
+    def not_see(*args)
+      TestUserEyes.new(true, *args)
+    end
+  end
+end
+
+def self.feature(*args, &block)
+  options = if args.last.is_a?(Hash) then args.pop else {} end
+  options[:type] = :acceptance
+  options[:caller] ||= caller
+  args.push(options)
+
+  describe(*args, &block)
+end
+
+RSpec.configuration.include Bbq::RSpecFeature, :type => :acceptance
+
+RSpec.configure do |config|
+  config.include Capybara::RSpecMatchers, :type => :acceptance
+  config.include Bbq::RSpecMatchers, :type => :acceptance
+end

data/lib/bbq/test.rb

@@ -0,0 +1,36 @@
+require 'active_support'
+require 'test/unit'
+require 'bbq/test_user'
+require 'test/unit/assertions'
+
+module Bbq
+
+  class TestCase < ActiveSupport::TestCase
+    class << self
+      alias :scenario :test
+      alias :background :setup
+    end
+
+    alias :background :setup
+  end
+
+  # test/unit specific methods for test_user
+  class TestUser
+
+    include Test::Unit::Assertions
+
+    def see!(*args)
+      args.each do |arg|
+        assert has_content?(arg), "Expecting to see \"#{arg}\", text not found."
+      end
+    end
+
+    def not_see!(*args)
+      args.each do |arg|
+        assert has_no_content?(arg), "Found \"#{arg}\", which was unexpected."
+      end
+    end
+
+  end
+
+end