stenotype 0.1.13 → 0.1.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d0d5893588a564349ac48d4b860e5864d31ee18e204f56bfcb67efa7ca8150cb
-  data.tar.gz: a11a18ddb4ea62a9c0dfa3a6bb4ab81eb7a7005f7c4f7e3ac9b8206863b25f72
+  metadata.gz: a42b44b8b7a3c69fe9bfc179aaef8e274c67ace47d3609edda524358ff59d6ec
+  data.tar.gz: 58b3185d8391de7473da08bc9ffb4de8ca9ca37e8d948b8c7d26b14d3bd1a928
 SHA512:
-  metadata.gz: bbf72969fe6b256240563688230bc904bc5f24ae27339f970c74922736f1166d2513e2d4b8cfa6fd0411f5f262c62f7e9864f92644cdf449f9c9b37b94540ef8
-  data.tar.gz: d210cf4081e569e3e2ebeb6fc2a302394ffdd9e7145088f67166ea4060a51441a76ad92b5209d08fbf0463efc680f7c4fae5c2c0cadaeaa7a4263c43b0347ed4
+  metadata.gz: 3578df8a2213ad6bfff4c8be71f902fba440ceed806e7b2cd4a3a7c443194e5abf11cc624f1466768f1a845e6a3696e108879e1524de5be553435b5fc443cc37
+  data.tar.gz: 2550d63b410c460b663562d453b97659dc014fde50cd250949530e210d9dc80cd251964858f90aa331de3303fb3b534f1601444c1208fdd7739ec309bb505e3c

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+### 0.1.15
+* Updates readme.
+
+### 0.1.14
+* Allows autodiscovering of the context handlers and Rails development env autoreload.
+
 ### 0.1.13
 * Removes obsolete rails pre-configuration for the sake of default configuration settings
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    stenotype (0.1.12)
+    stenotype (0.1.15)
       activesupport (>= 5.0.0)
       google-cloud-pubsub (~> 1.0.0)
       spicery (>= 0.22.0, < 1.0)
@@ -102,7 +102,7 @@ GEM
       googleauth (~> 0.9)
       grpc (~> 1.24)
       rly (~> 0.2.3)
-    google-protobuf (3.11.4)
+    google-protobuf (3.11.4-universal-darwin)
     googleapis-common-protos (1.3.9)
       google-protobuf (~> 3.0)
       googleapis-common-protos-types (~> 1.0)
@@ -116,7 +116,7 @@ GEM
       multi_json (~> 1.11)
       os (>= 0.9, < 2.0)
       signet (~> 0.12)
-    grpc (1.27.0)
+    grpc (1.27.0-universal-darwin)
       google-protobuf (~> 3.11)
       googleapis-common-protos-types (~> 1.0)
     grpc-google-iam-v1 (0.6.9)

data/README.md

@@ -105,7 +105,7 @@ Controls whether the hook `auto_initialize!` is run for each adapter. If set to
 
 #### Configuring context handlers
 
-Each event is emitted in a context which might be an ActionController instance or an ActiveJob instance or potentially any other place. Context handlers are implemented as plain ruby classes, so before using them you must register them. By default a plain `Class` handler is registered when not used with any framework. In case Ruby on Rails is used, then there are two additional context handlers for `ActionController` and `ActiveJob` instances.
+Each event is emitted in a context which might be an ActionController instance or an ActiveJob instance or potentially any other place. Context handlers are implemented as plain ruby classes. By default a plain `Class` handler is registered when not used with any framework. In case Ruby on Rails is used, then there are two additional context handlers for `ActionController` and `ActiveJob` instances. Registration of the context handler happens upon inheriting from `Stenotype::ContextHandlers::Base`.
 
 ### Emitting Events
 
@@ -118,7 +118,7 @@ Stenotype::Event.emit!(
 )
 ```
 
-The event is then going to be passed to a dispatcher responsible for sending the evens to targets. Note that a context handler must be registered before using it. See [Custom context handlers](#custom-context-handlers) for more details.
+The event is then going to be passed to a dispatcher responsible for sending the evens to targets. See [Custom context handlers](#custom-context-handlers) for more details.
 
 #### ActionController
 
@@ -201,8 +201,6 @@ class CustomHandler < Stenotype::ContextHandlers::Base
   end
 end
 
-Stenotype::ContextHandlers.register CustomHandler
-
 # Event is being emitted twice. First time with default options.
 # Second time with overriden method name and eval_context.
 class PlainRubyClass < BaseClass
@@ -251,7 +249,7 @@ Stenotype.config.targets.push(CustomAdapter.new)
 
 #### Custom context handlers
 
-A list of context handlers might be extended by defining a class inheriting from `Stenotype::ContextHandlers::Base` and registering a new context handler. Event handler must have a `self.handler_name` in order to use it during context serialization. Also custom handler must implement method `#as_json`:
+A list of context handlers might be extended by defining a class inheriting from `Stenotype::ContextHandlers::Base`. Event handler must have a `self.handler_name` in order to use it during context serialization. Also custom handler must implement method `#as_json`:
 ```ruby
 class CustomHandler < Stenotype::ContextHandlers::Base
   self.handler_name = :custom_handler_name
@@ -275,10 +273,8 @@ class CustomHandler < Stenotype::ContextHandlers::Base
 end
 ```
 
-After defining a new context handler you must register it as follows:
-```ruby
-Stenotype::ContextHandlers.register CustomHandler
-```
+You do not have to manually register the context handler since it happens upon inheriting from `Stenotype::ContextHandlers::Base`
+
 
 ## Development
 

data/lib/stenotype.rb

@@ -32,6 +32,4 @@ module Stenotype
   delegates_to_configuration
 end
 
-Stenotype::ContextHandlers.register(Stenotype::ContextHandlers::Klass)
-
 require "stenotype/railtie" if defined?(Rails)

data/lib/stenotype/context_handlers.rb

@@ -1,9 +1,5 @@
 # frozen_string_literal: true
 
-require "stenotype/context_handlers/base"
-require "stenotype/context_handlers/rails/controller"
-require "stenotype/context_handlers/rails/active_job"
-require "stenotype/context_handlers/klass"
 require "stenotype/context_handlers/collection"
 
 module Stenotype
@@ -14,6 +10,7 @@ module Stenotype
   module ContextHandlers
     class << self
       attr_writer :known
+
       #
       # @return {Array<#publish>} A list of handlers implementing [#publish]
       #
@@ -28,3 +25,9 @@ module Stenotype
     end
   end
 end
+
+require "stenotype/context_handlers/base"
+require "stenotype/context_handlers/rails/controller"
+require "stenotype/context_handlers/rails/active_job"
+require "stenotype/context_handlers/klass"
+

data/lib/stenotype/context_handlers/base.rb

@@ -24,6 +24,10 @@ module Stenotype
     class Base
       attr_reader :context, :options
 
+      def self.inherited(subklass)
+        ContextHandlers.register(subklass)
+      end
+
       #
       # @param context {Object} A context where the event was emitted
       # @param options {Hash} A hash of additional options
@@ -58,6 +62,15 @@ module Stenotype
           @handler_name || raise(NotImplementedError, "Please, specify the handler_name of #{self}")
         end
       end
+
+      private
+
+      #
+      # A rails specific workaround to make reloading in dev env happy
+      #
+      def self.before_remove_const
+        Stenotype::ContextHandlers.known.unregister(self)
+      end
     end
   end
 end

data/lib/stenotype/version.rb

@@ -2,6 +2,6 @@
 
 module Stenotype
   # :nodoc:
-  VERSION = "0.1.13"
+  VERSION = "0.1.15"
   # :nodoc:
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stenotype
 version: !ruby/object:Gem::Version
-  version: 0.1.13
+  version: 0.1.15
 platform: ruby
 authors:
 - Roman Kapitonov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-05 00:00:00.000000000 Z
+date: 2020-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport