foreverb 0.1.7 → 0.1.8

data/.gitignore

@@ -2,3 +2,5 @@
 .bundle
 Gemfile.lock
 pkg/*
+examples/**/log
+examples/**/tmp

data/README.md

@@ -1,16 +1,13 @@
 # Foreverb
 
-Small daemon framework **for ruby**, with logging, error handler watcher and much more.
+Small daemon framework **for ruby**, with logging, error handler, scheduling and much more.
 
 My inspiration was [forever for node.js](https://raw.github.com/indexzero/forever) written by Charlie Robbins.
-
-Please don't consider this gem as a port because is not.
-
-The executable name it's called ```foreverb``` to prevent collisions.
+My scheduling inspiration was taken from [clockwork](https://github.com/adamwiggins/clockwork) written by Adam Wiggins.
 
 ## Why?
 
-There are a lot of alternatives, one of the best is [resque](https://github.com/defunkt/resque), so why another daemons framework?
+There are some alternatives, one of the best is [resque](https://github.com/defunkt/resque), so why another daemons framework?
 In my servers I've several daemons and what I need is:
 
 * easily watch the process (memory, cpu)
@@ -99,6 +96,74 @@ $ bin/foo stop
 => Killing process 19538...
 ```
 
+## Scheduling
+
+You can use ```every``` method to schedule repetitive tasks.
+
+``` rb
+# Taken from, examples/sample
+Forever.run do
+  dir File.expand_path('../', __FILE__) # Default is ../../__FILE__
+
+  on_ready do
+    puts inspect
+  end
+
+  every 1.seconds do
+    puts "Every one seconds"
+  end
+
+  every 2.seconds do
+    puts "Every two seconds"
+  end
+
+  every 3.seconds do
+    puts "Every three seconds, long task"
+    sleep 10
+  end
+
+  every 1.day, :at => "18:28" do
+    puts "Every day at 18:28"
+  end
+
+  on_error do |e|
+    puts "Boom raised: #{e.message}"
+  end
+
+  on_exit do
+    puts "Bye bye"
+  end
+end
+```
+
+You should see in logs this:
+
+```
+$ examples/sample
+=> Pid not found, process seems don't exist!
+=> Process demonized with pid 1252 with Forever v.0.1.7
+[11/07 18:27:08] #<Forever dir:/Developer/src/extras/foreverb/examples, file:/Developer/src/extras/foreverb/examples/sample, log:/Developer/src/extras/foreverb/examples/log/sample.log, pid:/Developer/src/extras/foreverb/examples/tmp/sample.pid jobs:4>
+[11/07 18:27:08] Every one seconds
+[11/07 18:27:08] Every two seconds
+[11/07 18:27:08] Every three seconds, long task
+[11/07 18:27:09] Every one seconds
+[11/07 18:27:10] Every two seconds
+...
+[11/07 18:27:17] Every one seconds
+[11/07 18:27:18] Every one seconds
+[11/07 18:27:18] Every two seconds
+[11/07 18:27:19] Every three seconds, long task
+...
+[11/07 18:27:58] Every one seconds
+[11/07 18:27:59] Every one seconds
+[11/07 18:28:00] Every two seconds
+[11/07 18:28:00] Every one seconds
+[11/07 18:28:00] Every day at 18:28
+=> Found pid 1252...
+=> Killing process 1252...
+[11/07 18:28:18] Bye bye
+```
+
 ## Monitor your daemon(s):
 
 List daemons:
@@ -115,10 +180,18 @@ Stop daemon(s):
 $ foreverb stop foo
 Do you want really stop Forever: bin/foo  with pid 19538? y
 Killing process Forever: bin/foo  with pid 19538...
+
+$ foreverb stop --all -y
+Killing process Forever: /usr/bin/githubwatcher with pid 2824
+Killing process Forever: examples/sample with pid 2836
 ```
 
 That's all!
 
+## Extras
+
+To see a most comprensive app running _foreverb_ + _growl_ see [githubwatcher gem](https://github.com/daddye/githubwatcher)
+
 ## Author
 
 DAddYE, you can follow me on twitter [@daddye](http://twitter.com/daddye)

data/Rakefile

@@ -1,2 +1,16 @@
 require 'rubygems' unless defined?(Gem)
-require 'bundler/gem_tasks'
+require 'bundler/gem_tasks'
+
+%w(install release).each do |task|
+  Rake::Task[task].enhance do
+    sh "rm -rf pkg"
+  end
+end
+
+desc "Bump version on github"
+task :bump do
+  version = Bundler.load_gemspec(Dir[File.expand_path('../*.gemspec', __FILE__)].first).version
+  sh "git add .; git commit -m \"Bump to version #{version}\""
+end
+
+task :release => :bump

data/bin/foreverb

@@ -12,14 +12,19 @@ class CLI < Thor
     puts daemons.join("\n")
   end
 
-  desc "stop [DAEMON]", "Stop a specified daemon"
-  def stop(daemon)
-    found = daemons.find_all { |d| d=~/#{daemon}/i }
-    say "Daemon(s) matching '#{daemon}' not found", :red if found.empty?
+  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"
+  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")
-      if yes? "Do you want really stop #{daemon[-1]} with pid #{daemon[0]}?"
-        say "Killing process #{daemon[-1]} with pid #{daemon[0]}...", :green
+      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 != ""
       end

data/examples/sample

@@ -0,0 +1,44 @@
+#!/usr/bin/ruby
+require 'rubygems' unless defined?(Gem)
+require 'bundler/setup'
+require 'forever'
+
+$stdout_was = STDOUT.dup
+
+Forever.run do
+  def puts(text=nil)
+    text = super(text)
+    $stdout_was.print text
+  end
+
+  dir File.expand_path('../', __FILE__) # Default is ../../__FILE__
+
+  on_ready do
+    puts inspect
+  end
+
+  every 1.seconds do
+    puts "Every one seconds"
+  end
+
+  every 2.seconds do
+    puts "Every two seconds"
+  end
+
+  every 3.seconds do
+    puts "Every three seconds, long task"
+    sleep 10
+  end
+
+  every 1.minutes, :at => "%d:%d" % [Time.now.hour, Time.now.min+1] do
+    puts "Every minutes at #{"%d:%d" % [Time.now.hour, Time.now.min]}"
+  end
+
+  on_error do |e|
+    puts "Boom raised: #{e.message}"
+  end
+
+  on_exit do
+    puts "Bye bye"
+  end
+end

data/foreverb.gemspec

@@ -9,13 +9,13 @@ Gem::Specification.new do |s|
   s.email       = ["d.dagostino@lipsiasoft.com"]
   s.homepage    = "https://github.com/daddye/forever"
   s.summary     = %q{Small daemon framework for ruby}
-  s.description = %q{Small daemon framework for ruby, with logging, error handler and more...}
+  s.description = %q{Small daemon framework for ruby, with logging, error handler, scheduling and much more.}
 
-  s.rubyforge_project = "forever"
+  s.rubyforge_project = "foreverb"
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ["lib"]
+  s.require_paths = %w(lib)
   s.add_dependency 'thor', '~>0.14.6'
 end

data/lib/forever/base.rb

@@ -1,7 +1,12 @@
 require 'fileutils'
+require 'forever/every'
 
 module Forever
+  DATE_FORMAT = "%d/%m %H:%M:%S"
+
   class Base
+    include Every
+
     def initialize(options={}, &block)
       options.each { |k,v| send(k, v) }
 
@@ -13,11 +18,11 @@ module Forever
 
       stop!
 
-      return if ARGV[0] == "stop" || on_ready.nil?
+      return if ARGV[0] == "stop"
 
       fork do
         $0 = "Forever: #{$0}"
-        puts "=> Process demonized with pid #{Process.pid} with Forever v.#{Forever::VERSION}"
+        print "=> Process demonized with pid #{Process.pid} with Forever v.#{Forever::VERSION}\n"
 
         %w(INT TERM KILL).each { |signal| trap(signal)  { stop! } }
 
@@ -29,10 +34,18 @@ module Forever
         STDOUT.reopen(stream)
         STDERR.reopen(STDOUT)
 
+        Thread.abort_on_exception = true
+
         begin
-          on_ready.call if on_ready
+          threads = []
+          threads << Thread.new { on_ready.call } if on_ready
+          jobs.each do |job|
+            threads << Thread.new do
+              loop { job.call if job.time?(Time.now); sleep 1 }
+            end
+          end
+          threads.map(&:join)
         rescue Exception => e
-          Thread.list.reject { |t| t==Thread.current }.map(&:kill)
           on_error[e] if on_error
           stream.print "\n\n%s\n  %s\n\n" % [e.message, e.backtrace.join("\n  ")]
           sleep 30
@@ -41,6 +54,17 @@ module Forever
       end
     end
 
+    ##
+    # A replacement of puts that has the aim to works correclty with multiple threads
+    # and log date. If you want to personalize date, edit DATE_FORMAT.
+    #
+    def puts(text="")
+      text  = "[%s] %s" % [Time.now.strftime(DATE_FORMAT), text.to_s]
+      text += "\n" unless text[-1] == ?\n
+      print text; $stdout.flush
+      text
+    end
+
     ##
     # Caller file
     #
@@ -62,7 +86,7 @@ module Forever
     #
     def log(value=nil)
       @_log ||= File.join(dir, "log/#{File.basename(file)}.log") if exists?(dir, file)
-      value ? @_log = value : @_log
+      value.nil? ? @_log : @_log = value
     end
 
     ##
@@ -72,25 +96,26 @@ module Forever
     #
     def pid(value=nil)
       @_pid ||= File.join(dir, "tmp/#{File.basename(file)}.pid") if exists?(dir, file)
-      value ? @_pid = value : @_pid
+      value.nil? ? @_pid : @_pid = value
     end
 
     ##
     # Search if there is a running process and stop it
     #
-    def stop!(kill=true)
+    def stop!
       if exists?(pid)
         _pid = File.read(pid).to_i
-        puts "=> Found pid #{_pid}..."
+        print "=> Found pid #{_pid}...\n"
         FileUtils.rm_f(pid)
         begin
-          puts "=> Killing process #{_pid}..."
+          print "=> Killing process #{_pid}...\n"
+          on_exit.call if on_exit
           Process.kill(:KILL, _pid)
         rescue Errno::ESRCH => e
           puts "=> #{e.message}"
         end
       else
-        puts "=> Pid not found, process seems don't exist!"
+        print "=> Pid not found, process seems don't exist!\n"
       end
     end
 
@@ -101,6 +126,13 @@ module Forever
       block_given? ? @_on_error = block : @_on_error
     end
 
+    ##
+    # Callback raised when at exit
+    #
+    def on_exit(&block)
+      block_given? ? @_on_exit = block : @_on_exit
+    end
+
     ##
     # Callback to fire when the daemon start
     #
@@ -109,7 +141,7 @@ module Forever
     end
 
     def to_s
-      "#<Forever dir:#{dir}, file:#{file}, log:#{log}, pid:#{pid}>"
+      "#<Forever dir:#{dir}, file:#{file}, log:#{log}, pid:#{pid} jobs:#{jobs.size}>"
     end
     alias :inspect :to_s
 

data/lib/forever/every.rb

@@ -0,0 +1,46 @@
+require 'forever/numeric'
+
+module Forever
+  module Every
+    class Job
+      attr_accessor :period, :option, :last, :running
+
+      def initialize(period, options, block)
+        @period, @options, @last, @running = period, options, 0, false
+        @at = parse_at(@options[:at])
+        @block = block
+      end
+
+      def call
+        @last, @running = Time.now, true
+        @block.call
+      ensure
+        @running = false
+      end
+
+      def time?(t)
+        ellapsed_ready = (t - @last).to_i >= @period
+        time_ready     = @at.nil? || (t.hour == @at[0] && t.min == @at[1])
+        !running && ellapsed_ready && time_ready
+      end
+
+      private
+        def parse_at(at)
+          return unless at.is_a?(String)
+          m = at.match(/^(\d{1,2}):(\d{1,2})$/)
+          raise "Failed to parse #{at}" unless m
+          hour, min = m[1].to_i, m[2].to_i
+          raise "Failed to parse #{at}" if hour >= 24 || min >= 60
+          [hour, min]
+        end
+    end # Job
+
+    def every(period, options={}, &block)
+      jobs << Job.new(period, options, block)
+    end
+
+    def jobs
+      @_jobs ||= []
+    end
+  end # Every
+end # Forever

data/lib/forever/numeric.rb

@@ -0,0 +1,13 @@
+class Numeric
+  def seconds; self; end
+  alias :second :seconds
+
+  def minutes; self * 60; end
+  alias :minute :minutes
+
+  def hours; self * 3600; end
+  alias :hour :hours
+
+  def days; self * 86400; end
+  alias :day :days
+end

data/lib/forever/version.rb

@@ -1,3 +1,3 @@
 module Forever
-  VERSION = "0.1.7"
+  VERSION = "0.1.8"
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 7
-  version: 0.1.7
+  - 8
+  version: 0.1.8
 platform: ruby
 authors: 
 - DAddYE
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-08 00:00:00 +02:00
+date: 2011-07-11 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -31,7 +31,7 @@ dependencies:
         version: 0.14.6
   type: :runtime
   version_requirements: *id001
-description: Small daemon framework for ruby, with logging, error handler and more...
+description: Small daemon framework for ruby, with logging, error handler, scheduling and much more.
 email: 
 - d.dagostino@lipsiasoft.com
 executables: 
@@ -46,9 +46,12 @@ files:
 - README.md
 - Rakefile
 - bin/foreverb
+- examples/sample
 - foreverb.gemspec
 - lib/forever.rb
 - lib/forever/base.rb
+- lib/forever/every.rb
+- lib/forever/numeric.rb
 - lib/forever/version.rb
 has_rdoc: true
 homepage: https://github.com/daddye/forever
@@ -75,7 +78,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: "0"
 requirements: []
 
-rubyforge_project: forever
+rubyforge_project: foreverb
 rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3