dry_crud 0.6.0

data/rails_generators/dry_crud/templates/lib/standard_table_builder.rb

@@ -0,0 +1,104 @@
+# A simple helper to easily define tables listing several rows of the same data type.
+#
+# Example Usage:
+#   StandardTableBuilder.table(entries, template) do |t|
+#     t.col('My Header', :class => 'css') {|e| link_to 'Show', e }
+#     t.attrs :name, :city
+#   end
+class StandardTableBuilder
+	attr_reader :entries, :cols, :template
+  
+  # Delegate called methods to template.
+  # including StandardHelper would lead to problems with indirectly called methods.
+	delegate :content_tag, :format_attr, :column_type, :belongs_to_association, 
+           :captionize, :tr_alt, :to => :template
+
+	def initialize(entries, template)
+		@entries = entries
+		@template = template
+		@cols = []
+  end
+
+  # Convenience method to directly generate a table. Renders a row for each entry in entries.
+  # Takes a block that gets the table object as parameter for configuration.
+  # Returns the generated html for the table.
+  def self.table(entries, template)
+    t = new(entries, template)
+    yield t
+    t.to_html    
+  end
+
+  # Define a column for the table with the given header, the html_options used for
+  # each td and a block rendering the contents of a cell for the current entry.
+  # The columns appear in the order they are defined.
+	def col(header = '', html_options = {}, &block)
+		@cols << Col.new(header, html_options, @template, block)
+	end
+	
+  # Convenience method to add one or more attribute columns.
+  # The attribute name will become the header, the cells will contain
+  # the formatted attribute value for the current entry.
+	def attrs(*attrs)
+		attrs.each do |a|
+			col(captionize(a, entry_class), :class => align_class(a)) { |e| format_attr(e, a) }
+		end
+	end	
+	
+  # Renders the table as HTML.
+	def to_html
+		content_tag :table, :class => 'list' do
+			[html_header] + 
+			entries.collect { |e| html_row(e) }
+		end
+	end
+    
+  # Returns css classes used for alignment of the cell data.
+  # Based on the column type of the attribute.
+  def align_class(attr)
+    entry = entries.first
+    case column_type(entry, attr)
+      when :integer, :float, :decimal 
+        'right_align' unless belongs_to_association(entry, attr)
+      when :boolean  
+        'center_align'
+    end
+  end
+  
+  private 
+  
+	def html_header
+		content_tag :tr do
+			cols.collect { |c| c.html_header }
+		end
+  end
+
+	def html_row(entry)
+		tr_alt do
+			cols.collect { |c| c.html_cell(entry) }
+		end
+  end
+
+  def entry_class
+    entries.first.class
+  end
+	
+  # Helper class to store column information.
+	class Col < Struct.new(:header, :html_options, :template, :block) #:nodoc:
+	
+		delegate :content_tag, :to => :template
+	
+		def content(entry)
+			block.call(entry)
+		end
+		
+		def html_header
+			content_tag :th, header
+		end
+		
+		def html_cell(entry)
+			content_tag :td, content(entry), html_options
+		end
+
+  end
+
+end

data/rails_generators/dry_crud/templates/public/stylesheets/crud.css

@@ -0,0 +1,91 @@
+body, div, p, td, th {
+	font-family: Verdana, Geneva, Arial, Helvetica, sans-serif;
+	font-size: 11pt;
+}
+
+td {
+	vertical-align: top;
+}
+
+tr.even {
+	background-color: #DDD;
+}
+
+tr.odd { 
+	background-color: #EEE;
+}
+
+table.list {}
+
+/* div rendered if no entries available for list */
+div.list {}
+
+.right_align {
+	text-align: right;
+}
+
+.center_align {
+	text-align: center;
+}
+
+.labeled {
+	vertical-align: top;
+	margin: 1pt;
+}
+
+.labeled .caption {
+	font-style: italic;
+	width: 120pt;
+	padding-right: 5pt;
+	float: left;
+}
+
+.labeled .value {
+	margin-left: 125pt;
+}
+
+.labeled .value p {
+	margin: 0px;
+}
+
+.attributes {}
+
+a.action {
+	color: red;
+	text-decoration: none;
+}
+
+a:hover.action {
+	text-decoration: underline;
+}
+
+a:visited.action {
+	color: red;
+}
+
+#flash_notice {
+	color: #663333;
+}
+
+div.errorExplanation {
+	border: solid 1px #999999;
+	margin: 10pt;
+	padding: 5pt;
+	background-color: #FFBBBB;
+}
+
+.errorExplanation h2 {
+	font-size: 12pt;
+	margin-top: 0pt;
+}
+
+.errorExplanation ul {
+	margin-bottom: 5pt;
+}
+
+div.fieldWithErrors {
+	background-color: #FFBBBB;
+	display: inline-block;
+	padding: 2px;
+}
+

data/rails_generators/dry_crud/templates/test/crud_test_model.rb

@@ -0,0 +1,124 @@
+class CrudTestModel < ActiveRecord::Base #:nodoc:
+  validates_presence_of :name
+  
+  default_scope :order => 'name'
+  
+  belongs_to :companion, :class_name => 'CrudTestModel'
+  
+  def label
+    name
+  end
+end
+
+class CrudTestModelsController < CrudController #:nodoc:
+  HANDLE_PREFIX = 'handle_'
+  
+  before_create :possibly_redirect
+  before_create :handle_name
+  
+  before_render_new :possibly_redirect
+  before_render_new :set_companions
+  
+  attr_reader :called_callbacks
+  attr_accessor :should_redirect
+  
+  hide_action :called_callbacks, :should_redirect, :should_redirect=
+  
+  private
+  
+  # custom callback
+  def handle_name
+    if @entry.name == 'illegal'
+      flash[:error] = "illegal name"
+      return false
+    end
+  end
+  
+  [:create, :update, :save, :destroy].each do |a|
+    callback = "before_#{a.to_s}"
+    send(callback.to_sym, :"#{HANDLE_PREFIX}#{callback}")
+    callback = "after_#{a.to_s}"
+    send(callback.to_sym, :"#{HANDLE_PREFIX}#{callback}")
+  end
+  
+  def method_missing(sym, *args)
+    called_callback(sym.to_s[HANDLE_PREFIX.size..-1].to_sym) if sym.to_s.starts_with?(HANDLE_PREFIX)
+  end
+  
+  def possibly_redirect
+    redirect_to :action => 'index' if should_redirect && !performed?
+    !should_redirect
+  end
+  
+  def set_companions
+    @companions = CrudTestModel.all :conditions => {:human => true}
+  end
+  
+  def called_callback(callback)
+    @called_callbacks ||= []
+    @called_callbacks << callback
+  end
+  
+end
+
+ActionController::Routing::Routes.draw do |map|
+  map.resources :crud_test_models
+end
+
+# A simple test helper to prepare the test database with a CrudTestModel model.
+module CrudTestHelper
+
+  protected 
+  
+  # Sets up the test database with a crud_test_models table.
+  # Look at the source to view the column definition.
+  def setup_db    
+    silence_stream(STDOUT) do
+        ActiveRecord::Base.connection.create_table :crud_test_models, :force => true do |t|
+          t.string  :name, :null => false, :limit => 50
+          t.string  :whatever
+          t.integer :children
+          t.integer :companion_id
+          t.float   :rating
+          t.decimal :income, :precision => 14, :scale => 2
+          t.date    :birthdate
+          t.boolean :human, :default => true
+          t.text    :remarks
+          
+          t.timestamps
+      end
+    end
+  end
+  
+  # Removes the crud_test_models table from the database.
+  def reset_db
+    [:crud_test_models].each do |table|            
+      ActiveRecord::Base.connection.drop_table(table) rescue nil
+    end
+  end
+  
+  # Creates 6 dummy entries for the crud_test_models table.
+  def create_test_data
+    (1..6).inject(nil) {|prev, i| create(i, prev) }
+  end
+  
+  # Fixture-style accessor method to get CrudTestModel instances by name
+  def crud_test_models(name)
+    CrudTestModel.find_by_name(name.to_s)
+  end
+  
+  private
+  
+  def create(index, companion)
+    c = (index + 64).chr * 5
+    CrudTestModel.create!(:name => c, 
+                          :children => index, 
+                          :companion => companion,
+                          :rating => "#{index}.#{index}".to_f, 
+                          :income => 10000000 * index + 0.1 * index, 
+                          :birthdate => "#{1900 + 10 * index}-#{index}-#{index}", 
+                          :human => index % 2 == 0,
+                          :remarks => "#{c} #{c} #{c}\n" * 3)
+  end
+  
+end

data/rails_generators/dry_crud/templates/test/functional/crud_controller_test_helper.rb

@@ -0,0 +1,172 @@
+# A module to include into your functional tests for your crud controller subclasses.
+# Simply implement the two methods :test_entry and :test_entry_attrs to test the basic
+# crud functionality. Override the test methods if you changed the behaviour in your subclass
+# controller.
+module CrudControllerTestHelper 
+    
+  def test_index
+    get :index
+    assert_response :success
+    assert_template 'index'
+    assert_not_nil assigns(:entries)
+  end
+  
+  def test_index_xml
+    get :index, :format => 'xml'
+    assert_response :success
+    assert_not_nil assigns(:entries)
+    assert @response.body.starts_with?("<?xml")
+  end
+  
+  def test_show
+    get :show, :id => test_entry.id
+    assert_response :success
+    assert_template 'show'  
+    assert_equal test_entry, assigns(:entry)
+  end
+  
+  def test_show_xml
+    get :show, :id => test_entry.id, :format => 'xml'
+    assert_response :success
+    assert_equal test_entry, assigns(:entry)
+    assert @response.body.starts_with?("<?xml")
+  end
+  
+  def test_show_with_not_existing_id_raises_RecordNotFound
+    assert_raise(ActiveRecord::RecordNotFound) do
+      get :show, :id => 9999
+    end
+  end
+    
+  def test_show_without_id_redirects_to_index
+    get :show
+    assert_redirected_to_index  
+  end
+    
+  def test_new
+    get :new
+    assert_response :success
+    assert_template 'new'
+    assert assigns(:entry).new_record?
+  end
+  
+  def test_create
+    assert_difference("#{model_class.name}.count") do
+      post :create, model_identifier => test_entry_attrs
+    end
+    assert_redirected_to assigns(:entry)
+    assert ! assigns(:entry).new_record?
+    assert_test_attrs_equal
+  end
+  
+  def test_create_with_wrong_http_method_redirects
+    get :create, model_identifier => test_entry_attrs
+    assert_redirected_to_index
+    
+    put :create, model_identifier => test_entry_attrs
+    assert_redirected_to_index
+    
+    delete :create, model_identifier => test_entry_attrs
+    assert_redirected_to_index
+  end
+    
+  def test_create_xml
+    assert_difference("#{model_class.name}.count") do
+      post :create, model_identifier => test_entry_attrs, :format => 'xml'
+    end
+    assert_response :success
+    assert @response.body.starts_with?("<?xml")
+  end
+  
+  def test_edit
+    get :edit, :id => test_entry.id
+    assert_response :success
+    assert_template 'edit'
+    assert_equal test_entry, assigns(:entry)
+  end
+  
+  def test_edit_without_id_raises_RecordNotFound
+    assert_raise(ActiveRecord::RecordNotFound) do
+      get :edit
+    end
+  end
+  
+  def test_update
+    assert_no_difference("#{model_class.name}.count") do
+      put :update, :id => test_entry.id, model_identifier => test_entry_attrs
+    end
+    assert_test_attrs_equal
+    assert_redirected_to assigns(:entry)
+  end
+    
+  def test_update_with_wrong_http_method_redirects
+    get :update, :id => test_entry.id, model_identifier => test_entry_attrs
+    assert_redirected_to_index
+    
+    delete :update, :id => test_entry.id, model_identifier => test_entry_attrs
+    assert_redirected_to_index
+  end
+  
+  def test_update_xml
+    assert_no_difference("#{model_class.name}.count") do
+      put :update, :id => test_entry.id, model_identifier => test_entry_attrs, :format => 'xml'
+    end
+    assert_response :success
+    assert_equal "", @response.body.strip
+  end
+
+  def test_destroy
+    assert_difference("#{model_class.name}.count", -1) do
+      delete :destroy, :id => test_entry.id
+    end
+    assert_redirected_to_index
+  end
+  
+  def test_destroy_with_wrong_http_method_redirects
+    get :destroy, :id => test_entry.id
+    assert_redirected_to_index
+    
+    put :destroy, :id => test_entry.id
+    assert_redirected_to_index
+  end
+  
+  def test_destroy_xml
+    assert_difference("#{model_class.name}.count", -1) do
+      delete :destroy, :id => test_entry.id, :format => 'xml'
+    end
+    assert_response :success
+    assert_equal "", @response.body.strip
+  end
+  
+  protected 
+  
+  def assert_redirected_to_index
+    assert_redirected_to :action => 'index'
+  end
+  
+  def assert_test_attrs_equal
+    test_entry_attrs.each do |key, value|
+      actual = assigns(:entry).send(key)
+      assert_equal value, actual, "#{key} is expected to be <#{value.inspect}>, got <#{actual.inspect}>"
+    end
+  end
+  
+  def model_class
+    @controller.controller_name.classify.constantize
+  end
+  
+  def model_identifier
+    @controller.controller_name.singularize.to_sym
+  end
+  
+  # Test object used in several tests
+  def test_entry
+    raise "Implement this method in your test class"
+  end
+  
+  # Attribute hash used in several tests
+  def test_entry_attrs
+    raise "Implement this method in your test class"
+  end
+  
+end

data/rails_generators/dry_crud/templates/test/functional/crud_test_models_controller_test.rb

@@ -0,0 +1,96 @@
+require 'test_helper'
+require 'crud_test_model'
+require File.join(File.dirname(__FILE__), 'crud_controller_test_helper')
+
+class CrudTestModelsControllerTest < ActionController::TestCase
+  
+  include CrudControllerTestHelper
+  include CrudTestHelper
+  
+  attr_accessor :models
+  
+  setup :reset_db, :setup_db, :create_test_data
+  
+  teardown :reset_db
+  
+  def test_setup
+    assert_equal 6, CrudTestModel.count
+    assert_equal CrudTestModelsController, @controller.class
+    assert_recognizes({:controller => 'crud_test_models', :action => 'index'}, '/crud_test_models')
+    assert_recognizes({:controller => 'crud_test_models', :action => 'show', :id => '1'}, '/crud_test_models/1')
+    assert_equal %w(index show new create edit update destroy).to_set, CrudTestModelsController.send(:action_methods)
+  end
+  
+  def test_index
+    super
+    assert_equal 6, assigns(:entries).size
+    assert_equal assigns(:entries).sort_by {|a| a.name }, assigns(:entries)
+  end
+  
+  def test_new
+    super
+    assert assigns(:companions)
+  end
+  
+  def test_create
+    super
+    assert_equal [:before_create, :before_save, :after_save, :after_create], @controller.called_callbacks
+  end
+  
+  def test_update
+    super
+    assert_equal [:before_update, :before_save, :after_save, :after_update], @controller.called_callbacks
+  end
+  
+  def test_destroy
+    super
+    assert_equal [:before_destroy, :after_destroy], @controller.called_callbacks
+  end
+  
+  def test_create_with_before_callback
+    assert_no_difference("#{model_class.name}.count") do
+      post :create, :crud_test_model => {:name => 'illegal', :children => 2}
+    end
+    assert_template 'new'
+    assert assigns(:entry).new_record?
+    assert assigns(:companions)
+    assert flash[:error].present?
+    assert_equal 'illegal', assigns(:entry).name
+    assert_nil @controller.called_callbacks
+  end
+    
+  def test_create_with_before_callback_redirect
+    @controller.should_redirect = true
+    assert_no_difference("#{model_class.name}.count") do
+      post :create, :crud_test_model => {:name => 'illegal', :children => 2}
+    end
+    assert_redirected_to :action => 'index'
+    assert_nil @controller.called_callbacks
+  end
+  
+  def test_new_with_before_render_callback_redirect_does_not_set_companions
+    @controller.should_redirect = true
+    get :new
+    assert_redirected_to :action => 'index'
+    assert_nil assigns(:companions)
+  end
+  
+  
+  protected 
+  
+  def test_entry
+    crud_test_models(:AAAAA)
+  end
+  
+  def test_entry_attrs
+    {:name => 'foo', 
+     :children => 42, 
+     :companion_id => 3,
+     :rating => 99.99, 
+     :income => 2.42, 
+     :birthdate => '31-12-1999'.to_date,
+     :human => true,
+     :remarks => "some custom\n\tremarks"}
+  end
+  
+end

data/rails_generators/dry_crud/templates/test/unit/crud_helper_test.rb

@@ -0,0 +1,57 @@
+require 'test_helper'
+require 'crud_test_model'
+
+class CrudHelperTest < ActionView::TestCase
+  
+  include StandardHelper
+  include CrudTestHelper
+  
+  setup :reset_db, :setup_db, :create_test_data
+  teardown :reset_db
+  
+  def model_class
+    CrudTestModel
+  end
+  
+  test "standard crud table" do
+    @entries = CrudTestModel.all
+    t = crud_table
+    assert_match /(<tr.+?<\/tr>){7}/m, t
+    assert_match /(<th.+?<\/th>){14}/m, t
+    assert_match /(<a href.+?<\/a>.*?){18}/m, t
+  end
+    
+  test "custom crud table" do
+    @entries = CrudTestModel.all
+    t = crud_table do |t|
+      t.attrs :name, :children, :companion_id
+      t.col("head") {|e| content_tag :span, e.income.to_s }
+    end
+    assert_match /(<tr.+?<\/tr>){7}/m, t
+    assert_match /(<th.+?<\/th>){4}/m, t
+    assert_match /(<span>.+?<\/span>.*?){6}/m, t
+    assert_no_match /(<a href.+?<\/a>.*?)/m, t
+  end
+  
+  test "crud form" do
+    @entry = CrudTestModel.first
+    f = capture { crud_form }
+    
+    assert_match /form .*?action="\/crud_test_models\/#{@entry.id}"/, f
+    assert_match /input .*?name="crud_test_model\[name\]" .*?type="text"/, f
+    assert_match /input .*?name="crud_test_model\[whatever\]" .*?type="text"/, f
+    assert_match /input .*?name="crud_test_model\[children\]" .*?type="text"/, f
+    assert_match /input .*?name="crud_test_model\[rating\]" .*?type="text"/, f
+    assert_match /input .*?name="crud_test_model\[income\]" .*?type="text"/, f
+    assert_match /select .*?name="crud_test_model\[birthdate\(1i\)\]"/, f
+    assert_match /input .*?name="crud_test_model\[human\]" .*?type="checkbox"/, f
+    assert_match /select .*?name="crud_test_model\[companion_id\]"/, f
+    assert_match /textarea .*?name="crud_test_model\[remarks\]"/, f
+  end
+  
+  test "default attributes do not include id" do 
+    assert_equal [:name, :whatever, :children, :companion_id, :rating, :income, 
+                  :birthdate, :human, :remarks, :created_at, :updated_at], default_attrs
+  end
+  
+end