jobly 0.4.6 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b8a8edcc7454410166815e6adf0f105f71d0d741dc9e61b82ca61e7814c6b671
-  data.tar.gz: 7e87bb039d4dc9f608ebf747f31aa133ec67dc81a794c683fb0840dd3aeb352c
+  metadata.gz: b656a4bd0004a23f887711cc2c1d9813bb25a83549687d7ec84cd87878bf0aa6
+  data.tar.gz: 4044fda2137858843f2e951cee9a8a8a1e50fda6a217f8d40f700ab6e86b8da8
 SHA512:
-  metadata.gz: ae811324a752834c19ffa0bd116ef121c39d7b8bbbff95e2814155b4be3276662e641b268c1b62c247c6672de6f8c1ae11542d9e040f383c47070f0a3fa030d3
-  data.tar.gz: b682abaf3ac3005861d5546e5650ba51bb0b432c4c896b630d304b02c63fe1efeff2d81712a51351fe89cab301b98d16a910f58adb725a376b31c9dd167b65c3
+  metadata.gz: 7d67e9bb33ab98774b0493f2785291934a999de99ac50b606e25e44c96ebe1fdab2251bf274f63892a6e60ea060075dd17ac156ce4b22dcbccf72e88ae9b493a
+  data.tar.gz: 04d847fb7b1874317d5ef050178926628f1fceffd32a5ac1006e8d45291ebd8ddbe750773fbe9969beae511f751c98c89e83520f6e13c4511941b14a95f0dd63

data/lib/jobly/api.rb

@@ -62,9 +62,9 @@ module Jobly
 
       args = args.convert_to_typed
       if args.empty?
-        job_class.perform_async
+        job_class.run_later
       else
-        job_class.perform_async args
+        job_class.run_later args
       end
       
       response = {

data/lib/jobly/commands/run.rb

@@ -22,14 +22,14 @@ module Jobly
         if args['--later']
           say "Scheduling !txtgrn!#{job_class}"
           if params.empty?
-            job_class.perform_async
+            job_class.run_later
           else
-            job_class.perform_async params
+            job_class.run_later params
           end
         
         else
           say "Running !txtgrn!#{job_class}"
-          job_class.new.perform params
+          job_class.run params
         end
       end
 

data/lib/jobly/job.rb

@@ -5,6 +5,7 @@ module Jobly
     include JobExtensions::OptionAccessors
     include JobExtensions::Actions
     include JobExtensions::Solo
+    include JobExtensions::Isolation
 
     # Helpers must come after Sidekiq::Worker since they both bring logger
     # and our logger is the king of loggers
@@ -17,35 +18,39 @@ module Jobly
     attr_reader :params
 
     class << self
-      # Allow inheriting jobs to use `execute_async` instead of 
-      # `perform_async` for consistency with `execute`
-      alias_method :execute_async, :perform_async
-
-      # Allow calling a job with `JobName.execute` instead of 
-      # `JobName.new.execute`, for consistency.
-      def execute(*args)
-        new.execute *args
+      # Allow running a job with `JobName.run`
+      def run(params = {})
+        new.perform params
       end
 
-      # Allow calling a job with `JobName.perform` instead of 
-      # `JobName.new.perform`, for consistency.
-      def perform(*args)
-        new.perform *args
+      # Allow running a job asynchronously with `JobName.run_later`
+      def run_later(params = {})
+        perform_async params
       end
-
     end
 
     # This is the method sidekiq will call. We capture this call and convert
     # the hash argument which was converted to array on sidekiq's side, back
     # to a hash so we can forward to the job's `execute` method, which may 
     # implement keyword args.
-    def perform(params={})
+    # If the job was marked as isolated, we will run it in its own temporary
+    # directory.
+    def perform(params = {})
+      if isolated?
+        in_isolation { perform! params }
+      else
+        perform! params
+      end
+    end
+
+    # Run the job with its filters and actions.
+    def perform!(params = {})
       @params = params
       run_to_completion if run_before_filter
     end
 
     # Inheriting classes must implement this method only.
-    def execute(params={})
+    def execute(params = {})
       raise NotImplementedError
     end
 

data/lib/jobly/job_extensions/isolation.rb

@@ -0,0 +1,27 @@
+module Jobly
+  module JobExtensions
+    module Isolation
+      def self.included(base)
+        base.extend ClassMethods
+      end
+
+      module ClassMethods
+        attr_reader :isolate
+
+        def isolated(enabled = true)
+          @isolate = enabled
+        end
+      end
+
+      def in_isolation
+        Dir.mktmpdir 'jobly-' do |dir|
+          Dir.chdir(dir) { yield }
+        end
+      end
+
+      def isolated?
+        self.class.isolate
+      end
+    end
+  end
+end

data/lib/jobly/version.rb

@@ -1,3 +1,3 @@
 module Jobly
-  VERSION = "0.4.6"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jobly
 version: !ruby/object:Gem::Version
-  version: 0.4.6
+  version: 0.5.0
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-01 00:00:00.000000000 Z
+date: 2020-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -272,6 +272,7 @@ files:
 - lib/jobly/helpers/slack.rb
 - lib/jobly/job.rb
 - lib/jobly/job_extensions/actions.rb
+- lib/jobly/job_extensions/isolation.rb
 - lib/jobly/job_extensions/option_accessors.rb
 - lib/jobly/job_extensions/solo.rb
 - lib/jobly/jobs.rb