schlepper 0.9.1 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4506d586d2e1744bb829ee3b0def8bbe96b58856
-  data.tar.gz: bc1c5a139f20a668111719691395f2d0123a206a
+  metadata.gz: 3fa3e185f4b1e3af4ccaff4ad72af1207b4b36e3
+  data.tar.gz: 95a4032864b39ef3f9506764c446b04ad40b40ac
 SHA512:
-  metadata.gz: abe7e65630fc9c06207a2fd545e2142888d9efa896cd668a43b1ad2f6076a6749d8e659324484b830d2b4d01e74ce641caa4c61197495f3569fa24cc98d311b1
-  data.tar.gz: 09fee8ddd8f65b74b6ad135b261ff514872e442dea8eb339fc9642e0b125b27e9c3963eb0497f4034ada524815b7dc8c461c06c2d5ac55c3399024070492cff5
+  metadata.gz: 3944d556c0c8a83549355e4eb4466dd5e1c9308f458d066ce112521aabb4e4aafdb12129c347599dea8cb194bf52812a8154c32f342866ddb286ae12a719f8c8
+  data.tar.gz: 0a5e9b939b61b8ee2ba5ac5e6511d7923b21fdc0f6343d423e9ff64e17ac7fa5544cc5d8cad03f581693b8e1c2b1dcdaae10c08cfc253e4cdf0fd7949bb2e75a

data/README.md

@@ -47,6 +47,14 @@ override:
 class NameOfTask < Schlepper::Task
   attr_reader :failure_message
 
+  # Signals to the task runner that this task will control its own transaction.
+  # When true the task runner will not open a transaction.
+  # Use with caution.
+  # @return [Boolean] 
+  def controls_transaction?
+    false
+  end
+
   # @return [String] A short note on what the purpose of this task is
   def description
     <<-DOC.strip_heredoc
@@ -82,6 +90,9 @@ of the `run` method. You must return a literal `true` to signal to the task runn
 has completed successfully. Any return value other than `true` will signal to the task runner
 that this task has not completed successfully, and will not be marked as successful.
 
+The method `controls_transaction?` is optional. If it returns `true`, the task
+won't run in a transaction, and returning `false` from `run` won't roll anything back.
+
 Also take note of the instance variable `@failure_message`. Setting this to something
 descriptive if your task fails provides meaningful output to the person running the task.
 
@@ -103,6 +114,8 @@ Use `rake schlepper:run` to start the task running process. The task running pro
     - Roll back transaction
     - Display the name of the owner, and @failure\_message if provided
 
+The transaction steps are skipped if `controls_transaction?` is defined and returns `true`.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/schlepper/process.rb

@@ -74,27 +74,23 @@ module Schlepper
     end
 
     private def process_one klass
-      runner = klass.new
+      task = klass.new
 
       puts ''
-      puts "Processing #{klass.name} from #{runner.owner}:"
-      puts "#{runner.description}"
+      puts "Processing #{klass.name} from #{task.owner}:"
+      puts "#{task.description}"
       puts ''
 
-      ActiveRecord::Base.transaction do
-        if runner.run
-          ActiveRecord::Base.connection.execute <<-SQL
-            INSERT INTO schlepper_tasks (version, owner, description, completed_at)
-            VALUES (#{runner.version_number}, #{ActiveRecord::Base.sanitize(runner.owner)}, #{ActiveRecord::Base.sanitize(runner.description)}, #{ActiveRecord::Base.connection.quote(Time.now.to_s(:db))});
-          SQL
-        else
-          puts "#{klass.name} ran without errors, but was not successful"
-          if runner.failure_message
-            puts "The resulting failure was: #{runner.failure_message}"
-          else
-            puts "The failure message was not set. Find #{runner.owner} to help investigate"
+      if task.controls_transaction?
+        status = run_task_for task
+        log_error(klass.name, task.failure_message, task.owner) unless status
+      else
+        ActiveRecord::Base.transaction do
+          status = run_task_for task
+          unless status
+            log_error(klass.name, task.failure_message, task.owner)
+            fail ActiveRecord::Rollback
           end
-          fail ActiveRecord::Rollback
         end
       end
 
@@ -102,5 +98,27 @@ module Schlepper
       puts "Finished #{klass.name}"
       puts '~~~~~~~~~~~~~~~~~~~~~'
     end
+
+    private def run_task_for(task)
+      status = task.run
+
+      if status
+        ActiveRecord::Base.connection.execute <<-SQL
+          INSERT INTO schlepper_tasks (version, owner, description, completed_at)
+          VALUES (#{task.version_number}, #{ActiveRecord::Base.sanitize(task.owner)}, #{ActiveRecord::Base.sanitize(task.description)}, #{ActiveRecord::Base.connection.quote(Time.now.to_s(:db))});
+        SQL
+      end
+
+      status
+    end
+
+    private def log_error(name, message, owner)
+      puts "#{name} ran without errors, but was not successful"
+      if message
+        puts "The resulting failure was: #{message}"
+      else
+        puts "The failure message was not set. Find #{owner} to help investigate"
+      end
+    end
   end
 end

data/lib/schlepper/task.rb

@@ -23,6 +23,14 @@ module Schlepper
       @version_number ||= File.basename(method(:run).source_location.first).scan(/\A(\d{10,})/).first.first
     end
 
+    # Signals to the task runner that this task will control its own transaction.
+    # When true the task runner will not open a transaction.
+    # Use with caution.
+    # @return [Boolean]
+    def controls_transaction?
+      false
+    end
+
     # @return [String] Short note on the intent of this script
     # @abstract
     abstract def description

data/lib/schlepper/version.rb

@@ -1,3 +1,3 @@
 module Schlepper
-  VERSION = '0.9.1'
+  VERSION = '0.10.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: schlepper
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.10.1
 platform: ruby
 authors:
 - Rory O'Connell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-20 00:00:00.000000000 Z
+date: 2017-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -171,7 +171,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
 summary: Adds tracking of one off data scripts for Rails.