scatter_deploy 0.1.0 → 0.1.1

data/README.md

@@ -1,3 +1,57 @@
 # Scatter
 
 A deploy helper.
+
+## Installation
+
+`gem install scatter_deploy`
+
+If your Gem directory is in your `PATH`, you'll now have access to the `scatter` command.  Run `scatter help` for an overview.
+
+## Usage
+
+You interact with Scatter through the `scatter` command.  You can see a basic overview with `scatter help`.
+
+```
+Tasks:
+  scatter cap COMMAND      # Run arbitrary Capistrano commands.
+  scatter deploy           # Run a deploy routine. This is the default task.
+  scatter execute COMMAND  # Run arbitrary commands.
+  scatter help [TASK]      # Describe available tasks or one specific task
+  scatter version          # Show version.
+
+Options:
+  -d, [--directory=DIRECTORY]  # Specify a deploys directory.
+                               # Default: /Users/evan/.deploys
+  -p, [--project=PROJECT]      # Specify a project path, defaults to current Git repository root.
+  -s, [--shared=SHARED]        # Use a deploy script in the __shared directory. The project path will automatically be passed as an argument
+```
+
+All commands take three optional flags, `--directory`, `--project`, and `--shared`.
+
+## Flags
+
+* `--directory`, `-d`: Specify the root of your deploys directory. Defaults to `~/.deploys`.
+* `--project`, `-p`: Specify a path to a project (relative or absolute). Defaults to the root of the current Git repository, if one exists.  If you're not in a Git repository you *must* pass this argument.
+* `--shared`, `-s`: Specify a shared deploy command to use instead of a project-specific script. The absolute project path will be passed as an argument to the command.
+
+## Commands
+
+### `scatter` or `scatter deploy`
+
+Scatter's default task is `deploy`, so running `scatter deploy` is exactly the same as running `scatter`.  The `deploy` command will look first for an executable file called `deploy` in the project-specific deploy directory, then for a `Capfile`.  If it finds an executable, it will run it.  If no executable is found, but a `Capfile` is found, it will run `cap deploy`.
+
+### `scatter cap COMMAND`
+
+Let's you run arbitrary Capistrano commands, e.g. `scatter cap nginx:restart`.  All commands will be proxied to the project-specific deploy directory, which must contain a `Capfile` and config.
+
+### `scatter exec COMMAND`
+
+Let's you run arbitrary shell commands in the project-specific deploy directory, e.g. `scatter exec ls`.
+
+## Examples
+
+* `scatter`: Deploy the current project.
+* `scatter -p projectname`: Deploy the project in `./projectname`.
+* `scatter -p ~/projectname`: Deploy the project in your home directory's `projectname` directory.
+* `scatter -s wp`: Deploy the current project by calling `~/.deploys/__shared/wp` and passing your current Git repository's root as an argument.

data/lib/scatter.rb

@@ -1,5 +1,5 @@
 require 'scatter/cli'
 
 module Scatter
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/scatter/cli.rb

@@ -12,12 +12,12 @@ module Scatter
     class_option :project,
       :aliases => "-p",
       :type => :string,
-      :desc => "Specify a project, defaults to current Git root's basename."
+      :desc => "Specify a project path, defaults to current Git repository root."
 
     class_option :shared,
       :aliases => "-s",
       :type => :string,
-      :desc => "Use a deploy script in the __shared directory. The project name will automatically be passed as an argument"
+      :desc => "Use a deploy script in the __shared directory. The project path will automatically be passed as an argument"
 
     desc "deploy", "Run a deploy routine. This is the default task."
     def deploy
@@ -27,11 +27,11 @@ module Scatter
 
     desc "cap COMMAND", "Run arbitrary Capistrano commands."
     def cap(*cmd)
-      execute "cap", cmd
+      exec "cap", cmd
     end
 
-    desc "execute COMMAND", "Run arbitrary commands."
-    def execute(*cmd)
+    desc "exec COMMAND", "Run arbitrary commands."
+    def exec(*cmd)
       run cmd.join ' '
     end
 
@@ -46,14 +46,20 @@ module Scatter
       `git rev-parse --is-inside-work-tree 2>/dev/null`.match "^true"
     end
 
-    def project_name
-      return options.project if options.project
-      File.basename `git rev-parse --show-toplevel`.chomp if git?
+    def project_path
+      if options.project
+        File.expand_path options.project
+      elsif git?
+        `git rev-parse --show-toplevel`.chomp
+      end
     end
 
     def project_deploy_dir
-      return "#{options.directory}/__shared" if options.shared
-      "#{options.directory}/#{project_name}"
+      if options.shared
+        "#{options.directory}/__shared"
+      elsif project_path
+        "#{options.directory}/#{File.basename project_path}"
+      end
     end
 
     def capfile?
@@ -66,7 +72,7 @@ module Scatter
     end
 
     def generate_command
-      return "./#{options.shared} #{project_name}" if options.shared
+      return "./#{options.shared} #{project_path}" if options.shared
       return "./deploy" if executable?
       return "cap deploy" if capfile?
     end
@@ -77,9 +83,7 @@ module Scatter
         return
       end
 
-      command = generate_command unless command
-
-      unless command
+      unless command ||= generate_command
         say "No deploy command found"
         return
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scatter_deploy
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors: