theme-juice 0.7.14 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7ed570de1bcd5ee6386340c1e7fbfcf78e3f925f
-  data.tar.gz: ea4347cfbae407def5d4e3e08dcfaf36e0b2df50
+  metadata.gz: d50dfbc36432478d991daefbc81e53ddcd798df3
+  data.tar.gz: e8e747c5a0241e2a9f7d47587082289202ac6b98
 SHA512:
-  metadata.gz: 9fdf9dcd399513e6fcab32b505831207c9f346bc90c74385706890e141b49e61ffd8ca3b8fa2004e52087a9debf4659183646e8300b6db5174e31de0fad5dd6c
-  data.tar.gz: 9659e9842b6f24ef06947590ac048a9eb2a731f928e0a4b01b7248f73ba6325acad8ad3a0e72056d8bee10b9587812d22c71df02d0b882fc64e012178879f084
+  metadata.gz: 162908ca692a307bec00807795c192715844ba0ae37026bfb2f6a3d53bc39f3b9d20f1e1fed7256da2dd57b13cafa95ccb58469a36959f08bf3c153e57b7cc83
+  data.tar.gz: 065bb0c1940a1f74837e0ed820ada4c5fc24c65034d028e45355e62112b0377d6de0889615f8ecc9dee47682859e3660f211c461b1f70cca2a49a51acbf5d142

data/README.md

@@ -5,38 +5,14 @@
 [![Code Climate](https://img.shields.io/codeclimate/coverage/github/ezekg/theme-juice-cli.svg?style=flat-square)]()
 [![GitHub license](https://img.shields.io/github/license/ezekg/theme-juice-cli.svg?style=flat-square)](https://github.com/ezekg/theme-juice-cli/blob/master/LICENSE)
 
+_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, but with that said, we will of course semantically version all of our releases. Feel free to contribute to the development with new features or bug fixes. [View our contributing guidelines](#contributing)_
+
 ## What is it?
 Theme Juice is a WordPress development command line utility that allows you to scaffold out entire Vagrant development environments in seconds (using [VVV](https://github.com/Varying-Vagrant-Vagrants/VVV) as the VM), manage dependencies and build tools, and even handle deployments.
 
-### But Why?
-This project sprung out of an annoyance for the current workflow associated with WordPress and development in general. Things like:
-* Local development. It's insanely hard (and intimidating!) for non-ops/CS engineers.
-* WAMP/LAMP sucks.
-* The local env setup process is monotonous. It's the same thing _over and over again_, aside from a couple variables here and there.
-* It seems as though every few months a new build tool comes out, so you end up with projects created within the range of just a year or 2 having _completely_ different build tools. Does this project use Grunt? Guard? Oh, I see, it's using Gulp! No thanks.
-* Dependency management for WordPress is terrible.
-* A decent Git workflow for WordPress is even more terrible. Bloated repositories, out of date plugins, out of date core. It's a nightmare.
-* Given all of that, projects are hard to maintain, especially across multiple environments. It's hard to onboard new team members. It just sucks.
-
-In order to remedy most of those, I created a little Rake script that automated things like scaffolding out a new development site and also aliasing a few of the build tools that I used. A couple months later, I extracted that out to a little gem so that it didn't have to sit inside of a `Rakefile` (mainly because it utilized the oh-so-efficient copy-and-paste update method).
-
-After using it for a few more months, adding features here and there, I realized how much it had changed my workflow. I was spending less time fighting the tools I wanted to use, and more time on our projects doing what I love (coding!). It sped up our workflow and made coding more enjoyable. The project really started to evolve into a true command line utility from there.
-
-Another month or so down the line, I wanted to move `tj` out of alpha and really give it the attention and structure it deserved. So I spent a few more months doing a complete rewrite, learning a ton along the way. I bought a few books like [Design Patterns in Ruby](http://designpatternsinruby.com/) and gradually built up my Ruby skills. One thing I really wanted to focus on was _convention over configuration_, because most people don't care about the details; they want a local development site _that just works_.
-
-Fast forward to now, and `tj` has become a staple for our WordPress development. It really has changed the way we do things. Enjoy.
-
 ## Installation
 * First, install [Vagrant](https://www.vagrantup.com/) and [VirtualBox](https://www.virtualbox.org/) for local development.
-* Then, install these command line tools (most starter themes will use a combination of these):
-  * [Composer](https://getcomposer.org/)
-  * [NPM](https://www.npmjs.com/) ([Here's a good guide on properly installing NPM to not need `sudo`](http://www.johnpapa.net/how-to-use-npm-global-without-sudo-on-osx/))
-  * [Grunt-CLI](http://gruntjs.com/)
-  * [Gulp-CLI](http://gulpjs.com/)
-  * [Bower](http://bower.io/)
-  * [WP-CLI](http://wp-cli.org/)
-  * Make sure they're executable without `sudo`
-* Finally, install with: `gem install theme-juice`
+* Then install with: `gem install theme-juice`
 * That's it!
 
 ## Windows users
@@ -92,150 +68,16 @@ You can specify an unlimited number of commands with an unlimited number of argu
 
 ## Usage
 
-### List available commands:
-List all commands for `tj`.
-```bash
-tj
-```
-
-### Print version:
-This command will print the current version of `tj`.
-```bash
-tj --version # Aliases: -v version
-```
+Use the `man` page to print command usage:
 
-### Global flags:
-| Flag                   | Type   | Description                                |
-|:---------------------- |:------ |:------------------------------------------ |
-| `[--vm-path=PATH]`     | Path   | Force path to VM                           |
-| `[--vm-ip=IP]`         | String | Force IP address for VM                    |
-| `[--vm-prefix=PREFIX]` | String | Force directory prefix for project in VM   |
-| `[--yolo]`             | Bool   | Say yes to anything and everything         |
-| `[--boring]`           | Bool   | Disable all the coolness                   |
-| `[--no-unicode]`       | Bool   | Disable all unicode characters             |
-| `[--no-colors]`        | Bool   | Disable all colored output                 |
-| `[--no-animations]`    | Bool   | Disable all animations                     |
-| `[--no-landrush]`      | Bool   | Disable landrush for DNS                   |
-| `[--verbose]`          | Bool   | Verbose output                             |
-| `[--dryrun]`           | Bool   | Disable executing any commands             |
-
-_Use `ENV` variables to set global flags. For example, by running `export TJ_VM_PATH=~/vagrant-vvv`, the `ENV` variable will be used instead of the default `vm-path` from then on. You can remove global flags with `unset TJ_VM_PATH`_
-
-### Creating a new development project:
-Use this to create a new project. It will automagically set up your VM, including a local development site at `http://<url>.dev` with WordPress installed and a fresh WP database. It will sync up your local site installation with the Vagrant VM, so you can organize your projects however you want. This task will also install VVV into your `vm-path` directory if it has not already been installed.
-```bash
-tj create # Aliases: mk new
 ```
-
-#### Option flags:
-| Flag                                | Type   | Description                                      |
-|:----------------------------------- |:------ |:------------------------------------------------ |
-| `[-n, --name=NAME]`                 | String | Name of the project                              |
-| `[-l, --location=LOCATION]`         | Path   | Location of the local project                    |
-| `[-t, --theme=THEME]`               | URL    | Starter theme to install                         |
-| `[-u, --url=URL]`                   | URL    | Development URL for the project                  |
-| `[-r, --repository=REPO]`           | URL    | Initialize a new Git remote repository           |
-| `[-i, --import-db=DB]`              | Path   | Import an existing database                      |
-| `[--bare]`                          | Bool   | Create a project without a starter theme         |
-| `[--skip-repo]`                     | Bool   | Skip repository prompts and use default settings |
-| `[--skip-db]`                       | Bool   | Skip database prompts and use default settings   |
-| `[--use-defaults]`                  | Bool   | Skip all prompts and use default settings        |
-| `[--no-wp]`                         | Bool   | New project is not a WordPress install           |
-| `[--no-db]`                         | Bool   | New project does not need a database             |
-
-### Setting up an existing project:
-Use this to setup an existing local project within the development environment. You will go through the setup process to create the necessary files for the VM, including `vvv-hosts`, `vvv-nginx.conf`, DNS settings, and a fresh database (unless one already exists by the name chosen). This is essentially an alias for `create`, but with a few options being skipped.
-```bash
-tj setup # Aliases: up init
-```
-
-#### Option flags:
-| Flag                                | Type   | Description                                      |
-|:----------------------------------- |:------ |:------------------------------------------------ |
-| `[-n, --name=NAME]`                 | String | Name of the project                              |
-| `[-l, --location=LOCATION]`         | Path   | Location of the local project                    |
-| `[-u, --url=URL]`                   | URL    | Development URL for the project                  |
-| `[-r, --repository=REPO]`           | URL    | Initialize a new Git remote repository           |
-| `[-i, --import-db=DB]`              | Path   | Import an existing database                      |
-| `[--skip-repo]`                     | Bool   | Skip repository prompts and use default settings |
-| `[--skip-db]`                       | Bool   | Skip database prompts and use default settings   |
-| `[--use-defaults]`                  | Bool   | Skip all prompts and use default settings        |
-| `[--no-wp]`                         | Bool   | New project is not a WordPress install           |
-| `[--no-db]`                         | Bool   | New project does not need a database             |
-
-### Deleting a project from the VM:
-Use this to remove a project from your development environment. This will only remove files that were generated by `tj`. including the database setup, development url, and shared directories. _It will not touch your local folders that were synced to the VM._
-```bash
-tj delete # Aliases: rm remove trash
-```
-
-#### Option flags:
-| Flag                | Type   | Description                     |
-|:------------------- |:------ |:------------------------------- |
-| `[-n, --name=NAME]` | String | Name of the project             |
-| `[-u, --url=URL]`   | URL    | Development URL for the project |
-| `[--db-drop]`       | Bool   | Drop project's database         |
-| `[--vm-restart]`    | Bool   | Restart VM after deletion       |
-
-### Managing deployment and migration (coming soon):
-```bash
-tj deploy # Aliases: server remote
-```
-
-### Listing all `tj` projects in the VM:
-Use this to list all projects within your VM that were generated by `tj`.
-```bash
-tj list # Aliases: ls projects apps sites
-```
-
-### Managing development environment:
-Use this to easily manage your [Varying Vagrant Vagrants](https://github.com/Varying-Vagrant-Vagrants/VVV) VM. This is a wrapper for Vagrant commands executed within your VM path.
-```bash
-tj vm # Aliases: vagrant vvv
-```
-
-### Running installation for project:
-Uses `install` command within your config.
-```bash
-tj install # Aliases: build
-```
-
-### Watching and compiling assets:
-Use this to watch and compile assets with your preferred build tool, whether that be [Grunt](https://github.com/gruntjs/grunt), [Gulp](https://github.com/gulpjs/gulp), [Guard](https://github.com/guard/guard), or whatever. This is simply a wrapper for whatever command is in your config file.
-```bash
-tj watch # Aliases: dev
-```
-
-### Managing vendor dependencies:
-Use this to easily manage your dependencies with [Composer](https://github.com/composer/composer), or whatever command you set within your config.
-```bash
-tj vendor # Aliases: deps
-```
-
-### Locally executing WP-CLI inside your VM:
-Upon setup, an `ssh` block for the VM is automatically added to the `wp-cli.local.yml` file with all of your VM paths. In our starter theme, we use [wp-cli-ssh](https://github.com/xwp/wp-cli-ssh) to run `wp` commands locally.
-In order to do the same, it needs to be a dependency in your `composer.json`.
-```bash
-tj wp # Aliases: wordpress
-```
-
-### Backing up your database:
-Uses `backup` command within your config.
-```bash
-tj backup # Aliases: bk
-```
-
-### Distributing a package of your project:
-Uses `dist` command within your config.
-```bash
-tj dist # Aliases: zip package pkg
+tj
+tj -h
+tj help
+tj --help
 ```
 
-### Running your test suite:
-Uses `test` command within your config.
-```bash
-tj test # Aliases: tests spec specs
-```
+See [themejuice.it](http://themejuice.it) for the full documentation.
 
 ## Can I add my starter theme, ________?
 Yes! Just update the `THEMES` constant inside [commands/create.rb](https://github.com/ezekg/theme-juice-cli/blob/master/lib/theme-juice/commands/create.rb#L7-L11) and make a pull request. I'll verify that the theme includes a `Juicefile` (not required, but preferred to automate build steps), and that everything looks solid. Until then (or if your theme is private), just run `tj create --theme https://your.repo/link/goes.here` to clone your theme.

data/lib/theme-juice/cli.rb

@@ -6,36 +6,37 @@ module ThemeJuice
     def initialize(*)
       super
 
-      @version           = VERSION
-      @env               = Env
-      @io                = IO
-      @config            = Config
-      @project           = Project
-      @util              = Util.new
-      @list              = Tasks::List
-      @create            = Commands::Create
-      @delete            = Commands::Delete
-      @deploy            = Commands::Deploy
+      @version = VERSION
+      @env     = Env
+      @io      = IO
+      @config  = Config
+      @project = Project
+      @util    = Util.new
+      @list    = Tasks::List
+      @create  = Commands::Create
+      @delete  = Commands::Delete
+      @deploy  = Commands::Deploy
 
       init_env
     end
 
     no_commands do
       def init_env
-        @env.vm_path       = options.fetch "vm_path",       ENV.fetch("TJ_VM_PATH", File.expand_path("~/vagrant"))
-        @env.vm_ip         = options.fetch "vm_ip",         ENV.fetch("TJ_VM_IP", "192.168.50.4")
-        @env.vm_prefix     = options.fetch "vm_prefix",     ENV.fetch("TJ_VM_PREFIX", "tj-")
-        @env.yolo          = options.fetch "yolo",          ENV.fetch("TJ_YOLO", false)
-        @env.boring        = options.fetch "boring",        ENV.fetch("TJ_BORING", false)
-        @env.no_unicode    = options.fetch "no_unicode",    ENV.fetch("TJ_NO_UNICODE", @env.boring)
-        @env.no_colors     = options.fetch "no_colors",     ENV.fetch("TJ_NO_COLORS", @env.boring)
-        @env.no_animations = options.fetch "no_animations", ENV.fetch("TJ_NO_ANIMATIONS", @env.boring)
-        @env.no_landrush   = options.fetch "no_landrush",   ENV.fetch("TJ_NO_LANDRUSH", false)
-        @env.verbose       = options.fetch "verbose",       ENV.fetch("TJ_VERBOSE", false)
-        @env.dryrun        = options.fetch "dryrun",        ENV.fetch("TJ_DRYRUN", false)
+        @env.vm_path       = options[:vm_path]
+        @env.vm_ip         = options[:vm_ip]
+        @env.vm_prefix     = options[:vm_prefix]
+        @env.yolo          = options[:yolo]
+        @env.boring        = options[:boring]
+        @env.no_unicode    = options[:no_unicode]
+        @env.no_colors     = options[:no_colors]
+        @env.no_animations = options[:no_animations]
+        @env.no_landrush   = options[:no_landrush]
+        @env.verbose       = options[:verbose]
+        @env.dryrun        = options[:dryrun]
       end
     end
 
+    map %w[man, doc, docs]         => :help
     map %w[--version -v]           => :version
     map %w[mk new]                 => :create
     map %w[up init]                => :setup
@@ -50,23 +51,40 @@ module ThemeJuice
     map %w[tests spec specs]       => :test
     map %w[server remote]          => :deploy
     map %w[vagrant vvv]            => :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 for 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"
-    class_option :boring,        :type => :boolean,                  :desc => "Disable all the coolness"
-    class_option :no_unicode,    :type => :boolean,                  :desc => "Disable all unicode characters"
-    class_option :no_colors,     :type => :boolean,                  :desc => "Disable all colored output"
-    class_option :no_animations, :type => :boolean,                  :desc => "Disable all animations"
-    class_option :no_landrush,   :type => :boolean,                  :desc => "Disable landrush for DNS"
-    class_option :verbose,       :type => :boolean,                  :desc => "Verbose output"
-    class_option :dryrun,        :type => :boolean,                  :desc => "Disable executing any commands"
+    
+    class_option :vm_box,        :type => :string,  :default => nil,          :desc => "Force Vagrant box for 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 (coming soon)"
+    class_option :no_landrush,   :type => :boolean,                           :desc => "Disable landrush for DNS"
+    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"
+
+    desc "--help, -h", "View man page"
+    def help(command = nil)
+      root = File.expand_path "../man", __FILE__
+      man = ["tj", command].compact.join("-")
+      begin
+        if File.exist? "#{root}/#{man}"
+          if OS.windows?
+            @io.speak File.read "#{root}/#{man}.txt", :color => :white
+          else
+            @util.run "man #{root}/#{man}", :verbose => @env.verbose
+          end
+        else
+          @io.speak "No man page available for '#{command}'", :color => :red
+        end
+      rescue
+        super
+      end
+    end
 
     desc "--version, -v", "Print current version"
-    #
-    # @return {String}
-    #
     def version
       @io.speak @version, :color => :green
     end
@@ -78,15 +96,12 @@ module ThemeJuice
     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,                                    :desc => "Create a project without a starter theme"
+    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 => "New project is not a WordPress install"
-    method_option :no_db,        :type => :boolean,                                    :desc => "New project does not need a database"
-    #
-    # @return {Void}
-    #
+    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"
     def create
       @io.hello
       @create.new(options).execute
@@ -101,115 +116,73 @@ module ThemeJuice
     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 => "New project is not a WordPress install"
-    method_option :no_db,        :type => :boolean,                                    :desc => "New project does not need a database"
-    #
-    # @return {Void}
-    #
+    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"
     def setup
       @io.hello
-      @create.new(options.dup.merge({
-        :theme => false,
-        :bare => true,
-      })).execute
+      @create.new(options.dup.merge(:bare => true)).execute
     end
 
-    desc "delete", "Delete project (does not delete local project)"
+    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 project's database"
-    method_option :vm_restart, :type => :boolean, :aliases => "--restart-vm",        :desc => "Restart VM after deletion"
-    #
-    # @return {Void}
-    #
+    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"
     def delete
       @delete.new(options).unexecute
     end
 
     desc "deploy", "Manage deployment and migration"
-    #
-    # @return {Void}
-    #
     def deploy
       @deploy.new(options).execute
     end
 
     desc "list", "List all projects"
-    #
-    # @return {Void}
-    #
     def list
       @list.new(options).list :projects
     end
 
     desc "update", "Update tj and its dependencies"
-    #
-    # @return {Void}
-    #
     def update(*commands)
       @io.error "Not implemented"
     end
 
     desc "install", "Run installation for project"
-    #
-    # @return {Void}
-    #
     def install(*commands)
       @config.install commands
     end
 
-    desc "watch [COMMANDS]", "Watch and compile assets"
-    #
-    # @return {Void}
-    #
+    desc "watch [COMMANDS]", "Manage development build tools"
     def watch(*commands)
       @config.watch commands
     end
 
     desc "vendor [COMMANDS]", "Manage vendor dependencies"
-    #
-    # @return {Void}
-    #
     def vendor(*commands)
       @config.vendor commands
     end
 
     desc "dist [COMMANDS]", "Package project for distribution"
-    #
-    # @return {Void}
-    #
     def dist(*commands)
       @config.dist commands
     end
 
     desc "wp [COMMANDS]", "Manage WordPress installation"
-    #
-    # @return {Void}
-    #
     def wp(*commands)
       @config.wp commands
     end
 
     desc "backup [COMMANDS]", "Backup project"
-    #
-    # @return {Void}
-    #
     def backup(*commands)
       @config.backup commands
     end
 
     desc "test [COMMANDS]", "Manage and run project tests"
-    #
-    # @return {Void}
-    #
     def test(*commands)
       @config.test commands
     end
 
     desc "vm [COMMANDS]", "Manage development environment"
-    #
-    # @return {Void}
-    #
     def vm(*commands)
       @util.inside @env.vm_path do
         @util.run "vagrant #{commands.join(" ")}", :verbose => @env.verbose