stenotype 0.1.0 → 0.1.6

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

@@ -29,16 +29,15 @@ module Stenotype
         #     end
         #   end
         #
-        # rubocop:disable Metrics/MethodLength
         #
         def trackable_job!
           proxy = const_get(:JobExt)
           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
@@ -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.6"
   # :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.6
 platform: ruby
 authors:
 - Roman Kapitonov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-21 00:00:00.000000000 Z
+date: 2020-01-17 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,11 +259,15 @@ 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
 - lib/stenotype/adapters/google_cloud.rb
 - lib/stenotype/adapters/stdout_adapter.rb
+- lib/stenotype/at_exit.rb
 - lib/stenotype/configuration.rb
 - lib/stenotype/context_handlers.rb
 - lib/stenotype/context_handlers/base.rb
@@ -225,12 +276,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 +306,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.

data/lib/stenotype/exceptions.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-module Stenotype
-  #
-  # A namespace for holding library-level exceptions.
-  #
-  module Exceptions
-    #
-    # This exception is being raised in case an unsupported mode
-    # for Google Cloud is specified.
-    #
-    class GoogleCloudUnsupportedMode < StandardError; end
-
-    #
-    # This exception is being raised upon unsuccessful publishing of an event.
-    #
-    class MessageNotPublished < StandardError; end
-
-    #
-    # This exception is being raised in case no targets are
-    # specified {Stenotype::Configuration}.
-    #
-    class NoTargetsSpecified < StandardError; end
-
-    #
-    # This exception is being raised upon using a context handler which
-    # has never been registered in known handlers in {Stenotype::ContextHandlers::Collection}.
-    #
-    class UnknownHandler < StandardError; end
-  end
-end

data/lib/stenotype/frameworks/object_ext.rb

@@ -1,145 +0,0 @@
-# frozen_string_literal: true
-
-module Stenotype
-  #
-  # A namespace containing extensions of various frameworks.
-  # For example Rails components could be extended
-  #
-  module Frameworks
-    #
-    # An extension for a plain Ruby class in order to track invocation of
-    # instance methods.
-    #
-    module ObjectExt
-      #
-      # Class methods for `Object` to be extended by
-      #
-      ClassMethodsExtension = Class.new(Module)
-      #
-      # Instance methods to be included into `Object` ancestors chain
-      #
-      InstanceMethodsExtension = Class.new(Module)
-
-      attr_reader :instance_mod,
-                  :class_mod
-
-      # @!visibility private
-      def self.included(klass)
-        @instance_mod = InstanceMethodsExtension.new
-        @class_mod = ClassMethodsExtension.new
-
-        build_instance_methods
-        build_class_methods
-
-        klass.const_set(:InstanceProxy, Module.new)
-        klass.const_set(:ClassProxy, Module.new)
-
-        klass.send(:include, instance_mod)
-        klass.extend(class_mod)
-
-        super
-      end
-
-      #
-      # @!method emit_event(data = {}, method: caller_locations.first.label, eval_context: nil)
-      #   A method injected into all instances of Object
-      # @!scope instance
-      # @param data {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
-      #
-
-      #
-      # @!method emit_event_before(*methods)
-      #   A method injected into all instances of Object
-      # @!scope instance
-      # @param methods {Array<Symbol>} A list of method before which an event will be emitted
-      #
-
-      #
-      # @!method emit_klass_event_before(*class_methods)
-      #   A class method injected into all subclasses of [Object]
-      # @!scope class
-      # @param class_method {Array<Symbol>} A list of class method before which
-      #   an event will be emitted
-      #
-
-      #
-      # rubocop:disable Metrics/MethodLength
-      # Adds two methods: [#emit_event] and [#emit_event_before] to every object
-      #   inherited from [Object]
-      #
-      def build_instance_methods
-        instance_mod.class_eval <<-RUBY, __FILE__, __LINE__ + 1
-          def emit_event(data = {}, method: caller_locations.first.label, eval_context: nil)
-            Stenotype::Event.emit!(
-              {
-                type: 'class_instance',
-                **data,
-              },
-              options: {
-                class: self.class.name,
-                method: method.to_sym
-              },
-              eval_context: (eval_context || { klass: self })
-            )
-          end
-
-          def emit_event_before(*methods)
-            proxy = const_get(:InstanceProxy)
-
-            methods.each do |method|
-              proxy.module_eval do
-                define_method(method) do |*args, **rest_args, &block|
-                  Stenotype::Event.emit!(
-                    { type: 'class_instance' },
-                    options: {
-                      class: self.class.name,
-                      method: __method__
-                    },
-                    eval_context: { klass: self }
-                  )
-                  super(*args, **rest_args, &block)
-                end
-              end
-            end
-
-            send(:prepend, proxy)
-          end
-        RUBY
-      end
-
-      #
-      # Adds class method [#emit_klass_event_before] to every class
-      #   inherited from [Object]
-      #
-      def build_class_methods
-        class_mod.class_eval <<-RUBY, __FILE__, __LINE__ + 1
-          def emit_klass_event_before(*class_methods)
-            proxy = const_get(:ClassProxy)
-
-            class_methods.each do |method|
-              proxy.module_eval do
-                define_method(method) do |*args, **rest_args, &block|
-                  Stenotype::Event.emit!(
-                    { type: 'class' },
-                    options: {
-                      class: self.name,
-                      method: __method__
-                    },
-                    eval_context: { klass: self }
-                  )
-                  super(*args, **rest_args, &block)
-                end
-              end
-
-              singleton_class.send(:prepend, proxy)
-            end
-          end
-        RUBY
-      end
-      # rubocop:enable Metrics/MethodLength
-    end
-  end
-end