capifony 0.3.3 → 0.4.0

data/CHANGELOG

@@ -1,3 +1,10 @@
+== 0.4.0 / June 16, 2010
+
+* added propel tasks (thanks to http://github.com/arlo)
+* added orm abstraction
+* added doctrine/symfony tasks
+* huge refactoring of mostly everything (thanks to http://github.com/arlo)
+
 == 0.3.3 / June 13, 2010
 
 * added ability to change called php binary (thanks to http://github.com/xgorse)

data/README

@@ -136,3 +136,4 @@ 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)

data/bin/capifony

@@ -38,16 +38,16 @@ end
 files = {
   "Capfile" => unindent(<<-FILE),
     load 'deploy' if respond_to?(:namespace) # cap2 differentiator
-    Dir['vendor/plugins/*/recipes/*.rb'].each { |plugin| load(plugin) }
+    Dir['plugins/*/lib/recipes/*.rb'].each { |plugin| load(plugin) }
     load Gem.required_location('capifony', 'capifony.rb')
     load 'config/deploy' # remove this line to skip loading any of the default tasks
   FILE
 
   "config/deploy.rb" => 'set :application, "set your application name here"
 set :domain,      "#{application}.com"
-set :deploy_to,   "/path/to/www/#{domain}"
+set :deploy_to,   "/var/www/#{domain}"
 
-set :repository,  "#{domain}:/reps/#{application}.git"
+set :repository,  "#{domain}:/var/repos/#{application}.git"
 set :scm,         :git
 # Or: `accurev`, `bzr`, `cvs`, `darcs`, `subversion`, `mercurial`, `perforce`, `subversion` or `none`
 

data/lib/capifony.rb

@@ -2,9 +2,25 @@ require 'yaml'
 
 # Dirs that need to remain the same between deploys (shared dirs)
 set :shared_children, %w(log web/uploads)
+
+# Files that need to remain the same between deploys
+set :shared_files,    %w(config/databases.yml)
+
+# Asset folders (that need to be timestamped)
+set :asset_children,  %w(web/css web/images web/js)
+
 # PHP binary to execute
 set :php_bin,         "php"
 
+# Symfony environment
+set :symfony_env,     "prod"
+
+# Symfony default ORM
+set(:symfony_orm)     { guess_symfony_orm }
+
+# Symfony lib path
+set(:symfony_lib)     { guess_symfony_lib }
+
 def prompt_with_default(var, default)
   set(var) do
     Capistrano::CLI.ui.ask "#{var} [#{default}] : "
@@ -12,13 +28,29 @@ def prompt_with_default(var, default)
   set var, default if eval("#{var.to_s}.empty?")
 end
 
-def load_database_config(data, env = 'prod')
+def guess_symfony_orm
+  databases = YAML::load(IO.read('config/databases.yml'))
+
+  if databases['dev']
+    databases['dev'].keys[0].to_s
+  else
+    databases['all'].keys[0].to_s
+  end
+end
+
+def guess_symfony_lib
+  symfony_version = capture("#{php_bin} #{latest_release}/symfony -V")
+
+  /\((.*)\)/.match(symfony_version)[1]
+end
+
+def load_database_config(data, env)
   databases = YAML::load(data)
 
   if databases[env]
-    db_param = databases[env]['doctrine']['param']
+    db_param = databases[env][symfony_orm]['param']
   else
-    db_param = databases['all']['doctrine']['param']
+    db_param = databases['all'][symfony_orm]['param']
   end
 
   {
@@ -30,12 +62,8 @@ def load_database_config(data, env = 'prod')
 end
 
 namespace :deploy do
-  desc "Overwrite the start task to set the permissions on the project."
-  task :start do
-    symfony.configure.database
-    symfony.project.permissions
-    doctrine.build_all_and_load
-  end
+  desc "Overwrite the start task because symfony doesn't need it."
+  task :start do ; end
 
   desc "Overwrite the restart task because symfony doesn't need it."
   task :restart do ; end
@@ -45,32 +73,39 @@ namespace :deploy do
 
   desc "Customize migrate task because symfony doesn't need it."
   task :migrate do
-    doctrine.migrate
+    symfony.orm.migrate
   end
 
-  desc "Symlink static directories that need to remain between deployments."
-  task :create_dirs do
+  desc "Symlink static directories and static files that need to remain between deployments."
+  task :share_childs do
     if shared_children
       shared_children.each do |link|
-        run "if [ -d #{release_path}/#{link} ] ; then rm -rf #{release_path}/#{link}; fi"
         run "mkdir -p #{shared_path}/#{link}"
+        run "if [ -d #{release_path}/#{link} ] ; then rm -rf #{release_path}/#{link}; fi"
+        run "ln -nfs #{shared_path}/#{link} #{release_path}/#{link}"
+      end
+    end
+    if shared_files
+      shared_files.each do |link|
+        link_dir = File.dirname("#{shared_path}/#{link}")
+        run "mkdir -p #{link_dir}"
+        run "touch #{shared_path}/#{link}"
         run "ln -nfs #{shared_path}/#{link} #{release_path}/#{link}"
       end
     end
-
-    run "mkdir -p #{shared_path}/config"
-    run "touch #{shared_path}/config/databases.yml"
   end
 
   desc "Customize the finalize_update task to work with symfony."
   task :finalize_update, :except => { :no_release => true } do
     run "chmod -R g+w #{latest_release}" if fetch(:group_writable, true)
     run "mkdir -p #{latest_release}/cache"
-    create_dirs
+
+    # Share common files & folders
+    share_childs
 
     if fetch(:normalize_asset_timestamps, true)
       stamp = Time.now.utc.strftime("%Y%m%d%H%M.%S")
-      asset_paths = %w(css images js).map { |p| "#{latest_release}/web/#{p}" }.join(" ")
+      asset_paths = asset_children.map { |p| "#{latest_release}/#{p}" }.join(" ")
       run "find #{asset_paths} -exec touch -t #{stamp} {} ';'; true", :env => { "TZ" => "UTC" }
     end
   end
@@ -78,6 +113,7 @@ namespace :deploy do
   desc "Need to overwrite the deploy:cold task so it doesn't try to run the migrations."
   task :cold do
     update
+    symfony.orm.build_db_and_load
     start
   end
 
@@ -85,25 +121,25 @@ namespace :deploy do
   task :testall do
     update_code
     symlink
-    doctrine.build_all_and_load_test
+    symfony.orm.build_db_and_load
     symfony.tests.all
   end
 end
 
-namespace :symlink do
-  desc "Symlink the database"
-  task :db do
-    run "ln -nfs #{shared_path}/config/databases.yml #{latest_release}/config/databases.yml"
+namespace :symfony do
+  desc "Runs custom symfony task"
+  task :default do
+    prompt_with_default(:task_arguments, "cache:clear")
+
+    stream "#{php_bin} #{latest_release}/symfony #{task_arguments}"
   end
-end
 
-namespace :symfony do
   desc "Downloads & runs check_configuration.php on remote"
   task :check_configuration do
     prompt_with_default(:version, "1.4")
 
     run "wget  http://sf-to.org/#{version}/check.php -O /tmp/check_configuration.php"
-    run "#{php_bin} /tmp/check_configuration.php"
+    stream "#{php_bin} /tmp/check_configuration.php"
     run "rm /tmp/check_configuration.php"
   end
 
@@ -112,26 +148,28 @@ namespace :symfony do
     run "#{php_bin} #{latest_release}/symfony cache:clear"
   end
 
-  desc "Runs custom symfony task"
-  task :run_task do
-    prompt_with_default(:task_arguments, "cache:clear")
-
-    run "#{php_bin} #{latest_release}/symfony #{task_arguments}"
-  end
-
   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, "")
-      dbclass = "sfDoctrineDatabase"
+      prompt_with_default(:dsn,   "mysql:host=localhost;dbname=example_dev")
+      prompt_with_default(:user,  "root")
+      prompt_with_default(:pass,  "")
 
-      run "#{php_bin} #{latest_release}/symfony configure:database --class=#{dbclass} '#{dsn}' '#{user}' '#{pass}'"
+      run "#{php_bin} #{latest_release}/symfony configure:database '#{dsn}' '#{user}' '#{pass}'"
     end
   end
 
   namespace :project do
+    desc "Disables an application in a given environment"
+    task :disable do
+      run "#{php_bin} #{latest_release}/symfony project:disable #{symfony_env}"
+    end
+
+    desc "Enables an application in a given environment"
+    task :enable do
+      run "#{php_bin} #{latest_release}/symfony project:enable #{symfony_env}"
+    end
+
     desc "Fixes symfony directory permissions"
     task :permissions do
       run "#{php_bin} #{latest_release}/symfony project:permissions"
@@ -148,6 +186,14 @@ namespace :symfony do
     task :clear_controllers do
       run "#{php_bin} #{latest_release}/symfony project:clear-controllers"
     end
+
+    desc "Sends emails stored in a queue"
+    task :send_emails do
+      prompt_with_default(:message_limit, 10)
+      prompt_with_default(:time_limit,    10)
+
+      stream "#{php_bin} #{latest_release}/symfony project:send-emails --message-limit=#{message_limit} --time-limit=#{time_limit} --env=#{symfony_env}"
+    end
   end
 
   namespace :plugin do
@@ -166,39 +212,171 @@ namespace :symfony do
     desc "Rotates an application's log files"
     task :rotate do
       prompt_with_default(:application, "frontend")
-      prompt_with_default(:env, "prod")
 
-      run "#{php_bin} #{latest_release}/symfony log:rotate #{application} #{env}"
+      run "#{php_bin} #{latest_release}/symfony log:rotate #{application} #{symfony_env}"
     end
   end
 
   namespace :tests do
-    desc "Task to run all the tests for the application."
+    desc "Launches all tests"
     task :all do
       run "#{php_bin} #{latest_release}/symfony test:all"
     end
-  end
-end
 
-namespace :doctrine do
-  desc "Migrates database to current version"
-  task :migrate do
-    run "#{php_bin} #{latest_release}/symfony doctrine:migrate --env=prod"
+    desc "Launches functional tests"
+    task :functional do
+      prompt_with_default(:application, "frontend")
+
+      run "#{php_bin} #{latest_release}/symfony test:functional #{application}"
+    end
+
+    desc "Launches unit tests"
+    task :unit do
+      run "#{php_bin} #{latest_release}/symfony test:unit"
+    end
   end
 
-  desc "Generate code & database based on your schema"
-  task :build_all do
-    run "#{php_bin} #{latest_release}/symfony doctrine:build --all --no-confirmation --env=prod"
+  namespace :orm do
+    desc "Ensure symfony ORM is properly configured"
+    task :setup do
+      find_and_execute_task("symfony:#{symfony_orm}:setup")
+    end
+  
+    desc "Migrates database to current version"
+    task :migrate do
+      find_and_execute_task("symfony:#{symfony_orm}:migrate")
+    end
+
+    desc "Generate model lib form and filters classes based on your schema"
+    task :build_classes do
+      find_and_execute_task("symfony:#{symfony_orm}:build_classes")
+    end
+
+    desc "Generate code & database based on your schema"
+    task :build_all do
+      find_and_execute_task("symfony:#{symfony_orm}:build_all")
+    end
+
+    desc "Generate code & database based on your schema & load fixtures"
+    task :build_all_and_load do
+      find_and_execute_task("symfony:#{symfony_orm}:build_all_and_load")
+    end
+
+    desc "Generate sql & database based on your schema"
+    task :build_db do
+      find_and_execute_task("symfony:#{symfony_orm}:build_db")
+    end
+
+    desc "Generate sql & database based on your schema & load fixtures"
+    task :build_db_and_load do
+      find_and_execute_task("symfony:#{symfony_orm}:build_db_and_load")
+    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=prod"
+  namespace :doctrine do
+    desc "Ensure Doctrine is correctly configured"
+    task :setup do 
+      conf_files_exists = capture("if test -s #{shared_path}/config/databases.yml ; then echo 'exists' ; fi").strip
+      if (!conf_files_exists.eql?("exists"))
+        symfony.configure.database
+      end
+    end
+
+    desc "Execute a DQL query and view the results"
+    task :dql do
+      prompt_with_default(:query, "")
+
+      stream "#{php_bin} #{latest_release}/symfony doctrine:dql #{query} --env=#{symfony_env}"
+    end
+
+    desc "Dumps data to the fixtures directory"
+    task :data_dump do
+      run "#{php_bin} #{latest_release}/symfony doctrine:data-dump --env=#{symfony_env}"
+    end
+
+    desc "Loads YAML fixture data"
+    task :data_load do
+      run "#{php_bin} #{latest_release}/symfony doctrine:data-load --env=#{symfony_env}"
+    end
+
+    desc "Loads YAML fixture data without remove"
+    task :data_load_append do
+      run "#{php_bin} #{latest_release}/symfony doctrine:data-load --append --env=#{symfony_env}"
+    end
+
+    desc "Migrates database to current version"
+    task :migrate do
+      run "#{php_bin} #{latest_release}/symfony doctrine:migrate --env=#{symfony_env}"
+    end
+
+    desc "Generate model lib form and filters classes based on your schema"
+    task :build_classes do
+      run "#{php_bin} #{latest_release}/symfony doctrine:build --all-classes --env=#{symfony_env}"
+    end
+
+    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}"
+    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}"
+    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}"
+    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}"
+    end
   end
 
-  desc "Generate code & database based on your schema & load fixtures for test environment"
-  task :build_all_and_load_test do
-    run "#{php_bin} #{latest_release}/symfony doctrine:build --all --and-load --no-confirmation --env=test"
+  namespace :propel 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
+      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"
+    task :migrate do
+      puts "propel doesn't have built-in migration for now"
+    end
+
+    desc "Generate model lib form and filters classes based on your schema"
+    task :build_classes do
+      run "php #{latest_release}/symfony propel:build --all-classes --env=#{symfony_env}"
+    end
+
+    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}"
+    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}"
+    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}"
+    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}"
+    end
   end
 end
 
@@ -212,7 +390,7 @@ namespace :database do
       config    = ""
 
       run "cat #{shared_path}/config/databases.yml" do |ch, st, data|
-        config = load_database_config data, 'prod'
+        config = load_database_config data, symfony_env
       end
 
       case config['type']
@@ -283,7 +461,7 @@ namespace :database do
       run "bunzip2 -kc /tmp/#{filename} > /tmp/#{sqlfile}"
 
       run "cat #{shared_path}/config/databases.yml" do |ch, st, data|
-        config = load_database_config data, 'prod'
+        config = load_database_config data, symfony_env
       end
 
       case config['type']
@@ -342,7 +520,8 @@ namespace :shared do
 end
 
 after "deploy:finalize_update", # After finalizing update:
-  "symlink:db",                       # 1. Symlink database
+  "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

metadata

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