Doa 0.1.1

data/.gitignore

@@ -0,0 +1,5 @@
+*~
+*.bak
+doc/api
+doc/spec.html
+pkg/*

data/Doa.gemspec

@@ -0,0 +1,52 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{Doa}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Nolan Eakins <sneakin@semanticgap.com>"]
+  s.date = %q{2009-10-21}
+  s.description = %q{rSpec controller macros}
+  s.email = %q{suppert@semanticgap.com}
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "Doa.gemspec",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/doa.rb",
+     "lib/doa/class_methods.rb",
+     "lib/doa/instance_methods.rb",
+     "spec/application.rb",
+     "spec/doa_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/sneakin/Doa}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{The Tester}
+  s.test_files = [
+    "spec/application.rb",
+     "spec/doa_spec.rb",
+     "spec/spec_helper.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/README.rdoc

@@ -0,0 +1,69 @@
+= Doa (the tester)
+
+== Introduction
+
+Doa provides macros that makes Rails' controller specs more understandable and
+drier. It provides methods to provide the context for a controller's action,
+the params to be used in a given context, and the means to easily call the
+action using those params.
+
+
+== Usage
+
+Use `rake rdoc` to generate the RDocs which provides a complete example in the
+Doa module. You can run the specs, which are by example, with `rake spec`.
+
+
+== Example
+
+  require 'doa'
+
+  Doa.install!
+  Doa.default_url_params = { :format => 'xml' }
+
+  describe Controller do
+    action :show do
+      params do
+        { :id => 123 }
+      end
+
+      it "does something" do
+        doa(:page => 1)
+      end
+    end
+  end
+
+
+== Legal
+
+=== Copyright
+
+Copyright (C) 2009 SemanticGap(R)
+
+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.
+
+
+=== Trademarks
+
+SemanticGap is a registered trademark of Nolan Eakins. All
+rights reserved.
+

data/Rakefile

@@ -0,0 +1,34 @@
+require 'spec/rake/spectask'
+
+task :default => [ :spec, :rdoc ]
+
+desc "Run all specs in the spec directory"
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_opts = [ '--options', File.join(File.dirname(__FILE__), "spec", "spec.opts") ]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+require 'rake/rdoctask'
+
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_files.add("README.rdoc", "lib/**/*.rb")
+  rdoc.main = 'README.rdoc'
+  rdoc.title = 'Doa'
+  rdoc.rdoc_dir = 'doc/api'
+  rdoc.options << '--line-numbers' << '--inline-source'
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "Doa"
+    gemspec.summary = "The Tester"
+    gemspec.description = "rSpec controller macros"
+    gemspec.email = "suppert@semanticgap.com"
+    gemspec.homepage = "http://github.com/sneakin/Doa"
+    gemspec.authors = [ "Nolan Eakins <sneakin@semanticgap.com>" ]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/lib/doa/class_methods.rb

@@ -0,0 +1,78 @@
+# Copyright (C) 2009 SemanticGap(R)
+#
+# 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.
+
+module Doa
+  # Methods available at the context level.
+  module ClassMethods
+    # Initialize the parameters to be used within a context inheriting
+    # those of the surrounding contexts. Takes a block which must
+    # return a Hash.
+    #
+    # Usage:
+    #   params do
+    #     { :id => @user.id }
+    #   end
+    def params(&block)
+      self.default_params = block
+    end
+
+    # Setup a context to test a controller's action using #do_action.
+    # It takes the action's name and an optional HTTP method,
+    # evaluating the supplied block in the created context.
+    def action(name, method = nil, &block)
+      d = describe "\##{name}" do
+        do_action name, method
+      end
+
+      d.instance_eval(&block)
+      d
+    end
+
+    # Infrastructure method used by #action to generate the methods
+    # available within a test case.
+    def do_action(action_name, method = nil, params = Hash.new, &block)
+      # Locking in the arguments with closures
+      define_method("action_method") do
+        method || infer_method(action_name)
+      end
+
+      define_method("action_name") do
+        action_name
+      end
+
+      define_method("shared_params") do
+        return instance_eval(&block) if block
+        return Hash.new
+      end
+
+      define_method("action_params") do
+        params
+      end
+
+      # Now the methods we really want to use
+      class_eval do
+        include Doa::InstanceMethods
+      end
+    end
+  end
+end

data/lib/doa/instance_methods.rb

@@ -0,0 +1,70 @@
+# Copyright (C) 2009 SemanticGap(R)
+#
+# 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.
+
+module Doa
+  # Methods available inside individual cases.
+  module InstanceMethods
+    # Returns the parameters to be used in a given test case.
+    # The parameters are the result of merging the parameters from
+    # the top most context down to the current one.
+    def params
+      return @_params if @_params
+
+      p = Doa.default_params.try(:clone) ||
+        HashWithIndifferentAccess.new
+
+      p.recursive_merge!(super_params)
+      p.recursive_merge!(action_params)
+      p.recursive_merge!(self.instance_eval(&default_params)) if default_params
+      p.recursive_merge!(shared_params)
+
+      @_params = HashWithIndifferentAccess.new(p)
+    end
+
+    # Perform the action using the parameters that result from
+    # merging the context's parameters with those that were
+    # passed as an argument.
+    def doa(per_call_params = Hash.new)
+      send(action_method, action_name,
+           self.params.recursive_merge(per_call_params))
+    end
+
+    # Alias for #doa
+    def do_action(*args)
+      doa(*args)
+    end
+
+    private
+
+    # Merges in defaults from each parent class
+    def super_params
+      supers.reverse.inject(Hash.new) do |acc, klass|
+        next acc unless klass.respond_to?(:default_params)
+
+        dp = klass.default_params
+        acc.recursive_merge!(self.instance_eval(&dp) || Hash.new) if dp
+        acc
+      end
+    end
+  end
+end

data/lib/doa.rb

@@ -0,0 +1,95 @@
+# Copyright (C) 2009 SemanticGap(R)
+#
+# 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.
+
+require 'facets/hash'
+require 'doa/class_methods'
+require 'doa/instance_methods'
+
+# =Setup
+#
+# To use this, you should place the following in your "spec/spec_helper.rb":
+#
+#   require 'doa'
+#   Doa.install!
+#   Doa.default_params = { :css => 'desktop', :format => 'html' }
+#
+# =Usage
+#
+# And your specs can then resemble:
+#
+#   describe SomeController do
+#     action :update do
+#       before(:each) do
+#         @person = people(:bob)
+#       end
+#
+#       params do
+#         { :id => @person, :name => 'Robert' }
+#       end
+#
+#       it "updates bob" do
+#         Person.should_receive(:find).with(params[:id]).and_return(@person)
+#         lambda { doa }.should change(@person)
+#       end
+#     end
+#   end
+#
+module Doa
+  mattr_accessor :default_params
+
+  def self.included(base)
+    base.class_inheritable_accessor :default_params
+    base.extend(ClassMethods)
+  end
+
+  # Install Doa into RSpec's ControllerExampleGroup.
+  def self.install!
+    Spec::Rails::Example::ControllerExampleGroup.class_eval do
+      include Doa
+    end
+  end
+
+  private
+
+  # Given an action name such as :create, it returns the expected
+  # HTTP method.
+  def infer_method(action)
+    case action
+    when 'update' then :put
+    when 'create' then :post
+    else :get
+    end
+  end
+
+  # Returns the superclasses of an object
+  def supers
+    klass = self.class
+    supers = Array.new
+    while(klass)
+      supers << klass
+      klass = klass.superclass
+    end
+
+    supers
+  end
+end

data/spec/application.rb

@@ -0,0 +1,7 @@
+# Placeholder
+
+class ApplicationController < ActionController::Base
+  def update
+    @params = params
+  end
+end

data/spec/doa_spec.rb

@@ -0,0 +1,64 @@
+require File.join(File.dirname(__FILE__), "spec_helper")
+
+describe Doa, :type => :controller do
+  ActionController::Routing::Routes.draw do |map|
+    map.resources :test, :controller => 'application'
+  end
+
+  controller_name :application
+
+  action :update do
+    before(:each) do
+      @person = 'person'
+    end
+
+    params do
+      { :id => @person, :name => 'Robert' }
+    end
+
+    context 'no extra params' do
+      it "assigns the params" do
+        doa
+
+        assigns[:params][:id].should == @person
+        assigns[:params][:name].should == 'Robert'
+      end
+    end
+
+    context 'per-call params' do
+      before(:each) do
+        doa(:name => 'Bob', :age => 21)
+        @params = assigns[:params]
+      end
+
+      it "includes the parent context's params" do
+        @params[:id].should == @person
+      end
+
+      it "includes the passed params" do
+        @params[:name].should == 'Bob'
+        @params[:age].should == '21'
+      end
+    end
+
+    context 'per-context params' do
+      params do
+        { 'name' => 'Bob', :age => 21 }
+      end
+
+      before(:each) do
+        do_action
+        @params = assigns[:params]
+      end
+
+      it "includes the parent context's params" do
+        @params[:id].should == @person
+      end
+
+      it "merges in the context's params with the parent's" do
+        @params[:name].should == 'Bob'
+        @params[:age].should == '21'
+      end
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,4 @@
+--colour
+--format progress
+--format html:doc/spec.html
+--require rubygems

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+$: << File.join(File.dirname(File.dirname(__FILE__)), 'lib')
+$: << File.dirname(__FILE__)
+
+require 'active_support'
+require 'action_controller'
+require 'action_controller/request'
+require 'action_controller/rescue'
+require 'initializer'
+
+require 'spec/rails'
+require 'doa'
+
+Doa.install!

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification 
+name: Doa
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+platform: ruby
+authors: 
+- Nolan Eakins <sneakin@semanticgap.com>
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-21 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: rSpec controller macros
+email: suppert@semanticgap.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- .gitignore
+- Doa.gemspec
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/doa.rb
+- lib/doa/class_methods.rb
+- lib/doa/instance_methods.rb
+- spec/application.rb
+- spec/doa_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/sneakin/Doa
+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: The Tester
+test_files: 
+- spec/application.rb
+- spec/doa_spec.rb
+- spec/spec_helper.rb