yawl 0.0.3 → 0.1.0

data/.rspec

@@ -0,0 +1,3 @@
+--colour
+--format progress
+--order random

data/README.md

@@ -1,6 +1,8 @@
 # Yawl
 
-TODO: Write a gem description
+Yawl is **Y**et **a**nother **w**orkflow **l**ibrary.
+
+The target audience is for those who have workflows that are mostly sequential and don't need to create complex branching logic.
 
 ## Installation
 
@@ -18,16 +20,45 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+The way you go about using it is:
+
+1. You define a set of steps where most of your logic will go
+
+  ```ruby
+  Yawl::Steps.set :morning_routine do
+    step :first_thing do
+      def run
+        puts "brush teeth"
+      end
+    end
+  end
+  ```
+2. You define a process which references set(s) of steps, this will be the name you call when you want to run the process.
+
+  ```ruby
+  Yawl::ProcessDefinitions.add(:wake_up) do |process|
+    Yawl::Steps.realize_set_on(:morning_routine)
+  end
+  ```
+3. You call the process with the name you defined in step 2, and add any variables that you need to the `Yawl::Process#config` json field.
 
-## Example
+  ```ruby
+  p = Yawl::Process.create(:desired_state => "wake_up", :config => {})
+  p.start
+  ```
+
+## Running the Example
 
 ```
 bundle exec sequel -m migrations/ postgres://localhost/yawl_examples
+bundle exec ruby examples/cook_worker.rb &
 bundle exec ruby examples/cook.rb
-bundle exec ruby examples/cook_worker.rb
 ```
 
+## Credit
+
+Originally written by @dpiddy, extracted by @ricardochimal from a larger project into its own gem.
+
 ## Contributing
 
 1. Fork it

data/Rakefile

@@ -1 +1,7 @@
 require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+task :default => :spec

data/examples/cook.rb

@@ -1,8 +1,6 @@
 $:.unshift(File.expand_path(File.join(File.dirname($0), "../lib")))
 
-require "sequel"
-
-Sequel.connect(ENV["DATABASE_URL"] || "postgres://localhost/yawl_examples")
+ENV["DATABASE_URL"] ||= "postgres://localhost/yawl_examples"
 
 require "yawl"
 require File.dirname(File.expand_path(__FILE__)) + "/steps/scrambled_eggs"

data/examples/cook_worker.rb

@@ -2,8 +2,7 @@
 
 $:.unshift(File.expand_path(File.join(File.dirname($0), "../lib")))
 
-require "sequel"
-Sequel.connect(ENV["DATABASE_URL"] || "postgres://localhost/yawl_examples")
+ENV["DATABASE_URL"] ||= "postgres://localhost/yawl_examples"
 
 require "yawl"
 require "yawl/worker"

data/lib/yawl.rb

@@ -7,6 +7,8 @@ end
 require "yawl/config"
 require "yawl/log"
 
+require "yawl/db"
+
 require "yawl/process"
 require "yawl/process_definitions"
 require "yawl/step"

data/lib/yawl/config.rb

@@ -2,13 +2,9 @@ module Yawl
   module Config
     extend self
 
-    attr_writer :app
+    attr_accessor :app
     attr_accessor :deploy
 
-    def app
-      @app || "yawl"
-    end
-
     def log_quiet?
       env("LOG_QUIET") == "1"
     end

data/lib/yawl/db.rb

@@ -0,0 +1,13 @@
+require 'sequel'
+require 'yawl/config'
+
+module Yawl
+  DB = Sequel.connect(ENV["DATABASE_URL"].gsub('postgresql://', 'postgres://'))
+  DB.extension :pg_json
+  DB.execute("SET bytea_output TO 'escape'")
+
+  if Config.log_sequel?
+    require 'logger'
+    DB.loggers << Logger.new($stdout)
+  end
+end

data/lib/yawl/log.rb

@@ -10,7 +10,12 @@ module Yawl
     end
 
     def log_measure(data)
-      measure_base = "#{Config.app}.#{data[:ns]}.#{data[:fn]}"
+      if Config.app
+        measure_base = "#{Config.app}.#{data[:ns]}.#{data[:fn]}"
+      else
+        measure_base = "#{data[:ns]}.#{data[:fn]}"
+      end
+
       begin
         t0 = Time.now
         log(data.merge(at: "start"))
@@ -28,7 +33,8 @@ module Yawl
       if Config.log_quiet?
         block.call if block
       else
-        params = { app: Config.app }
+        params = { }
+        params[:app] = Config.app if Config.app
         params[:source] = Config.deploy if Config.deploy
         Scrolls.log(params.merge(data), &block)
       end

data/lib/yawl/process.rb

@@ -15,7 +15,7 @@ module Yawl
     class RequestIdAttributeMismatch < RuntimeError; end
 
     def self.log(data, &block)
-      Log.log({ ns: "process" }.merge(data), &block)
+      Log.log({ ns: "yawl-process" }.merge(data), &block)
     end
 
     def log(data, &block)

data/lib/yawl/setup.rb

@@ -1,5 +1,7 @@
 require 'sequel'
 
+require 'yawl/db'
+
 Sequel.extension :migration
 
 module Yawl
@@ -41,17 +43,27 @@ module Yawl
       end
     end
 
-
     def create!
-      MIGRATION.apply(db, :up)
+      MIGRATION.apply(DB, :up)
     end
 
     def destroy!
-      MIGRATION.apply(db, :down)
+      MIGRATION.apply(DB, :down)
     end
 
-    def db
-      Sequel.connect(ENV["DATABASE_URL"])
+    def create_for_test!
+      if DB.tables.include?(:processes)
+        destroy!
+      end
+      create!
+
+      require "queue_classic"
+      QC::Setup.drop
+      QC::Setup.create
+
+      require "queue_classic/later"
+      QC::Later::Setup.drop
+      QC::Later::Setup.create
     end
   end
 end

data/lib/yawl/step.rb

@@ -22,7 +22,7 @@ module Yawl
     end
 
     def self.log(data, &block)
-      Log.log({ ns: "step" }.merge(data), &block)
+      Log.log({ ns: "yawl-step" }.merge(data), &block)
     end
 
     def log(data, &block)

data/lib/yawl/steps/base.rb

@@ -115,7 +115,7 @@ module Yawl
       end
 
       def log(data, &block)
-        Log.log({ ns: "step_#{name}" }.merge(data), &block)
+        Log.log({ ns: "yawl-step_#{name}" }.merge(data), &block)
       end
     end
 

data/lib/yawl/version.rb

@@ -1,3 +1,3 @@
 module Yawl
-  VERSION = "0.0.3"
+  VERSION = "0.1.0"
 end

data/spec/lib/step_spec.rb

@@ -0,0 +1,368 @@
+require "spec_helper"
+
+describe Yawl::Step do
+  let(:process) {
+    p = Yawl::Process.create(:desired_state => "tested")
+    p.start
+    p
+  }
+  let(:step) { process.unfinished_steps.first }
+
+  before do
+    Yawl::ProcessDefinitions.add :tested do |process|
+      process.add_step(:name => "testing")
+    end
+  end
+
+  def define_successful_step
+    Yawl::Steps.step :testing do
+      def run
+        puts "I worked"
+      end
+    end
+  end
+
+  def define_failing_step
+    Yawl::Steps.step :testing do
+      def run
+        puts "I started"
+        raise "I failed"
+      end
+    end
+  end
+
+  def define_sigterm_step
+    Yawl::Steps.step :testing do
+      def run
+        puts "I started"
+        raise SignalException.new("SIGTERM")
+      end
+    end
+  end
+
+  def define_one_shot_failing_step
+    Yawl::Steps.step :testing do
+      def run
+        puts "I started"
+        raise "I failed"
+      end
+
+      def attempts
+        1
+      end
+    end
+  end
+
+  def define_fatal_step
+    Yawl::Steps.step :testing do
+      def run
+        puts "I started"
+        raise Yawl::Step::Fatal
+      end
+    end
+  end
+
+  def define_sleepy_step
+    Yawl::Steps.step :testing do
+      def run
+        puts "I started"
+        sleep
+      end
+    end
+  end
+
+  def define_one_shot_sleepy_step
+    Yawl::Steps.step :testing do
+      def run
+        puts "I started"
+        sleep
+      end
+
+      def attempts
+        1
+      end
+    end
+  end
+
+  describe ".execute" do
+    before do
+      define_successful_step
+    end
+
+    it "executes a single step by id" do
+      Yawl::Step.execute(step.id)
+
+      step.reload.state.should == "completed"
+    end
+  end
+
+  describe ".restart_interrupted" do
+    before do
+      define_successful_step
+    end
+
+    it "starts steps in the interrupted state" do
+      step.update(:state => "interrupted")
+
+      Yawl::Step.restart_interrupted
+
+      step.should be_queued_for_now
+    end
+  end
+
+  describe "#start" do
+    before do
+      define_successful_step
+    end
+
+    it "enqueues the step for immediate execution" do
+      step.start
+
+      step.should be_queued_for_now
+    end
+
+    it "resets state to pending" do
+      step.update(:state => "failed")
+
+      step.start
+
+      step.state.should == "pending"
+    end
+  end
+
+  context "running a successful step" do
+    before do
+      define_successful_step
+    end
+
+    it "sets state to completed" do
+      step.execute
+
+      step.state.should == "completed"
+    end
+
+    it "notifies the process of completion" do
+      step.process.should_receive(:step_finished)
+
+      step.execute
+    end
+
+    it "captures output" do
+      step.execute
+
+      step.attempts.first.output.should == "I worked\n"
+    end
+  end
+
+  context "running a failing step" do
+    context "that has attempts remaining" do
+      before do
+        define_failing_step
+      end
+
+      it "sets state to pending" do
+        step.execute
+
+        step.state.should == "pending"
+      end
+
+      it "does not notify the process of failure" do
+        step.process.should_not_receive(:step_failed)
+
+        step.execute
+      end
+
+      it "is queued for retry" do
+        step.execute
+
+        step.should be_queued_for_later
+      end
+
+      it "captures output" do
+        step.execute
+
+        step.attempts.first.output.should =~ /\AI started\n\n\n---\nCAUGHT ERROR: I failed\n.*:in `.*'/ # backtrace
+      end
+    end
+
+    context "running a fatal step" do
+      context "that has attempts remaining" do
+        before do
+          define_fatal_step
+        end
+
+        it "sets state to pending" do
+          expect {
+            step.execute
+          }.to raise_error(Yawl::Step::Fatal)
+
+          step.state.should == "failed"
+        end
+
+        it "does not notify the process of failure" do
+          step.process.should_receive(:step_failed)
+
+          expect {
+            step.execute
+          }.to raise_error(Yawl::Step::Fatal)
+        end
+
+        it "is not queued for retry" do
+          expect {
+            step.execute
+          }.to raise_error(Yawl::Step::Fatal)
+
+          step.should_not be_queued_for_later
+        end
+
+        it "captures output" do
+          expect {
+            step.execute
+          }.to raise_error(Yawl::Step::Fatal)
+
+          step.attempts.first.output.should =~ /\AI started\n\n\n---\nCAUGHT ERROR: Fatal error in step\n.*:in `.*'/ # backtrace
+        end
+      end
+    end
+
+    context "that has no attempts remaining" do
+      before do
+        define_one_shot_failing_step
+      end
+
+      it "passes the error through" do
+        expect {
+          step.execute
+        }.to raise_error("I failed")
+      end
+
+      it "sets state to failed" do
+        expect { step.execute }.to raise_error
+
+        step.state.should == "failed"
+      end
+
+      it "notifies the process of failure" do
+        step.process.should_receive(:step_failed)
+
+        expect { step.execute }.to raise_error
+      end
+
+      it "is not queued for retry" do
+        expect { step.execute }.to raise_error
+
+        step.should_not be_queued_for_later
+      end
+
+      it "captures output" do
+        expect { step.execute }.to raise_error
+
+        step.attempts.first.output.should =~ /\AI started\n\n\n---\nCAUGHT ERROR: I failed\n.*:in `.*'/
+      end
+    end
+
+    context "that fails due to SIGTERM" do
+      before do
+        define_sigterm_step
+      end
+
+      it "passes the error through" do
+        expect {
+          step.execute
+        }.to raise_error("SIGTERM")
+      end
+
+      it "sets state to interrupted" do
+        expect { step.execute }.to raise_error
+
+        step.state.should == "interrupted"
+      end
+
+      it "does not notify the process of failure" do
+        step.process.should_not_receive(:step_failed)
+
+        expect { step.execute }.to raise_error
+      end
+
+      it "is not queued for retry" do
+        expect { step.execute }.to raise_error
+
+        step.should_not be_queued_for_later
+      end
+
+      it "captures output" do
+        expect { step.execute }.to raise_error
+
+        step.attempts.first.output.should =~ /\AI started\n\n\n---\nCAUGHT ERROR: SIGTERM\n.*:in `.*'/ # backtrace
+      end
+    end
+  end
+
+  context "running a sleepy process" do
+    context "that has attempts remaining" do
+      before do
+        define_sleepy_step
+      end
+
+      it "sets state to pending" do
+        step.execute
+
+        step.state.should == "pending"
+      end
+
+      it "does not notify the process of failure" do
+        step.process.should_not_receive(:step_failed)
+
+        step.execute
+      end
+
+      it "is queued for retry" do
+        step.execute
+
+        step.should be_queued_for_later
+      end
+
+      it "captures output" do
+        step.execute
+
+        step.attempts.first.output.should =~ /\AI started\n\n\n---\nCAUGHT ERROR: Step slept\n.*:in `.*'/ # backtrace
+      end
+    end
+
+    context "that has no attempts remaining" do
+      before do
+        define_one_shot_sleepy_step
+      end
+
+      it "passes the error through" do
+        expect {
+          step.execute
+        }.to raise_error(Yawl::Step::Tired)
+      end
+
+      it "sets state to failed" do
+        expect { step.execute }.to raise_error
+
+        step.state.should == "failed"
+      end
+
+      it "notifies the process of failure" do
+        step.process.should_receive(:step_failed)
+
+        expect { step.execute }.to raise_error
+      end
+
+      it "is not queued for retry" do
+        expect { step.execute }.to raise_error
+
+        step.should_not be_queued_for_later
+      end
+
+      it "captures output" do
+        expect { step.execute }.to raise_error
+
+        step.attempts.first.output.should =~ /\AI started\n\n\n---\nCAUGHT ERROR: Step slept\n.*:in `.*'/ # backtrace
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,70 @@
+if ENV["CI"]
+  raise "ENV[DATABASE_URL] not set" unless ENV["DATABASE_URL"]
+else
+  ENV["DATABASE_URL"] = "postgres://localhost/yawl-test"
+end
+ENV["LOG_QUIET"] ||= "1"
+
+require "rspec"
+require "yawl"
+
+require "yawl/setup"
+
+Yawl::Setup.create_for_test!
+
+def QC.jobs
+  s = "SELECT * FROM queue_classic_jobs"
+  [QC::Conn.execute(s)].compact.flatten.
+    map {|j| j.reject {|k, v| !%w[q_name method args].include?(k) } }.
+    map {|j| j.merge("args" => JSON.parse(j["args"])) }.
+    map {|j| j.reject {|k, v| k == "args" && v.empty? } }
+end
+
+def QC.later_jobs
+  s = "SELECT * FROM queue_classic_later_jobs"
+  [QC::Conn.execute(s)].compact.flatten.
+    map {|j| j.reject {|k, v| !%w[q_name method args].include?(k) } }.
+    map {|j| j.merge("args" => JSON.parse(j["args"])) }.
+    map {|j| j.reject {|k, v| k == "args" && v.empty? } }
+end
+
+RSpec.configure do |c|
+  c.around(:each) do |example|
+    Yawl::DB.transaction(:rollback => :always) do
+      begin
+        QC::Conn.execute("BEGIN")
+        example.run
+      ensure
+        QC::Conn.execute("ROLLBACK")
+      end
+    end
+  end
+end
+
+RSpec::Matchers.define :be_queued_for_later do
+  match do |step|
+    QC.later_jobs.include?("q_name" => "default", "method" => "Yawl::Step.execute", "args" => [step.id])
+  end
+
+  failure_message_for_should do |step|
+    "expected #{step.inspect} to be queued for later in later jobs #{QC.later_jobs}"
+  end
+
+  failure_message_for_should_not do |step|
+    "expected #{step.inspect} to not be queued for later in later jobs #{QC.later_jobs}"
+  end
+end
+
+RSpec::Matchers.define :be_queued_for_now do
+  match do |step|
+    QC.jobs.include?("q_name" => "default", "method" => "Yawl::Step.execute", "args" => [step.id])
+  end
+
+  failure_message_for_should do |step|
+    "expected #{step.inspect} to be queued for now in jobs #{QC.jobs}"
+  end
+
+  failure_message_for_should_not do |step|
+    "expected #{step.inspect} to not be queued for now in jobs #{QC.jobs}"
+  end
+end

data/yawl.gemspec

@@ -21,8 +21,9 @@ Gem::Specification.new do |spec|
   spec.add_dependency "sequel"
   spec.add_dependency "scrolls"
   spec.add_dependency "queue_classic"
-  spec.add_dependency "queue_classic-later"
+  spec.add_dependency "queue_classic-later", ">= 0.3.0"
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yawl
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-29 00:00:00.000000000 Z
+date: 2014-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sequel
@@ -66,7 +66,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -74,7 +74,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -107,6 +107,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: Yet Another Workflow Library for Ruby
 email:
 - kiwi@null.cx
@@ -115,6 +131,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -124,6 +141,7 @@ files:
 - examples/steps/scrambled_eggs.rb
 - lib/yawl.rb
 - lib/yawl/config.rb
+- lib/yawl/db.rb
 - lib/yawl/log.rb
 - lib/yawl/process.rb
 - lib/yawl/process_definitions.rb
@@ -135,6 +153,8 @@ files:
 - lib/yawl/worker.rb
 - migrations/01_setup_tables.rb
 - migrations/02_setup_queue_classic.rb
+- spec/lib/step_spec.rb
+- spec/spec_helper.rb
 - yawl.gemspec
 homepage: https://github.com/ricardochimal/yawl
 licenses:
@@ -151,7 +171,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1266345301425141028
+      hash: -3718802543540648108
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -160,11 +180,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1266345301425141028
+      hash: -3718802543540648108
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Yet Another Workflow Library for Ruby
-test_files: []
+test_files:
+- spec/lib/step_spec.rb
+- spec/spec_helper.rb