steady 0.0.1

data/.gitignore

@@ -0,0 +1 @@
+pkg

data/Gemfile

@@ -0,0 +1,4 @@
+source :rubygems
+
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,10 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    speedytime (0.0.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  speedytime

data/README.md

@@ -0,0 +1,30 @@
+# Steady
+
+This gem is aimed at helping speed up ruby webapps by putting reoccuring but non time critical tasks into a background thread.
+It aids with the periodic scheduling as well as the threading issues that arise from moving data between threads. 
+
+# Example
+
+    Scheduler = Steady::Scheduler.new
+    
+    Scheduler.every 3.seconds do |changes|
+      changes[:plans] = JSON.parse(open("http://mysite.com/plans.json")) 
+    end 
+
+    # Run all above tasks now to get initial data
+    Scheduler.run 
+
+    # Schedule a thread to do this periodically
+    Scheduler.schedule
+
+
+    # Access your data in a thread safe manner 
+    Scheduler.data[:plans] 
+
+# Uses at Shopify
+
+* Monitoring read slave lagginess 
+* Fetching blog posts to show in the admin
+* Fetching centrally configured beta flags from remote 
+* and many many more 
+

data/Rakefile

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+require 'bundler'
+require 'bundler/gem_tasks'
+
+Rake::TestTask.new do |t|
+  t.libs << '.' << 'lib' << 'test'
+  t.test_files = FileList['test/**/*_test.rb']
+  t.verbose = false
+end
+

data/lib/steady.rb

@@ -0,0 +1,134 @@
+require 'speedytime'
+require 'thread'
+require 'set'
+
+module Steady
+
+  class SyncronizedHash
+    def initialize
+      @hash = Hash.new
+      @mutex = Mutex.new
+    end
+
+    def [](key)
+      @mutex.synchronize { @hash[key] }
+    end
+
+    def []=(key)
+      @mutex.synchronize { @hash.[]=(key, value) }
+    end
+
+    def apply(changes)
+      @mutex.synchronize { @hash.merge!(changes) }
+    end
+  end
+
+  class DirtyTrackingHash < Hash
+    def dirty?
+      @dirty
+    end
+
+    def []=(key, value)
+      @dirty = true
+      super
+    end
+  end
+
+  class Scheduler
+    attr_reader :tasks, :data
+
+    def initialize
+      @tasks = []
+      @data = SyncronizedHash.new
+    end
+
+    def every(interval, &block)
+      push Task.new(interval, &block)
+    end
+
+    def run
+      changes = DirtyTrackingHash.new
+      runs = false 
+
+
+      @tasks.each do |task|
+        if task.needs_running?
+          task.run(changes)
+          runs = true 
+        else
+          # tasks are sorted, if a tasks doesn't need running 
+          # then no task behind it will need running either at 
+          # the moment.
+          break
+        end
+      end
+
+      # if tasks ran we resort the tasks and apply
+      # any changes to the data hash 
+      if runs
+        @tasks.sort!
+        @data.apply(changes) if changes.dirty?
+        true
+      else
+        false
+      end
+    end
+
+    def schedule
+      Thread.new do 
+        loop { sleep; run }
+      end
+    end
+
+    def drowsiness
+      drowsiness = (t = @tasks.first) ? t.next_run - Speedytime.current : 1
+      drowsiness = 1 if drowsiness < 1
+      drowsiness
+    end
+
+    def sleep      
+      sleep(drowsiness)
+    end
+
+    private
+
+    def push(task)    
+      @tasks.push(task)
+      @tasks.sort!
+    end
+
+  end
+
+  class Task
+    attr_accessor :last_run, :interval
+
+    def initialize(interval, &block)
+      @interval = interval
+      @proc = block
+      @last_run = 0
+    end
+
+    def next_run
+      @last_run + @interval
+    end
+
+    def needs_running?
+      next_run <= Speedytime.current
+    end
+
+    def run(changes = nil)
+      if needs_running?
+        @proc.call(changes)
+        @last_run = Speedytime.current
+        true
+      else
+        false
+      end
+    end
+
+    def <=>(other)
+      next_run <=> other.next_run
+    end
+  end
+
+end

data/lib/steady/version.rb

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

data/steady.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'steady/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "steady"
+  gem.version       = Steady::VERSION
+  gem.authors       = ["Tobias Lutke"]
+  gem.email         = ["tobi@shopify.com"]
+  gem.description   = %q{Periodically run tasks that fetch data}
+  gem.summary       = %q{Simple worker thread for steady tasks}
+  gem.homepage      = ""
+  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_dependency('speedytime')
+end

data/test/steady_test.rb

@@ -0,0 +1,81 @@
+require "test/unit"
+require "steady"
+
+class SteadyTask < Test::Unit::TestCase
+
+  def setup
+    @sched = Steady::Scheduler.new
+  end  
+
+  def test_tasks_run
+    i = 0 
+    @sched.every 1 do 
+      i += 1
+    end
+
+    assert_equal 1, @sched.tasks.length 
+    @sched.run
+    assert_equal 1, @sched.tasks.length 
+
+    assert_equal 1, i 
+  end
+
+  def test_task_sorting
+    i = 0 
+
+    @sched.every 2 do 
+      i += 1
+    end  
+    @sched.every 5 do
+      i += 1
+    end
+    @sched.every 1 do
+      i += 1
+    end
+
+    @sched.run
+    assert_equal 3, i
+
+    sleep 1.1
+
+    @sched.run
+    assert_equal 4, i
+
+    sleep 1.1
+
+    @sched.run
+    assert_equal 6, i    
+  end
+
+  def test_task_drowsiness
+
+    @sched.every 5 do 
+    end  
+
+    assert_equal 1, @sched.drowsiness
+
+    @sched.run 
+
+    assert_equal 5, @sched.drowsiness    
+
+    @sched.every 1 do 
+    end  
+
+    assert_equal 1, @sched.drowsiness
+    
+  end
+
+  def test_mege
+
+    assert_equal nil, @sched.data[:test]
+
+    @sched.every 1 do |changes|
+      changes[:test] = 'ok'
+    end  
+
+    @sched.run
+
+    assert_equal 'ok', @sched.data[:test]    
+  end
+
+end

data/test/task_test.rb

@@ -0,0 +1,50 @@
+require "test/unit"
+require "periodic"
+
+class TestTask < Test::Unit::TestCase
+	
+  def test_tasks_run_by_default
+    i = 0
+
+  	task = Periodic::Task.new(5) do 
+      i += 1
+    end
+
+    task.run 
+
+    assert_equal 1, i
+	end
+
+  def test_tasks_run_one_per_second
+    i = 0
+
+    task = Periodic::Task.new(1) do 
+      i += 1
+    end
+
+    task.run 
+    task.run
+    sleep 1.1
+    task.run
+    task.run
+
+    assert_equal 2, i, 'should have been 2 because only 2 unique seconds elapsed'
+  end
+
+  def test_needs_running?
+    task = Periodic::Task.new(1)
+    assert task.needs_running? 
+    task.last_run = Speedytime.current
+    assert !task.needs_running?
+    task.last_run = Speedytime.current - 5
+    assert task.needs_running?
+  end
+
+  def test_interval
+    task = Periodic::Task.new(1)
+    task.last_run = Speedytime.current - 5
+    assert task.needs_running?
+    task.interval = 6 
+    assert !task.needs_running?
+  end
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: steady
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Tobias Lutke
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: speedytime
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Periodically run tasks that fetch data
+email:
+- tobi@shopify.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/steady.rb
+- lib/steady/version.rb
+- steady.gemspec
+- test/steady_test.rb
+- test/task_test.rb
+homepage: ''
+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.23
+signing_key: 
+specification_version: 3
+summary: Simple worker thread for steady tasks
+test_files:
+- test/steady_test.rb
+- test/task_test.rb