theme-juice 0.10.3 → 0.11.0

data/lib/theme-juice/man/tj-deploy.txt

@@ -6,11 +6,158 @@ NAME
        tj-deploy - Deploy a project
 
 SYNOPSIS
-       tj deploy [--flag=arg] [--flag]
+       tj deploy stage [command] [--flag=arg] [--flag]
 
 DESCRIPTION
-       Coming soon
+       Deploys a project to the passed stage. All commands are transformed and
+       then piped directly to capistrano(1) to handle deployment.
 
+SETUP
+       Follow these steps to quickly get up and running:
 
+       1.  Create a deploy user on the stage server
 
-				   June 2015			  TJ-DEPLOY(1)
+       2.  Create SSH keys for the new deploy user
+
+       3.  Create a deployment key for the stage server to clone your  reposi-
+	   tory
+
+       4.  Confirm the deploy user owns the deploy path
+
+       5.  Run	tj  deploy  <stage>  setup  to	setup  the  initial shared and
+	   releases directories
+
+       6.  Deploy!
+
+
+
+PRIMARY COMMANDS
+       If no command is passed, the default task to be executed is deploy
+
+       deploy Deploy a project
+
+       rollback
+	      Rollback a previous deployment
+
+       setup, check
+	      Run a preliminary deployment check, making sure that all	neces-
+	      sary folders are created and accessible on the passed stage
+
+SECONDARY COMMANDS
+       db:backup
+	      Back up the database on the passed stage and store it locally in
+	      the deployment.stages.vagrant.backup directory
+
+       db:pull
+	      Pull the database from the passed stage and import it  into  the
+	      development environment
+
+       db:push
+	      Push the database from the development environment and import it
+	      into the passed stage
+
+       env:pull
+	      Pull the current .env.<stage> file from the passed stage to  the
+	      development environment
+
+       env:push
+	      Push the current .env.<stage> file from the development environ-
+	      ment to the passed stage
+
+       uploads:pull
+	      Pull the current stage's uploads folder from the passed stage to
+	      the development environment
+
+       uploads:push
+	      Push  the uploads folder from the development environment to the
+	      passed stage's uploads folder
+
+CONFIG FILE
+       The YAML Juicefile(5)  configuration  may  be  used  to	store  deploy-
+       ment-related  settings. Below you will find the various block sequences
+       you may use to define your project's deployment settings. All of  these
+       will be passed to capistrano(1) to invoke a deployment.
+
+       deployment
+	      Deployment configuration
+
+       deployment.application
+	      Application settings passed directly to capistrano(1)
+
+       deployment.settings
+	      Deployment settings passed directly to capistrano(1)
+
+       deployment.repository
+	      Repository settings passed directly to capistrano(1)
+
+       deployment.rsync
+	      Optional	settings  passed  to  capistrano-rsync(1);  mapped  as
+	      rsync_<setting> during the deployment initialization
+
+       deployment.slack
+	      Optional settings passed to  capistrano-slackify(1);  mapped  as
+	      slack_<setting> during the deployment initialization
+
+       deployment.stages
+	      Deployment stages
+
+       deployment.stages.<stage>.server
+	      Domain or IP address of the server
+
+       deployment.stages.<stage>.path
+	      Root path to the deployment directory
+
+       deployment.stages.<stage>.user
+	      User account to deploy as (it is recommended not to use root)
+
+       deployment.stages.<stage>.url
+	      URL of the stage
+
+       deployment.stages.<stage>.uploads
+	      Relative path from deploy path to the uploads folder
+
+       deployment.stages.<stage>.tmp
+	      Relative path from deploy path to the tmp folder
+
+       deployment.stages.<stage>.shared
+	      Sequence of relative files from application root to place inside
+	      of the shared folder
+
+       deployment.stages.<stage>.roles
+	      Sequence of deployment roles for the stage
+
+       deployment.stages.vagrant
+	      Required development environment settings; these	are  used  for
+	      database and file migration
+
+       deployment.stages.vagrant.server
+	      Domain or IP address of the development environment
+
+       deployment.stages.vagrant.path
+	      Root path to the application directory within the VM
+
+       deployment.stages.vagrant.user
+	      User account to deploy as (usually vagrant)
+
+       deployment.stages.vagrant.pass
+	      Password for the user (usually vagrant)
+
+       deployment.stages.vagrant.url
+	      URL of the project
+
+       deployment.stages.vagrant.uploads
+	      Relative path from application root to the uploads folder
+
+       deployment.stages.vagrant.backup
+	      Relative path from application root to the backup folder
+
+       deployment.stages.vagrant.tmp
+	      Relative path from application root to the tmp folder
+
+       deployment.stages.vagrant.roles
+	      Sequence of roles for the development environment
+
+
+
+
+				   July 2015			  TJ-DEPLOY(1)

data/lib/theme-juice/man/tj-setup

@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "TJ\-SETUP" "1" "June 2015" "" "Theme Juice Manual"
+.TH "TJ\-SETUP" "1" "July 2015" "" "Theme Juice Manual"
 .
 .SH "NAME"
 \fBtj\-setup\fR \- Setup an existing project
@@ -28,7 +28,7 @@ Development URL for the project
 .
 .TP
 \fB\-r\fR, \fB\-\-repository\fR=\fIrepository\fR
-Initialize a new Git remote repository
+Initialize a new git(1) remote repository
 .
 .TP
 \fB\-i\fR, \fB\-\-import\-db\fR=\fIpath\fR
@@ -48,7 +48,7 @@ Skip all prompts and use default settings
 .
 .TP
 \fB\-\-no\-wp\fR
-Project is not a WordPress install
+Project is not a wordpress(7) install
 .
 .TP
 \fB\-\-no\-db\fR

data/lib/theme-juice/man/tj-setup.txt

@@ -24,7 +24,7 @@ GLOBAL OPTIONS
 	      Development URL for the project
 
        -r, --repository=repository
-	      Initialize a new Git remote repository
+	      Initialize a new git(1) remote repository
 
        -i, --import-db=path
 	      Import an existing database
@@ -39,7 +39,7 @@ GLOBAL OPTIONS
 	      Skip all prompts and use default settings
 
        --no-wp
-	      Project is not a WordPress install
+	      Project is not a wordpress(7) install
 
        --no-db
 	      Project does not need a database
@@ -47,4 +47,4 @@ GLOBAL OPTIONS
 
 
 
-				   June 2015			   TJ-SETUP(1)
+				   July 2015			   TJ-SETUP(1)

data/lib/theme-juice/man/tj.txt

@@ -9,16 +9,16 @@ SYNOPSIS
        tj [command] [--flag=arg] [--flag]
 
 DESCRIPTION
-       tj  is  a WordPress development command line utility that allows you to
-       scaffold out an	entire	Vagrant  development  environment  in  seconds
-       (using	 an    Apache	 fork	 of    VVV    https://github.com/Vary-
-       ing-Vagrant-Vagrants/VVV  called  VVV-Apache   https://github.com/eric-
-       mann/vvv-apache.git  as	the VM). It also helps you manage dependencies
-       and build tools, and can even handle your deployments.
+       Theme  Juice  (tj(1))  is  a  command line utility modern for WordPress
+       development. It allows you to scaffold  out  a  vagrant(1)  development
+       environment  in	seconds  (using  an  apache(7)	fork  of vvv(7) called
+       vvv-apache(7) as the VM), and generate/manage an  unlimited  number  of
+       development  projects.  It also helps you manage dependencies and build
+       tools, and can even handle your deployments.
 
 GLOBAL OPTIONS
        --vm-box=repository
-	      Force Vagrant box for use as VM
+	      Force vagrant(1) box for use as VM
 
        --vm-path=path
 	      Force path to VM
@@ -29,7 +29,8 @@ GLOBAL OPTIONS
        --vm-prefix=string
 	      Force directory prefix for project in VM
 
-       --yolo Say yes to anything and everything
+       --yolo Say yes to anything and everything, and maybe  even  get	a  few
+	      surprises
 
        --boring
 	      Prints all output without any fancy formatting
@@ -44,34 +45,34 @@ GLOBAL OPTIONS
 	      Prints all output without animations
 
        --no-landrush
-	      Disable the landrush gem for managing DNS
+	      Disable the landrush(1) gem for managing DNS
 
        --no-port-forward, --no-port-forwarding
 	      Disable automatic port forwarding
 
        --verbose
-	      Prints out additional logging information and raises any	excep-
+	      Prints  out additional logging information and raises any excep-
 	      tions caught during runtime
 
        --dryrun, --dry-run
 	      Run a command without actually doing anything
 
        --nginx, --no-apache
-	      Create conf files for nginx instead of apache
+	      Create conf files for nginx(7) instead of apache(7)
 
 PRIMARY COMMANDS
        Run tj help [command] to view an individual command's man page.
 
-       create, new, mk
+       create(1), new, mk
 	      Create a new project
 
-       setup, up, init
+       setup(1), up, init
 	      Setup an existing project
 
-       delete, rm, remove, trash
+       delete(1), rm, remove, trash
 	      Delete a project
 
-       deploy, server, remote
+       deploy(1), server, remote
 	      Deploy a project
 
 SECONDARY COMMANDS
@@ -82,12 +83,12 @@ SECONDARY COMMANDS
 	      List all projects
 
        vm, vagrant, vvv=[command[,command]...]
-	      Manage development environment via vagrant. Commands are proxied
-	      to your Vagrant installation so that they can be	run  from  any
-	      directory.
+	      Manage development  environment  via  vagrant(1).  Commands  are
+	      proxied  to  your  Vagrant  installation so that they can be run
+	      from any directory.
 
 CONFIG COMMANDS
-       These  run  the	corresponding command from your project's config file.
+       These run the corresponding command from your  project's  config  file.
        They accept any number of arguments, since the behavior and handling of
        input is defined within the config file itself.
 
@@ -107,7 +108,7 @@ CONFIG COMMANDS
 	      Package project for distribution
 
        wp, wordpress=[arg[,arg]...]
-	      Manage project's WordPress installation
+	      Manage project's wordpress(7) installation with wp-cli(1)
 
        backup, bk=[arg[,arg]...]
 	      Backup project
@@ -116,10 +117,10 @@ CONFIG COMMANDS
 	      Manage and run project tests
 
 CONFIG FILE
-       A  YAML	configuration  file  (Juicefile)  can  be  used  to store com-
-       monly-used build scripts. Each command block sequence can be mapped  to
-       an  individual project's build tool, allowing a streamlined set of com-
-       mands to be used across multiple projects that utilize different tools.
+       A YAML Juicefile(5) configuration can be used  to  store  commonly-used
+       build scripts. Each command block sequence can be mapped to an individ-
+       ual project's build tool, allowing a streamlined set of commands to  be
+       used across multiple projects that utilize different tools.
 
        commands
 	      Collection of various command block sequences
@@ -148,9 +149,6 @@ CONFIG FILE
        commands.test
 	      Command used to manage and run project tests
 
-       deployment
-	      Coming soon
-
        Placeholder  arguments can be used within any command block sequence to
        allow splat or indexed arguments to be passed to the corresponding com-
        mand when executed.
@@ -165,16 +163,16 @@ CONFIG FILE
        .tj.yaml naming convention. The raw filename regex matcher is below  if
        you want to be a little different.
 
-       /^(((\.)?(tj)|((J|j)uicefile))(.y(a)?ml)?$)/
+       /^(((\.)?(tj)|((J|j)uicefile))(\.y(a)?ml)?$)/
 
 ENVIRONMENT
        All of the global options have a corresponding ENV variable that can be
-       set to permanently use the specified value each time tj is run. This is
-       useful if you're using an alternate Vagrant box, or if you need to dis-
-       able certain features due to limited support e.g. on Windows.
+       set to permanently use the specified value each time tj(1) is run. This
+       is  useful  if you're using an alternate vagrant(1) box, or if you need
+       to disable certain features due to limited support e.g. on Windows.
 
        TJ_VM_BOX=repository
-	      Force Vagrant box for use as VM
+	      Force vagrant(1) box for use as VM
 
        TJ_PATH=path
 	      Force path to VM
@@ -186,7 +184,8 @@ ENVIRONMENT
 	      Force directory prefix for project in VM
 
        TJ_YOLO=bool
-	      Say yes to anything and everything
+	      Say yes to anything and everything, and maybe  even  get	a  few
+	      surprises
 
        TJ_BORING=bool
 	      Prints all output without any fancy formatting
@@ -201,21 +200,22 @@ ENVIRONMENT
 	      Prints all output without animations (coming soon)
 
        TJ_NO_LANDRUSH=bool
-	      Disable the landrush gem for managing DNS
+	      Disable the landrush(1) gem for managing DNS
 
        TJ_NO_PORT_FORWARD=bool
 	      Disable automatic port forwarding
 
        TJ_VERBOSE=bool
-	      Prints out additional logging information
+	      Prints  out additional logging information and raises any excep-
+	      tions caught during runtime
 
        TJ_DRYRUN=bool
 	      Run a command without actually doing anything
 
        TJ_NGINX=bool
-	      Create conf files for nginx instead of apache
+	      Create conf files for nginx(7) instead of apache(7)
 
 
 
 
-				   June 2015				 TJ(1)
+				   July 2015				 TJ(1)

data/lib/theme-juice/tasks/capistrano/db.rb

@@ -0,0 +1,81 @@
+# encoding: UTF-8
+
+namespace :db do
+
+  desc "Initialize database variables"
+  task :init do
+    set :timestamp, Time.now.strftime("%Y%m%d%H%M%S")
+    set :remote_db, "#{fetch(:timestamp)}.#{fetch(:stage)}.sql"
+    set :vm_db, "#{fetch(:timestamp)}.local.sql"
+  end
+
+  desc "Backup database on remote to local"
+  task :backup do
+    invoke "db:init"
+
+    on roles(:db) do
+
+      within release_path do
+        execute :wp, :db, :export, "#{fetch(:tmp_dir)}/#{fetch(:remote_db)}", "--add-drop-table"
+      end
+
+      run_locally do
+        execute :mkdir, "-p", fetch(:vm_backup_dir)
+      end
+
+      download! "#{fetch(:tmp_dir)}/#{fetch(:remote_db)}", "#{fetch(:vm_backup_dir)}/#{fetch(:remote_db)}"
+
+      within release_path do
+        execute :rm, "#{fetch(:tmp_dir)}/#{fetch(:remote_db)}"
+      end
+    end
+  end
+
+  desc "Push local database to remote"
+  task :push do
+    invoke "db:backup"
+
+    on roles(:dev) do
+      within fetch(:dev_path) do
+        execute :wp, :db, :export, "#{fetch(:vm_backup_dir)}/#{fetch(:vm_db)}"
+      end
+    end
+
+    on roles(:web) do
+      upload! "#{fetch(:vm_backup_dir)}/#{fetch(:vm_db)}", "#{fetch(:tmp_dir)}/#{fetch(:vm_db)}"
+
+      within release_path do
+        execute :wp, :db, :import, "#{fetch(:tmp_dir)}/#{fetch(:vm_db)}"
+        execute :rm, "#{fetch(:tmp_dir)}/#{fetch(:vm_db)}"
+        execute :wp, "search-replace", fetch(:vm_url), fetch(:stage_url), fetch(:wpcli_args) || "--skip-columns=guid"
+      end
+    end
+
+    on roles(:dev) do
+      within fetch(:dev_path) do
+        execute :rm, "#{fetch(:vm_backup_dir)}/#{fetch(:vm_db)}"
+      end
+    end
+  end
+
+  desc "Pull remote database to local"
+  task :pull do
+    invoke "db:backup"
+
+    on roles(:db) do
+      within release_path do
+        execute :wp, :db, :export, "#{fetch(:tmp_dir)}/#{fetch(:remote_db)}"
+        download! "#{fetch(:tmp_dir)}/#{fetch(:remote_db)}", "#{fetch(:vm_backup_dir)}/#{fetch(:remote_db)}"
+        execute :rm, "#{fetch(:tmp_dir)}/#{fetch(:remote_db)}"
+      end
+    end
+
+    on roles(:dev) do
+      within fetch(:dev_path) do
+        execute :wp, :db, :import, "#{fetch(:vm_backup_dir)}/#{fetch(:remote_db)}"
+        execute :rm, "#{fetch(:vm_backup_dir)}/#{fetch(:remote_db)}"
+        execute :wp, "search-replace", fetch(:stage_url), fetch(:vm_url), fetch(:wpcli_args) || "--skip-columns=guid"
+      end
+    end
+  end
+end