stenotype 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cad5a62bd56d635becd56bf9bae4d6421879d29952473fd507ae60885ea4723e
-  data.tar.gz: 0b2d65ef6e1f9a84bd369d908f4133f3787156fcc5a6b46a194b4193fa735411
+  metadata.gz: 5b998a75c7aef576ca3040ad7cd7a07082fddc9cd937b57e3d3e84d807124aba
+  data.tar.gz: 29d5bc462c420c881eeeeca851146c74e8f6db1240de777d8e19ca0806274fdd
 SHA512:
-  metadata.gz: c025894e106d650dcfe1bab82cf878b89a561eaae8a7eb23246a8d01a34800460a17734f55da518602d504a554b41648f6039d3174b2747d093dba8fbfbb0f26
-  data.tar.gz: 790e1a50a3fabff8db4c62017a556532b8acf3f1df6a330b91dfafba0e1af1701335f8463688fb8d201b75420542fd6cbba054939d33cd80e400e87b07100ed3
+  metadata.gz: 71094a00ecce450e4e2edbbda1327cf2f794c52d5d64bd304b67ec5f2498e49020c0ed4f2a07bc9425d5df8929ebe2d809447ea4b52baca0eb6569af27fcf22a
+  data.tar.gz: 1874d642a66cc7a2771fd78e92a2dc3e7aaea9ea520055cc2b7abe5bb2f9bf51dce5989e1498352411d134a371ec8b546ded1e8cb8e3d75b7408eaa340d06cbd

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 *Release Date*: 2019/11/21
 
+### 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.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    stenotype (0.1.1)
+    stenotype (0.1.2)
       activesupport (>= 5.0.0)
       google-cloud-pubsub (~> 1.0.0)
       spicery (>= 0.19.0, < 1.0)
@@ -96,7 +96,7 @@ GEM
       googleauth (~> 0.9)
       grpc (~> 1.24)
       rly (~> 0.2.3)
-    google-protobuf (3.11.1)
+    google-protobuf (3.11.1-universal-darwin)
     googleapis-common-protos (1.3.9)
       google-protobuf (~> 3.0)
       googleapis-common-protos-types (~> 1.0)
@@ -110,7 +110,7 @@ GEM
       multi_json (~> 1.11)
       os (>= 0.9, < 2.0)
       signet (~> 0.12)
-    grpc (1.25.0)
+    grpc (1.25.0-universal-darwin)
       google-protobuf (~> 3.8)
       googleapis-common-protos-types (~> 1.0)
     grpc-google-iam-v1 (0.6.9)

data/README.md

@@ -32,10 +32,18 @@ Stenotype.configure do |config|
 
   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.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
 ```
 
@@ -51,21 +59,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 +92,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 }
 )
 ```
@@ -172,9 +188,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
 ```

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

@@ -1,65 +1,71 @@
 # frozen_string_literal: true
 
 Rails.application.configure do
-  #
-  # Stenotype allows you to emit events which are then being published to a list of
-  # targets. Currently two targets are provided by default: Google Cloud Pub Sub and
-  # STDOUT for debug purposes.
-  #
-  # There is also a rails integration module which defines a handy DSL
-  # for triggering events in various Rails components. ActionController and
-  # ActiveJob are supported at the time of writing.
-  #
-  # Both extensions for Rails are enabled by default, but there are config options
-  # to control their presence.
-  # config.stenotype.rails do |rails_modules|
-  #   rails_modules.enable_action_controller_ext = true
-  #   rails_modules.enable_active_job_ext = true
-  # end
-  #
-  #
-  # To make publishing possible one must specify a list of targets. You could use
-  # StdoutAdapter for debug purposes before switching to a production publisher.
-  # By default the list of targets is empty and you'll get an error saying
-  # that no targets are specified.
-  #
-  # A config option is available for setting up the targets:
-  #
-  # config.stenotype.targets = [Stenotype::Adapters::StdoutAdapter.new]
-  #
-  # Or using Google Cloud:
-  #
-  # config.stenotype.targets = [Stenotype::Adapters::GoogleCloud.new]
-  #
-  # Or both:
-  #
-  # config.stenotype.targets = [
-  #   Stenotype::Adapters::StdoutAdapter.new,
-  #   Stenotype::Adapters::GoogleCloud.new
-  # ]
-  #
-  # To be able to use Google Cloud one has to specify Google Cloud credentials:
-  #
-  # config.stenotype.google_cloud do |gc_config|
-  #   gc_config.credentials = "SPECIFY YOUR CREDENTIALS" # path/to/key.json
-  #   gc_config.project_id = "SPECIFY YOUR PROJECT ID"
-  #   gc_config.topic = "SPECIFY YOUR TOPIC"
-  #   gc_config.mode = :async
-  # end
-  #
-  # Each event is shipped with a UUID generated with SecureRandom by default.
-  # This might be changed by using a corresponding config option. Note that
-  # uuid_generator expects method #uuid to be implemented
-  #
-  # config.stenotype.uuid_generator = SecureRandom
-  #
-  # In rare cases you might want to get control over how the event is being dispatched.
-  # Dispatcher must implement instance method #publish.
-  # Which dispatcher to use is controlled by the following config option:
-  #
-  # config.stenotype.dispatcher = Stenotype::Dispatcher
-  #
+  Stenotype.configure do |config|
+    #
+    # Stenotype allows you to emit events which are then being published to a list of
+    # targets. Currently two targets are provided by default: Google Cloud Pub Sub and
+    # STDOUT for debug purposes.
+    #
+    # There is also a rails integration module which defines a handy DSL
+    # for triggering events in various Rails components. ActionController and
+    # ActiveJob are supported at the time of writing.
+    #
+    # Both extensions for Rails are enabled by default, but there are config options
+    # to control their presence.
+    # config.rails do |rails_modules|
+    #   rails_modules.enable_action_controller_ext = true
+    #   rails_modules.enable_active_job_ext = true
+    # end
+    #
+    #
+    # To make publishing possible one must specify a list of targets. You could use
+    # StdoutAdapter for debug purposes before switching to a production publisher.
+    # By default the list of targets is empty and you'll get an error saying
+    # that no targets are specified.
+    #
+    # A config option is available for setting up the targets:
+    #
+    # config.targets = [Stenotype::Adapters::StdoutAdapter.new]
+    #
+    # Or using Google Cloud:
+    #
+    # config.targets = [Stenotype::Adapters::GoogleCloud.new]
+    #
+    # Or both:
+    #
+    # config.targets = [
+    #   Stenotype::Adapters::StdoutAdapter.new,
+    #   Stenotype::Adapters::GoogleCloud.new
+    # ]
+    #
+    # To be able to use Google Cloud one has to specify Google Cloud credentials:
+    #
+    # config.google_cloud do |gc_config|
+    #   gc_config.credentials = "SPECIFY YOUR CREDENTIALS" # path/to/key.json
+    #   gc_config.project_id = "SPECIFY YOUR PROJECT ID"
+    #   gc_config.topic = "SPECIFY YOUR TOPIC"
+    #   gc_config.async = true
+    # end
+    #
+    # Each event is shipped with a UUID generated with SecureRandom by default.
+    # This might be changed by using a corresponding config option. Note that
+    # uuid_generator expects method #uuid to be implemented
+    #
+    # config.uuid_generator = SecureRandom
+    #
+    # In rare cases you might want to get control over how the event is being dispatched.
+    # Dispatcher must implement instance method #publish.
+    # Which dispatcher to use is controlled by the following config option:
+    #
+    # config.dispatcher = Stenotype::Dispatcher
+    #
+    # Add your own context handlers
+    #
+    # Stenotype::ContextHandlers.register Your::Custom::HandlerClass
+    #
+  end
 end
 
 # For more usage instructions please refer to either README.md or yard documentation
-# in gem repository https://github.com/Freshly/stenotype
+# in gem repository https://github.com/Freshly/stenotype

data/lib/stenotype/adapters/base.rb

@@ -37,7 +37,7 @@ module Stenotype
       # @abstract
       # @raise [NotImplementedError] unless implemented in a subclass
       #
-      def publish(_event_data, **_additional_arguments)
+      def publish(_event_data, **_additional_attrs)
         raise NotImplementedError,
               "#{self.class.name} must implement method #publish"
       end

data/lib/stenotype/adapters/google_cloud.rb

@@ -48,22 +48,22 @@ module Stenotype
       #   # publishes to default CustomGCClient
       #   google_cloud_adapter.publish({ event: :data }, { additional: :data })
       #
-      def publish(event_data, **additional_arguments)
+      def publish(event_data, **additional_attrs)
         if config.async
-          publish_async(event_data, **additional_arguments)
+          publish_async(event_data, **additional_attrs)
         else
-          publish_sync(event_data, **additional_arguments)
+          publish_sync(event_data, **additional_attrs)
         end
       end
 
       private
 
-      def publish_sync(event_data, **additional_arguments)
-        topic.publish(event_data, additional_arguments)
+      def publish_sync(event_data, **additional_attrs)
+        topic.publish(event_data, additional_attrs)
       end
 
-      def publish_async(event_data, **additional_arguments)
-        topic.publish_async(event_data, additional_arguments) do |result|
+      def publish_async(event_data, **additional_attrs)
+        topic.publish_async(event_data, additional_attrs) do |result|
           raise Stenotype::MessageNotPublishedError unless result.succeeded?
         end
       end

data/lib/stenotype/adapters/stdout_adapter.rb

@@ -31,8 +31,13 @@ module Stenotype
       #  adapter = Stenotype::Adapters::StdoutAdapter.new(client: STDERR)
       #  adapter.publish({ event: :data }, { additional: :data })
       #
-      def publish(event_data, **additional_arguments)
-        client.info(**event_data, **additional_arguments)
+      def publish(event_data, **additional_attrs)
+        client.info("[Stenotype::Event] emitted with the following attributes") do
+          {
+            **event_data,
+            **additional_attrs,
+          }
+        end
       end
 
       private

data/lib/stenotype/emitter.rb

@@ -33,11 +33,12 @@ module Stenotype
     end
 
     #
-    # @!method emit_event(data = {}, method: caller_locations.first.label, eval_context: nil)
+    # @!method emit_event(name, attributes = {}, method: caller_locations.first.label, eval_context: nil)
     #   A method injected into target class to manually track events
     #   @!scope instance
-    #   @param data {Hash} Data to be sent to the targets
-    #   @param method {String} An optional method name
+    #   @param name {[String, Symbol]} Event name.
+    #   @param attributes {Hash} Data to be sent to the targets.
+    #   @param method {String} An optional method name.
     #   @param eval_context {Hash} A hash linking object to context handler
     #   @return {Stenotype::Event} An instance of emitted event
     #   @example Usage of emit_event
@@ -91,15 +92,14 @@ module Stenotype
     #
     def self.build_instance_methods(instance_mod)
       instance_mod.module_eval <<-RUBY, __FILE__, __LINE__ + 1
-        def emit_event(data = {}, method: caller_locations.first.label, eval_context: nil)
+        def emit_event(event_name, attributes = {}, method: caller_locations.first.label, eval_context: nil)
           Stenotype::Event.emit!(
+            event_name,
             {
-              type: "class_instance",
-              **data,
-            },
-            options: {
+              type: "instance_method",
               class: self.class.name,
-              method: method.to_sym
+              method: method.to_sym,
+              **attributes,
             },
             eval_context: (eval_context || { klass: self })
           )
@@ -120,12 +120,14 @@ module Stenotype
             proxy.module_eval do
               define_method(method) do |*args, **rest_args, &block|
                 Stenotype::Event.emit!(
-                  { type: "class_instance" },
-                  options: {
+                  # @todo How do we name such events?
+                  "instance_method",
+                  {
+                    type: "instance_method",
                     class: self.class.name,
-                    method: __method__
+                    method: __method__,
                   },
-                  eval_context: { klass: self }
+                  eval_context: { klass: self },
                 )
                 super(*args, **rest_args, &block)
               end
@@ -142,12 +144,14 @@ module Stenotype
             proxy.module_eval do
               define_method(method) do |*args, **rest_args, &block|
                 Stenotype::Event.emit!(
-                  { type: "class" },
-                  options: {
+                  # @todo How do we name such events?
+                  "class_method",
+                  {
+                    type: "class_method",
                     class: self.name,
-                    method: __method__
+                    method: __method__,
                   },
-                  eval_context: { klass: self }
+                  eval_context: { klass: self },
                 )
                 super(*args, **rest_args, &block)
               end

data/lib/stenotype/event.rb

@@ -11,19 +11,19 @@ module Stenotype
     # @example Emit an event using class method
     #   Stenotype::Event.emit!(data, options, eval_context)
     #
-    # @param data {Hash} Data to be published to the targets.
-    # @param options {Hash} A hash of additional options to be tracked.
-    # @param eval_context {Hash} A context having handler defined in {Stenotype::ContextHandlers}.
-    # @param dispatcher {#publish} A dispatcher object responding to [#publish]
+    # @param {[String, Symbol]} name Event name.
+    # @param {Hash} attributes Data to be published to the targets.
+    # @param {Hash} eval_context A context having handler defined in {Stenotype::ContextHandlers}.
+    # @param dispatcher {#publish} A dispatcher object responding to [#publish].
     # @return {Stenotype::Event} An instance of {Stenotype::Event}
     #
-    def self.emit!(data, options: {}, eval_context: {}, dispatcher: Stenotype.config.dispatcher)
-      event = new(data, options: options, eval_context: eval_context, dispatcher: dispatcher)
+    def self.emit!(name, attributes = {}, eval_context: {}, dispatcher: Stenotype.config.dispatcher)
+      event = new(name, attributes, eval_context: eval_context, dispatcher: dispatcher)
       event.emit!
       event
     end
 
-    attr_reader :data, :options, :eval_context, :dispatcher
+    attr_reader :name, :attributes, :eval_context, :dispatcher
 
     #
     # @example Create an event
@@ -31,15 +31,15 @@ module Stenotype
     # @example Create an event with custom dispatcher
     #   event = Stenotype::Event.new(data, options, eval_context, dispatcher: MyDispatcher.new)
     #
-    # @param {Hash} data Data to be published to the targets.
-    # @param {Hash} options A hash of additional options to be tracked.
+    # @param {[String, Symbol]} name Event name.
+    # @param {Hash} attributes Data to be published to the targets.
     # @param {Hash} eval_context A context having handler defined in {Stenotype::ContextHandlers}.
     # @param dispatcher {#publish} A dispatcher object responding to [#publish].
     # @return {Stenotype::Event} An instance of event
     #
-    def initialize(data, options: {}, eval_context: {}, dispatcher: Stenotype.config.dispatcher)
-      @data = data
-      @options = options
+    def initialize(name, attributes = {}, eval_context: {}, dispatcher: Stenotype.config.dispatcher)
+      @name = name
+      @attributes = attributes
       @eval_context = eval_context
       @dispatcher = dispatcher.new
     end
@@ -48,7 +48,7 @@ module Stenotype
     # Emits a {Stenotype::Event}.
     #
     # @example Emit an instance of event
-    #   event = Stenotype::Event.new(data, options, eval_context)
+    #   event = Stenotype::Event.new('events_name', { key: :value }, eval_context: { controller: ctrl })
     #   event.emit! #=> Publishes the event to targets
     #
     def emit!

data/lib/stenotype/event_serializer.rb

@@ -42,8 +42,8 @@ module Stenotype
     #
     def serialize
       {
-        **event_data,
-        **event_options,
+        name: event_name,
+        **event_attributes,
         **default_options,
         **eval_context_options,
       }
@@ -51,12 +51,12 @@ module Stenotype
 
     private
 
-    def event_data
-      event.data
+    def event_name
+      event.name
     end
 
-    def event_options
-      event.options
+    def event_attributes
+      event.attributes
     end
 
     def eval_context

data/lib/stenotype/frameworks/rails/action_controller.rb

@@ -20,10 +20,11 @@ module Stenotype
 
         #
         # Emits and event with given data
-        # @param data {Hash} Data to be sent to targets
+        # @param name {[String, Symbol]} Event name
+        # @todo What is really the name here?
         #
-        def _record_freshly_event(data)
-          Stenotype::Event.emit!(data, options: {}, eval_context: { controller: self })
+        def _record_freshly_event(name)
+          Stenotype::Event.emit!(name, { type: "controller_action" }, { eval_context: { controller: self }})
         end
 
         #
@@ -72,7 +73,7 @@ module Stenotype
             return if delta.empty?
 
             before_action only: delta do
-              _record_freshly_event(type: "view")
+              _record_freshly_event("view")
             end
 
             _tracked_actions.merge(delta)
@@ -110,7 +111,7 @@ module Stenotype
             return if delta.empty?
 
             before_action only: delta.to_a do
-              _record_freshly_event(type: "view")
+              _record_freshly_event("view")
             end
 
             # merge is a mutating op

data/lib/stenotype/frameworks/rails/active_job.rb

@@ -35,9 +35,9 @@ module Stenotype
           proxy.module_eval do
             define_method(:perform) do |*args, **rest_args, &block|
               Stenotype::Event.emit!(
+                "active_job_#{self.class.name}",
                 { type: "active_job" },
-                { options: {},
-                  eval_context: { active_job: self }},
+                { eval_context: { active_job: self }},
               )
               super(*args, **rest_args, &block)
             end

data/lib/stenotype/version.rb

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

metadata

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