harmoniser 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b56f94d1422e43dd7f7505516400c8f5949998dd8e4a1c8ec36c7c2f5a9ae9f0
-  data.tar.gz: fa96845e13121f315b6af48ef5b765272d00f4ea62ab32a4b3da91ef2eaab712
+  metadata.gz: 4410b741fa891c42db5f51dc48889768859a9a84a3eed3676fc35f0aaeb8cca1
+  data.tar.gz: c6af823a40e9b007f93a347e84ad44aee26dea0e10464fc608c116db7185ec19
 SHA512:
-  metadata.gz: 884789f7ccbb0fb23577ed739d352bc332fd9ef8064e9df0c4b355bead5b51b62c563328ac307409fe53481b68990f77f5f7ef34959d6cbc5a00bf364fb9e1ef
-  data.tar.gz: 30c55195bad1e6fe12d213377abeb8c25178e838a7745346e6858ced90efa67eb925a028324cce0361d403aad2c249141cbb0be6376383a4e17a443c8051a542
+  metadata.gz: d843cfe2d70c4ad95cfbe1ce592b7691c057840a191fb7838670eb68205a44549fd7b8e83ff75c2f7888d5c303903f357b93f64c1e37cd5ec342ebb17553051c
+  data.tar.gz: 331c5f2133c0e291581ae3f14be398dac07df8adbc43ad72de798171346380f28a084988ff0215922c12783c6e28ec93640dada3ee9aa096ca63ba43a08d2ee3

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## [0.6.0] - 2023-12-30
+
+### Added
+- Create a channel for each class including Harmoniser::Publisher or Harmoniser::Subscriber. A mutex in the context of the class including Publisher or Subscriber modules control access to the resources created as well as guarantees safe publication under multi-thread process.
+- Introduce broadcast and unicast examples.
+- Amend specs to wipe out RabbitMQ resources created during spec execution.
+
+### Changed
+- Honour verbose option regardless of the environment configuration set. For instance, for non-production environment, verbose is no longer verbose set by default.
+
 ## [0.5.0] - 2023-12-20
 
 ### Added

data/README.md

@@ -51,7 +51,7 @@ end
 MyPublisher.publish({ salute: "Hello World!" }.to_json, routing_key: "my_resource.foo.bar")
 ```
 
-The code above assumes that the exchange is already defined. We'd like to emphasize that defining RabbitMQ topology (exchanges, queues and binding) should be performed outside of the class whose role is purely focused on publishing. See more details about how to define the topology [here](examples/multicast.rb#L9-L18).
+The code above assumes that the exchange is already defined. We'd like to emphasize that defining RabbitMQ topology (exchanges, queues and binding) should be performed outside of the class whose role is purely focused on publishing. See more details about how to define the topology [here](examples/multicast.rb#L11-L19).
 
 ### RabbitMQ
 
@@ -78,19 +78,10 @@ Harmoniser server is a process specifically dedicated to run Subscribers that ar
 class MySubscriber
   include Harmoniser::Subscriber
   harmoniser_subscriber queue_name: "my_queue"
-
-  class << self
-    def on_delivery(delivery_info, properties, payload)
-      Harmoniser.logger.info({
-        body: "message received",
-        payload: payload
-      }.to_json)
-    end
-  end
 end
 ```
 
-The code above assumes that the queue and its binding to an exchange are already defined. You can see more details about how this is specified [here](examples/multicast.rb#L9-L18).
+The code above assumes that the queue and its binding to an exchange are already defined. You can see more details about how this is specified [here](examples/multicast.rb#L11-L19).
 
 In order for the subscribers to receive messages from a queue, you should spin up a dedicated Ruby process like following:
 

data/docs/cli.md

@@ -17,4 +17,4 @@ The `environment` is automatically inferred from the environment variables `RAIL
 
 The `require` is by default pointing at `.`, which means that this option when configured under a Rails application, might be ignored. Since Ruby is not Rails only, you can certainly specify the location path of your Ruby file that will be used to load the classes including Harmoniser::Subscriber. In contrast, if a path to a directory is passed, Harmoniser assumes that `./config/environment.rb` lives within the folder passed as option.
 
-The `verbose` option, when passed, sets the severity of Harmoniser logs to `debug` being able to see fine-grained details of things like RabbitMQ interactions happening or messages published into exchanges. By default, the verbosity is disabled to prevent your production environment to be flooded with unnecessary logs, however if the environment is not set to `production`, the severity of the logs is `debug` mode too.
+The `verbose` option, when passed, sets the severity of Harmoniser logs to `debug` being able to see fine-grained details of things like RabbitMQ interactions happening or messages published into exchanges. By default, the verbosity is disabled to prevent your environment to be flooded with unnecessary logs.

data/lib/harmoniser/configuration.rb

@@ -40,11 +40,7 @@ module Harmoniser
     end
 
     def set_logger_severity
-      @logger.level = if @options.production?
-        @options.verbose? ? Logger::DEBUG : Logger::INFO
-      else
-        Logger::DEBUG
-      end
+      @logger.level = @options.verbose? ? Logger::DEBUG : Logger::INFO
     end
   end
 end

data/lib/harmoniser/publisher.rb

@@ -5,8 +5,6 @@ module Harmoniser
   module Publisher
     class MissingExchangeDefinition < StandardError; end
     include Channelable
-    MUTEX = Mutex.new
-    private_constant :MUTEX
 
     module ClassMethods
       def harmoniser_publisher(exchange_name:)
@@ -20,7 +18,7 @@ module Harmoniser
       def publish(payload, opts = {})
         raise_missing_exchange_definition unless @harmoniser_exchange_definition
 
-        MUTEX.synchronize do
+        const_get(:HARMONISER_PUBLISHER_MUTEX).synchronize do
           harmoniser_exchange.publish(payload, opts)
         end
         Harmoniser.logger.debug { "Message published: payload = `#{payload}`, opts = `#{opts}`" }
@@ -31,10 +29,8 @@ module Harmoniser
       private
 
       def harmoniser_exchange
-        return @harmoniser_exchange if @harmoniser_exchange
-
         @harmoniser_exchange ||= Bunny::Exchange.new(
-          Publisher.harmoniser_channel,
+          Publisher.create_channel,
           @harmoniser_exchange_definition.type,
           @harmoniser_exchange_definition.name,
           @harmoniser_exchange_definition.opts
@@ -48,6 +44,7 @@ module Harmoniser
 
     class << self
       def included(base)
+        base.const_set(:HARMONISER_PUBLISHER_MUTEX, Mutex.new)
         base.extend(ClassMethods)
       end
     end

data/lib/harmoniser/subscriber.rb

@@ -7,8 +7,6 @@ module Harmoniser
     class MissingConsumerDefinition < StandardError; end
     include Channelable
     include Includable
-    MUTEX = Mutex.new
-    private_constant :MUTEX
 
     module ClassMethods
       def harmoniser_subscriber(queue_name:, consumer_tag: nil, no_ack: true, exclusive: false, arguments: {})
@@ -22,7 +20,7 @@ module Harmoniser
       end
 
       def harmoniser_subscriber_start
-        MUTEX.synchronize do
+        const_get(:HARMONISER_SUBSCRIBER_MUTEX).synchronize do
           @harmoniser_consumer ||= create_consumer
         end
       end
@@ -32,10 +30,11 @@ module Harmoniser
       def create_consumer
         raise_missing_consumer_definition unless @harmoniser_consumer_definition
 
+        channel = Subscriber.create_channel
         consumer = Bunny::Consumer.new(
-          Subscriber.harmoniser_channel,
+          channel,
           @harmoniser_consumer_definition.queue_name,
-          @harmoniser_consumer_definition.consumer_tag || Subscriber.harmoniser_channel.generate_consumer_tag,
+          @harmoniser_consumer_definition.consumer_tag || channel.generate_consumer_tag,
           @harmoniser_consumer_definition.no_ack,
           @harmoniser_consumer_definition.exclusive,
           @harmoniser_consumer_definition.arguments
@@ -77,6 +76,7 @@ module Harmoniser
 
     class << self
       def included(base)
+        base.const_set(:HARMONISER_SUBSCRIBER_MUTEX, Mutex.new)
         base.extend(ClassMethods)
         harmoniser_register_included(base)
       end

data/lib/harmoniser/version.rb

@@ -1,3 +1,3 @@
 module Harmoniser
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: harmoniser
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Jose Lloret
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-12-20 00:00:00.000000000 Z
+date: 2023-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny