stenotype 0.1.0 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 714f7d5fce3afe07cb1f49653fc44410ca0570086a310c8aead9b88229981f08
-  data.tar.gz: 7f69e3448a22a9d1094dbab6a783e206ac36a5c22c1eb10db3f25180ce07d167
+  metadata.gz: d77ba29ea50a26b7a8592149629d6a58368b56a615246ebaff36ade2a8a9f3a7
+  data.tar.gz: d519ef0ee071b97d6ff3dbed088f06b18826adbfdadcddaf89019c230b1aecb3
 SHA512:
-  metadata.gz: 5ac72dfb39d13e86dfee3617cbef85e06dec175541af1ec681298b74c970f0ef54f4e48a434b305778bc49c219604b6d3eeab3d444a9a670a4db8873ad7a0c94
-  data.tar.gz: 399afa50ff49b2b6b163a07345064193f3bdc18cb20719adb55b1ace92b6cafcedf3128f430df033e597836524138bce7f82134671378f113786e7e1f3948fe3
+  metadata.gz: b59b094ef4c1379a2771f78fef83639040fedc62a0a2d2fb9209c50060e2c96856ea26fd28090a5788a06c4d97942b78c954df1eba861d4fbdd07d675f91d60e
+  data.tar.gz: dfca37efc78a9063d8a239e27b2ed36a6b2ae981c330b072a2b3b43b46c9359323f4fd1ac790096c1458a38e860519ceb972f84ef9f9e12f2788b77d96c11709

data/.gitignore

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

data/.rubocop.yml

@@ -2,5 +2,6 @@ inherit_gem:
   spicerack-styleguide:
     - rubocop.yml
 
-AllCops:
-  TargetRubyVersion: 2.6
+# Disabled since ApplicationJob is only defined in a real application
+Rails/ApplicationJob:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,43 @@
+# Changelog
+
+*Release Date*: 2020/01/13
+
+### 0.1.5 2020/01/13
+* In case `graceful_error_handling` is set to off raise a generic `Stenotype::Error` on any exception in order to intercept a single error type in the client code.
+* Adds an `at_exit` hook to flush the async message queue when using the library in async mode.
+
+### 0.1.4 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`
+
+### 0.1.3: 2020/01/10
+* 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
+
+* Changes the interface of how event is emitted. Now you must pass `event_name`, `attributes` and optional `eval_context`. Note that `additional_options` are eliminated
+* Makes StdoutAdapter more informative by adding a special line for every entry in the log.
+* Fixes Rails initializer not working after switching to Configurable from Spicerack.
+
+### 0.1.1: 2019/11/25
+
+* Moves all error into top level namespace definition file.
+* Introduces a root class for all gem specific errors.
+* Renames ObjectExt to an Eventable concern.
+* Changes the aggressive extension of Object, forces a user to include the Eventable module only where necessary.
+* Moves all rails specific logic into a Railtie, which is required only if in Rails universe.
+* Adds more examples to yard documentation of the classes.
+* Adds a TODO list based on the feedback.
+* Grinds a huge GoogleCloud adapter method into smaller ones.
+* Add two 'on/off' configuration options for Rails specific components.
+* Switches to using rails specific delegate method where possible (in rails components extensions).
+
+### 0.1.0: The Big Bang
+
+* Rails controller and active job adapters
+* Generic event method
+* Handlers for GCP Pub/Sub and STDOUT
+* Initial commit
+
+
+

data/Gemfile

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 group :development, :test do
   gem "rspice"

data/Gemfile.lock

@@ -1,50 +1,51 @@
 PATH
   remote: .
   specs:
-    stenotype (0.1.0)
+    stenotype (0.1.6)
       activesupport (>= 5.0.0)
       google-cloud-pubsub (~> 1.0.0)
+      spicery (>= 0.19.0, < 1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (5.2.3)
-      actionpack (= 5.2.3)
+    actioncable (5.2.4)
+      actionpack (= 5.2.4)
       nio4r (~> 2.0)
       websocket-driver (>= 0.6.1)
-    actionmailer (5.2.3)
-      actionpack (= 5.2.3)
-      actionview (= 5.2.3)
-      activejob (= 5.2.3)
+    actionmailer (5.2.4)
+      actionpack (= 5.2.4)
+      actionview (= 5.2.4)
+      activejob (= 5.2.4)
       mail (~> 2.5, >= 2.5.4)
       rails-dom-testing (~> 2.0)
-    actionpack (5.2.3)
-      actionview (= 5.2.3)
-      activesupport (= 5.2.3)
+    actionpack (5.2.4)
+      actionview (= 5.2.4)
+      activesupport (= 5.2.4)
       rack (~> 2.0)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (5.2.3)
-      activesupport (= 5.2.3)
+    actionview (5.2.4)
+      activesupport (= 5.2.4)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.0.3)
-    activejob (5.2.3)
-      activesupport (= 5.2.3)
+    activejob (5.2.4)
+      activesupport (= 5.2.4)
       globalid (>= 0.3.6)
-    activemodel (5.2.3)
-      activesupport (= 5.2.3)
-    activerecord (5.2.3)
-      activemodel (= 5.2.3)
-      activesupport (= 5.2.3)
+    activemodel (5.2.4)
+      activesupport (= 5.2.4)
+    activerecord (5.2.4)
+      activemodel (= 5.2.4)
+      activesupport (= 5.2.4)
       arel (>= 9.0)
-    activestorage (5.2.3)
-      actionpack (= 5.2.3)
-      activerecord (= 5.2.3)
+    activestorage (5.2.4)
+      actionpack (= 5.2.4)
+      activerecord (= 5.2.4)
       marcel (~> 0.3.1)
-    activesupport (5.2.3)
+    activesupport (5.2.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
@@ -52,17 +53,29 @@ GEM
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
     arel (9.0.0)
+    around_the_world (0.19.2)
+      activesupport (>= 5.2.1)
     ast (2.4.0)
     builder (3.2.3)
     coderay (1.1.2)
+    collectible (0.19.2)
+      activesupport (>= 5.2.1)
+      short_circu_it (= 0.19.2)
+      tablesalt (= 0.19.2)
     concurrent-ruby (1.1.5)
+    conjunction (0.19.2)
+      activesupport (>= 5.2.1)
     crass (1.0.5)
     diff-lcs (1.3)
     docile (1.3.2)
     erubi (1.9.0)
+    facet (0.19.2)
+      activesupport (>= 5.2.1)
+      short_circu_it (= 0.19.2)
+      tablesalt (= 0.19.2)
     faker (1.9.6)
       i18n (>= 0.7)
-    faraday (0.17.0)
+    faraday (0.17.1)
       multipart-post (>= 1.2, < 3)
     github-markup (3.0.4)
     globalid (0.4.2)
@@ -83,7 +96,7 @@ GEM
       googleauth (~> 0.9)
       grpc (~> 1.24)
       rly (~> 0.2.3)
-    google-protobuf (3.10.1-universal-darwin)
+    google-protobuf (3.11.1-universal-darwin)
     googleapis-common-protos (1.3.9)
       google-protobuf (~> 3.0)
       googleapis-common-protos-types (~> 1.0)
@@ -108,87 +121,102 @@ GEM
     jaro_winkler (1.5.4)
     json (2.2.0)
     jwt (2.2.1)
-    loofah (2.3.1)
+    loofah (2.4.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     mail (2.7.1)
       mini_mime (>= 0.1.1)
     marcel (0.3.3)
       mimemagic (~> 0.3.2)
-    memoist (0.16.0)
+    memoist (0.16.2)
     method_source (0.9.2)
     mimemagic (0.3.3)
     mini_mime (1.0.2)
     mini_portile2 (2.4.0)
-    minitest (5.12.2)
+    minitest (5.13.0)
     multi_json (1.14.1)
     multipart-post (2.1.1)
     nio4r (2.5.2)
-    nokogiri (1.10.4)
+    nokogiri (1.10.7)
       mini_portile2 (~> 2.4.0)
     os (1.0.1)
-    parallel (1.18.0)
+    parallel (1.19.1)
     parser (2.6.5.0)
       ast (~> 2.4.0)
     pry (0.12.2)
       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.3)
-      actioncable (= 5.2.3)
-      actionmailer (= 5.2.3)
-      actionpack (= 5.2.3)
-      actionview (= 5.2.3)
-      activejob (= 5.2.3)
-      activemodel (= 5.2.3)
-      activerecord (= 5.2.3)
-      activestorage (= 5.2.3)
-      activesupport (= 5.2.3)
+    rails (5.2.4)
+      actioncable (= 5.2.4)
+      actionmailer (= 5.2.4)
+      actionpack (= 5.2.4)
+      actionview (= 5.2.4)
+      activejob (= 5.2.4)
+      activemodel (= 5.2.4)
+      activerecord (= 5.2.4)
+      activestorage (= 5.2.4)
+      activesupport (= 5.2.4)
       bundler (>= 1.3.0)
-      railties (= 5.2.3)
+      railties (= 5.2.4)
       sprockets-rails (>= 2.0.0)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
     rails-html-sanitizer (1.3.0)
       loofah (~> 2.3)
-    railties (5.2.3)
-      actionpack (= 5.2.3)
-      activesupport (= 5.2.3)
+    railties (5.2.4)
+      actionpack (= 5.2.4)
+      activesupport (= 5.2.4)
       method_source
       rake (>= 0.8.7)
       thor (>= 0.19.0, < 2.0)
     rainbow (3.0.0)
     rake (10.5.0)
     redcarpet (3.5.0)
+    redis (4.1.3)
+    redis_hash (0.19.2)
+      activesupport (>= 5.2.1)
+      redis (>= 3.0)
+      tablesalt (= 0.19.2)
     rly (0.2.3)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.2)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.1)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.2)
-    rspice (0.14.2)
-      faker (~> 1.8)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+    rspice (0.19.2)
+      faker (>= 1.8, < 2.0)
       rspec (~> 3.0)
-    rubocop (0.76.0)
+    rubocop (0.74.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
       parser (>= 2.6)
       rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 1.7)
+    rubocop-performance (1.4.1)
+      rubocop (>= 0.71.0)
+    rubocop-rails (2.3.0)
+      rack (>= 1.1)
+      rubocop (>= 0.72.0)
+    rubocop-rspec (1.35.0)
+      rubocop (>= 0.60.0)
     ruby-progressbar (1.10.1)
+    short_circu_it (0.19.2)
+      activesupport (>= 5.2.1)
+      around_the_world (= 0.19.2)
     signet (0.12.0)
       addressable (~> 2.3)
       faraday (~> 0.9)
@@ -199,6 +227,22 @@ GEM
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
+    spicerack (0.19.2)
+      around_the_world (= 0.19.2)
+      redis_hash (= 0.19.2)
+      short_circu_it (= 0.19.2)
+      tablesalt (= 0.19.2)
+      technologic (= 0.19.2)
+    spicerack-styleguide (0.19.2)
+      rubocop (= 0.74)
+      rubocop-performance (= 1.4.1)
+      rubocop-rails (= 2.3.0)
+      rubocop-rspec (= 1.35.0)
+    spicery (0.19.2)
+      collectible (= 0.19.2)
+      conjunction (= 0.19.2)
+      facet (= 0.19.2)
+      spicerack (= 0.19.2)
     sprockets (4.0.0)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
@@ -206,6 +250,13 @@ GEM
       actionpack (>= 4.0)
       activesupport (>= 4.0)
       sprockets (>= 3.0.0)
+    tablesalt (0.19.2)
+      activemodel (>= 5.2.1)
+      activesupport (>= 5.2.1)
+    technologic (0.19.2)
+      activesupport (>= 5.2.1)
+      railties (>= 5.2.1)
+      short_circu_it (= 0.19.2)
     thor (0.20.3)
     thread_safe (0.3.6)
     timecop (0.9.1)
@@ -229,8 +280,8 @@ DEPENDENCIES
   redcarpet (~> 3.5)
   rspec (~> 3.0)
   rspice
-  rubocop (~> 0.76)
   simplecov (~> 0.17)
+  spicerack-styleguide (>= 0.19.0, < 1.0)
   stenotype!
   timecop (~> 0.9)
   yard (~> 0.9)

data/README.md

@@ -7,7 +7,7 @@ This gem is a tool providing extensions to several rails components in order to
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'Stenotype'
+gem "Stenotype"
 ```
 
 And then execute:
@@ -25,24 +25,47 @@ 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.gc_project_id  = 'google_cloud_project_id'
-  config.gc_credentials = 'path_to_key_json'
-  config.gc_topic       = 'google_cloud_topic'
-  config.gc_mode        = :async # either :sync or :async
+  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"
+    gc_config.credentials = "path_to_key_json"
+    gc_config.topic       = "google_cloud_topic"
+    gc_config.async       = true # either true or false
+  end
+
+  config.rails do |rails_config|
+    rails_config.enable_action_controller_ext = true
+    rails_config.enable_active_job_ext        = true
+  end
 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.
@@ -51,21 +74,29 @@ An object that must implement method `#uuid`. Used when an event is emitted to g
 
 Dispatcher used to dispatch the event. A dispatcher must implement method `#publish(even, serializer: Stenotype::EventSerializer)`. By default `Stenotype::EventSerializer` is used, which is responsible for collecting the data from the event and evaluation context.
 
-#### config.gc_project_id
+#### config.google_cloud.project_id
 
 Google cloud project ID. Please refer to Google Cloud management console to get one.
 
-#### config.gc_credentials
+#### config.google_cloud.credentials
 
 Google cloud credentials. Might be obtained from Google Cloud management console.
 
-#### config.gc_topic
+#### config.google_cloud.topic
 
 Google Cloud topic used for publishing the events.
 
-#### config.gc_mode
+#### config.google_cloud.async
+
+Google Cloud publish mode. The mode is either sync or async. When in `sync` mode the event will be published in the same thread (which might influence performance). For `async` mode the event will be put into a pull which is going to be flushed after a threshold is met.
+
+#### config.rails.enable_action_controller_ext
+
+Allows to enable/disable Rails ActionController extension
+
+#### config.rails.enable_active_job_ext
 
-Google Cloud publish mode. Two options are available: `:sync, :async`. When in `sync` mode the event will be published in the same thread (which might influence performance). For `async` mode the event will be put into a pull which is going to be flushed after a threshold is met.
+Allows to enable/disable Rails ActiveJob extension
 
 #### Configuring context handlers
 
@@ -76,8 +107,8 @@ Each event is emitted in a context which might be an ActionController instance o
 Emitting an event is as simple as:
 ```ruby
 Stenotype::Event.emit!(
-    data,
-    options: additional_options,
+    "Event Name",
+    { attr1: :value1, attr2: :value2 },
     eval_context: { name_of_registered_context_handler: context_object }
 )
 ```
@@ -150,7 +181,7 @@ class BaseClass
   attr_reader :local_state
 
   def initialize
-    @local_state = 'some state'
+    @local_state = "some state"
   end
 end
 
@@ -172,9 +203,9 @@ Stenotype::ContextHandlers.register CustomHandler
 class PlainRubyClass < BaseClass
   def some_method(data)
     event_data = collect_some_data_as_a_hash
-    emit_event(event_data) # method name will be `some_method`, eval_context: { klass: self }
+    emit_event("event_name", event_data) # method name will be `some_method`, eval_context: { klass: self }
     other_event_data = do_something_else
-    emit_event(other_event_data, method: :custom_method_name, eval_context: { overriden_handler: self })
+    emit_event("other_event_name", other_event_data, method: :custom_method_name, eval_context: { overriden_handler: self })
   end
 end
 ```