stenotype 0.1.0 → 0.1.1

data/lib/stenotype/event_serializer.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-require 'securerandom'
 
 module Stenotype
   #
@@ -9,6 +8,14 @@ module Stenotype
   class EventSerializer
     attr_reader :event, :uuid_generator
 
+    #
+    # @example Serializing an event with default UUID generator
+    #   event = Stenotype::Event.new(data, attributes, eval_context)
+    #   serializer = Stenotype::EventSerializer.new(event)
+    #
+    # @example Serializing an event with custom UUID generator
+    #   event = Stenotype::Event.new(data, attributes, eval_context)
+    #   serializer = Stenotype::EventSerializer.new(event, uuid_generator: CustomUUIDGen)
     #
     # @param event {Stenotype::Event}
     # @param uuid_generator {#uuid} an object responding to [#uuid]
@@ -18,6 +25,18 @@ module Stenotype
       @uuid_generator = uuid_generator
     end
 
+    #
+    # @example Serializing an event with default uuid generator (SecureRandom)
+    #   event = Stenotype::Event.new(data, attributes, eval_context)
+    #   serializer = Stenotype::EventSerializer.new(event)
+    #   serializer.serialize #=> A hash with event.data, event.options,
+    #                        # default_options and eval_context_options
+    #
+    # @example Serializing an event with custom uuid generator
+    #   event = Stenotype::Event.new(data, attributes, eval_context)
+    #   serializer = Stenotype::EventSerializer.new(event, uuid_generator: CustomUUIDGen)
+    #   serializer.serialize #=> A hash with event.data, event.options,
+    #                        # default_options and eval_context_options
     #
     # @return {Hash} A hash representation of the event and its context
     #
@@ -26,7 +45,7 @@ module Stenotype
         **event_data,
         **event_options,
         **default_options,
-        **eval_context_options
+        **eval_context_options,
       }
     end
 
@@ -45,16 +64,17 @@ module Stenotype
     end
 
     def eval_context_options
-      eval_context.map do |context_name, context|
+      context_attributes = eval_context.map do |context_name, context|
         handler = Stenotype::ContextHandlers.known.choose(handler_name: context_name)
         handler.new(context).as_json
-      end.reduce(:merge!) || {}
+      end
+      context_attributes.reduce(:merge!) || {}
     end
 
     def default_options
       {
         timestamp: Time.now.utc,
-        uuid: uuid_generator.uuid
+        uuid: uuid_generator.uuid,
       }
     end
   end

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

@@ -3,6 +3,10 @@
 require "active_support/concern"
 
 module Stenotype
+  #
+  # A namespace containing extensions of various frameworks.
+  # For example Rails components could be extended
+  #
   module Frameworks
     module Rails
       #
@@ -12,11 +16,13 @@ module Stenotype
       module ActionControllerExtension
         extend ActiveSupport::Concern
 
+        private
+
         #
         # Emits and event with given data
         # @param data {Hash} Data to be sent to targets
         #
-        def record_freshly_event(data)
+        def _record_freshly_event(data)
           Stenotype::Event.emit!(data, options: {}, eval_context: { controller: self })
         end
 
@@ -28,12 +34,19 @@ module Stenotype
           # Adds a before_action to each action from the passed list. A before action
           # is emitting a {Stenotype::Event}. Please note that in case track_view is
           # used several times, it will keep track of the actions which emit events.
-          # Each time a new track_view is called it will find a symmetric difference
-          # of two sets: set of 'used' actions and a set passed to `track_view`.
           #
-          # @example
+          # @note Each time a new track_view is called it will find a symmetric difference
+          #   of two sets: set of already tracked actions and a set passed to `track_view`.
+          #
+          # @example Tracking multiple actions with track_view
+          #   Stenotype.configure do |config|
+          #     config.enable_action_controller_extension = true
+          #     config.enable_active_job_extension = true
+          #   end
+          #
           #   class MyController < ActionController::Base
-          #     track_view :index, :show
+          #     track_view :index, :show # Emits an event upon calling index and show actions,
+          #                              # but does not trigger an event on create
           #
           #     def index
           #       # do_something
@@ -59,36 +72,36 @@ module Stenotype
             return if delta.empty?
 
             before_action only: delta do
-              record_freshly_event(type: 'view')
+              _record_freshly_event(type: "view")
             end
 
             _tracked_actions.merge(delta)
           end
 
-          # :nodoc:
-          def _tracked_actions
-            @_tracked_actions ||= Set.new
-          end
-
-          # Note this action will only define a symmetric difference of
-          # the covered with events actions and the ones not used yet.
+          #
+          # @note This action will only define a symmetric difference of
+          # the tracked actions and the ones not tracked yet.
           # @see #track_view
           #
-          # @example
-          #   class MyController < ActionController::Base
-          #     track_all_views
+          # @example Emitting an event before all actions in controller
+          #   class UsersController < ApplicationController
+          #     track_all_views # Emits an event before all actions in a controller
           #
           #     def index
-          #       # do_something
+          #       # do something
           #     end
           #
           #     def show
           #       # do something
           #     end
+          #
+          #     def create
+          #       # do something
+          #     end
           #   end
           #
           def track_all_views
-            actions = self.action_methods
+            actions = action_methods
 
             # A symmetric difference of two sets.
             # This prevents accidental duplicating of events
@@ -97,12 +110,21 @@ module Stenotype
             return if delta.empty?
 
             before_action only: delta.to_a do
-              record_freshly_event(type: "view")
+              _record_freshly_event(type: "view")
             end
 
             # merge is a mutating op
             _tracked_actions.merge(delta)
           end
+
+          private
+
+          #
+          # @return {Set<Symbol>} a set of tracked actions
+          #
+          def _tracked_actions
+            @_tracked_actions ||= Set.new
+          end
         end
       end
     end

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

@@ -29,7 +29,6 @@ module Stenotype
         #     end
         #   end
         #
-        # rubocop:disable Metrics/MethodLength
         #
         def trackable_job!
           proxy = const_get(:JobExt)
@@ -37,8 +36,8 @@ module Stenotype
             define_method(:perform) do |*args, **rest_args, &block|
               Stenotype::Event.emit!(
                 { type: "active_job" },
-                options: {},
-                eval_context: { active_job: self }
+                { options: {},
+                  eval_context: { active_job: self }},
               )
               super(*args, **rest_args, &block)
             end
@@ -48,9 +47,8 @@ module Stenotype
           # super() can be chained down the ancestors
           # without changing existing ActiveJob interface
           #
-          send(:prepend, proxy)
+          public_send(:prepend, proxy)
         end
-        # rubocop:enable Metrics/MethodLength
       end
     end
   end

data/lib/stenotype/railtie.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require "stenotype/frameworks/rails/action_controller"
+require "stenotype/frameworks/rails/active_job"
+
+module Stenotype
+  #
+  # A Railtie allowing to extend Rails component with
+  #   Stenotype extensions for emitting event in various Rails components.
+  #
+  class Railtie < ::Rails::Railtie
+    Stenotype.configure do |config|
+      config.rails do |rails_config|
+        rails_config.enable_action_controller_ext = true
+        rails_config.enable_active_job_ext = true
+      end
+    end
+
+    config.stenotype = Stenotype.config
+
+    if config.stenotype.rails.enable_action_controller_ext
+      ActiveSupport.on_load(:action_controller) do
+        Stenotype::ContextHandlers.register Stenotype::ContextHandlers::Rails::Controller
+        include Stenotype::Frameworks::Rails::ActionControllerExtension
+      end
+    end
+
+    # @todo: consider using `::ActiveJob::Base.around_perform`
+    #        or `::ActiveJob::Base.around_enqueue`
+    if config.stenotype.rails.enable_active_job_ext
+      ActiveSupport.on_load(:active_job) do
+        Stenotype::ContextHandlers.register Stenotype::ContextHandlers::Rails::ActiveJob
+        extend Stenotype::Frameworks::Rails::ActiveJobExtension
+      end
+    end
+  end
+end

data/lib/stenotype/version.rb

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

data/stenotype.gemspec

@@ -6,42 +6,46 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "stenotype/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = 'stenotype'
+  spec.name          = "stenotype"
   spec.version       = Stenotype::VERSION
   spec.authors       = ["Roman Kapitonov"]
   spec.email         = ["roman.kapitonov@freshly.com"]
 
-  spec.summary       = 'Gem for emitting events and sending them to an external system.'
-  spec.description   = 'Pretty much it'
-  spec.homepage      = 'https://github.com/Freshly/stenotype'
-  spec.license       = 'MIT'
+  spec.summary       = "Gem for emitting events and sending them to an external system."
+  spec.description   = "Pretty much it"
+  spec.homepage      = "https://github.com/Freshly/stenotype"
+  spec.license       = "MIT"
 
-  spec.metadata['homepage_uri'] = spec.homepage
-  spec.metadata['source_code_uri'] = 'https://github.com/Freshly/stenotype'
-  spec.metadata['changelog_uri'] = 'https://github.com/Freshly/stenotype/CHANGELOG.md'
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/Freshly/stenotype"
+  spec.metadata["changelog_uri"] = "https://github.com/Freshly/stenotype/CHANGELOG.md"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = 'exe'
+  spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
-
-  spec.add_dependency 'activesupport', '>= 5.0.0'
-  spec.add_dependency 'google-cloud-pubsub', '~> 1.0.0'
-
-  spec.add_development_dependency 'bundler', '~> 2.0'
-  spec.add_development_dependency 'github-markup', '~> 3.0'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'redcarpet', '~> 3.5'
-  spec.add_development_dependency 'yard', '~> 0.9'
-
-  spec.add_development_dependency 'pry', '~> 0.12'
-  spec.add_development_dependency 'rails', '~> 5.2.3'
-  spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rubocop', '~> 0.76'
-  spec.add_development_dependency 'simplecov', '~> 0.17'
-  spec.add_development_dependency 'timecop', '~> 0.9'
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport", ">= 5.0.0"
+  spec.add_dependency "google-cloud-pubsub", "~> 1.0.0"
+
+  spec.add_runtime_dependency "spicery", ">= 0.19.0", "< 1.0"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "github-markup", "~> 3.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "redcarpet", "~> 3.5"
+  spec.add_development_dependency "yard", "~> 0.9"
+
+  spec.add_development_dependency "rspice", ">= 0.19.0", "< 1.0"
+  spec.add_development_dependency "spicerack-styleguide", ">= 0.19.0", "< 1.0"
+
+  spec.add_development_dependency "pry", "~> 0.12"
+  spec.add_development_dependency "rails", "~> 5.2.3"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "simplecov", "~> 0.17"
+  spec.add_development_dependency "timecop", "~> 0.9"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stenotype
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Roman Kapitonov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-21 00:00:00.000000000 Z
+date: 2019-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -38,6 +38,26 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: spicery
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.19.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.19.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -109,61 +129,87 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.9'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rspice
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: 0.19.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: 0.19.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: spicerack-styleguide
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.19.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.19.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.2.3
+        version: '0.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.2.3
+        version: '0.12'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 5.2.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 5.2.3
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.76'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.76'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -204,6 +250,7 @@ files:
 - ".rubocop.yml"
 - ".travis.yml"
 - ".yardopts"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -212,6 +259,9 @@ files:
 - TODO.md
 - bin/console
 - bin/setup
+- lib/generators/USAGE
+- lib/generators/stenotype/initializer/initializer_generator.rb
+- lib/generators/stenotype/initializer/templates/initializer.rb.erb
 - lib/stenotype.rb
 - lib/stenotype/adapters.rb
 - lib/stenotype/adapters/base.rb
@@ -225,12 +275,12 @@ files:
 - lib/stenotype/context_handlers/rails/active_job.rb
 - lib/stenotype/context_handlers/rails/controller.rb
 - lib/stenotype/dispatcher.rb
+- lib/stenotype/emitter.rb
 - lib/stenotype/event.rb
 - lib/stenotype/event_serializer.rb
-- lib/stenotype/exceptions.rb
-- lib/stenotype/frameworks/object_ext.rb
 - lib/stenotype/frameworks/rails/action_controller.rb
 - lib/stenotype/frameworks/rails/active_job.rb
+- lib/stenotype/railtie.rb
 - lib/stenotype/version.rb
 - stenotype.gemspec
 homepage: https://github.com/Freshly/stenotype
@@ -255,7 +305,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Gem for emitting events and sending them to an external system.