theme-juice 0.26.3 → 0.27.0

data/lib/theme-juice/env.rb

@@ -30,15 +30,15 @@ module ThemeJuice
     attr_accessor :branch
 
     def vm_box=(val)
-      @vm_box = val || ENV.fetch("TJ_VM_BOX") { "git@github.com:ezekg/theme-juice-vvv.git" }
+      @vm_box = val || ENV.fetch("TJ_VM_BOX") { "git@github.com:ezekg/graft.git" }
     end
 
     def vm_path=(val)
-      @vm_path = val || ENV.fetch("TJ_VM_PATH") { File.expand_path("~/tj-vagrant") }
+      @vm_path = val || ENV.fetch("TJ_VM_PATH") { File.expand_path("~/graft") }
     end
 
     def vm_ip=(val)
-      @vm_ip = val || ENV.fetch("TJ_VM_IP") { "192.168.50.4" }
+      @vm_ip = val || ENV.fetch("TJ_VM_IP") { "192.168.13.37" }
     end
 
     def vm_prefix=(val)

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

@@ -1,5 +1,6 @@
 module ThemeJuice
   module SingletonHelper
+
     def inspect
       res = []
 
@@ -12,5 +13,15 @@ module ThemeJuice
 
       res.sort
     end
+
+    def to_h
+      hash = {}
+
+      self.instance_variables.each do |k, _|
+        hash[k[1..-1]] = instance_variable_get k
+      end
+
+      hash
+    end
   end
 end

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" "July 2016" "" "Theme Juice Manual"
+.TH "TJ" "1" "August 2016" "" "Theme Juice Manual"
 .
 .SH "NAME"
 \fBtj\fR \- WordPress development made easy
@@ -138,96 +138,197 @@ List all projects
 \fBvm\fR, \fBvagrant\fR, \fBvvv\fR=[\fIcommand\fR[,\fIcommand\fR]\.\.\.]
 Manage development environment via vagrant(1)\. Commands are proxied to your Vagrant installation so that they can be run from any directory\.
 .
+.SH "CONFIG FILE"
+A YAML configuration file called a Juicefile(5) can be used to store commonly used build scripts, similar to npm(1) scripts\. Each command can be mapped to any build script you like, allowing you to define a set of commands that can be used across all of your projects\. If you plan to deploy using \fBtj\fR, this file will also house your deploy(1) configuration\.
+.
+.P
+For reference, below is an example config:
+.
+.IP "" 4
+.
+.nf
+
+  # Project configuration
+  project:
+    name: example
+    url: example\.dev
+
+  # Manage command aliases for the current project
+  commands:
+
+    # Run project install scripts
+    install:
+      \- npm install
+      \- grunt build
+
+    # Manage build tools
+    dev:
+      \- grunt %args%
+
+    # Manage front\-end dependencies
+    assets:
+      \- npm %args%
+
+    # Manage back\-end dependencies
+    vendor:
+      \- composer %args%
+
+    # Create a backup of the current database with a nice timestamp
+    backup:
+      \- mkdir \-p backup
+      \- wp @dev db export backup/$(date +\'%Y\-%m\-%d\-%H\-%M\-%S\')\.sql
+
+  # Manage deployment settings for the current project
+  deployment:
+    # \.\.\.
+
+    stages:
+      # \.\.\.
+.
+.fi
+.
+.IP "" 0
+.
 .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\. Below are the commands defined within the \fITheme Juice starter template\fR\.
+The commands within the \fBcommands\fR block can be run from the command line via \fBtj <command>\fR\. For example, we can run the \fBdev\fR command by running \fBtj dev\fR, which will in turn run the command \fBgrunt\fR\.
 .
-.TP
-\fBinstall\fR=[\fIarg\fR[,\fIarg\fR]\.\.\.]
-Run installation for project
+.P
+If you noticed in the example above, there are a few commands that contain \fB%args%\fR; each command list is run within a single execution via joining: \fBcmd1 && cmd2 [&& cmd3\.\.\.]\fR, with all \fB%args%\fR/\fB%argN%\fR being replaced with the corresponding argument index, when available\.
 .
-.TP
-\fBwatch\fR=[\fIarg\fR[,\fIarg\fR]\.\.\.]
-Manage and run development build tools
+.P
+Here\'s a few example commands using placeholders:
 .
-.TP
-\fBassets\fR=[\fIarg\fR[,\fIarg\fR]\.\.\.]
-Manage front\-end dependencies for project
+.IP "" 4
 .
-.TP
-\fBvendor\fR=[\fIarg\fR[,\fIarg\fR]\.\.\.]
-Manage back\-end dependencies for project
+.nf
+
+  example\-command:
+    # Will contain all arguments joined by a space
+    \- cmd1 %args%
+    # Will contain each argument mapped to its respective index
+    \- cmd2 \'%arg1% %arg2% %arg3%\'
+    # Will only map argument 4, while ignoring 1\-3
+    \- cmd3 "%arg4%"
 .
-.TP
-\fBdist\fR=[\fIarg\fR[,\fIarg\fR]\.\.\.]
-Package project for distribution
+.fi
+.
+.IP "" 0
+.
+.P
+To clarify a little bit more, we could run \fBtj dev build\fR, and since our \fBdev\fR command contains \fB%args%\fR, that will in turn run the command \fBgrunt build\fR; if we run \fBtj dev some:other task\fR, that would be interpreted and run as \fBgrunt some:other task\fR\.
+.
+.P
+You can specify an unlimited number of commands with an unlimited number of arguments within your \fBJuicefile\fR; however, you should be careful with how this is used\. Don\'t go including \fBsudo rm \-rf %arg1%\fR in a command, while passing \fB/\fR as an argument\. Keep it simple\. These are meant to make your life easier by helping you manage build tools, not to do fancy scripting\.
+.
+.SH "CONFIG TEMPLATE STRINGS"
+You may define ERB template strings within a project starter template\'s Juicefile(5)\. These will be replaced upon running create(1)\.
+.
+.P
+For example,
+.
+.IP "" 4
+.
+.nf
+
+  # Project configuration
+  project:
+    name: <%= name %>
+    url: <%= url %>
+.
+.fi
+.
+.IP "" 0
+.
+.P
+will be replaced with,
+.
+.IP "" 4
+.
+.nf
+
+  # Project configuration
+  project:
+    name: example\-project
+    url: example\-project\.dev
+.
+.fi
+.
+.IP "" 0
+.
+.P
+if those were the options chosen during a creation\. The following variables are available for use:
 .
 .TP
-\fBwp\fR=[\fIarg\fR[,\fIarg\fR]\.\.\.]
-Manage project\'s wordpress(7) installation with wp\-cli(1)
+\fBname\fR
+Project name
 .
 .TP
-\fBbackup\fR=[\fIarg\fR[,\fIarg\fR]\.\.\.]
-Backup project
+\fBlocation\fR
+Project location
 .
 .TP
-\fBtest\fR=[\fIarg\fR[,\fIarg\fR]\.\.\.]
-Manage and run project tests
+\fBurl\fR
+Project URL
 .
-.SH "CONFIG FILE"
-A YAML Juicefile(5) configuration can be used to store commonly\-used build scripts (and deploy(1) info), similar to npm(1) 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\. Below are descriptions for the default commands within the \fITheme Juice starter template\'s\fR \fBJuicefile\fR\.
+.TP
+\fBxip_url\fR
+Project xip\.io URL
 .
 .TP
-\fBcommands\fR
-Collection of various command block sequences
+\fBtemplate\fR
+Project template repository URL
 .
 .TP
-\fBcommands\.install\fR
-Command sequence used to properly install and build project
+\fBrepository\fR
+Initialized repository URL, if available
 .
 .TP
-\fBcommands\.watch\fR
-Command used to manage development build tools
+\fBdb_host\fR
+Project database host
 .
 .TP
-\fBcommands\.assets\fR
-Command used to manage front\-end dependencies
+\fBdb_name\fR
+Project database name
 .
 .TP
-\fBcommands\.vendor\fR
-Command used to manage back\-end dependencies
+\fBdb_user\fR
+Project database user
 .
 .TP
-\fBcommands\.wp\fR
-Command used to manage WordPress installation
+\fBdb_pass\fR
+Project database password
 .
 .TP
-\fBcommands\.dist\fR
-Commands used to package project for distribution
+\fBdb_import\fR
+Path to imported database file
 .
 .TP
-\fBcommands\.backup\fR
-Commands used to backup project
+\fBvm_box\fR
+Virtual machine box URL
 .
 .TP
-\fBcommands\.test\fR
-Command used to manage and run project tests
+\fBvm_ip\fR
+Virtual machine IP address
 .
-.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\.
+.TP
+\fBvm_path\fR
+Virtual machine location on the host machine
 .
 .TP
-\fB%args%\fR, \fB%arguments%\fR
-Splat argument placeholder e\.g\. \fBcmd %args%\fR
+\fBvm_root\fR
+Web root of the VM on the host machine
 .
 .TP
-\fB%argN%\fR, \fB%argumentN%\fR
-Where \fBn\fR is the argument index e\.g\. \fBcmd %arg1% | cmd %arg2%\fR
+\fBvm_location\fR
+Project location within the VM on the host machine
 .
-.P
-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\.
+.TP
+\fBvm_srv\fR
+Project location within the VM on the guest machine
 .
-.P
-\fB/^(((\e\.)?(tj)|((J|j)uicefile))(\e\.y(a)?ml)?$)/\fR
+.TP
+\fBvm_prefix\fR
+Virtual machine project location prefix
 .
 .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 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 i\.e\. on Windows\.

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

@@ -113,8 +113,4 @@ Modify \fBwp\-config\.php\fR file contents with project configuration (this flag
 .TP
 \fB\-\-no\-ssl\fR, \fB\-\-no\-https\fR
 Project does not need SSL support
-.
-.TP
-\fB\-\-provision\fR
-Run provisioners after creating project
 

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

@@ -92,9 +92,6 @@ GLOBAL OPTIONS
        --no-ssl, --no-https
 	      Project does not need SSL support
 
-       --provision
-	      Run provisioners after creating project
-
 
 
 

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

@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "TJ\-DEPLOY" "1" "January 2016" "" "Theme Juice Manual"
+.TH "TJ\-DEPLOY" "1" "August 2016" "" "Theme Juice Manual"
 .
 .SH "NAME"
 \fBtj\-deploy\fR \- Deploy a project
@@ -22,7 +22,7 @@ Follow these steps to quickly get up and running:
 Create a \fBdeploy\fR user on the \fBstage\fR server
 .
 .IP "2." 4
-Set up SSH keys for the new \fBdeploy\fR user to SSH in without a password
+Set up SSH keys for the new \fBdeploy\fR user for password\-less SSH access
 .
 .IP "3." 4
 Confirm the \fBdeploy\fR user owns the deploy path
@@ -107,7 +107,7 @@ Recursively pull a relative directory from the passed \fBstage\fR to the develop
 Recursively push a relative directory from the development environment to the passed \fBstage\fR\.
 .
 .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\.
+The YAML Juicefile(5) configuration may be used to store deployment\-related settings\. Below you will find the various options you can use to define your project\'s deployment setup\.
 .
 .TP
 \fBdeployment\fR
@@ -139,7 +139,7 @@ Deployment stages
 .
 .TP
 \fBdeployment\.stages\.<stage>\.server\fR
-Domain or IP address of the server
+Domain or IP address of the server; can include an optional port number in the form of \fB<ip_or_domain>:<port>\fR
 .
 .TP
 \fBdeployment\.stages\.<stage>\.path\fR
@@ -208,4 +208,136 @@ Relative path from application root to the tmp folder
 .TP
 \fBdeployment\.stages\.vagrant\.roles\fR
 Sequence of roles for the development environment
+.
+.P
+Below is an example deployment configuration:
+.
+.IP "" 4
+.
+.nf
+
+  # Project configuration
+  project:
+    name: example
+
+  # Deployment configuration
+  deployment:
+
+    # Repository settings
+    repository:
+      repo_url: git@github\.com:example/example\-app\.git
+      branch: :master
+      scm: :rsync
+
+    # Other settings that will be passed directly to Capistrano
+    # @see http://capistranorb\.com/
+    settings:
+      keep_releases: 5
+      format: :pretty
+      log_level: :verbose
+      use_sudo: false
+      ssh_options:
+        keys: ~/\.ssh/id_rsa
+        forward_agent: true
+        paranoid: true
+      # Add additional directories to $PATH\. This is useful if you\'re
+      #  on a shared hosting environment (i\.e\. GoDaddy) and you need
+      #  to use an executable such as wp\-cli for database migration\.
+      default_env:
+        path: /opt/wp\-cli/bin:$PATH
+
+    # Capistrano rsync options and install procedure
+    # @see https://github\.com/Bladrak/capistrano\-rsync
+    rsync:
+      stage: tmp/deploy
+      cache: shared/deploy
+      scm: :git
+      depth: 1
+      # Options to pass to the rsync command
+      # @see http://linux\.die\.net/man/1/rsync
+      options:
+        \- \-\-recursive
+        \- \-\-delete
+        \- \-\-delete\-excluded
+        \- \-\-include="vendor/**/*" # Overrides any excluded patterns
+        \- \-\-exclude="node_modules/"
+        \- \-\-exclude="\.env\.sample"
+        \- \-\-exclude="\.git*"
+        \- \-\-exclude="Juicefile*"
+        \- \-\-exclude="composer\.*"
+        \- \-\-exclude="package\.json"
+        \- \-\-exclude="README\.*"
+      # Run application install scripts
+      install:
+        \- composer install \-\-no\-dev
+        \- bundle install
+        \- npm install
+        \- bower install
+        \- grunt build
+      # Run scripts before the deployment starts
+      pre_scripts:
+        \- touch \.maintenance
+      # Run scripts before the deployment finishes
+      post_scripts:
+        \- rm \.maintenance
+        \- sudo service apache2 restart
+
+    # Slack integration
+    # @see https://github\.com/onthebeach/capistrano\-slackify
+    slack:
+      url: https://hooks\.slack\.com/services/your\-token
+      username: Deploybot
+      channel: "#devops"
+      emoji: ":rocket:"
+
+    # Deployment stages
+    stages:
+
+      production:
+        server: 192\.168\.13\.37:1234
+        path: /var/www/production
+        user: deploy
+        url: example\.com
+        uploads: app/uploads
+        tmp: tmp
+        shared:
+          \- \.env\.production
+        ignore:
+          \- robots\.txt
+        roles:
+          \- :web
+          \- :app
+          \- :db
+
+      staging:
+        server: 192\.168\.13\.37
+        path: /var/www/staging
+        user: deploy
+        url: staging\.example\.com
+        uploads: app/uploads
+        tmp: tmp
+        shared:
+          \- \.env\.staging
+        roles:
+          \- :web
+          \- :app
+          \- :db
+
+      # This is your development environment used to push/pull database files,
+      #  uploads, the \.env file, etc\.
+      vagrant:
+        server: example\.dev
+        path: /srv/www/tj\-example
+        user: vagrant
+        pass: vagrant
+        url: example\.dev
+        uploads: app/uploads
+        backup: backup
+        tmp: tmp
+        roles:
+          \- :dev
+.
+.fi
+.
+.IP "" 0