stenotype 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b998a75c7aef576ca3040ad7cd7a07082fddc9cd937b57e3d3e84d807124aba
-  data.tar.gz: 29d5bc462c420c881eeeeca851146c74e8f6db1240de777d8e19ca0806274fdd
+  metadata.gz: 9da486b9bc096f52bf0b4f81526d5d4922e0fa10a05141e28f2f55154c41cf3b
+  data.tar.gz: 2ef09f562429fded9c425086714985ef61736e458c9b111aeeb124d9e276f6db
 SHA512:
-  metadata.gz: 71094a00ecce450e4e2edbbda1327cf2f794c52d5d64bd304b67ec5f2498e49020c0ed4f2a07bc9425d5df8929ebe2d809447ea4b52baca0eb6569af27fcf22a
-  data.tar.gz: 1874d642a66cc7a2771fd78e92a2dc3e7aaea9ea520055cc2b7abe5bb2f9bf51dce5989e1498352411d134a371ec8b546ded1e8cb8e3d75b7408eaa340d06cbd
+  metadata.gz: 8db324c94a6d1fdbf2d692df8ae87dca43ede513a1df59e3ba0db91eaa0b2dd4e44ac7f5e7a4c52893049ca1181da61b9a32cca69312693115cc788eb2230125
+  data.tar.gz: 45292456af9acee8382436aa02452512bd29f7f40c1033f0a548a6b01fe12a6a8d78dd42a20193755a904a1837bf7ecd4831676a7f42aa4cae7b6bab4af7c1f4

data/.gitignore

@@ -11,3 +11,6 @@
 .rspec_status
 /.rakeTasks
 /.idea
+
+# rbenv
+.ruby-version

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 # Changelog
 
-*Release Date*: 2019/11/21
+*Release Date*: 2020/01/10
+
+### 0.1.3: 2020/01/10
+* Adds a new configuration option `graceful_error_handling` to suppress errors raised from the gem's internals yet logging the error to specified `config.logger`
+* Adds a new configuration option `logger` to use during error handling
+* Adds a new config option `Stenotype.config.enabled`. If the option is set to false then event is not going to be published. The option is `true` by default.
 
 ### 0.1.2: 2019/12/10
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    stenotype (0.1.2)
+    stenotype (0.1.4)
       activesupport (>= 5.0.0)
       google-cloud-pubsub (~> 1.0.0)
       spicery (>= 0.19.0, < 1.0)
@@ -147,7 +147,7 @@ GEM
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
     public_suffix (4.0.1)
-    rack (2.0.7)
+    rack (2.0.8)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
     rails (5.2.4)

data/README.md

@@ -25,13 +25,16 @@ Or install it yourself as:
 Configuring the library is as simple as:
 ```ruby
 Stenotype.configure do |config|
+  config.enabled = true
   config.targets = [ # Supported targets
     Stenotype::Adapters::StdoutAdapter.new,
     Stenotype::Adapters::GoogleCloud.new
   ]
 
-  config.uuid_generator = SecureRandom
-  config.dispatcher     = Stenotype::Dispatcher.new
+  config.uuid_generator          = SecureRandom
+  config.dispatcher              = Stenotype::Dispatcher.new
+  config.logger                  = Logger.new(STDOUT)
+  config.graceful_error_handling = true
 
   config.google_cloud do |gc_config|
     gc_config.project_id  = "google_cloud_project_id"
@@ -47,10 +50,22 @@ Stenotype.configure do |config|
 end
 ```
 
+#### config.enabled
+
+A flag checked upon emission of an event. Will prevent event emission if set to false. An event is emitted if set to true.
+
 #### config.targets
 
 Contain an array of targets for the events to be published to. Targets must implement method `#publish(event_data, **additional_arguments)`.
 
+#### config.logger
+
+Specifies a logger for messages and exceptions to be output to. If not set defaults to `Logger.new(STDOUT)`, otherwise a manually set logger is used.
+
+#### config.graceful_error_handling
+
+This flag if set to `true` is going to suppress all `StandardError`'s raised within a gem. Raises the error to the caller if set to `false`
+
 #### config.uuid_generator
 
 An object that must implement method `#uuid`. Used when an event is emitted to generate a unique id for each event.

data/lib/generators/stenotype/initializer/templates/initializer.rb.erb

@@ -18,6 +18,9 @@ Rails.application.configure do
     #   rails_modules.enable_active_job_ext = true
     # end
     #
+    # To enable or disable the library use the following config option:
+    #
+    # config.enabled = true # or false
     #
     # To make publishing possible one must specify a list of targets. You could use
     # StdoutAdapter for debug purposes before switching to a production publisher.
@@ -60,6 +63,14 @@ Rails.application.configure do
     #
     # config.dispatcher = Stenotype::Dispatcher
     #
+    # An option to suppress exception within a gem is available:
+    #
+    # config.graceful_error_handling = true
+    #
+    # To log errors a logger config option is available. Logger.new(STDOUT) is used by default.
+    #
+    # config.logger = Logger.new(STDOUT)
+    #
     # Add your own context handlers
     #
     # Stenotype::ContextHandlers.register Your::Custom::HandlerClass

data/lib/stenotype/configuration.rb

@@ -6,6 +6,7 @@ module Stenotype
   #
   # @example Configuring the library
   #   Stenotype.configure do |config|
+  #     config.enabled = true
   #     config.targets = [Target1.new, Target2.new]
   #     config.uuid_generator = SecureRandom
   #
@@ -25,6 +26,15 @@ module Stenotype
   module Configuration
     extend Spicerack::Configurable
 
+    # @!attribute graceful_error_handling
+    # @return {true, false} a flag for suppressing error raised withing the gem
+
+    # @!attribute logger
+    # @return {Logger} a logger with default severity methods to output gem level messages
+
+    # @!attribute enabled
+    # @return {true, false} a flag indicating whether event emission is enabled
+
     # @!attribute targets
     # @return {Array<#publish>} a list of targets responding to method [#publish]
 
@@ -60,9 +70,12 @@ module Stenotype
     # @return [true, false] A flag of whether ActiveJob ext is enabled
 
     configuration_options do
+      option :graceful_error_handling, default: true
+      option :enabled, default: true
       option :targets, default: []
       option :dispatcher, default: Stenotype::Dispatcher
       option :uuid_generator, default: SecureRandom
+      option :logger
 
       nested :google_cloud do
         option :credentials, default: nil
@@ -79,6 +92,27 @@ module Stenotype
 
     module_function
 
+    #
+    # @example With default logger
+    #   Stenotype.configure do |config|
+    #     # config.logger = nil # logger not set manually
+    #   end
+    #   Stenotype.config.logger #=> `Logger.new(STDOUT)` instance
+    #
+    # @example With custom logger
+    #   Stenotype.configure do |config|
+    #     config.logger = custom_logger_instance
+    #   end
+    #   Stenotype.config.logger #=> custom_logger_instance
+    #
+    # @return [{Logger, CustomLogger}] a logger object. Logger.new(STDOUT) by
+    #   default if another is not set during configuration
+    #
+    def logger
+      return config.logger if config.logger
+      config.logger || Logger.new(STDOUT)
+    end
+
     #
     # @example When at least one target is present
     #   Stenotype.configure do |config|
@@ -93,6 +127,8 @@ module Stenotype
     # @raise {Stenotype::NoTargetsSpecifiedError} in case no targets are configured
     # @return {Array<#publish>} An array of targets implementing method [#publish]
     #
+    # @todo THIS NEVER GETS CALLED, needs a fix
+    #
     def targets
       return config.targets unless config.targets.empty?
 

data/lib/stenotype/event.rb

@@ -18,9 +18,21 @@ module Stenotype
     # @return {Stenotype::Event} An instance of {Stenotype::Event}
     #
     def self.emit!(name, attributes = {}, eval_context: {}, dispatcher: Stenotype.config.dispatcher)
-      event = new(name, attributes, eval_context: eval_context, dispatcher: dispatcher)
-      event.emit!
-      event
+      return unless Stenotype.config.enabled
+
+      begin
+        event = new(name, attributes, eval_context: eval_context, dispatcher: dispatcher)
+        event.emit!
+        event
+      rescue => error
+        #
+        # @todo This is a temporary solution to enable conditional logger fetching
+        #   needs a fix to use default Spicerack::Configuration functionality
+        #
+        Stenotype::Configuration.logger.error(error)
+
+        raise unless Stenotype.config.graceful_error_handling
+      end
     end
 
     attr_reader :name, :attributes, :eval_context, :dispatcher
@@ -52,7 +64,19 @@ module Stenotype
     #   event.emit! #=> Publishes the event to targets
     #
     def emit!
-      dispatcher.publish(self)
+      return unless Stenotype.config.enabled
+
+      begin
+        dispatcher.publish(self)
+      rescue => error
+        #
+        # @todo This is a temporary solution to enable conditional logger fetching
+        #   needs a fix to use default Spicerack::Configuration functionality
+        #
+        Stenotype::Configuration.logger.error(error)
+
+        raise unless Stenotype.config.graceful_error_handling
+      end
     end
   end
 end

data/lib/stenotype/version.rb

@@ -2,6 +2,6 @@
 
 module Stenotype
   # :nodoc:
-  VERSION = "0.1.2"
+  VERSION = "0.1.4"
   # :nodoc:
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stenotype
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - Roman Kapitonov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-11 00:00:00.000000000 Z
+date: 2020-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport