maestro_plugin 0.0.2 → 0.0.3

data/.gitignore

@@ -1,4 +1,3 @@
-*.gem
 *.rbc
 .bundle
 .config

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    maestro_plugin (0.0.2)
+    maestro_plugin (0.0.4)
       json (>= 1.4.6)
       logging (= 1.8.0)
       rubyzip (= 0.9.8)
@@ -18,7 +18,7 @@ GEM
     logging (1.8.0)
       little-plugger (>= 1.1.3)
       multi_json (>= 1.3.6)
-    multi_json (1.3.6)
+    multi_json (1.7.2)
     rake (10.0.4)
     rspec (2.13.0)
       rspec-core (~> 2.13.0)

data/README.md

@@ -1,5 +1,5 @@
-maestro_plugin Gem
-===================
+Maestro Ruby Plugin Gem
+=======================
 
 Library For Creating Ruby Based Maestro Plugins
 =======

data/Rakefile

@@ -4,24 +4,14 @@ require 'rake/clean'
 
 require File.expand_path('../lib/maestro_plugin/version', __FILE__)
 
-CLEAN.include([ 'pkg', '*.gem'])
+CLEAN.include('pkg')
+CLOBBER.include('.bundle', '.config', 'coverage', 'InstalledFiles', 'spec/reports', 'rdoc', 'test', 'tmp')
 
-task :default => [:build]
+task :default => [:clean, :bundle, :spec, :build]
 
-desc 'Run specs'
-RSpec::Core::RakeTask.new do |t|
-  t.pattern = './spec/**/*_spec.rb' # don't need this, it's default.
-  t.rspec_opts = '--fail-fast --format p --color'
-  # Put spec opts in a file named .rspec in root
-end
+RSpec::Core::RakeTask.new
 
 desc 'Get dependencies with Bundler'
 task :bundle do
-  system 'bundle install'
-end
-
-task :build => [:clean, :bundle, :spec]
-task :build do
-  system 'gem build maestro_plugin.gemspec'
+  sh %{bundle install}
 end
-

data/lib/maestro_plugin/maestro_worker.rb

@@ -129,18 +129,44 @@ module Maestro
     end
 
     # Sends the specified ouput string to the server for persistence
-    def write_output(output)
-      return if output.gsub(/\n/, '').empty?
+    # If called with :buffer as an option, the output will be queued up until a number of writes has occurred, or
+    # a reasonable period since the last sent occurred.
+    # Any call without the :buffer option will cause any buffered output to be sent immediately.
+    #
+    # Example:
+    #   write_output("I am Sam\n")                      <-- send immediately
+    #   write_output("Sam I am\n", :buffer => true)     <-- buffer for later
+    #   write_output("I like Ham\n")                    <-- sends 'Sam I am\nI like Ham\n'
+    def write_output(output, options = {})
+      # First time thru?  We need to do some setup!
+      reset_buffered_output if @buffered_output.nil?
+
+      # If we have data and its not just a newline add it
+      if output && !output.gsub(/\n/, '').empty?
+        @buffered_output += output
+      end
 
-      workitem[OUTPUT_META] = output
-      workitem[STREAMING_META] = true
-      send_workitem_message
+      # If a) we have data to write, and
+      #    b) its been > 2 seconds since we last sent
+      #
+      # The 2 second factor is there to allow slowly accumulating data to be sent out more regularly.
+      if !@buffered_output.empty? && (!options[:buffer] || Time.now - @last_write_output > 2)
+        workitem[OUTPUT_META] = @buffered_output
+        workitem[STREAMING_META] = true
+        send_workitem_message
+        reset_buffered_output
+      end
     rescue Exception => e
       Maestro.log.warn "Unable To Write Output To Server #{e.class} #{e}: #{e.backtrace.join("\n")}"
     ensure
       workitem.delete(STREAMING_META)
     end
 
+    def reset_buffered_output
+      @buffered_output = ''
+      @last_write_output = Time.now
+    end
+
     def error
       fields[ERROR_META]
     end
@@ -243,10 +269,13 @@ module Maestro
 
     # end persistence
 
-    def get_field(field)
-      fields[field]
+    # Get a field from workitem, supporting default value
+    def get_field(field, default = nil)
+      value = fields[field]
+      value = default if !default.nil? && (value.nil? || (value.respond_to?(:empty?) && value.empty?))
+      value
     end
-
+ 
     def fields
       workitem['fields']
     end

data/lib/maestro_plugin/version.rb

@@ -1,5 +1,5 @@
 module Maestro
   module Plugin
-    VERSION = '0.0.2'
+    VERSION = '0.0.3'
   end
 end

data/spec/maestro_worker_spec.rb

@@ -29,7 +29,7 @@ describe Maestro::MaestroWorker do
     before :each do
       @workitem = {'fields' => {}}
       @ruote_participants = double("ruote_participants")
-      @ruote_participants.should_receive(:send_workitem_message).with(@workitem)
+      @ruote_participants.should_receive(:send_workitem_message).at_least(:once).with(@workitem)
 
       @worker = Maestro::MaestroWorker.new
       @worker.stub(:ruote_participants => @ruote_participants)
@@ -37,40 +37,68 @@ describe Maestro::MaestroWorker do
       @worker.should_receive(:send_workitem_message).at_least(:once).and_call_original
 
     end
-  
+
     it 'should send a write_output message' do
       @worker.write_output('Some Silly String')
       @worker.workitem['__output__'].should eql('Some Silly String')
       @worker.workitem['__streaming__'].should be_nil
     end
-    
+
+    it 'should aggregate output' do
+      @worker.write_output('Some Silly String')
+      @worker.workitem['__output__'].should eql('Some Silly String')
+      @worker.workitem['__streaming__'].should be_nil
+
+      @worker.write_output("1", :buffer => true)
+      @worker.workitem['__output__'].should eql('Some Silly String')
+      @worker.workitem['__streaming__'].should be_nil
+      @worker.write_output("22", :buffer => true)
+      @worker.workitem['__output__'].should eql('Some Silly String')
+      @worker.workitem['__streaming__'].should be_nil
+
+      # Should auto-send after 2 second delay
+      sleep 3
+      @worker.write_output("333", :buffer => true)
+      @worker.workitem['__output__'].should eql('122333')
+      @worker.workitem['__streaming__'].should be_nil
+      @worker.write_output("4444", :buffer => true)
+      @worker.workitem['__output__'].should eql('122333')
+      @worker.workitem['__streaming__'].should be_nil
+
+      # When called without aggregate, should purge
+      @worker.write_output("5555")
+      @worker.workitem['__output__'].should eql('44445555')
+      @worker.workitem['__streaming__'].should be_nil
+    end
+
     it 'should send a not needed message' do
       @worker.not_needed
       @worker.workitem['__not_needed__'].should be_nil
     end
-  
+
     it 'should send a cancel message' do
       @worker.cancel
       @worker.workitem['__cancel__'].should be_nil
     end
-  
+
     it 'should send a set_waiting message' do
-      @ruote_participants.should_receive(:send_workitem_message).with(@workitem)
+      # expects already in before :each block, so putting it here too causes test fail
+#      @ruote_participants.should_receive(:send_workitem_message).with(@workitem)
       @worker.set_waiting(true)
       @worker.workitem['__waiting__'].should be_true
-      
+
       @worker.set_waiting(false)
       @worker.workitem['__waiting__'].should be_nil
     end
-  
+
     it 'should send a create record message' do
       @worker.create_record_with_fields('cars', ['manu', 'date', 'name'], ['ferrari', '1964', '250 GTO'])
-      
+
       @worker.workitem['__model__'].should eql('cars')
       @worker.workitem['__record_fields__'].should eql('manu,date,name')
       @worker.workitem['__record_values__'].should eql('ferrari,1964,250 GTO')
     end
-  
+
     it 'should send a create record message with a hash' do
       fields = {'manu' => 'ferrari', 'date' => '1964', 'name' => 'GTO'}
       @worker.create_record_with_fields('cars', fields)
@@ -80,13 +108,13 @@ describe Maestro::MaestroWorker do
 
     it 'should send an update record-field message' do
       @worker.update_fields_in_record('animal', 'donkey', 'name', 'e-or')
-      
+
       @worker.workitem['__model__'].should eql('animal')
       @worker.workitem['__record_id__'].should eql('donkey')
       @worker.workitem['__record_field__'].should eql('name')
       @worker.workitem['__record_value__'].should eql('e-or')
     end
-  
+
     it 'should send a delete record message' do
       @worker.delete_record('animal', 1)
       @worker.workitem['__model__'].should eql('animal')
@@ -101,8 +129,8 @@ describe Maestro::MaestroWorker do
       @worker.workitem['__filter__'].should eql(filter)
       @worker.workitem['__name__'].should be_nil
     end
-  end  
-  
+  end
+
   describe 'Field handling' do
     before :each do
       @worker = Maestro::MaestroWorker.new
@@ -136,7 +164,5 @@ describe Maestro::MaestroWorker do
       @worker.is_json?('a string').should be_false
     end
 
-
-
   end
 end

metadata

@@ -2,7 +2,7 @@
 name: maestro_plugin
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors: 
   - Etienne Pelletier
@@ -10,85 +10,85 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-04-04 00:00:00 Z
+date: 2013-04-23 00:00:00 Z
 dependencies: 
   - !ruby/object:Gem::Dependency 
     name: logging
-    version_requirements: &id001 !ruby/object:Gem::Requirement 
+    prerelease: false
+    requirement: &id001 !ruby/object:Gem::Requirement 
       none: false
       requirements: 
         - - "="
           - !ruby/object:Gem::Version 
             version: 1.8.0
-    requirement: *id001
-    prerelease: false
     type: :runtime
+    version_requirements: *id001
   - !ruby/object:Gem::Dependency 
     name: rubyzip
-    version_requirements: &id002 !ruby/object:Gem::Requirement 
+    prerelease: false
+    requirement: &id002 !ruby/object:Gem::Requirement 
       none: false
       requirements: 
         - - "="
           - !ruby/object:Gem::Version 
             version: 0.9.8
-    requirement: *id002
-    prerelease: false
     type: :runtime
+    version_requirements: *id002
   - !ruby/object:Gem::Dependency 
     name: json
-    version_requirements: &id003 !ruby/object:Gem::Requirement 
+    prerelease: false
+    requirement: &id003 !ruby/object:Gem::Requirement 
       none: false
       requirements: 
         - - ">="
           - !ruby/object:Gem::Version 
             version: 1.4.6
-    requirement: *id003
-    prerelease: false
     type: :runtime
+    version_requirements: *id003
   - !ruby/object:Gem::Dependency 
     name: bundler
-    version_requirements: &id004 !ruby/object:Gem::Requirement 
+    prerelease: false
+    requirement: &id004 !ruby/object:Gem::Requirement 
       none: false
       requirements: 
         - - ~>
           - !ruby/object:Gem::Version 
             version: "1.3"
-    requirement: *id004
-    prerelease: false
     type: :development
+    version_requirements: *id004
   - !ruby/object:Gem::Dependency 
     name: rake
-    version_requirements: &id005 !ruby/object:Gem::Requirement 
+    prerelease: false
+    requirement: &id005 !ruby/object:Gem::Requirement 
       none: false
       requirements: 
         - - ">="
           - !ruby/object:Gem::Version 
             version: "0"
-    requirement: *id005
-    prerelease: false
     type: :development
+    version_requirements: *id005
   - !ruby/object:Gem::Dependency 
     name: jruby-openssl
-    version_requirements: &id006 !ruby/object:Gem::Requirement 
+    prerelease: false
+    requirement: &id006 !ruby/object:Gem::Requirement 
       none: false
       requirements: 
         - - ">="
           - !ruby/object:Gem::Version 
             version: "0"
-    requirement: *id006
-    prerelease: false
     type: :development
+    version_requirements: *id006
   - !ruby/object:Gem::Dependency 
     name: rspec
-    version_requirements: &id007 !ruby/object:Gem::Requirement 
+    prerelease: false
+    requirement: &id007 !ruby/object:Gem::Requirement 
       none: false
       requirements: 
         - - ~>
           - !ruby/object:Gem::Version 
             version: 2.13.0
-    requirement: *id007
-    prerelease: false
     type: :development
+    version_requirements: *id007
 description: A ruby library to help with the creation of Maestro plugins
 email: 
   - epelletier@maestrodev.com
@@ -126,18 +126,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 2
-        segments: 
-          - 0
         version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 2
-        segments: 
-          - 0
         version: "0"
 requirements: []