scatter_deploy 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6af75dd747591b2a9d664067d433790713a76ebe
-  data.tar.gz: 5efbd7958b3e24468a613ab01fe2ea50ecc8407c
+  metadata.gz: 7bab3406e28bb818ffeb59f27b97313773833b01
+  data.tar.gz: 11cd3b6e94c18dc1e998cecc61c302e07f9a98dd
 SHA512:
-  metadata.gz: 34b265d0a713f0f0be7efdfa051be30435412126905caa3a158b7557cb401e1b062f905bc0aa102a3630fe0ca066161649e420376c38fc20ddb220e22150d7a0
-  data.tar.gz: eb12b87e636831e94d303ad6cbcf4d1b6678d3a50b217f5bb55b2b53df6a050176b077a5105b6d25570916372369802967d88a0f5dd0fdd5c82f453f2f13c0da
+  metadata.gz: 9c1ca71a24eceb70a5e25ce26282350329244a0896f94199a48c1235e4a7d33688ef00240298bee4fdff41fa91696334911ca755f10f9023a0a7e7d3e777a6b8
+  data.tar.gz: b65b6885d64853c74a23cd63d4dd50e4fc51be633c7c71eb51b01a57e3e2d4814a908c2dfe99866f0bbd8443dbaf3d29f3dede5ede471887a731f99df5b8a38c

data/README.md

@@ -49,9 +49,40 @@ Let's you run arbitrary Capistrano commands, e.g. `scatter cap nginx:restart`.
 
 Let's you run arbitrary shell commands in the project-specific deploy directory, e.g. `scatter exec ls`.
 
+## Config
+
+You can set default configuration options in `~/.scatterconfig` using YAML.  Currently used settings are:
+
+* `directory` (string): Sets your default deploys directory, acts like using the `--directory` flag without having to specify it each time.
+* `aliases` (array): Aliases Scatter commands to other Scatter commands.  For example, you could alias `scatter foo` to `scatter -p ~/code/foo -d ~/.foodeploys`.  Aliases will *always* prepend `scatter` to the aliased command.
+
+Scatter exposes `config` and `alias` commands to manage these settings.  You can also manually edit `~/.scatterconfig`.  Here's an example config file:
+
+```yml
+---
+directory: /Users/evan/code/mydeploys
+aliases:
+  wp: -s wp
+  rgem: -s gem
+  foo: -p ~/code/foo -d ~/code/foodeploys
+```
+
+These settings could be achieved with these commands:
+
+```shell
+scatter config directory ~/code/mydeploys
+scatter alias wp "-s wp"
+scatter alias gem "-s gem"
+scatter alias foo "-p ~/code/foo -d ~/code/foodeploys"
+```
+
 ## 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.
+
+### WordPress
+
+One of my use cases for Scatter is deploying WordPress plugins versioned with Git to WordPress.org, which uses Subversion.  I wrote a post on how I use Scatter to do it: [Git, WordPress plugins, and a bit of sanity: Scatter](http://evansolomon.me/notes/git-wordpress-plugins-and-a-bit-of-sanity-scatter/).

data/lib/scatter/cli.rb

@@ -1,4 +1,5 @@
 require 'thor'
+require 'scatter/config'
 
 module Scatter
   class CLI < Thor
@@ -6,7 +7,7 @@ module Scatter
     class_option :directory,
       :aliases => "-d",
       :type => :string,
-      :default => "#{Dir.home}/.deploys",
+      :default => Config.get('directory'),
       :desc => "Specify a deploys directory."
 
     class_option :project,
@@ -41,7 +42,39 @@ module Scatter
       say Scatter::VERSION
     end
 
+    desc "alias FROM, TO", "Create an aliased Scatter command"
+    def alias(from, *to)
+      config = Config.get
+      config['aliases'] ||= {}
+      config['aliases'][from] = to.join ' '
+      Config.save config
+
+      say Config.show 'aliases'
+    end
+
+    desc "config SETTING, VALUE", "Set a default config option in ~/.scatterconfig"
+    method_option :show, :type => :boolean, :desc => "Show your current config settings"
+    def config(*args)
+      unless options.show
+        abort "Incorrect number of arguments" unless args.length == 2
+        setting = args.first
+        value = args.last
+        Config.set setting, value
+      end
+
+      say Config.show
+    end
+
     no_tasks do
+      # Process aliases
+      def method_missing(method, *args)
+        aliases  = Config.get 'aliases'
+        _method  = method.to_s
+
+        return super unless aliases.has_key?(_method) and aliases[_method].is_a?(String)
+        system "scatter #{aliases[_method]}"
+      end
+
       def git?
         unless system "which git >/dev/null 2>&1"
           abort "Scatter requires Git if you want it to find projects automatically"
@@ -74,11 +107,11 @@ module Scatter
         deploy = "#{project_deploy_dir}/deploy"
         return false unless File.exists? deploy
 
-        if File.executable? deploy
-          return true
-        else
+        unless File.executable? deploy
           abort "It looks like you have a deploy file, but it's not executable. Try something like: chmod +x #{deploy}"
         end
+
+        return true
       end
 
       def generate_command
@@ -88,13 +121,8 @@ module Scatter
       end
 
       def run(command=nil)
-        unless project_deploy_dir
-          abort "No deploy directory found"
-        end
-
-        unless command ||= generate_command
-          abort "No deploy command found"
-        end
+        abort "No deploy directory found" unless project_deploy_dir
+        abort "No deploy command found"   unless command ||= generate_command
 
         system "cd #{project_deploy_dir} && #{command}"
       end

data/lib/scatter/config.rb

@@ -0,0 +1,45 @@
+require 'yaml'
+
+module Scatter
+  class Config
+    CONFIG_FILE = "#{Dir.home}/.scatterconfig"
+    DEFAULTS = {'directory' => "#{Dir.home}/.deploys"}
+
+    def self.parse
+      return DEFAULTS unless File.exists? CONFIG_FILE
+
+      begin
+        return DEFAULTS.merge YAML.load(File.read CONFIG_FILE)
+      rescue
+        abort "There was a problem parsing #{CONFIG_FILE}, it should be valid YAML"
+      end
+    end
+
+    def self.get(key=nil)
+      config = self.parse
+      key ? config[key] : config
+    end
+
+    def self.save(options)
+      File.open(CONFIG_FILE, 'w') do |f|
+        f.write options.to_yaml
+      end
+    end
+
+    def self.set(key, value)
+      config = get
+      config[key] = value
+      save config
+    end
+
+    def self.show(key=nil)
+      if key
+        value = get[key]
+      else
+        value = get
+      end
+
+      value.to_yaml
+    end
+  end
+end

data/lib/scatter.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scatter_deploy
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - Evan Solomon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-21 00:00:00.000000000 Z
+date: 2013-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -50,6 +50,7 @@ files:
 - MIT-LICENSE
 - bin/scatter
 - lib/scatter/cli.rb
+- lib/scatter/config.rb
 - lib/scatter.rb
 homepage: http://evansolomon.me/
 licenses: