transaction_logger 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9b596362707ab73c1c50f5acbabccf71f550bdeb
-  data.tar.gz: 8ae2171ebd12b0af053aa4c0c71cd06a25e7537d
+  metadata.gz: c85e18e15f0aa46051bdd6d5d6d827ca662fce6b
+  data.tar.gz: 65889439258e4082571f87310c90a035bf23229d
 SHA512:
-  metadata.gz: 9b61478fed4c1980b615c49ea2f1d4b8678bc3b9942878ab68b0895fd502dd4fddbcb819026512fa0ce3596ef0baea25a3088d4d03b5997fdb97d7c15d975a47
-  data.tar.gz: 7a51811366be8ad002c624130fe68de5e759edf9a8bbb696e5ca605be857be692602a6f7f5c1e0e1c084c5121c404d023f90c5f9cf312236c67551f9ad34eef7
+  metadata.gz: 7b02d897ef866380ce133cd11215f9c974907008aa9d072f549fb7a9652e7511e0b49e7b5326f334c58bd99831d67dc4f795181db8ac3b4ba786b98703a22659
+  data.tar.gz: 9010d7c2270809e8436b22334f7d36ed864fb7aba114ae51d30873ce3af799358bf80df6167466a440694915f1c4ff4481a8d1e8da88d63035487bb6597a6929

data/README.md

@@ -42,7 +42,7 @@ Configure the logger by calling TransactionLogger.logger, such as with Ruby's Lo
 
 ```ruby
 logger = Logger.new STDOUT # Ruby default logger setup
-TransactionLogger.logger = logger
+TransactionLogger::Configure.logger = logger
 ```
 
 Calling Transaction_Logger.logger with no parameter sets the logger to a new instance of Logger as shown above.
@@ -52,7 +52,7 @@ Calling Transaction_Logger.logger with no parameter sets the logger to a new ins
 You can add a prefix to every hash key in the log by using the class method log_prefix:
 
 ```ruby
-TransactionLogger.log_prefix = "transaction_logger_"
+TransactionLogger::Configure.log_prefix = "transaction_logger_"
 # output hash:
 # {
 #   "transaction_logger_name" => "some name"
@@ -66,7 +66,7 @@ TransactionLogger.log_prefix = "transaction_logger_"
 You may also choose at which log level the TransactionLogger sends it's log hash. By default, *error* is the threshold, so that if an *error* or *fatal* log is made, then the TransactionLogger will send a JSON hash to it's configured logger. If you wish to set the threshold to *warn*, you can configure the TransactionLogger to do so:
 
 ```ruby
-TransactionLogger.level_threshold = :warn
+TransactionLogger::Configure.level_threshold = :warn
 ```
 
 ## Usage
@@ -94,16 +94,7 @@ add_transaction_log :some_method, {name: "Custom Name", context: {}}
 
 ### Example
 
-Initial setup, in a config file:
-
-```ruby
-logger = Logger.new STDOUT
-
-# Sets output to the new Logger
-TransactionLogger.logger = logger
-```
-
-Here is a transaction that raises an error:
+Assuming there is already an instance of Ruby's Logger class, here is a transaction that raises an error:
 
 ```ruby
 class ExampleClass
@@ -152,6 +143,11 @@ The expected output is:
 
 ## Version History
 
+### v1.0.1
+- Fixed issues with undefined trap_logger method
+- Hid module methods other than add_transaction_log
+- TransactionLogger configuration updated
+
 ### v1.0.0
 
 - AOP approach that provides a much cleaner, easier implementation of the TransactionLogger

data/lib/transaction_logger/version.rb

@@ -1,3 +1,3 @@
 module TransactionLogger
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/lib/transaction_logger.rb

@@ -5,52 +5,10 @@ require "transaction_logger/transaction_manager"
 module TransactionLogger
 
   # @private
-  # Extends ClassMethods of including class to the TransactionLogger
+  # Includes ClassMethods of including class to the TransactionLogger
   #
   def self.included(base)
-    base.extend(ClassMethods)
-  end
-
-  # Sets the hash keys on the TransactionLogger's log to have a prefix.
-  #
-  # Using .log_prefix "str_", the output of the log hash will contain keys
-  # prefixed with "str_", such as { "str_name" => "Class.method" }.
-  #
-  # @param prefix [#to_s] Any String or Object that responds to to_s
-  #
-  def self.log_prefix=(prefix)
-    @prefix = "#{prefix}"
-  end
-
-  # @private
-  # Returns the log_prefix
-  #
-  # @return [String] The currently stored prefix.
-  #
-  def self.log_prefix
-    @prefix
-  end
-
-  # Sets the TransactionLogger's output to a specific instance of Logger.
-  #
-  # @param logger [Logger] Any instace of ruby Logger
-  #
-  class << self
-    attr_writer :logger
-  end
-
-  # Sets the TransactionLogger's output to a new instance of Logger
-  #
-  def self.logger
-    @logger ||= Logger.new(STDOUT)
-  end
-
-  # Sets the TransactionLogger's logger level threshold.
-  #
-  # @param level [Symbol] A symbol recognized by logger, such as :warn
-  #
-  class << self
-    attr_writer :level_threshold
+    base.extend ClassMethods
   end
 
   module ClassMethods
@@ -70,11 +28,10 @@ module TransactionLogger
     def add_transaction_log(method, options={})
       old_method = instance_method method
 
-      prefix = Module.nesting.last.instance_variable_get :@prefix
-      logger = Module.nesting.last.instance_variable_get :@logger
-      level_threshold = Module.nesting.last.instance_variable_get :@level_threshold
-
-      options = { prefix: prefix, logger: logger, level_threshold: level_threshold }
+      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
         TransactionManager.start options, lambda  { |transaction|
@@ -83,28 +40,82 @@ module TransactionLogger
           transaction.context = options[:context]
           transaction.context ||= {}
 
-          self.class.trap_logger method, transaction
+          method_info = {}
+          method_info[:logger_method] = self.class.instance_method :logger
+          method_info[:calling_method] = caller_locations(1, 1)[0].label
+          method_info[:includer] = self
+
+          TransactionLogger::Helper.trap_logger method, transaction, method_info
           old_method.bind(self).call
         }
       end
     end
 
+  end
+
+  class Helper
     # @private
     # Traps the original logger inside the TransactionLogger
     #
     # @param method [Symbol]
     # @param transaction [Transaction]
     #
-    def trap_logger(_method, transaction)
-      logger_method = instance_method :logger
+    def self.trap_logger(_method, transaction, method_info={})
+      logger_method = method_info[:logger_method]
+      calling_method = method_info[:calling_method]
+      includer = method_info[:includer]
 
-      define_method :logger do
-        @original_logger ||= logger_method.bind(self).call
-        calling_method = caller_locations(1, 1)[0].label
+      includer.class.send :define_method, :logger, lambda {
+        @original_logger ||= logger_method.bind(includer).call
 
         @trapped_logger ||= {}
         @trapped_logger[calling_method] ||= LoggerProxy.new @original_logger, transaction
-      end
+      }
+    end
+
+  end
+
+  class Configure
+    # Sets the hash keys on the TransactionLogger's log to have a prefix.
+    #
+    # Using .log_prefix "str_", the output of the log hash will contain keys
+    # prefixed with "str_", such as { "str_name" => "Class.method" }.
+    #
+    # @param prefix [#to_s] Any String or Object that responds to to_s
+    #
+    def self.log_prefix=(prefix)
+      @prefix = prefix
+    end
+
+    # @private
+    # Returns the log_prefix
+    #
+    # @return [String] The currently stored prefix.
+    #
+    def self.log_prefix
+      @prefix
+    end
+
+    # Sets the TransactionLogger's output to a specific instance of Logger.
+    #
+    # @param logger [Logger] Any instace of ruby Logger
+    #
+    class << self
+      attr_writer :logger
+    end
+
+    # Sets the TransactionLogger's output to a new instance of Logger
+    #
+    def self.logger
+      @logger ||= Logger.new(STDOUT)
+    end
+
+    # Sets the TransactionLogger's logger level threshold.
+    #
+    # @param level [Symbol] A symbol recognized by logger, such as :warn
+    #
+    class << self
+      attr_writer :level_threshold
     end
   end
 

data/spec/transaction_logger_spec.rb

@@ -46,31 +46,33 @@ describe TransactionLogger do
     }
   end
 
-  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")
+  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
-    end
 
-    context "when a prefix is defined" do
-      let (:prefix) { "bta_" }
+      context "when a prefix is defined" do
+        let (:prefix) { "bta_" }
 
-      before :example do
-        described_class.log_prefix = prefix
-      end
+        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)
-      }
+        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
+        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")
+        it "adds the prefix to every key" do
+          expect(subject.to_hash).to include("bta_name" => "undefined")
+        end
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: transaction_logger
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - John Donner
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-16 00:00:00.000000000 Z
+date: 2015-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -142,7 +142,6 @@ files:
 - ".yardopts"
 - Gemfile
 - LICENSE
-- LICENSE.txt
 - README.md
 - Rakefile
 - lib/transaction_logger.rb
@@ -173,7 +172,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.3
 signing_key: 
 specification_version: 4
 summary: Contextual Business Transaction Logger for Ruby

data/LICENSE.txt

@@ -1,22 +0,0 @@
-Copyright (c) 2015 Sebastian Schleicher
-
-MIT License
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.