technologic 0.3.1 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c488d3241dd9a49c25f589abeb1ad2881bbd49111b6e89bd4b591595723cc36
-  data.tar.gz: 97a061057d7d1be868593ae093084c89f17044fe07cfffc954b8a377cdc2cd27
+  metadata.gz: 4d1d248bef1496c9ff561e4c50643d464b9a76e02f089d4c54917a5ce9a22552
+  data.tar.gz: a3292dcbda07946d9c4b3c8d86fa8354c79ff8b347250c2b0edcdb0f6c1c6bf5
 SHA512:
-  metadata.gz: 9fdc6a17fe71ad4489fdf3a89bd50d88aa59469adcdc57a170362c7179a40952c542aded610e1590c4d0e1364632977beec491c02f8c7cf6f584139f08c4ce0c
-  data.tar.gz: 64e6e5a9262c53481c713a99bc28b7b57a3208bc8872cdbb7f683ea8b05d5e4810c2a862b0ea54ee570d0c7d033d3197eda90fe4939fe50463e8cee9ccb0af4d
+  metadata.gz: b5830d5eaee4562a7dfdb97a19e8d0b46fd2bfcc2c4c550b996f6051ce321fc540bf4abf7a54798379a02435a13c4d20b3fd2be5a910fe21dfdc4f7736fd4058
+  data.tar.gz: fb6c695b74b5bd4519ca20ea331c5b01158be4529d71d2d3b0b0bd0af648f981d7ac6273da3cf7a5517a60c989c3749e4d9d289737840503793fee99ea23e0fa

data/lib/technologic.rb

@@ -1,7 +1,77 @@
 # frozen_string_literal: true
 
+require "active_support"
+require "active_support/callbacks"
+require "active_support/inflector"
+require "active_support/core_ext/hash/keys"
+require "active_support/core_ext/module/delegation"
+require "active_support/core_ext/string/inflections"
+
+require "short_circu_it"
+
 require "technologic/version"
+require "technologic/event"
+require "technologic/subscriber/base"
+require "technologic/fatal_subscriber"
+require "technologic/error_subscriber"
+require "technologic/warn_subscriber"
+require "technologic/info_subscriber"
+require "technologic/debug_subscriber"
+require "technologic/logger"
+require "technologic/config_options"
+require "technologic/setup"
 
 module Technologic
-  # Your code goes here...
+  extend ActiveSupport::Concern
+
+  SEVERITIES = %i[debug info warn error fatal].freeze
+  EXCEPTION_SEVERITIES = %i[error fatal].freeze
+
+  included do
+    delegate :instrument, :surveil, to: :class
+    protected :instrument, :surveil
+
+    SEVERITIES.each do |severity|
+      delegate severity, to: :class
+      protected severity # rubocop:disable Style/AccessModifierDeclarations
+    end
+
+    EXCEPTION_SEVERITIES.each do |severity|
+      method_name = "#{severity}!"
+
+      delegate method_name, to: :class
+      protected method_name # rubocop:disable Style/AccessModifierDeclarations
+    end
+  end
+
+  class_methods do
+    def instrument(severity, event, **data, &block)
+      ActiveSupport::Notifications.instrument("#{event}.#{name}.#{severity}", data, &block).tap do
+        # If a block was defined, :instrument will return the value of the block.
+        # Otherwise, :instrument will return nil, since it didn't do anything.
+        # Returning true here allows us to do fun things like `info :subscription_created and return subscription`
+        return true unless block_given?
+      end
+    end
+
+    def surveil(event, severity: :info, **data, &block)
+      raise LocalJumpError unless block_given?
+
+      instrument(severity, "#{event}_started", **data)
+      instrument(severity, "#{event}_finished", &block)
+    end
+
+    SEVERITIES.each do |severity|
+      define_method(severity) { |event, **data, &block| instrument(severity, event, **data, &block) }
+    end
+
+    EXCEPTION_SEVERITIES.each do |severity|
+      define_method("#{severity}!") do |error_class = StandardError, message = nil, **data, &block|
+        instrument severity, error_class.name.demodulize, **data, &block
+        raise error_class, message
+      end
+    end
+  end
 end
+
+require "technologic/railtie" if defined?(Rails)

data/lib/technologic/config_options.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Technologic
+  class ConfigOptions
+    class_attribute :enabled, default: true
+
+    class_attribute :subscribe_to_fatal, default: true
+    class_attribute :subscribe_to_error, default: true
+    class_attribute :subscribe_to_warn, default: true
+    class_attribute :subscribe_to_info, default: true
+    class_attribute :subscribe_to_debug, default: true
+
+    class_attribute :log_fatal_events, default: true
+    class_attribute :log_error_events, default: true
+    class_attribute :log_warn_events, default: true
+    class_attribute :log_info_events, default: true
+    class_attribute :log_debug_events, default: true
+
+    class_attribute :include_in_classes, default: %w[ApplicationController]
+  end
+end

data/lib/technologic/debug_subscriber.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Technologic
+  class DebugSubscriber < Subscriber::Base; end
+end

data/lib/technologic/error_subscriber.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Technologic
+  class ErrorSubscriber < Subscriber::Base; end
+end

data/lib/technologic/event.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Technologic
+  class Event
+    include ShortCircuIt
+
+    attr_reader :name, :duration
+
+    def initialize(name, started, finished, payload)
+      @name = name
+      @duration = finished - started
+      @payload = payload
+    end
+
+    def data
+      {}.tap do |hash|
+        hash.merge!(@payload)
+        hash[:event] = name
+        hash[:duration] = duration if duration.round > 0
+      end
+    end
+    memoize :data
+  end
+end

data/lib/technologic/fatal_subscriber.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Technologic
+  class FatalSubscriber < Subscriber::Base; end
+end

data/lib/technologic/info_subscriber.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Technologic
+  class InfoSubscriber < Subscriber::Base; end
+end

data/lib/technologic/logger.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Technologic
+  class Logger
+    class << self
+      def log(severity, event)
+        return unless defined?(Rails)
+
+        Rails.logger.public_send(severity) do
+          event.data.transform_values { |value| format_value_for_log(value) }
+        end
+      end
+
+      def format_value_for_log(value)
+        # `#to_log_string` is idiomatic to Technologic and is the most explicit way to specify how an object is logged.
+        return value.to_log_string if value.respond_to?(:to_log_string)
+
+        return value if value.is_a?(Numeric)
+        return value.id if value.respond_to?(:id)
+        return value.map { |mappable_value| format_value_for_log(mappable_value) } if value.respond_to?(:map)
+
+        value.to_s
+      end
+    end
+  end
+end

data/lib/technologic/railtie.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "rails/railtie"
+
+module Technologic
+  class Railtie < Rails::Railtie
+    config.technologic = Technologic::ConfigOptions
+
+    config.after_initialize do |application|
+      Technologic::Setup.for(application) if application.config.technologic.enabled
+    end
+  end
+end

data/lib/technologic/setup.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Technologic
+  class Setup
+    class << self
+      def for(application)
+        technologic_config = application.config.technologic
+
+        setup_subscribers(technologic_config)
+        setup_loggers(technologic_config)
+        setup_includes(technologic_config)
+      end
+
+      private
+
+      def setup_subscribers(config)
+        ActiveSupport::Notifications.subscribe(%r{\.fatal$}, Technologic::FatalSubscriber) if config.subscribe_to_fatal
+        ActiveSupport::Notifications.subscribe(%r{\.error$}, Technologic::ErrorSubscriber) if config.subscribe_to_error
+        ActiveSupport::Notifications.subscribe(%r{\.warn$}, Technologic::WarnSubscriber) if config.subscribe_to_warn
+        ActiveSupport::Notifications.subscribe(%r{\.info$}, Technologic::InfoSubscriber) if config.subscribe_to_info
+        ActiveSupport::Notifications.subscribe(%r{\.debug$}, Technologic::DebugSubscriber) if config.subscribe_to_debug
+      end
+
+      def setup_loggers(config)
+        Technologic::FatalSubscriber.on_event { |e| Technologic::Logger.log(:fatal, e) } if config.log_fatal_events
+        Technologic::ErrorSubscriber.on_event { |e| Technologic::Logger.log(:error, e) } if config.log_error_events
+        Technologic::WarnSubscriber.on_event { |e| Technologic::Logger.log(:warn, e) } if config.log_warn_events
+        Technologic::InfoSubscriber.on_event { |e| Technologic::Logger.log(:info, e) } if config.log_info_events
+        Technologic::DebugSubscriber.on_event { |e| Technologic::Logger.log(:debug, e) } if config.log_debug_events
+      end
+
+      def setup_includes(config)
+        config.include_in_classes.each { |class_name| class_name.constantize.include(Technologic) }
+      end
+    end
+  end
+end

data/lib/technologic/subscriber/base.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative "core"
+require_relative "event_handling"
+
+module Technologic
+  module Subscriber
+    class Base
+      include Core
+      include EventHandling
+    end
+  end
+end

data/lib/technologic/subscriber/core.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Technologic
+  module Subscriber
+    module Core
+      extend ActiveSupport::Concern
+
+      class_methods do
+        def call(name, started, finished, _unique_id, payload)
+          trigger Technologic::Event.new(name.chomp(".#{severity}"), started, finished, payload)
+        end
+
+        def severity
+          @severity ||= name.demodulize.chomp("Subscriber").downcase.to_sym
+        end
+      end
+    end
+  end
+end

data/lib/technologic/subscriber/event_handling.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Technologic
+  module Subscriber
+    module EventHandling
+      extend ActiveSupport::Concern
+
+      included do
+        class_attribute :_event_handlers, instance_writer: false, default: []
+      end
+
+      class_methods do
+        def on_event(&block)
+          _event_handlers << block
+        end
+
+        def trigger(event)
+          _event_handlers.each { |handler| handler.call(event) }
+        end
+
+        def inherited(base)
+          base._event_handlers = _event_handlers.dup
+          super
+        end
+      end
+    end
+  end
+end

data/lib/technologic/version.rb

@@ -2,5 +2,5 @@
 
 module Technologic
   # This constant is managed by spicerack
-  VERSION = "0.3.1"
+  VERSION = "0.4.3"
 end

data/lib/technologic/warn_subscriber.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Technologic
+  class WarnSubscriber < Subscriber::Base; end
+end

metadata

@@ -1,15 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: technologic
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.3
 platform: ruby
 authors:
 - Eric Garside
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-04 00:00:00.000000000 Z
-dependencies: []
+date: 2018-10-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.1
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.1
+- !ruby/object:Gem::Dependency
+  name: short_circu_it
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.4.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.4.3
 description: An opinionated philosophy on logging for Ruby on Rails applications.
 email:
 - garside@gmail.com
@@ -20,7 +62,20 @@ files:
 - LICENSE.txt
 - README.md
 - lib/technologic.rb
+- lib/technologic/config_options.rb
+- lib/technologic/debug_subscriber.rb
+- lib/technologic/error_subscriber.rb
+- lib/technologic/event.rb
+- lib/technologic/fatal_subscriber.rb
+- lib/technologic/info_subscriber.rb
+- lib/technologic/logger.rb
+- lib/technologic/railtie.rb
+- lib/technologic/setup.rb
+- lib/technologic/subscriber/base.rb
+- lib/technologic/subscriber/core.rb
+- lib/technologic/subscriber/event_handling.rb
 - lib/technologic/version.rb
+- lib/technologic/warn_subscriber.rb
 homepage: https://www.freshly.com
 licenses:
 - MIT