theme-juice 0.10.3 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1c31f52778569765ae8d2184426a107850cd7e15
-  data.tar.gz: df21f1f810814fb17e8653aa8ee44e0142cff999
+  metadata.gz: b86241b9b2883ed2adddf9dd120c86f4f8f59c41
+  data.tar.gz: 30c1aad3368d040c1d97b639d0b2403f77be438d
 SHA512:
-  metadata.gz: 9b9afa8f91fe59237a8e5bbe7117aaa7c017a6ed5d1c84b44a7337d48621882d94954a41a90a0c68b6ce29a55837bf70f4a5a42aefc22f7c12d537808dae67ec
-  data.tar.gz: cb687b18119b4dd6b92f8f7832d46fcff5f0d227889d112846afcec43e20a890109ba5e8efca05eeeaeb2f54639b7ca6f5cacf33134ab6172bb4bce728df626d
+  metadata.gz: ef99c8ad896be4a6eb983cee174b45f73a1e96a9b61790202f47284c6b4fc0ed3d6db55ff5f9f53302911d9d1ec504aec6490149bbb68e0b202e3e766dd64ddb
+  data.tar.gz: 46dcd3804620abbf9d5c0036694edc7b09b339a02e5b5524c8ca38ddca5430a6e4e80d9929c5cad84550eb6f4c54cd8ca750ef97ba8ec2c014a16ee4e86eeced

data/README.md

@@ -4,12 +4,18 @@
 [![Code Climate](https://img.shields.io/codeclimate/github/ezekg/theme-juice-cli.svg?style=flat-square)](https://codeclimate.com/github/ezekg/theme-juice-cli)
 [![Code Climate](https://img.shields.io/codeclimate/coverage/github/ezekg/theme-juice-cli.svg?style=flat-square)](https://codeclimate.com/github/ezekg/theme-juice-cli)
 
+![Theme Juice CLI](demo.gif)
+
 _This project is currently under active development and will not be completely 'stable' per-say until we hit `1.0`. Everything here is subject to change without notice. (We will of course semantically version all of our releases, with the minor version being incremented with new features/breaking changes.) Feel free to contribute to the development with new features, ideas or bug fixes._
 
+_The master branch contains features currently in development (such as deployment), so don't expect it to work at all times. Grab the newest RubyGem instead of building directly from master._
+
 [View our contributing guidelines to get started!](#contributing)
 
+
 ## What is it?
-`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/Varying-Vagrant-Vagrants/VVV) called [VVV-Apache](https://github.com/ericmann/vvv-apache.git) as the VM). It also helps you manage dependencies and build tools, and can even handle your deployments.
+Theme Juice (`tj`) is a command line utility for modern WordPress development. It allows you to scaffold out a Vagrant development environment in seconds (using an Apache fork of [VVV](https://github.com/Varying-Vagrant-Vagrants/VVV) called [VVV-Apache](https://github.com/ericmann/vvv-apache.git) 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.
+
 
 ## 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.**
@@ -25,6 +31,8 @@ gem install theme-juice
 
 ## Getting Started
 
+_If you're going to be using [our starter theme](https://github.com/ezekg/theme-juice-starter), then I recommend checking out [it's dependencies](https://github.com/ezekg/theme-juice-starter#development-dependencies) before running your first `create`. That way, the build step doesn't fail._
+
 #### Create a new project
 This will lead you through a series of prompts to set up required project information, such as name, location, theme, database info, etc. Using the specified information, it will run the installation process and set up a local development environment, if one hasn't already been set up. It will sync your local project location with the project
 location within the VM, so you can run this from anywhere on your local system.
@@ -33,6 +41,15 @@ location within the VM, so you can run this from anywhere on your local system.
 tj create
 ```
 
+##### What happens on your first `create`?
+`tj` will clone the selected VM to your `vm-path` (default path is `~/vagrant/`); after that finishes up, it will create all of the necessary project files, such as:
+* `Customfile` containing DNS and synced folder settings
+* `init-custom.sql` containing database setup
+* `project.conf` containing server settings
+* `wp-cli.local.yml` containing VM paths
+
+Once those things are done, `tj` will run the starter theme's installation (via the `Juicefile`, if present), and then finally provision the VM to put the new configuration into effect. If you've never used Vagrant before, the first provision might take awhile. After that's done, you should be able to access your new project at the specified url.
+
 #### Set up an existing project
 This sets up an existing local project within the development environment. You will go through a series of prompts to create the necessary files. This command is essentially an alias for `tj create --bare`.
 
@@ -49,6 +66,13 @@ It will not touch your local folders that were synced to the VM.
 tj delete
 ```
 
+#### Deploying a project
+This will deploy a project to the passed `stage` using [Capistrano](http://capistranorb.com/).
+
+```
+tj deploy <stage>
+```
+
 #### Want more?
 Want to check out all of the various flags and features `tj` offers? Just ask `tj` for help, and you'll be greeted with a nice `man` page full of information about how to use just about everything.
 
@@ -56,7 +80,7 @@ Want to check out all of the various flags and features `tj` offers? Just ask `t
 tj help
 ```
 
-Or, check out [themejuice.it](http://themejuice.it) for a pretty website chock-full of documentation.
+Or, you can also check out [themejuice.it](http://themejuice.it) for a pretty website chock-full of the same documentation provided by `tj help`.
 
 ## FAQ
 
@@ -108,6 +132,10 @@ Yes and no; in order for `tj` to properly create a project, the Vagrant box need
 |  |  ├── site-1.conf
 |  |  ├── site-2.conf
 |  |  ..
+|  ├── database/
+|  |  |
+|  |  ├── init-custom.sql
+|  |  ..
 |  ..
 ├── www/
 |  |
@@ -133,24 +161,41 @@ A YAML configuration file (`Juicefile`) can be used to store commonly-used build
 Below is the config that comes baked into [our starter theme](https://github.com/ezekg/theme-juice-starter):
 
 ```yml
+#
+# Manage command aliases for the current application
+#
 commands:
+
+  # Run application install scripts
   install:
     - composer install
-    - bundler install
+    - bundle install
     - npm install
     - bower install
     - grunt build
+
+  # Manage build tools
   watch:
     - grunt %args%
+
+  # Manage front-end dependencies
   assets:
     - bower %args%
+
+  # Manage back-end dependencies
   vendor:
     - composer %args%
+
+  # Manage WP installation
   wp:
     - wp ssh --host=vagrant %args%
+
+  # Create a backup of the current database with a nice timestamp
   backup:
     - 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
   dist:
     - tar -zcvf dist.tar.gz .
 ```
@@ -168,13 +213,15 @@ cmd3 "%arg4%"
 You can specify an unlimited number of commands with an unlimited number of arguments; however, you should be careful with how this is used. Don't go including `sudo rm -rf %arg1%` in a command, while passing `/` 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.
 
 #### Does `tj` handle deployments?
-Eventually, yes. It's not currently production-ready, but as soon as it is, we'll have detailed instructions on how to configure and deploy applications using `tj`. Right now, I'm leaning towards integrating an automated Capistrano workflow, but am open to other options. [Have an idea and want to contribute?](#contributing)
+As of `0.11`, yes! Check out the [documentation](http://themejuice.it/deploy) to get started.
 
 #### Can I access a project from another device (i.e. mobile)?
 Yes! Every project created with `tj` will automatically be set up to support using [xip.io](http://xip.io/). If you're using OSX, then everything should work out of the box. If you're not using OSX, then you'll need to point port `80` on your host machine to `8080`; Vagrant cannot do this by default for security reasons.
 
 Once everything is good to go, you can access a project from another device on the same network by going to `<project-name>.<your-hosts-ip-address>.xip.io` e.g. `themejuice.192.168.1.1.xip.io`.
 
+_If you're familiar with forwarding host ports on operating systems other than OSX, check out [this file](https://github.com/ezekg/theme-juice-cli/blob/master/lib/theme-juice/tasks/forward_ports.rb#L34-L51) and make a pull request so that everybody else can benefit from your smarts._
+
 #### Help! It won't let me `git clone` anything!
 You most likely don't have [SSH-keys for GitHub set up correctly (if even at all)](https://help.github.com/articles/error-permission-denied-publickey/). Either set that up, or manually run `tj` with the appropriate flags corresponding to the problem-repository, swapping out `git@github.com:` for `https://github.com/`:
 

data/lib/theme-juice.rb

@@ -4,12 +4,14 @@ require "thor"
 require "faker"
 require "os"
 require "yaml"
+require "capistrano/all"
 
 module ThemeJuice
 end
 
 require "theme-juice/version"
 require "theme-juice/helpers/singleton_helper"
+require "theme-juice/helpers/hash_helper"
 require "theme-juice/env"
 require "theme-juice/project"
 require "theme-juice/util"
@@ -41,6 +43,11 @@ require "theme-juice/tasks/vm_provision"
 require "theme-juice/tasks/vm_restart"
 require "theme-juice/tasks/import_database"
 require "theme-juice/tasks/list"
+require "theme-juice/tasks/stage"
+require "theme-juice/tasks/vm_stage"
+require "theme-juice/tasks/settings"
+require "theme-juice/tasks/load"
+require "theme-juice/tasks/invoke"
 require "theme-juice/command"
 require "theme-juice/commands/create"
 require "theme-juice/commands/delete"

data/lib/theme-juice/cli.rb

@@ -56,20 +56,20 @@ module ThemeJuice
     map %w[server remote]          => :deploy
     map %w[vagrant vvv]            => :vm
 
-    class_option :vm_box,          :type => :string,  :default => nil,                    :desc => "Force Vagrant box for use as VM"
-    class_option :vm_path,         :type => :string,  :default => nil,                    :desc => "Force path to VM"
-    class_option :vm_ip,           :type => :string,  :default => nil,                    :desc => "Force IP address of VM"
-    class_option :vm_prefix,       :type => :string,  :default => nil,                    :desc => "Force directory prefix for project in VM"
-    class_option :yolo,            :type => :boolean,                                     :desc => "Say yes to anything and everything (try it)"
-    class_option :boring,          :type => :boolean,                                     :desc => "Prints all output without anything fancy"
-    class_option :no_unicode,      :type => :boolean,                                     :desc => "Prints all output without unicode characters"
-    class_option :no_colors,       :type => :boolean, :aliases => "--no-color",           :desc => "Prints all output without color"
-    class_option :no_animations,   :type => :boolean,                                     :desc => "Prints all output without animations"
-    class_option :no_landrush,     :type => :boolean,                                     :desc => "Disable landrush for DNS"
-    class_option :no_port_forward, :type => :boolean, :aliases => "--no-port-forwarding", :desc => "Disable automatic port forwarding"
-    class_option :verbose,         :type => :boolean,                                     :desc => "Prints out additional logging information"
-    class_option :dryrun,          :type => :boolean, :aliases => "--dry-run",            :desc => "Run a command without actually executing anything"
-    class_option :nginx,           :type => :boolean, :aliases => "--no-apache",          :desc => "Create conf files for nginx instead of apache"
+    class_option :vm_box,          :type => :string,  :default => nil,                    :desc => ""
+    class_option :vm_path,         :type => :string,  :default => nil,                    :desc => ""
+    class_option :vm_ip,           :type => :string,  :default => nil,                    :desc => ""
+    class_option :vm_prefix,       :type => :string,  :default => nil,                    :desc => ""
+    class_option :yolo,            :type => :boolean,                                     :desc => ""
+    class_option :boring,          :type => :boolean,                                     :desc => ""
+    class_option :no_unicode,      :type => :boolean,                                     :desc => ""
+    class_option :no_colors,       :type => :boolean, :aliases => "--no-color",           :desc => ""
+    class_option :no_animations,   :type => :boolean,                                     :desc => ""
+    class_option :no_landrush,     :type => :boolean,                                     :desc => ""
+    class_option :no_port_forward, :type => :boolean, :aliases => "--no-port-forwarding", :desc => ""
+    class_option :verbose,         :type => :boolean,                                     :desc => ""
+    class_option :dryrun,          :type => :boolean, :aliases => "--dry-run",            :desc => ""
+    class_option :nginx,           :type => :boolean, :aliases => "--no-apache",          :desc => ""
 
     desc "--help, -h", "View man page"
     def help(command = nil)
@@ -96,51 +96,51 @@ module ThemeJuice
     end
 
     desc "create", "Create new project"
-    method_option :name,         :type => :string,  :aliases => "-n", :default => nil, :desc => "Name of the project"
-    method_option :location,     :type => :string,  :aliases => "-l", :default => nil, :desc => "Location of the local project"
-    method_option :theme,        :type => :string,  :aliases => "-t", :default => nil, :desc => "Starter theme to install"
-    method_option :url,          :type => :string,  :aliases => "-u", :default => nil, :desc => "Development URL for the project"
-    method_option :repository,   :type => :string,  :aliases => "-r",                  :desc => "Initialize a new Git remote repository"
-    method_option :db_import,    :type => :string,  :aliases => %w[-i --import-db],    :desc => "Import an existing database"
-    method_option :bare,         :type => :boolean, :aliases => %w[--no-theme],        :desc => "Create a project without a starter theme"
-    method_option :skip_repo,    :type => :boolean,                                    :desc => "Skip repository prompts and use default settings"
-    method_option :skip_db,      :type => :boolean,                                    :desc => "Skip database prompts and use default settings"
-    method_option :use_defaults, :type => :boolean,                                    :desc => "Skip all prompts and use default settings"
-    method_option :no_wp,        :type => :boolean,                                    :desc => "Project is not a WordPress install"
-    method_option :no_db,        :type => :boolean,                                    :desc => "Project does not need a database"
+    method_option :name,         :type => :string,  :aliases => "-n", :default => nil, :desc => ""
+    method_option :location,     :type => :string,  :aliases => "-l", :default => nil, :desc => ""
+    method_option :theme,        :type => :string,  :aliases => "-t", :default => nil, :desc => ""
+    method_option :url,          :type => :string,  :aliases => "-u", :default => nil, :desc => ""
+    method_option :repository,   :type => :string,  :aliases => "-r",                  :desc => ""
+    method_option :db_import,    :type => :string,  :aliases => %w[-i --import-db],    :desc => ""
+    method_option :bare,         :type => :boolean, :aliases => %w[--no-theme],        :desc => ""
+    method_option :skip_repo,    :type => :boolean,                                    :desc => ""
+    method_option :skip_db,      :type => :boolean,                                    :desc => ""
+    method_option :use_defaults, :type => :boolean,                                    :desc => ""
+    method_option :no_wp,        :type => :boolean,                                    :desc => ""
+    method_option :no_db,        :type => :boolean,                                    :desc => ""
     def create
       @io.hello
       @create.new(options).execute
     end
 
     desc "setup", "Setup existing project"
-    method_option :name,         :type => :string,  :aliases => "-n", :default => nil, :desc => "Name of the project"
-    method_option :location,     :type => :string,  :aliases => "-l", :default => nil, :desc => "Location of the local project"
-    method_option :url,          :type => :string,  :aliases => "-u", :default => nil, :desc => "Development URL for the project"
-    method_option :repository,   :type => :string,  :aliases => "-r",                  :desc => "Initialize a new Git remote repository"
-    method_option :db_import,    :type => :string,  :aliases => %w[-i --import-db],    :desc => "Import an existing database"
-    method_option :skip_repo,    :type => :boolean,                                    :desc => "Skip repository prompts and use default settings"
-    method_option :skip_db,      :type => :boolean,                                    :desc => "Skip database prompts and use default settings"
-    method_option :use_defaults, :type => :boolean,                                    :desc => "Skip all prompts and use default settings"
-    method_option :no_wp,        :type => :boolean,                                    :desc => "Project is not a WordPress install"
-    method_option :no_db,        :type => :boolean,                                    :desc => "Project does not need a database"
+    method_option :name,         :type => :string,  :aliases => "-n", :default => nil, :desc => ""
+    method_option :location,     :type => :string,  :aliases => "-l", :default => nil, :desc => ""
+    method_option :url,          :type => :string,  :aliases => "-u", :default => nil, :desc => ""
+    method_option :repository,   :type => :string,  :aliases => "-r",                  :desc => ""
+    method_option :db_import,    :type => :string,  :aliases => %w[-i --import-db],    :desc => ""
+    method_option :skip_repo,    :type => :boolean,                                    :desc => ""
+    method_option :skip_db,      :type => :boolean,                                    :desc => ""
+    method_option :use_defaults, :type => :boolean,                                    :desc => ""
+    method_option :no_wp,        :type => :boolean,                                    :desc => ""
+    method_option :no_db,        :type => :boolean,                                    :desc => ""
     def setup
       @io.hello
       @create.new(options.dup.merge(:bare => true)).execute
     end
 
     desc "delete", "Delete a project (does not delete local project)"
-    method_option :name,       :type => :string,  :aliases => "-n", :default => nil, :desc => "Name of the project"
-    method_option :url,        :type => :string,  :aliases => "-u", :default => nil, :desc => "Development URL for the project"
-    method_option :db_drop,    :type => :boolean, :aliases => "--drop-db",           :desc => "Drop the project's database"
-    method_option :vm_restart, :type => :boolean, :aliases => "--restart-vm",        :desc => "Restart the VM after deletion"
+    method_option :name,       :type => :string,  :aliases => "-n", :default => nil, :desc => ""
+    method_option :url,        :type => :string,  :aliases => "-u", :default => nil, :desc => ""
+    method_option :db_drop,    :type => :boolean, :aliases => "--drop-db",           :desc => ""
+    method_option :vm_restart, :type => :boolean, :aliases => "--restart-vm",        :desc => ""
     def delete
       @delete.new(options).unexecute
     end
 
-    desc "deploy", "Deploy a project"
-    def deploy
-      @deploy.new(options).execute
+    desc "deploy STAGE [,ARGS]", "Deploy a project"
+    def deploy(stage, *args)
+      @deploy.new(options).send(stage, *args).execute
     end
 
     desc "list", "List all projects"
@@ -149,54 +149,54 @@ module ThemeJuice
     end
 
     desc "update", "Update tj and its dependencies"
-    def update(*commands)
+    def update(*args)
       @io.error "Not implemented"
     end
 
     desc "install", "Run theme installation"
-    def install(*commands)
-      @config.install commands
+    def install(*args)
+      @config.command :install, args
     end
 
-    desc "watch [COMMANDS]", "Manage development build tools"
-    def watch(*commands)
-      @config.watch commands
+    desc "watch [ARGS]", "Manage development build tools"
+    def watch(*args)
+      @config.command :watch, args
     end
 
-    desc "assets [COMMANDS]", "Manage front-end dependencies"
-    def assets(*commands)
-      @config.assets commands
+    desc "assets [ARGS]", "Manage front-end dependencies"
+    def assets(*args)
+      @config.command :assets, args
     end
 
-    desc "vendor [COMMANDS]", "Manage back-end dependencies"
-    def vendor(*commands)
-      @config.vendor commands
+    desc "vendor [ARGS]", "Manage back-end dependencies"
+    def vendor(*args)
+      @config.command :vendor, args
     end
 
-    desc "dist [COMMANDS]", "Package project for distribution"
-    def dist(*commands)
-      @config.dist commands
+    desc "dist [ARGS]", "Package project for distribution"
+    def dist(*args)
+      @config.command :dist, args
     end
 
-    desc "wp [COMMANDS]", "Manage WordPress installation"
-    def wp(*commands)
-      @config.wp commands
+    desc "wp [ARGS]", "Manage WordPress installation"
+    def wp(*args)
+      @config.command :wp, args
     end
 
-    desc "backup [COMMANDS]", "Backup project"
-    def backup(*commands)
-      @config.backup commands
+    desc "backup [ARGS]", "Backup project"
+    def backup(*args)
+      @config.command :backup, args
     end
 
-    desc "test [COMMANDS]", "Manage and run project tests"
-    def test(*commands)
-      @config.test commands
+    desc "test [ARGS]", "Manage and run project tests"
+    def test(*args)
+      @config.command :test, args
     end
 
-    desc "vm [COMMANDS]", "Manage development environment"
-    def vm(*commands)
+    desc "vm [ARGS]", "Manage development environment"
+    def vm(*args)
       @util.inside @env.vm_path do
-        @util.run "vagrant #{commands.join(" ")}", :verbose => @env.verbose
+        @util.run "vagrant #{args.join(" ")}", :verbose => @env.verbose
       end
     end
   end

data/lib/theme-juice/commands/deploy.rb

@@ -6,7 +6,27 @@ module ThemeJuice
 
       def initialize(opts = {})
         super
-        runner { @io.error "Not implemented" }
+
+        @config.deployment.stages.keys.each do |stage|
+          self.class.send :define_method, stage do |*args|
+            @env.cap   = Capistrano::Application.new
+            @env.stage = stage.to_sym
+
+            runner do |tasks|
+              tasks << Tasks::Stage.new
+              tasks << Tasks::VMStage.new
+              tasks << Tasks::Settings.new
+              tasks << Tasks::Load.new
+              tasks << Tasks::Invoke.new(args)
+            end
+
+            self
+          end
+        end
+      end
+
+      def method_missing(method, *args, &block)
+        @io.error "It looks like the stage '#{method}' doesn't exist"
       end
     end
   end

data/lib/theme-juice/config.rb

@@ -7,18 +7,21 @@ module ThemeJuice
     @project = Project
     @util    = Util.new
 
-    def method_missing(method, *args, &block)
-      @project.location ||= Dir.pwd
-
+    def command(sequence, *args)
       begin
-        config.fetch("commands", {})
-          .fetch("#{method}") { @io.error "Command '#{method}' not found in config", NotImplementedError }
-          .each { |cmd| run format_command(cmd, *args) }
+        config.commands.fetch("#{sequence}") {
+          @io.error "Command '#{sequence}' not found in config", NotImplementedError }
+          .each { |c| run format_command(c, *args) }
       rescue NoMethodError
         @io.say "Skipping...", :color => :yellow, :icon => :notice
       end
     end
 
+    def deployment
+      config.deployment ||
+        @io.error("Deployment settings not found in config", NotImplementedError)
+    end
+
     private
 
     def run(command)
@@ -40,7 +43,10 @@ module ThemeJuice
 
     def config
       begin
-        YAML.load_file Dir["#{@project.location}/*"].select { |f| config_regex =~ File.basename(f) }.last ||
+        @project.location ||= Dir.pwd
+
+        YAML.load_file Dir["#{@project.location}/*"].select { |f|
+          config_regex =~ File.basename(f) }.last ||
           @io.error("Config file not found in '#{@project.location}'", LoadError)
       rescue ::Psych::SyntaxError => err
         @io.error "Config file contains invalid YAML", SyntaxError do
@@ -52,7 +58,7 @@ module ThemeJuice
     end
 
     def config_regex
-      %r{^(((\.)?(tj)|((J|j)uicefile))(.y(a)?ml)?$)}
+      %r{^(((\.)?(tj)|((J|j)uicefile))(\.y(a)?ml)?$)}
     end
 
     def multi_arg_regex