lamian 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c6851ffad052c2a8937a913f880a1b6a5424c218
-  data.tar.gz: 2f3d5a8e3c67f2583d6778394f077cdfece11378
+  metadata.gz: 5fed5c60bd57fa0cd1e33f57ee3ffebd8009ee7c
+  data.tar.gz: 6c6324fa43333c990e1562e0a8cb2e63f7871496
 SHA512:
-  metadata.gz: 2310ee71cae10bdca125a2832002bf62ad4cd98f154525afe2b3f2eba43526eb0c4ac9d09df484b23ae5d89d6e1dfdd8d40d77a8cc216fcd196b0e03a5c7aa3f
-  data.tar.gz: '08b05982d5c0d01fd1491de1255111defa75b9cd7c188c288e8472d7123d9ed4ad8e714f34e01f47329ede890050f5ddb8369f8f7e36364cb150e4446c163aa8'
+  metadata.gz: e3b733bccc6a50fadefe5eac089eead5fa764a3dff4b3363049f5ad773d9f970a19b5e5e0395741ad3cd5bf8c6a7f6b01d583c9fa6d987fb4dce68c019c0034e
+  data.tar.gz: 6e966db934eee4fafe40ffb69c155dafb8b9f3d6ad15d53346b12b4c26a149ab1751d6bb23cfd2fd6317d05f81e3d787f965209f18bd0388771965307e8305f4

data/lib/lamian.rb

@@ -10,6 +10,8 @@ module Lamian
   autoload :Logger, "lamian/logger"
   autoload :LoggerExtension, "lamian/logger_extension"
   autoload :Middleware, "lamian/middleware"
+  autoload :RavenContextExtension, "lamian/raven_context_extension"
+  autoload :SidekiqRavenMiddleware, "lamian/sidekiq_raven_middleware"
 
   require "lamian/engine"
 

data/lib/lamian/engine.rb

@@ -1,20 +1,18 @@
 # frozen_string_literal: true
 
 require "rails"
-require "exception_notification"
-require "exception_notification/rails"
 
 module Lamian
-  # Rails engine, which injects middleware and appends
-  # lamian views to rails library.
-  # Lamian views are used in exception_notifier to provide
-  # request_log section
+  # This engine is automatically loaded by Rails
+  # @see https://edgeguides.rubyonrails.org/engines.html Rails::Engine docs
   class Engine < ::Rails::Engine
-    config.app_middleware.insert_before(
-      ExceptionNotification::Rack,
-      ::Lamian::Middleware,
-    )
-
+    # Lamian views are used in exception_notifier to provide request_log section
     paths["app/views"] << "lib/lamian/rails_views"
+
+    initializer "lamian.use_rack_middleware" do |app|
+      # :nocov:
+      app.config.middleware.unshift(Lamian::Middleware)
+      # :nocov:
+    end
   end
 end

data/lib/lamian/logger.rb

@@ -7,12 +7,6 @@ module Lamian
   # Provides thread-local loggers to catch teed messages from
   # regular loggers.
   # Uses :__lamian_logger thread variable
-  # @attr level [Int]
-  #   current log level, implicitly set to zero
-  # @attr logdevs [Array(StringIO)]
-  #   stack of log devices used to store logs
-  # @attr formatter [Logger::Formatter]
-  #   formatter, inherited from Lamian.config
   class Logger < ::Logger
     # Provides access to logger bound to curent thread
     # @return [Lamian::Logger] current logger
@@ -23,22 +17,27 @@ module Lamian
     def initialize
       self.level = 0
       self.logdevs = []
-      self.formatter = Lamian.config.formatter
     end
 
     # @see Lamian.run
     # Collects logs sent inside block
     def run
-      push_logdev(StringIO.new)
+      logdevs.push(StringIO.new)
+
       yield
     ensure
-      pop_logdev
+      logdevs.pop
     end
 
     # Part of Logger api, entry point for all logs
     # extened to run on each log device in stack
     def add(*args, &block)
-      each_logdev { super(*args, &block) }
+      @formatter = Lamian.config.formatter
+
+      logdevs.each do |logdev|
+        @logdev = logdev
+        super
+      end
     end
 
     # @see Lamian.dump
@@ -56,7 +55,13 @@ module Lamian
 
     private
 
-    attr_accessor :level, :logdevs, :formatter
+    # @return [Int]
+    #   current log level, implicitly set to zero
+    attr_accessor :level
+
+    # @return [Array(StringIO)]
+    #   stack of log devices used to store logs
+    attr_accessor :logdevs
 
     # Formats string using given format
     # @todo create `formatters` interface to allow real format selection
@@ -71,26 +76,5 @@ module Lamian
       return unless string
       string.gsub!(/\[\d{1,2}m/, "")
     end
-
-    # Pushes new logdev in the start of #run call
-    # @param logdev [StringIO] new StringIO
-    def push_logdev(logdev)
-      logdevs << logdev
-    end
-
-    # Pops logdev in the end of #run call
-    # @return [StringIO] logdev
-    def pop_logdev
-      logdevs.pop
-    end
-
-    # Runs specific block with all logdevs in stack to
-    # populate them all
-    def each_logdev
-      logdevs.each do |logdev|
-        @logdev = logdev
-        yield
-      end
-    end
   end
 end

data/lib/lamian/middleware.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Lamian
-  # Provides rack middleware, which allows to colelct request logs
+  # Provides rack middleware, which allows to collect request logs
   # @attr app [Proc] stored application
   class Middleware
     # @param app [Proc] stored application

data/lib/lamian/raven_context_extension.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+# A patch for Raven::Context class
+module Lamian::RavenContextExtension
+  # Adds current lamian log to the extra part of all raven events generated inside Lamian.run block
+  # @see https://www.rubydoc.info/gems/sentry-raven/0.9.2/Raven/Context#extra-instance_method
+  def extra
+    log = Lamian.dump(format: :txt)
+    return super unless log
+    extra = super || {}
+    extra.merge(lamian_log: log)
+  end
+end

data/lib/lamian/sidekiq_raven_middleware.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+# A sidekiq middleware
+class Lamian::SidekiqRavenMiddleware
+  # Adds current lamian log to the extra part of raven events generated inside sidekiq jobs
+  def call(*)
+    Lamian.run do
+      begin
+        yield
+      rescue Exception # rubocop:disable Lint/RescueException
+        Raven.extra_context(lamian_log: Lamian.dump(format: :txt))
+        raise
+      end
+    end
+  end
+end

data/lib/lamian/version.rb

@@ -13,5 +13,5 @@ module Lamian
   # According to this, it is enought to specify '~> a.b'
   # if private API was not used and to specify '~> a.b.c' if it was
 
-  VERSION = "1.0.1"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lamian
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - JelF
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-02 00:00:00.000000000 Z
+date: 2018-12-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -24,20 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.2'
-- !ruby/object:Gem::Dependency
-  name: exception_notification
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -164,6 +150,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: sentry-raven
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.7.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.7.4
 description: Add logs to your error messages, using exception_notifier or smth like
   it
 email:
@@ -180,8 +180,10 @@ files:
 - lib/lamian/middleware.rb
 - lib/lamian/rails_views/exception_notifier/_request_log.html.erb
 - lib/lamian/rails_views/exception_notifier/_request_log.text.erb
+- lib/lamian/raven_context_extension.rb
+- lib/lamian/sidekiq_raven_middleware.rb
 - lib/lamian/version.rb
-homepage: https://github.com/JelF/lamian
+homepage: https://github.com/umbrellio/lamian
 licenses: []
 metadata: {}
 post_install_message: 
@@ -200,7 +202,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.5.2.3
 signing_key: 
 specification_version: 4
 summary: Add logs to your error messages