niessner-rspec_controller_macros 0.0.1

data/README

@@ -0,0 +1,116 @@
+Installing
+----------
+1) Add: 
+    ENV["RAILS_ENV"] = "test"
+   to the top of /spec/spec_helper.rb
+2) Add:
+    config.gem "niessner-rspec_view_macros", :lib => "rspec_view_macros", :source => "http://gems.github.com"
+   to your environment.rb inside the Initializer.run block
+   
+Usage
+----------
+
+Registering roles
+In the configure block of your spec/spec_helper.rb register roles by doing:
+
+Rspec::UserRoles.register(:visitor) {nil}
+Rspec::UserRoles.register(:user) {User.new}  
+Rspec::UserRoles.register(:admin) do 
+  user = User.new
+  user.admin = true
+  user
+end
+
+Let's you write specs similar to:
+
+describe Admin::ArticlesController do
+  describe "get index" do
+    as_a(:visitor) {it_should_redirect_to {new_session_path}}
+    as_a(:user) {it_should_render_template.permission_denied}
+
+    as_an :admin do
+      before do
+        @articles = [Article.new, Article.new]
+        stub(Article).find(:all) {@articles}
+      end
+    
+      it_should_render_view Admin::Articles::Index
+      it_should_render_layout Layouts::Admin
+      it_should_set_rendered_view.articles.to {@articles}
+    end
+  end
+    
+  describe "post create" do
+    as_a(:visitor) {it_should_redirect_to {new_session_path}}
+    as_a(:user) {it_should_render_template.permission_denied}
+    
+    as_an :admin do
+      before {stub(Article).create!("title" => "Title", "body" => "Body")}
+      post :article => {:title => "Title", :body => "Body"}
+      
+      it "should call finishing_editing" do
+        response.should have_text("finish_editing(null);")
+      end
+    end
+  end
+    
+  describe "post update" do
+    as_a(:visitor) {it_should_redirect_to {new_session_path}}
+    as_a(:user) {it_should_render_template.permission_denied}
+    
+    as_an :admin do
+      before(:each) do
+        article = Article.new
+        strong.stub(Article).find("5") {article}
+        strong.stub(Article).find(:all) {[]}
+        strong.stub(article).update_attributes!("title" => "Title", "body" => "Body")
+      end
+      
+      post :id => 5, :article => {:title => "Title", :body => "Body"}
+    
+      it "should call finishing_editing" do
+        response.should have_text("finish_editing(null);")
+      end
+    end
+  end
+  
+  describe "post publish" do
+    as_a(:visitor) {it_should_redirect_to {new_session_path}}
+    as_a(:user) {it_should_render_template.permission_denied}
+    
+    as_an :admin do
+      before(:each) do
+        @article = Article.new
+        strong.stub(@article).publish!
+        strong.stub(Article).find("5") {@article}
+        strong.stub(Article).find(:all) {[]}
+      end
+      
+      post :id => 5
+    
+      it "should publish the article" do
+        verify_invocation of_spy(@article).publish!
+      end
+    end
+  end
+    
+  describe "post destroy" do
+    as_a(:visitor) {it_should_redirect_to {new_session_path}}
+    as_a(:user) {it_should_render_template.permission_denied}
+    
+    as_an :admin do
+      before(:each) do
+        @article = Article.new
+        strong.stub(@article).destroy
+        strong.stub(Article).find("5") {@article}
+        strong.stub(Article).find(:all) {[]}
+      end
+      
+      post :id => 5
+  
+      it "should destroy the article" do
+        verify_invocation of_spy(@article).destroy
+      end
+    end
+  end
+end

data/Rakefile

@@ -0,0 +1,22 @@
+require 'rubygems'
+require 'rake'
+require 'rake/gempackagetask'
+require 'date'
+ 
+spec = Gem::Specification.new do |s|
+  s.name = "rspec_controller_macros"
+  s.version = "0.0.1"
+  s.summary = "Some macros to make it more convenient to spec controllers."
+  s.files = FileList['[A-Z]*', 'lib/**/*.rb']
+  s.require_path = 'lib'  
+  s.author = "Michael Niessner"
+  s.email = "michael@niessner.us"
+  s.platform = Gem::Platform::RUBY
+end
+ 
+desc "Generate a gemspec file"
+task :gemspec do
+  File.open("#{spec.name}.gemspec", 'w') do |f|
+    f.write spec.to_ruby
+  end
+end

data/lib/rspec/controller_as_a_macro.rb

@@ -0,0 +1,39 @@
+module Rspec
+  module ControllerAsAMacro
+    module ExampleMethods
+      def login_with_user(user)
+        @current_user = user
+        stub(controller).current_user {@current_user}
+      end
+    end
+    
+    module ExampleGroupMethods
+      def as_a(*role_symbols, &as_a_block)
+        as_role(:a, *role_symbols, &as_a_block)
+      end
+      
+      def as_an(*role_symbols, &as_a_block)
+        as_role(:an, *role_symbols, &as_a_block)
+      end
+      
+    protected
+      def as_role(description_symbol, *role_symbols, &as_a_block)
+        role_symbols.each do |role_symbol|
+          describe "as #{description_symbol} #{role_symbol}" do
+            before do
+              login_with_user Rspec::UserRoles.user_with_role(role_symbol)
+            end
+          
+            instance_eval(&as_a_block)
+          end        
+        end
+      end
+    end
+    
+    def self.included(object)
+      object.send :include, ExampleMethods
+      object.extend ExampleGroupMethods
+    end
+  end
+end
+

data/lib/rspec/controller_be_a_redirect_macro.rb

@@ -0,0 +1,17 @@
+module Rspec
+  module ControllerBeARedirectMacro
+    module ExampleGroupMethods
+      def it_should_be_a_redirect
+        it "should be a redirect" do
+          do_action
+          response.should be_redirect
+        end        
+      end
+    end
+    
+    def self.included(object)
+      object.extend ExampleGroupMethods
+    end
+  end
+end
+

data/lib/rspec/controller_be_a_success_macro.rb

@@ -0,0 +1,16 @@
+module Rspec
+  module ControllerBeASuccessMacro
+    module ExampleGroupMethods
+      def it_should_be_a_success
+        it "should be a success" do
+          do_action
+          response.should be_success
+        end
+      end
+    end
+    
+    def self.included(object)
+      object.extend ExampleGroupMethods
+    end
+  end
+end

data/lib/rspec/controller_do_action_macro.rb

@@ -0,0 +1,61 @@
+module Rspec
+  module ControllerDoActionMacro
+    module ExampleMethods
+      def described_action
+        self.class.description_parts[1].split(" ")
+      end
+      
+      def set_post_parameters_to(hash)
+        set_action_parameters(hash)
+      end
+      
+      def set_get_parameters_to(hash)
+        set_action_parameters(hash)
+      end
+      
+      def set_put_parameters_to(hash)
+        set_action_parameters(hash)
+      end
+      
+      def set_delete_parameters_to(hash)
+        set_action_parameters(hash)
+      end
+      
+      def set_action_parameters(hash)
+        @action_parameters = hash
+      end
+      
+      def action_parameters(hash=nil)
+        hash || @action_parameters
+      end
+      
+      def do_post(hash=nil)
+        do_action(hash)
+      end
+      
+      def do_get(hash=nil)
+        do_action(hash)
+      end
+      
+      def do_put(hash=nil)
+        do_action(hash)
+      end
+      
+      def do_delete(hash=nil)
+        do_action(hash)
+      end
+      
+      def do_action(hash=nil)
+        send_parameters = described_action
+        send_parameters = send_parameters + [action_parameters(hash)] if action_parameters(hash).not.nil?
+        self.send(*send_parameters)        
+      end
+    end  
+    
+    def self.included(receiver)
+      receiver.send :include, ExampleMethods
+    end      
+  end
+end
+
+

data/lib/rspec/controller_post_macro.rb

@@ -0,0 +1,16 @@
+module Rspec
+  module ControllerPostMacro
+    module ExampleGroupMethods
+      def post(hash)
+        before do
+          set_post_parameters_to(hash)
+          do_action
+        end
+      end
+    end
+    
+    def self.included(object)
+      object.extend ExampleGroupMethods
+    end
+  end
+end

data/lib/rspec/controller_redirect_to_macro.rb

@@ -0,0 +1,19 @@
+module Rspec
+  module ControllerRedirectToMacro
+    module ExampleGroupMethods
+      def it_should_redirect_to(&block)
+        it "should redirect to " do
+          do_action
+          path = self.instance_eval(&block)
+          new_description = instance_variable_get("@_defined_description") + path.to_s
+          instance_variable_set("@_defined_description", new_description)
+          response.should redirect_to(path)
+        end
+      end
+    end
+    
+    def self.included(object)
+      object.extend ExampleGroupMethods
+    end
+  end
+end

data/lib/rspec/controller_render_template_macro.rb

@@ -0,0 +1,37 @@
+module Rspec
+  module ControllerRenderTemplateMacro
+    module ExampleGroupMethods
+      class RenderTemplateProxy < BlankSlate
+        def initialize(example_group)
+          @example_group = example_group
+        end
+        
+        def permission_denied
+          @example_group.it_should_render_template_with_template_string("app/views/shared/permission_denied.html.erb")
+        end
+      end
+      
+      def it_should_render_template(template_string=nil)
+        if template_string.nil?
+          RenderTemplateProxy.new(self)
+        else
+          it_should_render_template_with_template_string(template_string)
+        end
+      end
+
+      def it_should_render_template_with_template_string(template_string)
+        it "should render template #{template_string}" do
+          do_action
+          response.should render_template(template_string)
+        end
+      end
+    end
+    
+    def self.included(object)
+      object.extend ExampleGroupMethods
+    end
+  end
+end
+
+
+

data/lib/rspec/user_roles.rb

@@ -0,0 +1,29 @@
+module Rspec
+  class UserRoles
+    include Singleton
+
+    class << self
+      def register(role, &block)
+        instance.register(role, &block)
+      end
+    
+      def user_with_role(role)
+        instance.user_with_role(role)
+      end
+    end
+  
+    def register(role, &block)
+      roles[role] = block
+    end
+  
+    def user_with_role(role)
+      raise "Role not found" if roles[role].nil?
+      roles[role].call
+    end
+  
+  protected
+    def roles
+      @roles ||= Hash.new
+    end
+  end
+end

data/lib/rspec_controller_macros.rb

@@ -0,0 +1,16 @@
+ActionController::Base.send(:include, ViewObjects::ActionControllerEnhancements)
+
+if ENV["RAILS_ENV"] == "test"
+  require 'spec'
+  require 'spec/rails'
+  
+  Spec::Runner.configure do |config|
+    config.include(Rspec::ControllerAsAMacro, :type => :controllers)
+    config.include(Rspec::ControllerDoActionMacro, :type => :controllers)
+    config.include(Rspec::ControllerBeASuccessMacro, :type => :controllers)
+    config.include(Rspec::ControllerBeARedirectMacro, :type => :controllers)
+    config.include(Rspec::ControllerRenderTemplateMacro, :type => :controllers)
+    config.include(Rspec::ControllerRedirectToMacro, :type => :controllers)
+    config.include(Rspec::ControllerPostMacro, :type => :controllers)
+  end
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification 
+name: niessner-rspec_controller_macros
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Michael Niessner
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-11-10 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: 
+email: michael@niessner.us
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Rakefile
+- README
+- lib/rspec_controller_macros.rb
+- lib/rspec/controller_as_a_macro.rb
+- lib/rspec/controller_be_a_redirect_macro.rb
+- lib/rspec/controller_be_a_success_macro.rb
+- lib/rspec/controller_do_action_macro.rb
+- lib/rspec/controller_post_macro.rb
+- lib/rspec/controller_redirect_to_macro.rb
+- lib/rspec/controller_render_template_macro.rb
+- lib/rspec/user_roles.rb
+has_rdoc: false
+homepage: 
+post_install_message: 
+rdoc_options: []
+
+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.2.0
+signing_key: 
+specification_version: 2
+summary: Some macros to make it more convenient to spec controllers.
+test_files: []
+