theme-juice 0.18.4 → 0.18.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6cd26e5fb956ae95d976b354c59a1816495781b7
-  data.tar.gz: c2501f9e6d8e83f2112995d8239f288a9d6cd716
+  metadata.gz: ce260a5474824765f0e6277ad73ea3a9db42aa2b
+  data.tar.gz: 8fc2f348498435f68f4731e2fc3af128c229cedf
 SHA512:
-  metadata.gz: 1997ce76f00cbf59f050861624754401b125d70b9ef03c15aa3e49b3cf495e1f8e8eaeaceff14d1dd25d9b9d1cbd09edde2c9be9916f8ade853169cf8bd6dfd0
-  data.tar.gz: 19fdca8779678c987f04d3e5b33d504a10cb5edeaca3859217dac163058fdbf9dcd463a8edbd2fa9dd758c299cbffe8f95b89f899197cb4b68eb864bf2a2b061
+  metadata.gz: 3cae1fde7249d2dca577566a1b69111e2783892fa0d5ad402371dfd28351d4446efd76dfce70e52977108cb83d47d30ce4f39d84fd358d738d98742af4e1422e
+  data.tar.gz: 83e79fdedf0ecb100f6bfa78acec5436b183e3edd5c537ae452abb61c54d7085a349917bbcfa620b0f81b4163695c10dcfa67046e42537c398f7714c19796dac

data/README.md

@@ -8,12 +8,30 @@
 ![Theme Juice CLI](demo.gif)
 
 ## What is it?
-[Theme Juice CLI](http://themejuice.it) (`tj`) is a command line utility that allows you to generate, manage and deploy new local WordPress development applications in seconds using Vagrant, utilizing an [Apache fork](https://github.com/ezekg/theme-juice-vvv) of [VVV](https://github.com/Varying-Vagrant-Vagrants/VVV) for the virtual machine.
+The [Theme Juice CLI](http://themejuice.it), also known as `tj`, helps you create new local WordPress development sites, manage existing sites, and deploy them, all from the command line. It utilizes an [Apache fork](https://github.com/ezekg/theme-juice-vvv) of [VVV](https://github.com/Varying-Vagrant-Vagrants/VVV) for the virtual machine to spin up new development sites in seconds.
 
 Check out [our getting started guide over at SitePoint](http://www.sitepoint.com/introducing-theme-juice-for-local-wordpress-development/), or [view the documentation site](http://themejuice.it).
 
+## What problems does `tj` help solve?
+To get the most out of `tj`, it is recommended that you use our [starter template](https://github.com/ezekg/theme-juice-starter). Why? Keep on reading and we'll tell you. `tj` is built on top of tried and true open source libraries such as [Capistrano](http://capistranorb.com/) for deployments, [Vagrant](https://www.vagrantup.com/) for local development, and even a little bit of [WP-CLI](http://wp-cli.org) for database migration. Some of the main pain points `tj` helps solve are:
+
+### 1. Local development
+Say goodbye to MAMP! With one command, `tj create`, you can have a new local development site up and running in under a minute. It uses a streamlined fork of VVV (listed above) to create a Vagrant development environment, and lets you create and manage multiple projects within a single virtual machine. It also handles deployments over SSH using Capistrano if you want to move away from FTP (more about that below).
+
+### 2. Multi-environment projects
+Oh, multi-environment development! Usually, you would have to ignore your entire `wp-config.php` file and create one for every single stage. These can get out of sync fast. Even worse, the config file actually gets checked into the project repo and so the credentials fluctuate from `dev` to `staging` to `production`. Not good. Not good at all.
+
+Our [starter template](https://github.com/ezekg/theme-juice-starter) uses a `.env` file, and has support for an unlimited number of environments (we generally do `development`, `staging` and `production`). Since these settings are housed in a `.env` file, they are not checked into the repo. That means the codebase is 100% environment agnostic. [The way it should be.](http://12factor.net/)
+
+### 3. Multi-environment deployments
+Really. Want to deploy to staging? Set up a staging environment inside of the [`Juicefile`](https://github.com/ezekg/theme-juice-starter/blob/master/Juicefile?ts=2), make sure you can SSH in without a password (remember, best practices here!) and run `tj deploy staging`. Boom, you're done. Make a mistake? Run `tj rollback staging`. Crisis averted!
+
+Want to pull the database from your production server to your development install? Run `tj remote production db:pull` and you're good to go; `tj` will automatically handle rewriting any URLs within the database.
+
+How about pushing your development database and your local uploads folder? Run `tj remote production db:push && tj remote production uploads:push` and you're done. [You can even send notifications to your teams Slack channel if you want to!](https://github.com/ezekg/theme-juice-cli#can-i-integrate-my-deployments-with-slack)
+
 ## Requirements
-**`tj` requires [Vagrant](https://www.vagrantup.com/) and [VirtualBox](https://www.virtualbox.org/) to be able to create virtual machines for local development. Please download and install both of these before getting started.**
+**`tj` requires [Vagrant](https://www.vagrantup.com/) and [VirtualBox](https://www.virtualbox.org/) to be able to create virtual machines for local development. Please download and install both of these before getting started.** If you plan on using `tj` for deployments, you should also ensure that your `remote` servers have [WP-CLI](http://wp-cli.org/") installed in order for `tj` to be able to handle database migration.
 
 I recommend one of the latest versions of Ruby MRI (2.2, 2.1, 2.0). `tj` requires at least MRI 1.9.3. For the full report, check out the [Travis CI build status](https://travis-ci.org/ezekg/theme-juice-cli), where I test against an array of Ruby interpreters.
 
@@ -46,7 +64,7 @@ tj create
 #### What happens on your first `create`?
 1. `tj` will execute `tj init` if the VM is uninitialized
 1. `tj` will clone the selected starter template
-1. `tj` will run the starter template's Juicefile(1) `install` command
+1. `tj` will run the starter template's Juicefile `install` command
 1. `tj` will create all of the necessary project files, such as:
   * `Customfile` containing DNS and synced folder settings
   * `init-custom.sql` containing database setup
@@ -169,11 +187,11 @@ Below is the config that comes baked into [our starter template](https://github.
 
 ```yml
 #
-# Manage command aliases for the current application
+# Manage command aliases for the current project
 #
 commands:
 
-  # Run application install scripts
+  # Run project install scripts
   install:
     - composer install
     - bundle install
@@ -202,7 +220,7 @@ commands:
     - mkdir -p backup
     - wp ssh --host=vagrant db export backup/$(date +'%Y-%m-%d-%H-%M-%S').sql
 
-  # Package up entire application into a gzipped tar file
+  # Package up entire project into a gzipped tar file
   dist:
     - tar -zcvf dist.tar.gz .
 ```

data/lib/theme-juice/man/tj

@@ -1,5 +1,5 @@
-.\" generated with Ronn/v0.7.0
-.\" http://github.com/rtomayko/ronn/tree/0.7.0
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
 .TH "TJ" "1" "December 2015" "" "Theme Juice Manual"
 .

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

@@ -1,5 +1,5 @@
-.\" generated with Ronn/v0.7.0
-.\" http://github.com/rtomayko/ronn/tree/0.7.0
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
 .TH "TJ\-CREATE" "1" "December 2015" "" "Theme Juice Manual"
 .

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

@@ -1,5 +1,5 @@
-.\" generated with Ronn/v0.7.0
-.\" http://github.com/rtomayko/ronn/tree/0.7.0
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
 .TH "TJ\-DELETE" "1" "December 2015" "" "Theme Juice Manual"
 .

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

@@ -1,5 +1,5 @@
-.\" generated with Ronn/v0.7.0
-.\" http://github.com/rtomayko/ronn/tree/0.7.0
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
 .TH "TJ\-DEPLOY" "1" "December 2015" "" "Theme Juice Manual"
 .
@@ -12,6 +12,9 @@
 .SH "DESCRIPTION"
 Deploys a project to the passed \fBstage\fR\. All commands are transformed and then piped directly to capistrano(1) to handle deployment\.
 .
+.SH "REQUIREMENTS"
+The \fBremote\fR that is being deployed to needs to have wp\-cli(1) installed in order for tj(1) to be able to handle database migration\.
+.
 .SH "SETUP"
 Follow these steps to quickly get up and running:
 .

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

@@ -12,6 +12,10 @@ DESCRIPTION
        Deploys a project to the passed stage. All commands are transformed and
        then piped directly to capistrano(1) to handle deployment.
 
+REQUIREMENTS
+       The remote that is being deployed to needs to have wp-cli(1)  installed
+       in order for tj(1) to be able to handle database migration.
+
 SETUP
        Follow these steps to quickly get up and running:
 
@@ -40,7 +44,7 @@ PRIMARY COMMANDS
 	      Rollback a previous deployment
 
        setup, check
-	      Run a preliminary deployment check, making sure that all	neces-
+	      Run  a preliminary deployment check, making sure that all neces-
 	      sary folders are created and accessible on the passed stage
 
 SECONDARY COMMANDS
@@ -49,7 +53,7 @@ SECONDARY COMMANDS
 	      the deployment.stages.vagrant.backup directory
 
        db:pull
-	      Pull the database from the passed stage and import it  into  the
+	      Pull  the  database from the passed stage and import it into the
 	      development environment
 
        db:push
@@ -57,7 +61,7 @@ SECONDARY COMMANDS
 	      into the passed stage
 
        env:pull
-	      Pull the current .env.<stage> file from the passed stage to  the
+	      Pull  the current .env.<stage> file from the passed stage to the
 	      development environment
 
        env:push
@@ -69,19 +73,19 @@ SECONDARY COMMANDS
 	      the development environment
 
        uploads:push
-	      Push  the uploads folder from the development environment to the
+	      Push the uploads folder from the development environment to  the
 	      passed stage's uploads folder
 
        file:pull=path
-	      Pull a relative file from the passed stage  to  the  development
+	      Pull  a  relative  file from the passed stage to the development
 	      environment.
 
        file:push=path
-	      Push  a  relative  file  from the development environment to the
+	      Push a relative file from the  development  environment  to  the
 	      passed stage.
 
        dir:pull=path
-	      Recursively pull a relative directory from the passed  stage  to
+	      Recursively  pull  a relative directory from the passed stage to
 	      the development environment.
 
        dir:push=path
@@ -89,9 +93,9 @@ SECONDARY COMMANDS
 	      ronment to the passed stage.
 
 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
+       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
@@ -111,7 +115,7 @@ CONFIG FILE
 	      rsync_<setting> during the deployment initialization
 
        deployment.slack
-	      Optional settings passed to  capistrano-slackify(1);  mapped  as
+	      Optional	settings  passed  to capistrano-slackify(1); mapped as
 	      slack_<setting> during the deployment initialization
 
        deployment.stages
@@ -137,14 +141,14 @@ CONFIG FILE
 
        deployment.stages.<stage>.shared
 	      Sequence of relative files from application root to place inside
-	      of the shared folder. Files that end  with  a  trailing  forward
+	      of  the  shared  folder.	Files that end with a trailing forward
 	      slash are assumed to be a directory.
 
        deployment.stages.<stage>.roles
 	      Sequence of deployment roles for the stage
 
        deployment.stages.vagrant
-	      Required	development  environment  settings; these are used for
+	      Required development environment settings; these	are  used  for
 	      database and file migration
 
        deployment.stages.vagrant.server

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

@@ -1,7 +1,7 @@
-.\" generated with Ronn/v0.7.0
-.\" http://github.com/rtomayko/ronn/tree/0.7.0
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "TJ\-SETUP" "1" "December 2015" "" "Theme Juice Manual"
+.TH "TJ\-SETUP" "1" "November 2015" "" "Theme Juice Manual"
 .
 .SH "NAME"
 \fBtj\-setup\fR \- Setup an existing project

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

@@ -47,4 +47,4 @@ GLOBAL OPTIONS
 
 
 
-				 December 2015			   TJ-SETUP(1)
+				 November 2015			   TJ-SETUP(1)

data/lib/theme-juice/version.rb

@@ -1,5 +1,5 @@
 # encoding: UTF-8
 
 module ThemeJuice
-  VERSION = "0.18.4"
+  VERSION = "0.18.5"
 end

metadata

@@ -1,143 +1,143 @@
 --- !ruby/object:Gem::Specification
 name: theme-juice
 version: !ruby/object:Gem::Version
-  version: 0.18.4
+  version: 0.18.5
 platform: ruby
 authors:
 - Ezekiel Gabrielse
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-06 00:00:00.000000000 Z
+date: 2015-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.19.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.19.0
 - !ruby/object:Gem::Dependency
   name: faker
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 1.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 1.4.0
 - !ruby/object:Gem::Dependency
   name: os
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.9.0
 - !ruby/object:Gem::Dependency
   name: capistrano
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 3.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 3.4.0
 - !ruby/object:Gem::Dependency
   name: net-ssh
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 2.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 2.9.0
 - !ruby/object:Gem::Dependency
   name: capistrano-slackify
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 2.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 2.6.0
 - !ruby/object:Gem::Dependency
   name: capistrano-rsync-bladrak
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 1.3.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 1.3.2
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10.4'
-description: tj is a command line utility that allows you to generate, manage and
-  deploy new local WordPress development applications in seconds using Vagrant.
+description: tj helps you create new local WordPress development sites, manage existing
+  sites, and deploy them, all from the command line.
 email:
 - ezekg@yahoo.com
 executables:
@@ -221,17 +221,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: WordPress development made easy