Red Box progress indicator with active_scaffold_upload branch

Problem
You need to display a splash screen when uploading files to a Ruby on Rails application.

Solution
My model:

class Number < ActiveRecord::Base
  file_column :intro
  file_column :vmail
end

The steps I have followed.

  1. Install redbox plugin from project path run:
    ./script/plugin install svn://rubyforge.org/var/svn/ambroseplugins/redbox
  2. If files redbox.js, redbox.css and redbox_spinner.gif haven’t been copied over to the public folders copy them over manually or go to vendor/plugins/redbox and run:
    rake update_scripts
  3. Find an animated gif for the progress indicator to be used (ie pleasewait.gif) and copy it over to public/images.
  4. In order to be able to use the progress indicator in different parts of the application, add the following to the app/views/layouts/ :
    application.rhtml
                 <%= stylesheet_link_tag 'redbox' %>
                <%= javascript_include_tag 'redbox' %>

    near the place where <= javascript_include_tag :default > is located.
    Also at the bottom of the page create the content of the redbox:

    <p id="redbox" style="display: none"> </p>
    
    <p style="color: blue"> Please wait ....
    
    Uploading files
    
    <img src="/images/pleasewait.gif" width="200" />
    
  5. Copy _update_form.rhtml, update_form.rhtml and update.rjs from vendor/plugins/active_scaffold_upload/frontends/default/views/ to the app/views/numbers (model you want to use).
  6. To display the redbox in the numbers/_update_form.rhtml add the following in the submit_tag:
     , :onClick => "return RedBox.showInline('redbox') " %>
  7. To close the redbox after the uploading was successful, add the following in numbers/update.rjs as the first line inside controller.send :successful? clause:
    page.RedBox.close()

Ruby On Rails on CentOS 4.6

Problem
Installing Ruby on Rails on CentOS 4.6.
The yum install ruby installs an old version of Ruby 1.8.1, but you want 1.8.6
Solution
Based on a script from uberdose

The original post is here:
http://wp.uberdose.com/2007/07/15/ruby-on-rails-on-centos-45/

  wget ftp://ftp.gnu.org/gnu/readline/readline-5.1.tar.gz
  tar xvfz readline-5.1.tar.gz
  cd readline-5.1
  ./configure --prefix=/usr/local
  make
  sudo make install

  cd ..
  wget ftp://ftp.ruby-lang.org/pub/ruby/1.8/ruby-1.8.6.tar.gz
  tar xvfz ruby-1.8.6.tar.gz
  cd ruby-1.8.6
  ./configure --prefix=/usr/local --enable-pthread --with-readline-dir=/usr/local --enable-shared
  make
  sudo make install

  cd ..
  wget http://rubyforge.org/frs/download.php/20980/rubygems-0.9.4.tgz
  tar xvfz rubygems-0.9.4
  cd rubygems-0.9.4
  sudo /usr/local/bin/ruby setup.rb
  cd ..
  sudo gem install rails --include-dependencies
  sudo gem install termios --include-dependencies
  sudo gem install mongrel --include-dependencies
  sudo gem install mongrel-cluster --include-dependencies
  sudo gem install capistrano --include-dependencies
  sudo gem install mysql -- --with-mysql-dir=/usr/

Using older Capistrano version 1.x after upgrading to Capistrano 2.x

Problem
You have just upgraded your Capistrano installation to version 2.x, but you didn’t have time to convert your recipes to the newer version.

Solution
In order to be able to use your old recipes of Capistrano version 1.x after upgrading, you can use the following (assuming your version 1.x is 1.4.1):

cap _1.4.1_ deploy

or, if you have migrations you want to use:

cap _1.4.1_ deploy_with_migrations

using authentication with acts_as_authenticated

Problem
You want to use the easiest authentication method, in order to add users/permissions to your application.

Solution

  1. Install the act_as_authenticated plugin:
    script/plugin install http://svn.techno-weenie.net/projects/plugins/acts_as_authenticated
  2. Generate controllers, models and migration:
    script/generate authenticated user account
  3. Add necessary user foreign keys in appropriate tables (ie customer in xxx_create_users.rb), plus other fields you may want to use in your user table (ie role):
    create table "users", :force => true do |t|
      t.column :login, :string
      ...
      t.column :role, :string, :default => 'C'
      ...
      end
      add_column :customers, :user_id, :integer
      ...
      def self.down
        ...
        remove_column :customers, :user_id
      end
  4. Run the migration:
    rake db:migrate VERSION=xxx
  5. Comment out from app/controllers/account_controller.rb the following:
    include AuthenticatedSystem
  6. Add it in the app/controllers/application.rb just under the class declaration.
  7. Add in application.rb (same as above) the following just after the session section:
    before_filter :login_required, :except => [:login, :signup, :logout]
  8. Comment out the default redirection after login and put your own (ie customers): in the account_controller.rb, just before
    the flash[:notice] = “Logged in successfully”.
    Also add the else for the the invalid login:

      redirect_back_or_default(:controller => 'customers', :action => 'list')
      flash[:notice] = "Logged in successfully"
    else
      flash[:notice] = "Invalid Login/Password!"
  9. Change the action in the signup and logout functions in the account_controller.rb file from index to login
  10. Add (optionally) more fields (role) in the signup page (app/views/account/signup.rhtml):
    
    
    
    <%= f.select :role, ['A','R','C'] %>
  11. Add restrictions for displaying records depending on user logged in, by using the conditions_for_collection of the activescaffold plugin in app/controllers/customers_controller.rb:
    def conditions_for_collection
      ['customers.user_id = (?)', current_user.id]
    end
  12. Add a menu page layout in app/views/layouts/_menu.rhtml:
  13. Add the call to the menu partial in the app/views/layouts/application.rhtml, just before the div with id=main :
    <%= render :partial => "layouts/menu"%>

Keeping uploaded files between deployments

Problem
You are using file_column plugin (or maybe another plugin?), to upload files in your ruby on rails application. Because the files are big you don’t want to have a different copy stored in your subversion repository for each different deployment version. You want to keep a common folder with all your uploaded files, and use it with every different deployment version.

Solution
For the example, we will have a numbers table that has two file_column uploadable columns (intro,voice_mail), with the following migration:

class CreateNumbers < ActiveRecord::Migration
  def self.up
    create_table :numbers do |t|
      t.column :customer_id, :int, :null => false
      t.column :phone_no, :string, :null => false
      t.column :intro, :string
      t.column :vmail, :string
      t.column :created_at, :datetime
      t.column :updated_at, :datetime
    end

  def self.down
    drop_table :numbers
  end
end
  1. If you already have used cap deploy or cap setup you should have a shared folder in your deployment server.
    You should copy the intro and vmail folders that should be located on your public/number folder on your local development client, on a folder called number in your development server in your shared folder.
  2. Create a file in your local pc in lib/cap_recipes.rb:
    Capistrano.configuration(:must_exist).load do
    
      desc "Keep generated uploaded files between deployments"
        task :after_symlink do
           run "rm -drf #{deploy_to}/#{current_dir}/public/number"
           sudo "ln -nfs #{shared_path}/number #{deploy_to}/#{current_dir}/public"
        end
      end

    Be careful with the naming of the task as (at least for capistrano 1.4 that I’m using), it must have a special name as after_symlink.
    Also be careful that if you try to use before_symlink, it won’t work as the current symlink won’t be setup.

  3. In your config/deploy.rb file add at the top the following:
    require 'lib/cap_recipes'
  4. Now you should be ready to deploy your new version so:
    svn -m "added customised capistrano recipes" commit

    make sure that you check in your version in subversion, and then:

    cap deploy

    you should be able to see a link in your current/public folder called number that points to the shared/number folder that hold all the uploaded files.

Adding icons to ActiveScaffold’s actions

Problem
You want to replace the standard text descriptions in ActiveScaffold’s actions with your icons.

Solution

  1. Create a file called active_scaffold_overrides.css in ror_project/public/stylesheets
  2. Copy the css code from ror_project/vendor/plugins/active_scaffold/frontends/default/stylesheets/stylesheet.css and paste it in to the file created in the previous step.
  3. Create a directory my_images in ror_project/public/images/activescaffold to hold your images.
  4. Copy to the new directory the images you want to use in the application.
  5. In the active_scaffold_overrides.css file find the section named:
    /* Table :: Actions (Edit,Delete) .... */

    and for each action that you want to use an icon add (ie edit)

    .active_scaffold tr.record td.actions a.edit {
        display:     block;
        width:        16px;
        height:       16px;
        background: transparent url(../../../images/active_scaffold/my_images/image.png) no-repeat right 50%;
    }
  6. In the application.rb, if you want the links to be the same for the whole application add:
    ActiveScaffold.set_defaults do |config|
        config.update.link.label =""
    end
  7. in your layout/application.rhtml (create one if you don’t already have one), include
    <%= stylesheet_link_tag "active_scaffold_overrides" %>
  8. Restart webrick/mongrel

Controller testing in Active Scaffold

Problem

You need to have to functionally test your controller when you are using ActiveScaffold. There are pieces of code that tell you how to do that on a normal ror application (ie without ActiveScaffold), like recipe 7.17 on the Rails Cookbook, or a fragment of code in an Active Scaffold application, but they don’t have the full details.

Solution

Here is an attempt to give some more detailed step by step instructions on how to do it.

  1. The migration for the example customer model.
  2. class CreateCustomers < ActiveRecord::Migration
      def self.up
        # Create customers table
        create_table  :customers do |t|
          t.column  :customer_code, :string, :null => false
          t.column  :created_at, :datetime
          t.column  :updated_at, :datetime
        end
      end
    end
  3. The customer model, with the extra function to display the customer code
  4. class Customer < ActiveRecord::Base
    
      has_many    :numbers
    
      def to_label
        "#{customer_code}"
      end
    end
  5. The customer controller app/controllers/customers_controller.rb, using the Active Scaffold
  6. class CustomersController < ApplicationController
    
      active_scaffold :customer do |config|
        config.list.columns = [:customer_code, :numbers, :created_at, :updated_at]
        config.columns[:customer_code].inplace_edit = true
     end
    
    end
  7. The fixtures YML file test/fixtures/customers.yml
  8. first_customer:
      id:               1
      customer_code:    123
      created_at:       2007-09-26 11:17:07
      updated_at:       2007-09-26 11:17:07
    
    second_customer:
      id:               2
      customer_code:    456
      created_at:       2007-09-26 11:17:13
      updated_at:       2007-09-26 11:17:13
  9. And here are some functions to test some pages and a full CRUD test
  10. require File.dirname(__FILE__) + '/../test_helper'
    require 'customers_controller'
    
    class CustomerControllerTest < Test::Unit::TestCase
      fixtures  :customers
    
      def setup
        @controller = CustomersController.new
        @request = ActionController::TestRequest.new
        @response = ActionController::TestResponse.new
      end
    
      def test_index
        get :index
        assert_response :success
        assert_template 'list'
      end
    
      def test_new
        get :new
        assert_response :success
        assert_template 'create_form'
      end
    
      def test_edit
        get :edit, :id => customers(:first_customer).id
        assert_response :success
        assert_template 'update_form'
      end
    
      def test_show
        get :show, :id => customers(:first_customer).id
        assert_response :success
        assert_template 'show'
      end
    
      def test_customer_controller_CRUD
    
        # CREATE
        # Get the number of records
        record_no = Customer.count
        # Create a new record
        post  :create, {"commit"=>"Create", :record=>{"customer_code"=>"890"}}
        # Assert that the record is not nil
        assert_not_nil  assigns("record")
        # Look that the number of records has been increased by 1
        assert_equal  record_no+1, Customer.count
    
        # UPDATE
        # Get the number of records
        record_no = Customer.count
        # Update a record
        new_customer_code = "987"
        put :update, {"commit"=>"Update",:id=>customers(:first_customer).id,
                                          :record=>{"customer_code"=>new_customer_code}}
        # Assert that the record is not nil
        assert_not_nil  assigns("record")
        # Look that the number of records has stayed the same
        assert_equal  record_no, Customer.count
        # Check that the update took place
        customer = Customer.find(customers(:first_customer).id)
        assert_equal  new_customer_code, customer.customer_code
    
        # DELETE
        # Get the number of records
        record_no = Customer.count
        # Delete a record
        delete  :destroy, :id => customers(:first_customer).id
        # Look that the number of records has been decreased by 1
        assert_equal  record_no-1, Customer.count
      end
    
    end

:int and :integer problem in Ruby on Rails migration

After spending some time trying to make a migration work, and having the error message coming back:

You have a nil object when you didn't expect it!
You might have expected an instance of Array.
The error occurred while evaluating nil.[]

I’ve decided to do a google search for the specific problem, as it was working fine with other test migrations.

It turns out that if the migration is not model specific, but a different one (ie trying to add a new column to an existing table), the :int for the column doesn’t work!
It has to be :integer.
Full bug report and the article are here:
Migrations: :integer works, :int doesn’t – datatype discrepancy