funktional 1.0.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 [name of plugin creator]
+
+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/Manifest

@@ -0,0 +1,60 @@
+MIT-LICENSE
+Manifest
+README.rdoc
+Rakefile
+lib/funktional.rb
+lib/funktional/assertion.rb
+lib/funktional/assigned_assertion.rb
+lib/funktional/attribute_test_helper.rb
+lib/funktional/context.rb
+lib/funktional/context/assigned_should_block.rb
+lib/funktional/context/collector.rb
+lib/funktional/context/count_should_block.rb
+lib/funktional/context/delegating_should_block.rb
+lib/funktional/context/element_should_block.rb
+lib/funktional/context/flashed_should_block.rb
+lib/funktional/context/should_block.rb
+lib/funktional/context/should_create_block.rb
+lib/funktional/context/should_delete_block.rb
+lib/funktional/context/should_not_block.rb
+lib/funktional/context/should_not_create_block.rb
+lib/funktional/context/should_not_delete_block.rb
+lib/funktional/context/should_not_send_email_block.rb
+lib/funktional/context/stack_recorder.rb
+lib/funktional/email_assertion.rb
+lib/funktional/flashed_assertion.rb
+lib/funktional/model_assertions.rb
+lib/funktional/random_characters.rb
+lib/funktional/recursive_assertion.rb
+lib/funktional/route_checker.rb
+lib/funktional/setup.rb
+lib/funktional/test_class_methods.rb
+lib/funktional/test_instance_methods.rb
+tasks/should_b_tasks.rake
+test/fixtures/posts.yml
+test/fixtures/users.yml
+test/functional/users_controller_test.rb
+test/test-app/app/controllers/application_controller.rb
+test/test-app/app/controllers/users_controller.rb
+test/test-app/app/helpers/application_helper.rb
+test/test-app/app/models/post.rb
+test/test-app/app/models/user.rb
+test/test-app/app/views/users/edit.html.erb
+test/test-app/app/views/users/index.html.erb
+test/test-app/app/views/users/new.html.erb
+test/test-app/config/boot.rb
+test/test-app/config/database.yml
+test/test-app/config/environment.rb
+test/test-app/config/environments/test.rb
+test/test-app/config/initializers/funktional.rb
+test/test-app/config/initializers/new_rails_defaults.rb
+test/test-app/config/routes.rb
+test/test-app/db/migrate/001_create_users.rb
+test/test-app/db/migrate/002_create_posts.rb
+test/test-app/public/404.html
+test/test-app/public/422.html
+test/test-app/public/500.html
+test/test-app/script/console
+test/test-app/script/generate
+test/test_helper.rb
+test/unit/user_test.rb

data/README.rdoc

@@ -0,0 +1,292 @@
+= Funktional
+
+== A Rails testing framework with a railsy syntax
+
+== Install
+* Use braid to install, if you don't have it.
+      sudo gem install braid
+
+* Then
+
+      braid add git://github.com/brentgreeff/funktional.git -p
+
+* add a setup line to 'test/test_helper.rb'
+
+      class ActiveSupport::TestCase
+        setup :funktional
+      end
+
+Done!
+
+
+== For extra flavour, add:
+  * should_pricot (Hpricot matchers in Test::Unit)
+  * hash_factory (Super simple factories for your tests)
+  * matchy (RSpec matchers in Test::Unit)
+
+
+== Contexts
+
+
+Contexts, Don't Repeat Yourself, share common setup steps between your tests.
+
+      context "On a hot summer day" do
+        before { day :hot }
+        
+        context "in the middle of July" do
+          before { Time.now = 'July 15' }
+          
+          should "be on the beach" do
+            assert_equal 'beach', @me.location
+          end
+          
+          should "be drinking lemonade" do
+            assert_equal 'lemonade', @me.drinking
+          end
+        end
+      end
+
+
+== Unit tests
+
+=== Define domain logic through validations.
+
+* Start off with a valid instance
+
+      context "A Company" do
+        setup { @company = create_company }
+        
+        should "respond to fax no" do
+          @company.should_respond_to :fax_no
+        end
+        
+        should "require a name" do
+          @company.should_require_a :name, 'please enter the name'
+        end
+        
+        should "require an address" do
+          @company.should_require_an :address, 'please enter the address'
+        end
+        
+        should "not allow creative accounting" do
+          @company.creative_accounting = true
+          @company.should_have_invalid :books, 'no creative accounting please'
+        end
+        
+        should "not require a telephone no if an address is present" do
+          @company.address = an_address
+          @company.should_not_require_a :telephone_no
+        end
+        
+        should "not have a name longer than 80 characters" do
+          @company.name = 81.random_characters
+          @company.should_have_invalid :name, 'max is 80'
+          # random_characters is a small useful helper method.
+        end
+      end
+
+
+=== Email
+
+      should "send email" do
+        should :send_email => {
+          :from => 'me@example.com',
+          :to => 'you@example.com',
+          :subject => 'Your order',
+          :containing => "important info"
+        }
+      end
+      
+      should "not send email" do
+        should_not :send_email do
+          # do something here
+        end
+      end
+
+=== Object creation
+
+      should "create something" do
+        should :create => Something do
+          # Do something
+        end
+      end
+      
+      should "delete something" do
+        should :delete => Something do
+          # Do something
+        end
+      end
+      
+      should "not delete something" do
+        should_not :delete => Something do
+          # Do something
+        end
+      end
+      
+      should "not create something" do
+        should_not :create => Something do
+          # Do something
+        end
+      end
+
+
+== Testing Controllers
+
+=== Routing
+
+      should :route => '/onions/new' do
+        controller 'onions'
+        action 'new'
+      end
+
+* you need to pass the method if its not a :get request
+
+      should :route => '/onions', :method => :post do
+        controller 'onions'
+        action 'create'
+      end
+
+=== Render
+
+      should "show the new order page" do
+        get :new
+        should :render => 'orders/new'
+      end
+
+The default 'should :render' checks for a http status code of 200
+
+* What about other codes?
+      
+      should "return the not found page when the id does not exist" do
+        get :show, :id => 'something does not exist'
+        should :render_404 => 'public/404'
+      end
+
+=== Redirection
+
+      should "go to the login page if not logged in" do
+        logout
+        get :new
+        should :redirect_to => '/login'
+      end
+
+=== Initializing a new object
+
+      should "assign a new order" do
+        get :new
+        should :assign_new => Order
+      end
+
+=== Loading Objects
+
+      should "load order by id" do
+        get :edit, :id => @order.id
+        assigned(Order).should_be @order
+      end
+
+* This checks the object assigned is of the correct type.
+
+=== Testing the attributes of an assigned object.
+
+      should "associate the current user as the editor" do
+        login_as @user = create_user
+        put :update, :id => @article.id
+        
+        assigned(Article).editor.should_be @user
+      end
+      
+      should "chain as long as you like" do
+        assigned(Article).editor.first_name.should_be 'pete'
+      end
+
+* If you pass a Symbol its just a value based assertion.
+
+      should "load a collection" do
+        get :index
+        assigned(:records).should_be [@record_1, @record_2]
+      end
+
+=== Flash messages
+
+      should "notify the user when order was created" do
+        post :create, :order => attrib
+        flashed(:notice).should_be 'Yay, Order created!'
+      end
+
+
+== Controller Helpers
+
+There are also some helpers for manipulating attributes.
+
+I tend to define an attrib method in my funtional tests
+to represent valid attributes passed to create or update a resource.
+
+* eg:
+
+      def attrib
+        {
+          :first_name => 'Jim',
+          :last_name => 'Bean'
+        }
+      end
+
+Sometimes you want to tests different values, especially invalid ones,
+to get away from all the merge noise, I have defined these helpers:
+
+      missing_attrib
+      blank_attrib
+      replace_attrib
+      add_attrib
+
+
+* Means you can write tests like the following:
+      
+      should_not :create => Order do
+        post :create, :order => blank_attrib(:cc_no)
+      end
+      should :render => 'orders/new'
+
+
+== All funktional assertions are also available as class methods.
+
+      context "When doing it all" do
+        before { :hit_a_controller }
+        
+        should :render => 'somethings/new'
+        
+        should :render_404 => 'public/404'
+        
+        should :render_404    # (defaults to 'public/404')
+        
+        should :redirect_to => '/somethings'
+        
+        element('h1').should_be 'Something'   # (you need should_pricot for this one).
+        
+        count('#friends ol.remaining').should_be 'Not Many'   # (should_pricot here too)
+        
+        flashed(:notice).should_be 'Cool'
+        
+        should :assign_new => Something
+        
+        assigned(Something).name.should_be 'something'
+        
+        assigned(:something).should_be { @something }
+        
+        should :create => Something
+        
+        should :delete => Something
+        
+        should_not :create => Something
+        
+        should_not :delete => Something
+        
+        should :send_email => {
+          :from => 'me@example.com',
+          :to => 'you@example.com'
+        }
+        
+        should_not :send_email
+      end
+
+
+Copyright (c) 2009 [Brent Greeff], released under the MIT license

data/Rakefile

@@ -0,0 +1,36 @@
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'echoe'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the should_b plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the should_b plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ShouldB'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+  
+Echoe.new('funktional', '1.0.0') do |p|
+  p.description     = "Alternative test/unit framework"  
+  p.url             = "http://github.com/brentgreeff/funktional"  
+  p.author          = "Brent Greeff and Felix Clack"  
+  p.email           = "felixclack@gmail.com"  
+  p.ignore_pattern  = ["init.rb", "install.rb", "uninstall.rb"]  
+  p.development_dependencies = []
+end  
+  
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }

data/funktional.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{funktional}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Brent Greeff and Felix Clack"]
+  s.date = %q{2010-03-06}
+  s.description = %q{Alternative test/unit framework}
+  s.email = %q{felixclack@gmail.com}
+  s.extra_rdoc_files = ["README.rdoc", "lib/funktional.rb", "lib/funktional/assertion.rb", "lib/funktional/assigned_assertion.rb", "lib/funktional/attribute_test_helper.rb", "lib/funktional/context.rb", "lib/funktional/context/assigned_should_block.rb", "lib/funktional/context/collector.rb", "lib/funktional/context/count_should_block.rb", "lib/funktional/context/delegating_should_block.rb", "lib/funktional/context/element_should_block.rb", "lib/funktional/context/flashed_should_block.rb", "lib/funktional/context/should_block.rb", "lib/funktional/context/should_create_block.rb", "lib/funktional/context/should_delete_block.rb", "lib/funktional/context/should_not_block.rb", "lib/funktional/context/should_not_create_block.rb", "lib/funktional/context/should_not_delete_block.rb", "lib/funktional/context/should_not_send_email_block.rb", "lib/funktional/context/stack_recorder.rb", "lib/funktional/email_assertion.rb", "lib/funktional/flashed_assertion.rb", "lib/funktional/model_assertions.rb", "lib/funktional/random_characters.rb", "lib/funktional/recursive_assertion.rb", "lib/funktional/route_checker.rb", "lib/funktional/setup.rb", "lib/funktional/test_class_methods.rb", "lib/funktional/test_instance_methods.rb", "tasks/should_b_tasks.rake"]
+  s.files = ["MIT-LICENSE", "Manifest", "README.rdoc", "Rakefile", "lib/funktional.rb", "lib/funktional/assertion.rb", "lib/funktional/assigned_assertion.rb", "lib/funktional/attribute_test_helper.rb", "lib/funktional/context.rb", "lib/funktional/context/assigned_should_block.rb", "lib/funktional/context/collector.rb", "lib/funktional/context/count_should_block.rb", "lib/funktional/context/delegating_should_block.rb", "lib/funktional/context/element_should_block.rb", "lib/funktional/context/flashed_should_block.rb", "lib/funktional/context/should_block.rb", "lib/funktional/context/should_create_block.rb", "lib/funktional/context/should_delete_block.rb", "lib/funktional/context/should_not_block.rb", "lib/funktional/context/should_not_create_block.rb", "lib/funktional/context/should_not_delete_block.rb", "lib/funktional/context/should_not_send_email_block.rb", "lib/funktional/context/stack_recorder.rb", "lib/funktional/email_assertion.rb", "lib/funktional/flashed_assertion.rb", "lib/funktional/model_assertions.rb", "lib/funktional/random_characters.rb", "lib/funktional/recursive_assertion.rb", "lib/funktional/route_checker.rb", "lib/funktional/setup.rb", "lib/funktional/test_class_methods.rb", "lib/funktional/test_instance_methods.rb", "tasks/should_b_tasks.rake", "test/fixtures/posts.yml", "test/fixtures/users.yml", "test/functional/users_controller_test.rb", "test/test-app/app/controllers/application_controller.rb", "test/test-app/app/controllers/users_controller.rb", "test/test-app/app/helpers/application_helper.rb", "test/test-app/app/models/post.rb", "test/test-app/app/models/user.rb", "test/test-app/app/views/users/edit.html.erb", "test/test-app/app/views/users/index.html.erb", "test/test-app/app/views/users/new.html.erb", "test/test-app/config/boot.rb", "test/test-app/config/database.yml", "test/test-app/config/environment.rb", "test/test-app/config/environments/test.rb", "test/test-app/config/initializers/funktional.rb", "test/test-app/config/initializers/new_rails_defaults.rb", "test/test-app/config/routes.rb", "test/test-app/db/migrate/001_create_users.rb", "test/test-app/db/migrate/002_create_posts.rb", "test/test-app/public/404.html", "test/test-app/public/422.html", "test/test-app/public/500.html", "test/test-app/script/console", "test/test-app/script/generate", "test/test_helper.rb", "test/unit/user_test.rb", "funktional.gemspec"]
+  s.homepage = %q{http://github.com/brentgreeff/funktional}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Funktional", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{funktional}
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Alternative test/unit framework}
+  s.test_files = ["test/functional/users_controller_test.rb", "test/test_helper.rb", "test/unit/user_test.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/lib/funktional/assertion.rb

@@ -0,0 +1,9 @@
+module Funktional
+  class Assertion
+    protected
+    
+    def method_missing(method, *args)
+      Funktional.test_instance.send method, *args
+    end
+  end
+end

data/lib/funktional/assigned_assertion.rb

@@ -0,0 +1,43 @@
+module Funktional
+  class AssignedAssertion
+    def initialize(klass_or_symbol)
+      if klass_or_symbol.is_a? Symbol
+        @symbol = klass_or_symbol
+      else
+        @klass = klass_or_symbol
+        @symbol = get_symbol_from_klass
+      end
+      
+      @test = Funktional.test_instance
+      @assigned = @test.assigns(@symbol)
+      
+      @test.assert_not_nil @assigned, "No [#{@symbol}] assigned"
+      
+      if @klass
+        @test.assert @assigned.is_a?(@klass), type_safety_failed_msg
+      end
+    end
+    
+    def should_be(expected_value=nil, &block)
+      if block_given?
+        expected_value ||= block.bind(@test).call
+      end
+      
+      @test.assert_equal expected_value, @assigned
+    end
+    
+    protected
+    
+    def method_missing(method, *args)
+      RecursiveAssertion.new(@assigned, method)
+    end
+    
+    def get_symbol_from_klass
+      @klass.to_s.tableize.singularize.to_sym
+    end
+    
+    def type_safety_failed_msg
+      "assigned [#{@symbol}] is not a [#{@klass}]"
+    end    
+  end
+end

data/lib/funktional/attribute_test_helper.rb

@@ -0,0 +1,27 @@
+module Funktional
+  module AttributeTestHelper
+    
+    def missing_attrib(to_remove)
+      copy_of_attrib = attrib.clone
+      found = copy_of_attrib.delete to_remove
+      raise Exception, 'attribute marked for removal is missing' unless found
+      
+      return copy_of_attrib
+    end
+    
+    def blank_attrib(to_blank)
+      attrib.merge(to_blank => '')
+    end
+    
+    def replace_attrib(to_replace)
+      key = to_replace.keys.first
+      value = to_replace.values.first
+      
+      attrib.merge(key => value)
+    end
+    
+    def add_attrib(addition)
+      attrib.merge(addition)
+    end
+  end
+end

data/lib/funktional/context/assigned_should_block.rb

@@ -0,0 +1,32 @@
+module Funktional
+  class AssignedShouldBlock < ShouldBlock
+    
+    def initialize(recorder, context)
+      @recorder, @context = recorder, context
+      @should_name = "the assigned(#{@recorder.__target})"
+      
+      @blk = lambda do
+        result = nil
+        
+        recorder.__each_called do |meth, args, block|
+          if result.nil?
+            result = assigned(recorder.__target).send(meth, *args, &block)
+          else
+            result.send(meth, *args)
+          end
+        end
+      end
+    end
+    
+    def test_name_parts
+      call_chain = ''
+      
+      @recorder.__each_called do |meth, args|
+        call_chain << ".#{meth}" unless meth.eql? :should_be
+      end
+      @should_name << "#{call_chain} should be [#{@recorder.__last_value}]"
+      
+      return ["test:", "#{@context.full_name},", "#{@should_name}"]
+    end
+  end
+end

data/lib/funktional/context/collector.rb

@@ -0,0 +1,21 @@
+module Funktional
+  class << self
+    attr_accessor :contexts
+    
+    def contexts
+      @contexts ||= []
+    end
+    
+    def current_context
+      self.contexts.last
+    end
+    
+    def add_context(context)
+      self.contexts.push(context)
+    end
+    
+    def remove_context
+      self.contexts.pop
+    end
+  end
+end

data/lib/funktional/context/count_should_block.rb

@@ -0,0 +1,21 @@
+module Funktional
+  class CountShouldBlock < ShouldBlock
+    
+    def initialize(recorder, context)
+      @recorder, @context = recorder, context
+      @should_name = "count(#{@recorder.__target})"
+      
+      @blk = lambda do
+        count(recorder.__target).send(recorder.__meth(0)[:name], *recorder.__meth(0)[:args])
+      end
+    end
+    
+    def test_name_parts
+      parts = ["test:", "#{@context.full_name},", "#{@should_name}"]
+      parts << @recorder.__meth(0)[:name].to_s.gsub('_', ' ')
+      parts << "[#{@recorder.__meth(0)[:args]}]"
+      
+      return parts
+    end
+  end
+end

data/lib/funktional/context/delegating_should_block.rb

@@ -0,0 +1,30 @@
+module Funktional
+  class DelegatingShouldBlock < ShouldBlock
+    
+    def initialize(options, context, &blk)
+      @should_name = build_should_name(options, &blk)
+      @blk = proc { should(options, &blk) }
+      @context = context
+    end
+    
+    def build_should_name(options, &blk)
+      case options.keys.first
+        when :render
+          "render the [#{options[:render]}] template"
+        when :render_404
+          "render the [#{options[:render_404]}] template with a [404] status code"
+        when :redirect_to
+          "redirect to the [#{options[:redirect_to]}] url"
+        when :assign_new
+          "assign a new [#{options[:assign_new]}]"
+        when :route, :method
+          args = (options.length > 1) ? options : options.values.first
+          RouteChecker.build(args, &blk).__test_name
+        when :send_email
+          "send an email #{options[:send_email].inspect}"
+        else
+          raise NoMethodError, "#{options.inspect} is not recognised"
+      end
+    end
+  end
+end

data/lib/funktional/context/element_should_block.rb

@@ -0,0 +1,29 @@
+module Funktional
+  class ElementShouldBlock < ShouldBlock
+    
+    def initialize(recorder, context)
+      @recorder, @context = recorder, context
+      @should_name = "element(#{@recorder.__target})"
+      
+      @blk = lambda do
+        element(recorder.__target).send(recorder.__meth(0)[:name], *recorder.__meth(0)[:args])
+      end
+    end
+    
+    def test_name_parts
+      parts = ["test:", "#{@context.full_name},", "#{@should_name}"]
+      parts << @recorder.__meth(0)[:name].to_s.gsub('_', ' ')
+      
+      if called?(:should_be) or called?(:should_contain)
+        parts << "[#{@recorder.__meth(0)[:args]}]"
+      end
+      return parts
+    end
+    
+    private
+    
+    def called?(name)
+      @recorder.__meth(0)[:name].eql? name
+    end
+  end
+end

data/lib/funktional/context/flashed_should_block.rb

@@ -0,0 +1,17 @@
+module Funktional
+  class FlashedShouldBlock < ShouldBlock
+    
+    def initialize(recorder, context)
+      @recorder, @context = recorder, context
+      @should_name = "flash[:#{@recorder.__target}]"
+      
+      @blk = lambda do
+        flashed(recorder.__target).send(recorder.__meth(0)[:name], *recorder.__meth(0)[:args])
+      end
+    end
+    
+    def test_name_parts
+      ["test:", "#{@context.full_name},", @should_name, "should be", "[#{@recorder.__meth(0)[:args]}]"]
+    end
+  end
+end