symphony 0.12.5 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b574d82a0376c4f397afddcd8eef820cd089d22e4c2cc09e6374cf0e9227ff5
-  data.tar.gz: 291e18181eaf8bf4484e8dc438123a28bd5bd07af506adff81235f3a98224861
+  metadata.gz: 4a3df7405c545cb568ef001dd1287e51bc2e2de8184d8b5ef43204b5fca7599b
+  data.tar.gz: 2abfd45b2447a5660feae02c67f9bbd5d856a68ba69cd391c9b7101e9a1a4582
 SHA512:
-  metadata.gz: 20f2a6bf4785239e01b82b05b2ea7c252aeaf8553656a170c738bc32965f9a62c65a8a374969420cb00a3c58ecefa90b0214b828dcdfe95c827f73ba4a3749be
-  data.tar.gz: 5c162e6316d2f10ce7e5c416c60a2c88275ac38f6186fe90c3e48536f1dc86d8b806699dafa74873be39335a6ccb706d5b2a597a7e252aa1c2560816c12f6e85
+  metadata.gz: a2bf4f256cb6605cbadfb03e6432a61cd036bf372ce8c97db932e3eafef0d22d9a8bf3e6907c772a271258fee096a5b87fd9a8f285b03302e94d922d65ccbff4
+  data.tar.gz: e384f2e9edbb3dc43e773e8cfa69be3bd316c8cbfa233d7ee93ab3865c67e90110f223671775d7318282cbee3ccbfed7d3a3ab17581f51f17edcee212f519bfb

data/History.rdoc

@@ -1,3 +1,27 @@
+= Release History for symphony
+
+---
+
+== v0.14.0 [2020-07-23] Michael Granger <ged@faeriemud.org>
+
+Improvements:
+
+- Allow `x-queue-type` to be specified for a `Task`. Thanks to
+  Alyssa Verkade <averkade@costar.com> for the patch.
+
+
+== v0.13.0 [2020-03-09] Michael Granger <ged@faeriemud.org>
+
+Improvements:
+
+- Remove Yajl dependency in favor of stdlib json.
+- Update for Ruby 2.7
+
+Changes:
+
+- Requires Ruby 2.6+
+
+
 == v0.12.5 [2019-07-16] Michael Granger <ged@FaerieMUD.org>
 
 Improvements:

data/Manifest.txt

@@ -1,8 +1,7 @@
 .simplecov
-ChangeLog
 History.rdoc
 Manifest.txt
-README.rdoc
+README.md
 Rakefile
 UPGRADING.md
 USAGE.rdoc

data/{README.rdoc → README.md}

@@ -1,10 +1,19 @@
-= symphony
+# symphony
 
-wiki:: http://bitbucket.org/ged/symphony
-docs:: http://deveiate.org/code/symphony
+home
+: https://hg.sr.ht/~ged/Symphony
 
+code
+: https://hg.sr.ht/~ged/Symphony/browse
 
-== Description
+docs
+: https://deveiate.org/code/symphony
+
+github
+: https://github.com/ged/symphony
+
+
+## Description
 
 Symphony is a subscription-based asynchronous job system. It
 allows you to define jobs that watch for lightweight events from a
@@ -21,7 +30,7 @@ symphony-task::
   require the process management that the symphony daemon provides.
 
 
-== Synopsis
+## Synopsis
 
 	class WorkerTask < Symphony::Task
 		# Process all events
@@ -37,28 +46,33 @@ symphony-task::
 For a more detailed description of usage, please refer to the USAGE document.
 
 
-== Installation
+## Installation
 
     gem install symphony
 
 
-== Contributing
+## Contributing
 
 You can check out the current development source with Mercurial via its
-{project page}[http://bitbucket.org/ged/symphony]. Or if you prefer Git, via 
-{its Github mirror}[https://github.com/ged/symphony].
+[project page](https://hg.sr.ht/~ged/symphony). Or if you prefer Git, via
+[its Github mirror](https://github.com/ged/symphony).
 
 After checking out the source, run:
 
-    $ rake newb
+    $ rake setup
+
+This task will install dependencies, and do any other necessary developer setup.
+
+
+## Authors
 
-This task will install any missing dependencies, run the tests/specs,
-and generate the API documentation.
+- Michael Granger <ged@faeriemud.org>
+- Mahlon E. Smith <mahlon@martini.nu>
 
 
-== License
+## License
 
-Copyright (c) 2011-2015, Michael Granger and Mahlon E. Smith
+Copyright (c) 2011-2020, Michael Granger and Mahlon E. Smith
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

data/Rakefile

@@ -1,79 +1,10 @@
-#!/usr/bin/env rake
+#!/usr/bin/env ruby -S rake
 
-begin
-	require 'hoe'
-rescue LoadError
-	abort "This Rakefile requires hoe (gem install hoe)"
-end
-
-GEMSPEC = 'symphony.gemspec'
-
-
-Hoe.plugin :mercurial
-Hoe.plugin :signing
-Hoe.plugin :deveiate
-
-Hoe.plugins.delete :rubyforge
-
-hoespec = Hoe.spec 'symphony' do |spec|
-	spec.readme_file = 'README.rdoc'
-	spec.history_file = 'History.rdoc'
-	spec.extra_rdoc_files = FileList[ '*.rdoc' ]
-	spec.spec_extras[:rdoc_options] = ['-f', 'fivefish', '-t', 'Symphony']
-	spec.spec_extras[:required_rubygems_version] = '>= 2.0.3'
-	spec.license 'BSD'
-
-	spec.developer 'Michael Granger', 'ged@FaerieMUD.org'
-	spec.developer 'Mahlon E. Smith', 'mahlon@martini.nu'
-
-	spec.dependency 'configurability', '~> 3.1'
-	spec.dependency 'loggability', '~> 0.11'
-	spec.dependency 'pluggability', '~> 0.4'
-	spec.dependency 'bunny', '~> 2.0'
-	spec.dependency 'sysexits', '~> 1.1'
-	spec.dependency 'yajl-ruby', '~> 1.3'
-	spec.dependency 'msgpack', '~> 1.0'
-	spec.dependency 'metriks', '~> 0.9'
-	spec.dependency 'rusage', '~> 0.2'
-
-	spec.dependency 'rspec', '~> 3.0', :developer
-	spec.dependency 'simplecov', '~> 0.8', :developer
-	spec.dependency 'timecop', '~> 0.8', :developer
-
-	spec.require_ruby_version( '>=2.0.0' )
-	spec.hg_sign_tags = true if spec.respond_to?( :hg_sign_tags= )
+require 'rake/deveiate'
 
-	self.rdoc_locations << "deveiate:/usr/local/www/public/code/#{remote_rdoc_dir}"
+Rake::DevEiate.setup( 'symphony' ) do |project|
+	project.publish_to = 'deveiate:/usr/local/www/public/code'
+	project.required_ruby_version = '~> 2.6'
 end
 
-# Fix some Hoe retardedness
-hoespec.spec.files.delete( '.gemtest' )
-ENV['VERSION'] ||= hoespec.spec.version.to_s
-
-# Run the tests before checking in
-task 'hg:precheckin' => [ :check_history, :check_manifest, :gemspec, :spec ]
-
-# Rebuild the ChangeLog immediately before release
-task :prerelease => 'ChangeLog'
-CLOBBER.include( 'ChangeLog' )
-
-desc "Build a coverage report"
-task :coverage do
-	ENV["COVERAGE"] = 'yes'
-	Rake::Task[:spec].invoke
-end
-
-
-task :gemspec => GEMSPEC
-file GEMSPEC => hoespec.spec.files do |task|
-	spec = $hoespec.spec
-	spec.version = "#{spec.version.bump}.0.pre#{Time.now.strftime("%Y%m%d%H%M%S")}"
-	File.open( task.name, 'w' ) do |fh|
-		fh.write( spec.to_ruby )
-	end
-end
-
-task :default => :gemspec
-
-CLOBBER.include( GEMSPEC.to_s )
 

data/USAGE.rdoc

@@ -79,14 +79,14 @@ calling #run on the class itself.
 == The Simplest Task
 
     #!/usr/bin/env ruby
-    
+
     require 'symphony'
-    
+
     class Test < Symphony::Task
-        
+
         # Process all events
         subscribe_to '#'
-        
+
         def work( payload, metadata )
             puts "I received an event: %p with a payload of %p" % [
                 metadata[ :delivery_info ][ :routing_key ],
@@ -95,7 +95,7 @@ calling #run on the class itself.
             return true
         end
     end
-    
+
     Symphony.load_config( 'etc/config.yml' )
     Test.run
 
@@ -239,13 +239,13 @@ By default, Symphony will try and create a queue based on the Class
 name of the task.  You can override this per-task.
 
     class Test < Symphony::Task
-        
+
         # Process all events
         subscribe_to '#'
-        
+
         # I don't want to connect to a 'test' queue, lets make it interesting:
         queue_name 'shazzzaaaam'
-            
+
         def work( payload, metadata )
         ...
 
@@ -261,14 +261,28 @@ can tell a task to create a persistent queue instead of an auto-delete queue:
 
 == Queue Re-binding
 
-If you want Symphony to re-bind a worker's queue when it starts up, you call tell it to with +always_rebind+:
+If you want Symphony to re-bind a worker's queue when it starts up, you call
+tell it to with +always_rebind+:
 
     always_rebind true
 
-Note that re-binding doesn't *unbind* from the existing pattern/s, so you'll 
+Note that re-binding doesn't *unbind* from the existing pattern/s, so you'll
 need to account for this in the Task's +work+ method.
 
 
+== Queue Type
+
+If you're running a version of RabbitMQ that supports the `x-queue-type`
+argument (e.g., for quorum queues), you can specify a value for it using the
+`queue_type` declaration:
+
+    queue_type 'quorum'
+
+Note that several other queue settings might not work with some kinds of
+queues; the validity of the combination of the task's settings are left to
+the implementor.
+
+
 = Plugins
 
 Plugins change or enhance the behavior of a Symphony::Task.
@@ -287,7 +301,7 @@ the process name to display a total count and jobs per second rate.
         prepend Symphony::Metrics
         # ...
     end
-        
+
 
 == Routing
 
@@ -300,13 +314,13 @@ receive multiple message topics much easier to maintain and test.
 
     class Test < Symphony::Task
         include Symphony::Routing
-        
+
         on 'users.create', 'workstation.create' do |payload, metadata|
             puts "A user or workstation wants to be created!"
             # ...
             return true
         end
-        
+
         on 'users.delete' do |payload, metadata|
             puts "A user wants to be deleted!"
             return true

data/lib/symphony.rb

@@ -12,7 +12,7 @@ module Symphony
 	       Configurability
 
 	# Library version constant
-	VERSION = '0.12.5'
+	VERSION = '0.14.0'
 
 	# Version-control revision constant
 	REVISION = %q$Revision$

data/lib/symphony/daemon.rb

@@ -1,5 +1,5 @@
 # -*- ruby -*-
-#encoding: utf-8
+# frozen_string_literal: true
 
 require 'configurability'
 require 'loggability'
@@ -248,7 +248,7 @@ class Symphony::Daemon
 		self.log.info "Restarting task group for %p" % [ task_class ]
 		group.max_workers = max
 		group.restart_workers
-		end
+	end
 
 
 	### Shut down the workers for the specified task group.

data/lib/symphony/metrics.rb

@@ -1,5 +1,5 @@
 # -*- ruby -*-
-#encoding: utf-8
+# frozen_string_literal: true
 
 require 'rusage'
 require 'metriks'

data/lib/symphony/mixins.rb

@@ -1,5 +1,5 @@
 # -*- ruby -*-
-#encoding: utf-8
+# frozen_string_literal: true
 
 
 module Symphony

data/lib/symphony/queue.rb

@@ -150,13 +150,14 @@ class Symphony::Queue
 
 	### Create a new Queue for the specified +task_class+.
 	def initialize( task_class )
-		@name          = task_class.queue_name
-		@acknowledge   = task_class.acknowledge
-		@consumer_tag  = task_class.consumer_tag
-		@routing_keys  = task_class.routing_keys
-		@prefetch      = task_class.prefetch
-		@persistent    = task_class.persistent
-		@always_rebind = task_class.always_rebind
+		@name            = task_class.queue_name
+		@acknowledge     = task_class.acknowledge
+		@consumer_tag    = task_class.consumer_tag
+		@routing_keys    = task_class.routing_keys
+		@prefetch        = task_class.prefetch
+		@persistent      = task_class.persistent
+		@always_rebind   = task_class.always_rebind
+		@amqp_queue_type = task_class.queue_type
 
 		@amqp_queue    = nil
 		@shutting_down = false
@@ -195,6 +196,10 @@ class Symphony::Queue
 	# Whether or not to re-bind the queue to the exchange during setup
 	attr_predicate :always_rebind
 
+	##
+	# The -x-queue-type of the queue, if any
+	attr_reader :amqp_queue_type
+
 	##
 	# The underlying Bunny::Queue this object manages
 	attr_reader :amqp_queue
@@ -256,19 +261,20 @@ class Symphony::Queue
 		exchange = self.class.amqp_exchange
 		channel = self.class.amqp_channel
 		created_queue = false
-		queue         = nil
 
-		begin
-			queue = channel.queue( self.name, passive: true )
+		queue = begin
+			existing_queue = channel.queue( self.name, passive: true )
 			channel.prefetch( prefetch_count )
 			self.log.info "Using pre-existing queue: %s" % [ self.name ]
+			existing_queue
 		rescue Bunny::NotFound => err
 			self.log.info "%s; creating a new queue instead." % [ err.message ]
 			created_queue = true
 			channel = self.class.reset_amqp_channel
 			channel.prefetch( prefetch_count )
 
-			queue = channel.queue( self.name, auto_delete: !self.persistent )
+			arguments = { 'x-queue-type' => self.amqp_queue_type }.compact
+			channel.queue( self.name, auto_delete: !self.persistent, arguments: arguments )
 		end
 
 		if self.always_rebind? || created_queue

data/lib/symphony/routing.rb

@@ -1,5 +1,5 @@
 # -*- ruby -*-
-#encoding: utf-8
+# frozen_string_literal: true
 
 require 'loggability'
 

data/lib/symphony/signal_handling.rb

@@ -1,5 +1,5 @@
 # -*- ruby -*-
-#encoding: utf-8
+# frozen_string_literal: true
 
 require 'symphony'
 

data/lib/symphony/statistics.rb

@@ -1,5 +1,5 @@
 # -*- ruby -*-
-#encoding: utf-8
+# frozen_string_literal: true
 
 require 'loggability'
 require 'symphony' unless defined?( Symphony )

data/lib/symphony/task.rb

@@ -1,5 +1,5 @@
 # -*- ruby -*-
-#encoding: utf-8
+# frozen_string_literal: true
 
 require 'set'
 require 'sysexits'
@@ -7,7 +7,7 @@ require 'pluggability'
 require 'loggability'
 
 require 'msgpack'
-require 'yajl'
+require 'json'
 require 'yaml'
 
 require 'symphony' unless defined?( Symphony )
@@ -47,6 +47,15 @@ class Symphony::Task
 	plugin_prefixes 'symphony/tasks'
 
 
+	@queue         = nil
+	@acknowledge   = true
+	@routing_keys  = Set.new
+	@prefetch      = 10
+	@persistent    = false
+	@always_rebind = false
+	@queue_type    = nil
+
+
 	### Create a new Task object and listen for work. Exits with the code returned
 	### by #start when it's done.
 	def self::run( exit_on_idle=false )
@@ -79,11 +88,15 @@ class Symphony::Task
 	def self::inherited( subclass )
 		super
 
+		subclass.instance_variable_set( :@queue, nil )
+		subclass.instance_variable_set( :@queue_type, nil )
+		subclass.instance_variable_set( :@always_rebind, false )
 		subclass.instance_variable_set( :@routing_keys, Set.new )
 		subclass.instance_variable_set( :@acknowledge, true )
 		subclass.instance_variable_set( :@work_model, :longlived )
 		subclass.instance_variable_set( :@prefetch, 10 )
 		subclass.instance_variable_set( :@timeout_action, :reject )
+		subclass.instance_variable_set( :@timeout, nil )
 		subclass.instance_variable_set( :@persistent, false )
 		subclass.instance_variable_set( :@idle_timeout, DEFAULT_IDLE_TIMEOUT )
 	end
@@ -132,6 +145,16 @@ class Symphony::Task
 	end
 
 
+	### Specify an x-queue-type for the underlying queue
+	def self::queue_type( type=nil )
+		if type
+			@queue_type = type
+		end
+
+		return @queue_type
+	end
+
+
 	### Set up one or more topic key patterns to use when binding the Task's queue
 	### to the exchange.
 	def self::subscribe_to( *routing_keys )
@@ -438,7 +461,7 @@ class Symphony::Task
 			when 'application/x-msgpack'
 				MessagePack.unpack( payload )
 			when 'application/json', 'text/javascript'
-				Yajl::Parser.parse( payload )
+				JSON.parse( payload )
 			when 'application/x-yaml', 'text/x-yaml'
 				YAML.load( payload )
 			else