harmoniser 0.8.1 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22ff604975432b081956834ca20441d85c8ae98ce690a6185daea4e0d7a1eb11
-  data.tar.gz: 1b5c12440738254845b8f7d717013f5306ea760df126cc702dbce178af9e7f32
+  metadata.gz: cd51302d5c886af771b66e4528054042a8922071669719ba625aac5d5c0dc503
+  data.tar.gz: 2dd00c5d6699436fca25d6c721cba80518aa8baa967e3bca247af408b829582b
 SHA512:
-  metadata.gz: '0568d8afd4545a550a645f016936cc27866973216a20a3aa7cb9b083b8e62ce0fab3e6dca8e1b5dadf8104edc7a7f08a165d1b252dc94fcb0ee631fe489f19d8'
-  data.tar.gz: cf2e9b2f429f0bf8a4abf7741f893d732fa8cde55935aa3f518222e1aaf1857313019c6b9f049b4fdf0be8882b5c392a1dc6dbfd70e0048a9826a4af89edcc5e
+  metadata.gz: 6f2f43e8bc13d89db74bc38da9e08b86773aea3582cf5df277c985df22a016aa22bc5f965243b3df451c9f22ff40bc16299aeece5b7d5d15d57b6a43fb8b2233
+  data.tar.gz: e3768b89e31de5b74b27333a990247b416067acc6055e4a1ea15d3ad63560a91780d9f379ced069f0cc9c950907186d2e67cd5daaacfaaf4b4f64b8715804415

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## [0.9.0] - 2024-08-09
+
+### Added
+- Add debug log when a message is received by a subscriber
+- Add error_class, error_message and error_backtrace for `--require` option from cli
+
+### Changed
+- Amend debug log when a message is published so that exchange name is included
+- Improve error message for MissingExchangeDefinition and
+  MissingConsumerDefinition
+- Define dev dependencies through Gemfile instead of gemspec
+- Changed Topology methods to return self so that Topology definition becomes chainable
+
 ## [0.8.1] - 2024-04-08
 
 ### Fixed

data/harmoniser.gemspec

@@ -25,7 +25,4 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_runtime_dependency "bunny", "~> 2.22"
-  spec.add_development_dependency "rake", "~> 13.0"
-  spec.add_development_dependency "rspec", "~> 3"
-  spec.add_development_dependency "standardrb", "~> 1.0"
 end

data/lib/harmoniser/launcher.rb

@@ -34,14 +34,14 @@ module Harmoniser
     def load_rails
       filepath = File.expand_path("#{@configuration.require}/config/environment.rb")
       require filepath
-    rescue LoadError
-      @logger.warn("Error while requiring file within directory. No subscribers will run for this process: require = `#{@configuration.require}`, filepath = `#{filepath}`")
+    rescue LoadError => e
+      @logger.warn("Error while requiring file within directory. No subscribers will run for this process: require = `#{@configuration.require}`, filepath = `#{filepath}`, error_class = `#{e.class}`, error_message = `#{e.message}`, error_backtrace = `#{e.backtrace&.first(5)}`")
     end
 
     def load_file
       require @configuration.require
-    rescue LoadError
-      @logger.warn("Error while requiring file. No subscribers will run for this process: require = `#{@configuration.require}`")
+    rescue LoadError => e
+      @logger.warn("Error while requiring file. No subscribers will run for this process: require = `#{@configuration.require}`, error_class = `#{e.class}`, error_message = `#{e.message}`, error_backtrace = `#{e.backtrace&.first(5)}`")
     end
   end
 end

data/lib/harmoniser/publisher.rb

@@ -21,7 +21,7 @@ module Harmoniser
         const_get(:HARMONISER_PUBLISHER_MUTEX).synchronize do
           harmoniser_exchange.publish(payload, opts)
         end
-        Harmoniser.logger.debug { "Message published: payload = `#{payload}`, opts = `#{opts}`" }
+        Harmoniser.logger.debug { "Message published: exchange = `#{@harmoniser_exchange_definition.name}`, payload = `#{payload}`, opts = `#{opts}`" }
 
         harmoniser_exchange
       end
@@ -44,7 +44,7 @@ module Harmoniser
       end
 
       def raise_missing_exchange_definition
-        raise MissingExchangeDefinition, "Please, call harmoniser_publisher class method first with the exchange_name that will be used for publications"
+        raise MissingExchangeDefinition, "Please call the harmoniser_publisher class method at `#{const_get(:HARMONISER_PUBLISHER_CLASS)}` with the exchange_name that will be used for publishing"
       end
 
       def handle_return(exchange)
@@ -57,6 +57,7 @@ module Harmoniser
     class << self
       def included(base)
         base.const_set(:HARMONISER_PUBLISHER_MUTEX, Mutex.new)
+        base.const_set(:HARMONISER_PUBLISHER_CLASS, base)
         base.extend(ClassMethods)
       end
     end

data/lib/harmoniser/subscriber.rb

@@ -57,6 +57,7 @@ module Harmoniser
 
       def handle_delivery(consumer)
         consumer.on_delivery do |delivery_info, properties, payload|
+          Harmoniser.logger.debug { "Message received by a consumer: consumer_tag = `#{consumer.consumer_tag}, `payload = `#{payload}`, queue = `#{consumer.queue}`" }
           if respond_to?(:on_delivery)
             on_delivery(delivery_info, properties, payload)
           else
@@ -70,13 +71,14 @@ module Harmoniser
       end
 
       def raise_missing_consumer_definition
-        raise MissingConsumerDefinition, "Please, call harmoniser_subscriber class method first with the queue_name that will be used for subscribing"
+        raise MissingConsumerDefinition, "Please call the harmoniser_subscriber class method at `#{const_get(:HARMONISER_SUBSCRIBER_CLASS)}` with the queue_name that will be used for subscribing"
       end
     end
 
     class << self
       def included(base)
         base.const_set(:HARMONISER_SUBSCRIBER_MUTEX, Mutex.new)
+        base.const_set(:HARMONISER_SUBSCRIBER_CLASS, base)
         base.extend(ClassMethods)
         harmoniser_register_included(base)
       end

data/lib/harmoniser/topology.rb

@@ -19,6 +19,7 @@ module Harmoniser
         name: name,
         opts: opts
       )
+      self
     end
 
     def add_queue(name, **opts)
@@ -26,6 +27,7 @@ module Harmoniser
         name: name,
         opts: opts
       )
+      self
     end
 
     def add_binding(exchange_name, destination_name, destination_type = :queue, **opts)
@@ -35,6 +37,7 @@ module Harmoniser
         destination_type: destination_type,
         opts: opts
       )
+      self
     end
 
     def declare

data/lib/harmoniser/version.rb

@@ -1,3 +1,3 @@
 module Harmoniser
-  VERSION = "0.8.1"
+  VERSION = "0.9.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: harmoniser
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.9.0
 platform: ruby
 authors:
 - Jose Lloret
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-04-07 00:00:00.000000000 Z
+date: 2024-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny
@@ -24,48 +24,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.22'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3'
-- !ruby/object:Gem::Dependency
-  name: standardrb
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
 description: A declarative approach to communication with RabbitMQ that simplifies
   the integration of publishing and consuming messages.
 email: