theme-juice 0.10.3 → 0.11.0

data/lib/theme-juice/env.rb

@@ -18,6 +18,8 @@ module ThemeJuice
     attr_accessor :verbose
     attr_accessor :dryrun
     attr_accessor :nginx
+    attr_accessor :stage
+    attr_accessor :cap
 
     def vm_box=(val)
       @vm_box = val ||= ENV.fetch("TJ_VM_BOX") { "git@github.com:ericmann/vvv-apache.git" }

data/lib/theme-juice/helpers/hash_helper.rb

@@ -0,0 +1,41 @@
+require "ostruct"
+
+module ThemeJuice
+  module HashHelper
+
+    def symbolize_keys
+      inject({}) do |acc, (k, v)|
+        key = String === k ? k.to_sym : k
+        value = Hash === v ? v.symbolize_keys : v
+        acc[key] = value
+        acc
+      end
+    end
+
+    # @TODO This is probably not a good idea...
+    def method_missing(method, *args, &block)
+      if to_ostruct.respond_to? method
+        to_ostruct.send method
+      else
+        super
+      end
+    end
+
+    def to_ostruct(acc = self, opts = {})
+      if opts[:recursive]
+        case acc
+        when Hash
+          OpenStruct.new Hash[acc.map { |k, v| [k, to_ostruct(v, opts)] }]
+        when Array
+          acc.map { |x| to_ostruct(x, opts) }
+        else
+          acc
+        end
+      else
+        OpenStruct.new acc
+      end
+    end
+  end
+end
+
+Hash.send :include, ThemeJuice::HashHelper

data/lib/theme-juice/man/tj

@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "TJ" "1" "June 2015" "" "Theme Juice Manual"
+.TH "TJ" "1" "July 2015" "" "Theme Juice Manual"
 .
 .SH "NAME"
 \fBtj\fR \- WordPress development made easy
@@ -10,13 +10,13 @@
 \fBtj\fR [\fIcommand\fR] [\-\-flag=\fIarg\fR] [\-\-flag]
 .
 .SH "DESCRIPTION"
-\fBtj\fR 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 \fIhttps://github\.com/Varying\-Vagrant\-Vagrants/VVV\fR called VVV\-Apache \fIhttps://github\.com/ericmann/vvv\-apache\.git\fR 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\.
 .
 .SH "GLOBAL OPTIONS"
 .
 .TP
 \fB\-\-vm\-box\fR=\fIrepository\fR
-Force Vagrant box for use as VM
+Force vagrant(1) box for use as VM
 .
 .TP
 \fB\-\-vm\-path\fR=\fIpath\fR
@@ -32,7 +32,7 @@ Force directory prefix for project in VM
 .
 .TP
 \fB\-\-yolo\fR
-Say yes to anything and everything
+Say yes to anything and everything, and maybe even get a few surprises
 .
 .TP
 \fB\-\-boring\fR
@@ -52,7 +52,7 @@ Prints all output without animations
 .
 .TP
 \fB\-\-no\-landrush\fR
-Disable the \fBlandrush\fR gem for managing DNS
+Disable the landrush(1) gem for managing DNS
 .
 .TP
 \fB\-\-no\-port\-forward\fR, \fB\-\-no\-port\-forwarding\fR
@@ -68,25 +68,25 @@ Run a command without actually doing anything
 .
 .TP
 \fB\-\-nginx\fR, \fB\-\-no\-apache\fR
-Create conf files for nginx instead of apache
+Create \fBconf\fR files for nginx(7) instead of apache(7)
 .
 .SH "PRIMARY COMMANDS"
 Run \fBtj help\fR [\fIcommand\fR] to view an individual command\'s man page\.
 .
 .TP
-\fBcreate\fR, \fBnew\fR, \fBmk\fR
+create(1), \fBnew\fR, \fBmk\fR
 Create a new project
 .
 .TP
-\fBsetup\fR, \fBup\fR, \fBinit\fR
+setup(1), \fBup\fR, \fBinit\fR
 Setup an existing project
 .
 .TP
-\fBdelete\fR, \fBrm\fR, \fBremove\fR, \fBtrash\fR
+delete(1), \fBrm\fR, \fBremove\fR, \fBtrash\fR
 Delete a project
 .
 .TP
-\fBdeploy\fR, \fBserver\fR, \fBremote\fR
+deploy(1), \fBserver\fR, \fBremote\fR
 Deploy a project
 .
 .SH "SECONDARY COMMANDS"
@@ -101,7 +101,7 @@ List all projects
 .
 .TP
 \fBvm\fR, \fBvagrant\fR, \fBvvv\fR=[\fIcommand\fR[,\fIcommand\fR]\.\.\.]
-Manage development environment via \fBvagrant\fR\. 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\.
 .
 .SH "CONFIG COMMANDS"
 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\.
@@ -128,7 +128,7 @@ Package project for distribution
 .
 .TP
 \fBwp\fR, \fBwordpress\fR=[\fIarg\fR[,\fIarg\fR]\.\.\.]
-Manage project\'s WordPress installation
+Manage project\'s wordpress(7) installation with wp\-cli(1)
 .
 .TP
 \fBbackup\fR, \fBbk\fR=[\fIarg\fR[,\fIarg\fR]\.\.\.]
@@ -139,7 +139,7 @@ Backup project
 Manage and run project tests
 .
 .SH "CONFIG FILE"
-A YAML configuration file (\fBJuicefile\fR) can be used to store commonly\-used build scripts\. Each command block sequence can be mapped to an individual project\'s build tool, allowing a streamlined set of commands 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 individual project\'s build tool, allowing a streamlined set of commands to be used across multiple projects that utilize different tools\.
 .
 .TP
 \fBcommands\fR
@@ -177,10 +177,6 @@ Commands used to backup project
 \fBcommands\.test\fR
 Command used to manage and run project tests
 .
-.TP
-\fBdeployment\fR
-Coming soon
-.
 .P
 Placeholder arguments can be used within any command block sequence to allow splat or indexed arguments to be passed to the corresponding command when executed\.
 .
@@ -196,14 +192,14 @@ Where \fBn\fR is the argument index e\.g\. \fBcmd %arg1% | cmd %arg2%\fR
 When naming your configuration file, use the recommended \fBJuicefile\fR, or \fB\.tj\.yaml\fR naming convention\. The raw filename regex matcher is below if you want to be a little different\.
 .
 .P
-\fB/^(((\e\.)?(tj)|((J|j)uicefile))(\.y(a)?ml)?$)/\fR
+\fB/^(((\e\.)?(tj)|((J|j)uicefile))(\e\.y(a)?ml)?$)/\fR
 .
 .SH "ENVIRONMENT"
-All of the global options have a corresponding \fBENV\fR variable that can be set to permanently use the specified value each time \fBtj\fR is run\. This is useful if you\'re using an alternate Vagrant box, or if you need to disable certain features due to limited support e\.g\. on Windows\.
+All of the global options have a corresponding \fBENV\fR variable that can be 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\.
 .
 .TP
 \fBTJ_VM_BOX\fR=\fIrepository\fR
-Force Vagrant box for use as VM
+Force vagrant(1) box for use as VM
 .
 .TP
 \fBTJ_PATH\fR=\fIpath\fR
@@ -219,7 +215,7 @@ Force directory prefix for project in VM
 .
 .TP
 \fBTJ_YOLO\fR=\fIbool\fR
-Say yes to anything and everything
+Say yes to anything and everything, and maybe even get a few surprises
 .
 .TP
 \fBTJ_BORING\fR=\fIbool\fR
@@ -239,7 +235,7 @@ Prints all output without animations (coming soon)
 .
 .TP
 \fBTJ_NO_LANDRUSH\fR=\fIbool\fR
-Disable the \fBlandrush\fR gem for managing DNS
+Disable the landrush(1) gem for managing DNS
 .
 .TP
 \fBTJ_NO_PORT_FORWARD\fR=\fIbool\fR
@@ -247,7 +243,7 @@ Disable automatic port forwarding
 .
 .TP
 \fBTJ_VERBOSE\fR=\fIbool\fR
-Prints out additional logging information
+Prints out additional logging information and raises any exceptions caught during runtime
 .
 .TP
 \fBTJ_DRYRUN\fR=\fIbool\fR
@@ -255,5 +251,5 @@ Run a command without actually doing anything
 .
 .TP
 \fBTJ_NGINX\fR=\fIbool\fR
-Create conf files for nginx instead of apache
+Create \fBconf\fR files for nginx(7) instead of apache(7)
 

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

@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "TJ\-CREATE" "1" "June 2015" "" "Theme Juice Manual"
+.TH "TJ\-CREATE" "1" "July 2015" "" "Theme Juice Manual"
 .
 .SH "NAME"
 \fBtj\-create\fR \- Create a new project
@@ -32,7 +32,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
@@ -56,7 +56,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-create.txt

@@ -30,7 +30,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
@@ -48,7 +48,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
@@ -56,4 +56,4 @@ GLOBAL OPTIONS
 
 
 
-				   June 2015			  TJ-CREATE(1)
+				   July 2015			  TJ-CREATE(1)

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

@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "TJ\-DELETE" "1" "June 2015" "" "Theme Juice Manual"
+.TH "TJ\-DELETE" "1" "July 2015" "" "Theme Juice Manual"
 .
 .SH "NAME"
 \fBtj\-delete\fR \- Delete a project
@@ -10,7 +10,7 @@
 \fBtj delete\fR [\-\-flag=\fIarg\fR] [\-\-flag]
 .
 .SH "DESCRIPTION"
-Remove a project from your development environment\. This will only remove files that were generated by \fBtj\fR i\.e\. the database setup, DNS setup, and the project\'s shared directories\.
+Removes a project from your development environment\. This will only remove files that were generated by tj(1) i\.e\. the database setup, DNS setup, and the project\'s shared directories\.
 .
 .P
 It will not touch your local folders that were synced to the VM\.

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

@@ -9,8 +9,8 @@ SYNOPSIS
        tj delete [--flag=arg] [--flag]
 
 DESCRIPTION
-       Remove  a  project  from  your  development environment. This will only
-       remove files that were generated by tj i.e.  the  database  setup,  DNS
+       Removes	a  project  from  your development environment. This will only
+       remove files that were generated by tj(1) i.e. the database setup,  DNS
        setup, and the project's shared directories.
 
        It will not touch your local folders that were synced to the VM.
@@ -31,4 +31,4 @@ GLOBAL OPTIONS
 
 
 
-				   June 2015			  TJ-DELETE(1)
+				   July 2015			  TJ-DELETE(1)

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

@@ -1,13 +1,185 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "TJ\-DEPLOY" "1" "June 2015" "" "Theme Juice Manual"
+.TH "TJ\-DEPLOY" "1" "July 2015" "" "Theme Juice Manual"
 .
 .SH "NAME"
 \fBtj\-deploy\fR \- Deploy a project
 .
 .SH "SYNOPSIS"
-\fBtj deploy\fR [\-\-flag=\fIarg\fR] [\-\-flag]
+\fBtj deploy\fR \fIstage\fR [\fIcommand\fR] [\-\-flag=\fIarg\fR] [\-\-flag]
 .
 .SH "DESCRIPTION"
-Coming soon
+Deploys a project to the passed \fBstage\fR\. All commands are transformed and then piped directly to capistrano(1) to handle deployment\.
+.
+.SH "SETUP"
+Follow these steps to quickly get up and running:
+.
+.IP "1." 4
+Create a \fBdeploy\fR user on the \fBstage\fR server
+.
+.IP "2." 4
+Create SSH keys for the new \fBdeploy\fR user
+.
+.IP "3." 4
+Create a deployment key for the \fBstage\fR server to clone your repository
+.
+.IP "4." 4
+Confirm the \fBdeploy\fR user owns the deploy path
+.
+.IP "5." 4
+Run \fBtj deploy <stage> setup\fR to setup the initial shared and releases directories
+.
+.IP "6." 4
+Deploy!
+.
+.IP "" 0
+.
+.SH "PRIMARY COMMANDS"
+If no command is passed, the default task to be executed is \fBdeploy\fR
+.
+.TP
+\fBdeploy\fR
+Deploy a project
+.
+.TP
+\fBrollback\fR
+Rollback a previous deployment
+.
+.TP
+\fBsetup\fR, \fBcheck\fR
+Run a preliminary deployment check, making sure that all necessary folders are created and accessible on the passed \fBstage\fR
+.
+.SH "SECONDARY COMMANDS"
+.
+.TP
+\fBdb:backup\fR
+Back up the database on the passed \fBstage\fR and store it locally in the \fBdeployment\.stages\.vagrant\.backup\fR directory
+.
+.TP
+\fBdb:pull\fR
+Pull the database from the passed \fBstage\fR and import it into the development environment
+.
+.TP
+\fBdb:push\fR
+Push the database from the development environment and import it into the passed \fBstage\fR
+.
+.TP
+\fBenv:pull\fR
+Pull the current \fB\.env\.<stage>\fR file from the passed \fBstage\fR to the development environment
+.
+.TP
+\fBenv:push\fR
+Push the current \fB\.env\.<stage>\fR file from the development environment to the passed \fBstage\fR
+.
+.TP
+\fBuploads:pull\fR
+Pull the current \fBstage\fR\'s uploads folder from the passed \fBstage\fR to the development environment
+.
+.TP
+\fBuploads:push\fR
+Push the uploads folder from the development environment to the passed \fBstage\fR\'s uploads folder
+.
+.SH "CONFIG FILE"
+The YAML Juicefile(5) configuration may be used to store deployment\-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\.
+.
+.TP
+\fBdeployment\fR
+Deployment configuration
+.
+.TP
+\fBdeployment\.application\fR
+Application settings passed directly to capistrano(1)
+.
+.TP
+\fBdeployment\.settings\fR
+Deployment settings passed directly to capistrano(1)
+.
+.TP
+\fBdeployment\.repository\fR
+Repository settings passed directly to capistrano(1)
+.
+.TP
+\fBdeployment\.rsync\fR
+Optional settings passed to capistrano\-rsync(1); mapped as \fBrsync_<setting>\fR during the deployment initialization
+.
+.TP
+\fBdeployment\.slack\fR
+Optional settings passed to capistrano\-slackify(1); mapped as \fBslack_<setting>\fR during the deployment initialization
+.
+.TP
+\fBdeployment\.stages\fR
+Deployment stages
+.
+.TP
+\fBdeployment\.stages\.<stage>\.server\fR
+Domain or IP address of the server
+.
+.TP
+\fBdeployment\.stages\.<stage>\.path\fR
+Root path to the deployment directory
+.
+.TP
+\fBdeployment\.stages\.<stage>\.user\fR
+User account to deploy as (it is recommended \fInot\fR to use \fBroot\fR)
+.
+.TP
+\fBdeployment\.stages\.<stage>\.url\fR
+URL of the stage
+.
+.TP
+\fBdeployment\.stages\.<stage>\.uploads\fR
+Relative path from deploy path to the uploads folder
+.
+.TP
+\fBdeployment\.stages\.<stage>\.tmp\fR
+Relative path from deploy path to the tmp folder
+.
+.TP
+\fBdeployment\.stages\.<stage>\.shared\fR
+Sequence of relative files from application root to place inside of the shared folder
+.
+.TP
+\fBdeployment\.stages\.<stage>\.roles\fR
+Sequence of deployment roles for the stage
+.
+.TP
+\fBdeployment\.stages\.vagrant\fR
+Required development environment settings; these are used for database and file migration
+.
+.TP
+\fBdeployment\.stages\.vagrant\.server\fR
+Domain or IP address of the development environment
+.
+.TP
+\fBdeployment\.stages\.vagrant\.path\fR
+Root path to the application directory within the VM
+.
+.TP
+\fBdeployment\.stages\.vagrant\.user\fR
+User account to deploy as (usually \fBvagrant\fR)
+.
+.TP
+\fBdeployment\.stages\.vagrant\.pass\fR
+Password for the user (usually \fBvagrant\fR)
+.
+.TP
+\fBdeployment\.stages\.vagrant\.url\fR
+URL of the project
+.
+.TP
+\fBdeployment\.stages\.vagrant\.uploads\fR
+Relative path from application root to the uploads folder
+.
+.TP
+\fBdeployment\.stages\.vagrant\.backup\fR
+Relative path from application root to the backup folder
+.
+.TP
+\fBdeployment\.stages\.vagrant\.tmp\fR
+Relative path from application root to the tmp folder
+.
+.TP
+\fBdeployment\.stages\.vagrant\.roles\fR
+Sequence of roles for the development environment
+