filet 0.1.0

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+/.rvmrc

data/Gemfile

@@ -0,0 +1,6 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in filet.gemspec
+gemspec
+
+gem 'ruby-debug'

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2011 Jorge Dias, Jakub Godawa
+
+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/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/Readme.md

@@ -0,0 +1,39 @@
+# Filet
+
+Filet is a dsl for acceptance testing on top of Test::Unit.
+
+## Installation
+
+    gem install filet
+
+## Usage
+
+To use filet just include in your test_helper
+
+    require 'filet'
+    include Filet
+
+## Hooks
+
+We provide several hooks for options processing.
+
+1. Filet.feature_hook
+
+This allows to process the options you pass for the feature
+
+    Filet.feature_hook do |base, options|
+      base.send(:include, Capybara)
+    end
+
+2. Filet.context_hook
+
+This allows to process the options you pass for the context
+
+    Filet.context_hook do |base, options|
+      base.send(:include, SomeModule) if options[:js]
+    end
+
+## Acknowledgements
+
+We'd like to thank our employer XING AG for letting us work on this project as part of our innovation time and releasing it as open source.
+We also want to thank Luismi Cavallé for steak which was our inspiration to do this and all the great people that have made Testing so easy.

data/filet.gemspec

@@ -0,0 +1,18 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "filet/version"
+
+Gem::Specification.new do |s|
+  s.name        = "filet"
+  s.version     = Filet::VERSION
+  s.authors     = ["Jorge Dias", "Jakub Godawa"]
+  s.email       = ["jorge@mrdias.com", "jakub.godawa@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{Acceptance Testing framework for Test::Unit}
+  s.description = %q{Extension for Test::Unit to have a Steak-like DSL for acceptance testing}
+
+  s.files         = `git ls-files`.split("\n")
+  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"]
+end

data/lib/filet.rb

@@ -0,0 +1,10 @@
+module Filet
+  def rails?
+    defined?(ActionController)
+  end
+
+  extend self
+end
+
+require "filet/version"
+require "filet/test_case"

data/lib/filet/backport.rb

@@ -0,0 +1,17 @@
+# Active Support extensions for Test::Unit::TestCase
+module Filet::Backport
+  module Declarative
+    def test(name, &block)
+      test_name = "test_#{name.gsub(/\s+/,'_')}".to_sym
+      defined = instance_method(test_name) rescue false
+      raise "#{test_name} is already defined in #{self}" if defined
+      if block_given?
+        define_method(test_name, &block)
+      else
+        define_method(test_name) do
+          flunk "No implementation provided for #{name}"
+        end
+      end
+    end
+  end
+end

data/lib/filet/hooks.rb

@@ -0,0 +1,33 @@
+module Filet::Hooks
+  def self.extended(base)
+    base.class_eval do
+      @@context_hook = nil
+      @@feature_hook = nil
+    end
+  end
+
+  # TODO: Abstract the hook creation if we need another one
+  def feature_hook(&block)
+    if block
+      @@feature_hook = block
+    else
+      @@feature_hook
+    end
+  end
+
+  def feature_hook=(block)
+    @@feature_hook = block
+  end
+
+  def context_hook(&block)
+    if block
+      @@context_hook = block
+    else
+      @@context_hook
+    end
+  end
+
+  def context_hook=(block)
+    @@context_hook = block
+  end
+end

data/lib/filet/test_case.rb

@@ -0,0 +1,60 @@
+require 'test/unit'
+require 'filet'
+require 'filet/backport'
+require 'filet/hooks'
+
+module Filet
+  base_klass = Filet.rails? ? ActionController::IntegrationTest : Test::Unit::TestCase
+
+  class TestCase < base_klass
+
+    extend Filet::Hooks
+    extend Filet::Backport::Declarative unless Filet.rails?
+
+    class << self
+      attr_accessor :description
+
+      alias :scenario :test
+
+      def context(name, options = {}, &block)
+        klass = create_class(name, self, &block)
+
+        context_hook.call(klass, options) if context_hook
+
+        klass
+      end
+
+      def background(&block)
+        define_method(:setup, &block)
+      end
+
+      def teardown(&block)
+        define_method(:teardown, &block)
+      end
+
+    end
+
+    # Placeholder so test/unit ignores test cases without any tests.
+    def default_test
+    end
+
+  end
+
+  def feature(name, description, options = {}, &block)
+    klass = create_class(name, Filet::TestCase, &block)
+    klass.description = description
+
+    Filet::TestCase.feature_hook.call(klass, options) if Filet::TestCase.feature_hook
+    klass
+  end
+
+  def create_class(name, superclass, &block)
+    klass = Class.new(superclass, &block)
+    name = name.gsub(/(^\d*|\W)/, ' ').lstrip
+    klass_name = name.gsub(/(^[a-z]|\s+\w)/).each do |match|
+      match.lstrip.upcase
+    end
+
+    superclass.const_set klass_name, klass
+  end
+end

data/lib/filet/version.rb

@@ -0,0 +1,3 @@
+module Filet
+  VERSION = "0.1.0"
+end

data/test/filet/test_case_test.rb

@@ -0,0 +1,116 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'test/unit'
+require 'filet/test_case'
+
+include Filet
+
+module Filet
+  class TestCaseTest < Test::Unit::TestCase
+    def test_feature_returns_filet_test_case
+      klass = feature("feature name", "feature description lorem ipsum")
+      assert_equal Filet::TestCase, klass.superclass
+      assert_equal "Filet::TestCase::FeatureName", klass.name
+      assert_equal "feature description lorem ipsum", klass.description
+    end
+
+    def test_context_returns_feature_subclass
+      klass = nil
+      feature("feature name", "description") do
+        klass = context("acceptance criteria 1")
+      end
+
+      assert_match /FeatureName::AcceptanceCriteria1$/, klass.name
+      assert_match /FeatureName$/, klass.superclass.name
+    end
+
+    def test_provides_a_hook_to_process_feature_options
+      Filet::TestCase.feature_hook do |base, options|
+        base.instance_variable_set("@feature_hook_on", true)
+      end
+
+      klass = feature("feature name", "description")
+
+      assert klass.instance_variable_get("@feature_hook_on"), "hook is not used"
+
+      Filet::TestCase.feature_hook = nil
+    end
+
+    def test_provides_a_hook_to_process_context_options
+      Filet::TestCase.context_hook do |base, options|
+        if options[:js]
+          base.instance_variable_set("@js_option", true)
+        end
+      end
+
+      klass = nil
+
+      feature("feature name", "description") do
+        klass = context("acceptance criteria js", :js => true)
+      end
+
+      assert klass.instance_variable_get("@js_option"), "hook is not used"
+
+      Filet::TestCase.context_hook = nil
+    end
+
+    def test_class_nesting
+      context_klass = context_klass =
+        context_klass2 = context_klass2 = nil
+
+      feature("feature name", "description") do
+        context_klass = context("some context") do
+          context_klass = context("the criteria")
+        end
+
+        context_klass2 = context("other context") do
+          context_klass2 = context("the criteria")
+        end
+      end
+
+      assert_not_equal context_klass.name, context_klass2.name
+      assert_not_equal context_klass.name, context_klass2.name
+    end
+
+    def test_background_method
+      klass = feature("feature name", "description") do
+        background do
+          klass.instance_variable_set("@setup_created", true)
+        end
+      end
+
+      klass.new('default_test').setup
+      assert klass.instance_variable_get('@setup_created')
+    end
+
+    def test_teardown_method
+      klass = feature("feature name", "description") do
+        teardown do
+          klass.instance_variable_set("@teardown_created", true)
+        end
+      end
+
+      klass.new('default_test').teardown
+      assert klass.instance_variable_get('@teardown_created')
+    end
+
+    def test_scenario
+      context_klass = nil
+
+      klass = feature("feature name", "description") do
+        scenario "Scenario description"
+
+        context_klass = context "Grouping context" do
+          scenario "Nested Scenario"
+        end
+      end
+
+      assert klass.instance_methods.include?("test_Scenario_description")
+      assert context_klass.instance_methods.include?("test_Nested_Scenario")
+    end
+
+    def teardown
+      Filet::TestCase.send(:remove_const, :FeatureName) if defined?(Filet::TestCase::FeatureName)
+    end
+  end
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: filet
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Jorge Dias
+- Jakub Godawa
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-07-22 00:00:00.000000000 +02:00
+default_executable: 
+dependencies: []
+description: Extension for Test::Unit to have a Steak-like DSL for acceptance testing
+email:
+- jorge@mrdias.com
+- jakub.godawa@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- Rakefile
+- Readme.md
+- filet.gemspec
+- lib/filet.rb
+- lib/filet/backport.rb
+- lib/filet/hooks.rb
+- lib/filet/test_case.rb
+- lib/filet/version.rb
+- test/filet/test_case_test.rb
+has_rdoc: true
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Acceptance Testing framework for Test::Unit
+test_files:
+- test/filet/test_case_test.rb