foreverb 0.2.1 → 0.2.2

data/CHANGES.md

@@ -0,0 +1,9 @@
+# Version 0.2.2
+
+* Added global monitoring, to easily watch each `foreverb` daemon
+* Look daemons through config file and unix command `ps`
+* Added `start` CLI command
+* Added `restart` CLI command
+* Added `tail` CLI command
+* Added `update` CLI command (useful to update daemons config)
+* Improved documentation (aka the readme)

data/README.md

@@ -207,17 +207,42 @@ you should see:
 [14/07 15:48:40] Bye bye
 ```
 
-## Monitor your daemon(s):
+## CLI
 
-List daemons:
+### Help:
+
+``` sh
+$ foreverb help
+Tasks:
+  foreverb help [TASK]                       # Describe available tasks or one specific task
+  foreverb list                              # List Forever running daemons
+  foreverb restart [DAEMON] [--all] [--yes]  # Restart one or more matching daemons
+  foreverb start [DAEMON] [--all] [--yes]    # Start one or more matching daemons
+  foreverb stop [DAEMON] [--all] [--yes]     # Stop one or more matching daemons
+  foreverb tail [DAEMON]                     # Tail log of first matching daemon
+  foreverb update [DAEMON] [--all] [--yes]   # Update config from one or more matching daemons
+  foreverb version                           # show the version number
+```
+
+### List daemons:
 
 ``` sh
 $ foreverb list
-PID     RSS     CPU   CMD
-19838   32512   1.6   Forever: bin/githubwatcher
+     RUNNING  /Developer/src/Extras/githubwatcher/bin/githubwatcher
+     RUNNING  /Developer/src/Extras/foreverb/examples/sample
+Reading config from: /Users/DAddYE/.foreverb
+```
+
+### Monitor daemons (with ps):
+
+``` sh
+$ foreverb list -m
+PID   RSS     CPU    CMD
+5528  168 Mb  0.1 %  Forever: /Developer/src/Extras/githubwatcher/bin/githubwatcher
+5541  18 Mb   0.0 %  Forever: /Developer/src/Extras/foreverb/examples/sample
 ```
 
-Stop daemon(s):
+### Stop daemon(s):
 
 ``` sh
 $ foreverb stop foo
@@ -229,7 +254,65 @@ Killing process Forever: /usr/bin/githubwatcher with pid 2824
 Killing process Forever: examples/sample with pid 2836
 ```
 
-That's all!
+### Start daemon(s):
+
+``` sh
+$ foreverb start github
+Do you want really start /Developer/src/Extras/githubwatcher/bin/githubwatcher? y
+=> Found pid 5528...
+=> Killing process 5528...
+=> Process demonized with pid 14925 with Forever v.0.2.2
+```
+
+as for stop we allow `--all` and `-y`
+
+### Restart daemon(s)
+
+``` sh
+$ foreverb restart github
+Do you want really restart /Developer/src/Extras/githubwatcher/bin/githubwatcher? y
+=> Found pid 5528...
+=> Killing process 5528...
+=> Process demonized with pid 14925 with Forever v.0.2.2
+```
+
+as for stop we allow `--all` and `-y`
+
+### Tail logs
+
+``` sh
+$ foreverb tail github
+[22/07 11:22:17] Quering git://github.com/DAddYE/lipsiadmin.git...
+[22/07 11:22:17] Quering git://github.com/DAddYE/lightbox.git...
+[22/07 11:22:17] Quering git://github.com/DAddYE/exception-notifier.git...
+[22/07 11:22:17] Quering git://github.com/DAddYE/lipsiablog.git...
+[22/07 11:22:17] Quering git://github.com/DAddYE/purple_ruby.git...
+```
+
+you can specify how many lines show with option `-n`, default is `150`
+
+### Update config
+
+This command would be helpful if you change `pid` `log` path, in this way the global config file `~/.foreverb` will be update
+using latest informations from yours deamons
+
+Note that you can personalize the config file setting `FOREVER_PATH` matching your needs.
+
+``` sh
+$ foreverb update github
+Do you want really update config from /Developer/src/Extras/githubwatcher/bin/githubwatcher? y
+```
+
+as for stop we allow `--all` and `-y`
+
+## HACKS
+
+Bundler has the bad behavior to load `Gemfile` from your current path, so if your `daemons` (ex: [githubwatcher](https://github.com/daddye/githubwatcher))
+is shipped with their own `Gemfile` to prevent errors you must insert that line:
+
+``` ruby
+ENV['BUNDLE_GEMFILE'] = File.expand_path('../../Gemfile', __FILE__) # edit matching your Gemfile path
+```
 
 ## Extras
 
@@ -237,4 +320,20 @@ To see a most comprensive app running _foreverb_ + _growl_ see [githubwatcher ge
 
 ## Author
 
-DAddYE, you can follow me on twitter [@daddye](http://twitter.com/daddye) or take a look at my site [daddye.it](http://www.daddye.it)
+DAddYE, you can follow me on twitter [@daddye](http://twitter.com/daddye) or take a look at my site [daddye.it](http://www.daddye.it)
+
+## Copyright
+
+Copyright (C) 2011 Davide D'Agostino - [@daddye](http://twitter.com/daddye)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
+associated documentation files (the “Software”), to deal in the Software without restriction, including without
+limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
+and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM,
+DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/bin/foreverb

@@ -2,35 +2,81 @@
 require 'rubygems' unless defined?(Gem)
 require File.expand_path('../../lib/forever/version.rb', __FILE__)
 require 'thor'
+require 'yaml'
 
-class CLI < Thor
+FOREVER_PATH = ENV['FOREVER_PATH'] ||= File.expand_path("~/.foreverb") unless defined?(FOREVER_PATH)
 
+class CLI < Thor
 
-  desc "list", "List Forever daemons"
+  desc "list", "List Forever running daemons"
+  method_option :monitor, :type => :boolean, :aliases => "-m", :default => false, :desc => "Show memory and cpu usage with ps"
   def list
-    say "PID\tRSS\tCPU\tCMD", :green
-    puts daemons.join("\n")
+    say "No deamons running", :red if config.empty?
+
+    if options.monitor
+      print_table([%w(PID RSS CPU CMD), *ps])
+    else
+      config.each do |conf|
+        status = begin
+          "WRONG CONFIG" and return unless File.exist?(conf[:pid])
+          pid = File.read(conf[:pid]).to_i
+          Process.kill(0, pid)
+          "RUNNING"
+        rescue Errno::ESRCH, Errno::ENOENT
+          "NOT RUNNING"
+        end
+        say_status status, conf[:file], status =~ /^RUNNING/ ? :green : :red
+      end
+      say "Reading config from: #{FOREVER_PATH}", :blue
+    end
   end
 
-  desc "stop [DAEMON] [--all] [--yes]", "Stop a specified daemon"
-  method_option :all, :type => :boolean, :aliases => "-a", :desc => "Stop all daemons"
-  method_option :yes, :type => :boolean, :aliases => "-y", :desc => "Don't ask permission to kill process"
+  desc "stop [DAEMON] [--all] [--yes]", "Stop one or more matching daemons"
+  method_option :all, :type => :boolean, :aliases => "-a", :desc => "All matching daemons"
+  method_option :yes, :type => :boolean, :aliases => "-y", :desc => "Don't ask permission to kill daemon"
   def stop(daemon=nil)
-    say "You must provide a daemon name or provide --all option", :red and return if daemon.nil? && !options.all
-    found = options.all ? daemons : daemons.find_all { |d| d=~/#{daemon}/i }
-    say "Daemon(s) matching '#{daemon}' not found", :red if found.empty? && !daemon.nil?
-    say "Daemons not found", :red if found.empty? && options.all && daemon.nil?
-
-    found.each do |daemon|
-      daemon = daemon.split("\t").map(&:strip)
-      if options.yes || yes?("Do you want really stop \e[1m#{daemon[-1]}\e[0m with pid \e[1m#{daemon[0]}\e[0m?")
-        say "Killing process \e[1m#{daemon[-1]}\e[0m\e[32m with pid \e[1m#{daemon[0]}", :green
-        result = `kill #{daemon[0]}`.strip
-        say result, :red if result != ""
+    find(daemon, :multiple => options.all).each do |conf|
+      if options.yes || yes?("Do you want really stop \e[1m#{conf[:file]}\e[0m?")
+        say_status "STOPPING", conf[:file]
+        system(conf[:file], 'stop')
+        say_status "ERROR", result, :red if result != ""
       end
     end
   end
 
+  desc "start [DAEMON] [--all] [--yes]", "Start one or more matching daemons"
+  method_option :all, :type => :boolean, :aliases => "-a", :desc => "All matching daemons"
+  method_option :yes, :type => :boolean, :aliases => "-y", :desc => "Don't ask permission to start the daemon"
+  def start(daemon=nil)
+    find(daemon, :multiple => options.all).each do |conf|
+      system(conf[:file]) if options.yes || yes?("Do you want really start \e[1m#{conf[:file]}\e[0m?")
+    end
+  end
+
+  desc "restart [DAEMON] [--all] [--yes]", "Restart one or more matching daemons"
+  method_option :all, :type => :boolean, :aliases => "-a", :desc => "All matching daemons"
+  method_option :yes, :type => :boolean, :aliases => "-y", :desc => "Don't ask permission to start the daemon"
+  def restart(daemon=nil)
+    invoke :start
+  end
+
+  desc "tail [DAEMON]", "Tail log of first matching daemon"
+  method_option :lines, :aliases => "-n", :default => 150, :desc => "How many lines show?"
+  def tail(daemon)
+    found = find(daemon)[0]
+    return unless found
+    system "tail -f -n #{options.lines} #{found[:log]}"
+  end
+
+  desc "update [DAEMON] [--all] [--yes]", "Update config from one or more matching daemons"
+  method_option :all, :type => :boolean, :aliases => "-a", :desc => "All matching daemons"
+  method_option :yes, :type => :boolean, :aliases => "-y", :desc => "Don't ask permission to start the daemon"
+  def update(daemon=nil)
+    find(daemon, :multiple => options.all).each do |conf|
+      system(conf[:file], 'up') if options.yes || yes?("Do you want really update config from \e[1m#{conf[:file]}\e[0m?")
+    end
+  end
+
   map "--version" => :version
   desc "version", "show the version number"
   def version
@@ -38,8 +84,31 @@ class CLI < Thor
   end
 
   private
-    def daemons
-      `ps axo pid,rss,pcpu,command | grep -vE "^USER|grep" | grep Forever: | awk '{print $1"\t"$2"\t"$3"\t"$4" "$5" "$6}'`.chomp.split("\n")
+    def find(daemon, options={})
+      multiple = options.delete(:multiple)
+      say "You must provide a daemon name or provide --all option", :red and return [] if daemon.nil? && !multiple
+      found = multiple ? config : config.find_all { |conf| conf[:file] =~ /#{daemon}/ }
+      say "Daemon(s) matching '#{daemon}' not found", :red if found.empty? && !daemon.nil?
+      say "Daemons not found", :red if found.empty? && nil && daemon.nil?
+      found
+    end
+
+    def find_all(daemon)
+      find(daemon, :multiple => true)
+    end
+
+    def config
+      File.exist?(FOREVER_PATH) ? YAML.load_file(FOREVER_PATH) : []
+    end
+
+    def ps
+      # This is horrible command, but how we can keep compatiblity between darwin and *unix ?
+      result = `ps axo pid,rss,pcpu,command | grep -vE "^USER|grep" | grep Forever: | awk '{print $1"\t"$2"\t"$3"\t"$4" "$5" "$6}'`
+      result = result.chomp.split("\n").map { |line| line.split("\t") }
+      result = result.sort { |a,b| b[1].to_i <=> a[1].to_i }
+      result.each { |column| column[1] = "%d Mb" % [column[1].to_i / 1024] }
+      result.each { |column| column[2] = "%s %"  % [column[2]] }
+      result
     end
 end
 

data/examples/sample

@@ -10,42 +10,42 @@ Forever.run do
     puts "All jobs will will wait me for 1 second"; sleep 1
   end
 
-  every 5.seconds, :last => Time.now do
-    puts "Every 5 seconds from start"
-  end
-
-  every 30.seconds, :last => Time.now do
-    puts "Every 30 seconds from start with boom"
-    raise "woooooa"
-  end
-
-  every 10.seconds, :at => "#{Time.now.hour}:00" do
-    puts "Every 10 seconds but first call at #{Time.now.hour}:00"
-  end
-
-  every 1.seconds, :at => "#{Time.now.hour}:#{Time.now.min+1}" do
-    puts "Every one second but first call at #{Time.now.hour}:#{Time.now.min}"
-  end
-
+  # every 5.seconds, :last => Time.now do
+  #   puts "Every 5 seconds from start"
+  # end
+  #
+  # every 30.seconds, :last => Time.now do
+  #   puts "Every 30 seconds from start with boom"
+  #   raise "woooooa"
+  # end
+  #
+  # every 10.seconds, :at => "#{Time.now.hour}:00" do
+  #   puts "Every 10 seconds but first call at #{Time.now.hour}:00"
+  # end
+  #
+  # every 1.seconds, :at => "#{Time.now.hour}:#{Time.now.min+1}" do
+  #   puts "Every one second but first call at #{Time.now.hour}:#{Time.now.min}"
+  # end
+  #
   every 10.seconds do
     puts "Every 10 second"
   end
-
-  every 20.seconds do
-    puts "Every 20 second"
-  end
-
-  every 15.seconds do
-    puts "Every 15 seconds, but my task require 10 seconds"; sleep 10
-  end
-
-  every 10.seconds, :at => [":#{Time.now.min+1}", ":#{Time.now.min+2}"] do
-    puts "Every 10 seconds but first call at xx:#{Time.now.min}"
-  end
-
-  on_error do |e|
-    puts "Boom raised: #{e.message}"
-  end
+  #
+  # every 20.seconds do
+  #   puts "Every 20 second"
+  # end
+  #
+  # every 15.seconds do
+  #   puts "Every 15 seconds, but my task require 10 seconds"; sleep 10
+  # end
+  #
+  # every 10.seconds, :at => [":#{Time.now.min+1}", ":#{Time.now.min+2}"] do
+  #   puts "Every 10 seconds but first call at xx:#{Time.now.min}"
+  # end
+  #
+  # on_error do |e|
+  #   puts "Boom raised: #{e.message}"
+  # end
 
   on_exit do
     puts "Bye bye"

data/lib/forever.rb

@@ -3,6 +3,8 @@ require "forever/every"
 require "forever/base"
 require "forever/version"
 
+FOREVER_PATH = ENV['FOREVER_PATH'] ||= File.expand_path("~/.foreverb") unless defined?(FOREVER_PATH)
+
 module Forever
   extend self
 

data/lib/forever/base.rb

@@ -14,15 +14,27 @@ module Forever
       Dir.mkdir(File.dirname(log)) if log && !File.exist?(File.dirname(log))
       Dir.mkdir(File.dirname(pid)) if pid && !File.exist?(File.dirname(pid))
 
+      write_config!
+
+      if ARGV.any? { |arg| arg == "config" }
+        print config.to_yaml
+        return
+      end
+
+      return if ARGV.any? { |arg| arg == "up" }
+
       stop!
 
-      return if ARGV[0] == "stop"
+      return if ARGV.any? { |arg| arg == "stop" }
 
       fork do
         $0 = "Forever: #{$0}"
         print "=> Process demonized with pid #{Process.pid} with Forever v.#{Forever::VERSION}\n"
 
         %w(INT TERM KILL).each { |signal| trap(signal)  { stop! } }
+        trap(:HUP) do
+          IO.open(1, 'w'){ |s| s.puts config }
+        end
 
         File.open(pid, "w") { |f| f.write(Process.pid.to_s) } if pid
 
@@ -124,11 +136,17 @@ module Forever
     alias :inspect :to_s
 
     def config
-      { :dir => dir, :file => file, :log => log, :pid => pid }.to_yaml
+      { :dir => dir, :file => file, :log => log, :pid => pid }
     end
-    alias :to_yaml :config
 
     private
+      def write_config!
+        config_was = File.exist?(FOREVER_PATH) ? YAML.load_file(FOREVER_PATH) : []
+        config_was.delete_if { |conf| conf[:file] == file }
+        config_was << config
+        File.open(FOREVER_PATH, "w") { |f| f.write config_was.to_yaml }
+      end
+
       def exists?(*values)
         values.all? { |value| value && File.exist?(value) }
       end

data/lib/forever/version.rb

@@ -1,3 +1,3 @@
 module Forever
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: foreverb
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: 
   segments: 
   - 0
   - 2
-  - 1
-  version: 0.2.1
+  - 2
+  version: 0.2.2
 platform: ruby
 authors: 
 - DAddYE
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-14 00:00:00 +02:00
+date: 2011-07-22 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -45,11 +45,13 @@ extra_rdoc_files: []
 
 files: 
 - .gitignore
+- CHANGES.md
 - Gemfile
 - README.md
 - Rakefile
 - bin/foreverb
 - examples/sample
+- examples/tmp/sample.pid
 - foreverb.gemspec
 - lib/forever.rb
 - lib/forever/base.rb