random utterings...: Subversion script for Rails developers

Subversion script for Rails developers

Chris Barnes — Wed, 19 Sep 2007 15:15:00 +0000

I read somewhere that good developers use version control. There's a good article on HowtoUseRailsWithSubversion.

So why should I repeat those steps for every new project I work on.

There is another article which attempted to tackle this problem. However, you still have to do the initial steps and then copy this script into your project directory and execute it.

The following script takes it a bit farther. You call it like this.

rails-svn app_dir repository username

So if I wanted to create a new rails project called toejam, I would execute:

rails-svn toejam svn://randomutterings.com/projects/toejam/trunk chris

Here's what happens under the hood.

After checking to make sure the directory doesn't already exist, your rails app is created with the standard rails command. (If the directory already exists, you will be asked if you want to continue. Choosing yes will allow the script to continue but if this script has been run on the same app twice, all of the svn commits will be duplicated.)
Your new app is imported to the subversion repository specified. Authentication is done with the username provided. You may be prompted for a password from your repository.
The original app directory is deleted and a working copy is checked out from the repository into that directory.
All the default rails log files are removed and subversion is instructed to ignore those files. (Log files can get large and we definitely don't need them in version control.)
The database.yml is moved to database.example to serve as a template for anyone who checks out the code and any newly created database.yml files are ignored by subversion. (Doing this will help if you have multiple developers working on the same project in different environments. It also prevents you from overwriting the database.yml file on the production server, oops!
Subversion is told to ignore everything in the tmp folder, the .htaccess files, and the dispatch.fcgi file.

Without further ado, here's the script. Just copy it and save it somewhere in your path. /usr/bin is a good choice. Don't forget to chmod 755 so you can execute it.

    #!/bin/bash

    if [ "$#" != "3" ]; then
      echo "Usage: rails-svn app_dir repository username"
      exit 1
    fi

    APPDIR=./$1
    SVN_TRUNK=$2
    SVN_USER=$3

    function check_if_exist () {
      if [[ -e $1 ]]; then
        echo ""
        echo "$1 already exists, overwrite? y or n"
        echo ""
        read OVERWRITE
        case "$OVERWRITE" in
        y)
          echo "Overwriting..."
          ;;
        *)
          echo "Action canceled"
          exit 1
          ;;
        esac
      fi
    }

    check_if_exist ${APPDIR}
    rails $APPDIR
    svn import $APPDIR $SVN_TRUNK -m "Import" --username $SVN_USER
    sudo rm -r $APPDIR
    svn checkout $SVN_TRUNK $APPDIR
    cd $APPDIR

    svn remove log/*
    svn commit -m "removing log files" 
    svn propset svn:ignore "*.log" log/
    svn update log/
    svn commit -m "Ignoring all files in /log/ ending in .log"
    svn move config/database.yml config/database.example
    svn commit -m "Moving database.yml to database.example to provide a template for anyone who checks out the code"
    svn propset svn:ignore "database.yml" config/
    svn update config/
    svn commit -m "Ignoring database.yml"
    svn remove tmp/*
    svn propset svn:ignore "*" tmp/
    svn update tmp/
    svn commit -m "ignore tmp/ content from now" 
    svn propset svn:ignore ".htaccess" public/
    svn update public/
    svn commit -m "Ignoring .htaccess"
    svn propset svn:ignore "dispatch.fcgi" public/
    svn update public/
    svn commit -m "Ignoring dispatch.fcgi"

I'm interested in converting this into a gem and possibly rewriting it in ruby. If anyone has the skills and wants to contribute, leave a comment or email me.

"Subversion script for Rails developers" by acompanhantes

Mon, 22 Aug 2011 17:45:45 +0000

Thank you for the informative content. http://www.frentesquentes.com acompanhantes acompanhantes

"Subversion script for Rails developers" by caneta espiã

Thu, 18 Aug 2011 02:42:06 +0000

What a nice article, thank you. caneta espiã

"Subversion script for Rails developers" by lussypointing@yahoo.com

Wed, 08 Jun 2011 11:15:26 +0000

This blog is really informative.I have read this blog and this blog is very useful for me.I have waiting next article.Thanks for great information shearing.http://www.PolicyInteractive.com.

"Subversion script for Rails developers" by sam

Thu, 03 Mar 2011 09:14:16 +0000

This articles helps me more.Thanks for your sharing,I will pay more attentions to your blog. Looking forward to your better and better articles.See you next time. tiffany & co

"Subversion script for Rails developers" by chaussure basket

Fri, 10 Dec 2010 03:56:29 +0000

Yeah! I very like this!@

"Subversion script for Rails developers" by Beats Headphones

Mon, 22 Nov 2010 07:22:40 +0000

bravo à vous deux !!! pas mal votre idéé de faire sponsorisé votre mariage !!jje vous souhaite tout le bonheur du monde !!! vous etiez magnifique !!! que de beaux souvenirs pour vous !!! soyez heureux bisous odile de marseille

"Subversion script for Rails developers" by Beats Headphones

Sat, 20 Nov 2010 14:17:45 +0000

Congrats to you guys for making the finest choice in the third party code you ship!

"Subversion script for Rails developers" by lista email

Sun, 17 Oct 2010 21:45:36 +0000

Chris Barnes my friend, thanks for sharing this script.

"Subversion script for Rails developers" by hdfh

Mon, 11 Oct 2010 08:55:11 +0000

pt directed to Rails developers? I am interested in the progress and transformation of any programming script.

"Subversion script for Rails developers" by Ann

Wed, 08 Sep 2010 12:15:57 +0000

Thanks for information!

"Subversion script for Rails developers" by Perry Cunningham

Tue, 18 May 2010 13:58:17 +0000

Have you perfected this particular subversion script directed to Rails developers? I am interested in the progress and transformation of any programming script.

neck firming cream

"Subversion script for Rails developers" by Frederick

Tue, 18 May 2010 12:14:14 +0000

Hi have you been improving this code lately? I am curious as to whether some people left comments via email. I am interested if your code has indeed reached the gem stage.

Free Bondage Videos

"Subversion script for Rails developers" by face blog

Sat, 27 Mar 2010 10:13:11 +0000

Thank you. Your explanation is even clear than a tutorial. It is short and sweet....awesome post.

"Subversion script for Rails developers" by rssnewsdigest

Thu, 03 Apr 2008 07:36:00 +0000

Try rssnewsdigest.com, a new comprehensive news aggregator. With rssnewsdigest, you don ’t really have to go anywhere else. http://rssnewsdigest.com

"Subversion script for Rails developers" by Chris Barnes

Wed, 07 Nov 2007 16:26:47 +0000

You're right Matt, I changed those lines, they should have been applied to the public directory.

"Subversion script for Rails developers" by matt

Fri, 26 Oct 2007 00:18:46 +0000

I was poking around in my own script that I wrote and noticed two lines that I have and you have as well: svn propset svn:ignore "dispatch.fcgi" config/ svn propset svn:ignore ".htaccess" config/ I deleted my cause I don't see how a htaccess or a dispatch file would find it's way into the config directory. Is there something I'm forgetting here?