call_logger 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6e801f833860f18014297b607e82c57aee7690df4d50d03a8a36933c8f6fed3
-  data.tar.gz: 3014e9a30a8e0bfdd2576b7a2f416f0bd2b89e21f610548d53924ee4fd527f19
+  metadata.gz: 0adfd61ac39437bc65d870c48db0c0b6d2fd55b460c2464af3147da96fe151cd
+  data.tar.gz: 6d7e043e3db14b179cbdaca5f95610b5b2c702b4f38d8c4880d6c59113baa05e
 SHA512:
-  metadata.gz: fe4c591ddc244a7a4f099789e02c55db42b0471f0c0dff7508b6382cc68baf1f291ece56ed0583a2f98706cb93d4f14aa78945302d8f4ee1589129e50ed1d672
-  data.tar.gz: e14c310b304d4a30159bb019b9cf1ec1bf3f897cc1c51089bfeeff6dd0a2850e0ba2ea4ac2a6b99672ab88d11c7f702240f98b48dd8ec127635b9d73918243c7
+  metadata.gz: 3ef83a709e2bcba4728b2e24ee08ead8d85069e3515873700ee26d0a00e8544201fd512416032a3801fcd1a6ae26276ece42aaee19b5d863aa70a97b4c09973d
+  data.tar.gz: 4f6b506851e99811a0db92587e1ee0b9c3f35dc4f5763a5835fb805e2be133352b219d4b7d4c98b76338995b9906000a78130b9319d556d50c476adab1c2f357

data/.gitignore

@@ -9,3 +9,5 @@
 
 # rspec failure tracking
 .rspec_status
+
+Gemfile.lock*

data/README.md

@@ -5,6 +5,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)
 
+In the default setting, a method is logged before call with arguments and after the call with result and time call took (in seconds).
+A message is also logged on execution error.
+
 ```
 class Calculator
   include CallLogger
@@ -17,6 +20,11 @@ class Calculator
     a/b
   end
 
+  log def slow_square(a)
+    sleep a
+    a * a
+  end
+
   log_class def self.info(msg)
     "Showing: #{msg}"
   end
@@ -24,7 +32,7 @@ end
 
 Calculator.new.times(3,4)
 # Calculator#times(3, 4)
-# Calculator#times => 6
+# Calculator#times => 6, [Took: 0.000011s]
 # => 6
 
 Calculator.new.div(3,0)
@@ -34,7 +42,12 @@ Calculator.new.div(3,0)
 
 Calculator.info("hello!")
 # Calculator.info(hello)
-# Calculator.info => "Showing: hello"
+# Calculator.info => "Showing: hello", [Took: 0.000011s]
+
+
+Calculator.new.slow_square(2)
+# Calculator#slow_square(2)
+# Calculator#slow_square => 4, [Took: 2.000117s]
 ```
 
 ## Installation
@@ -147,7 +160,7 @@ end
 
 Calculator.new.times(3,4)
 # multiply
-# multiply => 6
+# multiply => 6, [Took: 0.000011s]
 # => 6
 ```
 
@@ -159,7 +172,7 @@ log_block('multiply')
 end
 Calculator.new.times(3,4)
 # multiply
-# multiply => 6
+# multiply => 6, [Took: 0.000011s]
 # => 6
 ```
 
@@ -178,7 +191,7 @@ end
 * `Logger` should provide a `#call` method accepting a single paramter.
 * `Formatter` should provide following methods:
   * `#before(method, args)` - accepting method name and it's arguments; called before method execution
-  * `#after(method, result)` - accepting method name and it's result; called after method execution
+  * `#after(method, result, seconds: nil)` - accepting method name, it's result and seconds took execution as a KV param; called after method execution
   * `#error(method, exception)` - accepting method name and an exception; called when error is raised
 
 ## TODO
@@ -189,7 +202,7 @@ end
 * [] logging all methods defined in the class
 * [] doc: Rails integration
 * [] doc: API docs
-* [] infra: travis
+* [+] infra: travis
 
 ## Development
 

data/call_logger.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "pry"

data/lib/call_logger/call_wrapper.rb

@@ -1,3 +1,5 @@
+require 'benchmark'
+
 module CallLogger
   class CallWrapper
     attr_reader :formatter, :logger
@@ -9,8 +11,9 @@ module CallLogger
 
     def call(name, args)
       logger.call(formatter.before(name, args))
-      result = yield
-      logger.call(formatter.after(name, result))
+      result = nil
+      seconds = Benchmark.realtime { result = yield }
+      logger.call(formatter.after(name, result, seconds: seconds))
       result
     rescue StandardError => e
       logger.call(formatter.error(name, e))

data/lib/call_logger/formatter.rb

@@ -4,8 +4,8 @@ module CallLogger
       "#{method}(#{args.join(', ')})"
     end
 
-    def after(method, result)
-      "#{method} => #{result}"
+    def after(method, result, seconds: nil)
+      "#{method} => #{result}, [Took: #{'%.6f' % seconds}s]"
     end
 
     def error(method, exception)

data/lib/call_logger/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: call_logger
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Maciej Rzasa
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-02 00:00:00.000000000 Z
+date: 2019-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -91,7 +91,6 @@ files:
 - ".rspec"
 - ".travis.yml"
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile

data/Gemfile.lock

@@ -1,46 +0,0 @@
-PATH
-  remote: .
-  specs:
-    call_logger (0.5.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    coderay (1.1.2)
-    diff-lcs (1.3)
-    method_source (0.9.2)
-    pry (0.12.2)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    pry-doc (0.13.5)
-      pry (~> 0.11)
-      yard (~> 0.9.11)
-    rake (10.5.0)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
-    yard (0.9.16)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.16)
-  call_logger!
-  pry
-  pry-doc
-  rake (~> 10.0)
-  rspec (~> 3.0)
-
-BUNDLED WITH
-   1.16.2