simple_worker 0.3.14 → 0.3.15

data/README.markdown

@@ -103,3 +103,22 @@ Setup:
 
 Now you can use your workers like their part of your app!
 
+
+Configuration Options
+---------------------
+
+### Global Attributes
+
+These are attributes that can be set as part of your config block then will be set on
+all your worker objects automatically. This is particularly good for things like database
+connection info or things that you would need to use across the board.
+
+Eg:
+
+    config.global_attributes[:db_user] = "sa"
+    config.global_attributes[:db_pass] = "pass"
+
+Then in your worker, you must have:
+
+    attr_accessor :db_user, :db_pass
+

data/lib/simple_worker/base.rb

@@ -1,181 +1,211 @@
-# This is an abstract module that developers creating works can mixin/include to use the SimpleWorker special functions.
-
-require 'digest/md5'
-
-module SimpleWorker
-
-    class Base
-
-        attr_accessor :task_set_id, :task_id, :schedule_id
-
-        class << self
-            attr_accessor :subclass, :caller_file
-            @merged = []
-            @merged_workers = []
-
-            def reset!
-                @merged = []
-                @merged_workers = []
-            end
-
-            def inherited(subclass)
-                subclass.reset!
-
-#                puts "subclass.inspect=" + subclass.inspect
-#                puts 'existing caller=' + (subclass.instance_variable_defined?(:@caller_file) ? subclass.instance_variable_get(:@caller_file).inspect : "nil")
-#                puts "caller=" + caller.inspect
-#                splits = caller[0].split(":")
-#                caller_file = splits[0] + ":" + splits[1]
-                caller_file = caller[0][0...(caller[0].index(":in"))]
-                caller_file = caller_file[0...(caller_file.rindex(":"))]
-#                puts 'caller_file=' + caller_file
-                # don't need these class_variables anymore probably
-                subclass.instance_variable_set(:@caller_file, caller_file)
-
-                super
-            end
-
-            # merges the specified files.
-            def merge(*files)
-                files.each do |f|
-                    unless File.exist? f
-                        raise "File not found: " + f
-                    end
-                    require f
-                    @merged << File.expand_path(f)
-                end
-            end
-
-            def merge_worker(file, class_name)
-                puts 'merge_worker in ' + self.name
-                merge(file)
-                @merged_workers << [File.expand_path(file), class_name]
-            end
-        end
-
-
-        def log(str)
-            puts str.to_s
-        end
-
-        def user_dir
-            "."
-        end
-
-        def set_progress(hash)
-            puts 'set_progress: ' + hash.inspect
-        end
-
-        def who_am_i?
-            return self.class.name
-        end
-
-        def uploaded?
-            self.class.instance_variable_defined?(:@uploaded) && self.class.instance_variable_get(:@uploaded)
-        end
-
-
-        # Will send in all instance_variables.
-        def queue
-            puts 'in queue'
-            upload_if_needed
-
-            response = SimpleWorker.service.queue(self.class.name, sw_get_data)
-            puts 'queue response=' + response.inspect
-            @task_set_id = response["task_set_id"]
-            @task_id = response["tasks"][0]["task_id"]
-            response
-        end
-
-        def status
-            SimpleWorker.service.status(task_id)
-        end
-
-        def upload
-            upload_if_needed
-        end
-
-        def schedule(schedule)
-            upload_if_needed
-
-            response = SimpleWorker.service.schedule(self.class.name, sw_get_data, schedule)
-            puts 'schedule response=' + response.inspect
-            @schedule_id = response["schedule_id"]
-            response
-        end
-
-        def schedule_status
-            SimpleWorker.service.schedule_status(schedule_id)
-        end
-
-        # Callbacks for developer
-        def before_upload
-
-        end
-
-        def after_upload
-
-        end
-
-        def before_run
-
-        end
-
-        def after_run
-
-        end
-
-        private
-
-        def upload_if_needed
-
-            before_upload
-
-            puts 'upload_if_needed'
-            # Todo, watch for this file changing or something so we can reupload
-            unless uploaded?
-                subclass = self.class
-                rfile = subclass.instance_variable_get(:@caller_file) # Base.caller_file # File.expand_path(Base.subclass)
-                puts 'rfile=' + rfile.inspect
-                puts 'self.class.name=' + subclass.name
-                merged = self.class.instance_variable_get(:@merged)
-                puts 'merged1=' + merged.inspect
-                superclass = subclass
-                # Also get merged from subclasses up to SimpleWorker::Base
-                while (superclass = superclass.superclass)
-                    puts 'superclass=' + superclass.name
-                    break if superclass.name == SimpleWorker::Base.name
-                    super_merged = superclass.instance_variable_get(:@merged)
-#                     puts 'merging caller file: ' + superclass.instance_variable_get(:@caller_file).inspect
-                    super_merged << superclass.instance_variable_get(:@caller_file)
-                    merged = super_merged + merged
-                    puts 'merged with superclass=' + merged.inspect
-
-                end
-                SimpleWorker.service.upload(rfile, subclass.name, :merge=>merged)
-                self.class.instance_variable_set(:@uploaded, true)
-            else
-                puts 'already uploaded for ' + self.class.name
-            end
-            puts 'uploading merged workers'
-            self.class.instance_variable_get(:@merged_workers).each do |mw|
-                # to support merges in the secondary worker, we should instantiate it here, then call "upload"
-                puts 'instantiating and uploading ' + mw[1]
-                Kernel.const_get(mw[1]).new.upload
-#                    SimpleWorker.service.upload(mw[0], mw[1])
-            end
-
-            after_upload
-        end
-
-        def sw_get_data
-            data = {}
-            self.instance_variables.each do |iv|
-                data[iv] = instance_variable_get(iv)
-            end
-            return data
-        end
-
-
-    end
-end
+# This is an abstract module that developers creating works can mixin/include to use the SimpleWorker special functions.
+
+require 'digest/md5'
+
+module SimpleWorker
+
+    class Base
+
+        attr_accessor :task_set_id, :task_id, :schedule_id
+
+        class << self
+            attr_accessor :subclass, :caller_file
+            @merged = []
+            @merged_workers = []
+
+            def reset!
+                @merged = []
+                @merged_workers = []
+            end
+
+            def inherited(subclass)
+                subclass.reset!
+
+#                puts "subclass.inspect=" + subclass.inspect
+#                puts 'existing caller=' + (subclass.instance_variable_defined?(:@caller_file) ? subclass.instance_variable_get(:@caller_file).inspect : "nil")
+#                puts "caller=" + caller.inspect
+#                splits = caller[0].split(":")
+#                caller_file = splits[0] + ":" + splits[1]
+                caller_file = caller[0][0...(caller[0].index(":in"))]
+                caller_file = caller_file[0...(caller_file.rindex(":"))]
+#                puts 'caller_file=' + caller_file
+                # don't need these class_variables anymore probably
+                subclass.instance_variable_set(:@caller_file, caller_file)
+
+                super
+            end
+
+            # merges the specified files.
+            def merge(*files)
+                files.each do |f|
+                    unless File.exist? f
+                        raise "File not found: " + f
+                    end
+                    require f
+                    @merged << File.expand_path(f)
+                end
+            end
+
+            def merge_worker(file, class_name)
+                puts 'merge_worker in ' + self.name
+                merge(file)
+                @merged_workers << [File.expand_path(file), class_name]
+            end
+        end
+
+
+        def log(str)
+            puts str.to_s
+        end
+
+        def user_dir
+            "."
+        end
+
+        def set_progress(hash)
+            puts 'set_progress: ' + hash.inspect
+        end
+
+        def who_am_i?
+            return self.class.name
+        end
+
+        def uploaded?
+            self.class.instance_variable_defined?(:@uploaded) && self.class.instance_variable_get(:@uploaded)
+        end
+
+        # Call this if you want to run locally and get some extra features from this gem like global attributes.
+        def run_local
+#            puts 'run_local'
+            set_global_attributes
+            run
+        end
+
+        def set_global_attributes
+            ga = SimpleWorker.config.global_attributes
+            if ga && ga.size > 0
+                ga.each_pair do |k,v|
+#                    puts "k=#{k} v=#{v}"
+                    if self.respond_to?(k)
+                        self.send("#{k}=", v)
+                    end
+                end
+            end
+        end
+
+        # Will send in all instance_variables.
+        def queue
+#            puts 'in queue'
+            set_global_attributes
+            upload_if_needed
+
+            response = SimpleWorker.service.queue(self.class.name, sw_get_data)
+#            puts 'queue response=' + response.inspect
+            @task_set_id = response["task_set_id"]
+            @task_id = response["tasks"][0]["task_id"]
+            response
+        end
+
+        def status
+            SimpleWorker.service.status(task_id)
+        end
+
+        def upload
+            upload_if_needed
+        end
+
+        #
+        # schedule: hash of scheduling options that can include:
+        #     Required:
+        #     - start_at:      Time of first run - DateTime or Time object.
+        #     Optional:
+        #     - run_every:     Time in seconds between runs. If ommitted, task will only run once.
+        #     - delay_type:    Fixed Rate or Fixed Delay. Default is fixed_delay.
+        #     - end_at:        Scheduled task will stop running after this date (optional, if ommitted, runs forever or until cancelled)
+        #     - run_times:     Task will run exactly :run_times. For instance if :run_times is 5, then the task will run 5 times.
+        #
+        def schedule(schedule)
+            set_global_attributes
+            upload_if_needed
+
+            response = SimpleWorker.service.schedule(self.class.name, sw_get_data, schedule)
+#            puts 'schedule response=' + response.inspect
+            @schedule_id = response["schedule_id"]
+            response
+        end
+
+        def schedule_status
+            SimpleWorker.service.schedule_status(schedule_id)
+        end
+
+        # Callbacks for developer
+        def before_upload
+
+        end
+
+        def after_upload
+
+        end
+
+        def before_run
+
+        end
+
+        def after_run
+
+        end
+
+        private
+
+        def upload_if_needed
+
+            before_upload
+
+            puts 'upload_if_needed'
+            # Todo, watch for this file changing or something so we can reupload
+            unless uploaded?
+                subclass = self.class
+                rfile = subclass.instance_variable_get(:@caller_file) # Base.caller_file # File.expand_path(Base.subclass)
+                puts 'rfile=' + rfile.inspect
+                puts 'self.class.name=' + subclass.name
+                merged = self.class.instance_variable_get(:@merged)
+                puts 'merged1=' + merged.inspect
+                superclass = subclass
+                # Also get merged from subclasses up to SimpleWorker::Base
+                while (superclass = superclass.superclass)
+                    puts 'superclass=' + superclass.name
+                    break if superclass.name == SimpleWorker::Base.name
+                    super_merged = superclass.instance_variable_get(:@merged)
+#                     puts 'merging caller file: ' + superclass.instance_variable_get(:@caller_file).inspect
+                    super_merged << superclass.instance_variable_get(:@caller_file)
+                    merged = super_merged + merged
+                    puts 'merged with superclass=' + merged.inspect
+
+                end
+                SimpleWorker.service.upload(rfile, subclass.name, :merge=>merged)
+                self.class.instance_variable_set(:@uploaded, true)
+            else
+                puts 'already uploaded for ' + self.class.name
+            end
+            puts 'uploading merged workers'
+            self.class.instance_variable_get(:@merged_workers).each do |mw|
+                # to support merges in the secondary worker, we should instantiate it here, then call "upload"
+                puts 'instantiating and uploading ' + mw[1]
+                Kernel.const_get(mw[1]).new.upload
+#                    SimpleWorker.service.upload(mw[0], mw[1])
+            end
+
+            after_upload
+        end
+
+        def sw_get_data
+            data = {}
+            self.instance_variables.each do |iv|
+                data[iv] = instance_variable_get(iv)
+            end
+            return data
+        end
+
+
+    end
+end

data/lib/simple_worker/config.rb

@@ -1,8 +1,20 @@
 module SimpleWorker
+
+
+    # Config is used to setup the SimpleWorker client.
+    # You must set the access_key and secret_key.
+    #
+    # config.global_attributes allows you to specify attributes that will automatically be set on every worker,
+    #    this is good for database connection information or things that will be used across the board.
     class Config
         attr_accessor :access_key,
                       :secret_key,
-                      :host
+                      :host,
+                      :global_attributes
+
+        def initialize
+            @global_attributes = {}
+        end
     end
 
 end

data/test/test_base.rb

@@ -26,6 +26,9 @@ class TestBase < Test::Unit::TestCase
             config.access_key = @access_key
             config.secret_key = @secret_key
             config.host = "http://localhost:3000/api/"
+            config.global_attributes["db_user"] = "sa"
+            config.global_attributes["db_pass"] = "pass"
+
         end
     end
 end

data/test/test_simple_worker.rb

@@ -1,6 +1,6 @@
 
 
-require 'test_base'
+require_relative 'test_base'
 
 class SimpleWorkerTests < TestBase
 
@@ -38,6 +38,18 @@ class SimpleWorkerTests < TestBase
         assert tw.status["status"] == "complete"
 
     end
+
+    def test_global_attributes
+        worker = TestWorker3.new
+        worker.run_local
+
+        puts 'worker=' + worker.inspect
+
+        assert_equal "sa", worker.db_user
+        assert_equal "pass", worker.db_pass
+        assert_equal 123, worker.x
+
+    end
 #
 #
 #    def test_queue

data/test/test_worker_2.rb

@@ -8,8 +8,8 @@ end
 # Bump for new checksum.sdf
 class TestWorker2 < SimpleWorker::Base
 
-    merge 'models/model_1.rb'
-    merge_worker 'second_worker.rb', 'SecondWorker'
+    merge File.join(File.dirname(__FILE__), 'models', 'model_1.rb')
+    merge_worker File.join(File.dirname(__FILE__), 'second_worker.rb'), 'SecondWorker'
 
     attr_accessor :s3_key, :times, :x
 

data/test/test_worker_3.rb

@@ -4,15 +4,16 @@ rescue Exception => ex
     puts ex.message
     require 'simple_worker'
 end
-require 'test_worker_2'
+require_relative 'test_worker_2'
 
 class TestWorker3 < TestWorker2
 
 
-    attr_accessor :s3_key, :times
+    attr_accessor :x, :db_user, :db_pass
 
     def run()
-
+        puts 'TestWorker3.run'
+        @x = 123
     end
 
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 3
-  - 14
-  version: 0.3.14
+  - 15
+  version: 0.3.15
 platform: ruby
 authors: 
 - Travis Reeder
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-26 00:00:00 -07:00
+date: 2010-11-18 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -58,8 +58,8 @@ homepage: http://github.com/appoxy/simple_worker
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement