simple_worker 0.3.19 → 0.3.20

data/README.markdown

@@ -45,10 +45,12 @@ Let's say someone does something in your app and you want to send an email about
     worker.to = current_user.email
     worker.subject = "Here is your mail!"
     worker.body = "This is the body"
-    **worker.run**
+    worker.run_local
 
-Queue up your Worker
---------------------
+Once you've got it working locally, the next step is to run it on the SimpleWorker cloud.
+
+Queue up your Worker on the SimpleWorker Cloud
+----------------------------------------------
 
 Let's say someone does something in your app and you want to send an email about it.
 
@@ -56,7 +58,9 @@ Let's say someone does something in your app and you want to send an email about
     worker.to = current_user.email
     worker.subject = "Here is your mail!"
     worker.body = "This is the body"
-    **worker.queue**
+    worker.queue
+
+This will send it off to the SimpleWorker cloud.
 
 Schedule your Worker
 --------------------
@@ -68,7 +72,7 @@ action in your application. This is almost the same as queuing your worker.
     worker.to = current_user.email
     worker.subject = "Here is your mail!"
     worker.body = "This is the body"
-    **worker.schedule(:start_at=>1.hours.since)**
+    worker.schedule(:start_at=>1.hours.since)
 
 Check Status
 ------------
@@ -79,7 +83,7 @@ If you still have access to the worker object, just call:
 
 If you only have the job ID, call:
 
-    SimpleWorker.status(job_id)
+    SimpleWorker.service.status(job_id)
 
 This will return a hash like:
 
@@ -91,22 +95,27 @@ This will return a hash like:
      "duration"=>nil,
      "progress"=>{"percent"=>25}}
 
-TODO: How to access log.
 
 Logging
 -------
 
+In your worker, just call the log method with the string you want logged:
+
     log "Starting to do something..."
 
-The log will be available for viewing via the SimpleWorker UI or via log in the API.
+The log will be available for viewing via the SimpleWorker UI or via log in the API:
+
+    SimpleWorker.service.log(job_id)
 
 Setting Progress
 ----------------
 
-    set_progress(:percent => 25, :message => "We are a quarter of the way there!")
+This is just a way to let your users know where the job is at if required.
 
-You can actually put anything in this hash and it will be returned with a call to status.
+    set_progress(:percent => 25, :message => "We are a quarter of the way there!")
 
+You can actually put anything in this hash and it will be returned with a call to status. We recommend using
+the format above for consistency and to get some additional features where we look for these values.
 
 Schedule a Recurring Job - CRON
 ------------------------------
@@ -178,6 +187,9 @@ Or simpler yet, try using relative paths:
     merge "../app/models/user"
     merge "../app/models/account.rb"
 
+The opposite can be done as well with "unmerge" and can be useful when using Rails to exclude classes that are automatically
+merged.
+
 
 Bringing in other Workers
 ---------------------

data/lib/railtie.rb

@@ -5,7 +5,7 @@ require 'rails'
 
 module SimpleWorker
   class Railtie < Rails::Railtie
-    railtie_name :simple_worker
+#    railtie_name :simple_worker deprecated
 
     initializer "simple_worker.configure_rails_initialization" do |app|
       puts 'railtie'

data/lib/simple_worker.rb

@@ -17,8 +17,12 @@ module SimpleWorker
       yield(config)
       SimpleWorker.service = Service.new(config.access_key, config.secret_key, :config=>config)
     end
+
+ 
   end
 
+
+
 end
 
 if defined?(Rails)

data/lib/simple_worker/base.rb

@@ -12,10 +12,12 @@ module SimpleWorker
       attr_accessor :subclass, :caller_file
       @merged         = []
       @merged_workers = []
+      @unmerged       = []
 
       def reset!
         @merged         = []
         @merged_workers = []
+        @unmerged       = []
       end
 
       def inherited(subclass)
@@ -35,30 +37,47 @@ module SimpleWorker
         super
       end
 
+      def check_for_file(f)
+        f = f.to_str
+        unless ends_with?(f, ".rb")
+          f << ".rb"
+        end
+        exists = false
+        if File.exist? f
+          exists = true
+        else
+          # try relative
+#          p caller
+          f2 = File.join(File.dirname(caller[3]), f)
+          puts 'f2=' + f2
+          if File.exist? f2
+            exists = true
+            f      = f2
+          end
+        end
+        unless exists
+          raise "File not found: " + f
+        end
+        f = File.expand_path(f)
+        require f
+        f
+      end
+
       # merges the specified files.
       # todo: don't allow multiple files per merge, just one like require
       def merge(*files)
         files.each do |f|
-          f = f.to_str
-          unless ends_with?(f, ".rb")
-            f << ".rb"
-          end
-          exists = false
-          if File.exist? f
-            exists = true
-          else
-            # try relative
-            f2 = File.join(File.dirname(caller[0]), f)
-            if File.exist? f2
-              exists = true
-              f = f2
-            end
-          end
-          unless exists
-            raise "File not found: " + f
-          end
-          require f
-          @merged << File.expand_path(f)
+          f = check_for_file(f)
+          @merged << f
+        end
+      end
+
+      # Opposite of merge, this will omit the files you specify from being merged in. Useful in Rails apps
+      # where a lot of things are auto-merged by default like your models.
+      def unmerge(*files)
+        files.each do |f|
+          f = check_for_file(f)
+          @unmerged << f
         end
       end
 
@@ -80,7 +99,7 @@ module SimpleWorker
     end
 
     def user_dir
-      "."
+      "./"
     end
 
     def set_progress(hash)
@@ -189,37 +208,40 @@ module SimpleWorker
       puts 'upload_if_needed ' + self.class.name
       # Todo, watch for this file changing or something so we can reupload
       unless uploaded?
-        merged = self.class.instance_variable_get(:@merged)
-        puts 'merged1=' + merged.inspect
-
-        subclass = self.class
-        rfile    = subclass.instance_variable_get(:@caller_file) # Base.caller_file # File.expand_path(Base.subclass)
-        puts 'subclass file=' + rfile.inspect
-        puts 'subclass.name=' + subclass.name
+        merged     = self.class.instance_variable_get(:@merged)
+        unmerged     = self.class.instance_variable_get(:@unmerged)
+#        puts 'merged1=' + merged.inspect
+
+        subclass   = self.class
+        rfile      = subclass.instance_variable_get(:@caller_file) # Base.caller_file # File.expand_path(Base.subclass)
+#        puts 'subclass file=' + rfile.inspect
+#        puts 'subclass.name=' + subclass.name
         superclass = subclass
         # Also get merged from subclasses up to SimpleWorker::Base
         while (superclass = superclass.superclass)
-          puts 'superclass=' + superclass.name
+#          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
+#          puts 'merged with superclass=' + merged.inspect
         end
         merged += SimpleWorker.config.models if SimpleWorker.config.models
-        SimpleWorker.service.upload(rfile, subclass.name, :merge=>merged)
+        SimpleWorker.service.upload(rfile, subclass.name, :merge=>merged, :unmerge=>unmerged)
         self.class.instance_variable_set(:@uploaded, true)
       else
         puts 'already uploaded for ' + self.class.name
       end
       merged_workers = self.class.instance_variable_get(:@merged_workers)
-      puts 'now uploading merged WORKERS ' + merged_workers.inspect
-      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
+      if merged_workers.size > 0
+        puts 'now uploading merged workers ' + merged_workers.inspect
+        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
       end
 
       after_upload
@@ -231,7 +253,7 @@ module SimpleWorker
         data[iv] = instance_variable_get(iv)
       end
 
-      config_data = SimpleWorker.config.get_atts_to_send
+      config_data      = SimpleWorker.config.get_atts_to_send
       data[:sw_config] = config_data
       return data
     end

data/lib/simple_worker/config.rb

@@ -25,9 +25,9 @@ module SimpleWorker
 
     def get_atts_to_send
       config_data = {}
-      config_data['database'] = database if database
-      config_data['global_attributes'] = global_attributes if global_attributes
-      config_data['host'] = host if host
+      config_data['database'] = self.database if self.database
+      config_data['global_attributes'] = self.global_attributes if self.global_attributes
+      config_data['host'] = self.host if self.host
       config_data
     end
 

data/lib/simple_worker/service.rb

@@ -27,7 +27,7 @@ module SimpleWorker
         existing_md5 = IO.read(f)
       end
 
-      filename = build_merged_file(filename, options[:merge]) if options[:merge]
+      filename = build_merged_file(filename, options[:merge], options[:unmerge]) if options[:merge]
 
 #            sys.classes[subclass].__file__
 #            puts '__FILE__=' + Base.subclass.__file__.to_s
@@ -56,10 +56,20 @@ module SimpleWorker
       end
     end
 
-    def build_merged_file(filename, merge)
+    def build_merged_file(filename, merge, unmerge)
       merge = merge.dup
       merge << filename
+      #puts "merge before uniq! " + merge.inspect
       merge.uniq!
+     # puts "merge after uniq! " + merge.inspect
+
+      if unmerge
+        unmerge.each do |x|
+          deleted = merge.delete x
+          puts "Unmerging #{x}. Success? #{deleted}"
+        end
+      end
+
       fname2 = File.join(Dir.tmpdir(), File.basename(filename))
 #            puts 'fname2=' + fname2
 #            puts 'merged_file_array=' + merge.inspect

data/test/models/model_2.rb

@@ -0,0 +1,22 @@
+begin
+    require File.join(File.dirname(__FILE__), '../../lib/simple_worker')
+rescue Exception => ex
+    puts 'ERROR!!! ' + ex.message
+#    require 'simple_worker'
+end
+
+
+class Model2
+    attr_accessor :heidi, :ho
+
+    include SimpleWorker::UsedInWorker
+
+    def say_hello
+        log "Hi there sir"
+    end
+
+    # testk laksdfj klasj df
+    def test
+        log 'test'
+    end
+end

data/test/test_worker_2.rb

@@ -9,6 +9,7 @@ end
 class TestWorker2 < SimpleWorker::Base
 
     merge File.join(File.dirname(__FILE__), 'models', 'model_1.rb')
+    unmerge 'models/model_2.rb'
     merge_worker File.join(File.dirname(__FILE__), 'second_worker.rb'), 'SecondWorker'
 
     attr_accessor :s3_key, :times, :x

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 3
-  - 19
-  version: 0.3.19
+  - 20
+  version: 0.3.20
 platform: ruby
 authors: 
 - Travis Reeder
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-30 00:00:00 -08:00
+date: 2011-01-07 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -49,6 +49,7 @@ files:
 - rails/init.rb
 - README.markdown
 - test/models/model_1.rb
+- test/models/model_2.rb
 - test/requiring_worker.rb
 - test/scheduled_worker.rb
 - test/second_worker.rb
@@ -92,6 +93,7 @@ specification_version: 3
 summary: Classified
 test_files: 
 - test/models/model_1.rb
+- test/models/model_2.rb
 - test/requiring_worker.rb
 - test/scheduled_worker.rb
 - test/second_worker.rb