dry_crud 1.6.0 → 1.7.0

data/lib/generators/dry_crud/templates/spec/support/crud_controller_examples.rb

@@ -0,0 +1,244 @@
+require 'support/crud_controller_test_helper'
+
+RSpec.configure do |c|
+  c.before :failing => true do
+    model_class.any_instance.stub(:save).and_return(false)
+    model_class.any_instance.stub(:destroy).and_return(false)
+  end
+end
+
+# A set of examples to include into the tests for your crud controller subclasses.
+# Simply #let :test_entry, :new_entry_attrs and :edit_entry_attrs to test the basic
+# crud functionality. 
+# If single examples do not match with you implementation, you may skip
+# them by passing a skip parameter with context arrays:
+#   include_examples 'crud controller', :skip => [%w(index html sort) %w(destroy json)]
+shared_examples "crud controller" do |options|
+
+  include CrudControllerTestHelper
+
+  render_views
+
+  subject { response }
+  
+  let(:model_class)      { controller.send(:model_class) }
+  let(:model_identifier) { controller.model_identifier }
+  let(:test_params)      { scope_params }
+  let(:entry)            { assigns(controller.send(:ivar_name, model_class)) }
+  let(:entries)          { assigns(controller.send(:ivar_name, model_class).pluralize) }
+  let(:sort_column)      { model_class.column_names.first }
+  let(:search_value) do
+    field = controller.search_columns.first
+    val = test_entry[field].to_s
+    val[0..((val.size + 1)/ 2)]
+  end
+
+  before do
+    m = example.metadata
+    perform_combined_request if m[:perform_request] != false && m[:action] && m[:method]
+  end
+  
+  
+  describe_action :get, :index, :unless => skip?(options, 'index') do
+    context ".html", :format => :html, :unless => skip?(options, %w(index html)) do
+    
+      context 'plain', :unless => skip?(options, %w(index html plain)), :combine => 'ihp' do
+        it_should_respond
+        it_should_assign_entries
+        it_should_render
+      end
+      
+      context "search", :if => described_class.search_columns.present?, :unless => skip?(options, %w(index html search)), :combine => 'ihse' do
+        let(:params) { {:q => search_value} }
+        
+        it_should_respond
+        context "entries" do
+          subject { entries }
+          it { should include(test_entry) }
+        end
+      end
+      
+      context "sort", :unless => skip?(options, %w(index html sort)) do
+        context "ascending", :unless => skip?(options, %w(index html sort ascending)), :combine => 'ihso' do
+          let(:params) { {:sort => sort_column, :sort_dir => 'asc'} } 
+          
+          it_should_respond
+          it "should have sorted entries" do
+            sorted = entries.sort_by(&(sort_column.to_sym))
+            entries.should == sorted
+          end
+        end
+        
+        context "descending", :unless => skip?(options, %w(index html sort descending)), :combine => 'ihsd' do
+          let(:params) { {:sort => sort_column, :sort_dir => 'desc'} } 
+      
+          it_should_respond
+          it "should have sorted entries" do
+            sorted = entries.sort_by(&(sort_column.to_sym))
+            entries.should == sorted.reverse
+          end
+        end
+      end
+    end
+    
+    context ".json", :format => :json, :unless => skip?(options, %w(index json)), :combine => 'ij' do
+      it_should_respond
+      it_should_assign_entries
+      its(:body) { should start_with('[{') }
+    end
+  end
+  
+  describe_action :get, :show, :id => true, :unless => skip?(options, 'show') do
+
+    context ".html", :format => :html, :unless => skip?(options, %w(show html)) do
+      context "plain", :unless => skip?(options, %w(show html plain)), :combine => 'sh' do
+        it_should_respond
+        it_should_assign_entry
+        it_should_render
+      end
+      
+      context "with non-existing id", :unless => skip?(options, 'show', 'html', 'with non-existing id') do
+        let(:params) { {:id => 9999 } }
+        
+        it "should raise RecordNotFound", :perform_request => false do
+          expect { perform_request }.to raise_error(ActiveRecord::RecordNotFound)
+        end
+      end
+    end
+    
+    context ".json", :format => :json, :unless => skip?(options, %w(show json)), :combine => 'sj' do
+      it_should_respond
+      it_should_assign_entry
+      its(:body) { should start_with('{') }
+    end
+  end
+  
+  describe_action :get, :new, :unless => skip?(options, %w(new)) do
+    context "plain", :unless => skip?(options, %w(new plain)), :combine => 'new' do
+      it_should_respond
+      it_should_render
+      it_should_persist_entry(false)
+    end
+    
+    context "with params", :unless => skip?(options, 'new', 'with params') do
+      let(:params) { { model_identifier => new_entry_attrs } }
+      it_should_set_attrs(:new)
+    end
+  end
+  
+  describe_action :post, :create, :unless => skip?(options, %w(create)) do
+    let(:params) { { model_identifier => new_entry_attrs } }
+    
+    it "should add entry to database", :perform_request => false do
+      expect { perform_request }.to change { model_class.count }.by(1)
+    end
+    
+    context "html", :format => :html, :unless => skip?(options, %w(create html)) do
+      context "with valid params", :unless => skip?(options, %w(create html valid)), :combine => 'ch' do
+        it_should_redirect_to_show
+        it_should_set_attrs(:new)
+        it_should_persist_entry
+        it_should_have_flash(:notice)
+      end
+      
+      context "with invalid params", :failing => true, :unless => skip?(options, %w(create html invalid)), :combine => 'chi' do
+        it_should_render('new')
+        it_should_persist_entry(false)
+        it_should_set_attrs(:new)
+        it_should_not_have_flash(:notice)
+      end
+    end
+    
+    context "json", :format => :json, :unless => skip?(options, %w(create json)) do
+      context "with valid params", :unless => skip?(options, %w(create json valid)), :combine => 'cjv' do
+        it_should_respond(201)
+        it_should_set_attrs(:new)
+        its(:body) { should start_with('{') }
+        it_should_persist_entry
+      end
+      
+      context "with invalid params", :failing => true, :unless => skip?(options, %w(create json invalid)), :combine => 'cji' do
+        it_should_respond(422)
+        it_should_set_attrs(:new)
+        its(:body) { should match(/"errors":\{/) }
+        it_should_persist_entry(false)
+      end
+    end
+  end
+  
+  describe_action :get, :edit, :id => true, :unless => skip?(options, %w(edit)), :combine => 'edit' do
+    it_should_respond
+    it_should_render
+    it_should_assign_entry
+  end
+  
+  describe_action :put, :update, :id => true, :unless => skip?(options, %w(update)) do
+    let(:params) { {model_identifier => edit_entry_attrs} }
+    
+    it "should update entry in database", :perform_request => false do
+      expect { perform_request }.to change { model_class.count }.by(0)
+    end
+    
+    context ".html", :format => :html, :unless => skip?(options, %w(update html)) do
+      context "with valid params", :unless => skip?(options, %w(update html valid)), :combine => 'uhv' do
+        it_should_set_attrs(:edit)
+        it_should_redirect_to_show
+        it_should_persist_entry
+        it_should_have_flash(:notice)
+      end
+      
+      context "with invalid params", :failing => true, :unless => skip?(options, %w(update html invalid)), :combine => 'uhi' do
+        it_should_render('edit')
+        it_should_set_attrs(:edit)
+        it_should_not_have_flash(:notice)
+      end
+    end
+    
+    context ".json", :format => :json, :unless => skip?(options, %w(udpate json)) do
+      context "with valid params", :unless => skip?(options, %w(udpate json valid)), :combine => 'ujv' do
+        it_should_respond(204)
+        it_should_set_attrs(:edit)
+        its(:body) { should match(/s*/) }
+        it_should_persist_entry
+      end
+      
+      context "with invalid params", :failing => true, :unless => skip?(options, %w(update json invalid)), :combine => 'uji' do
+        it_should_respond(422)
+        it_should_set_attrs(:edit)
+        its(:body) { should match(/"errors":\{/) }
+      end
+    end
+  end
+  
+  describe_action :delete, :destroy, :id => true, :unless => skip?(options, %w(destroy)) do
+    
+    it "should remove entry from database", :perform_request => false  do
+      expect { perform_request }.to change { model_class.count }.by(-1)
+    end
+    
+    context ".html", :format => :html, :unless => skip?(options, %w(destroy html)) do
+      context "successfull", :combine => 'dhs' do
+        it_should_redirect_to_index
+        it_should_have_flash(:notice)
+      end
+      
+      context "with failure", :failing => true, :combine => 'dhf' do
+        it_should_redirect_to_index
+        it_should_have_flash(:alert)
+      end
+    end
+    
+    context ".json", :format => :json, :unless => skip?(options, %w(destroy json)) do
+      context "successfull", :combine => 'djs' do
+        it_should_respond(204)
+        its(:body) { should match(/s*/) }
+      end
+      
+      context "with failure", :failing => true, :combine => 'djf' do
+        it_should_respond(422)
+        its(:body) { should match(/"errors":\{/) }
+      end
+    end
+  end
+  
+end

data/lib/generators/dry_crud/templates/spec/support/crud_controller_test_helper.rb

@@ -0,0 +1,160 @@
+# Contains assertions for testing common crud controller use cases.
+# See crud_controller_examples for use cases.
+module CrudControllerTestHelper
+  extend ActiveSupport::Concern
+
+  # Performs a request based on the metadata of the action example under test.
+  def perform_request
+    m = example.metadata
+    example_params = respond_to?(:params) ? send(:params) : {}
+    params = scope_params.merge(:format => m[:format])
+    params.merge!(:id => test_entry.id) if m[:id]
+    params.merge!(example_params)
+    send(m[:method], m[:action], params)
+  end
+
+  # If a combine key is given in metadata, only the first request for all examples
+  # with the same key will be performed.
+  def perform_combined_request
+    if stack = example.metadata[:combine]
+      @@current_stack ||= nil
+      if stack == @@current_stack && described_class == @@current_controller.class
+        @response = @@current_response
+        @templates = @@current_templates
+        @controller = @@current_controller
+        @request = @@current_request
+      else
+        perform_request
+        
+        @@current_stack = stack
+        @@current_response = @response
+        @@current_request = @request
+        @@current_controller = @controller
+        @@current_templates = @templates
+      end
+    else
+      perform_request
+    end
+  end
+
+  # The params defining the nesting of the test entry.
+  def scope_params
+    params = {}
+    # for nested controllers, add parent ids to each request
+    Array(controller.nesting).reverse.inject(test_entry) do |parent, p|
+      if p.is_a?(Class) && p < ActiveRecord::Base
+        assoc = p.name.underscore
+        params["#{assoc}_id"] = parent.send(:"#{assoc}_id")
+        parent.send(assoc)
+      else
+        parent
+      end
+    end
+    params
+  end
+  
+  module ClassMethods
+    
+    # Describe a certain action and provide some usefull metadata.
+    # Tests whether this action is configured to be skipped.
+    def describe_action(method, action, metadata = {}, &block)
+      describe("#{method.to_s.upcase} #{action}", 
+               {:if => described_class.instance_methods.collect(&:to_s).include?(action.to_s), 
+                :method => method, 
+                :action => action}.
+               merge(metadata), 
+               &block)
+    end
+    
+    def skip?(options, *contexts)
+      options ||= {}
+      contexts = Array(contexts).flatten
+      skips = Array(options[:skip])
+      skips = [skips] if skips.blank? || !skips.first.is_a?(Array)
+      
+      skips.flatten.present? && 
+      skips.any? { |skip| skip == contexts.take(skip.size) }
+    end
+    
+    # Test the response status, default 200.
+    def it_should_respond(status = 200)
+      its(:status) { should == status }
+    end
+    
+    # Test that entries are assigned.
+    def it_should_assign_entries
+      it "should assign entries" do
+        entries.should be_present
+      end
+    end
+    
+    # Test that entry is assigned.
+    def it_should_assign_entry
+      it "should assign entry" do
+        entry.should == test_entry
+      end
+    end
+    
+    # Test that the given template or the main template of the action under test is rendered. 
+    def it_should_render(template = nil)
+      it { should render_template(template || example.metadata[:action]) }
+    end
+    
+    # Test that test_entry_attrs are set on entry.
+    def it_should_set_attrs(action = nil)
+      it "should set params as entry attributes" do
+        attrs = send("#{action}_entry_attrs")
+        actual = {}
+        attrs.keys.each do |key|
+          actual[key] = entry.attributes[key.to_s]
+        end
+        actual.should == attrs
+      end
+    end
+    
+    # Test that the response redirects to the index action.
+    def it_should_redirect_to_index
+      it { should redirect_to scope_params.merge(:action => 'index', :returning => true) } 
+    end
+    
+    # Test that the response redirects to the show action of the current entry.
+    def it_should_redirect_to_show
+      it { should redirect_to scope_params.merge(:action => 'show', :id => entry.id) } 
+    end
+    
+    # Test that the given flash type is present.
+    def it_should_have_flash(type, message = nil)
+      context "flash" do
+        subject { flash }
+        
+        its([type]) do
+          should(message ? match(message) : be_present)
+        end
+      end
+    end
+
+    # Test that not flash of the given type is present.
+    def it_should_not_have_flash(type)
+      context "flash" do
+        subject { flash }
+        its([type]) { should be_blank }
+      end
+    end
+    
+    # Test that the current entry is persistend and valid, or not.
+    def it_should_persist_entry(bool = true)
+      context "entry" do
+        subject { entry }
+    
+        if bool
+          it { should be_persisted }
+          it { should be_valid }
+        else
+          it { should_not be_persisted }
+        end
+      end
+    end
+  end
+  
+end
+

data/lib/generators/dry_crud/templates/test/crud_test_model.rb

@@ -1,8 +1,8 @@
 # A dummy model used for general testing.
 class CrudTestModel < ActiveRecord::Base #:nodoc:
 
-  attr_protected nil
-
+  attr_accessible :name, :whatever, :children, :rating, :income, :birthdate, :gets_up_at, :last_seen, :human, :remarks
+          
   belongs_to :companion, :class_name => 'CrudTestModel'
   has_and_belongs_to_many :others, :class_name => 'OtherCrudTestModel'
   has_many :mores, :class_name => 'OtherCrudTestModel', :foreign_key => :more_id
@@ -86,7 +86,7 @@ class CrudTestModelsController < CrudController #:nodoc:
     end
   end
 
-  protected
+  private
 
   def list_entries
     entries = super
@@ -98,6 +98,12 @@ class CrudTestModelsController < CrudController #:nodoc:
 
   private
 
+  def build_entry
+    entry = super
+    entry.companion_id = model_params.delete(:companion_id) if model_params
+    entry
+  end
+
   # custom callback
   def handle_name
     if entry.name == 'illegal'
@@ -106,6 +112,17 @@ class CrudTestModelsController < CrudController #:nodoc:
     end
   end
 
+  # callback to redirect if @should_redirect is set
+  def possibly_redirect
+    redirect_to :action => 'index' if should_redirect && !performed?
+    !should_redirect
+  end
+
+  def set_companions
+    @companions = CrudTestModel.all :conditions => {:human => true}
+  end
+
+
   # create callback methods that record the before/after callbacks
   [:create, :update, :save, :destroy].each do |a|
     callback = "before_#{a.to_s}"
@@ -125,16 +142,6 @@ class CrudTestModelsController < CrudController #:nodoc:
     called_callback(sym.to_s[HANDLE_PREFIX.size..-1].to_sym) if sym.to_s.starts_with?(HANDLE_PREFIX)
   end
 
-  # callback to redirect if @should_redirect is set
-  def possibly_redirect
-    redirect_to :action => 'index' if should_redirect && !performed?
-    !should_redirect
-  end
-
-  def set_companions
-    @companions = CrudTestModel.all :conditions => {:human => true}
-  end
-
   # records a callback
   def called_callback(callback)
     @called_callbacks ||= []
@@ -142,7 +149,14 @@ class CrudTestModelsController < CrudController #:nodoc:
   end
 
 end
-
+  
+#:nodoc:
+REGEXP_ROWS = /<tr.+?<\/tr>/m  #:nodoc:
+REGEXP_HEADERS = /<th.+?<\/th>/m  #:nodoc:
+REGEXP_SORT_HEADERS = /<th><a .*?sort_dir=asc.*?>.*?<\/a><\/th>/m  #:nodoc:
+REGEXP_ACTION_CELL = /<td class=\"action\"><a href.+?<\/a><\/td>/m  #:nodoc:
+  
+  
 # A simple test helper to prepare the test database with a CrudTestModel model.
 # This helper is used to test the CrudController and various helpers
 # without the need for an application based model.
@@ -178,7 +192,7 @@ module CrudTestHelper
     ERB::Util.h(text)
   end
 
-  protected
+  private
 
   # Sets up the test database with a crud_test_models table.
   # Look at the source to view the column definition.
@@ -245,13 +259,23 @@ module CrudTestHelper
     end
   end
 
-  private
+  def special_routing
+    controller = @controller || controller  # test:unit uses instance variable, rspec the method
+    @routes = ActionDispatch::Routing::RouteSet.new
+    _routes = @routes
+
+    controller.singleton_class.send(:include, _routes.url_helpers)
+    controller.view_context_class = Class.new(controller.view_context_class) do
+      include _routes.url_helpers
+    end
+
+    @routes.draw { resources :crud_test_models }
+  end
 
   def create(index, companion)
     c = str(index)
-    CrudTestModel.create!(:name => c,
+    m = CrudTestModel.new(:name => c,
                           :children => 10 - index,
-                          :companion => companion,
                           :rating => "#{index}.#{index}".to_f,
                           :income => 10000000 * index + 0.1 * index,
                           :birthdate => "#{1900 + 10 * index}-#{index}-#{index}",
@@ -262,6 +286,9 @@ module CrudTestHelper
                           :last_seen => "#{2000 + 10 * index}-#{index}-#{index} 1#{index}:2#{index}",
                           :human => index % 2 == 0,
                           :remarks => "#{c} #{str(index + 1)} #{str(index + 2)}\n" * (index % 3 + 1))
+    m.companion = companion
+    m.save!
+    m
   end
 
   def create_other(index)

data/lib/generators/dry_crud/templates/test/functional/crud_controller_test_helper.rb

@@ -76,16 +76,16 @@ module CrudControllerTestHelper
 
   def test_create
     assert_difference("#{model_class.name}.count") do
-      post :create, test_params(model_identifier => test_entry_attrs)
+      post :create, test_params(model_identifier => new_entry_attrs)
     end
     assert_redirected_to_show entry
     assert ! entry.new_record?
-    assert_test_attrs_equal
+    assert_attrs_equal(new_entry_attrs)
   end
 
   def test_create_json
     assert_difference("#{model_class.name}.count") do
-      post :create, test_params(model_identifier => test_entry_attrs, :format => 'json')
+      post :create, test_params(model_identifier => new_entry_attrs, :format => 'json')
     end
     assert_response :success
     assert @response.body.starts_with?("{")
@@ -100,15 +100,15 @@ module CrudControllerTestHelper
 
   def test_update
     assert_no_difference("#{model_class.name}.count") do
-      put :update, test_params(:id => test_entry.id, model_identifier => test_entry_attrs)
+      put :update, test_params(:id => test_entry.id, model_identifier => edit_entry_attrs)
     end
-    assert_test_attrs_equal
+    assert_attrs_equal(edit_entry_attrs)
     assert_redirected_to_show entry
   end
 
   def test_update_json
     assert_no_difference("#{model_class.name}.count") do
-      put :update, test_params(:id => test_entry.id, model_identifier => test_entry_attrs, :format => 'json')
+      put :update, test_params(:id => test_entry.id, model_identifier => edit_entry_attrs, :format => 'json')
     end
     assert_response :success
     assert_equal "", @response.body.strip
@@ -129,7 +129,7 @@ module CrudControllerTestHelper
     assert_equal "", @response.body.strip
   end
 
-  protected
+  private
 
   def assert_redirected_to_index
     assert_redirected_to test_params(:action => 'index', :returning => true)
@@ -139,8 +139,8 @@ module CrudControllerTestHelper
     assert_redirected_to test_params(:action => 'show', :id => entry.id)
   end
 
-  def assert_test_attrs_equal
-    test_entry_attrs.each do |key, value|
+  def assert_attrs_equal(attrs)
+    attrs.each do |key, value|
       actual = entry.send(key)
       assert_equal value, actual, "#{key} is expected to be <#{value.inspect}>, got <#{actual.inspect}>"
     end
@@ -175,6 +175,16 @@ module CrudControllerTestHelper
   def test_entry_attrs
     raise "Implement this method in your test class"
   end
+  
+  # Attribute hash used in edit/update tests.
+  def edit_entry_attrs
+    test_entry_attrs
+  end
+
+  # Attribute hash used in new/create tests.
+  def new_entry_attrs
+    test_entry_attrs
+  end
 
   # The params to pass to an action, including required nesting params.
   def test_params(params = {})

data/lib/generators/dry_crud/templates/test/functional/crud_test_models_controller_test.rb

@@ -278,25 +278,13 @@ class CrudTestModelsControllerTest < ActionController::TestCase
     assert_equal 'Crud Test Model', @controller.models_label(false)
   end
 
-  protected
-
-  def special_routing
-    @routes = ActionDispatch::Routing::RouteSet.new
-    _routes = @routes
-
-    @controller.singleton_class.send(:include, _routes.url_helpers)
-    @controller.view_context_class = Class.new(@controller.view_context_class) do
-      include _routes.url_helpers
-    end
-
-    @routes.draw { resources :crud_test_models }
-  end
+  private
 
   def test_entry
     crud_test_models(:AAAAA)
   end
 
-  def test_entry_attrs
+  def new_entry_attrs
     {:name => 'foo',
      :children => 42,
      :companion_id => 3,
@@ -307,4 +295,13 @@ class CrudTestModelsControllerTest < ActionController::TestCase
      :remarks => "some custom\n\tremarks"}
   end
 
+  def edit_entry_attrs
+    {:name => 'foo',
+     :children => 42,
+     :rating => 8.5,
+     :income => 2.42,
+     :birthdate => '31-12-1999'.to_date,
+     :human => true,
+     :remarks => "some custom\n\tremarks"}
+  end
 end