employer-activerecord 0.0.1 → 0.1

data/.pryrc

@@ -0,0 +1,2 @@
+require "bundler"
+Bundler.require

data/.rspec

@@ -0,0 +1 @@
+--color --format documentation -I. -rspec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - jruby-19mode
+script: rspec

data/README.md

@@ -1,6 +1,6 @@
-# Employer::Activerecord
+# Employer::ActiveRecord [![Build Status](https://travis-ci.org/mkremer/employer-activerecord.png)](https://travis-ci.org/mkremer/employer-activerecord)
 
-TODO: Write a gem description
+ActiveRecord backend for Employer
 
 ## Installation
 
@@ -18,7 +18,26 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Generate and run the migration to create the employer\_jobs tablein your
+database:
+
+```
+rails g employer:active_record
+bundle exec rake db:migrate
+```
+
+Ensure that your Employer configuration starts with something like the below:
+
+```ruby
+require "./config/environment.rb"
+require "employer-activerecord"
+
+pipeline_backend Employer::ActiveRecord::Pipeline.new
+```
+
+If you're not using Rails then require whatever sets up your application's
+environment instead of config/environment.rb before requiring 
+employer-activerecord. 
 
 ## Contributing
 

data/employer-activerecord.gemspec

@@ -21,4 +21,5 @@ Gem::Specification.new do |gem|
 
   gem.add_development_dependency "rspec"
   gem.add_development_dependency "pry"
+  gem.add_development_dependency "sqlite3"
 end

data/lib/employer-activerecord/job.rb

@@ -0,0 +1,15 @@
+require "active_record"
+
+module Employer
+  module ActiveRecord
+    class Job < ::ActiveRecord::Base
+      self.table_name = "employer_jobs"
+      self.inheritance_column = "_type"
+
+      validates :state, presence: true
+      validates :type, presence: true
+
+      scope :free, where(state: :free)
+    end
+  end
+end

data/lib/employer-activerecord/pipeline.rb

@@ -0,0 +1,41 @@
+require "json"
+
+module Employer
+  module ActiveRecord
+    class Pipeline
+      def enqueue(job_hash)
+        job_attributes = {
+          type: job_hash[:class],
+          properties: job_hash[:attributes].to_json,
+          state: :free
+        }
+
+        Employer::ActiveRecord::Job.create!(job_attributes).id
+      end
+
+      def dequeue
+        if job = Employer::ActiveRecord::Job.free.order("created_at ASC").lock(true).first
+          job.state = :locked
+          job.save!
+          {id: job.id, class: job.type, attributes: JSON.parse(job.properties)}
+        end
+      end
+
+      def clear
+        Employer::ActiveRecord::Job.destroy_all
+      end
+
+      def complete(job)
+        Employer::ActiveRecord::Job.find(job.id, lock: true).destroy
+      end
+
+      def fail(job)
+        Employer::ActiveRecord::Job.find(job.id, lock: true).update_attributes(state: :failed)
+      end
+
+      def reset(job)
+        Employer::ActiveRecord::Job.find(job.id, lock: true).update_attributes(state: :free)
+      end
+    end
+  end
+end

data/lib/employer-activerecord/version.rb

@@ -1,5 +1,5 @@
 module Employer
   module Activerecord
-    VERSION = "0.0.1"
+    VERSION = "0.1"
   end
 end

data/lib/generators/employer/active_record_generator.rb

@@ -0,0 +1,14 @@
+require 'rails/generators/active_record'
+
+module Employer
+  class ActiveRecordGenerator < ::Rails::Generators::Base
+    include Rails::Generators::Migration
+    extend ActiveRecord::Generators::Migration
+
+    source_paths << File.join(File.dirname(__FILE__), "templates")
+
+    def create_migration_file
+      migration_template 'migration.rb', 'db/migrate/create_employer_jobs.rb'
+    end
+  end
+end

data/lib/generators/employer/templates/migration.rb

@@ -0,0 +1,13 @@
+class CreateEmployerJobs < ActiveRecord::Migration
+  def change
+    create_table :employer_jobs do |t|
+      t.string :state
+      t.string :type
+      t.text :properties
+
+      t.timestamps
+    end
+
+    add_index :employer_jobs, [:state, :created_at], order: {created_at: :asc}
+  end
+end

data/spec/employer-activerecord/job_spec.rb

@@ -0,0 +1,34 @@
+require "employer-activerecord/job"
+
+describe Employer::ActiveRecord::Job do
+  let(:job) { Employer::ActiveRecord::Job.new(state: :free, type: "TestJob") }
+
+  it "requires state" do
+    job.state = nil
+    job.should be_invalid
+    job.errors.should include(:state)
+    job.state = :free
+    job.should be_valid
+  end
+
+  it "requires type" do
+    job.type = nil
+    job.should be_invalid
+    job.errors.should include(:type)
+    job.type = "TestJob"
+    job.should be_valid
+  end
+
+  describe ".free" do
+    it "returns jobs with state free" do
+      job1 = Employer::ActiveRecord::Job.create(state: :free, type: "TestJob")
+      job2 = Employer::ActiveRecord::Job.create(state: :free, type: "TestJob")
+      job3 = Employer::ActiveRecord::Job.create(state: :locked, type: "TestJob")
+
+      free_jobs = Employer::ActiveRecord::Job.free.to_a
+      free_jobs.should include(job1)
+      free_jobs.should include(job2)
+      free_jobs.should_not include(job3)
+    end
+  end
+end

data/spec/employer-activerecord/pipeline_spec.rb

@@ -0,0 +1,70 @@
+require "employer-activerecord/pipeline"
+require "employer-activerecord/job"
+
+describe Employer::ActiveRecord::Pipeline do
+  let(:pipeline) { Employer::ActiveRecord::Pipeline.new }
+
+  before(:each) do
+    Employer::ActiveRecord::Job.destroy_all
+  end
+
+  describe "#enqueue" do
+    it "saves the job hash to the database" do
+      job_hash = {class: "TestJob", attributes: {shape: "Square", color: "Blue"}}
+      job_id = pipeline.enqueue(job_hash)
+      job = Employer::ActiveRecord::Job.find(job_id)
+      job.should_not be_nil
+      job.type.should eq("TestJob")
+      job.properties.should eq({"shape" => "Square", "color" => "Blue"}.to_json)
+    end
+  end
+
+  describe "#dequeue" do
+    it "locks a job from the database and returns it as a job hash" do
+      locked_job = Employer::ActiveRecord::Job.create!(created_at: 2.days.ago, state: :locked, type: "TestJob", properties: {shape: "Circle", color: "Red"}.to_json)
+      free_job1 = Employer::ActiveRecord::Job.create!(created_at: 1.day.ago, state: :free, type: "TestJob", properties: {shape: "Triangle", color: "Green"}.to_json)
+      free_job2 = Employer::ActiveRecord::Job.create!(state: :free, type: "TestJob", properties: {shape: "Square", color: "Yellow"}.to_json)
+
+      job_hash = {id: free_job1.id, class: "TestJob", attributes: {"shape" => "Triangle", "color" => "Green"}}
+      pipeline.dequeue.should eq(job_hash)
+
+      job_hash = {id: free_job2.id, class: "TestJob", attributes: {"shape" => "Square", "color" => "Yellow"}}
+      pipeline.dequeue.should eq(job_hash)
+
+      pipeline.dequeue.should be_nil
+    end
+  end
+
+  describe "clear" do
+    it "deletes all jobs" do
+      Employer::ActiveRecord::Job.should_receive(:destroy_all)
+      pipeline.clear
+    end
+  end
+
+  describe "#complete" do
+    it "deletes the job from the database" do
+      job = Employer::ActiveRecord::Job.create!(state: :free, type: "TestJob", properties: {shape: "Triangle", color: "Green"}.to_json)
+      pipeline.complete(job)
+      Employer::ActiveRecord::Job.where(id: job.id).count.should eq(0)
+    end
+  end
+
+  describe "#reset" do
+    it "unlocks the job in the database" do
+      job = Employer::ActiveRecord::Job.create!(state: :locked, type: "TestJob", properties: {shape: "Triangle", color: "Green"}.to_json)
+      pipeline.reset(job)
+      job.reload
+      job.state.should eq("free")
+    end
+  end
+
+  describe "#fail" do
+    it "marks the job as failed in the database" do
+      job = Employer::ActiveRecord::Job.create!(state: :locked, type: "TestJob", properties: {shape: "Triangle", color: "Green"}.to_json)
+      pipeline.fail(job)
+      job.reload
+      job.state.should eq("failed")
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require "pry"
+require "active_record"
+require "generators/employer/templates/migration"
+
+# Connect with an in-memory SQLite database
+ActiveRecord::Base.establish_connection(adapter: "sqlite3", database: ":memory:")
+
+# Run the template migration to generate the jobs table
+CreateEmployerJobs.new.change

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: employer-activerecord
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: '0.1'
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-19 00:00:00.000000000 Z
+date: 2013-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: employer
@@ -75,6 +75,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - mark@without-brains.net
@@ -83,13 +99,23 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .pryrc
+- .rspec
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - employer-activerecord.gemspec
 - lib/employer-activerecord.rb
+- lib/employer-activerecord/job.rb
+- lib/employer-activerecord/pipeline.rb
 - lib/employer-activerecord/version.rb
+- lib/generators/employer/active_record_generator.rb
+- lib/generators/employer/templates/migration.rb
+- spec/employer-activerecord/job_spec.rb
+- spec/employer-activerecord/pipeline_spec.rb
+- spec/spec_helper.rb
 homepage: 
 licenses:
 - MIT
@@ -115,5 +141,8 @@ rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: ActiveRecord backend for Employer
-test_files: []
+test_files:
+- spec/employer-activerecord/job_spec.rb
+- spec/employer-activerecord/pipeline_spec.rb
+- spec/spec_helper.rb
 has_rdoc: