advisor 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6bd705ca8a6e531d27ba1f7477118d039fd8e93e
-  data.tar.gz: f0372ed273abef5b744b0509c35d25887220081b
+  metadata.gz: bb82aadaba5ad1eabdc2abf85341b1cce43b0af8
+  data.tar.gz: 54e6addf7315ec6f27bc75155fbe3fc394d5223d
 SHA512:
-  metadata.gz: d662f5d5c8270323bd8023c3f9f27b13fbe2fc7b6b0081a37d2975cf743d889b71336f2f61cc9859a7630ed489bbdfbd9f1db87711b5d6b9ef4b72dc354364f9
-  data.tar.gz: 8d38aa47bcdad42014e600e9492dcde1c1c789f76c15fd357d793e10216f740a0935534d245bbdccfb397dbac5b54c04f6ecfca57a9dc7550f7545de8a64f828
+  metadata.gz: 5580f78d8832b51b5dc3afee89dd243f2e72f689a509361b83df1a89cd0b94ee1b725dd30f0f8c79635505edf5977f9e8f0822c404ea333e705d8b3eff5bee7e
+  data.tar.gz: 5638d1f84f884403f37c937d4b6162e7454d948b52cb4832fa444219a28f50a1b91aa86dfb3d96359951e363c11a20d8c09a0b37adb1b4eeccf1f55324257d6f

data/.ruby-version

@@ -1 +1 @@
-2.1.5
+2.2.2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    advisor (0.5.1)
+    advisor (0.6.0)
       metriks
 
 GEM
@@ -21,7 +21,7 @@ GEM
     columnize (0.9.0)
     debugger-linecache (1.2.0)
     diff-lcs (1.2.5)
-    hitimes (1.2.2)
+    hitimes (1.2.4)
     method_source (0.8.2)
     metriks (0.9.9.7)
       atomic (~> 1.0)
@@ -74,4 +74,4 @@ DEPENDENCIES
   rubocop
 
 BUNDLED WITH
-   1.10.6
+   1.12.1

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'advisor'
+
+require 'pry'
+Pry.start

data/lib/advisor/advices/call_logger.rb

@@ -2,6 +2,28 @@ require 'logger'
 
 module Advisor
   module Advices
+    # A simple built-in logging advise
+    #
+    # == Examples
+    #
+    #   class MyClass
+    #     extend Advisor::Loggable
+    #
+    #     log_calls_to(:simple)
+    #     # [...]Called: MyClass#simple()
+    #
+    #     log_calls_to(:with_result, result: true)
+    #     # [...]Called: MyClass#with_result()
+    #     # [...]Result: MyClass#with_result() => String: "bla"
+    #
+    #     log_calls_to(:with_tag, tag: -> { "[id=#{id}]" }
+    #     # [...][id=42]Called: MyClass#with_tag()
+    #
+    #     log_calls_to(:with_specific_logger, logger: Rails.logger)
+    #     log_calls_to(
+    #       :with_backtrace_cleaner, backtrace_cleaner: CustomCleaner
+    #      )
+    #   end
     class CallLogger
       class << self
         attr_accessor :backtrace_cleaner
@@ -18,9 +40,12 @@ module Advisor
         @cleaner = opts[:backtrace_cleaner] || CallLogger.backtrace_cleaner
         @logger = opts[:logger] || CallLogger.default_logger
         @tag_proc = opts[:with] || -> {}
+        @log_result = opts[:result] || false
       end
 
-      attr_reader :object, :method, :call_args, :logger, :tag_proc, :cleaner
+      attr_reader(
+        :object, :method, :call_args, :logger, :tag_proc, :log_result, :cleaner
+      )
 
       def self.applier_method
         :log_calls_to
@@ -28,7 +53,7 @@ module Advisor
 
       def call
         logger.info(success_message)
-        yield
+        yield.tap(&result_message)
       rescue exception_class => e
         logger.error(failure_message(e))
         raise
@@ -46,6 +71,16 @@ module Advisor
         call_message('Failed: ', backtrace.join("\n"))
       end
 
+      def result_message
+        lambda do |result|
+          return unless log_result
+
+          logger.info(
+            call_message('Result: ', " => #{result.class}: #{result.inspect}")
+          )
+        end
+      end
+
       def call_message(prefix, suffix = '')
         "#{time}#{thread}#{id}#{custom_tag}#{prefix}\
 #{klass}##{method}(#{arguments})\

data/lib/advisor/version.rb

@@ -1,3 +1,3 @@
 module Advisor
-  VERSION = '0.5.1'
+  VERSION = '0.6.0'
 end

data/spec/advisor/advices/call_logger_spec.rb

@@ -4,7 +4,9 @@ module Advisor
   module Advices
     describe CallLogger do
       subject(:advice) do
-        described_class.new(object, method, args, logger: logger, with: tag)
+        described_class.new(
+          object, method, args, logger: logger, with: tag, result: result
+        )
       end
 
       let(:object) { OpenStruct.new(id: 42, x: 'y') }
@@ -12,6 +14,7 @@ module Advisor
       let(:args) { ['the universe', 'and everything'] }
       let(:logger) { instance_double(Logger) }
       let(:tag) { -> { "[x=#{x}]" } }
+      let(:result) { true }
 
       let(:block) { -> { :bla } }
 
@@ -23,6 +26,12 @@ module Advisor
 Called: OpenStruct#the_meaning_of_life(\"the universe\", \"and everything\")"
         end
 
+        let(:result_log_message) do
+          "[Time=#{Time.now}][Thread=#{Thread.current.object_id}][id=42][x=y]\
+Result: OpenStruct#the_meaning_of_life(\"the universe\", \"and everything\") \
+=> Symbol: :bla"
+        end
+
         before do
           allow(Time).to receive(:now).and_return(Time.now)
           allow(logger).to receive(:info)
@@ -36,6 +45,12 @@ Called: OpenStruct#the_meaning_of_life(\"the universe\", \"and everything\")"
           call
         end
 
+        it do
+          expect(logger).to receive(:info).with(result_log_message)
+
+          call
+        end
+
         context 'when yielding the block raises an error' do
           let(:block) { -> () { fail 'deu ruim!' } }
 
@@ -100,6 +115,16 @@ Called: OpenStruct#the_meaning_of_life(\"the universe\", \"and everything\")"
             call
           end
         end
+
+        context 'when it is not provided to log the result' do
+          let(:result) { false }
+
+          it do
+            expect(logger).not_to receive(:info).with(result_log_message)
+
+            call
+          end
+        end
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: advisor
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Renan Ranelli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-20 00:00:00.000000000 Z
+date: 2016-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: metriks
@@ -111,7 +111,8 @@ dependencies:
 description: 
 email:
 - renanranelli@gmail.com
-executables: []
+executables:
+- console
 extensions: []
 extra_rdoc_files: []
 files:
@@ -125,6 +126,7 @@ files:
 - Rakefile
 - Readme.org
 - advisor.gemspec
+- bin/console
 - lib/advisor.rb
 - lib/advisor/advices.rb
 - lib/advisor/advices/call_logger.rb
@@ -157,9 +159,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: AOP with anonymous modules
 test_files: []
-has_rdoc: