call_logger 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a3a3d44a1224ca8b9853cc6946bbdd41c7f5555b52fd26200923171763ad26e9
-  data.tar.gz: 36dc9907080ccacb3a3cd6da0311d17f6f4de1408ab7c90b4eeee31f7c4e37a5
+  metadata.gz: d6e801f833860f18014297b607e82c57aee7690df4d50d03a8a36933c8f6fed3
+  data.tar.gz: 3014e9a30a8e0bfdd2576b7a2f416f0bd2b89e21f610548d53924ee4fd527f19
 SHA512:
-  metadata.gz: a233520174d5800c9b4f74d2cd002e7e1155d57381ca7bb0ab56a4ccae78f7e6a4aefee883e0f98bf3bcdc6f4c58200385cc2dad7cfe6ba01369760250db7def
-  data.tar.gz: 3d44fb992a646ae941360b4a233edd4bf48e93f4573c55dba683a7dd8209bfc598df6164eb1c1623c09f9333e57ba1435619eeb46bbf506b59b4afc025a32d91
+  metadata.gz: fe4c591ddc244a7a4f099789e02c55db42b0471f0c0dff7508b6382cc68baf1f291ece56ed0583a2f98706cb93d4f14aa78945302d8f4ee1589129e50ed1d672
+  data.tar.gz: e14c310b304d4a30159bb019b9cf1ec1bf3f897cc1c51089bfeeff6dd0a2850e0ba2ea4ac2a6b99672ab88d11c7f702240f98b48dd8ec127635b9d73918243c7

data/.travis.yml

@@ -1,5 +1,8 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.5.1
-before_install: gem install bundler -v 1.16.2
+  - 2.6.0
+  - 2.5.3
+  - 2.4.5
+  - jruby
+before_install: gem install bundler

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    call_logger (0.4.0)
+    call_logger (0.5.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -2,6 +2,9 @@
 
 A debugging tool that lets you log method usage.
 
+[![Build status](https://travis-ci.org/mrzasa/call_logger.svg?branch=master)](https://travis-ci.org/mrzasa/call_logger)
+[![Maintainability](https://api.codeclimate.com/v1/badges/55bd374e1cd20af702ed/maintainability)](https://codeclimate.com/github/mrzasa/call_logger/maintainability)
+
 ```
 class Calculator
   include CallLogger
@@ -22,7 +25,7 @@ end
 Calculator.new.times(3,4)
 # Calculator#times(3, 4)
 # Calculator#times => 6
-# => 7
+# => 6
 
 Calculator.new.div(3,0)
 # Calculator#div(3, 0)
@@ -127,6 +130,39 @@ class Calculator
 end
 ```
 
+### Wrapping a block
+
+You can wrap a block of code using `#log_block` (in instance methods) or `.log_block` (in class methods). Block parameters will not be logged though:
+
+```
+class Calculator
+  include CallLogger
+
+  def times(a, b)
+    log_block('multiply')
+      a*b
+    end
+  end
+end
+
+Calculator.new.times(3,4)
+# multiply
+# multiply => 6
+# => 6
+```
+
+Block calls may be also logged without including `CallLogger` module with `CallLogger.log_block`:
+
+```
+log_block('multiply')
+  a*b
+end
+Calculator.new.times(3,4)
+# multiply
+# multiply => 6
+# => 6
+```
+
 ### Configuration
 
 There are two pluggable components: `Logger` and `Formatter`. `Formatter` preperes messages to be printed and `Logger` sents them to the
@@ -148,8 +184,8 @@ end
 ## TODO
 
 * [+] class methods
-* [] multiple method names
-* [] handle blocks
+* [+] multiple method names
+* [+] handle blocks
 * [] logging all methods defined in the class
 * [] doc: Rails integration
 * [] doc: API docs

data/lib/call_logger/call_wrapper.rb

@@ -0,0 +1,20 @@
+module CallLogger
+  class CallWrapper
+    attr_reader :formatter, :logger
+
+    def initialize(formatter:, logger: )
+      @formatter = formatter
+      @logger = logger
+    end
+
+    def call(name, args)
+      logger.call(formatter.before(name, args))
+      result = yield
+      logger.call(formatter.after(name, result))
+      result
+    rescue StandardError => e
+      logger.call(formatter.error(name, e))
+      raise
+    end
+  end
+end

data/lib/call_logger/method_wrapper.rb

@@ -1,20 +1,49 @@
 module CallLogger
   class MethodWrapper
-    attr_reader :formatter, :logger
+    attr_reader :extended_class, :owner_class
 
-    def initialize(formatter:, logger: )
-      @formatter = formatter
-      @logger = logger
+    def initialize(extended_class, owner_class)
+      @extended_class = extended_class
+      @owner_class = owner_class
     end
 
-    def call(method, args)
-      logger.call(formatter.before(method, args))
-      result = yield
-      logger.call(formatter.after(method, result))
-      result
-    rescue StandardError => e
-      logger.call(formatter.error(method, e))
-      raise
+    def wrap_single(method)
+      owner = @owner_class
+      sep = separator
+      extended_class.alias_method "#{method}_without_log", method
+      extended_class.define_method method do |*args|
+        owner.do_log("#{owner}#{sep}#{method}", args) do
+          send("#{method}_without_log", *args)
+        end
+      end
+    end
+
+    def wrap_multiple(methods)
+      extended_class.prepend(build_module(methods))
+    end
+
+    private
+
+    def separator
+      if extended_class.singleton_class?
+        '.'
+      else
+        '#'
+      end
+    end
+
+    def build_module(methods)
+      owner = @owner_class
+      sep = separator
+      Module.new do
+        methods.each do |method|
+          define_method method do |*args|
+            owner.do_log("#{owner}#{sep}#{method}", args) do
+              super(*args)
+            end
+          end
+        end
+      end
     end
   end
 end

data/lib/call_logger/version.rb

@@ -1,3 +1,3 @@
 module CallLogger
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/lib/call_logger.rb

@@ -3,8 +3,8 @@ require "call_logger/version"
 require 'call_logger/formatter'
 require 'call_logger/logger'
 require 'call_logger/configuration'
+require 'call_logger/call_wrapper'
 require 'call_logger/method_wrapper'
-require 'call_logger/method_wrapper_builder'
 
 module CallLogger
   def self.included(base)
@@ -21,6 +21,18 @@ module CallLogger
   end
   configure # set defaults
 
+  def log_block(name, &block)
+    self.class.log_block(name, &block)
+  end
+
+  def self.log_block(name, &block)
+    logger = configuration.logger
+    formatter = configuration.formatter
+    call_wrapper = CallWrapper.new(
+      logger: logger, formatter: formatter
+    )
+    call_wrapper.call(name, [], &block)
+  end
 
   module ClassMethods
     def log(*methods)
@@ -31,22 +43,26 @@ module CallLogger
       wrap_log(singleton_class, methods)
     end
 
+    def log_block(name, &block)
+      do_log(name, [], &block)
+    end
+
     def wrap_log(owner, methods)
-      builder = MethodWrapperBuilder.new(owner, self)
+      wrapper = MethodWrapper.new(owner, self)
       if methods.size == 1 && owner.respond_to?(methods.first)
-        builder.wrap_single(methods.first)
+        wrapper.wrap_single(methods.first)
       else
-        builder.wrap_multi(methods)
+        wrapper.wrap_multiple(methods)
       end
     end
 
-    def do_log(method, args, &block)
+    def do_log(name, args, &block)
       logger = ::CallLogger.configuration.logger
       formatter = ::CallLogger.configuration.formatter
-      method_wrapper = ::CallLogger::MethodWrapper.new(
+      call_wrapper = CallWrapper.new(
         logger: logger, formatter: formatter
       )
-      method_wrapper.call(method, args, &block)
+      call_wrapper.call(name, args, &block)
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: call_logger
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Maciej Rzasa
@@ -99,11 +99,11 @@ files:
 - bin/setup
 - call_logger.gemspec
 - lib/call_logger.rb
+- lib/call_logger/call_wrapper.rb
 - lib/call_logger/configuration.rb
 - lib/call_logger/formatter.rb
 - lib/call_logger/logger.rb
 - lib/call_logger/method_wrapper.rb
-- lib/call_logger/method_wrapper_builder.rb
 - lib/call_logger/version.rb
 homepage: https://github.com/mrzasa/call_logger
 licenses:

data/lib/call_logger/method_wrapper_builder.rb

@@ -1,49 +0,0 @@
-module CallLogger
-  class MethodWrapperBuilder
-    attr_reader :extended_class, :owner_class
-
-    def initialize(extended_class, owner_class)
-      @extended_class = extended_class
-      @owner_class = owner_class
-    end
-
-    def wrap_single(method)
-      owner = @owner_class
-      sep = separator
-      extended_class.alias_method "#{method}_without_log", method
-      extended_class.define_method method do |*args|
-        owner.do_log("#{owner}#{sep}#{method}", args) do
-          send("#{method}_without_log", *args)
-        end
-      end
-    end
-
-    def wrap_multi(methods)
-      extended_class.prepend(build_module(methods))
-    end
-
-    private
-
-    def separator
-      if extended_class.singleton_class?
-        '.'
-      else
-        '#'
-      end
-    end
-
-    def build_module(methods)
-      owner = @owner_class
-      sep = separator
-      Module.new do
-        methods.each do |method|
-          define_method method do |*args|
-            owner.do_log("#{owner}#{sep}#{method}", args) do
-              super(*args)
-            end
-          end
-        end
-      end
-    end
-  end
-end