mina-cakephp 1.0.0 → 1.0.1

data/.gitignore

@@ -48,3 +48,5 @@ pkg
 
 # For rubinius:
 #*.rbc
+
+*.gem

data/README.md

@@ -1,24 +1,45 @@
 # mina-cakephp
 
-mina-cakephp add supports to deploy CakePHP Applications using [Mina](http://nadarei.co/mina).
+mina-cakephp is a gem that adds many tasks to aid in the deployment of [CakePHP] (http://www.cakephp.org) applications
+using [Mina] (http://nadarei.co/mina).
 
-## How to use
+# Getting Start
 
-Create one file at root directory of app named Minafile. Sample:
+## Instalation
+	
+	gem install mina-cakephp
+
+## Configuration
+
+After installation, create a file in the root directory of your project called `Minafile`.
+
+Note: Mina uses the command `mina init` to create a config file at `config/deploy.rb`, but CakePHP use the `Config` directory to hold configurations.
+To avoid problems we recommend using `Minafile` instead of `config/deploy.rb`
+
+`Minafile` sample:
 
 	require 'mina/git'
+	# Load tasks of mina-cakephp
 	require 'mina-cakephp'
 
+	# Mina default configuration
+	# more info at http://nadarei.co/mina
 	set :domain, 'server.to.deploy.com' 
 	set :deploy_to, '/var/www/my-app'
 	set :repository, 'git@mysever:my-app.git'
 	set :user, 'root'
 
-	set :shared_paths, ['Config/database.php', 'tmp'] #CakePHP shared paths used at apps.
-
-	#CakePHP Config
-	set :cake_path, '/var/www/libs/cakephp' #CakePHP core path
-	set :cake_database, { #Connection configuration
+	# Shared file or folder between deploys
+	# more at http://nadarei.co/mina/tasks/deploy_link_shared_paths.html
+	set :shared_paths, ['Config/database.php', 'tmp']
+
+	## mina-cakephp Settings
+	# Defines the  CakePHP core path. 
+	# This path is used to execute bake commands and update webroot/index.php if needed.
+	set :cake_path, '/var/www/libs/cakephp'
+	# Database connection settings.
+	# This will be used to create Config/database.php
+	set :cake_database, {
 		'datasource' => 'Database/Mysql',
 		'persistent' => false,
 		'host' => 'localhost',
@@ -28,44 +49,62 @@ Create one file at root directory of app named Minafile. Sample:
 		'prefix' => ''
 	}
 
-	#Steps to deploy app
-
+	## Deploy Task
 	task :deploy do
 	  deploy do
-	    invoke :'git:clone' #Clone project from :respository
-	    invoke :'deploy:link_shared_paths' #Create symlinks of :shared_paths
+	  	# Clone project, more at http://nadarei.co/mina/tasks/git_clone.html
+	    invoke :'git:clone'
+	    # Create symlinks
+	    # more at http://nadarei.co/mina/tasks/deploy_link_shared_paths.html
+	    invoke :'deploy:link_shared_paths'
 	    
-	    invoke :'cakephp:cake_core_path' #Set CakePHP Core path at webroot/index.php
-	    invoke :'cakephp:debug_zero' #Set debug 0 at Config/core.php
-	    invoke :'cakephp:tmp:clean_cache' #Clear tmp files
-
-	    invoke :'cakephp:asset_compress:setup' #Create folder to receive assets
-	    invoke :'cakephp:asset_compress:build' #Run Schema build command line
+	    # If you do not have CakePHP in your include_path, you will need to set CakePHP core path at webroot/index.php.
+	    # This task will do it for you.
+	    invoke :'cakephp:cake_core_path'
+	    # This task changes the debug level to 0 at Config/core.php
+	    invoke :'cakephp:debug_disable'
+	    # This task will delete all temporary files at tmp/
+	    invoke :'cakephp:tmp:clean_cache'
+
+	    # This task will create a folder and set correct permissions 
+	    # to receive build files of AssetCompress plugin (https://github.com/markstory/asset_compress)
+	    invoke :'cakephp:asset_compress:setup'
+	    # Build asset files
+	    invoke :'cakephp:asset_compress:build'
 
 	    to :launch do
-	      invoke :'cakephp:migrations:run_all' #Run migrations before launch app
+	    	# If you are using the Migrations plugin of CakeDC
+	    	# you need to invoke this task to run all migrations before launching the application.
+	    	invoke :'cakephp:migrations:run_all'
 	    end
 	  end
 	end
 
-	desc "Custom setup commands"
+	# Taks to prepare the environment
 	task :setup do
-	    #Clone CakePHP Core into cake_path, you can omit this if you dont need to clone cakephp when 
-	    #run mina setup
-	    #invoke :'cakephp:git:clone'
+	    # Invoke this task if you need to clone CakePHP core when setting up the enviroment.
+	    invoke :'cakephp:git:clone'
 	end
 
-Then run:
-	
+## Setup Environment
+
 	mina setup
 
-It will prepare server to receive first deploy.
+More at http://nadarei.co/mina/directory_structure.html
 
-To deploy your app just run:
+## Deploying
 
 	mina deploy
 
-Done.
+More at http://nadarei.co/mina/deploying.html
+
+## More tasks
+
+Run
+
+	mina -T
+
+To list all tasks.
 
 ## Contributing to mina-cakephp
  

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.0.1

data/lib/mina-cakephp/cakephp.rb

@@ -20,7 +20,7 @@ namespace :cakephp do
   end
 
   desc "Configure CakePHP debug to 0."
-  task :debug_zero do
+  task :debug_disable do
     regex = "((\\/\\/)?\\s*Configure::write\\('debug',(.*)\\);)"
     queue %{
       echo "-----> Setting up CakePHP debug to 0" && (
@@ -56,8 +56,8 @@ namespace :cakephp do
 
   queue %{
     echo "-----> Creating CakePHP database config file." && (
-      #{echo_cmd %{mkdir -p #{shared_path}/Config}} &&
-      #{echo_cmd %{echo "#{content}" > #{shared_path}/Config/database.php}} &&
+      #{echo_cmd %{mkdir -p #{deploy_to}/#{shared_path}/Config}} &&
+      #{echo_cmd %{echo "#{content}" > #{deploy_to}/#{shared_path}/Config/database.php}} &&
       echo "-----> Done."
     ) || (
       echo "ERROR: Problem to create database config file."

data/lib/mina-cakephp/cakephp/tmp.rb

@@ -6,7 +6,7 @@ namespace :cakephp do
     desc "Setup CakePHP tmp directories."
     task :create do
       cmds = cake_tmp_dirs.map do |d|
-        echo_cmd %{mkdir -p #{shared_path}/tmp/#{d}}
+        echo_cmd %{mkdir -p #{deploy_to}/#{shared_path}/tmp/#{d}}
       end
 
       queue %{

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mina-cakephp
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-21 00:00:00.000000000 Z
+date: 2013-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mina
-  requirement: &22831000 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,12 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *22831000
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Tools to deploy CakePHP apps with mina.
 email:
 - contato@danielpk.com.br
@@ -62,9 +67,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Tools to deploy CakePHP apps with mina.
 test_files: []
-has_rdoc: