metrognome 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in metrognome.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Chris Carlon
+
+MIT License
+
+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.md

@@ -0,0 +1,31 @@
+# Metrognome
+
+A simple repeating task scheduler for Rails applications
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'metrognome'
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install metrognome
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request at cjc25/metrognome
+
+TODO: Commit message/code style guidelines

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/metrognome/railtie.rb

@@ -0,0 +1,9 @@
+module Metrognome
+  class Railtie < Rails::Railtie
+    railtie_name :metrognome
+
+    rake_tasks do
+      load "tasks/metrognome.rake"
+    end
+  end
+end

data/lib/metrognome/registrar.rb

@@ -0,0 +1,27 @@
+module Metrognome
+  class Registrar
+    class << self
+      def registered
+        @registered ||= []
+      end
+
+      def register scheduler
+        raise ArgumentError.new "scheduler must be a Metrognome::Scheduler!" unless scheduler.is_a? Metrognome::Scheduler
+
+        @registered ||= []
+        @registered << scheduler
+        scheduler.lock = next_filename
+        scheduler.last = Time.now - 1.year
+        scheduler.call_setup
+      end
+
+      private
+        def next_filename
+          @counter ||= 0
+          @counter += 1
+          "metrognome-#{@counter}"
+        end
+    end
+  end
+end
+

data/lib/metrognome/runner.rb

@@ -0,0 +1,55 @@
+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

data/lib/metrognome/scheduler.rb

@@ -0,0 +1,39 @@
+module Metrognome
+  class Scheduler
+    attr_accessor :interval, :lock, :last
+
+    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)
+    end
+
+    def setup &block
+      @setup = block
+    end
+
+    def task &block
+      @task = block
+    end
+
+    def call_setup
+      instance_eval &@setup if @setup
+    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
+      end
+    end
+  end
+end
+

data/lib/metrognome/version.rb

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

data/lib/metrognome.rb

@@ -0,0 +1,7 @@
+require 'rails'
+require 'metrognome/railtie'
+
+require 'metrognome/scheduler'
+require 'metrognome/registrar'
+require 'metrognome/runner'
+

data/lib/tasks/metrognome.rake

@@ -0,0 +1,60 @@
+namespace :metrognome do
+  # TODO move PIDFILE into config
+  module Metrognome
+    PIDFILE = File.join 'tmp', 'metrognome.pid'
+  end
+
+  task :register => :environment do
+    require 'metrognome'
+    Dir[File.join(Rails.root, 'config', 'metrognome', '*.rb')].each do |file|
+      require file
+    end
+  end
+
+  desc 'Begin the metrognome scheduler'
+  task :start => :register do
+    unless File.exists? Metrognome::PIDFILE
+      Signal.trap 'HUP', 'IGNORE'
+
+      pid = fork do
+        Rails.logger = Logger.new 'log/metrognome.log'
+        Metrognome::Runner.start
+      end
+
+      Process.detach pid
+      File.open(Metrognome::PIDFILE, File::CREAT | File::WRONLY | File::TRUNC, 0600) do |f|
+        f.write pid
+      end
+    else
+      $stderr.puts "#{Metrognome::PIDFILE} already exists. Is metrognome already running?"
+    end
+  end
+
+  desc 'End the metrognome scheduler'
+  task :stop do
+    if File.exists? Metrognome::PIDFILE
+      pid = 0
+      begin
+        pid = File.read(Metrognome::PIDFILE).to_i
+      rescue
+        $stderr.puts "Could not read the contents of #{Metrognome::PIDFILE}"
+        return
+      end
+      raise "Bad PID in #{Metrognome::PIDFILE}" if pid == 0
+
+      begin
+        Process.kill :TERM, pid
+      rescue Errno::EPERM
+        $stderr.puts "Not permitted to kill process #{pid}"
+        return
+      rescue Errno::ESRCH
+        $stderr.puts "Process #{pid} is not running"
+      end
+
+      File.delete Metrognome::PIDFILE
+    else
+      $stderr.puts "#{Metrognome::PIDFILE} does not exist"
+    end
+  end
+end
+

data/metrognome.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'metrognome/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "metrognome"
+  gem.version       = Metrognome::VERSION
+  gem.authors       = ["Chris Carlon"]
+  gem.email         = ["chris.carlon25@gmail.com"]
+  gem.description   = %q{A simple repeating task scheduler for Rails applications}
+  gem.summary       = %q{A simple repeating task scheduler for Rails applications}
+  gem.homepage      = "https://github.com/cjc25/metrognome"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_runtime_dependency 'rails', '~> 3.2'
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: metrognome
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Chris Carlon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: A simple repeating task scheduler for Rails applications
+email:
+- chris.carlon25@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- 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
+homepage: https://github.com/cjc25/metrognome
+licenses: []
+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
+signing_key: 
+specification_version: 3
+summary: A simple repeating task scheduler for Rails applications
+test_files: []