karo 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 661301b756abdfa7df216b4c5f887524d90059dd
-  data.tar.gz: 41b21803c8685a67fa3b3ab022e1373c4dda0cbf
+  metadata.gz: 742fafe45e1d1395f8f579a88b3fb4c537481c91
+  data.tar.gz: c85269a286f75601dfeb54083bc2bad8319b8a2a
 SHA512:
-  metadata.gz: d33e07d1eca2b3743834b7c7c1a727097ed306f7eeb2f5c3e8a99eb3461693302a81020324900dbee6fefbdbcfb518fb5dff95cf837f0ee9930b30b96457bebe
-  data.tar.gz: 45a8b1d2c40f93ebf045de657080c5c5e4b1b922fb83ee01aa5b6ce33872870d1dc6ca21a693a26bac0499495323daa20f176ee11122321f6f1b2e36079175ad
+  metadata.gz: 90bddb90a979c4a9cf146197f04c62d8839f1f1c73e3e89cc2afc776ad10d3820349fdbdd4ae32a76c927fe786b922c7f521598ede759234972be9c25955c4a2
+  data.tar.gz: 46b8df075a2839bd684d6879aa7c5244a1cb1715d07c3e6cae22c6fc68f958b7d3fc2dd74a3f95bc2d17e4611b720d4a38ed661744668263dfda30a625b5490e

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## v1.4.0
+
+### Features
+
+- Added command 'command' to supercede 'on' command and deprecated 'on'
+- Added options to store custom commands for an environment within .karo.yml file
+
 ## v1.3.0
 
 ### Features

data/lib/karo/cli.rb

@@ -8,29 +8,29 @@ require 'ap'
 
 module Karo
 
-	class CLI < Thor
+  class CLI < Thor
 
-		include Thor::Actions
+    include Thor::Actions
 
-	  class_option :config_file, type: :string, default: Config.default_file_name,
-	  						  aliases: "-c", desc: "name of the file containing server configuration"
-	  class_option :environment, aliases: "-e", desc: "server environment", default: "production"
+    class_option :config_file, type: :string, default: Config.default_file_name,
+                  aliases: "-c", desc: "name of the file containing server configuration"
+    class_option :environment, aliases: "-e", desc: "server environment", default: "production"
 
-	  desc "log", "displays server log for a given environment"
-	  def log(name="")
-	    configuration = Config.load_configuration(options)
+    desc "log", "displays server log for a given environment"
+    def log(name="")
+      configuration = Config.load_configuration(options)
 
-	    path = File.join(configuration["path"], "shared/log/#{options["environment"]}.log")
-	    ssh  = "ssh #{configuration["user"]}@#{configuration["host"]}"
+      path = File.join(configuration["path"], "shared/log/#{options["environment"]}.log")
+      ssh  = "ssh #{configuration["user"]}@#{configuration["host"]}"
 
-	    if name.eql?("")
-	    	cmd = "tail -f #{path}"
-	    else
-	    	cmd = "tail #{path} | grep -A 10 -B 10 #{name}"
-	    end
+      if name.eql?("")
+        cmd = "tail -f #{path}"
+      else
+        cmd = "tail #{path} | grep -A 10 -B 10 #{name}"
+      end
 
-	    system "#{ssh} '#{cmd}'"
-	  end
+      system "#{ssh} '#{cmd}'"
+    end
 
     desc "cache [search, remove]", "find or clears a specific or all cache from shared/cache directory on the server"
     subcommand "cache", Cache
@@ -41,68 +41,130 @@ module Karo
     desc "db [pull, push]", "syncs MySQL database between server and localhost"
     subcommand "db", Db
 
-	  desc "config", "displays server configuration stored in a config file"
-	  def config
-	    configuration = Config.load_configuration(options)
-
-	    ap configuration if configuration
-	  end
-
-		def self.source_root
-    	File.dirname(__FILE__)
-  	end
-
-	  desc "generate", "generate a sample configuration file to be used by karo [default is .karo.yml]"
-	  def generate
-			config_file = File.expand_path(options[:config_file])
-	    copy_file 'templates/karo.yml', config_file
-	  end
-
-	  desc "ssh", "open ssh console for a given server environment"
-	  def ssh
-	    configuration = Config.load_configuration(options)
-
-	    path = File.join(configuration["path"], "current")
-	    ssh  = "ssh #{configuration["user"]}@#{configuration["host"]} -t"
-	    cmd  = "cd #{path} && $SHELL"
-	    system "#{ssh} '#{cmd}'"
-	  end
-
-	  desc "console", "open rails console for a given server environment"
-	  def console
-	    configuration = Config.load_configuration(options)
-
-	    path = File.join(configuration["path"], "current")
-	    ssh  = "ssh #{configuration["user"]}@#{configuration["host"]} -t"
-	    cmd  = "cd #{path} && bundle exec rails console #{options[:environment]}"
-	    system "#{ssh} '#{cmd}'"
-	  end
-
-	  desc "top", "run top command on a given server environment"
-	  def top
-	    configuration = Config.load_configuration(options)
-
-	    path = File.join(configuration["path"], "current")
-	    ssh  = "ssh #{configuration["user"]}@#{configuration["host"]} -t"
-	    cmd  = "top"
-	    system "#{ssh} '#{cmd}'"
-	  end
-
-	  desc "on", "run any command within a given server environment"
-	  def on(*tokens)
-	    configuration = Config.load_configuration(options)
-
-	    path = File.join(configuration["path"], "current")
-	    ssh  = "ssh #{configuration["user"]}@#{configuration["host"]}"
-	    cmd  = tokens.join(" ")
-	    system "#{ssh} '#{cmd}'"
-	  end
-
-	  desc "version", "displays karo's current version"
-	  def version
-	  	say Karo::VERSION
-	  end
-
-	end
+    desc "config", "displays server configuration stored in a config file"
+    def config
+      configuration = Config.load_configuration(options)
+
+      ap configuration if configuration
+    end
+
+    def self.source_root
+      File.dirname(__FILE__)
+    end
+
+    desc "generate", "generate a sample configuration file to be used by karo [default is .karo.yml]"
+    def generate
+      config_file = File.expand_path(options[:config_file])
+      copy_file 'templates/karo.yml', config_file
+    end
+
+    desc "ssh", "open ssh console for a given server environment"
+    def ssh
+      configuration = Config.load_configuration(options)
+
+      path = File.join(configuration["path"], "current")
+      ssh  = "ssh #{configuration["user"]}@#{configuration["host"]} -t"
+      cmd  = "cd #{path} && $SHELL"
+      system "#{ssh} '#{cmd}'"
+    end
+
+    desc "console", "open rails console for a given server environment"
+    def console
+      configuration = Config.load_configuration(options)
+
+      path = File.join(configuration["path"], "current")
+      ssh  = "ssh #{configuration["user"]}@#{configuration["host"]} -t"
+      cmd  = "cd #{path} && bundle exec rails console #{options[:environment]}"
+      system "#{ssh} '#{cmd}'"
+    end
+
+    desc "command [COMMAND]", "run any command within a given server environment"
+    method_option :tty, aliases: "-t", desc: "force pseudo-tty allocation",
+                  type: :boolean, default: true
+    long_desc <<-LONGDESC
+    `karo command [command]` or `karo cmd [command]`
+
+    will run the [COMMAND] passed on the server.
+
+    You can optionally pass --no-tty to disable ssh force pseudo-tty allocation
+
+    e.g. Display list of files on the staging server
+
+    > $ karo command ls -e staging --no-tty
+
+    CHANGELOG.md Gemfile.lock README.md
+
+    e.g. Run top command on the production server
+
+    > $ karo command top
+
+    > top - 17:14:06 up 219 days, 11:30,  1 user,  load average: 0.28, 0.49, 0.47
+
+    You can also store custom commands for a given environment in the configuration file
+
+    e.g. .karo.yml
+
+    production:
+
+    --host: example.com
+
+    --user: deploy
+
+    --path: /data/app_name
+
+    --commands:
+
+    ----memory: watch vmstat -sSM
+
+    ----top_5_memory: ps aux | sort -nk +4 | tail
+
+    > $ karo cmd memory
+
+    > Every 2.0s: vmstat -sSM Tue Jul  2 17:18:16 2013
+
+    > 35840140  total memory
+
+    > 35308456  used memory
+
+    > 25224800  active memory
+    LONGDESC
+    def command(cmd)
+      configuration = Config.load_configuration(options)
+
+      ssh  = "ssh #{configuration["user"]}@#{configuration["host"]}"
+
+      # Forces pseudo-tty allocation
+      ssh << " -t" if options[:tty]
+
+      if configuration["commands"] && configuration["commands"][cmd]
+        cmd = configuration["commands"][cmd]
+      end
+
+      system "#{ssh} '#{cmd}'"
+    end
+    map cmd: :command
+
+    desc "on [COMMAND]", "run any command within a given server environment"
+    method_option :tty, aliases: "-t", desc: "force pseudo-tty allocation",
+                  type: :boolean, default: true
+    def on(cmd)
+      say "Deprecated and will be removed in version 2.0", :yellow
+      say "Please use 'command' instead", :yellow
+      invoke :command
+    end
+
+    desc "top", "run top command on a given server environment"
+    method_option :tty, aliases: "-t", desc: "force pseudo-tty allocation",
+                  type: :boolean, default: true
+    def top
+      invoke :command, ["top"]
+    end
+
+    desc "version", "displays karo's current version"
+    def version
+      say Karo::VERSION
+    end
+
+  end
 
 end

data/lib/karo/config.rb

@@ -22,7 +22,9 @@ module Karo
 		  		configuration
 		  	end
 		  rescue Karo::NoConfigFileFoundError
-		  	raise Thor::Error, "Please make sure that this configuration file exists? '#{config_file}'"
+		  	puts "You can use 'karo generate' to generate a skeleton .karo.yml file"
+		  	puts "Please make sure that this configuration file exists? '#{config_file}'"
+		  	raise Thor::Error, "and run the command again"
 		  end
 	  end
 

data/lib/karo/templates/karo.yml

@@ -2,7 +2,12 @@ production:
   host: example.com
   user: deploy
   path: /data/app_name
+  commands:
+    memory: watch vmstat -sSM
+    top_5_memory: ps aux | sort -nk +4 | tail
 staging:
   host: example.com
   user: deploy
   path: /data/app_name
+  commands:
+    memory: vmstat -sSM

data/lib/karo/version.rb

@@ -1,3 +1,3 @@
 module Karo
-  VERSION = "1.3.0"
+  VERSION = "1.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: karo
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Rahul Trikha
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-02 00:00:00.000000000 Z
+date: 2013-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry