loop_dance 0.2.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,18 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+gem "activesupport", ">= 3.0"
+gem "i18n"
+gem "daemon_controller"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development, :test do
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+  gem "ruby-debug"
+  gem "rspec"
+  gem "shoulda"
+end
+

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Danil Pismenny
+
+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 OR COPYRIGHT HOLDERS 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/README.rdoc

@@ -0,0 +1,54 @@
+= LoopDance
+
+No forks. No threads. Just looped scheduler based on `daemon_controller` and `looper`
+
+== Easy to install
+
+   gem 'loop_dance'
+
+== Simple to setup
+
+Just create file 'lib/loop_dance.rb':
+
+    class Dancer < LoopDance::Dancer
+
+      every 3.hours do
+        User.notify_all
+      end
+
+      every 60.seconds do
+        Report.checks
+      end
+
+    end
+
+LoopDance automatically starts at the rails 3 server startup.
+
+== Useful management
+
+From the application:
+
+    Dancer.start unless Dancer.running?
+
+By the rake tasks (TODO):
+
+    rake loop_dance:start
+    rake loop_dance:stop
+    rake loop_dance:status
+
+
+== Contributing to loop_dance
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2010 Danil Pismenny. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,60 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "loop_dance"
+  gem.homepage = "http://github.com/dapi/loop_dance"
+  gem.license = "MIT"
+  gem.summary = %Q{Simple auto-starting daemon based on the looper and daemon_controller}
+  gem.description = %Q{Really easy setup. Auto-start daaemon at rails server startup. Rake's tasks based control.}  # ' anti ruby-mode
+  gem.email = "danil@orionet.ru"
+  gem.authors = ["Danil Pismenny"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  gem.add_runtime_dependency 'daemon_controller', '>= 0.2.5'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+
+#task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "loop_dance #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/init.rb

@@ -0,0 +1 @@
+require 'loop_dance'

data/lib/loop_dance/commands.rb

@@ -0,0 +1,91 @@
+module LoopDance
+  
+  module Commands
+
+    attr_accessor :tasks, :timeout, :maximal_timeout
+    
+    def every( interval, &block )
+      @tasks = [] unless @tasks
+      @tasks << LoopDance::Task.new( interval, &block )
+      find_minimal_timeout interval
+      @maximal_timeout = interval if !@maximal_timeout || @maximal_timeout < interval
+    end
+
+    def dance
+      loop_init
+      if @tasks.empty?
+        log "No tasks defined."
+      else
+        while (@run) do
+          @tasks.each_with_index do |task, index|
+            if task.time_to_run?
+              log "Run task ##{index} for every #{task.interval.inspect}"
+              task.run 
+            end
+            break unless @run
+          end
+            log "Sleep for #{@timeout.inspect}"
+            sleep @timeout.to_i if @run
+          end
+        end
+      log "shutting down"
+    end
+    
+    def stop
+      @run = false
+    end
+    
+    def pid_file
+      "log/#{name.underscore}.pid"
+    end
+      
+    def log(text)
+      puts "#{Time.now} #{self}: #{text}"
+    end
+    
+    private
+
+    def find_minimal_timeout( interval )
+      return @timeout = interval if @timeout.blank?
+      minimal = interval < @timeout ? interval : @timeout
+      while not timeout_devides? minimal
+        minimal-=1
+      end
+        @timeout = minimal
+      end
+
+      def timeout_devides?( timeout )
+        @tasks.each { |task|
+          m = (task.interval / timeout).to_i
+          return false unless m * timeout == task.interval
+        }
+        return true
+      end
+      
+      def trap_signals
+        sigtrap = proc { 
+          log "caught trapped signal, shutting down"
+          @run = false 
+        }
+        ["SIGTERM", "SIGINT", "SIGHUP"].each do |signal|
+          trap signal, sigtrap
+        end
+      end
+      
+      def loop_init
+        # we don't want to delay output to sdtout until the program stops, we want feedback!
+        $stdout.sync=true
+        write_pid
+        trap_signals
+        @run = true
+        log "Process started and sleep for #{timeout.inspect}. kill #{Process.pid} to stop"
+      end
+
+      def write_pid
+        file = File.new( pid_file, "w" )
+        file.print Process.pid.to_s
+        file.close
+      end
+
+  end
+end

data/lib/loop_dance/controller.rb

@@ -0,0 +1,55 @@
+require 'daemon_controller'
+
+module LoopDance
+  class Controller < DaemonController
+
+    cattr_accessor :dancer, :start_timeout
+
+    self.start_timeout = 45
+
+    class << self
+
+      def new( dancer )
+        self.dancer = dancer
+        h = {
+          :identifier => dancer.name,
+          :daemonize_for_me => true,
+          :start_command => start_command,
+          :ping_command => lambda { true },
+          :pid_file => dancer.pid_file,
+          :log_file => log_file,
+          :start_timeout => start_timeout,
+          :log_file_activity_timeout => dancer.maximal_timeout + 3  # 3 seconds to stock
+        }
+        super h
+      end
+            
+      def log_file
+        dancer.pid_file.gsub '.pid', '.log'
+      end
+
+      def start_command
+        if defined? Rails
+          "rails runner -e #{Rails.env} '#{dancer}.dance' 2>&1 >>#{log_file}"
+        else
+          "rails runner '#{dancer}.dance' 2>&1 >>#{log_file}"
+        end
+        
+      end
+    end
+    
+    def auto_start
+      dancer.log  "Starting.. (#{@start_command})"
+      start unless running?
+    rescue => exception # DaemonController::StartTimeout
+      dancer.log "Exception until starting #{dancer}: #{exception.inspect}"
+      dancer.log  exception.backtrace if defined?( Rails ) && !Rails.env.production?
+    end
+    
+    
+    #stop
+    #start
+    #running
+  
+  end
+end

data/lib/loop_dance/dancer.rb

@@ -0,0 +1,27 @@
+require 'active_support/core_ext'
+
+module LoopDance
+  
+  autoload :Commands, 'loop_dance/commands'
+  autoload :Controller, 'loop_dance/controller'
+  
+  class Dancer
+    
+    
+    extend LoopDance::Commands
+
+
+    class << self
+
+      # Can start daemon automatically at rails server startup? true by default
+      cattr_accessor :start_automatic
+      self.start_automatic = true
+      
+      def controller
+        @controller ||= LoopDance::Controller.new self
+      end
+
+    end
+    
+  end
+end

data/lib/loop_dance/railtie.rb

@@ -0,0 +1,27 @@
+require 'rails'
+module LoopDance
+
+  class Railtie < Rails::Railtie
+    
+    initializer 'loop_dance.initialize', :after => :after_initialize do
+
+      load_dancers
+      # Do not start dancers if rake or other tasks
+      LoopDance.auto_start if server_startup?
+    end
+
+    def load_dancers
+      require 'dancers'
+    end
+
+    # FIX: Is there more cute solution?
+    def server_startup?
+      caller.to_s=~/config\.ru/
+    end
+
+    rake_tasks do
+      #load "path/to/my_railtie.tasks"
+    end
+    
+  end
+end

data/lib/loop_dance/task.rb

@@ -0,0 +1,23 @@
+class LoopDance::Task
+  attr_accessor :last_run_at, :block, :interval
+  
+  def initialize( interval, &block )
+    run_count=0
+    self.interval = interval
+    self.block = block
+    self.last_run_at = Time.now
+  end
+  
+  def time_to_run?
+    !last_run_at || last_run_at + interval <= Time.now
+  end
+  
+  def run
+    block.call
+  rescue Exception => e
+    puts "Uncaught exception bubbled up: \n#{e.class}: #{e.message}\n\t#{e.backtrace.join("\n\t")} "
+  ensure
+    self.last_run_at = Time.now
+  end
+  
+end

data/lib/loop_dance.rb

@@ -0,0 +1,19 @@
+module LoopDance
+
+  autoload :Task,  "loop_dance/task"
+  autoload :Dancer,  "loop_dance/dancer"
+
+  def self.auto_start
+    return puts "LoopDance: No dancers to start" if LoopDance::Dancer.subclasses.empty?
+    LoopDance::Dancer.subclasses.each do |dancer|
+      dancer.controller.auto_start if dancer.start_automatic
+    end
+  end
+  
+end
+
+begin
+  require 'loop_dance/railtie'
+rescue LoadError => e
+  puts "Can't load loop_dance/railtie"
+end

data/loop_dance.gemspec

@@ -0,0 +1,142 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{loop_dance}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Danil Pismenny"]
+  s.date = %q{2011-01-01}
+  s.description = %q{Really easy setup. Auto-start daaemon at rails server startup. Rake's tasks based control.}
+  s.email = %q{danil@orionet.ru}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "init.rb",
+    "lib/loop_dance.rb",
+    "lib/loop_dance/commands.rb",
+    "lib/loop_dance/controller.rb",
+    "lib/loop_dance/dancer.rb",
+    "lib/loop_dance/railtie.rb",
+    "lib/loop_dance/task.rb",
+    "loop_dance.gemspec",
+    "rails/init.rb",
+    "spec/dancer_spec.rb",
+    "spec/spec_helper.rb",
+    "spec/task_spec.rb",
+    "test/rails/.gitignore",
+    "test/rails/Gemfile",
+    "test/rails/Rakefile",
+    "test/rails/app/controllers/application_controller.rb",
+    "test/rails/config.ru",
+    "test/rails/config/application.rb",
+    "test/rails/config/boot.rb",
+    "test/rails/config/database.yml",
+    "test/rails/config/environment.rb",
+    "test/rails/config/environments/development.rb",
+    "test/rails/config/environments/production.rb",
+    "test/rails/config/environments/test.rb",
+    "test/rails/config/initializers/backtrace_silencers.rb",
+    "test/rails/config/initializers/inflections.rb",
+    "test/rails/config/initializers/mime_types.rb",
+    "test/rails/config/initializers/secret_token.rb",
+    "test/rails/config/initializers/session_store.rb",
+    "test/rails/config/locales/en.yml",
+    "test/rails/config/routes.rb",
+    "test/rails/db/seeds.rb",
+    "test/rails/lib/dancers.rb",
+    "test/rails/lib/tasks/.gitkeep",
+    "test/rails/public/404.html",
+    "test/rails/public/422.html",
+    "test/rails/public/500.html",
+    "test/rails/public/favicon.ico",
+    "test/rails/public/images/rails.png",
+    "test/rails/public/index.html",
+    "test/rails/public/javascripts/application.js",
+    "test/rails/public/javascripts/controls.js",
+    "test/rails/public/javascripts/dragdrop.js",
+    "test/rails/public/javascripts/effects.js",
+    "test/rails/public/javascripts/prototype.js",
+    "test/rails/public/javascripts/rails.js",
+    "test/rails/public/robots.txt",
+    "test/rails/public/stylesheets/.gitkeep",
+    "test/rails/script/rails"
+  ]
+  s.homepage = %q{http://github.com/dapi/loop_dance}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Simple auto-starting daemon based on the looper and daemon_controller}
+  s.test_files = [
+    "spec/dancer_spec.rb",
+    "spec/spec_helper.rb",
+    "spec/task_spec.rb",
+    "test/rails/app/controllers/application_controller.rb",
+    "test/rails/config/application.rb",
+    "test/rails/config/boot.rb",
+    "test/rails/config/environment.rb",
+    "test/rails/config/environments/development.rb",
+    "test/rails/config/environments/production.rb",
+    "test/rails/config/environments/test.rb",
+    "test/rails/config/initializers/backtrace_silencers.rb",
+    "test/rails/config/initializers/inflections.rb",
+    "test/rails/config/initializers/mime_types.rb",
+    "test/rails/config/initializers/secret_token.rb",
+    "test/rails/config/initializers/session_store.rb",
+    "test/rails/config/routes.rb",
+    "test/rails/db/seeds.rb",
+    "test/rails/lib/dancers.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activesupport>, [">= 3.0"])
+      s.add_runtime_dependency(%q<i18n>, [">= 0"])
+      s.add_runtime_dependency(%q<daemon_controller>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<ruby-debug>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_runtime_dependency(%q<daemon_controller>, [">= 0.2.5"])
+    else
+      s.add_dependency(%q<activesupport>, [">= 3.0"])
+      s.add_dependency(%q<i18n>, [">= 0"])
+      s.add_dependency(%q<daemon_controller>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<ruby-debug>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<daemon_controller>, [">= 0.2.5"])
+    end
+  else
+    s.add_dependency(%q<activesupport>, [">= 3.0"])
+    s.add_dependency(%q<i18n>, [">= 0"])
+    s.add_dependency(%q<daemon_controller>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<ruby-debug>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<daemon_controller>, [">= 0.2.5"])
+  end
+end
+

data/rails/init.rb

@@ -0,0 +1 @@
+Kernel.load File.join(File.dirname(__FILE__), '..', 'init.rb')

data/spec/dancer_spec.rb

@@ -0,0 +1,85 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe LoopDance do 
+
+  describe "setup" do
+  end
+
+  describe "finds minimal interval"
+
+  describe "examples" do 
+
+    before(:all) do
+      class Dancer1 < LoopDance::Dancer
+        every 2.seconds do
+        end
+        every 4.seconds do
+        end
+        every 6.seconds do
+        end
+        every 10.seconds do
+        end
+      end
+    end
+
+
+    it { Dancer1.tasks.count.should == 4 }
+    it { Dancer1.timeout.should == 2 }
+    it { LoopDance::Dancer.tasks.should be_blank }
+    it { Dancer1.maximal_timeout.should == 10 }
+
+
+    describe "another dancer not change first dancer's tasks" do
+      
+      before(:all) do
+        class Dancer2 < LoopDance::Dancer
+          every 6.seconds do
+          end
+          every 11.seconds do
+          end
+        end
+      end
+
+      it { Dancer2.tasks.count.should == 2 }
+      it { Dancer2.timeout.should == 1 }
+      it { Dancer2.maximal_timeout.should == 11 }
+      
+    end
+
+    describe "find right minimal timeout" do
+      
+      before(:all) do
+        class Dancer3 < LoopDance::Dancer
+          every 6.seconds do
+          end
+          every 9.seconds do
+          end
+        end
+      end
+
+      it { Dancer3.tasks.count.should == 2 }
+      it { Dancer3.timeout.should == 3 }
+      it { Dancer3.maximal_timeout.should == 9 }
+      
+    end
+
+    describe "method stop stops the loop" do
+      
+      before(:all) do
+        class Dancer < LoopDance::Dancer
+          every 2.seconds do
+            stop
+          end
+        end
+      end
+
+      it { Dancer.dance }
+      it { Dancer.maximal_timeout.should == 2 }
+      
+    end
+
+
+    
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'loop_dance'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+
+RSpec.configure do |config|
+  
+end