metrognome 0.0.1 → 0.0.2

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YzU2MDJhNDNmODk3YzA0ZGFlYWEyMDQyNWMyOGIzZWUzZDM0ZjBmOQ==
+  data.tar.gz: !binary |-
+    YTk4OWZiNmRiMWY4ODIwZDdlNmIzOGUxMmRlMzY0MmViOGQwYzFiNw==
+SHA512:
+  metadata.gz: !binary |-
+    ZTJkNjRjM2FhMGU4MDcyZWRlZmM5NThlMzUxZWZiZDhiNzk1N2NjNGUwZjlh
+    NzBhY2Q1NjdkMjBiM2ZmZTU5ZWVkMDA3MWYzMDE3ZDU3OWY4ZjA4ZWM2MmI2
+    YmYyNTc1YzY5NTg5ZjFjZDAzMjQ3NzUyNmM0YzVjYmNkYTkzMTc=
+  data.tar.gz: !binary |-
+    MGIyYjM0YzEzNzFjNjBmYThkNGM2ZTY3MzA0ZWY2NGZjNTI2MGUzNmZlNDMw
+    M2EwODE3NmEwZGRjYjhlNTdjMzQ3YTRmNmFkMzFiZGZlZWUwNmU2YzM3Nzdl
+    YmFlZDEyMzkxNDNiMmVjOTA2Mjc2OWEzOTBmOWFjNzk1MDlmOWU=

data/.gitignore

@@ -2,6 +2,7 @@
 *.rbc
 .bundle
 .config
+.rspec
 .yardoc
 Gemfile.lock
 InstalledFiles
@@ -15,3 +16,6 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+
+.ruby-version
+.ruby-gemset

data/README.md

@@ -18,7 +18,75 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Starting and Stopping
+
+To start the metrognome, run:
+
+    $ bundle exec rake metrognome:start
+
+In production, use RAILS\_ENV to let Rails know to start the right environment:
+
+    $ bundle exec rake RAILS_ENV=production metrognome:start
+
+To stop the metrognome, run:
+
+    $ bundle exec rake metrognome:stop
+
+### Schedulers
+
+Schedulers are registered with metrognome and run on a periodic basis.
+Schedulers are `.rb` files read from the folder `config/metrognome`
+
+#### Initialization and task
+
+All schedulers are instances of Metrognome::Scheduler, initialized like:
+
+```ruby
+beeper = Metrognome::Scheduler.new(10.seconds)
+```
+
+The beeper task will be executed every 10 seconds beginning when the metrognome
+starts. To define the task to execute, pass a block to `beeper.task`:
+
+```ruby
+beeper.task do
+  puts "Beep!"
+end
+```
+
+Finally, register the task with `Metrognome::Registrar.register`:
+
+```ruby
+Metrognome::Registrar.register beeper
+```
+
+#### Setup and local variables
+
+Most schedulers can benefit from some persistence, or at least some setup. Let's
+have our beeper keep track of how many times it's beeped.
+
+Accessors can be declared when the scheduler is initialized:
+
+```ruby
+beeper = Metrognome::Scheduler.new(10.seconds, :counter)
+```
+
+The counter can be given an initial value by passing a block to `beeper.setup`:
+
+```ruby
+beeper.setup do
+  self.counter = 0
+end
+```
+
+Finally, the counter can be used in the task block:
+
+```ruby
+beeper.task do
+  self.counter += 1
+  logger.info "Beep! #{counter} time(s)"
+end
+```
 
 ## Contributing
 

data/lib/metrognome.rb

@@ -3,5 +3,4 @@ require 'metrognome/railtie'
 
 require 'metrognome/scheduler'
 require 'metrognome/registrar'
-require 'metrognome/runner'
 

data/lib/metrognome/registrar.rb

@@ -1,27 +1,41 @@
+require 'singleton'
+
 module Metrognome
   class Registrar
-    class << self
-      def registered
-        @registered ||= []
-      end
+    include Singleton
 
-      def register scheduler
-        raise ArgumentError.new "scheduler must be a Metrognome::Scheduler!" unless scheduler.is_a? Metrognome::Scheduler
+    def self.register scheduler
+      self.instance.register scheduler
+    end
 
-        @registered ||= []
-        @registered << scheduler
-        scheduler.lock = next_filename
-        scheduler.last = Time.now - 1.year
-        scheduler.call_setup
+    def register scheduler
+      unless scheduler.is_a? Metrognome::Scheduler
+        raise ArgumentError.new "scheduler #{scheduler.inspect} must be a Metrognome::Scheduler."
       end
 
-      private
-        def next_filename
-          @counter ||= 0
-          @counter += 1
-          "metrognome-#{@counter}"
-        end
+      @registered ||= []
+      @registered << scheduler
+    end
+
+    def start
+      @registered.each { |scheduler| scheduler.run }
+
+      wait_for_sigterm
+      Signal.trap("TERM") { exit 1 }
+
+      @registered.each do |scheduler|
+        scheduler.stop
+        scheduler.thread.run
+      end
+      @registered.each { |scheduler| scheduler.thread.join }
     end
+
+    private
+      # Sleep until we get a SIGTERM.
+      def wait_for_sigterm
+        Signal.trap("TERM") { return }
+        sleep
+      end
   end
 end
 

data/lib/metrognome/scheduler.rb

@@ -1,18 +1,11 @@
 module Metrognome
   class Scheduler
-    attr_accessor :interval, :lock, :last
+    attr_reader :thread
 
-    def initialize interval, *variables
-      self.interval = interval
-
-      variables.each do |v|
-        raise ArgumentError.new "All variables must be Strings or Symbols!" unless v.is_a? String or v.is_a? Symbol
-        eval "class << self; attr_accessor :#{v}; end"
-      end
-    end
-
-    def lock
-      File.join(Rails.root, 'tmp', @lock)
+    def initialize interval, description = 'Anonymous scheduler'
+      @interval = interval
+      @description = description
+      @stopped = false
     end
 
     def setup &block
@@ -23,15 +16,26 @@ module Metrognome
       @task = block
     end
 
-    def call_setup
-      instance_eval &@setup if @setup
+    def stop
+      @stopped = true
     end
 
-    def call_task
-      File.open(lock, File::RDWR | File::CREAT, 0600) do |file|
-        break unless file.flock(File::LOCK_EX | File::LOCK_NB)
-        self.last = Time.now
-        instance_eval &@task if @task
+    def run
+      @thread = Thread.new do
+        instance_eval(&@setup) if @setup
+
+        until @stopped do
+          start = Time.now
+          Rails.logger.info "#{@description} beginning task execution."
+          instance_eval(&@task) if @task
+          Rails.logger.info "#{@description} completed task execution."
+          # TODO log stopping task
+
+          until @stopped do
+            to_sleep = start + @interval - Time.now
+            break if to_sleep <= 0 or Kernel.sleep(to_sleep) >= to_sleep
+          end
+        end
       end
     end
   end

data/lib/metrognome/version.rb

@@ -1,3 +1,3 @@
 module Metrognome
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/tasks/metrognome.rake

@@ -14,11 +14,13 @@ namespace :metrognome do
   desc 'Begin the metrognome scheduler'
   task :start => :register do
     unless File.exists? Metrognome::PIDFILE
+      # Ignore SIGHUP since we'll probably be started from an SSH session.
       Signal.trap 'HUP', 'IGNORE'
 
       pid = fork do
         Rails.logger = Logger.new 'log/metrognome.log'
-        Metrognome::Runner.start
+        Rails.logger.formatter = Logger::Formatter.new
+        Metrognome::Registrar.instance.start
       end
 
       Process.detach pid

data/metrognome.gemspec

@@ -18,4 +18,6 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
 
   gem.add_runtime_dependency 'rails', '~> 3.2'
+
+  gem.add_development_dependency 'rspec'
 end

data/spec/metrognome/scheduler_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+require 'active_support/time'
+
+describe Metrognome::Scheduler do
+  before do
+    @dummy_scheduler = Metrognome::Scheduler.new 1.minute, 'Test scheduler'
+    @dummy_scheduler.setup { @task_counter = 0 }
+    @dummy_scheduler.task do
+      if @task_counter == 5
+        self.stop
+      else
+        @task_counter += 1
+      end
+    end
+
+    @slept = 0
+    Kernel.stub(:sleep) do |arg|
+      # Make sure we're only sleeping up to the schedule time.
+      arg.should be < 1.minute
+      @slept += 1
+      arg + 1  # Always break out of the sleep loop.
+    end
+
+    # Metrognome should run in a Rails app, so set the logger we use.
+    Rails.logger = Logger.new nil
+  end
+
+  it 'should count to 5' do
+    @dummy_scheduler.run
+    Thread.pass while @dummy_scheduler.thread.alive?
+    @slept.should == 5
+    @dummy_scheduler.instance_eval { @task_counter }.should == 5
+  end
+
+  it 'should exit without exception' do
+    @dummy_scheduler.run
+    Thread.pass while @dummy_scheduler.thread.alive?
+
+    # The scheduler thread status is nil on exit due to exception.
+    @dummy_scheduler.thread.status.should === false
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'metrognome'

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: metrognome
 version: !ruby/object:Gem::Version
-  version: 0.0.1
-  prerelease: 
+  version: 0.0.2
 platform: ruby
 authors:
 - Chris Carlon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-22 00:00:00.000000000 Z
+date: 2014-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -22,11 +20,24 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A simple repeating task scheduler for Rails applications
 email:
 - chris.carlon25@gmail.com
@@ -42,33 +53,35 @@ files:
 - lib/metrognome.rb
 - lib/metrognome/railtie.rb
 - lib/metrognome/registrar.rb
-- lib/metrognome/runner.rb
 - lib/metrognome/scheduler.rb
 - lib/metrognome/version.rb
 - lib/tasks/metrognome.rake
 - metrognome.gemspec
+- spec/metrognome/scheduler_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/cjc25/metrognome
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.1.11
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A simple repeating task scheduler for Rails applications
-test_files: []
+test_files:
+- spec/metrognome/scheduler_spec.rb
+- spec/spec_helper.rb

data/lib/metrognome/runner.rb

@@ -1,55 +0,0 @@
-module Metrognome
-  class Runner
-    class << self
-      # TODO pull out reaper_interval into config
-      attr_accessor :running, :reaper_last
-      REAPER_INTERVAL = 1
-
-      def start
-        setup
-
-        loop do
-          if @_sigterm
-            running.each { |t| t.kill }
-            reap
-            break
-          end
-          reap if Time.now - reaper_last > REAPER_INTERVAL
-
-          Metrognome::Registrar.registered.each do |sched|
-            if Time.now - sched.last > sched.interval
-              running << Thread.new do
-                sched.call_task
-
-                # DB connections will no longer be closed automatically, so
-                # close it manually here
-                ActiveRecord::Base.connection.close
-              end
-            end
-          end
-          # TODO GCD sleep instead of 1
-          sleep 1
-        end
-
-        Metrognome::Registrar.registered.each { |s| File.delete s.lock }
-      end
-
-      private
-        def setup
-          require 'set'
-          self.running = Set.new
-          self.reaper_last = Time.now
-
-          Signal.trap "TERM" do
-            exit 1 if @_sigterm
-            @_sigterm = 1
-          end
-        end
-
-        def reap
-          running.delete_if { |t| t.join(0) }
-          self.reaper_last = Time.now
-        end
-    end
-  end
-end