A Clean, Well-Lighted Place - Home

Deploying symfony project with Capistrano

2008-05-12T19:15:00Z

As you may know Capistrano is a great tool "originally written to ease the pain of deploying Rails applications". If you are not familiar with it take a look at it's getting started guide. Even if Rails applications development is the primary way that people use Capistrano it can be used for a lot more than that.

Let me show you how you can use it for easy-and-with-no-pain deployment of symfony project.

First cd to your project and run (I assume that you have Capistrano installed allready)

$ capify .

to capify your project . This will create two files - Capify and config/deploy.rb. We'll use the second one for our symfony related tasks.
So this is how the modifed deploy.rb file that I use to deploy my symfony projects looks like :

set :application, "mysfapp"
set :repository,  "http://path/to/the/version/control/repository"

# If you aren't deploying to /u/apps/#{application} on the target
# servers (which is the default), you can specify the actual location
# via the :deploy_to variable:
set :deploy_to, "/path/to/project/#{application}"

# If there's no access to the repository from the production server, deploy via uploading tarball to the server
#set :deploy_via, :copy

# If you aren't using Subversion to manage your source code, specify
# your SCM below:
# set :scm, :subversion

role :app, "codingspree.net"
role :web, "codingspree.net"
# role :db,  "your db-server here", :primary => true

set :user, "codingspree"

# path to php executable 
set :php, "/usr/local/php5/bin/php5"

# symfony application name (used for migrations)
set :sf_app, "frontend"

namespace (:deploy) do

  desc <<-DESC
    [internal] Overriding original task to fit to symfony project needs
  DESC
  task :finalize_update, :except => { :no_release => true } do
    run "chmod -R g+w #{latest_release}" if fetch(:group_writable, true)

    run <<-CMD
      rm -rf #{latest_release}/log &&
      ln -s #{shared_path}/log #{latest_release}/log
    CMD
    
    run <<-CMD
      rm -rf #{latest_release}/cache &&
      ln -s #{shared_path}/cache #{latest_release}/cache
    CMD
    
    stamp = Time.now.utc.strftime("%Y%m%d%H%M.%S")
    asset_paths = %w(images css js).map { |p| "#{latest_release}/web/#{p}" }.join(" ")
    run "find #{asset_paths} -exec touch -t #{stamp} {} ';'; true", :env => { "TZ" => "UTC" }
  end
  
  desc <<-DESC
    Overriding original task to exclude restart
  DESC
  task :default do
    update
  end
  
  desc <<-DESC
    Overriding original task to use symfoy migrations (via sfMigrationsLightPlugin)
  DESC
  task :migrations do
    update
    sf.migrate
  end  
  
  after "deploy:update", 'deploy:customize'
  
  desc <<-DESC
    All custom tasks will be here
  DESC
  task :customize do
    # custmize it here
    sf.symlinks
    sf.remove_dev_environments
    
    # clear cache
    sf.cc
  end
  
end


namespace (:sf) do
  
  desc <<-DESC
    Run the "symfony migrate" task
  DESC
  task :migrate do
    run "cd #{current_path} && #{php} symfony migrate #{sf_app}"    
  end

  desc <<-DESC
    Run the "symfony cc" task
  DESC
  task :cc do
    run "cd #{current_path} && rm -rf cache/*"
  end

  desc <<-DESC
    Create symlink to symfony specific targets
  DESC
  task :symlinks do
    # symlink to database.yml
    run "rm -rf #{current_path}/config/databases.yml"
    run "ln -s #{shared_path}/databases.yml #{current_path}/config/databases.yml"

    # symlink to config.php    
    run "rm -rf #{current_path}/config/config.php"
    run "ln -s #{shared_path}/config.php #{current_path}/config/config.php"

    # symlink to sf data dir    
    run "rm -rf #{current_path}/web/sf"
    run "ln -s /path/to/sf/data/dir #{current_path}/web/sf"
        
    # symlink to uploads    
    run "rm -rf #{current_path}/web/uploads"
    run "ln -s #{shared_path}/uploads #{current_path}/web/uploads"
    
  end 
  
  desc <<-DESC
    Remove DEV environments
  DESC
  task :remove_dev_environments do
    run "rm -rf #{current_path}/web/*_dev.php"    
  end 
  
  desc <<-DESC
    Disable symfony application
  DESC
  task :disable do
    run "cd #{current_path} && #{php} symfony disable #{sf_app} prod"    
  end 
  
  desc <<-DESC
    Enable symfony application
  DESC
  task :enable do
    run "cd #{current_path} && #{php} symfony enable #{sf_app} prod"    
  end   
end

As you can see most of it is usual Capistrano configuration (user, repository, application, etc.) so I'll explain only the symfony related stuff.

12	# path to php executable set :php, "/usr/local/php5/bin/php5"

This variable is used to specify where PHP5 cli is placed (you know not all hostings are using PHP5 as default).

12	# symfony application name (used for migrations)set :sf_app, "frontend"

Here we specify the name of one of our symfony project applications. It will be needed to run migrations (you ARE using sfPropelMigrationsLightPlugin allready, right?).

In the next section of the deploy.rb file I overrided few of the original tasks from deploy namespace to fit to my needs - finalize_update to set symlinks to symfony cache and log directories, the default task to exclude restart because I don't need it, migrations to set it to use symfony migrations and at the end there is one hook task that will be executed after deploy:update -it's called customize and I'll place all custom tasks there.

The last part of the file is sf namespace that includes some symfony related tasks as migrate, cc, symlinks, remove_dev_environments, disable, enable and so on. As you see you can wrap any symfony task that you have to execute on the production server with Capistrano task.

All you need now is to set a little bit the production server (run cap deploy:config, symlink document root to /path/to/project/mysfapp/current, place relevant database.yml and config.php in /path/to/project/mysfapp/shared, etc) and you are ready to run

$ cap deploy

Thats it! Easy one command deployment! With migrations (cap deploy:migrate)! Hope it's explained clear enough (if not place your questions in the comments).

See ya @ EuRuKo 2008

2008-03-20T14:39:00Z

This year's portion of beer and ruby is waiting me in Prague at euruko2008.org
See ya there ;)

How to generate urls for ActionMailer emails

2007-11-12T22:18:00Z

This is a little bit tricky, but I've found an solution in the comments from other article on this problem. First we need to set default_url_options for ActionMailer::Base. This can be done with before_filter method in ApplicationController

class ApplicationController < ActionController::Base
  before_filter :set_default_url_options_for_mailers

  def set_default_url_options_for_mailers
    ActionMailer::Base.default_url_options[:host] = request.host_with_port
  end

end

Now we can generate the url in the mailer model

  def email_confirmation(user)
    recipients user.email
    from  "example.com  <no-reply@example.com>"
    subject "Confirm your email address"
    content_type "text/html"

    body :user => user, :activation_page => url_for(:controller => "main", :action => 
    'activate', :only_path => false)
  end

Adding callbacks for Propel models in symfony project

2007-09-11T10:13:00Z

This is a simple how-to that describes adding callbacks for Propel models in symfony project (like those usefull methods in ActiveRecord::Callbacks module).

Step 1 : Enable Propel behaviors in config/propel.ini

propel.builder.AddBehaviors = true     // Default value is false

Step 2 : Register the callback method and define it in model class - for example lib/model/Page.php

class PageTab extends BasePageTab
{
  function preSave(BaseObject $object, $con)
  {
    
  }
}

sfMixer::register('BasePageTab:save:pre', array('PageTab', 'preSave'));

Step 3 : Rebuild the model

$ symfony propel-build-model

There is much more detailed article on this topic by François Zaninotto called "Understanding Behaviors"

"Skinny Controller, Fat Model" approach in symfony project

2007-09-10T15:24:00Z

A very common error when you first start to write an application in the MVC way is bypassing some of the components or just not using it as it should.
This problem and an example how to do it in the "right way" are described in a one of Jamis Buck's posts called Skinny Controller, Fat Model.

Here is a cover-up version of the code from that post ported to symfony/PHP...

Before (or how-NOT-to-do-it example) :

<!-- listSuccess.php -->
<?php
  foreach ($path as $breadcrumb=>$name)
  {
    ?>
      <a href="<?=url_for($breadcrumb)?>"><?=__($name)?></a> / 
    <?
  }
  
  foreach ($people as $p)
  {
    ?>
      <div id="person-<?=$p->getId()?>">
        <span class="name">
          <?=$p->getLastName()?>, <?=$p->getFirstName()?>
        </span>
        <span class="age">
          <?= (date('Y') - date('Y', strtotime($p->getBirthdate()))) ?>
        </span>
      </div>
    <?
  }
?>

# actions.php
class personsActions extends sfActions
{
  public function executeList()
  {
    $c = new Criteria;
    $c->add(PersonPeer::ADDED_AT, date('Y-m-d'), Criteria::GREATER_EQUAL);
    $c->add(PersonPeer::DELETED, false);
    
    $this->people = Person::doSelect($c);
  }
}

1234	# PersonPeer.phpclass PersonPeer extends BasePersonPeer{}

After (or do-it-in-this-way example) :

<!-- listSuccess.php -->
<?php echo breadcrumbs($path) ?>

<?php foreach ($people as $p): ?>
  <div id="person-<?php echo $p->getId()?>">
    <span class="name"><?php echo $p->getFullName()?></span>
    <span class="age"><?php echo $p->getAge()?></span>
  </div>
<? endforeach;?>

# actions.php
class personsActions extends sfActions
{
  public function executeList()
  {
    $this->people = PersonPeer::findRecent();
  }
}

# PersonPeer.php
class PersonPeer extends BasePersonPeer
{
  public function findRecent()
  {
    $c = new Criteria;
    $c->add(self::ADDED_AT, date('Y-m-d'), Criteria::GREATER_EQUAL);
    $c->add(self::DELETED, false);

    return self::doSelect($c);
  }
}

# Person.php
class Person extends BasePerson
{
  public function getFullName()
  {
    return $this->getLastName() . ', ' . $p->getFirstName();
  }

  public function getAge()
  {
    return (date('Y') - date('Y', strtotime($this->getBirthdate())));
  }
}

Eclipse Regular Expression Tester

2007-08-28T15:14:00Z

Today, while searching for online regular expressions tester I've found this very nice plugin - Eclipse Regular Expression Tester. Give it a try!

Presentation: Applying Agile to Ruby

2007-08-07T17:10:00Z

Another great talk on infoq.com. By Fred George.

Presentation: The Beauty of Ruby

2007-07-09T16:11:00Z

In this talk Glenn Vanderburg demonstrates some of the subtle beauty that experienced Rubyists know and love.