lev 4.1.0 → 4.2.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NmIyODE2NzY1ZTAwZjA4YzZmY2NmYzYyNzFiZmVmOGJhMWE4MzNkYw==
+    MTgxYzgyOGI5NmQwYzE2MWM0NGI2NjZiMTIzM2U5NDk5ZGZiZjZkYw==
   data.tar.gz: !binary |-
-    MWE4YzcxOWFkYmU2ZTQ5ZjllMDg0MWQ3NTdkZTVhNjZjYjFjZWUzMA==
+    ZGIyNGMyNDdmZGY1NjM0NmZmY2E5NTMwODU2MDJmMTU1YTYwYjM4OQ==
 SHA512:
   metadata.gz: !binary |-
-    ZTExN2U3Njg2MmM2OTQ0NTk0NDZmYjk2NDU4NmE1NjBmOTIwNDJlMzY3MGRk
-    MTc5NmRiMjJhNTljMjc3Yzg2OGE2NmU1Y2IwMDQ1ZDlkYTA4MjI4N2QzODA0
-    NzZlMGMyYWYzMzEyM2QyM2UyN2EzY2NlN2FjYjdlMjQyYWU0NjA=
+    N2FhODUwZmE3ZTM3NDJlMGM2N2JlM2YxNWExNDIxMDI0MzdlNmZlZGFmODFj
+    ZmM3NjY3ZWQ2M2FkMjFkMjI4NWY3MDFkNzJmYzc1MWY3YTMyN2VjZWZlYzky
+    MWIyZDlhMTA1MjY5YTQ2MDc1ZjhjMGM1OGU0ZGQyZThhZWJiMzc=
   data.tar.gz: !binary |-
-    MzA2YjM3ZTRiOWRlNzJiZWNjZDRhZWE5NWU1MjI5OGQ0OWZhMDdlZmJkNjFi
-    ZTE5YWRlNjljNDE4NTQ2ZWU3OTIzN2FhZTYyZGM2ODk0N2MyZjBkOGZhODRh
-    NzJhNTk5NDUyYjk3MGE0NGZkYTM0OGViNDA4MTA4MmNhNzhjYjM=
+    MmJkMjMwZDhhNjk1ZjRiYThiMzkzYjBkMmFlZmVjZGU1NGYyYjNlOGJhYjM4
+    MDU2YzI4NTg2OTQ0ZjdhYmM3OTkzZTU2Y2FjZTc0ZWRmYWVmZmMyZjdmNWNl
+    MTI0ODYwMDE1YzI0NWIzZGQzYTkxNDMzOTkzNGU3ZWZkOTdmMWQ=

data/README.md

@@ -63,6 +63,16 @@ Here's an example setting an error and an output:
       end
     end
 
+If you'd like the `fatal_error` to raise a `StandardError` immediately instead of bubbling up to the `Lev::Routine#errors` object, you must configure it:
+
+```ruby
+Lev.configure do |config|
+  config.raise_fatal_errors = true
+end
+```
+
+So if you `fatal_error(name: :is_blank)` it will raise `StandardError: "name is blank"`, or `fatal_error(thing: :is_broken, and: :messed_up)` it will raise `StandardError: "thing is broken - and messed up"`
+
 Additionally, see below for a discussion on how to transfer errors from ActiveRecord models.
 
 Any `StandardError` raised within a routine will be caught and transformed into a fatal error with `:kind` set to `:exception`.  The caller of this routine can choose to reraise this exception by calling `reraise_exception!` on the returned errors object:
@@ -376,6 +386,27 @@ Routine class have access to a few other methods:
 2. a `topmost_runner` accessor which points to the highest routine in the calling
    hierarchy (that routine whose 'runner' is nil)
 
+### Calling routines as ActiveJobs
+
+If `ActiveJob` is included in your project, you can invoke a routine to be run in the background.  E.g. instead of saying
+
+```ruby
+MyRoutine.call(arg1: 23, arg2: 'howdy')
+```
+
+You can say
+
+```ruby
+MyRoutine.perform_later(arg1: 23, arg2: 'howdy')
+```
+
+By default jobs are placed in the `:default` queue, but you can override this in the `lev_routine` call:
+
+```ruby
+class MyRoutine
+  lev_routine active_job_queue: :some_other_queue
+end
+```
 
 ## Handlers
 

data/lib/lev.rb

@@ -54,11 +54,13 @@ module Lev
       attr_accessor :form_error_class
       attr_accessor :security_transgression_error
       attr_accessor :illegal_argument_error
+      attr_accessor :raise_fatal_errors
 
       def initialize
         @form_error_class = 'error'
         @security_transgression_error = Lev::SecurityTransgression
         @illegal_argument_error = Lev::IllegalArgument
+        @raise_fatal_errors = false
         super
       end
     end

data/lib/lev/object.rb

@@ -8,6 +8,10 @@ class Object
       options[:transaction] ||= Lev::TransactionIsolation.mysql_default.symbol
       @transaction_isolation = Lev::TransactionIsolation.new(options[:transaction])
 
+      @active_job_queue = options[:active_job_queue]
+
+      @raise_fatal_errors = options[:raise_fatal_errors]
+
       @delegates_to = options[:delegates_to]
       if @delegates_to
         uses_routine @delegates_to,

data/lib/lev/routine.rb

@@ -206,6 +206,34 @@ module Lev
         result.outputs.send(@express_output)
       end
 
+      if defined?(ActiveJob)
+        def active_job_class
+          @active_job_class ||= const_set("ActiveJob",
+            Class.new(ActiveJob::Base) do
+              queue_as do
+                parent_routine.active_job_queue
+              end
+
+              def parent_routine
+                self.class.parent
+              end
+
+              def perform(*args, &block)
+                parent_routine.call(*args, &block)
+              end
+            end
+          )
+        end
+
+        def perform_later(*args, &block)
+          active_job_class.perform_later(*args, &block)
+        end
+
+        def active_job_queue
+          @active_job_queue || :default
+        end
+      end
+
       # Called at a routine's class level to foretell which other routines will
       # be used when this routine executes.  Helpful for figuring out ahead of
       # time what kind of transaction isolation level should be used.
@@ -239,6 +267,11 @@ module Lev
         @nested_routines ||= {}
       end
 
+      def raise_fatal_errors?
+        @raise_fatal_errors ||
+          (Lev.configuration.raise_fatal_errors && @raise_fatal_errors.nil?)
+      end
+
       def class_to_symbol(klass)
         klass.name.underscore.gsub('/','_').to_sym
       end
@@ -369,7 +402,11 @@ module Lev
     end
 
     def fatal_error(args={})
-      errors.add(true, args)
+      if topmost_runner.class.raise_fatal_errors?
+        raise StandardError, args.to_a.map { |i| i.join(' ') }.join(' - ')
+      else
+        errors.add(true, args)
+      end
     end
 
     def nonfatal_error(args={})

data/lib/lev/version.rb

@@ -1,3 +1,3 @@
 module Lev
-  VERSION = "4.1.0"
+  VERSION = "4.2.0"
 end

data/spec/active_job_routines_spec.rb

@@ -0,0 +1,27 @@
+require 'active_job'
+require 'spec_helper'
+
+ActiveJob::Base.queue_adapter = :test
+ActiveJob::Base.logger = ::Logger.new(nil)
+
+class LaterRoutine
+  lev_routine active_job_queue: :something_else
+
+  protected
+  def exec
+  end
+end
+
+RSpec.describe 'ActiveJob routines' do
+  it 'can perform routines later' do
+    expect {
+      LaterRoutine.perform_later
+    }.to change { ActiveJob::Base.queue_adapter.enqueued_jobs.count }.by(1)
+  end
+
+  it 'can have the default queue overridden' do
+    LaterRoutine.perform_later
+    queue_name = ActiveJob::Base.queue_adapter.enqueued_jobs.first[:queue]
+    expect(queue_name).to eq('something_else')
+  end
+end

data/spec/routine_spec.rb

@@ -4,16 +4,16 @@ describe Lev::Routine do
 
   before do
     stub_const 'RaiseError', Class.new
-    RaiseError.class_eval { 
-      lev_routine 
+    RaiseError.class_eval {
+      lev_routine
       def exec
         raise 'error message'
       end
     }
 
     stub_const 'RaiseStandardError', Class.new
-    RaiseStandardError.class_eval { 
-      lev_routine 
+    RaiseStandardError.class_eval {
+      lev_routine
       def exec
         unknown_method_call
       end
@@ -32,4 +32,88 @@ describe Lev::Routine do
     }.to raise_error(NameError)
   end
 
+  it 'allows not raising fatal errors to be overridden' do
+    stub_const 'NestedFatalError', Class.new
+    NestedFatalError.class_eval {
+      lev_routine
+
+      def exec
+        fatal_error(code: :its_broken)
+      end
+    }
+
+    stub_const 'SpecialFatalErrorOption', Class.new
+    SpecialFatalErrorOption.class_eval {
+      lev_routine raise_fatal_errors: true, delegates_to: NestedFatalError
+    }
+
+    stub_const 'NoFatalErrorOption', Class.new
+    NoFatalErrorOption.class_eval {
+      lev_routine
+      def exec
+        fatal_error(code: :no_propagate)
+      end
+    }
+
+    Lev.configure { |c| c.raise_fatal_errors = false }
+
+    expect {
+      SpecialFatalErrorOption.call
+    }.to raise_error
+
+    expect {
+      NoFatalErrorOption.call
+    }.not_to raise_error
+  end
+
+  it 'allows raising fatal errors config to be overridden' do
+    stub_const 'SpecialNoFatalErrorOption', Class.new
+    SpecialNoFatalErrorOption.class_eval {
+      lev_routine raise_fatal_errors: false
+      def exec
+        fatal_error(code: :its_broken)
+      end
+    }
+
+    Lev.configure { |c| c.raise_fatal_errors = true }
+
+    expect {
+      SpecialNoFatalErrorOption.call
+    }.not_to raise_error
+  end
+
+  context 'when raise_fatal_errors is configured true' do
+    before do
+      Lev.configure do |config|
+        config.raise_fatal_errors = true
+      end
+
+      stub_const 'RaiseFatalError', Class.new
+      RaiseFatalError.class_eval {
+        lev_routine
+        def exec
+          fatal_error(code: :broken, such: :disaster)
+        end
+      }
+    end
+
+    after do
+      Lev.configure do |config|
+        config.raise_fatal_errors = false
+      end
+    end
+
+    it 'raises an exception on fatal_error if configured' do
+      expect {
+        RaiseFatalError.call
+      }.to raise_error
+
+      begin
+        RaiseFatalError.call
+      rescue => e
+        expect(e.message).to eq('code broken - such disaster')
+      end
+    end
+  end
+
 end

data/spec/transaction_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+unless ActiveRecord::Migration.table_exists?(:models)
+  ActiveRecord::Migration.create_table(:models)
+end
+
+class Model < ActiveRecord::Base; end
+
+RSpec.describe 'Transactions' do
+  before do
+    stub_const 'RollBackTransactions', Class.new
+    stub_const 'NestedRoutine', Class.new
+
+    NestedRoutine.class_eval do
+      lev_routine
+
+      def exec
+        raise 'Rolled back'
+      end
+    end
+
+    RollBackTransactions.class_eval do
+      lev_routine
+
+      uses_routine NestedRoutine
+
+      def exec
+        Model.create!
+        run(:nested_routine)
+      end
+    end
+  end
+
+  context 'in nested routines' do
+    it 'rolls back on exceptions' do
+      expect {
+        RollBackTransactions.call
+      }.to raise_error
+
+      expect(Model.count).to eq(0)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lev
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 4.2.0
 platform: ruby
 authors:
 - JP Slavinsky
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-16 00:00:00.000000000 Z
+date: 2015-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -178,6 +178,20 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activejob
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -221,6 +235,7 @@ files:
 - lib/lev/transaction_isolation.rb
 - lib/lev/utilities.rb
 - lib/lev/version.rb
+- spec/active_job_routines_spec.rb
 - spec/create_sprocket_spec.rb
 - spec/deep_merge_spec.rb
 - spec/delegates_to_spec.rb
@@ -238,6 +253,7 @@ files:
 - spec/support/paramify_handler_b.rb
 - spec/support/sprocket.rb
 - spec/support/sprocket_handler.rb
+- spec/transaction_spec.rb
 homepage: http://github.com/lml/lev
 licenses:
 - MIT
@@ -263,6 +279,7 @@ signing_key:
 specification_version: 4
 summary: Ride the rails but don't touch them.
 test_files:
+- spec/active_job_routines_spec.rb
 - spec/create_sprocket_spec.rb
 - spec/deep_merge_spec.rb
 - spec/delegates_to_spec.rb
@@ -280,3 +297,4 @@ test_files:
 - spec/support/paramify_handler_b.rb
 - spec/support/sprocket.rb
 - spec/support/sprocket_handler.rb
+- spec/transaction_spec.rb