transaction_logger 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 30f8e8e54923dfdc287aeb35da8c13dd4ab6b49c
-  data.tar.gz: fcd753fbf378de1fd0e5c3b2d12592c34bfdbf67
+  metadata.gz: 2e0b34abcfe7bb0e2aab8a11e94fa283e3cd4c8a
+  data.tar.gz: 2b5525a2f7b0d65d0acaf2deb86765075509483e
 SHA512:
-  metadata.gz: 8396dc16368ead80fd6e778acdc4ddf3d1072645ff08699a0caf651c0c58732a3e643ef8a0cb54b1c52ccfb276c1544c9730630f43a5a9e4cccbed31793f49a5
-  data.tar.gz: c514903ed15b3bfcc772c352b4edc18227c3c5ab4499d98fba7ab69db1125bc41afe8040d8f8f174e69ed9c2b8e92a4dfd9d2940d892528f782dd258d219c7a7
+  metadata.gz: 946306e6960761db73217526eba5262b97817fb4a902f07e7d475730f8ef9f813367a1435ac9b09f3434654a0cae3f10e511871c8c446442d6f70174cc427e66
+  data.tar.gz: 1028997dbb986ff41f157d9676d5b086005f45723b9fa488fd15f53a29225bcb80509d8ee3380bc3c23793fc25d851bbf86102bed6edb717b90b2c668c3d0ad4

data/README.md

@@ -86,10 +86,19 @@ class YourClass
 end
 ```
 
-By default, the transaction will be named *YourClass:some_method*, and have no context. You can easily change this by adding the following symbols to an additional options parameter:
+By default, the transaction will be named *YourClass:some_method*. You can easily change this by adding the name to the options params:
 
 ```ruby
-add_transaction_log :some_method, {name: "Custom Name", context: {}}
+add_transaction_log :some_method, {name: "Custom Name" }
+```
+
+You can set a *context* to the options that is pushed to the logger. It can either anything supporting `.to_hash` or a `Proc`.
+The proc will be evaluated in the scope of the traced method.
+
+```ruby
+add_transaction_log :some_method, {context: "Custom Context" }
+add_transaction_log :some_method, {context: { key: "value context" } }
+add_transaction_log :some_method, {context: -> { request.params } }
 ```
 
 ### Example
@@ -108,7 +117,7 @@ class ExampleClass
     logger.info "Success"
   end
 
-  add_transaction_log :some_method, {context: {some_id: 12}}
+  add_transaction_log :some_method, { context: { some_id: 12 } }
 end
 ```
 
@@ -143,6 +152,10 @@ The expected output is:
 
 ## Version History
 
+### v1.1.0
+- Fixed issues [#32](https://github.com/blinkist/transaction_logger/issues/32) for missing context
+- Added support for Proc as context [#34](https://github.com/blinkist/transaction_logger/issues/34)
+
 ### v1.0.1
 - Fixed issues with undefined trap_logger method
 - Hid module methods other than add_transaction_log

data/lib/transaction_logger/version.rb

@@ -1,3 +1,3 @@
 module TransactionLogger
-  VERSION = "1.0.2"
+  VERSION = "1.0.3"
 end

data/lib/transaction_logger.rb

@@ -28,17 +28,28 @@ module TransactionLogger
     def add_transaction_log(method, options={})
       old_method = instance_method method
 
-      options = {}
       options[:prefix] = TransactionLogger::Configure.instance_variable_get :@prefix
       options[:logger] = TransactionLogger::Configure.instance_variable_get :@logger
       options[:level_threshold] = TransactionLogger::Configure.instance_variable_get :@level_threshold
 
       define_method method do
+        context = options[:context]
+
+        if context.is_a? Proc
+          begin
+            context = instance_exec(&context)
+          rescue => e
+            context = "TransactionLogger: couldn't evaluate context: #{e.message}"
+            # Write an error to the untrapped logger
+            logger.error context
+            logger.error e.backtrace.take(10).join "\n"
+          end
+        end
+
         TransactionManager.start options, lambda  { |transaction|
           transaction.name = options[:name]
           transaction.name ||= "#{old_method.bind(self).owner}#{method.inspect}"
-          transaction.context = options[:context]
-          transaction.context ||= {}
+          transaction.context = context || {}
 
           # Check for a logger on the instance
           if methods.include? :logger

data/spec/transaction_logger/transaction_spec.rb

@@ -0,0 +1,54 @@
+require "spec_helper"
+require "logger"
+
+describe TransactionLogger::Transaction do
+  let (:test_lmbda) {
+    lambda do |_t|
+    end
+  }
+
+  subject {
+    TransactionLogger::Transaction.new(
+      { prefix: nil, logger: Logger.new(STDOUT), level_threshold: nil }, test_lmbda)
+  }
+
+  describe "#run" do
+    context "when no exception is raised" do
+      let (:test_lmbda) {
+        lambda  do |_t|
+          "result"
+        end
+      }
+
+      let (:result) { subject.run }
+
+      it "returns lmda" do
+        expect(result).to eq "result"
+      end
+    end
+
+    context "when an exception is raised" do
+      let (:test_lmbda) {
+        lambda  do |_t|
+          fail "test error"
+        end
+      }
+
+      let (:child) {
+        TransactionLogger::Transaction.new(
+          { prefix: nil, logger: Logger.new(STDOUT), level_threshold: nil }, test_lmbda)
+      }
+
+      let (:result) { subject.run }
+
+      it "raises an exception" do
+        expect { result }.to raise_error "test error"
+      end
+
+      it "calls failure" do
+        expect(subject).to receive(:failure)
+        result
+      end
+    end
+  end
+end

data/spec/transaction_logger_configure_spec.rb

@@ -0,0 +1,43 @@
+require "spec_helper"
+require "logger"
+
+describe TransactionLogger::Configure do
+  let (:test_lmbda) {
+    lambda do |_t|
+    end
+  }
+
+  describe ".log_prefix" do
+    subject {
+      TransactionLogger::Transaction.new(
+        { prefix: nil, logger: Logger.new(STDOUT), level_threshold: nil }, test_lmbda)
+    }
+
+    context "when there is no prefix" do
+      it "does not change the output" do
+        expect(subject.to_hash).to include("name" => "undefined")
+      end
+    end
+
+    context "when a prefix is defined" do
+      let (:prefix) { "bta_" }
+
+      before :example do
+        described_class.log_prefix = prefix
+      end
+
+      subject {
+        TransactionLogger::Transaction.new(
+          { prefix: described_class.log_prefix, logger: Logger.new(STDOUT), level_threshold: nil }, test_lmbda)
+      }
+
+      after :example do
+        described_class.log_prefix = ""
+      end
+
+      it "adds the prefix to every key" do
+        expect(subject.to_hash).to include("bta_name" => "undefined")
+      end
+    end
+  end
+end

data/spec/transaction_logger_spec.rb

@@ -74,6 +74,72 @@ describe TransactionLogger do
     end
   end
 
+  context "logging options" do
+    let(:logger_stub) { double(Logger) }
+
+    let(:test_logger) {
+      Class.new do
+        include TransactionLogger
+
+        def do_something
+          raise "Error"
+        end
+
+        def logger
+          Logger.new STDOUT
+        end
+
+        add_transaction_log :do_something, name: "my name", context: "my context"
+      end
+    }
+
+    it "sets transaction name and context" do
+      TransactionLogger::Configure.logger = logger_stub
+
+      expect(logger_stub).to receive(:error) do |msg|
+        expect(msg["context"]).to eq "my context"
+        expect(msg["name"]).to eq "my name"
+      end
+
+      test = test_logger.new
+      expect { test.do_something }.to raise_error "Error"
+    end
+  end
+
+  context "Dynamic context" do
+    let(:instance_logger_lambda) {
+      Class.new do
+        include TransactionLogger
+
+        def do_something
+          logger.info "TEST"
+        end
+
+        def dynamic_context
+          "Dynamic Context"
+        end
+
+        def logger
+          Logger.new STDOUT
+        end
+
+        add_transaction_log :do_something, context: -> { dynamic_context }
+      end
+    }
+
+    it "executes the lambda bound to the logged instance" do
+      test = instance_logger_lambda.new
+      expect(test).to receive(:dynamic_context).and_call_original
+      test.do_something
+    end
+
+    it "doesn't fail the method execution if the lambda eval fails" do
+      test = instance_logger_lambda.new
+      allow(test).to receive(:dynamic_context).and_raise "Some error"
+      expect { test.do_something }.to_not raise_error
+    end
+  end
+
   subject {
     TransactionLogger::Transaction.new(
       { prefix: nil, logger: Logger.new(STDOUT), level_threshold: nil }, test_lmbda)
@@ -112,75 +178,4 @@ describe TransactionLogger do
       end
     }
   end
-
-  describe TransactionLogger::Configure do
-    describe ".log_prefix" do
-      context "when there is no prefix" do
-        it "does not change the output" do
-          expect(subject.to_hash).to include("name" => "undefined")
-        end
-      end
-
-      context "when a prefix is defined" do
-        let (:prefix) { "bta_" }
-
-        before :example do
-          described_class.log_prefix = prefix
-        end
-
-        subject {
-          TransactionLogger::Transaction.new(
-            { prefix: described_class.log_prefix, logger: Logger.new(STDOUT), level_threshold: nil }, test_lmbda)
-        }
-
-        after :example do
-          described_class.log_prefix = ""
-        end
-
-        it "adds the prefix to every key" do
-          expect(subject.to_hash).to include("bta_name" => "undefined")
-        end
-      end
-    end
-  end
-
-  describe "#run" do
-    context "when no exception is raised" do
-      let (:test_lmbda) {
-        lambda  do |_t|
-          "result"
-        end
-      }
-
-      let (:result) { subject.run }
-
-      it "returns lmda" do
-        expect(result).to eq "result"
-      end
-    end
-
-    context "when an exception is raised" do
-      let (:test_lmbda) {
-        lambda  do |_t|
-          fail "test error"
-        end
-      }
-
-      let (:child) {
-        TransactionLogger::Transaction.new(
-          { prefix: nil, logger: Logger.new(STDOUT), level_threshold: nil }, test_lmbda)
-      }
-
-      let (:result) { subject.run }
-
-      it "raises an exception" do
-        expect { result }.to raise_error "test error"
-      end
-
-      it "calls failure" do
-        expect(subject).to receive(:failure)
-        result
-      end
-    end
-  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: transaction_logger
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - John Donner
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-01 00:00:00.000000000 Z
+date: 2015-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -176,7 +176,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.3
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Contextual Business Transaction Logger for Ruby