stateful_jobs 0.0.1

data/spec/dummy/config/initializers/backtrace_silencers.rb

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+
+# You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces.
+# Rails.backtrace_cleaner.add_silencer { |line| line =~ /my_noisy_library/ }
+
+# You can also remove all the silencers if you're trying to debug a problem that might stem from framework code.
+# Rails.backtrace_cleaner.remove_silencers!

data/spec/dummy/config/initializers/inflections.rb

@@ -0,0 +1,15 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new inflection rules using the following format
+# (all these examples are active by default):
+# ActiveSupport::Inflector.inflections do |inflect|
+#   inflect.plural /^(ox)$/i, '\1en'
+#   inflect.singular /^(ox)en/i, '\1'
+#   inflect.irregular 'person', 'people'
+#   inflect.uncountable %w( fish sheep )
+# end
+#
+# These inflection rules are supported but not enabled by default:
+# ActiveSupport::Inflector.inflections do |inflect|
+#   inflect.acronym 'RESTful'
+# end

data/spec/dummy/config/initializers/mime_types.rb

@@ -0,0 +1,5 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new mime types for use in respond_to blocks:
+# Mime::Type.register "text/richtext", :rtf
+# Mime::Type.register_alias "text/html", :iphone

data/spec/dummy/config/initializers/resque.rb

@@ -0,0 +1 @@
+Resque.inline = Rails.env.development? || Rails.env.test?

data/spec/dummy/config/initializers/secret_token.rb

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+
+# Your secret key for verifying the integrity of signed cookies.
+# If you change this key, all old signed cookies will become invalid!
+# Make sure the secret is at least 30 characters and all random,
+# no regular words or you'll be exposed to dictionary attacks.
+Dummy::Application.config.secret_token = 'dffa2898f783621c644616398999268745032a940fe9d4c91ca463213f9ae3819514010614a278c448d4d525bdc44f295f71f4d45c1ba56a369384a715df11ba'

data/spec/dummy/config/initializers/session_store.rb

@@ -0,0 +1,8 @@
+# Be sure to restart your server when you modify this file.
+
+Dummy::Application.config.session_store :cookie_store, key: '_dummy_session'
+
+# Use the database for sessions instead of the cookie-based default,
+# which shouldn't be used to store highly confidential information
+# (create the session table with "rails generate session_migration")
+# Dummy::Application.config.session_store :active_record_store

data/spec/dummy/config/initializers/wrap_parameters.rb

@@ -0,0 +1,14 @@
+# Be sure to restart your server when you modify this file.
+#
+# This file contains settings for ActionController::ParamsWrapper which
+# is enabled by default.
+
+# Enable parameter wrapping for JSON. You can disable this by setting :format to an empty array.
+ActiveSupport.on_load(:action_controller) do
+  wrap_parameters format: [:json]
+end
+
+# Disable root element in JSON by default.
+ActiveSupport.on_load(:active_record) do
+  self.include_root_in_json = false
+end

data/spec/dummy/config/locales/en.yml

@@ -0,0 +1,5 @@
+# Sample localization file for English. Add more files in this directory for other locales.
+# See https://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
+
+en:
+  hello: "Hello world"

data/spec/dummy/config/routes.rb

@@ -0,0 +1,61 @@
+Dummy::Application.routes.draw do
+
+  stateful_jobs :test_runs
+
+  # The priority is based upon order of creation:
+  # first created -> highest priority.
+
+  # Sample of regular route:
+  #   match 'products/:id' => 'catalog#view'
+  # Keep in mind you can assign values other than :controller and :action
+
+  # Sample of named route:
+  #   match 'products/:id/purchase' => 'catalog#purchase', :as => :purchase
+  # This route can be invoked with purchase_url(:id => product.id)
+
+  # Sample resource route (maps HTTP verbs to controller actions automatically):
+  #   resources :products
+
+  # Sample resource route with options:
+  #   resources :products do
+  #     member do
+  #       get 'short'
+  #       post 'toggle'
+  #     end
+  #
+  #     collection do
+  #       get 'sold'
+  #     end
+  #   end
+
+  # Sample resource route with sub-resources:
+  #   resources :products do
+  #     resources :comments, :sales
+  #     resource :seller
+  #   end
+
+  # Sample resource route with more complex sub-resources
+  #   resources :products do
+  #     resources :comments
+  #     resources :sales do
+  #       get 'recent', :on => :collection
+  #     end
+  #   end
+
+  # Sample resource route within a namespace:
+  #   namespace :admin do
+  #     # Directs /admin/products/* to Admin::ProductsController
+  #     # (app/controllers/admin/products_controller.rb)
+  #     resources :products
+  #   end
+
+  # You can have the root of your site routed with "root"
+  # just remember to delete public/index.html.
+  # root :to => 'welcome#index'
+
+  # See how all your routes lay out with "rake routes"
+
+  # This is a legacy wild controller route that's not recommended for RESTful applications.
+  # Note: This route will make all actions in every controller accessible via GET requests.
+  # match ':controller(/:action(/:id))(.:format)'
+end

data/spec/dummy/db/migrate/20130228143735_create_test_runs.rb

@@ -0,0 +1,10 @@
+class CreateTestRuns < ActiveRecord::Migration
+  def change
+    create_table :test_runs do |t|
+      t.string :current_job
+      t.string :current_state
+
+      t.timestamps
+    end
+  end
+end

data/spec/dummy/db/schema.rb

@@ -0,0 +1,23 @@
+# encoding: UTF-8
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# Note that this schema.rb definition is the authoritative source for your
+# database schema. If you need to create the application database on another
+# system, you should be using db:schema:load, not running all the migrations
+# from scratch. The latter is a flawed and unsustainable approach (the more migrations
+# you'll amass, the slower it'll run and the greater likelihood for issues).
+#
+# It's strongly recommended to check this file into your version control system.
+
+ActiveRecord::Schema.define(:version => 20130228143735) do
+
+  create_table "test_runs", :force => true do |t|
+    t.string   "current_job"
+    t.string   "current_state"
+    t.datetime "created_at",    :null => false
+    t.datetime "updated_at",    :null => false
+  end
+
+end

data/spec/dummy/public/404.html

@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The page you were looking for doesn't exist (404)</title>
+  <style type="text/css">
+    body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
+    div.dialog {
+      width: 25em;
+      padding: 0 4em;
+      margin: 4em auto 0 auto;
+      border: 1px solid #ccc;
+      border-right-color: #999;
+      border-bottom-color: #999;
+    }
+    h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
+  </style>
+</head>
+
+<body>
+  <!-- This file lives in public/404.html -->
+  <div class="dialog">
+    <h1>The page you were looking for doesn't exist.</h1>
+    <p>You may have mistyped the address or the page may have moved.</p>
+  </div>
+</body>
+</html>

data/spec/dummy/public/422.html

@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The change you wanted was rejected (422)</title>
+  <style type="text/css">
+    body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
+    div.dialog {
+      width: 25em;
+      padding: 0 4em;
+      margin: 4em auto 0 auto;
+      border: 1px solid #ccc;
+      border-right-color: #999;
+      border-bottom-color: #999;
+    }
+    h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
+  </style>
+</head>
+
+<body>
+  <!-- This file lives in public/422.html -->
+  <div class="dialog">
+    <h1>The change you wanted was rejected.</h1>
+    <p>Maybe you tried to change something you didn't have access to.</p>
+  </div>
+</body>
+</html>

data/spec/dummy/public/500.html

@@ -0,0 +1,25 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>We're sorry, but something went wrong (500)</title>
+  <style type="text/css">
+    body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
+    div.dialog {
+      width: 25em;
+      padding: 0 4em;
+      margin: 4em auto 0 auto;
+      border: 1px solid #ccc;
+      border-right-color: #999;
+      border-bottom-color: #999;
+    }
+    h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
+  </style>
+</head>
+
+<body>
+  <!-- This file lives in public/500.html -->
+  <div class="dialog">
+    <h1>We're sorry, but something went wrong.</h1>
+  </div>
+</body>
+</html>

data/spec/dummy/script/rails

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require File.expand_path('../../config/boot',  __FILE__)
+require 'rails/commands'

data/spec/lib/stateful_jobs_job_dispatcher_spec.rb

@@ -0,0 +1,126 @@
+require 'spec_helper'
+
+class TestJob < StatefulJobs::Job::Base
+end
+
+describe StatefulJobs::Job::Dispatcher do
+
+  describe '#perform' do
+    before :each do
+      @test_run = TestRun.create
+      TestRun.stub(:find).and_return(@test_run)
+    end
+
+    context 'with job class' do
+      before :each do
+        TestRun.stateful_jobs = {}
+        TestRun.stateful_job :test_job, TestJob
+      end
+
+      it 'calls the jobs perform method' do
+        TestJob.should_receive(:perform).with(@test_run)
+
+        StatefulJobs::Job::Dispatcher.perform 'TestRun', @test_run.id, 'test_job'
+      end
+
+      it 'sets the current job' do
+        StatefulJobs::Job::Dispatcher.perform 'TestRun', @test_run.id, 'test_job'
+
+        @test_run.reload
+        @test_run.current_job.should eql('test_job')
+      end
+
+      it 'sets the done state on successful jobs' do
+        TestJob.should_receive(:perform).with(@test_run).and_return true
+
+        StatefulJobs::Job::Dispatcher.perform 'TestRun', @test_run.id, 'test_job'
+
+        TestRun.unstub(:find)
+        @test_run.reload
+
+        @test_run.current_state.should eql('done')
+      end
+
+      it 'sets the failure state on non successful jobs' do
+        TestJob.should_receive(:perform).with(@test_run).and_return false
+
+        StatefulJobs::Job::Dispatcher.perform 'TestRun', @test_run.id, 'test_job'
+
+        TestRun.unstub(:find)
+        @test_run.reload
+
+        @test_run.current_state.should eql('failed')
+      end
+
+      it 'sets the error state when exception was thrown' do
+        TestJob.should_receive(:perform).with(@test_run).and_raise Exception
+
+        expect {
+          StatefulJobs::Job::Dispatcher.perform 'TestRun', @test_run.id, 'test_job'
+        }.to raise_error
+
+        TestRun.unstub(:find)
+        @test_run.reload
+
+        @test_run.current_state.should eql('error')
+      end
+    end
+
+    context 'with job proc' do
+      before :each do
+        TestRun.stateful_jobs = {}
+        TestRun.stateful_job :test_job do
+        end
+      end
+
+      it 'calls the jobs proc' do
+        TestRun.stateful_jobs[:test_job].should_receive(:call).with(@test_run)
+
+        StatefulJobs::Job::Dispatcher.perform 'TestRun', @test_run.id, 'test_job'
+      end
+
+      it 'sets the current job' do
+        StatefulJobs::Job::Dispatcher.perform 'TestRun', @test_run.id, 'test_job'
+
+        @test_run.reload
+        @test_run.current_job.should eql('test_job')
+      end
+
+      it 'sets the done state on successful jobs' do
+        TestRun.stateful_jobs[:test_job].should_receive(:call).with(@test_run).and_return true
+
+        StatefulJobs::Job::Dispatcher.perform 'TestRun', @test_run.id, 'test_job'
+
+        TestRun.unstub(:find)
+        @test_run.reload
+
+        @test_run.current_state.should eql('done')
+      end
+
+      it 'sets the failure state on non successful jobs' do
+        TestRun.stateful_jobs[:test_job].should_receive(:call).with(@test_run).and_return false
+
+        StatefulJobs::Job::Dispatcher.perform 'TestRun', @test_run.id, 'test_job'
+
+        TestRun.unstub(:find)
+        @test_run.reload
+
+        @test_run.current_state.should eql('failed')
+      end
+
+      it 'sets the error state when exception was thrown' do
+        TestRun.stateful_jobs[:test_job].should_receive(:call).with(@test_run).and_raise Exception
+
+        expect {
+          StatefulJobs::Job::Dispatcher.perform 'TestRun', @test_run.id, 'test_job'
+        }.to raise_error
+
+        TestRun.unstub(:find)
+        @test_run.reload
+
+        @test_run.current_state.should eql('error')
+      end
+    end
+  end
+
+end

data/spec/lib/stateful_jobs_job_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+class TestJob < StatefulJobs::Job::Base
+end
+
+describe StatefulJobs::Job do
+
+  describe '#enqueue' do
+    before :each do
+      TestRun.stateful_jobs = {}
+      TestRun.stateful_job :test_job, TestJob
+
+      @test_run = TestRun.create
+    end
+
+    it 'enqueues the Dispatcher with given job on resque' do
+      Resque.should_receive(:enqueue).with(StatefulJobs::Job::Dispatcher, 'TestRun', @test_run.id, :test_job)
+
+      StatefulJobs::Job.enqueue @test_run, :test_job
+    end
+  end
+
+end

data/spec/models/test_run_spec.rb

@@ -0,0 +1,77 @@
+require 'spec_helper'
+
+class TestJob < StatefulJobs::Job::Base
+end
+
+describe TestRun do
+
+  describe 'model' do
+    it 'implements the stateful_job class method' do
+      TestRun.methods.should include(:stateful_job)
+    end
+
+    it 'implements the stateful_job_for class method' do
+      TestRun.methods.should include(:stateful_job_for)
+    end
+  end
+
+  describe '#stateful_job' do
+    before :each do
+      TestRun.stateful_jobs = {}
+    end
+
+    context 'with block given' do
+      it 'adds the job to its jobs hash' do
+        TestRun.stateful_job :test_job do
+        end
+
+        TestRun.stateful_jobs.should have_key(:test_job)
+        TestRun.stateful_jobs[:test_job].should be_a(Proc)
+      end
+
+      it 'defines a ! method for enqueuing the job' do
+        TestRun.instance_methods.should include(:test_job!)
+      end
+    end
+
+    context 'with block given' do
+      it 'adds the job to its jobs hash' do
+        TestRun.stateful_job :test_job, TestJob
+
+        TestRun.stateful_jobs.should have_key(:test_job)
+        TestRun.stateful_jobs[:test_job].should eql(TestJob)
+      end
+
+      it 'defines a ! method for enqueuing the job' do
+        TestRun.instance_methods.should include(:test_job!)
+      end
+    end
+  end
+
+  describe '#stateful_job_for' do
+    before :each do
+      TestRun.stateful_jobs = {}
+
+      TestRun.stateful_job :test_job, TestJob
+    end
+
+    it 'returns the job fo given key' do
+      TestRun.stateful_job_for(:test_job).should eql(TestJob)
+    end
+  end
+
+  describe 'enqueuing jobs' do
+    before :each do
+      TestRun.stateful_jobs = {}
+      TestRun.stateful_job :test_job, TestJob
+
+      @test_run = TestRun.create
+    end
+
+    it 'enqueues the job' do
+      StatefulJobs::Job.should_receive(:enqueue).with(@test_run, :test_job)
+
+      @test_run.test_job!
+    end
+  end
+end