rservicebus2 0.2.5 → 0.2.10

data/lib/rservicebus2/handler_manager.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RServiceBus2
   # Given a directory, this class is responsible for finding
   #  msgnames,
@@ -20,10 +22,10 @@ module RServiceBus2
     # setBusAttributeIfRequested
     #
     # @param [RServiceBus2::Handler] handler
-    def set_bus_attribute_if_requested(handler)
+    def conditionally_set_bus_attribute(handler)
       if defined?(handler.bus)
         handler.bus = @host
-        RServiceBus2.log 'Bus attribute set for: ' + handler.class.name
+        RServiceBus2.log "Bus attribute set for: #{handler.class.name}"
       end
 
       self
@@ -32,10 +34,10 @@ module RServiceBus2
     # setStateAttributeIfRequested
     #
     # @param [RServiceBus2::Handler] handler
-    def set_state_attribute_if_requested(handler)
+    def conditionally_set_state_attribute(handler)
       if defined?(handler.state)
         handler.state = @state_manager.get(handler)
-        RServiceBus2.log 'Bus attribute set for: ' + handler.class.name
+        RServiceBus2.log "Bus attribute set for: #{handler.class.name}"
       end
 
       self
@@ -50,29 +52,29 @@ module RServiceBus2
       self
     end
 
+    # rubocop:disable Metrics/AbcSize
     def interrogate_handler_for_app_resources(handler)
-      RServiceBus2.rlog "Checking app resources for: #{handler.class.name}"
-      RServiceBus2.rlog "If your attribute is not getting set, check that it is in the 'attr_accessor' list"
+      RServiceBus2.rlog "Checking app resources for: #{handler.class.name}\n" \
+                        "If your attribute is not getting set, check that it is in the 'attr_accessor' list"
 
       @resource_list_by_handler_name[handler.class.name] = []
-      @resource_manager.get_all.each do |k, v|
+      @resource_manager.all.each do |k, _v|
         next unless handler.class.method_defined?(k)
 
         @resource_list_by_handler_name[handler.class.name] << k
-        RServiceBus2.log "Resource attribute, #{k}, found for: " +
-          handler.class.name
+        RServiceBus2.log "Resource attribute, #{k}, found for: #{handler.class.name}"
       end
-
-      self
     end
+    # rubocop:enable Metrics/AbcSize
 
     def add_handler(lc_msg_name, handler)
-      msg_name = lc_msg_name.gsub(/(?<=_|^)(\w)/){$1.upcase}.gsub(/(?:_)(\w)/,'\1') # Turn snake_case string to CamelCase
+      # Turn snake_case string to CamelCase
+      msg_name = lc_msg_name.gsub(/(?<=_|^)(\w)/) { Regexp.last_match(1).upcase }.gsub(/(?:_)(\w)/, '\1')
       @handler_list[msg_name] = [] if @handler_list[msg_name].nil?
-      return unless @handler_list[msg_name].index{ |x| x.class.name == handler.class.name }.nil?
+      return unless @handler_list[msg_name].index { |x| x.instance_of(handler) }.nil?
 
       @handler_list[msg_name] << handler
-      set_bus_attribute_if_requested(handler)
+      conditionally_set_bus_attribute(handler)
       check_if_state_attribute_requested(handler)
       interrogate_handler_for_app_resources(handler)
     end
@@ -86,28 +88,32 @@ module RServiceBus2
 
       list = []
       @handler_list[msg_name].each do |handler|
-        list = list + @resource_list_by_handler_name[handler.class.name] unless @resource_list_by_handler_name[handler.class.name].nil?
+        unless @resource_list_by_handler_name[handler.class.name].nil?
+          list += @resource_list_by_handler_name[handler.class.name]
+        end
       end
       list.uniq!
     end
 
-    def set_resources_for_handlers_needed_to_process_msg(msg_name)
+    # rubocop:disable Metrics/AbcSize
+    def conditionally_set_resources_for_handlers(msg_name)
       @handler_list[msg_name].each do |handler|
-        set_state_attribute_if_requested(handler)
-
+        conditionally_set_state_attribute(handler)
         next if @resource_list_by_handler_name[handler.class.name].nil?
+
         @resource_list_by_handler_name[handler.class.name].each do |k|
           handler.instance_variable_set("@#{k}", @resource_manager.get(k).get_resource)
-          RServiceBus2.rlog "App resource attribute, #{k}, set for: " + handler.class.name
+          RServiceBus2.rlog "App resource attribute, #{k}, set for: #{handler.class.name}"
         end
       end
     end
+    # rubocop:enable Metrics/AbcSize
 
     def get_handler_list_for_msg(msg_name)
       return [] if @handler_list[msg_name].nil?
 
-      list = get_list_of_resources_needed_to_process_msg(msg_name)
-      set_resources_for_handlers_needed_to_process_msg(msg_name)
+      # list = get_list_of_resources_needed_to_process_msg(msg_name)
+      conditionally_set_resources_for_handlers(msg_name)
 
       @handler_list[msg_name]
     end
@@ -116,16 +122,16 @@ module RServiceBus2
       @handler_list.key?(msg_name)
     end
 
-    def get_stats
+    def stats
       list = []
-      @handler_list.each do |k, v|
+      @handler_list.each do |_k, v|
         list << v.inspect
       end
 
       list
     end
 
-    def get_list_of_msg_names
+    def msg_names
       @handler_list.keys
     end
   end

data/lib/rservicebus2/helper_functions.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+
+# Helper functions
 module RServiceBus2
   def self.convert_dto_to_hash(obj)
     hash = {}
@@ -35,7 +38,7 @@ module RServiceBus2
   end
 
   def self.get_value(name, default = nil)
-    value = (ENV[name].nil? || ENV[name] == '') ? default : ENV[name]
+    value = ENV[name].nil? || ENV[name] == '' ? default : ENV[name]
     log "Env value: #{name}: #{value}"
     value
   end
@@ -50,7 +53,6 @@ module RServiceBus2
     agent = RServiceBus2::Agent.new
     Audit.new(agent).audit_to_queue(msg)
     agent.send_msg(msg, queue_name, response_queue)
-
   rescue QueueNotFoundForMsg => e
     msg = "\n"
     msg = "#{msg}*** Queue not found for, #{e.message}\n"
@@ -76,10 +78,12 @@ module RServiceBus2
 
   def self.check_environment_variable(string)
     return false if ENV[string].nil?
+    return false if ENV[string] == ''
     return true if ENV[string] == true || ENV[string] =~ (/(true|t|yes|y|1)$/i)
     return false if ENV[string] == false ||
                     ENV[string].nil? ||
                     ENV[string] =~ (/(false|f|no|n|0)$/i)
-    fail ArgumentError, "invalid value for Environment Variable: \"#{string}\""
+
+    raise ArgumentError, "invalid value for Environment Variable: \"#{string}\""
   end
 end

data/lib/rservicebus2/host.rb

@@ -1,10 +1,15 @@
+# frozen_string_literal: true
+
 module RServiceBus2
   class NoHandlerFound < StandardError
   end
+
   class ClassNotFoundForMsg < StandardError
   end
+
   class NoMsgToProcess < StandardError
   end
+
   class PropertyNotSet < StandardError
   end
 
@@ -14,9 +19,8 @@ module RServiceBus2
 
     # Provides a thin logging veneer
     # @param [String] string Log entry
-    # @param [Boolean] ver Indicator for a verbose log entry
-    def log(string, ver = false)
-      RServiceBus2.log(string, ver)
+    def log(string)
+      RServiceBus2.log(string)
     end
 
     # Thin veneer for Configuring external resources
@@ -26,19 +30,6 @@ module RServiceBus2
                                                              self,
                                                              @state_manager,
                                                              @saga_storage)
-      self
-    end
-
-    # Thin veneer for Configuring SendAt
-    def configure_send_at_manager
-      @send_at_manager = SendAtManager.new(self)
-      self
-    end
-
-    # Thin veneer for Configuring state
-    def configure_state_manager
-      @state_manager = StateManager.new
-      self
     end
 
     # Thin veneer for Configuring state
@@ -48,25 +39,6 @@ module RServiceBus2
 
       uri = URI.parse(string)
       @saga_storage = SagaStorage.get(uri)
-      self
-    end
-
-    # Thin veneer for Configuring Cron
-    def configure_circuit_breaker
-      @circuit_breaker = CircuitBreaker.new(self)
-      self
-    end
-
-    # Thin veneer for Configuring external resources
-    def configure_monitors
-      @monitors = ConfigureMonitor.new(self, @resource_manager).get_monitors(ENV)
-      self
-    end
-
-    # Thin veneer for Configuring the Message Queue
-    def connect_to_mq
-      @mq = MQ.get
-      self
     end
 
     # Subscriptions are specified by adding events to the
@@ -74,11 +46,9 @@ module RServiceBus2
     def send_subscriptions
       log 'Send Subscriptions'
 
-      @endpoint_mapping.get_subscription_endpoints.each do |event_name|
+      @endpoint_mapping.subscription_endpoints.each do |event_name|
         subscribe(event_name)
       end
-
-      self
     end
 
     # Load and configure Message Handlers
@@ -90,8 +60,6 @@ module RServiceBus2
       @config.handler_path_list.each do |path|
         @handler_loader.load_handlers_from_path(path)
       end
-
-      self
     end
 
     # Load and configure Sagas
@@ -103,14 +71,6 @@ module RServiceBus2
       @config.saga_path_list.each do |path|
         @saga_loader.load_sagas_from_path(path)
       end
-
-      self
-    end
-
-    # Thin veneer for Configuring Cron
-    def configure_cron_manager
-      @cron_manager = CronManager.new(self, @handler_manager.get_list_of_msg_names)
-      self
     end
 
     # Load Contracts
@@ -121,62 +81,50 @@ module RServiceBus2
         require path
         RServiceBus2.rlog "Loaded Contract: #{path}"
       end
-
-      self
     end
 
     # For each directory given, find and load all librarys
     def load_libs
       log 'Load Libs'
       @config.lib_list.each do |path|
-        $:.unshift path
+        $LOAD_PATH.unshift path
       end
-
-      self
     end
 
     # Load, configure and initialise Subscriptions
     def configure_subscriptions
       subscription_storage = ConfigureSubscriptionStorage.new.get(@config.app_name, @config.subscription_uri)
       @subscription_manager = SubscriptionManager.new(subscription_storage)
-      self
-    end
-
-    # Initialise statistics monitor
-    def configure_statistics
-      @stats = StatisticManager.new( self )
-      self
     end
 
     def initialize
       RServiceBus2.rlog "Current directory: #{Dir.pwd}"
-      @config = ConfigFromEnv.new.load_host_section
-                                  .load_contracts
-                                  .load_handler_path_list
-                                  .load_saga_path_list
-                                  .load_libs
-                                  .load_working_dir_list
+      @config = ConfigFromEnv.new
+                             .load_host_section
+                             .load_contracts
+                             .load_handler_path_list
+                             .load_saga_path_list
+                             .load_libs
+                             .load_working_dir_list
 
-      connect_to_mq
+      @mq = MQ.get
 
       @endpoint_mapping = EndpointMapping.new.configure(@mq.local_queue_name)
 
-      self.configure_statistics
-          .load_contracts
-          .load_libs
-          .configure_send_at_manager
-          .configure_state_manager
-          .configure_saga_storage
-          .configure_app_resource
-          .configure_circuit_breaker
-          .configure_monitors
-          .load_handlers
-          .load_sagas
-          .configure_cron_manager
-          .configure_subscriptions
-          .send_subscriptions
-
-      self
+      @stats = StatisticManager.new(self)
+      load_contracts
+      load_libs
+      @send_at_manager = SendAtManager.new(self)
+      @state_manager = StateManager.new
+      configure_saga_storage
+      configure_app_resource
+      @circuit_breaker = CircuitBreaker.new(self)
+      @monitors = ConfigureMonitor.new(self, @resource_manager).get_monitors(ENV)
+      load_handlers
+      load_sagas
+      @cron_manager = CronManager.new(self, @handler_manager.msg_names)
+      configure_subscriptions
+      send_subscriptions
     end
 
     # Ignition
@@ -185,10 +133,10 @@ module RServiceBus2
       log "Watching, #{@mq.local_queue_name}"
       $0 = "rservicebus - #{@mq.local_queue_name}"
       unless @config.forward_received_messages_to.nil?
-        log 'Forwarding all received messages to: ' + @config.forward_received_messages_to.to_s
+        log "Forwarding all received messages to: #{@config.forward_received_messages_to}"
       end
       unless @config.forward_sent_messages_to.nil?
-        log 'Forwarding all sent messages to: ' + @config.forward_sent_messages_to.to_s
+        log "Forwarding all sent messages to: #{@config.forward_sent_messages_to}"
       end
 
       start_listening_to_endpoints
@@ -258,7 +206,6 @@ module RServiceBus2
             _send_already_wrapped_and_serialised(serialized_object,
                                                  @config.error_queue_name)
             @mq.ack
-
           rescue PropertyNotSet => e
             # This has been re-rasied from a rescue in the handler
             puts "*** #{e.message}"
@@ -266,7 +213,6 @@ module RServiceBus2
             property_name = e.message[10, e.message.index(',', 10) - 10]
             puts "*** Ensure the environment variable, RSB_#{property_name},
               has been set at startup."
-
           rescue StandardError => e
             sleep 0.5
 
@@ -275,7 +221,7 @@ module RServiceBus2
             puts e.backtrace
             puts '***'
 
-            if retries > 0
+            if retries.positive?
               retries -= 1
               @mq.return_to_queue
             else
@@ -293,7 +239,7 @@ module RServiceBus2
                 abort
               end
 
-              error_string = e.message + '. ' + e.backtrace.join('. ')
+              error_string = "#{e.message}. #{e.backtrace.join('. ')}"
               @msg.add_error_msg(@mq.local_queue_name, error_string)
               serialized_object = YAML.dump(@msg)
               _send_already_wrapped_and_serialised(serialized_object, @config.error_queue_name)
@@ -318,7 +264,6 @@ module RServiceBus2
 
           @send_at_manager.process
           @circuit_breaker.success
-
         rescue StandardError => e
           if e.message == 'SIGTERM' || e.message == 'SIGINT'
             puts 'Exiting on request ...'
@@ -326,7 +271,7 @@ module RServiceBus2
           else
             puts '*** This is really unexpected.'
             message_loop = false
-            puts 'Message: ' + e.message
+            puts "Message: #{e.message}"
             puts e.backtrace
           end
         end
@@ -338,33 +283,29 @@ module RServiceBus2
       @resource_manager.begin
       msg_name = @msg.msg.class.name
       handler_list = @handler_manager.get_handler_list_for_msg(msg_name)
-      RServiceBus2.rlog 'Handler found for: ' + msg_name
+      RServiceBus2.rlog "Handler found for: #{msg_name}"
       begin
         @queue_for_msgs_to_be_sent_on_complete = []
 
         log "Started processing msg, #{msg_name}"
         handler_list.each do |handler|
-          begin
-            log "Handler, #{handler.class.name}, Started"
-            handler.handle(@msg.msg)
-            log "Handler, #{handler.class.name}, Finished"
-          rescue PropertyNotSet => e
-            raise PropertyNotSet.new( "Property, #{e.message}, not set for, #{handler.class.name}" )
-          rescue StandardError => e
-            puts "E #{e.message}"
-            log 'An error occurred in Handler: ' + handler.class.name
-            raise e
-          end
+          log "Handler, #{handler.class.name}, Started"
+          handler.handle(@msg.msg)
+          log "Handler, #{handler.class.name}, Finished"
+        rescue PropertyNotSet => e
+          raise PropertyNotSet, "Property, #{e.message}, not set for, #{handler.class.name}"
+        rescue StandardError => e
+          puts "E #{e.message}"
+          log "An error occurred in Handler: #{handler.class.name}"
+          raise e
         end
 
-        if @saga_manager.handle(@msg) == false && handler_list.length == 0
-          fail NoHandlerFound, msg_name
-        end
+        raise NoHandlerFound, msg_name if @saga_manager.handle(@msg) == false && handler_list.length.zero?
+
         @resource_manager.commit(msg_name)
 
         send_queued_msgs
         log "Finished processing msg, #{msg_name}"
-
       rescue StandardError => e
         @resource_manager.rollback(msg_name)
         @queue_for_msgs_to_be_sent_on_complete = nil
@@ -381,9 +322,7 @@ module RServiceBus2
     def _send_already_wrapped_and_serialised(serialized_object, queue_name)
       RServiceBus2.rlog 'Bus._send_already_wrapped_and_serialised'
 
-      unless @config.forward_sent_messages_to.nil?
-        @mq.send(@config.forward_sent_messages_to, serialized_object)
-      end
+      @mq.send(@config.forward_sent_messages_to, serialized_object) unless @config.forward_sent_messages_to.nil?
 
       @mq.send(queue_name, serialized_object)
     end
@@ -400,8 +339,8 @@ module RServiceBus2
         RServiceBus2.rlog "Sending, #{msg.class.name} to, #{queue_name}"
       else
         parts = queue_name.split('@')
-        r_msg.set_remote_queue_name(parts[0])
-        r_msg.set_remote_host_name(parts[1])
+        r_msg.remote_queue_name = parts[0]
+        r_msg.remote_host_name = parts[1]
         q = 'transport-out'
         RServiceBus2.rlog "Sending, #{msg.class.name} to, #{queue_name}, via #{q}"
       end
@@ -422,19 +361,20 @@ module RServiceBus2
 
     def queue_msg_for_send_on_complete(msg, queue_name, timestamp = nil)
       correlation_id = @saga_data.nil? ? nil : @saga_data.correlation_id
-      correlation_id = (!@msg.nil? && !@msg.correlation_id.nil?) ? @msg.correlation_id : correlation_id
-      @queue_for_msgs_to_be_sent_on_complete << Hash['msg', msg, 'queue_name', queue_name, 'correlation_id', correlation_id, 'timestamp',timestamp ]
+      correlation_id = !@msg.nil? && !@msg.correlation_id.nil? ? @msg.correlation_id : correlation_id
+      @queue_for_msgs_to_be_sent_on_complete <<
+        Hash['msg', msg, 'queue_name', queue_name, 'correlation_id', correlation_id, 'timestamp', timestamp]
     end
 
     # Sends a msg back across the bus
     # Reply queues are specified in each msg. It works like
     # email, where the reply address can actually be anywhere
     # @param [RServiceBus2::Message] msg msg to be sent
-    def reply(msg)
-      RServiceBus2.rlog 'Reply with: ' + msg.class.name + ' To: ' + @msg.return_address
+    def reply(msg, timestamp = nil)
+      RServiceBus2.rlog "Reply with: #{msg.class.name} To: #{@msg.return_address}"
       @stats.inc_total_reply
 
-      queue_msg_for_send_on_complete(msg, @msg.return_address)
+      queue_msg_for_send_on_complete(msg, @msg.return_address, timestamp)
     end
 
     def get_endpoint_for_msg(msg_name)
@@ -443,21 +383,20 @@ module RServiceBus2
 
       return @mq.local_queue_name if @handler_manager.can_msg_be_handled_locally(msg_name)
 
-      log 'No end point mapping found for: ' + msg_name
-      log '**** Check environment variable MessageEndpointMappings contains an entry named : ' + msg_name
-      raise 'No end point mapping found for: ' + msg_name
+      log "No end point mapping found for: #{msg_name}"
+      log "**** Check environment variable MessageEndpointMappings contains an entry named: #{msg_name}"
+      raise "No end point mapping found for: #{msg_name}"
     end
 
-
     # Send a msg across the bus
     # msg destination is specified at the infrastructure level
     # @param [RServiceBus2::Message] msg msg to be sent
-    def send( msg, timestamp=nil )
+    def send(msg, timestamp = nil)
       RServiceBus2.rlog 'Bus.Send'
       @stats.inc_total_sent
 
       msg_name = msg.class.name
-      queue_name = self.get_endpoint_for_msg(msg_name)
+      queue_name = get_endpoint_for_msg(msg_name)
       queue_msg_for_send_on_complete(msg, queue_name, timestamp)
     end
 
@@ -476,7 +415,7 @@ module RServiceBus2
     # Sends a subscription request across the Bus
     # @param [String] eventName event to be subscribes to
     def subscribe(event_name)
-      RServiceBus2.rlog 'Bus.Subscribe: ' + event_name
+      RServiceBus2.rlog "Bus.Subscribe: #{event_name}"
 
       queue_name = get_endpoint_for_msg(event_name)
       subscription = MessageSubscription.new(event_name)