capcake 0.0.4 → 2.0.1

data/README.markdown

@@ -1,4 +1,4 @@
-# capcake
+# capcake ![Project status](http://stillmaintained.com/jadb/capcake.png)
 
 Looking to deploy a [CakePHP](http://cakephp.org) application you've built? Capcake extends [Capistrano](http://capify.org), removing the *rails-ism*, replacing them by more *cake-ish* ones.
 
@@ -51,9 +51,7 @@ We need to tell it where to deploy, using what methods:
 
 And finally, some CakePHP related settings (if omitted, Capcake will NOT handle deploying CakePHP):
 
-	set :cake_branch, "1.3.0-alpha"
-
-For this to work, *deployer*'s SSH keys must be added to the [Chaw](http://thechaw.com/users/account).
+	set :cake_branch, " "
 
 You can change the default values for the following variables also:
 
@@ -62,6 +60,20 @@ You can change the default values for the following variables also:
 	set :user, "your_username"
 	set :branch, "tag"
 
+Append the following lines to your .git/info/exclude file:
+
+	.DS_Store
+	tmp/*
+
+## Alternative Easy Configuration
+
+Simply replace your deploy.rb configuration file with the one provided in the template directory, and change all variables on the lines that have comments with your values.
+
+This configuration file is meant to work with [Multiple Stages Without Multistage Extension](https://github.com/capistrano/capistrano/wiki/2.x-Multiple-Stages-Without-Multistage-Extension) so every cap command will have to contain the stage you want to deploy to. For instance:
+
+	$ cap staging deploy:setup
+	$ cap staging deploy
+
 ## Deployment
 
 The first time you are deploying, you need to run:
@@ -94,6 +106,21 @@ Which will change the directory structure to become:
 	[deploy_to]/shared/system
 	[deploy_to]/shared/tmp
 
+## Credits
+
+* Jamis Buck ([Capistrano's](https://github.com/capistrano) original author)
+* [Jad Bitar](http://github.com/jadb) (capcake code)
+* [damusnet](https://github.com/damusnet) (capcake code)
+* [Michael Franze](http://github.com/franzem) (capcake wiki)
+
+## Patches & Features
+
+* Fork
+* Mod, fix
+* Test - this is important, so it's not unintentionally broken
+* Commit - do not mess with license, todo, version, etc. (if you do change any, make them into commits of their own that I can ignore when I pull)
+* Pull request - bonus point for topic branches
+
 ## Bugs & Feedback
 
-http://github.com/jadb/capcake/issues
+http://github.com/jadb/capcake/issues

data/lib/capcake.rb

@@ -28,32 +28,36 @@ Capistrano::Configuration.instance(:must_exist).load do
   # changes if you do decide to muck with these!
   # =========================================================================
 
+  set :cake2,                 true
   set :scm,                   :git
   set :git_enable_submodules, 1
-  set :revision,              source.head
   set :deploy_via,            :checkout
-  set :shared_children,       %w(config system tmp)
 
   set :git_flag_quiet,        ""
 
   _cset(:cake_branch)         { "" }
-  _cset(:cake_repo)           { "http://github.com/cakephp/cakephp1x.git" }
+  _cset(:cake_repo)	          { "git://github.com/cakephp/cakephp.git" }
   _cset :tmp_children,        %w(cache logs sessions tests)
   _cset :cache_children,      %w(models persistent views)
   _cset :logs_files,          %w(debug error)
 
   def capcake()
-    set :deploy_to, "/var/www/#{application}" if (deploy_to.empty?)
+    set :deploy_to,           "/var/www/#{application}" if (deploy_to.empty?)
     set(:current_path)        { File.join(deploy_to, current_dir) }
-    set(:database_path)       { File.join(File.join(shared_path, "config"), "database.php") }
+    if cake2
+      set :shared_children,       %w(Config System tmp)
+      set :database_partial_path, "Config/database.php"
+    else
+      set :shared_children,       %w(config system tmp)
+      set :database_partial_path, "config/database.php"
+    end
+    set(:database_path)       { File.join(shared_path, database_partial_path) }
     set(:shared_path)         { File.join(deploy_to, shared_dir) }
     _cset(:cake_path)         { shared_path }
     _cset(:tmp_path)          { File.join(shared_path, "tmp") }
     _cset(:cache_path)        { File.join(tmp_path, "cache") }
     _cset(:logs_path)         { File.join(tmp_path, "logs") }
 
-    after("deploy:setup", "cake:database:config") if (!remote_file_exists?(database_path))
-    after("deploy:symlink", "cake:database:symlink") if (remote_file_exists?(database_path))
   end
 
   def defaults(val, default)
@@ -73,9 +77,9 @@ Capistrano::Configuration.instance(:must_exist).load do
 
   namespace :deploy do
     desc <<-DESC
-      Deploys your project. This calls `update'. Note that \
+      Deploys your project. This calls `update`. Note that \
       this will generally only work for applications that have already been deployed \
-      once. For a "cold" deploy, you'll want to take a look at the `deploy:cold' \
+      once. For a "cold" deploy, you'll want to take a look at the `deploy:cold` \
       task, which handles the cold start specifically.
     DESC
     task :default do
@@ -84,7 +88,7 @@ Capistrano::Configuration.instance(:must_exist).load do
     desc <<-DESC
       Prepares one or more servers for deployment. Before you can use any \
       of the Capistrano deployment tasks with your project, you will need to \
-      make sure all of your servers have been prepared with `cap deploy:setup'. When \
+      make sure all of your servers have been prepared with `cap deploy:setup`. When \
       you add a new server to your cluster, you can easily run the setup task \
       on just that server by specifying the HOSTS environment variable:
 
@@ -101,20 +105,22 @@ Capistrano::Configuration.instance(:must_exist).load do
       run "#{try_sudo} mkdir -p #{(dirs + tmp_dirs).join(' ')} && #{try_sudo} chmod -R 777 #{tmp_path}" if (!user.empty?)
       set :git_flag_quiet, "-q "
       cake.setup if (!cake_branch.empty?)
+      cake.database.config if (!remote_file_exists?(database_path))
     end
 
     desc <<-DESC
       Copies your project and updates the symlink. It does this in a \
-      transaction, so that if either `update_code' or `symlink' fail, all \
+      transaction, so that if either `update_code` or `symlink` fail, all \
       changes made to the remote servers will be rolled back, leaving your \
-      system in the same state it was in before `update' was invoked. Usually, \
-      you will want to call `deploy' instead of `update', but `update' can be \
+      system in the same state it was in before `update` was invoked. Usually, \
+      you will want to call `deploy` instead of `update`, but `update` can be \
       handy if you want to deploy, but not immediately restart your application.
     DESC
     task :update do
       transaction do
         update_code
         symlink
+	cake.cache.clear
       end
     end
 
@@ -122,8 +128,8 @@ Capistrano::Configuration.instance(:must_exist).load do
       Copies your project to the remote servers. This is the first stage \
       of any deployment; moving your updated code and assets to the deployment \
       servers. You will rarely call this task directly, however; instead, you \
-      should call the `deploy' task (to do a complete deploy) or the `update' \
-      task (if you want to perform the `restart' task separately).
+      should call the `deploy` task (to do a complete deploy) or the `update` \
+      task (if you want to perform the `restart` task separately).
 
       You will need to make sure you set the :scm variable to the source \
       control software you are using (it defaults to :subversion), and the \
@@ -137,19 +143,8 @@ Capistrano::Configuration.instance(:must_exist).load do
     end
 
     desc <<-DESC
-      [internal] Touches up the released code. This is called by update_code \
-      after the basic deploy finishes. It assumes a Rails project was deployed, \
-      so if you are deploying something else, you may want to override this \
-      task with your own environment's requirements.
-
-      This task will make the release group-writable (if the :group_writable \
-      variable is set to true, which is the default). It will then set up \
-      symlinks to the shared directory for the log, system, and tmp/pids \
-      directories, and will lastly touch all assets in public/images, \
-      public/stylesheets, and public/javascripts so that the times are \
-      consistent (so that asset timestamping works).  This touch process \
-      is only carried out if the :normalize_asset_timestamps variable is \
-      set to true, which is the default.
+      [internal] This task will make the release group-writable (if the :group_writable \
+      variable is set to true, which is the default). 
     DESC
     task :finalize_update, :except => { :no_release => true } do
       run "chmod -R g+w #{latest_release}" if fetch(:group_writable, true)
@@ -158,12 +153,12 @@ Capistrano::Configuration.instance(:must_exist).load do
     desc <<-DESC
       Updates the symlinks to the most recently deployed version. Capistrano works \
       by putting each new release of your application in its own directory. When \
-      you deploy a new version, this task's job is to update the `current', \
-      `current/tmp', `current/webroot/system' symlinks to point at the new version. \
+      you deploy a new version, this task's job is to update the `current`, \
+      `current/tmp`, `current/webroot/system` symlinks to point at the new version. \
       
-      You will rarely need to call this task directly; instead, use the `deploy' \
-      task (which performs a complete deploy, including `restart') or the 'update' \
-      task (which does everything except `restart').
+      You will rarely need to call this task directly; instead, use the `deploy` \
+      task (which performs a complete deploy, including `restart`) or the 'update` \
+      task (which does everything except `restart`).
     DESC
     task :symlink, :except => { :no_release => true } do
       on_rollback do
@@ -175,6 +170,7 @@ Capistrano::Configuration.instance(:must_exist).load do
       end
       run "ln -s #{shared_path}/system #{latest_release}/webroot/system && ln -s #{shared_path}/tmp #{latest_release}/tmp";
       run "rm -f #{current_path} && ln -s #{latest_release} #{current_path}"
+      cake.database.symlink if (remote_file_exists?(database_path))
     end
 
     desc <<-DESC
@@ -226,7 +222,7 @@ Capistrano::Configuration.instance(:must_exist).load do
       end
 
       desc <<-DESC
-        Rolls back to the previously deployed version. The `current' symlink will \
+        Rolls back to the previously deployed version. The `current` symlink will \
         be updated to point at the previously deployed version, and then the \
         current release will be removed from the servers.
       DESC
@@ -237,7 +233,7 @@ Capistrano::Configuration.instance(:must_exist).load do
 
       desc <<-DESC
         Rolls back to a previous version and restarts. This is handy if you ever \
-        discover that you've deployed a lemon; `cap rollback' and you're right \
+        discover that you've deployed a lemon; `cap rollback` and you're right \
         back where you were, on the previously deployed version.
       DESC
       task :default do
@@ -271,7 +267,7 @@ Capistrano::Configuration.instance(:must_exist).load do
       Test deployment dependencies. Checks things like directory permissions, \
       necessary utilities, and so forth, reporting on the things that appear to \
       be incorrect or missing. This is good for making sure a deploy has a \
-      chance of working before you actually run `cap deploy'.
+      chance of working before you actually run `cap deploy`.
 
       You can define your own dependencies, as well, using the `depend' method:
 
@@ -307,7 +303,7 @@ Capistrano::Configuration.instance(:must_exist).load do
     end
 
     desc <<-DESC
-      Deploys and starts a `cold' application. This is useful if you have never \
+      Deploys and starts a `cold` application. This is useful if you have never \
       deployed your application before. It currently runs `deploy:setup` followed \
       by `deploy:update`. \
       (This is still an experimental feature, and is subject to change without \
@@ -320,7 +316,7 @@ Capistrano::Configuration.instance(:must_exist).load do
 
     namespace :pending do
       desc <<-DESC
-        Displays the `diff' since your last deploy. This is useful if you want \
+        Displays the `diff` since your last deploy. This is useful if you want \
         to examine what changes are about to be deployed. Note that this might \
         not be supported on all SCM's.
       DESC
@@ -416,7 +412,7 @@ Capistrano::Configuration.instance(:must_exist).load do
       Prepares server for deployment of a CakePHP application. \
 
       By default, it will create a shallow clone of the CakePHP repository \
-      inside #{shared_path}/cakephp and run deploy:cake:update.
+      inside #{shared_path}/cakephp and run `deploy:cake:update`.
 
       For more info about shallow clones: \
       http://www.kernel.org/pub/software/scm/git/docs/git-clone.html \
@@ -444,6 +440,17 @@ Capistrano::Configuration.instance(:must_exist).load do
     task :update do
       set :cake_branch, ENV['BRANCH'] if ENV.has_key?('BRANCH')
       stream "cd #{cake_path}/cakephp && git checkout #{git_flag_quiet}#{cake_branch}"
+      if cake2
+        run "#{try_sudo} ln -s #{shared_path}/cakephp/lib/Cake #{deploy_to}/#{version_dir}/Cake"
+      else
+        run "#{try_sudo} ln -s #{shared_path}/cakephp/cake #{deploy_to}/#{version_dir}/cake"
+      end
+      run "#{try_sudo} mkdir -m 777 -p #{shared_path}/cakephp/media/transfer/img"
+      run "#{try_sudo} mkdir -m 777 -p #{shared_path}/cakephp/media/static/img"
+      run "#{try_sudo} mkdir -m 777 -p #{shared_path}/cakephp/media/filter"
+      run "#{try_sudo} ln -s #{shared_path}/cakephp/media #{deploy_to}/#{version_dir}/media"
+      run "#{try_sudo} ln -s #{shared_path}/cakephp/plugins #{deploy_to}/#{version_dir}/plugins"
+      run "#{try_sudo} ln -s #{shared_path}/cakephp/vendors #{deploy_to}/#{version_dir}/vendors"
     end
 
     namespace :cache do
@@ -454,8 +461,8 @@ Capistrano::Configuration.instance(:must_exist).load do
         is renamed/removed after it was found but before it removes it, no error \
         will prompt (-ignore_readdir_race). If symlinks are found, they will not be followed
 
-        You will rarely need to call this task directly; instead, use the `deploy' \
-        task (which performs a complete deploy, including `cake:cache:clear')
+        You will rarely need to call this task directly; instead, use the `deploy` \
+        task (which performs a complete deploy, including `cake:cache:clear`)
       DESC
       task :clear, :roles => :web, :except => { :no_release => true } do
         run "#{try_sudo} find -P #{cache_path} -ignore_readdir_race -type f -name '*' -exec rm -f {} \\;"
@@ -524,7 +531,7 @@ Capistrano::Configuration.instance(:must_exist).load do
         #{deploy_to}/shared/config/database.php
       DESC
       task :symlink, :roles => :web, :except => { :no_release => true } do
-        run "#{try_sudo} ln -s #{database_path} #{current_path}/config/database.php"
+        run "#{try_sudo} rm -f #{current_path}/#{database_partial_path} && #{try_sudo} ln -s #{database_path} #{current_path}/#{database_partial_path}"
       end
     end
 

data/lib/templates/deploy.rb.default

@@ -0,0 +1,43 @@
+require 'rubygems'
+require 'capcake'
+
+set :application, "your_app_name"				# Your application name
+
+set :scm, :git
+set :repository,  "git@domain.com:path/to/repo"			# Your repository url
+set :scm_username, "username"					# Your username to log into your repository
+set :scm_passphrase, Capistrano::CLI.password_prompt("Type your ssh passphrase for user #{scm_username}: ")
+set :branch, "master"
+set :use_sudo, false
+
+set :deploy_via, :remote_cache
+set(:group_writable, false)
+
+###
+# Staging
+###
+
+task :staging do
+  set :deploy_to, "/var/www/application/staging" 		# Your staging root path
+  set :user, "user"						# Your staging user
+  set :group, "www-data"					# Your staging group
+  server "staging.example.com", :web				# Your staging server url
+end
+
+###
+# Production
+###
+
+task :production do
+  set :deploy_to, "/var/www/application/production"		# Your production root path
+  set :user, "user"						# Your production user
+  set :group, "www-data"					# Your production group
+  server "example.com", :web					# Your production server url
+end
+
+ssh_options[:forward_agent] = true
+
+set :cake_branch, " "
+
+capcake
+

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: capcake
 version: !ruby/object:Gem::Version 
-  version: 0.0.4
+  prerelease: false
+  segments: 
+  - 2
+  - 0
+  - 1
+  version: 2.0.1
 platform: ruby
 authors: 
 - Jad Bitar
@@ -9,19 +14,22 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-17 00:00:00 -05:00
+date: 2012-01-28 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: capistrano
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 5
         version: "2.5"
-    version: 
+  type: :runtime
+  version_requirements: *id001
 description: Deploy CakePHP applications using Capistrano
 email: jadbitar@mac.com
 executables: []
@@ -32,10 +40,10 @@ extra_rdoc_files:
 - LICENSE
 - README.markdown
 files: 
-- lib/TODO
 - lib/capcake.rb
 - lib/templates/create_database.rsql
 - lib/templates/database.rphp
+- lib/templates/deploy.rb.default
 - lib/templates/maintenance.rhtml
 - LICENSE
 - README.markdown
@@ -44,26 +52,28 @@ homepage: http://github.com/jadb/capcake
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Deploy CakePHP applications using Capistrano

data/lib/TODO

@@ -1,7 +0,0 @@
-* create cake:logs:tail to find every file modified in the last N hours and then tail them all
-* update deploy:check to check if shared/system/database.php is created or not - force creation if :db is set
-* override deploy:migrate and deploy:migrations to use cake schema shell commands
-* test what's simpler for people in general:
-	- using multistage extension for Capistrano
-	- creating deploy:production, deploy:staging tasks to reset variables' values
-* refactor code so it looks more like Ruby stuff (ie: Capitate)