capifony 0.4.0 → 0.4.1

data/CHANGELOG

@@ -1,3 +1,11 @@
+== 0.4.1 / June 17, 2010
+
+* added `symfony_env_local` variable, specifying local symfony environment to work with
+* added third parameter (blocks) to `prompt_with_default` (as in `ask`)
+* hided password from input & logs in `symfony:configure:database` task
+* added confirmation dialogs to destructive ORM tasks
+* run `project:clear-controllers` only on `prod` environment
+
 == 0.4.0 / June 16, 2010
 
 * added propel tasks (thanks to http://github.com/arlo)

data/README

@@ -3,14 +3,12 @@ Deploying symfony Applications with Capistrano
 
 Capistrano is an open source tool for running scripts on multiple servers. It’s primary use is for easily deploying applications. While it was built specifically for deploying Rails apps, it’s pretty simple to customize it to deploy other types of applications. We’ve been working on creating a deployment “recipe” to work with symfony applications to make our job a lot easier.
 
-Prerequisites
--------------
+## Prerequisites ##
 
 - Must have SSH access to the server you are deploying to.
 - Must have Ruby and RubyGems installed on your machine (not required for deployment server)’
 
-Installing Capifony
--------------------
+## Installing Capifony ##
 
 ### Through RubyGems.org ###
 
@@ -23,8 +21,7 @@ Installing Capifony
 	gem build capifony.gemspec
 	sudo gem install capifony-{version}.gem
 
-Setup your project to use Capifony
-----------------------------------
+## Setup your project to use Capifony ##
 
 CD to your project directory & run:
 
@@ -34,8 +31,7 @@ This will create `Capfile` in your project root & `deploy.rb` config file in `co
 
 Fill up your `config/deploy.rb` with your server connection data
 
-Server Setup
-------------
+## Server Setup ##
 
 Now, you can start the deployment process! To get your server setup with the file structure that Capistrano expects, you can run:
 
@@ -43,16 +39,18 @@ Now, you can start the deployment process! To get your server setup with the fil
 
 This command will create the following folder structure on your server:
 
-	|-- deploy_to_path
-	  |-- current (symlink)
+	`-- /var/www/demo.everzet.com
+	  |-- current → /var/www/demo.everzet.com/releases/20100512131539
 	  |-- releases
 	    |-- 20100512131539
 	    |-- 20100509150741
-	    |-- 20100509145325
-	  |-- shared
+	    `-- 20100509145325
+	  `-- shared
 	    |-- log
-	    |-- web
-	      |-- uploads
+	    |-- config
+	      `-- databases.yml
+	    `-- web
+	      `-- uploads
 
 The folders in the releases directory will be the actual deployed code, timestamped. Capistrano symlinks your log & web/uploads directories from your app to the directories in the shared folder so that it doesn’t get erased when you deploy a new version of your code.
 
@@ -60,8 +58,7 @@ To deploy your application, simply run:
 
 	cap deploy
 
-Deployment
-----------
+## Deployment ##
 
 To configure database on production environment, run:
 
@@ -77,8 +74,7 @@ Now, whenever you need to deploy a new version of your code, just run:
 
 	cap deploy
 
-Databases
----------
+## Databases ##
 
 If you need to dump remote database & download this dump to local `backups/` folder, run:
 
@@ -96,8 +92,7 @@ If you need to dump local database & populate this dump on remote server, run:
 
 	cap database:move:to_remote
 
-Shared folders
---------------
+## Shared folders ##
 
 If you need to download some shared folders from remote server, run:
 
@@ -107,8 +102,7 @@ If you need to upload some shared folders to remote server, run:
 
 	cap shared:{databases OR log OR uploads]:to_remote
 
-Other tasks
------------
+## Other tasks ##
 
 If you need to deploy and run your migrations you can call:
 
@@ -122,7 +116,7 @@ This will deploy the application, rebuild the test database, then run all of the
 
 Also, you have command to run your custom symfony tasks:
 
-	cap symfony:run_task
+	cap symfony
 
 If you want to see all of the Capistrano tasks available, you can run:
 
@@ -130,10 +124,9 @@ If you want to see all of the Capistrano tasks available, you can run:
 
 We’ve been using this setup for a little while now, and it’s saved us a ton of time when we need to push changes for a site to the production server.
 
-Contributors
-============
+## Contributors ##
 
 * everzet (owner): [http://github.com/everzet](http://github.com/everzet)
-* Travis Roberts (creator of improved version): [http://blog.centresource.com/author/troberts/](http://blog.centresource.com/author/troberts/)
 * Arlo (contributor): [http://github.com/arlo](http://github.com/arlo)
 * Xavier Gorse (contributor): [http://github.com/xgorse](http://github.com/xgorse)
+* Travis Roberts (creator of improved version): [http://blog.centresource.com/author/troberts/](http://blog.centresource.com/author/troberts/)

data/lib/capifony.rb

@@ -1,19 +1,22 @@
 require 'yaml'
 
 # Dirs that need to remain the same between deploys (shared dirs)
-set :shared_children, %w(log web/uploads)
+set :shared_children,   %w(log web/uploads)
 
 # Files that need to remain the same between deploys
-set :shared_files,    %w(config/databases.yml)
+set :shared_files,      %w(config/databases.yml)
 
 # Asset folders (that need to be timestamped)
-set :asset_children,  %w(web/css web/images web/js)
+set :asset_children,    %w(web/css web/images web/js)
 
 # PHP binary to execute
-set :php_bin,         "php"
+set :php_bin,           "php"
+
+# Symfony environment on local
+set :symfony_env_local, "dev"
 
 # Symfony environment
-set :symfony_env,     "prod"
+set :symfony_env,       "prod"
 
 # Symfony default ORM
 set(:symfony_orm)     { guess_symfony_orm }
@@ -21,9 +24,9 @@ set(:symfony_orm)     { guess_symfony_orm }
 # Symfony lib path
 set(:symfony_lib)     { guess_symfony_lib }
 
-def prompt_with_default(var, default)
+def prompt_with_default(var, default, &block)
   set(var) do
-    Capistrano::CLI.ui.ask "#{var} [#{default}] : "
+    Capistrano::CLI.ui.ask("#{var} [#{default}] : ", &block)
   end
   set var, default if eval("#{var.to_s}.empty?")
 end
@@ -31,8 +34,8 @@ end
 def guess_symfony_orm
   databases = YAML::load(IO.read('config/databases.yml'))
 
-  if databases['dev']
-    databases['dev'].keys[0].to_s
+  if databases[symfony_env_local]
+    databases[symfony_env_local].keys[0].to_s
   else
     databases['all'].keys[0].to_s
   end
@@ -151,11 +154,21 @@ namespace :symfony do
   namespace :configure do
     desc "Configure database DSN"
     task :database do
-      prompt_with_default(:dsn,   "mysql:host=localhost;dbname=example_dev")
-      prompt_with_default(:user,  "root")
-      prompt_with_default(:pass,  "")
+      prompt_with_default(:dsn,         "mysql:host=localhost;dbname=#{application}")
+      prompt_with_default(:db_username, "root")
+      db_password = Capistrano::CLI.password_prompt("db_password : ")
+
+      # surpress debug log output to hide the password
+      current_logger_level = self.logger.level
+      if current_logger_level >= Capistrano::Logger::DEBUG
+        logger.debug %(executing "#{php_bin} #{latest_release}/symfony configure:database '#{dsn}' '#{db_username}' ***")
+        self.logger.level = Capistrano::Logger::INFO 
+      end
+
+      run "#{php_bin} #{latest_release}/symfony configure:database '#{dsn}' '#{db_username}' '#{db_password}'"
 
-      run "#{php_bin} #{latest_release}/symfony configure:database '#{dsn}' '#{user}' '#{pass}'"
+      # restore logger level
+      self.logger.level = current_logger_level
     end
   end
 
@@ -316,22 +329,30 @@ namespace :symfony do
 
     desc "Generate code & database based on your schema"
     task :build_all do
-      run "#{php_bin} #{latest_release}/symfony doctrine:build --all --no-confirmation --env=#{symfony_env}"
+      if Capistrano::CLI.ui.agree("Do you really want to rebuild #{symfony_env}'s database? (y/N)")
+        run "#{php_bin} #{latest_release}/symfony doctrine:build --all --no-confirmation --env=#{symfony_env}"
+      end
     end
 
     desc "Generate code & database based on your schema & load fixtures"
     task :build_all_and_load do
-      run "#{php_bin} #{latest_release}/symfony doctrine:build --all --and-load --no-confirmation --env=#{symfony_env}"
+      if Capistrano::CLI.ui.agree("Do you really want to rebuild #{symfony_env}'s database and load #{symfony_env}'s fixtures? (y/N)")
+        run "#{php_bin} #{latest_release}/symfony doctrine:build --all --and-load --no-confirmation --env=#{symfony_env}"
+      end
     end
 
     desc "Generate sql & database based on your schema"
     task :build_db do
-      run "#{php_bin} #{latest_release}/symfony doctrine:build --sql --db --no-confirmation --env=#{symfony_env}"
+      if Capistrano::CLI.ui.agree("Do you really want to rebuild #{symfony_env}'s database? (y/N)")
+        run "#{php_bin} #{latest_release}/symfony doctrine:build --sql --db --no-confirmation --env=#{symfony_env}"
+      end
     end
 
     desc "Generate sql & database based on your schema & load fixtures"
     task :build_db_and_load do
-      run "#{php_bin} #{latest_release}/symfony doctrine:build --sql --db --and-load --no-confirmation --env=#{symfony_env}"
+      if Capistrano::CLI.ui.agree("Do you really want to rebuild #{symfony_env}'s database and load #{symfony_env}'s fixtures? (y/N)")
+        run "#{php_bin} #{latest_release}/symfony doctrine:build --sql --db --and-load --no-confirmation --env=#{symfony_env}"
+      end
     end
   end
 
@@ -339,13 +360,15 @@ namespace :symfony do
     desc "Ensure Propel is correctly configured"
     task :setup do
       conf_files_exists = capture("if test -s #{shared_path}/config/propel.ini -a -s #{shared_path}/config/databases.yml ; then echo 'exists' ; fi").strip
+
+      # share childs again (for propel.ini file)
+      shared_files << "config/propel.ini"
+      deploy.share_childs
+
       if (!conf_files_exists.eql?("exists"))
         run "cp #{symfony_lib}/plugins/sfPropelPlugin/config/skeleton/config/propel.ini #{shared_path}/config/propel.ini"
         symfony.configure.database
       end
-      # share childs again (for propel.ini file)
-      shared_files << "config/propel.ini"
-      deploy.share_childs
     end
 
     desc "Migrates database to current version"
@@ -360,22 +383,30 @@ namespace :symfony do
 
     desc "Generate code & database based on your schema"
     task :build_all do
-      run "#{php_bin} #{latest_release}/symfony propel:build --sql --db --no-confirmation --env=#{symfony_env}"
+      if Capistrano::CLI.ui.agree("Do you really want to rebuild #{symfony_env}'s database? (y/N)")
+        run "#{php_bin} #{latest_release}/symfony propel:build --sql --db --no-confirmation --env=#{symfony_env}"
+      end
     end
 
     desc "Generate code & database based on your schema & load fixtures"
     task :build_all_and_load do
-      run "#{php_bin} #{latest_release}/symfony propel:build --sql --db --and-load --no-confirmation --env=#{symfony_env}"
+      if Capistrano::CLI.ui.agree("Do you really want to rebuild #{symfony_env}'s database and load #{symfony_env}'s fixtures? (y/N)")
+        run "#{php_bin} #{latest_release}/symfony propel:build --sql --db --and-load --no-confirmation --env=#{symfony_env}"
+      end
     end
 
     desc "Generate sql & database based on your schema"
     task :build_db do
-      run "#{php_bin} #{latest_release}/symfony propel:build --sql --db --no-confirmation --env=#{symfony_env}"
+      if Capistrano::CLI.ui.agree("Do you really want to rebuild #{symfony_env}'s database? (y/N)")
+        run "#{php_bin} #{latest_release}/symfony propel:build --sql --db --no-confirmation --env=#{symfony_env}"
+      end
     end
 
     desc "Generate sql & database based on your schema & load fixtures"
     task :build_db_and_load do
-      run "#{php_bin} #{latest_release}/symfony propel:build --sql --db --and-load --no-confirmation --env=#{symfony_env}"
+      if Capistrano::CLI.ui.agree("Do you really want to rebuild #{symfony_env}'s database and load #{symfony_env}'s fixtures? (y/N)")
+        run "#{php_bin} #{latest_release}/symfony propel:build --sql --db --and-load --no-confirmation --env=#{symfony_env}"
+      end
     end
   end
 end
@@ -414,7 +445,7 @@ namespace :database do
     task :local do
       filename  = "#{application}.local_dump.#{Time.now.to_i}.sql.bz2"
       file      = "backups/#{filename}"
-      config    = load_database_config IO.read('config/databases.yml'), 'dev'
+      config    = load_database_config IO.read('config/databases.yml'), symfony_env_local
       sqlfile   = "#{application}_dump.sql"
 
       `mkdir -p backups`
@@ -433,7 +464,7 @@ namespace :database do
     desc "Dump remote database, download it to local & populate here"
     task :to_local do
       filename  = "#{application}.remote_dump.latest.sql.bz2"
-      config    = load_database_config IO.read('config/databases.yml'), 'dev'
+      config    = load_database_config IO.read('config/databases.yml'), symfony_env_local
       sqlfile   = "#{application}_dump.sql"
 
       database.dump.remote
@@ -519,10 +550,14 @@ namespace :shared do
   end
 end
 
-after "deploy:finalize_update", # After finalizing update:
-  "symfony:orm:setup",                # 0. Ensure that ORM is configured
-  "symfony:orm:build_classes",        # 1. (Re)build the model
-  "symfony:cc",                       # 2. Clear cache
-  "symfony:plugin:publish_assets",    # 3. Publish plugin assets
-  "symfony:project:permissions",      # 4. Fix project permissions
-  "symfony:project:clear_controllers" # 5. Clear controllers
+# After finalizing update:
+after "deploy:finalize_update" do
+  symfony.orm.setup                       # 0. Ensure that ORM is configured
+  symfony.orm.build_classes               # 1. (Re)build the model
+  symfony.cc                              # 2. Clear cache
+  symfony.plugin.publish_assets           # 3. Publish plugin assets
+  symfony.project.permissions             # 4. Fix project permissions
+  if symfony_env.eql?("prod")
+    symfony.project.clear_controllers     # 5. Clear controllers in production environment
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: capifony
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 13
   prerelease: false
   segments: 
   - 0
   - 4
-  - 0
-  version: 0.4.0
+  - 1
+  version: 0.4.1
 platform: ruby
 authors: 
 - Konstantin Kudryashov
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-16 00:00:00 +03:00
+date: 2010-06-17 00:00:00 +03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency