rservicebus2 0.2.7 → 0.2.12

data/lib/rservicebus2/endpointmapping.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RServiceBus2
   # Marshals data for message end points
   # Expected format: <msg mame 1>:<end point 1>;<msg mame 2>:<end point 2>
@@ -6,16 +8,17 @@ module RServiceBus2
       RServiceBus2.get_value(name)
     end
 
-    def log(string, _ver = false)
+    def log(string, _ver: false)
       RServiceBus2.log(string)
     end
 
+    # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
     def configure_mapping(mapping)
       match = mapping.match(/(.+):(.+)/)
       if match.nil?
-        log 'Mapping string provided is invalid'
-        log "The entire mapping string is: #{mapping}"
-        log "*** Could not find ':' in mapping entry, #{line}"
+        log 'Mapping string provided is invalid\n' \
+            "The entire mapping string is: #{mapping}\n" \
+            "*** Could not find ':' in mapping entry, #{line}\n"
         exit
       end
 
@@ -23,16 +26,18 @@ module RServiceBus2
       @endpoints[match[1]] = match[2]
 
       @queue_name_list.each do |q|
-        if q != match[2] && q.downcase == match[2].downcase
-          log('*** Two queues specified with only case sensitive difference.')
-          log("*** #{q} != #{match[2]}")
-          log('*** If you meant these queues to be the same, please match case
-                and restart the bus.')
-        end
+        next unless q != match[2] && q.downcase == match[2].downcase
+
+        log('*** Two queues specified with only case sensitive difference.')
+        log("*** #{q} != #{match[2]}")
+        log('*** If you meant these queues to be the same, please match case
+              and restart the bus.')
       end
       @queue_name_list << match[2]
     end
+    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
 
+    # rubocop:disable Metrics/MethodLength
     def configure(local_queue_name = nil)
       log('EndpointMapping.Configure')
 
@@ -40,9 +45,9 @@ module RServiceBus2
       @queue_name_list << local_queue_name unless local_queue_name.nil?
 
       unless get_value('MESSAGE_ENDPOINT_MAPPING').nil?
-        log('*** MESSAGE_ENDPOINT_MAPPING environment variable was detected')
-        log("*** You may have intended MESSAGE_ENDPOINT_MAPPINGS, note the 'S'
-              on the end")
+        log '*** MESSAGE_ENDPOINT_MAPPING environment variable was detected\n' \
+            "*** You may have intended MESSAGE_ENDPOINT_MAPPINGS, note the 'S'
+              on the end"
       end
 
       mappings = get_value('MESSAGE_ENDPOINT_MAPPINGS')
@@ -54,6 +59,7 @@ module RServiceBus2
 
       self
     end
+    # rubocop:enable Metrics/MethodLength
 
     def initialize
       @endpoints = {}
@@ -65,7 +71,7 @@ module RServiceBus2
       nil
     end
 
-    def get_subscription_endpoints
+    def subscription_endpoints
       @endpoints.keys.select { |el| el.end_with?('Event') }
     end
   end

data/lib/rservicebus2/errormessage.rb

@@ -1,11 +1,12 @@
-module RServiceBus2
+# frozen_string_literal: true
 
+module RServiceBus2
   # Error Message
   class ErrorMessage
     attr_reader :occurredat, :source_queue, :error_msg
 
     def initialize(source_queue, error_msg)
-      @occurredat = DateTime.now
+      @occurredat = Time.now
 
       @source_queue = source_queue
       @error_msg = error_msg

data/lib/rservicebus2/handler_loader.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module RServiceBus2
   # Given a directory, this class is responsible for finding
   #  msgnames,
   #  handlernames, and
   #  loading handlers
   class HandlerLoader
-    attr_reader :handlerList
+    # attr_reader :handlerList - 8 May 2021
 
     # Constructor
     #
@@ -22,12 +24,11 @@ module RServiceBus2
     # Cleans the given path to ensure it can be used for as a parameter for the require statement.
     # @param [String] file_path the path to be cleaned
     def get_require_path(file_path)
-      file_path = './' + file_path unless file_path.start_with?('/')
+      file_path = "./#{file_path}" unless file_path.start_with?('/')
 
       return file_path.sub('.rb', '') if File.exist?(file_path)
 
-      abort('Filepath, ' + file_path + ", given for messagehandler require
-        doesn't exist")
+      abort("Filepath, #{file_path}, given for messagehandler require doesn't exist")
     end
 
     # Instantiate the handler named in handlerName from the file name in
@@ -38,6 +39,7 @@ module RServiceBus2
     # @param [String] handler_name name of the handler to instantiate
     # @param [String] file_path the path to the file to be loaded
     # @return [RServiceBus2::Handler] the loader
+    # rubocop:disable Metrics/MethodLength
     def load_handler_from_file(handler_name, file_path)
       require_path = get_require_path(file_path)
 
@@ -45,22 +47,22 @@ module RServiceBus2
       begin
         handler = Object.const_get(handler_name).new
       rescue StandardError => e
-        puts 'Expected class name: ' + handler_name + ', not found after
-          require: ' + require_path
-        puts '**** Check in ' + file_path + ' that the class is named : ' +
-          handler_name
-        puts '( In case its not that )'
+        puts "Expected class name: #{handler_name}, not found after require: #{require_path}\n" \
+             "**** Check in #{file_path} that the class is named: #{handler_name}\n" \
+             '( In case its not that )'
         raise e
       end
 
       handler
     end
+    # rubocop:enable Metrics/MethodLength
 
     # Wrapper function
     #
     # @param [String] file_path
     # @param [String] handler_name
     # @returns [RServiceBus2::Handler] handler
+    # rubocop:disable Metrics/MethodLength
     def load_handler(msg_name, file_path, handler_name)
       if @list_of_loaded_paths.key?(file_path)
         RServiceBus2.log "Not reloading, #{file_path}"
@@ -68,29 +70,30 @@ module RServiceBus2
       end
 
       begin
-        RServiceBus2.rlog 'file_path: ' + file_path
-        RServiceBus2.rlog 'handler_name: ' + handler_name
+        RServiceBus2.rlog "file_path: #{file_path}"
+        RServiceBus2.rlog "handler_name: #{handler_name}"
 
         handler = load_handler_from_file(handler_name, file_path)
-        RServiceBus2.log 'Loaded Handler: ' + handler_name
+        RServiceBus2.log "Loaded Handler: #{handler_name}"
 
         @handler_manager.add_handler(msg_name, handler)
 
         @list_of_loaded_paths[file_path] = 1
       rescue StandardError => e
-        puts 'Exception loading handler from file: ' + file_path
+        puts "Exception loading handler from file: #{file_path}"
         puts e.message
         puts e.backtrace[0]
         abort
       end
     end
+    # rubocop:enable Metrics/MethodLength
 
     # This method is overloaded for unit tests
     #
     # @param [String] path directory to check
     # @return [Array] a list of paths to files found in the given path
     def get_list_of_files_for_dir(path)
-      list = Dir[path + '/*']
+      list = Dir["#{path}/*"]
       RServiceBus2.rlog "HandlerLoader.getListOfFilesForDir. path: #{path},
         list: #{list}"
       list
@@ -105,14 +108,14 @@ module RServiceBus2
     def load_handlers_from_second_level_path(msg_name, base_dir)
       get_list_of_files_for_dir(base_dir).each do |file_path|
         next if file_path.end_with?('.')
+        next unless !File.directory?(file_path) && File.extname(file_path) == '.rb'
 
-        ext_name = File.extname(file_path)
-        if !File.directory?(file_path) && ext_name == '.rb'
-          file_name = File.basename(file_path).sub('.rb', '')
-          handler_name = "message_handler_#{msg_name}_#{file_name}".gsub(/(?<=_|^)(\w)/){$1.upcase}.gsub(/(?:_)(\w)/,'\1') # Classify
+        file_name = File.basename(file_path).sub('.rb', '')
+        # Classify
+        handler_name = "message_handler_#{msg_name}_#{file_name}"
+                       .gsub(/(?<=_|^)(\w)/) { Regexp.last_match(1).upcase }.gsub(/(?:_)(\w)/, '\1')
 
-          load_handler(msg_name, file_path, handler_name)
-        end
+        load_handler(msg_name, file_path, handler_name)
       end
 
       self
@@ -130,22 +133,26 @@ module RServiceBus2
     # Load top level handlers from the given directory
     #
     # @param [String] baseDir directory to check - should not have trailing slash
+    # rubocop:disable Metrics/MethodLength
     def load_handlers_from_top_level_path(base_dir)
       RServiceBus2.rlog "HandlerLoader.loadHandlersFromTopLevelPath. baseDir: #{base_dir}"
       get_list_of_files_for_dir(base_dir).each do |file_path|
-        unless file_path.end_with?('.')
-          msg_name = get_msg_name(file_path)
-          if File.directory?(file_path)
-            load_handlers_from_second_level_path(msg_name, file_path)
-          else
-            handler_name = "message_handler_#{msg_name}".gsub(/(?<=_|^)(\w)/){$1.upcase}.gsub(/(?:_)(\w)/,'\1') # Classify
-            load_handler(msg_name, file_path, handler_name)
-          end
+        next if file_path.end_with?('.')
+
+        msg_name = get_msg_name(file_path)
+        if File.directory?(file_path)
+          load_handlers_from_second_level_path(msg_name, file_path)
+        else
+          # Classify
+          handler_name = "message_handler_#{msg_name}"
+                         .gsub(/(?<=_|^)(\w)/) { Regexp.last_match(1).upcase }.gsub(/(?:_)(\w)/, '\1')
+          load_handler(msg_name, file_path, handler_name)
         end
       end
 
       self
     end
+    # rubocop:enable Metrics/MethodLength
 
     # Entry point for loading handlers
     #

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
+          handler.instance_variable_set("@#{k}", @resource_manager.get(k).resource)
+          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 = {}
@@ -11,14 +14,14 @@ module RServiceBus2
     convert_dto_to_hash(obj).to_json
   end
 
-  def self.log(string, ver = false)
+  def self.log(string, ver: false)
     return if check_environment_variable('TESTING')
 
     type = ver ? 'VERB' : 'INFO'
-    if check_environment_variable('VERBOSE') || !ver
-      timestamp = Time.new.strftime('%Y-%m-%d %H:%M:%S')
-      puts "[#{type}] #{timestamp} :: #{string}"
-    end
+    return unless check_environment_variable('VERBOSE') || !ver
+
+    timestamp = Time.new.strftime('%Y-%m-%d %H:%M:%S')
+    puts "[#{type}] #{timestamp} :: #{string}"
   end
 
   def self.rlog(string)
@@ -35,11 +38,12 @@ 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
 
+  # rubocop:disable Metrics/MethodLength
   def self.send_msg(msg, response_queue = 'agent')
     require 'rservicebus2/endpointmapping'
     endpoint_mapping = EndpointMapping.new
@@ -50,15 +54,13 @@ 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"
-    msg = "#{msg}*** Ensure you have an environment variable set for this
-            Message Type, eg, \n"
-    msg = "#{msg}*** MESSAGE_ENDPOINT_MAPPINGS=#{e.message}:<QueueName>\n"
-    raise StandardError, msg
+    raise StandardError, '' \
+      "*** Queue not found for, #{e.message}\n" \
+      "*** Ensure you have an environment variable set for this Message Type, eg, \n" \
+      "*** MESSAGE_ENDPOINT_MAPPINGS=#{e.message}:<QueueName>\n"
   end
+  # rubocop:enable Metrics/MethodLength
 
   def self.check_for_reply(queue_name)
     ENV['RSBMQ'] = 'beanstalk://localhost' if ENV['RSBMQ'].nil?
@@ -74,12 +76,15 @@ module RServiceBus2
       #{caller[0]}. #{string}"
   end
 
+  # rubocop:disable Metrics/CyclomaticComplexity
   def self.check_environment_variable(string)
-    return false if ENV[string].nil?
+    return false if ENV[string].nil? || 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
+  # rubocop:enable Metrics/CyclomaticComplexity
 end